Make $BuiltModuleSubdirectory configurable in build.yaml

[gaelcolas]

Currently it seems to work fine when passed by argument. It would be great it we could make it work in the config file.

[gaelcolas]

fixed with #306 Does the existing build.ps1 need updating on each repo?

[gaelcolas]

Also, look at testing delta for your PR for the Set-SamplerVariable (-6%), please try to correct that.

[gaelcolas]

And now we need to update DscResource.Test to support this. Currently getting:

Build FAILED. 18 tasks, 1 errors, 0 warnings 00:00:11.9031330
Get-Item: C:\src\nxtools\output\RequiredModules\DscResource.Test\0.15.1\tasks\Invoke_HQRM_Tests.build.ps1:113:37
Line |
 113 |  … ModuleManifest = [string](Get-Item -Path $builtModuleManifest).FullNa …
     |                              ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     | Cannot find path 'C:\src\nxtools\output\nxtools' because it does not exist.

[NicolasBn]

Indeed, each build.ps1 need to be updated. If no, the value of PSModulePath will be defined to output folder.

I'll update tests for Set-SamplerVariable.

For DscResource.Test, should we open a new issue ?

[gaelcolas]

DscResource.Test, should we open a new issue ?

Yes please, those issues are kinda expected. Probably need to check Sampler.GithubTask, and other modules with task (DocGenerator, Test...).

[gaelcolas]

oh, and I can see that the output/ is still set as one $env:PSModulePath variable which should not be the case. When using subdirectory, only output/RequiredModules and output/subdirectory should be in the PSModulePath...

[NicolasBn]

When using subdirectory, only output/RequiredModules and output/subdirectory should be in the PSModulePath...

Yes, it's why I moved the definition of $env:PSModulePath in build.ps1 from Begin to Process bloc ;) https://github.com/NicolasBn/Sampler/blob/594da9bd6b4905f578ce838743f1b5314da24ac3/Sampler/Templates/Build/build.ps1#L229

[gaelcolas]

ah, I know what went wrong... As you rightly moved the block in the build.ps1 from begin to process block... you forgot to remove the bit in the template (which is what I used to try it out).

Please also update the build.ps1

[NicolasBn]

Oh Okay ! I will do !

[NicolasBn]

DscResource.Test, should we open a new issue ?

Yes please, those issues are kinda expected. Probably need to check Sampler.GithubTask, and other modules with task (DocGenerator, Test...).

After checking, DscResource.Test has no need to change. With my last PR in the repo, the tasks are based on Set-SamplerTaskVariable.ps1 script.

But Sampler.GitHubTasks need to be changed : https://github.com/gaelcolas/Sampler.GitHubTasks/blob/fd5cf1e0544a4c900e577b87e69181b483a11366/.build/tasks/New-Release.GitHub.build.ps1#L58

Same to DscResource.DocGenerator : https://github.com/dsccommunity/DscResource.DocGenerator/blob/3a8ba1112e5cba97e3daf0b1d72453f547f5186a/source/tasks/Generate_Conceptual_Help.build.ps1#L88

https://github.com/dsccommunity/DscResource.DocGenerator/blob/3a8ba1112e5cba97e3daf0b1d72453f547f5186a/source/tasks/Generate_Wiki_Content.build.ps1#L91

https://github.com/dsccommunity/DscResource.DocGenerator/blob/3a8ba1112e5cba97e3daf0b1d72453f547f5186a/source/tasks/Publish_GitHub_Wiki_Content.build.ps1#L112

[johlju]

@NicolasBn is this closed with the merge of PR #306?

[NicolasBn]

No, I forget to remove some lines in build.ps1 template.

And I must to add some pester tests to cover my changes.

It's already written. I just need to create a new PR.

[johlju]

Cool. Then we keep this open.

[NicolasBn]

Finally, I think I found a bug in my code. I based it on $PSboundParameter to find if BuiltModuleSubDirectory parameter is passed to the task. But $PSBoundParameter scope is to Set-SamplerTaskVariable script, not the task.

So when BuiltModuleSubDirectory is set in the build configuration file and the BuiltModuleSubDirectory parameter is used on build.ps1, the configuration file has the priority. For me, the parameter ought to have the biggest priority.

[johlju]

Yes, parameter should have priority. it cannot use $PSBoundParameters since it does not contain any default parameter that might be set by property. Must use Get-Variable to check if the parameter was set. Then if property of the parameter got the variable from parent scope or environment variable it will be set, but it is not shown in $PSBoundParameters.

[NicolasBn]

So, I just need to check the value of $BuiltModuleSubDirectory, the value is herited from the task scope. Is not necessary to use Get-Variable ?

And if no values set in $BuilfModuleSubDirectory or $BuildInfo['BuiltModuleSubDirectory'], I use a null value. What do you think about this ?

[johlju]

Yes, sounds correct. The script is dot-sourced into the task so it is in the same scope, so we should be able to use the variable directly without Get-Variable.

[gaelcolas]

The problem with not using Get-Variable is when we use Set-StrictMode -Version Latest. Sure, it's not in use at the moment, but it's probably best to assume we'll try to be more strict going forward.

[NicolasBn]

OK, I see, but $BuiltModuleSubDirectory will not be the only variable impacted by Set-StrictMode -Version Latest.

Should we open a new issue to discuss about that ?

I will create a PR with Get-Variable for $BuilModuleSubDirectory.

[johlju]

I think we should run the unit test with strict mode, then the tests will enforce that for us, and let us not have the strict statement when we run the code in production

I agree with @NicolasBn that we should open an issue to track this. But @NicolasBn we could fix this one so that there is one less we need to fix later. 😊

[NicolasBn]

Understood ! I tested to set strict mode directly at the beginning of task :

Task Build_ModuleOutput_ModuleBuilder {
    Set-StrictMode -Version Latest -Debug
    # Get the vales for task variables, see https://github.com/gaelcolas/Sampler#task-variables.
    . Set-SamplerTaskVariable -AsNewBuild

No exception was generated with $BuiltSubFolderDirectory. And with Get-Variable I can determine which scope I must to use in -Scope parameter. No value was found.

[johlju]

And with Get-Variable I can determine which scope I must to use in -Scope parameter. No value was found.

@NicolasBn I'm not following you. Do you mean you get a value when using $BuiltSubFolderDirectory, but not with Get-Variable -Name 'BuiltSubFolderDirectory' -ValueOnly?

[NicolasBn]

To resume : I got the value when I used BuiltSubFolderDirectory and Get-Variable -Name 'BuiltSubFolderDirectory' -ValueOnly

But when I added -Scope to Get-Variable, that didn't work. The scoping isn't my preference in PowerShell. I might be wrong in my way to use -Scope parameter.

[johlju]

Not sure you need to use scope parameter since you want the variable in the same scope. The script are dot sourced in the same scope as the task parameters. Or am missing something?

[NicolasBn]

No, you are right. But what's the benefit to use Get-Variable -Name 'BuiltSubFolderDirectory' -ValueOnly rather than $BuiltSubFolderDirectory?

The dot sourcing is really impacted by Strict Mode?

[johlju]

You did tests with strict and it didn’t impact so we could then just use BuiltSubFolderDirectory.