add test case for not having test.resourceDir in main scope

[btomala]

I found that the resource from the directive test.resourceDir is added to the classpath in the main scope. It should be only in the test scope.

I thought that was an easy fix, so I tried to do so. However, I failed. I'm opening a PR with a test case for this. I'm happy to fix it if you could give me some guidance on where to look.

[Gedochao]

The directive is declared here:

scala-cli/modules/directives/src/main/scala/scala/build/preprocessing/directives/Resources.scala

Lines 34 to 36 in 418959f

	@DirectiveName("test.resourceDirs")
	testResourceDirs: DirectiveValueParser.WithScopePath[List[Positioned[String]]] =
	DirectiveValueParser.WithScopePath.empty(Nil)

and then put into options, here:

scala-cli/modules/directives/src/main/scala/scala/build/preprocessing/directives/Resources.scala

Line 40 in 418959f

Resources.buildOptions(testResourceDirs).map(_.withScopeRequirement(Scope.Test))

At a glance, test scope is being passed as a requirement...

[Gedochao]

We construct the build options with the resource directory here:

scala-cli/modules/directives/src/main/scala/scala/build/preprocessing/directives/Resources.scala

Lines 46 to 70 in 418959f

	def buildOptions(resourceDirs: DirectiveValueParser.WithScopePath[List[Positioned[String]]])
	: Either[BuildException, BuildOptions] = Right {
	val paths = resourceDirs.value.map(_.value)
	val (virtualRootOpt, rootOpt) = Directive.osRootResource(resourceDirs.scopePath)
	// TODO Return a BuildException for malformed paths
	val paths0 = rootOpt
	.toList
	.flatMap { root =>
	paths.map(os.Path(_, root))
	}
	val virtualPaths = virtualRootOpt.map { virtualRoot =>
	paths.map(path => virtualRoot / os.SubPath(path))
	}
	// warnIfNotExistsPath(paths0, logger) // this should be reported elsewhere (more from BuildOptions)
	BuildOptions(
	classPathOptions = ClassPathOptions(
	resourcesDir = paths0,
	resourcesVirtualDir = virtualPaths.toList.flatten
	)
	)
	}

It seems it's then extracted while processing sources here:

scala-cli/modules/build/src/main/scala/scala/build/CrossSources.scala

Lines 398 to 412 in 418959f

	private def resolveResourceDirs(
	allInputs: Inputs,
	preprocessedSources: Seq[PreprocessedSource]
	): Seq[WithBuildRequirements[os.Path]] = {
	val fromInputs = allInputs.elements
	.collect { case r: ResourceDirectory => WithBuildRequirements(BuildRequirements(), r.path) }
	val fromSources =
	preprocessedSources.flatMap(_.options)
	.flatMap(_.classPathOptions.resourcesDir)
	.map(r => WithBuildRequirements(BuildRequirements(), r))
	val fromSourcesWithRequirements = preprocessedSources
	.flatMap(_.optionsWithTargetRequirements)
	.flatMap(_.map(_.classPathOptions.resourcesDir).flatten)
	fromInputs ++ fromSources ++ fromSourcesWithRequirements
	}

To debug this, I'd track if build requirements (being the test scope) is respected when this field is being passed around:

scala-cli/modules/build/src/main/scala/scala/build/CrossSources.scala

Line 47 in 418959f

resourceDirs: Seq[WithBuildRequirements[os.Path]],

Let me know if this helps, this is where I'd start.

[Gedochao]

(note: I converted the PR to a draft, since it's not ready for review)

[btomala]

I'm not sure if these tests were testing the resolving of test scope resourceDir; it was testing only if the build options are passed correctly.
I was expecting that this would be equal, but it's not. It wasn't even before my changes. Now this test is failing.

[btomala]

Removing this resolves my issue and fixes the tests. The resourceDirectoriesFromDirectives extracts the directives and puts them in the input without scope. Later on in the resolveResourceDirs, the paths were extracted from input and wrapped into WithBuildRequirements without scope (because it wasn't available at this point) using the default main scope.

However, I'm not sure what the other consequences of this change are, as the allInputs are returned from the forInputs method. I don't know where this is used yet.

[Gedochao]

right... so I'm guessing we need to respect the scope here

[btomala]

Another option to address the issue will be to pass the allInputs to resoveReourceDirs instead of finalInputs