adding some fixes

[gaelcolas]

Fixing template and deprecating an old task we probably shouldn't be using anymore...

Asking @johlju to review and assess the impact.

---

This change is 

[codecov]

Codecov Report

Merging #428 (52f2237) into main (16933e1) will not change coverage.
The diff coverage is n/a.

@@         Coverage Diff         @@
##           main   #428   +/-   ##
===================================
  Coverage    81%    81%           
===================================
  Files        44     44           
  Lines      2319   2319           
===================================
  Hits       1899   1899           
  Misses      420    420           

[johlju]

Asking @johlju to review and assess the impact.

Actually didn't realize that this was different for some modules in DSC Community. It will fail on for example ExchangeDsc but for example SqlServerDsc and others already have this change. Simple fix by adding the correct config. The impact will be som maintaining work to unblock PRs. But this change is good and needed.

Looks good if the RequiredModules file do not need updating.

Reviewed 5 of 5 files at r1, all commit messages.
Reviewable status: all files reviewed, 2 unresolved discussions (waiting on @gaelcolas)

a discussion (no related file):
Might make sure the module is added here too. Maybe the if statement need to revised too?

Sampler/Sampler/Templates/Build/RequiredModules.psd1.template

Lines 39 to 46 in e9155b8

	If ($PLASTER_PARAM_ModuleType -in @('dsccommunity','CompleteSample') -or $PLASTER_PARAM_Features -Contains ('All') -or $PLASTER_PARAM_Features -Contains ('DSCResources')) {
	@"
	'DscResource.Common' = 'latest'
	'DscResource.Test' = 'latest'
	'DscResource.AnalyzerRules' = 'latest'
	xDscResourceDesigner = 'latest'
	'DscResource.DocGenerator' = 'latest'
	"@

Code quote (from Sampler/Templates/Build/build.yaml.template):

  DscResource.Test:
    - 'Task.*'

---

---

build.yaml line 177 at r1 (raw file):

  GitHubFilesToAdd:
    - 'CHANGELOG.md'
  ReleaseAssets:

Curious. Is this used somewhere by something?

Code quote:

ReleaseAssets:

[gaelcolas]

We probably should raise an issue in the affected repos before merging/releasing then.
Yes, I should think through the changes required for the RequiredModules.
For me the old task was always a problem in new projects.

Regarding the ReleaseAssets:, it's not used by default, but it's very useful to add stuff to the GitHub release...
https://github.com/chocolatey-community/Chocolatey/releases/tag/v0.2.0-preview0009

For instance in the Chocolatey module I add the Azure Automanage Machine Configuration packages/zips:

[johlju]

Regarding the ReleaseAssets:, it's not used by default, but it's very useful to add stuff to the GitHub release...

Cool. Will see if I can implement it for SqlServerDsc (and then add it to Sampler).

[johlju]

We probably should raise an issue in the affected repos before merging/releasing then.

Maybe I have a script to create an issue in several repos. Though, I wonder if it easier to just propose a PR in each repo, then we can fix the the VM image to windows-latest for the build phase too.

Repos that need to change:

• https://github.com/dsccommunity/SharePointDsc/blob/master/build.yaml
• https://github.com/dsccommunity/NetworkingDsc/blob/main/build.yaml
• https://github.com/dsccommunity/HyperVDsc/blob/main/build.yaml
• https://github.com/dsccommunity/JeaDsc/blob/master/build.yaml
• https://github.com/dsccommunity/ExchangeDsc/blob/main/build.yaml
• https://github.com/dsccommunity/NpmDsc/blob/main/build.yaml
• https://github.com/dsccommunity/ComputerManagementDsc/blob/main/build.yaml
• https://github.com/dsccommunity/DFSDsc/blob/main/build.yaml
• https://github.com/dsccommunity/xPSDesiredStateConfiguration/blob/main/build.yaml
• https://github.com/dsccommunity/StorageDsc/blob/main/build.yaml
• https://github.com/dsccommunity/ConfigMgrCBDsc/blob/master/build.yaml
• https://github.com/dsccommunity/xRemoteDesktopSessionHost/blob/master/build.yaml
• https://github.com/dsccommunity/WSManDsc/blob/main/build.yaml
• https://github.com/dsccommunity/DnsServerDsc/blob/main/build.yaml
• https://github.com/dsccommunity/WebAdministrationDsc/blob/main/build.yaml
• https://github.com/dsccommunity/DscResource.DocGenerator/blob/main/build.yaml
• https://github.com/dsccommunity/CertificateDsc/blob/main/build.yaml
• https://github.com/dsccommunity/xCredSSP/blob/main/build.yaml
• https://github.com/dsccommunity/GPRegistryPolicyDsc/blob/master/build.yaml
• https://github.com/dsccommunity/SecurityPolicyDsc/blob/master/build.yaml
• https://github.com/dsccommunity/ActiveDirectoryDsc/blob/main/build.yaml
• https://github.com/dsccommunity/FailoverClusterDsc/blob/main/build.yaml
• https://github.com/dsccommunity/SChannelDsc/blob/master/build.yaml
• https://github.com/dsccommunity/xDhcpServer/blob/main/build.yaml
• https://github.com/dsccommunity/FileContentDsc/blob/main/build.yaml
• https://github.com/dsccommunity/iSCSIDsc/blob/main/build.yaml
• https://github.com/dsccommunity/FSRMDsc/blob/main/build.yaml
• https://github.com/dsccommunity/ActiveDirectoryCSDsc/blob/main/build.yaml
• https://github.com/dsccommunity/AzureDevOpsDsc/blob/main/build.yaml
• https://github.com/dsccommunity/OfficeOnlineServerDsc/blob/master/build.yaml
• https://github.com/dsccommunity/PostgreSqlDsc/blob/master/build.yaml
• https://github.com/dsccommunity/xBitlocker/blob/master/build.yaml
• https://github.com/dsccommunity/DpkgPackage/blob/master/build.yaml
• https://github.com/dsccommunity/GitHubEnterpriseDsc/blob/master/build.yaml
• https://github.com/dsccommunity/xWindowsUpdate/blob/master/build.yaml

[johlju]

I will slowly fix the most used repos so we can get this merged.

[johlju]

Reviewable status: all files reviewed, 3 unresolved discussions (waiting on @gaelcolas)

---

Sampler/Templates/Build/build.yaml.template line 255 at r1 (raw file):

@"

DscTest:

Must have the key MainGitBranch: set to <%= ${PLASTER_PARAM_MainGitBranch} %> under the key DscTest.

[johlju]

After trying to update SharePointDsc and failed - concluded the task in Sampler cannot be removed because the new task in DscResource.Test only support Pester 5 currently. The task in Sampler uses the v4 tests in DscResource.Test.

The DscResource.Test command Invoke-DscResourceTest it seems it can run both the v4 and v5 tests depending on what version is installed but the new task does not use that command - not sure why, maybe we never got that far. There need to be a refactoring of the command and the new task. There are a lot of logic in the new task that is not in the command. But that might just be okay since the task knows how to read from build.yaml, but in the end maybe it should call the command as well.

Old task calls the command.

Sampler/.build/tasks/DscResource.Test.build.ps1

Line 232 in a14049c

$script:testResults = Invoke-DscResourceTest @dscTestParams

The new task calls Invoke-Pester directly.

https://github.com/dsccommunity/DscResource.Test/blob/88d3e7bb7aa59406d6fc3ff260649be6b462c0e6/source/tasks/Invoke_HQRM_Tests.build.ps1#L458-L465

[johlju]

This is to much work to do now. :/ I put it back on the back-burner...