Compare commits

..

18 Commits

Author SHA1 Message Date
Andrew 79d47ceed9 Fixed Invoke-DscResource error when a class-based resource module path contains a space (#112) 2023-05-13 11:34:20 -07:00
Andrew 727085ecaa Fixed link in v2 changelog 2023-02-27 13:53:37 -08:00
Andrew a935614790 Added v2 changelog 2023-02-27 13:48:07 -08:00
Andrew 7c063aed9d Updated Sbom task parameters 2023-02-24 11:39:47 -08:00
Andrew b83ba2ccc0 Updated EsrpSign parameters 2023-02-24 10:28:36 -08:00
Andrew 316773dfe6 release pipeline - updated machine pool 2023-02-23 20:46:55 -08:00
Andrew 11b3bd0fdb Updated version to v2.0.6 2023-02-23 20:35:27 -08:00
Andrew 4af8841d74 Added SBOM generation and changed image to PSMMS2019-Secure (#69) 2023-02-23 20:32:43 -08:00
Andrew ad361bfe4b Update release pipeline for 1ES (#61) 2023-02-23 20:32:26 -08:00
Andrew 08b5f4de0e Release pipeline updates for 1ES (#63) 2023-02-23 20:31:17 -08:00
Andrew f142525bc7 Updated version to v2.0.6 2023-02-23 20:00:37 -08:00
Andrew a9182cf60e Add ImplementationDetail member only when the member does not already exist 2023-02-23 19:59:36 -08:00
Andrew 68cfed18c9 Remove duplicate result resources from Get-DSCResourcesModules 2023-02-23 19:54:34 -08:00
Steve Lee 3ae4b6afda Change ErrorAction to Ignore so that the error doesn't show up in $Error (#93) 2023-02-23 19:51:42 -08:00
Andrew 4777a3ed77 Remove PSDesiredStateConfiguration.InvokeDscResource experimental feature. (#52) 2023-02-23 19:49:35 -08:00
Andrew 85eeda51a6 Updating CI and Release pipelines with latest Compliance (#43) 2023-02-23 19:40:46 -08:00
bagajjal 70dad1f41e support embedded resource (#38) 2023-02-23 19:37:28 -08:00
Travis Plunk 1cb7076792 Fix CI issues (#40) 2023-02-23 19:36:28 -08:00
32 changed files with 1119 additions and 4630 deletions
+53 -40
View File
@@ -21,10 +21,12 @@ stages:
- stage: Build
displayName: Build PSDesiredStateConfiguration module
pool:
vmImage: windows-latest
name: Package ES CodeHub Lab E
jobs:
- job: BuildPkg
displayName: Build Package
variables:
- group: ESRP
steps:
- powershell: |
$powerShellPath = Join-Path -Path $env:AGENT_TEMPDIRECTORY -ChildPath 'powershell'
@@ -41,14 +43,6 @@ stages:
checkLatest: false
version: 5.9.1
- task: UseDotNet@2
displayName: 'Install .NET Core SDK'
inputs:
packageType: sdk
useGlobalJson: true
includePreviewVersions: true
workingDirectory: '$(Build.SourcesDirectory)'
- pwsh: |
Get-ChildItem -Path env:
displayName: Capture environment for build
@@ -88,36 +82,77 @@ stages:
Import-Module -Name $modPath -Force
#
$(Build.SourcesDirectory)/build.ps1 -Build -Clean
$outBinPath = "$(Build.SourcesDirectory)\out\PSDesiredStateConfiguration"
$vstsCommandString = "vso[task.setvariable variable=outBinPath]${outBinPath}"
Write-Host "sending " + $vstsCommandString
Write-Host "##$vstsCommandString"
displayName: Execute build
- publish: "$(outBinPath)"
- pwsh: |
$signSrcPath = "$(Build.SourcesDirectory)\out\PSDesiredStateConfiguration"
# Set signing src path variable
$vstsCommandString = "vso[task.setvariable variable=signSrcPath]${signSrcPath}"
Write-Host "sending " + $vstsCommandString
Write-Host "##$vstsCommandString"
$signOutPath = "$(Build.SourcesDirectory)\signed\PSDesiredStateConfiguration"
$null = New-Item -ItemType Directory -Path $signOutPath
# Set signing out path variable
$vstsCommandString = "vso[task.setvariable variable=signOutPath]${signOutPath}"
Write-Host "sending " + $vstsCommandString
Write-Host "##$vstsCommandString"
# Set path variable for guardian codesign validation
$vstsCommandString = "vso[task.setvariable variable=GDN_CODESIGN_TARGETDIRECTORY]${signOutPath}"
Write-Host "sending " + $vstsCommandString
Write-Host "##$vstsCommandString"
displayName: Setup variables for signing
- template: EsrpSign.yml@ComplianceRepo
parameters:
# the folder which contains the binaries to sign
buildOutputPath: $(signSrcPath)
# the location to put the signed output
signOutputPath: $(signOutPath)
# the certificate ID to use
certificateId: "CP-230012"
# the file pattern to use, comma separated
pattern: '*.psm1,*.psd1'
- pwsh: |
$repoName = [guid]::newGuid().ToString("N")
$packageRoot = "$(Build.SourcesDirectory)\signed\PSDesiredStateConfiguration"
Register-PSRepository -Name $repoName -SourceLocation $packageRoot -InstallationPolicy Trusted
Publish-Module -Path $packageRoot -Repository $repoName
Unregister-PSRepository -Name $repoName
Get-ChildItem -Recurse -Path $packageRoot | Write-Verbose -Verbose
$nupkgPath = (Get-ChildItem -Recurse -Path $packageRoot -Filter "PSDesiredStateConfiguration*.nupkg" | select -First 1).FullName
Write-Host "##vso[artifact.upload containerfolder=nupkg;artifactname=nupkg]$nupkgPath"
displayName: Package and publish nupkg
name: ProduceNupkg
- publish: "$(signSrcPath)"
artifact: Build
displayName: Publish build
- publish: "$(signOutPath)"
artifact: SignedBuild
displayName: Publish signed build
- stage: Compliance
displayName: Compliance
dependsOn: Build
jobs:
- job: Compliance_Job
pool:
vmImage: windows-latest
name: Package ES CodeHub Lab E
steps:
- checkout: self
- checkout: ComplianceRepo
- download: current
artifact: Build
artifact: SignedBuild
- pwsh: |
Get-ChildItem -Path "$(Pipeline.Workspace)\Build" -Recurse
Get-ChildItem -Path "$(Pipeline.Workspace)\SignedBuild" -Recurse
displayName: Capture downloaded artifacts
- template: ci-compliance.yml@ComplianceRepo
parameters:
# component-governance
sourceScanPath: '$(Pipeline.Workspace)\Build'
sourceScanPath: '$(Pipeline.Workspace)\SignedBuild'
# credscan
suppressionsFile: ''
# TermCheck
@@ -127,25 +162,3 @@ stages:
codeBaseName: 'PSDesiredStateConfiguration_20210423'
# selections
APIScan: false # set to false when not using Windows APIs.
- stage: Test
displayName: Test Package
dependsOn: Build
jobs:
- template: templates/ci-test.yml
parameters:
jobName: TestPkgWin
displayName: PowerShell Core on Windows
imageName: windows-latest
- template: templates/ci-test.yml
parameters:
jobName: TestPkgUbuntu
displayName: PowerShell Core on Ubuntu
imageName: ubuntu-latest
- template: templates/ci-test.yml
parameters:
jobName: TestPkgWinMacOS
displayName: PowerShell Core on macOS
imageName: macOS-latest
+20 -15
View File
@@ -9,13 +9,19 @@ resources:
endpoint: ComplianceGHRepo
name: PowerShell/compliance
variables:
- name: PackageName
value: 'PSDesiredStateConfiguration'
- name: PackageVersion
value: '2.0.6'
stages:
- stage: Build
displayName: Build PSDesiredStateConfiguration module
pool:
name: 1ES
name: PowerShell1ES
demands:
- ImageOverride -equals MMS2019
- ImageOverride -equals PSMMS2019-Secure
jobs:
- job: BuildPkg
displayName: Build Package
@@ -37,14 +43,6 @@ stages:
checkLatest: false
version: 5.9.1
- task: UseDotNet@2
displayName: 'Install .NET Core SDK'
inputs:
packageType: sdk
useGlobalJson: true
includePreviewVersions: true
workingDirectory: '$(Build.SourcesDirectory)'
- pwsh: |
Get-ChildItem -Path env:
displayName: Capture environment for build
@@ -113,7 +111,14 @@ stages:
# the certificate ID to use
certificateId: "CP-230012"
# the file pattern to use, comma separated
pattern: '*.psm1,*.psd1,Microsoft.PowerShell.DscSubsystem.dll'
pattern: '*.psm1,*.psd1'
- template: Sbom.yml@ComplianceRepo
parameters:
BuildDropPath: "$(Build.SourcesDirectory)/signed/PSDesiredStateConfiguration"
Build_Repository_Uri: 'https://github.com/PowerShell/PSDesiredStateConfiguration'
PackageName: $(PackageName)
PackageVersion: $(PackageVersion)
- pwsh: |
$repoName = [guid]::newGuid().ToString("N")
@@ -141,9 +146,9 @@ stages:
jobs:
- job: Compliance_Job
pool:
name: 1ES
name: PowerShell1ES
demands:
- ImageOverride -equals MMS2019
- ImageOverride -equals PSMMS2019-Secure
steps:
- checkout: self
- checkout: ComplianceRepo
@@ -176,9 +181,9 @@ stages:
- deployment: DeployPowerShellGallery
displayName: Deploy nupkg to PowerShell Gallery
pool:
name: 1ES
name: PowerShell1ES
demands:
- ImageOverride -equals MMS2019
- ImageOverride -equals PSMMS2019-Secure
environment: 'PSDesiredStateConfiguration-ReleaseApproval'
strategy:
runOnce:
+19
View File
@@ -0,0 +1,19 @@
name: PR-$(System.PullRequest.PullRequestNumber)-$(Date:yyyyMMdd)$(Rev:.rr)
trigger:
# Batch merge builds together while a merge build is running
batch: true
branches:
include:
- master
pr:
branches:
include:
- master
resources:
- repo: self
clean: true
jobs:
- template: templates/credscan.yml
+16
View File
@@ -0,0 +1,16 @@
steps:
- pwsh: |
Install-Module -Name "platyPS","Pester" -Force
displayName: Install dependencies
timeoutInMinutes: 10
- pwsh: |
Install-Module -Name "PSScriptAnalyzer" -RequiredVersion 1.18.0 -Force
displayName: Install PSScriptAnalyzer
timeoutInMinutes: 10
- pwsh: |
Install-Module -Name PSPackageProject -Force
displayName: Install PSPackageProject module
timeoutInMinutes: 10
- pwsh: |
$(Build.SourcesDirectory)/build.ps1 -Build
displayName: Build
+104 -56
View File
@@ -10,65 +10,113 @@ jobs:
vmImage: ${{ parameters.imageName }}
displayName: ${{ parameters.displayName }}
steps:
- powershell: |
$powerShellPath = Join-Path -Path $env:AGENT_TEMPDIRECTORY -ChildPath 'powershell'
- ${{ parameters.powershellExecutable }}: |
if($IsMacOs)
{
brew install powershell/tap/powershell-preview
sudo ln -s -f /usr/local/opt/powershell-preview/libexec/pwsh /usr/local/bin/pwsh
}
elseif($IsLinux)
{
sudo apt-get update
sudo apt-get install powershell-preview
sudo ln -s /opt/microsoft/powershell/7-preview/pwsh /usr/local/bin/pwsh
}
elseif($IsWindows)
{
Invoke-WebRequest -Uri https://raw.githubusercontent.com/PowerShell/PowerShell/master/tools/install-powershell.ps1 -outfile ./install-powershell.ps1
./install-powershell.ps1 -Preview -Destination $powerShellPath
$newPath = $powerShellPath + [System.IO.Path]::PathSeparator + $env:PATH
$vstsCommandString = "vso[task.setvariable variable=PATH]$newPath"
./install-powershell.ps1 -AddToPath -Preview -Destination C:\powershell-preview
$vstsCommandString = "vso[task.setvariable variable=PATH]C:\powershell-preview;$env:PATH"
Write-Host "sending " + $vstsCommandString
Write-Host "##$vstsCommandString"
displayName: Install PowerShell Core
}
displayName: Setup PowerShell preview
- pwsh: |
$modulePath = Join-Path -Path $env:AGENT_TEMPDIRECTORY -ChildPath 'TempModules'
if (Test-Path -Path $modulePath) {
Write-Verbose -Verbose "Deleting existing temp module path: $modulePath"
Remove-Item -Path $modulePath -Recurse -Force -ErrorAction Ignore
}
if (! (Test-Path -Path $modulePath)) {
Write-Verbose -Verbose "Creating new temp module path: $modulePath"
$null = New-Item -Path $modulePath -ItemType Directory
}
displayName: Create temporary module path
- ${{ parameters.powershellExecutable }}: |
$PSVersionTable
$vstsCommandString = "vso[task.setvariable variable=PSHOME]$pshome"
Write-Host "sending " + $vstsCommandString
Write-Host "##$vstsCommandString"
displayName: Capture PowerShellVersion
- pwsh: |
$modulePath = Join-Path -Path $env:AGENT_TEMPDIRECTORY -ChildPath 'TempModules'
Write-Verbose -Verbose "Install PowerShellGet V3 to temp module path"
Save-Module -Name PowerShellGet -Path $modulePath -MinimumVersion 3.0.0-beta10 -AllowPrerelease -Force
Write-Verbose -Verbose "Install PlatyPS to temp module path"
Save-Module -Name "platyPS" -Path $modulePath -Force
Write-Verbose -Verbose "Install PSScriptAnalyzer to temp module path"
Save-Module -Name "PSScriptAnalyzer" -Path $modulePath -RequiredVersion 1.18.0 -Force
Write-Verbose -Verbose "Install Pester 4.X to temp module path"
Save-Module -Name "Pester" -MaximumVersion 4.99 -Path $modulePath -Force
Write-Verbose -Verbose "Install PSPackageProject to temp module path"
Save-Module -Name PSPackageProject -Path $modulePath -Force
#
$vstsCommandString = "vso[task.setvariable variable=modulePath]${modulePath}"
Write-Host "sending " + $vstsCommandString
Write-Host "##$vstsCommandString"
displayName: Install PSPackageProject and dependencies
- download: current
artifact: Build
- ${{ parameters.powershellExecutable }}: |
dir env:PATH
displayName: Capture Path
- pwsh: |
"PSVersionTable is"| Write-Verbose -Verbose
$PSVersionTable | Out-String | Write-Verbose -Verbose
#
$targetModuleLocation = Join-Path -Path $(modulePath) -ChildPath 'PSDesiredStateConfiguration'
Move-Item -Path "$(Pipeline.Workspace)\Build" -Destination $targetModuleLocation -Force
#
$env:PSModulePath = '$(modulePath)' + [System.IO.Path]::PathSeparator + $env:PSModulePath
"PSModulePath is"| Write-Verbose -Verbose
$env:PSModulePath | Write-Verbose -Verbose
#
Get-Module -ListAvailable -Name PSDesiredStateConfiguration | select Name,Version,PreRelease,Path | Write-Verbose -Verbose
#
"Listing contents of $targetModuleLocation"| Write-Verbose -Verbose
Get-ChildItem -Recurse -Path $targetModuleLocation | Write-Verbose -Verbose
#
Invoke-PSPackageProjectTest -Type Functional
displayName: Execute functional tests
errorActionPreference: continue
- ${{ parameters.powershellExecutable }}: |
Get-PSRepository
displayName: Capture PSRepository
- ${{ parameters.powershellExecutable }}: |
Install-module Pester -Force -MaximumVersion 4.99
displayName: Install dependencies - Pester
timeoutInMinutes: 10
- ${{ parameters.powershellExecutable }}: |
Install-Module -Name "platyPS" -Force
displayName: Install dependencies - PlatyPS
timeoutInMinutes: 10
- ${{ parameters.powershellExecutable }}: |
Install-Module -Name "PSScriptAnalyzer" -RequiredVersion 1.18.0 -Force
displayName: Install dependencies - PSScriptAnalyzer
timeoutInMinutes: 10
- ${{ parameters.powershellExecutable }}: |
Install-Module -Name PSPackageProject -Force
displayName: Install PSPackageProject module
- ${{ parameters.powershellExecutable }}: |
Get-InstalledModule -Name pester -AllVersions | Where-Object {$_.Version -ge ([version]::new(5,0,0))} | Uninstall-Module -Force
displayName: Remove >= 5.0.0 Pester
- task: DownloadBuildArtifacts@0
displayName: 'Download artifacts'
inputs:
buildType: current
downloadType: specific
itemPattern: '**/*.nupkg'
downloadPath: '$(System.ArtifactsDirectory)'
- ${{ parameters.powershellExecutable }}: |
$sourceName = 'pspackageproject-local-repo'
Register-PSRepository -Name $sourceName -SourceLocation '$(System.ArtifactsDirectory)' -ErrorAction Ignore
$config = Get-PSPackageProjectConfiguration
$buildOutputPath = $config.BuildOutputPath
$null = New-Item -ItemType Directory -Path $buildOutputPath -Verbose
$moduleName = $config.ModuleName
Save-Module -Repository $sourceName -Name $moduleName -Path $config.BuildOutputPath
displayName: Extract product artifact
timeoutInMinutes: 10
- ${{ parameters.powershellExecutable }}: |
Invoke-PSPackageProjectTest -Type Functional
displayName: Execute functional tests - InvokeDscResource Disabled
errorActionPreference: continue
- ${{ parameters.powershellExecutable }}: |
$configFolder = split-path $PROFILE
$configPath = Join-Path $configFolder -ChildPath powershell.config.json
copy-Item $(Build.SourcesDirectory)/assets/powershell.config.json $configPath
displayName: Enable ExperimentalFeature
errorActionPreference: continue
- ${{ parameters.powershellExecutable }}: |
Invoke-PSPackageProjectTest -Type Functional
displayName: Execute functional tests - InvokeDscResource Enabled
errorActionPreference: continue
- ${{ parameters.powershellExecutable }}: |
Invoke-PSPackageProjectTest -Type StaticAnalysis
displayName: Execute static analysis tests
# need to figure out how to disable PSAvoidOverwritingBuiltInCmdlets
continueOnError: true
errorActionPreference: continue
condition: succeededOrFailed()
- ${{ parameters.powershellExecutable }}: |
Unregister-PSRepository -Name 'pspackageproject-local-repo' -ErrorAction Ignore
displayName: Unregister temporary PSRepository
condition: always()
timeoutInMinutes: 10
+31
View File
@@ -0,0 +1,31 @@
parameters:
pool: 'Hosted VS2017'
jobName: 'credscan'
displayName: Secret Scan
jobs:
- job: ${{ parameters.jobName }}
pool:
name: ${{ parameters.pool }}
displayName: ${{ parameters.displayName }}
steps:
- powershell: Write-Host "##vso[build.updatebuildnumber]$env:BUILD_SOURCEBRANCHNAME-$env:BUILD_SOURCEVERSION-$((get-date).ToString("yyyyMMddhhmmss"))"
displayName: Set Build Name for Non-PR
condition: ne(variables['Build.Reason'], 'PullRequest')
- task: securedevelopmentteam.vss-secure-development-tools.build-task-credscan.CredScan@2
displayName: 'Scan for secrets'
inputs:
debugMode: false
- task: securedevelopmentteam.vss-secure-development-tools.build-task-publishsecurityanalysislogs.PublishSecurityAnalysisLogs@2
displayName: 'Publish Secret Scan Logs to Build Artifacts'
continueOnError: true
- task: securedevelopmentteam.vss-secure-development-tools.build-task-postanalysis.PostAnalysis@1
displayName: 'Check for failures'
inputs:
CredScan: true
ToolLogsNotFoundAction: Error
+17
View File
@@ -0,0 +1,17 @@
steps:
- powershell: |
$shouldSign = $true
if($env:BUILD_REASON -ne 'Manual')
{
$shouldSign = $false
}
if($env:SKIP_SIGNING -eq 'Yes')
{
$shouldSign = $false
}
$vstsCommandString = "vso[task.setvariable variable=SHOULD_SIGN]$($shouldSign.ToString().ToLowerInvariant())"
Write-Host ("sending " + $vstsCommandString)
Write-Host "##$vstsCommandString"
displayName: 'Set SHOULD_SIGN Variable'
+3
View File
@@ -0,0 +1,3 @@
# Changelogs
* [v2 changelog](v2.md)
+23
View File
@@ -0,0 +1,23 @@
# v2 Changelog
## [v2.0.7]
### Main changes
- Fixed Invoke-DscResource error when a class-based resource module path contains a space.
[v2.0.7]: https://www.powershellgallery.com/packages/PSDesiredStateConfiguration/2.0.7
## [v2.0.6]
### Main changes
- Fixed `PathSeparator` bug in Get-DSCResourceModules.
- Changed `PSDesiredStateConfiguration.InvokeDscResource` from experimental to permanently enabled feature.
- Changed `ErrorAction` to `Ignore` so that the error doesn't show up in `$Error`.
- Removed duplicate result resources from `Get-DSCResourcesModules`.
- Add `ImplementationDetail` member to results only when the member does not already exist.
- Updated v2 Release pipeline with latest Compliance requirements.
- Added SBOM generation that is now released with v2 module.
[v2.0.6]: https://www.powershellgallery.com/packages/PSDesiredStateConfiguration/2.0.6
+26 -14
View File
@@ -1,19 +1,31 @@
# PSDesiredStateConfiguration module
# How to Create PSDesiredStateConfiguration NuGet package for PoweShell Core
- Modify psm1 file in PSDesiredStateConfiguration module.
-- Remove the signature from the bottom of the file.
-- Add your changes.
-- Get it signed from DSC Azure dev ops pipeline.
Following is the expected signing settings:
<file src="__INPATHROOT__\Modules\PSDesiredStateConfiguration\PSDesiredStateConfiguration.psm1" signType="AuthenticodeFormer" dest="__OUTPATHROOT__\Modules\PSDesiredStateConfiguration\PSDesiredStateConfiguration.psm1" />
## Build
- Other files under PSDesiredStateConfiguration module doesnt need to be signed, you can modify them directly.
### Requirements
- [Any recent PowerShell Core release](https://github.com/PowerShell/powershell/releases) to run the build script
- [.NET Core SDK](https://dotnet.microsoft.com/download/dotnet/thank-you/sdk-6.0.100-preview.4-windows-x64-binaries) of the version specified in `global.json` (`dotnet` should be visible through PATH env var)
- [`PSPackageProject` module](https://www.powershellgallery.com/packages/PSPackageProject) installed from PS Gallery
- Change the version in nuget spec file.
### Build Process
- Run `build.ps1 -Build -Clean`
- Compiled module will be in `./out/PSDesiredStateConfiguration`
- Check-in these changes in DesiredStateConfiguration repository.
## CI - Continuous Integration
CI pipeline definition is in `.vsts-ci\azure-pipelines-ci.yml` and running Compliance and Pester tests in `test\PSDesiredStateConfiguration.Tests.ps1` on Windows, Linux and Mac. CI builds are not signed.
- Create a NuGet package by running following command, it will generate NuGet package (PSDesiredStateConfiguration.6.2.0.nupkg). Get it published by PowerShell team.
nuget pack .\psdesiredstateconfiguration.nuspec
## Publishing Releases
[The module is released on Powershell Gallery](https://www.powershellgallery.com/packages/PSDesiredStateConfiguration).
For a release the code of this repo is mirrored into an internal repo and `.vsts-ci\azure-pipelines-release.yml` pipeline is run. Release builds are signed.
# Modify PowerShell code to pick up new version of NuGet package.
- Sync PowerShell/PowerShell repository and change NuGet package version in following files
src/powershell-unix/powershell-unix.csproj
src/powershell-win-core/powershell-win-core.csproj
```sh
<ItemGroup>
- <PackageReference Include="PSDesiredStateConfiguration" Version="6.0.0-beta.8" />
+ <PackageReference Include="PSDesiredStateConfiguration" Version="6.2.0" />
<PackageReference Include="PowerShellHelpFiles" Version="1.0.0-*" />
</ItemGroup>
```
- Send PR to PowerShell team
+1
View File
@@ -0,0 +1 @@
{"ExperimentalFeatures":["PSCommandNotFoundSuggestion","PSForEachObjectParallel","PSImplicitRemotingBatching","Microsoft.PowerShell.Utility.PSDebugRunspaceWithBreakpoints","PSDesiredStateConfiguration.InvokeDscResource"]}
+19 -25
View File
@@ -13,42 +13,36 @@ Implement build and packaging of the package and place the output $OutDirectory/
function DoBuild
{
Write-Verbose -Verbose -Message "Starting DoBuild"
Write-Verbose -Verbose -Message "Make sure that 'nuget' and 'dotnet' are visible through PATH"
Write-Verbose -Verbose -Message "Copying module files to '${OutDirectory}/${ModuleName}'"
# copy psm1 and psd1 files
copy-item "${SrcPath}/*" "${OutDirectory}/${ModuleName}" -Recurse
#
$smaPackageVersionToUse = "7.2.0-preview.6" # 7.2.0-preview.6 - is the first SMA version that has DSC subsystem changes
$subsystemCodePath = Resolve-Path "${SrcPath}/../DscSubsystem"
Write-Verbose -Verbose -Message "Subsystem code path ${subsystemCodePath}"
# copy help
Write-Verbose -Verbose -Message "Copying help files to '${OutDirectory}/${ModuleName}'"
copy-item -Recurse "${HelpPath}/${Culture}" "${OutDirectory}/${ModuleName}"
if ( Test-Path $subsystemCodePath )
{
if ( Test-Path "${SrcPath}/code" ) {
Write-Verbose -Verbose -Message "Building assembly and copying to '${OutDirectory}/${ModuleName}'"
Push-Location $subsystemCodePath
$PackageReferencesPath = Join-Path $subsystemCodePath "PackageReferences"
nuget install System.Management.Automation -OutputDirectory ./PackageReferences -PreRelease -Version $smaPackageVersionToUse -DependencyVersion Ignore -ExcludeVersion
dotnet publish
$subsystemBinPath = Join-Path (Get-ChildItem -Recurse "publish" -Directory) "Microsoft.PowerShell.DscSubsystem.dll"
if (Test-Path $subsystemBinPath)
{
Copy-Item $subsystemBinPath "${OutDirectory}/${ModuleName}"
# build code and place it in the staging location
try {
Push-Location "${SrcPath}/code"
$result = dotnet publish
copy-item "bin/Debug/netstandard2.0/publish/${ModuleName}.dll" "${OutDirectory}/${ModuleName}"
}
else
{
Write-Error -Message "dotnet build failed - $subsystemBinPath not found"
catch {
$result | ForEach-Object { Write-Warning $_ }
Write-Error "dotnet build failed"
}
finally {
Pop-Location
}
Pop-Location
}
else {
Write-Error -Message "No code to build in '$subsystemCodePath'"
Write-Verbose -Verbose -Message "No code to build in '${SrcPath}/code'"
}
## Add build and packaging here
Write-Verbose -Verbose -Message "Ending DoBuild"
}
-5
View File
@@ -1,5 +0,0 @@
{
"sdk": {
"version": "6.0.100-preview.4.21255.9"
}
}
-10
View File
@@ -1,10 +0,0 @@
<?xml version="1.0" encoding="utf-8"?>
<configuration>
<packageSources>
<clear />
<add key="nuget.org" value="https://api.nuget.org/v3/index.json" />
</packageSources>
<disabledPackageSources>
<clear />
</disabledPackageSources>
</configuration>
+17
View File
@@ -0,0 +1,17 @@
<?xml version="1.0" encoding="utf-8"?>
<package xmlns="http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd">
<metadata minClientVersion="3.4">
<id>PSDesiredStateConfiguration</id>
<version>2.0</version>
<title>PSDesiredStateConfiguration</title>
<authors>Microsoft</authors>
<owners>microsoft,powershell</owners>
<requireLicenseAcceptance>false</requireLicenseAcceptance>
<description>Provides pre-built PSDesiredStateConfiguration module for PowerShell.</description>
<summary></summary>
<copyright>© Microsoft Corporation. All rights reserved.</copyright>
<contentFiles>
<files include="**/*" buildAction="None" copyToOutput="true" flatten="false" />
</contentFiles>
</metadata>
</package>
-89
View File
@@ -1,89 +0,0 @@
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
#nullable enable
using System;
using System.Collections.ObjectModel;
using System.Collections.Generic;
using System.Management.Automation;
using System.Management.Automation.Internal;
using System.Management.Automation.Language;
namespace System.Management.Automation.Subsystem.DSC
{
/// <summary>
/// Interface for implementing a cross platform desired state configuration component.
/// </summary>
public class CrossPlatformDsc : ICrossPlatformDsc, IModuleAssemblyInitializer
{
/// <summary>
/// Gets the unique identifier for a subsystem implementation.
/// </summary>
public Guid Id { get {return Guid.NewGuid();} }
/// <summary>
/// Gets the name of a subsystem implementation.
/// </summary>
public string Name { get {return "Cross platform desired state configuration";} }
/// <summary>
/// Gets the description of a subsystem implementation.
/// </summary>
public string Description { get {return "Cross platform desired state configuration";} }
/// <summary>
/// Gets a dictionary that contains the functions to be defined at the global scope of a PowerShell session.
/// Key: function name; Value: function script.
/// </summary>
Dictionary<string, string>? ISubsystem.FunctionsToDefine => null;
/// <summary>
/// Test.
/// </summary>
public void LoadDefaultKeywords(Collection<Exception> errors)
{
Microsoft.PowerShell.DesiredStateConfiguration.Internal.CrossPlatform.DscClassCache.LoadDefaultCimKeywords(errors);
}
/// <summary>
/// Default summary.
/// </summary>
public void ClearCache()
{
Microsoft.PowerShell.DesiredStateConfiguration.Internal.CrossPlatform.DscClassCache.ClearCache();
}
/// <summary>
/// Default summary.
/// </summary>
public string GetDSCResourceUsageString(DynamicKeyword keyword)
{
return Microsoft.PowerShell.DesiredStateConfiguration.Internal.CrossPlatform.DscClassCache.GetDSCResourceUsageString(keyword);
}
/// <summary>
/// Checks if a string is one of dynamic keywords that can be used in both configuration and meta configuration.
/// </summary>
public bool IsSystemResourceName(string name)
{
return Microsoft.PowerShell.DesiredStateConfiguration.Internal.CrossPlatform.DscClassCache.SystemResourceNames.Contains(name);
}
/// <summary>
/// Checks if a string matches default module name used for meta configuration resources.
/// </summary>
public bool IsDefaultModuleNameForMetaConfigResource(string name)
{
return name.Equals(Microsoft.PowerShell.DesiredStateConfiguration.Internal.CrossPlatform.DscClassCache.DefaultModuleInfoForMetaConfigResource.Item1, StringComparison.OrdinalIgnoreCase);
}
public void OnImport()
{
if (SubsystemManager.GetSubsystem<ICrossPlatformDsc>() == null)
{
SubsystemManager.RegisterSubsystem(SubsystemKind.CrossPlatformDsc, this);
}
}
}
}
-68
View File
@@ -1,68 +0,0 @@
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System;
using System.Collections;
using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
using System.Globalization;
using System.IO;
using System.Management.Automation;
using System.Security;
namespace Microsoft.PowerShell.DesiredStateConfiguration.Internal.CrossPlatform
{
/// <summary>
/// Class that does high level Cim schema parsing.
/// </summary>
internal class CimDSCParser
{
private readonly JsonDeserializer _jsonDeserializer;
internal CimDSCParser()
{
_jsonDeserializer = JsonDeserializer.Create();
}
internal IEnumerable<PSObject> ParseSchemaJson(string filePath, bool useNewRunspace = false)
{
try
{
string json = File.ReadAllText(filePath);
string fileNameDefiningClass = Path.GetFileNameWithoutExtension(filePath);
int dotIndex = fileNameDefiningClass.IndexOf(".schema", StringComparison.InvariantCultureIgnoreCase);
if (dotIndex != -1)
{
fileNameDefiningClass = fileNameDefiningClass.Substring(0, dotIndex);
}
IEnumerable<PSObject> result = _jsonDeserializer.DeserializeClasses(json, useNewRunspace);
foreach (dynamic classObject in result)
{
string superClassName = classObject.SuperClassName;
string className = classObject.ClassName;
if (string.Equals(superClassName, "OMI_BaseResource", StringComparison.OrdinalIgnoreCase))
{
// Get the name of the file without schema.mof/json extension
if (!className.Equals(fileNameDefiningClass, StringComparison.OrdinalIgnoreCase))
{
PSInvalidOperationException e = PSTraceSource.NewInvalidOperationException(
ParserStrings.ClassNameNotSameAsDefiningFile, className, fileNameDefiningClass);
throw e;
}
}
}
return result;
}
catch (Exception exception)
{
PSInvalidOperationException e = PSTraceSource.NewInvalidOperationException(
exception, ParserStrings.CimDeserializationError, filePath);
e.SetErrorId("CimDeserializationError");
throw e;
}
}
}
}
-72
View File
@@ -1,72 +0,0 @@
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System;
using System.Collections;
using System.Collections.Generic;
using System.Management.Automation;
using System.Management.Automation.Runspaces;
namespace Microsoft.PowerShell.DesiredStateConfiguration.Internal.CrossPlatform
{
internal class JsonDeserializer
{
#region Constructors
/// <summary>
/// Instantiates a default deserializer.
/// </summary>
/// <returns>Default deserializer.</returns>
public static JsonDeserializer Create()
{
return new JsonDeserializer();
}
#endregion Constructors
#region Methods
/// <summary>
/// Returns schema of Cim classes from specified json file.
/// </summary>
/// <param name="json">Json text to deserialize.</param>
/// <param name="useNewRunspace">If a new runspace should be used.</param>
/// <returns>Deserialized PSObjects.</returns>
public IEnumerable<PSObject> DeserializeClasses(string json, bool useNewRunspace = false)
{
if (string.IsNullOrEmpty(json))
{
throw new ArgumentNullException(nameof(json));
}
System.Management.Automation.PowerShell powerShell = null;
if (useNewRunspace)
{
// currently using RunspaceMode.NewRunspace will reset PSModulePath env var for the entire process
// this is something we want to avoid in DSC GuestConfigAgent scenario, so we use following workaround
var s_iss = InitialSessionState.CreateDefault();
s_iss.EnvironmentVariables.Add(
new SessionStateVariableEntry(
"PSModulePath",
Environment.GetEnvironmentVariable("PSModulePath"),
description: null));
powerShell = System.Management.Automation.PowerShell.Create(s_iss);
}
else
{
powerShell = System.Management.Automation.PowerShell.Create(RunspaceMode.CurrentRunspace);
}
using (powerShell)
{
return powerShell.AddCommand("Microsoft.PowerShell.Utility\\ConvertFrom-Json")
.AddParameter("InputObject", json)
.AddParameter("Depth", 100) // maximum supported by cmdlet
.Invoke();
}
}
#endregion Methods
}
}
File diff suppressed because it is too large Load Diff
@@ -1,20 +0,0 @@
<!-- USE "./build.ps1 -Build" TO BUILD THIS -->
<Project Sdk="Microsoft.NET.Sdk" ToolsVersion="15.0">
<PropertyGroup>
<TargetFramework>net6.0</TargetFramework>
<PlatformTarget>AnyCPU</PlatformTarget>
<AssemblyName>Microsoft.PowerShell.DscSubsystem</AssemblyName>
<!-- Assembly is fully signed in \.vsts-ci\azure-pipelines-release.yml -->
<DelaySign>true</DelaySign>
<AssemblyOriginatorKeyFile>visualstudiopublic.snk</AssemblyOriginatorKeyFile>
<SignAssembly>true</SignAssembly>
</PropertyGroup>
<ItemGroup>
<!-- Can't use PackageReference here because subsystem uses internal SMA types that are not available in `ref` version of the SMA package.
So a workaround is to download SMA package and reference local file (full runtime SMA assembly) in `runtimes` folder. -->
<Reference Include="PackageReferences/System.Management.Automation/runtimes/win/lib/net6.0/System.Management.Automation.dll"></Reference>
</ItemGroup>
</Project>
Binary file not shown.
@@ -1,232 +0,0 @@
[
{
"ClassName": "MSFT_Credential",
"ClassVersion": "1.0.0",
"ClassProperties": [
{
"Name": "UserName",
"CimType": "String",
"Qualifiers": {
"MaxLen": 256
}
},
{
"Name": "Password",
"CimType": "String"
}
]
},
{
"ClassName": "OMI_BaseResource",
"ClassVersion": "1.0.0",
"ClassProperties": [
{
"Name": "ResourceId",
"CimType": "String",
"Qualifiers": {
"Required": true
}
},
{
"Name": "SourceInfo",
"CimType": "String",
"Qualifiers": {
"Write": true
}
},
{
"Name": "DependsOn",
"CimType": "StringArray",
"Qualifiers": {
"Write": true
}
},
{
"Name": "ModuleName",
"CimType": "String",
"Qualifiers": {
"Required": true
}
},
{
"Name": "ModuleVersion",
"CimType": "String",
"Qualifiers": {
"Required": true
}
},
{
"Name": "ConfigurationName",
"CimType": "String",
"Qualifiers": {
"Write": true
}
},
{
"Name": "PsDscRunAsCredential",
"CimType": "Instance",
"ReferenceClassName": "MSFT_Credential",
"Qualifiers": {
"Write": true,
"EmbeddedInstance": "MSFT_Credential"
}
}
]
},
{
"ClassName": "MSFT_KeyValuePair",
"ClassVersion": "1.0.0",
"ClassProperties": [
{
"Name": "Key",
"CimType": "String",
"Qualifiers": {
"Key": true
}
},
{
"Name": "Value",
"CimType": "String",
"Qualifiers": {
"Write": true
}
}
]
},
{
"ClassName": "MSFT_BaseConfigurationProviderRegistration",
"ClassVersion": "1.0.0",
"ClassProperties": [
{
"Name": "ClassName",
"CimType": "String",
"Qualifiers": {
"Key": true
}
},
{
"Name": "DSCEngineCompatVersion",
"CimType": "String"
},
{
"Name": "DSCModuleVersion",
"CimType": "String"
}
]
},
{
"ClassName": "MSFT_CimConfigurationProviderRegistration",
"ClassVersion": "1.0.0",
"SuperClassName": "MSFT_BaseConfigurationProviderRegistration",
"ClassProperties": [
{
"Name": "Namespace",
"CimType": "String"
}
]
},
{
"ClassName": "MSFT_PSConfigurationProviderRegistration",
"ClassVersion": "1.0.0",
"SuperClassName": "MSFT_BaseConfigurationProviderRegistration",
"ClassProperties": [
{
"Name": "ModuleName",
"CimType": "String"
},
{
"Name": "ProviderPath",
"CimType": "String"
},
{
"Name": "ModulePath",
"CimType": "String"
}
]
},
{
"ClassName": "OMI_ConfigurationDocument",
"ClassVersion": "1.0.0",
"ClassProperties": [
{
"Name": "Version",
"CimType": "String"
},
{
"Name": "Author",
"CimType": "String"
},
{
"Name": "Copyright",
"CimType": "String"
},
{
"Name": "HelpInfoUri",
"CimType": "String"
},
{
"Name": "ContentType",
"CimType": "String"
},
{
"Name": "GenerationDate",
"CimType": "String"
},
{
"Name": "GenerationHost",
"CimType": "String"
},
{
"Name": "Name",
"CimType": "String"
},
{
"Name": "MinimumCompatibleVersion",
"CimType": "String"
},
{
"Name": "CompatibleVersionAdditionalProperties",
"CimType": "StringArray"
},
{
"Name": "UseCms",
"CimType": "Boolean"
}
]
},
{
"ClassName": "OMI_MetaConfigurationResource",
"ClassVersion": "1.0.0",
"ClassProperties": [
{
"Name": "ResourceId",
"CimType": "String",
"Qualifiers": {
"Required": true
}
},
{
"Name": "SourceInfo",
"CimType": "String",
"Qualifiers": {
"Write": true
}
}
]
},
{
"ClassName": "OMI_ResourceModuleManager",
"ClassVersion": "1.0.0",
"SuperClassName": "OMI_MetaConfigurationResource"
},
{
"ClassName": "OMI_ConfigurationDownloadManager",
"ClassVersion": "1.0.0",
"SuperClassName": "OMI_MetaConfigurationResource"
},
{
"ClassName": "OMI_ReportManager",
"ClassVersion": "1.0.0",
"SuperClassName": "OMI_MetaConfigurationResource"
}
]
@@ -1,218 +0,0 @@
{
"ClassName": "MSFT_DSCMetaConfiguration",
"FriendlyName": "LocalConfigurationManager",
"ClassVersion": "1.0.0",
"ClassProperties": [
{
"Name": "ConfigurationModeFrequencyMins",
"CimType": "UInt32"
},
{
"Name": "RebootNodeIfNeeded",
"CimType": "Boolean"
},
{
"Name": "ConfigurationMode",
"CimType": "String",
"Qualifiers": {
"ValueMap": [
"ApplyOnly",
"ApplyAndMonitor",
"ApplyAndAutoCorrect",
"MonitorOnly"
],
"Values": [
"ApplyOnly",
"ApplyAndMonitor",
"ApplyAndAutoCorrect",
"MonitorOnly"
]
}
},
{
"Name": "ActionAfterReboot",
"CimType": "String",
"Qualifiers": {
"ValueMap": [
"ContinueConfiguration",
"StopConfiguration"
],
"Values": [
"ContinueConfiguration",
"StopConfiguration"
]
}
},
{
"Name": "Credential",
"CimType": "Instance",
"ReferenceClassName": "MSFT_Credential",
"Qualifiers": {
"EmbeddedInstance": "MSFT_Credential"
}
},
{
"Name": "RefreshMode",
"CimType": "String",
"Qualifiers": {
"ValueMap": [
"Push",
"Pull",
"Disabled"
],
"Values": [
"Push",
"Pull",
"Disabled"
]
}
},
{
"Name": "CertificateID",
"CimType": "String"
},
{
"Name": "ConfigurationID",
"CimType": "String"
},
{
"Name": "DownloadManagerName",
"CimType": "String"
},
{
"Name": "DownloadManagerCustomData",
"CimType": "InstanceArray",
"ReferenceClassName": "MSFT_KeyValuePair",
"Qualifiers": {
"EmbeddedInstance": "MSFT_KeyValuePair"
}
},
{
"Name": "RefreshFrequencyMins",
"CimType": "UInt32"
},
{
"Name": "AllowModuleOverwrite",
"CimType": "Boolean"
},
{
"Name": "DebugMode",
"CimType": "StringArray",
"Qualifiers": {
"ValueMap": [
"None",
"ForceModuleImport",
"All",
"ResourceScriptBreakAll",
"ResourceScriptBreakpoint"
],
"Values": [
"None",
"ForceModuleImport",
"All",
"ResourceScriptBreakAll",
"ResourceScriptBreakpoint"
]
}
},
{
"Name": "LCMVersion",
"CimType": "String",
"Qualifiers": {
"Read": true
}
},
{
"Name": "LCMCompatibleVersions",
"CimType": "StringArray",
"Qualifiers": {
"Read": true
}
},
{
"Name": "LCMState",
"CimType": "String",
"Qualifiers": {
"Read": true,
"ValueMap": [
"Idle",
"Busy",
"PendingReboot",
"PendingConfiguration"
],
"Values": [
"Idle",
"Busy",
"PendingReboot",
"PendingConfiguration"
]
}
},
{
"Name": "LCMStateDetail",
"CimType": "String",
"Qualifiers": {
"Read": true
}
},
{
"Name": "ConfigurationDownloadManagers",
"CimType": "InstanceArray",
"ReferenceClassName": "OMI_ConfigurationDownloadManager",
"Qualifiers": {
"EmbeddedInstance": "OMI_ConfigurationDownloadManager"
}
},
{
"Name": "ResourceModuleManagers",
"CimType": "InstanceArray",
"ReferenceClassName": "OMI_ResourceModuleManager",
"Qualifiers": {
"EmbeddedInstance": "OMI_ResourceModuleManager"
}
},
{
"Name": "ReportManagers",
"CimType": "InstanceArray",
"ReferenceClassName": "OMI_ReportManager",
"Qualifiers": {
"EmbeddedInstance": "OMI_ReportManager"
}
},
{
"Name": "PartialConfigurations",
"CimType": "InstanceArray",
"ReferenceClassName": "MSFT_PartialConfiguration",
"Qualifiers": {
"EmbeddedInstance": "MSFT_PartialConfiguration"
}
},
{
"Name": "StatusRetentionTimeInDays",
"CimType": "UInt32"
},
{
"Name": "AgentId",
"CimType": "String",
"Qualifiers": {
"Read": true
}
},
{
"Name": "SignatureValidationPolicy",
"CimType": "String"
},
{
"Name": "SignatureValidations",
"CimType": "InstanceArray",
"ReferenceClassName": "MSFT_SignatureValidation",
"Qualifiers": {
"EmbeddedInstance": "MSFT_SignatureValidation"
}
},
{
"Name": "MaximumDownloadSizeMB",
"CimType": "UInt32"
}
]
}
@@ -1,455 +0,0 @@
[
{
"ClassName": "MSFT_WebDownloadManager",
"FriendlyName": "ConfigurationRepositoryWeb",
"ClassVersion": "1.0.0",
"SuperClassName": "OMI_ConfigurationDownloadManager",
"ClassProperties": [
{
"Name": "ServerURL",
"CimType": "String",
"Qualifiers": {
"Key": true
}
},
{
"Name": "CertificateID",
"CimType": "String"
},
{
"Name": "AllowUnsecureConnection",
"CimType": "Boolean"
},
{
"Name": "RegistrationKey",
"CimType": "String"
},
{
"Name": "ConfigurationNames",
"CimType": "StringArray"
},
{
"Name": "ProxyURL",
"CimType": "String"
},
{
"Name": "ProxyCredential",
"CimType": "Instance",
"ReferenceClassName": "MSFT_Credential",
"Qualifiers": {
"EmbeddedInstance": "MSFT_Credential"
}
}
]
},
{
"ClassName": "MSFT_FileDownloadManager",
"FriendlyName": "ConfigurationRepositoryShare",
"ClassVersion": "1.0.0",
"SuperClassName": "OMI_ConfigurationDownloadManager",
"ClassProperties": [
{
"Name": "SourcePath",
"CimType": "String",
"Qualifiers": {
"Key": true
}
},
{
"Name": "Credential",
"CimType": "Instance",
"ReferenceClassName": "MSFT_Credential",
"Qualifiers": {
"EmbeddedInstance": "MSFT_Credential"
}
}
]
},
{
"ClassName": "MSFT_WebResourceManager",
"FriendlyName": "ResourceRepositoryWeb",
"ClassVersion": "1.0.0",
"SuperClassName": "OMI_ResourceModuleManager",
"ClassProperties": [
{
"Name": "ServerURL",
"CimType": "String",
"Qualifiers": {
"Key": true
}
},
{
"Name": "CertificateID",
"CimType": "String"
},
{
"Name": "AllowUnsecureConnection",
"CimType": "Boolean"
},
{
"Name": "RegistrationKey",
"CimType": "String"
},
{
"Name": "ProxyURL",
"CimType": "String"
},
{
"Name": "ProxyCredential",
"CimType": "Instance",
"ReferenceClassName": "MSFT_Credential",
"Qualifiers": {
"EmbeddedInstance": "MSFT_Credential"
}
}
]
},
{
"ClassName": "MSFT_FileResourceManager",
"FriendlyName": "ResourceRepositoryShare",
"ClassVersion": "1.0.0",
"SuperClassName": "OMI_ResourceModuleManager",
"ClassProperties": [
{
"Name": "SourcePath",
"CimType": "String",
"Qualifiers": {
"Key": true
}
},
{
"Name": "Credential",
"CimType": "Instance",
"ReferenceClassName": "MSFT_Credential",
"Qualifiers": {
"EmbeddedInstance": "MSFT_Credential"
}
}
]
},
{
"ClassName": "MSFT_WebReportManager",
"FriendlyName": "ReportServerWeb",
"ClassVersion": "1.0.0",
"SuperClassName": "OMI_ReportManager",
"ClassProperties": [
{
"Name": "ServerURL",
"CimType": "String",
"Qualifiers": {
"Key": true
}
},
{
"Name": "CertificateID",
"CimType": "String"
},
{
"Name": "AllowUnsecureConnection",
"CimType": "Boolean"
},
{
"Name": "RegistrationKey",
"CimType": "String"
},
{
"Name": "ProxyURL",
"CimType": "String"
},
{
"Name": "ProxyCredential",
"CimType": "Instance",
"ReferenceClassName": "MSFT_Credential",
"Qualifiers": {
"EmbeddedInstance": "MSFT_Credential"
}
}
]
},
{
"ClassName": "MSFT_PartialConfiguration",
"FriendlyName": "PartialConfiguration",
"ClassVersion": "1.0.0",
"SuperClassName": "OMI_MetaConfigurationResource",
"ClassProperties": [
{
"Name": "Description",
"CimType": "String",
"Qualifiers": {
"Write": true
}
},
{
"Name": "ExclusiveResources",
"CimType": "StringArray",
"Qualifiers": {
"Write": true
}
},
{
"Name": "ConfigurationSource",
"CimType": "StringArray",
"Qualifiers": {
"Write": true
}
},
{
"Name": "ResourceModuleSource",
"CimType": "StringArray",
"Qualifiers": {
"Write": true
}
},
{
"Name": "DependsOn",
"CimType": "StringArray",
"Qualifiers": {
"Write": true
}
},
{
"Name": "RefreshMode",
"CimType": "String",
"Qualifiers": {
"ValueMap": [
"Push",
"Pull",
"Disabled"
],
"Values": [
"Push",
"Pull",
"Disabled"
]
}
}
]
},
{
"ClassName": "MSFT_SignatureValidation",
"FriendlyName": "SignatureValidation",
"ClassVersion": "1.0.0",
"SuperClassName": "OMI_MetaConfigurationResource",
"ClassProperties": [
{
"Name": "TrustedStorePath",
"CimType": "String",
"Qualifiers": {
"Write": true
}
},
{
"Name": "SignedItemType",
"CimType": "StringArray",
"Qualifiers": {
"ValueMap": [
"Configuration",
"Module"
],
"Values": [
"Configuration",
"Module"
]
}
}
]
},
{
"ClassName": "MSFT_DSCMetaConfigurationV2",
"FriendlyName": "Settings",
"ClassVersion": "2.0.0",
"ClassProperties": [
{
"Name": "ConfigurationModeFrequencyMins",
"CimType": "UInt32"
},
{
"Name": "RebootNodeIfNeeded",
"CimType": "Boolean"
},
{
"Name": "ConfigurationMode",
"CimType": "String",
"Qualifiers": {
"ValueMap": [
"ApplyOnly",
"ApplyAndMonitor",
"ApplyAndAutoCorrect",
"MonitorOnly"
],
"Values": [
"ApplyOnly",
"ApplyAndMonitor",
"ApplyAndAutoCorrect",
"MonitorOnly"
]
}
},
{
"Name": "ActionAfterReboot",
"CimType": "String",
"Qualifiers": {
"ValueMap": [
"ContinueConfiguration",
"StopConfiguration"
],
"Values": [
"ContinueConfiguration",
"StopConfiguration"
]
}
},
{
"Name": "RefreshMode",
"CimType": "String",
"Qualifiers": {
"ValueMap": [
"Push",
"Pull",
"Disabled"
],
"Values": [
"Push",
"Pull",
"Disabled"
]
}
},
{
"Name": "CertificateID",
"CimType": "String"
},
{
"Name": "ConfigurationID",
"CimType": "String"
},
{
"Name": "RefreshFrequencyMins",
"CimType": "UInt32"
},
{
"Name": "AllowModuleOverwrite",
"CimType": "Boolean"
},
{
"Name": "DebugMode",
"CimType": "StringArray",
"Qualifiers": {
"ValueMap": [
"None",
"ForceModuleImport",
"All",
"ResourceScriptBreakAll",
"ResourceScriptBreakpoint"
],
"Values": [
"None",
"ForceModuleImport",
"All",
"ResourceScriptBreakAll",
"ResourceScriptBreakpoint"
]
}
},
{
"Name": "LCMVersion",
"CimType": "String",
"Qualifiers": {
"Read": true
}
},
{
"Name": "LCMCompatibleVersions",
"CimType": "StringArray",
"Qualifiers": {
"Read": true
}
},
{
"Name": "LCMState",
"CimType": "String",
"Qualifiers": {
"Read": true,
"ValueMap": [
"Idle",
"Busy",
"PendingReboot",
"PendingConfiguration"
],
"Values": [
"Idle",
"Busy",
"PendingReboot",
"PendingConfiguration"
]
}
},
{
"Name": "LCMStateDetail",
"CimType": "String",
"Qualifiers": {
"Read": true
}
},
{
"Name": "ConfigurationDownloadManagers",
"CimType": "InstanceArray",
"ReferenceClassName": "OMI_ConfigurationDownloadManager",
"Qualifiers": {
"EmbeddedInstance": "OMI_ConfigurationDownloadManager"
}
},
{
"Name": "ResourceModuleManagers",
"CimType": "InstanceArray",
"ReferenceClassName": "OMI_ResourceModuleManager",
"Qualifiers": {
"EmbeddedInstance": "OMI_ResourceModuleManager"
}
},
{
"Name": "ReportManagers",
"CimType": "InstanceArray",
"ReferenceClassName": "OMI_ReportManager",
"Qualifiers": {
"EmbeddedInstance": "OMI_ReportManager"
}
},
{
"Name": "PartialConfigurations",
"CimType": "InstanceArray",
"ReferenceClassName": "MSFT_PartialConfiguration",
"Qualifiers": {
"EmbeddedInstance": "MSFT_PartialConfiguration"
}
},
{
"Name": "StatusRetentionTimeInDays",
"CimType": "UInt32"
},
{
"Name": "AgentId",
"CimType": "String",
"Qualifiers": {
"Read": true
}
},
{
"Name": "SignatureValidationPolicy",
"CimType": "String"
},
{
"Name": "SignatureValidations",
"CimType": "InstanceArray",
"ReferenceClassName": "MSFT_SignatureValidation",
"Qualifiers": {
"EmbeddedInstance": "MSFT_SignatureValidation"
}
},
{
"Name": "MaximumDownloadSizeMB",
"CimType": "UInt32"
}
]
}
]
@@ -9,7 +9,7 @@
RootModule = 'PSDesiredStateConfiguration.psm1'
# Version number of this module.
moduleVersion = '3.0.0'
moduleVersion = '2.0.7'
# Supported PSEditions
CompatiblePSEditions = @('Core')
@@ -30,7 +30,7 @@ Copyright = '(c) Microsoft Corporation. All rights reserved.'
Description = 'PowerShell Desired State Configuration'
# Minimum version of the Windows PowerShell engine required by this module
PowerShellVersion = '7.2'
PowerShellVersion = '6.1'
# Name of the Windows PowerShell host required by this module
# PowerShellHostName = ''
@@ -48,7 +48,7 @@ PowerShellVersion = '7.2'
# ProcessorArchitecture = ''
# Modules that must be imported into the global environment prior to importing this module
#RequiredModules = @()
# RequiredModules = @()
# Assemblies that must be loaded prior to importing this module
# RequiredAssemblies = @()
@@ -63,7 +63,7 @@ PowerShellVersion = '7.2'
# FormatsToProcess = @()
# Modules to import as nested modules of the module specified in RootModule/ModuleToProcess
NestedModules = @('Microsoft.PowerShell.DscSubsystem.dll')
# NestedModules = @()
# Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export.
FunctionsToExport = @(
@@ -71,7 +71,6 @@ FunctionsToExport = @(
'New-DscChecksum'
'Get-DscResource'
'Invoke-DscResource'
'ConvertTo-DscJsonSchema'
)
@@ -101,13 +100,11 @@ HelpInfoURI = 'https://go.microsoft.com/fwlink/?linkid=2113535'
PrivateData = @{
PSData = @{
Prerelease = 'beta1'
Tags = @('PSDesiredStateConfiguration',
'PSEdition_Core',
'Linux',
'Mac',
'Windows')
ProjectUri = 'https://github.com/PowerShell/PSDesiredStateConfiguration'
}
}
}
}
@@ -16,7 +16,7 @@ data LocalizedData
InvalidConfigurationName = Invalid Configuration Name '{0}' is specified. Standard names may only contain letters (a-z, A-Z), numbers (0-9), and underscore (_). The name may not be null or empty, and should start with a letter.
InvalidResourceSpecification = Found more than one resource named '{0}'. Please use the module specification to be more specific.
UnsupportedResourceImplementation = The resource '{0}' implemented as '{1}' is not supported by Invoke-DscResource.
NoValidConfigFileFound = No valid config files (json,zip) were found.
NoValidConfigFileFound = No valid config files (mof,zip) were found.
InputFileNotExist=File {0} doesn't exist.
FileReadError=Error Reading file {0}.
MatchingFileNotFound=No matching file found.
@@ -47,7 +47,7 @@ data LocalizedData
GetDscResourceInputName=The Get-DscResource input '{0}' parameter value is '{1}'.
ResourceNotMatched=Skipping resource '{0}' as it does not match the requested name.
InitializingClassCache=Initializing class cache
LoadingDefaultKeywords=Loading default keywords
LoadingDefaultCimKeywords=Loading default CIM keywords
GettingModuleList=Getting module list
CreatingResourceList=Creating resource list
CreatingResource=Creating resource '{0}'.
@@ -71,12 +71,12 @@ data LocalizedData
Set-StrictMode -Off
# In case localized resource is not available we revert back to English as defined in LocalizedData section so ignore the error instead of showing it to user.
Import-LocalizedData -BindingVariable LocalizedData -FileName PSDesiredStateConfiguration.Resource.psd1 -ErrorAction SilentlyContinue
Import-LocalizedData -BindingVariable LocalizedData -FileName PSDesiredStateConfiguration.Resource.psd1 -ErrorAction Ignore
Import-Module $PSScriptRoot/helpers/DscResourceInfo.psm1
# Set DSC HOME environment variable.
$env:DSC_HOME = Join-Path $PSScriptRoot "Configuration"
$env:DSC_HOME = "$PSScriptRoot/Configuration"
$script:V1MetaConfigPropertyList = @('ConfigurationModeFrequencyMins', 'RebootNodeIfNeeded', 'ConfigurationMode', 'ActionAfterReboot', 'RefreshMode', 'CertificateID', 'ConfigurationID', 'DownloadManagerName', 'DownloadManagerCustomData', 'RefreshFrequencyMins', 'AllowModuleOverwrite', 'DebugMode', 'Credential')
$script:DirectAccessMetaConfigPropertyList = @('AllowModuleOverWrite', 'CertificateID', 'ConfigurationDownloadManagers', 'ResourceModuleManagers', 'DebugMode', 'RebootNodeIfNeeded', 'RefreshMode', 'ConfigurationAgent')
@@ -307,7 +307,7 @@ function ConvertTo-MOFInstance
elseif ($Value -is [PSCredential] )
{
# If the input object is a PSCredential, turn it into an MSFT_Credential with an encrypted password.
$clearText = [Microsoft.PowerShell.DesiredStateConfiguration.Internal.CrossPlatform.DscClassCache]::GetStringFromSecureString($Value.Password)
$clearText = [Microsoft.PowerShell.DesiredStateConfiguration.Internal.DscClassCache]::GetStringFromSecureString($Value.Password)
$newValue = @{
UserName = $Value.UserName
Password = $clearText
@@ -701,6 +701,33 @@ function ConvertTo-MOFInstance
$OFS = $oldOFS
}
#
# Add extra information about Author, GenerationHost, GenerationDate and Name if they are not specified
#
if ($Type -match 'OMI_ConfigurationDocument' -and $Properties)
{
if (-not $Properties.ContainsKey('Author'))
{
$result += " Author = `"$([system.environment]::UserName)`";`n"
}
if (-not $Properties.ContainsKey('GenerationDate'))
{
$result += " GenerationDate = `"$(Get-Date)`";`n"
}
if (-not $Properties.ContainsKey('GenerationHost'))
{
$result += " GenerationHost = `"$([system.environment]::MachineName)`";`n"
}
# todo: report error is configuration name does't match
if (-not $Properties.ContainsKey('Name'))
{
$result += " Name = `"$(Get-PSTopConfigurationName)`";`n"
}
}
#
# Append the completed mof instance text to the overall document
#
@@ -1766,6 +1793,59 @@ function ValidateUpdate-ConfigurationData
return $true
}
##############################################################
#
# Checks to see if a module defining composite resources should be reloaded
# based the last write time of the schema file. Returns true if the file exists
# and the last modified time was either not recorded or has change.
#
function Test-ModuleReloadRequired
{
[OutputType([bool])]
param (
[Parameter(Mandatory)]
[string]
$SchemaFilePath
)
if (-not $SchemaFilePath -or $SchemaFilePath -notmatch '\.schema\.psm1$')
{
# not a composite res
return $false
}
# If the path doesn't exist, then we can't reload it.
# Note: this condition is explicitly not an error for this function.
if ( -not (Test-Path $SchemaFilePath))
{
if ($schemaFileLastUpdate.ContainsKey($SchemaFilePath))
{
$schemaFileLastUpdate.Remove($SchemaFilePath)
}
return $false
}
# If we have a modified date, then return it.
if ($schemaFileLastUpdate.ContainsKey($SchemaFilePath))
{
if ( (Get-Item $SchemaFilePath).LastWriteTime -eq $schemaFileLastUpdate[$SchemaFilePath] )
{
return $false
}
else
{
return $true
}
}
# Otherwise, record the last write time and return true.
$script:schemaFileLastUpdate[$SchemaFilePath] = (Get-Item $SchemaFilePath).LastWriteTime
$true
}
# Holds the schema file to lastwritetime mapping.
[System.Collections.Generic.Dictionary[string,DateTime]] $script:schemaFileLastUpdate =
New-Object -TypeName 'System.Collections.Generic.Dictionary[string,datetime]'
###########################################################
# Configuration keyword implementation
###########################################################
@@ -1891,7 +1971,7 @@ function Configuration
# Load the default CIM keyword/function definitions set, populating the function collection
# with the default functions.
[Microsoft.PowerShell.DesiredStateConfiguration.Internal.CrossPlatform.DscClassCache]::LoadDefaultCimKeywords($functionsToDefine)
[Microsoft.PowerShell.DesiredStateConfiguration.Internal.DscClassCache]::LoadDefaultCimKeywords($functionsToDefine)
# Set up the rest of the configuration runtime state.
Initialize-ConfigurationRuntimeState $Name
@@ -1982,8 +2062,25 @@ function Configuration
foreach ($mod in $modulesInfo) {
$null = ImportClassResourcesFromModule -Module $mod -Resources $res -functionsToDefine $functionsToDefine
if ($moduleInfos.Count -eq 1)
$dscResourcesPath = Join-Path -Path $mod.ModuleBase -ChildPath 'DscResources'
if(Test-Path $dscResourcesPath)
{
foreach($requiredResource in $res)
{
if ($requiredResource.Contains('*')) {
# we historically resolve wildcards by Get-Item File System rules.
# We don't support wildcards resolutions for Friendly names.
foreach ($resource in Get-ChildItem -Path $dscResourcesPath -Directory -Name -Filter $requiredResource)
{
$null = ImportCimAndScriptKeywordsFromModule -Module $mod -Resource $resource -functionsToDefine $functionsToDefine
}
} else {
# ImportCimAndScriptKeywordsFromModule takes care about resolving $requiredResources names to ClassNames or FriendlyNames.
$null = ImportCimAndScriptKeywordsFromModule -Module $mod -Resource $requiredResource -functionsToDefine $functionsToDefine
}
}
}
elseif ($moduleInfos.Count -eq 1)
{
$modules.Add($moduleInfos)
}
@@ -2219,7 +2316,7 @@ function Configuration
{
Write-Debug -Message " CONFIGURATION $Name : DOING TOP-LEVEL CLEAN UP"
[System.Management.Automation.Language.DynamicKeyword]::Reset()
[Microsoft.PowerShell.DesiredStateConfiguration.Internal.CrossPlatform.DscClassCache]::ClearCache()
[Microsoft.PowerShell.DesiredStateConfiguration.Internal.DscClassCache]::ClearCache()
Initialize-ConfigurationRuntimeState
}
@@ -2272,7 +2369,7 @@ function Update-ModuleVersion
$moduleVersionstring = "ModuleVersion = "
$moduleVersionstring += "`"$moduleVersionValue`"" + ";"
$NodeInstanceAliases[$alias] = $first + $moduleVersionstring + "`n};"
$NodeInstanceAliases[$alias] = $first + $moduleVersionstring + "`r`n};"
}
}
}
@@ -2308,14 +2405,14 @@ function Update-DependsOn
$needAdd = $true
$first = $instanceText.Substring(0, $curlyPosition)
$dependsOn = "DependsOn = {`n"
$dependsOn = "DependsOn = {`r`n"
$len = @($NodeResources[$resourceId]).Length
$dependsOn += foreach ($resourceId in $NodeResources[$resourceId])
{
' ' + "`"$($resourceId -replace '\\', '\\' -replace '"', '\"')`"" +
$(if (--$len -gt 0)
{
",`n"
",`r`n"
}
else
{
@@ -2329,7 +2426,7 @@ function Update-DependsOn
if($needAdd)
{
$NodeInstanceAliases[$alias] = $first + $dependsOn + "`n};"
$NodeInstanceAliases[$alias] = $first + $dependsOn + "`r`n};"
}
}
}
@@ -2371,12 +2468,12 @@ function Update-ConfigurationDocumentRef
$needAdd = $true
$first = $instanceText.Substring(0, $curlyPosition).TrimEnd()
$ConfigurationNameRef = "`n ConfigurationName = `"$ConfigurationName`";"
$ConfigurationNameRef = "`r`n ConfigurationName = `"$ConfigurationName`";"
}
if($needAdd)
{
$NodeInstanceAliases[$alias] = $first + $ConfigurationNameRef + "`n};`n"
$NodeInstanceAliases[$alias] = $first + $ConfigurationNameRef + "`r`n};"
}
}
}
@@ -2396,16 +2493,66 @@ function ImportClassResourcesFromModule
$functionsToDefine
)
$Errors = New-Object -TypeName 'System.Collections.ObjectModel.Collection[System.Exception]'
$resourcesFound = [Microsoft.PowerShell.DesiredStateConfiguration.Internal.DscClassCache]::ImportClassResourcesFromModule($Module, $Resources, $functionsToDefine)
return ,$resourcesFound
}
$resourcesFound = [Microsoft.PowerShell.DesiredStateConfiguration.Internal.CrossPlatform.DscClassCache]::ImportClassResourcesFromModule($Module, $Resources, $functionsToDefine, $Errors)
function ImportCimAndScriptKeywordsFromModule
{
param (
[Parameter(Mandatory)]
$Module,
foreach($ex in $Errors)
[Parameter(Mandatory)]
$resource,
$functionsToDefine
)
trap
{
Write-Error -Exception $ex
continue
}
return ,$resourcesFound
$SchemaFilePath = $null
$oldCount = $functionsToDefine.Count
$keywordErrors = New-Object -TypeName 'System.Collections.ObjectModel.Collection[System.Exception]'
$foundCimSchema = [Microsoft.PowerShell.DesiredStateConfiguration.Internal.DscClassCache]::ImportCimKeywordsFromModule(
$Module, $resource, [ref] $SchemaFilePath, $functionsToDefine, $keywordErrors)
foreach($ex in $keywordErrors)
{
Write-Error -Exception $ex
if($ex.InnerException)
{
Write-Error -Exception $ex.InnerException
}
}
$functionsAdded = $functionsToDefine.Count - $oldCount
Write-Debug -Message " $Name : PROCESSING RESOURCE FILE: Added $functionsAdded type handler functions from '$SchemaFilePath'"
$SchemaFilePath = $null
$oldCount = $functionsToDefine.Count
$foundScriptSchema = [Microsoft.PowerShell.DesiredStateConfiguration.Internal.DscClassCache]::ImportScriptKeywordsFromModule(
$Module, $resource, [ref] $SchemaFilePath, $functionsToDefine )
$functionsAdded = $functionsToDefine.Count - $oldCount
Write-Debug -Message " $Name : PROCESSING RESOURCE FILE: Added $functionsAdded type handler functions from '$SchemaFilePath'"
if ($foundScriptSchema -and $SchemaFilePath)
{
$resourceDirectory = Split-Path $SchemaFilePath
if($null -ne $resourceDirectory)
{
Import-Module -Force: (Test-ModuleReloadRequired $SchemaFilePath) -Verbose:$false -Name $resourceDirectory -Global -ErrorAction SilentlyContinue
}
}
return $foundCimSchema -or $foundScriptSchema
}
#
@@ -2429,7 +2576,7 @@ function Write-MetaConfigFile
)
# Set up prefix for both the configuration and metaconfiguration documents.
$nodeDoc = $null
$nodeDoc = "/*`n@TargetNode='$mofNode'`n" + "@GeneratedBy=$([system.environment]::UserName)`n@GenerationDate=$(Get-Date)`n@GenerationHost=$([system.environment]::MachineName)`n*/`n"
$nodeConfigurationDocument = $null
[int]$nodeDocCount = 0
$resourceManagers = $null
@@ -2555,15 +2702,18 @@ function Write-MetaConfigFile
Write-Debug -Message " ${ConfigurationName}: Adding missing OMI_ConfigurationDocument element to the document"
if($Script:NodesPasswordEncrypted[$mofNode])
{
$nodeDoc += "`ninstance of OMI_ConfigurationDocument`n{`n Version=`"2.0.0`";`n MinimumCompatibleVersion = `"$($script:PSMetaConfigDocumentInstVersionInfo['MinimumCompatibleVersion'])`";`n CompatibleVersionAdditionalProperties= $(Get-CompatibleVersionAddtionaPropertiesStr);`n ContentType=`"PasswordEncrypted`";`n Name=`"$(Get-PSTopConfigurationName)`";`n};"
$nodeDoc += "`ninstance of OMI_ConfigurationDocument`n{`n Version=`"2.0.0`";`n MinimumCompatibleVersion = `"$($script:PSMetaConfigDocumentInstVersionInfo['MinimumCompatibleVersion'])`";`n CompatibleVersionAdditionalProperties= $(Get-CompatibleVersionAddtionaPropertiesStr);`n Author=`"$([system.environment]::UserName)`";`n GenerationDate=`"$(Get-Date)`";`n GenerationHost=`"$([system.environment]::MachineName)`";`n ContentType=`"PasswordEncrypted`";`n Name=`"$(Get-PSTopConfigurationName)`";`n};"
}
else
{
$nodeDoc += "`ninstance of OMI_ConfigurationDocument`n{`n Version=`"2.0.0`";`n MinimumCompatibleVersion = `"$($script:PSMetaConfigDocumentInstVersionInfo['MinimumCompatibleVersion'])`";`n CompatibleVersionAdditionalProperties= $(Get-CompatibleVersionAddtionaPropertiesStr);`n Name=`"$(Get-PSTopConfigurationName)`";`n};"
$nodeDoc += "`ninstance of OMI_ConfigurationDocument`n{`n Version=`"2.0.0`";`n MinimumCompatibleVersion = `"$($script:PSMetaConfigDocumentInstVersionInfo['MinimumCompatibleVersion'])`";`n CompatibleVersionAdditionalProperties= $(Get-CompatibleVersionAddtionaPropertiesStr);`n Author=`"$([system.environment]::UserName)`";`n GenerationDate=`"$(Get-Date)`";`n GenerationHost=`"$([system.environment]::MachineName)`";`n Name=`"$(Get-PSTopConfigurationName)`";`n};"
}
}
}
# Fix up newlines to be CRLF
$nodeDoc = $nodeDoc -replace "`n", "`r`n"
# todo: meta configuration might not be verifiable currently
$errMsg = Test-MofInstanceText $nodeDoc
if($errMsg)
@@ -2658,7 +2808,7 @@ function Write-NodeMOFFile
)
# Set up prefix for both the configuration and metaconfiguration documents.
$nodeDoc = $null
$nodeDoc = "/*`n@TargetNode='$mofNode'`n" + "@GeneratedBy=$([system.environment]::UserName)`n@GenerationDate=$(Get-Date)`n@GenerationHost=$([system.environment]::MachineName)`n*/`n"
$nodeMetaDoc = $nodeDoc
$nodeConfigurationDocument = $null
[int]$metaDocCount = 0
@@ -2716,11 +2866,11 @@ function Write-NodeMOFFile
Write-Debug -Message " ${ConfigurationName}: Adding missing OMI_ConfigurationDocument element to the document"
if($Script:NodesPasswordEncrypted[$mofNode])
{
$nodeMetaDoc += "`ninstance of OMI_ConfigurationDocument`n{`n Version=`"2.0.0`";`n MinimumCompatibleVersion = `"1.0.0`";`n CompatibleVersionAdditionalProperties= $(Get-CompatibleVersionAddtionaPropertiesStr);`n ContentType=`"PasswordEncrypted`";`n Name=`"$(Get-PSTopConfigurationName)`";`n};"
$nodeMetaDoc += "`ninstance of OMI_ConfigurationDocument`n{`n Version=`"2.0.0`";`n MinimumCompatibleVersion = `"1.0.0`";`n CompatibleVersionAdditionalProperties= $(Get-CompatibleVersionAddtionaPropertiesStr);`n Author=`"$([system.environment]::UserName)`";`n GenerationDate=`"$(Get-Date)`";`n GenerationHost=`"$([system.environment]::MachineName)`";`n ContentType=`"PasswordEncrypted`";`n Name=`"$(Get-PSTopConfigurationName)`";`n};"
}
else
{
$nodeMetaDoc += "`ninstance of OMI_ConfigurationDocument`n{`n Version=`"2.0.0`";`n MinimumCompatibleVersion = `"1.0.0`";`n CompatibleVersionAdditionalProperties= $(Get-CompatibleVersionAddtionaPropertiesStr);`n Name=`"$(Get-PSTopConfigurationName)`";`n};"
$nodeMetaDoc += "`ninstance of OMI_ConfigurationDocument`n{`n Version=`"2.0.0`";`n MinimumCompatibleVersion = `"1.0.0`";`n CompatibleVersionAdditionalProperties= $(Get-CompatibleVersionAddtionaPropertiesStr);`n Author=`"$([system.environment]::UserName)`";`n GenerationDate=`"$(Get-Date)`";`n GenerationHost=`"$([system.environment]::MachineName)`";`n Name=`"$(Get-PSTopConfigurationName)`";`n};"
}
}
}
@@ -2739,26 +2889,72 @@ function Write-NodeMOFFile
{
if($nodeDoc.Contains("PsDscRunAsCredential"))
{
$nodeDoc += "`ninstance of OMI_ConfigurationDocument`n{`n Version=`"2.0.0`";`n MinimumCompatibleVersion = `"2.0.0`";`n CompatibleVersionAdditionalProperties= {`"Omi_BaseResource:ConfigurationName`"};`n ContentType=`"PasswordEncrypted`";`n Name=`"$(Get-PSTopConfigurationName)`";`n};"
$nodeDoc += "`ninstance of OMI_ConfigurationDocument`n
{`n Version=`"2.0.0`";`n
MinimumCompatibleVersion = `"2.0.0`";`n
CompatibleVersionAdditionalProperties= {`"Omi_BaseResource:ConfigurationName`"};`n
Author=`"$([system.environment]::UserName)`";`n
GenerationDate=`"$(Get-Date)`";`n
GenerationHost=`"$([system.environment]::MachineName)`";`n
ContentType=`"PasswordEncrypted`";`n
Name=`"$(Get-PSTopConfigurationName)`";`n
};"
}
else
{
$nodeDoc += "`ninstance of OMI_ConfigurationDocument`n{`n Version=`"2.0.0`";`n MinimumCompatibleVersion = `"1.0.0`";`n CompatibleVersionAdditionalProperties= {`"Omi_BaseResource:ConfigurationName`"};`n ContentType=`"PasswordEncrypted`";`n Name=`"$(Get-PSTopConfigurationName)`";`n};"
$nodeDoc += "`ninstance of OMI_ConfigurationDocument`n
{`n Version=`"2.0.0`";`n
MinimumCompatibleVersion = `"1.0.0`";`n
CompatibleVersionAdditionalProperties= {`"Omi_BaseResource:ConfigurationName`"};`n
Author=`"$([system.environment]::UserName)`";`n
GenerationDate=`"$(Get-Date)`";`n
GenerationHost=`"$([system.environment]::MachineName)`";`n
ContentType=`"PasswordEncrypted`";`n
Name=`"$(Get-PSTopConfigurationName)`";`n
};"
}
}
else
{
if($nodeDoc.Contains("PsDscRunAsCredential"))
{
$nodeDoc += "`ninstance of OMI_ConfigurationDocument`n{`n Version=`"2.0.0`";`n MinimumCompatibleVersion = `"2.0.0`";`n CompatibleVersionAdditionalProperties= {`"Omi_BaseResource:ConfigurationName`"};`n Name=`"$(Get-PSTopConfigurationName)`";`n};"
$nodeDoc += "`ninstance of OMI_ConfigurationDocument`n
{`n Version=`"2.0.0`";`n
MinimumCompatibleVersion = `"2.0.0`";`n
CompatibleVersionAdditionalProperties= {`"Omi_BaseResource:ConfigurationName`"};`n
Author=`"$([system.environment]::UserName)`";`n
GenerationDate=`"$(Get-Date)`";`n
GenerationHost=`"$([system.environment]::MachineName)`";`n
Name=`"$(Get-PSTopConfigurationName)`";`n
};"
}
else
{
$nodeDoc += "`ninstance of OMI_ConfigurationDocument`n{`n Version=`"2.0.0`";`n MinimumCompatibleVersion = `"1.0.0`";`n CompatibleVersionAdditionalProperties= {`"Omi_BaseResource:ConfigurationName`"};`n Name=`"$(Get-PSTopConfigurationName)`";`n};"
$nodeDoc += "`ninstance of OMI_ConfigurationDocument`n
{`n Version=`"2.0.0`";`n
MinimumCompatibleVersion = `"1.0.0`";`n
CompatibleVersionAdditionalProperties= {`"Omi_BaseResource:ConfigurationName`"};`n
Author=`"$([system.environment]::UserName)`";`n
GenerationDate=`"$(Get-Date)`";`n
GenerationHost=`"$([system.environment]::MachineName)`";`n
Name=`"$(Get-PSTopConfigurationName)`";`n
};"
}
}
}
}
# Fix up newlines to be CRLF
$nodeDoc = $nodeDoc -replace "`n", "`r`n"
$errMsg = Test-MofInstanceText $nodeDoc
if($errMsg)
{
$errorMessage = $LocalizedData.InvalidMOFDefinition -f @($mofNode, $errMsg)
$exception = New-Object -TypeName System.InvalidOperationException -ArgumentList $errorMessage
Write-Error -Exception $exception -Message $errorMessage -Category InvalidOperation -ErrorId InvalidMOFDefinition
Update-ConfigurationErrorCount
$nodeOutfile = "$ConfigurationOutputDirectory/$($mofNode).mof.error"
}
if($nodeDocCount -gt 0)
{
@@ -2772,6 +2968,7 @@ function Write-NodeMOFFile
if($nodeMetaDoc -match 'MSFT_DSCMetaConfiguration' -and $Script:PSConfigurationErrors -eq 0)
{
$nodeMetaDoc = $nodeMetaDoc -replace "`n", "`r`n"
$nodeMetaDoc > $nodeMetaOutfile
Get-ChildItem $nodeMetaOutfile
}
@@ -3215,7 +3412,7 @@ function Test-MofInstanceText
{
try
{
[Microsoft.PowerShell.DesiredStateConfiguration.Internal.CrossPlatform.DscClassCache]::ValidateInstanceText($instanceText)
[Microsoft.PowerShell.DesiredStateConfiguration.Internal.DscClassCache]::ValidateInstanceText($instanceText)
}
catch [System.Management.Automation.MethodInvocationException]
{
@@ -3458,7 +3655,7 @@ function New-DscChecksum
# Retrieve all valid configuration files at the specified $Path
$allConfigFiles = $Path | ForEach-Object -Process {
(Get-ChildItem -Path $_ -Recurse | Where-Object -FilterScript {
$_.Extension -eq '.json' -or $_.Extension -eq '.zip'
$_.Extension -eq '.mof' -or $_.Extension -eq '.zip'
}
)
}
@@ -3467,6 +3664,7 @@ function New-DscChecksum
if ($allConfigFiles.Length -eq 0)
{
Write-Log -Message $LocalizedData.NoValidConfigFileFound
return
}
@@ -3481,7 +3679,7 @@ function New-DscChecksum
}
# If the Force parameter was not specified and the hash file already exists for the current file, log this, and skip this file
if (!$Force -and (Get-Item -Path $fileOutpath -ErrorAction SilentlyContinue))
if (!$Force -and (Get-Item -Path $fileOutpath -ErrorAction Ignore))
{
Write-Log -Message ($LocalizedData.CheckSumFileExists -f $fileOutpath)
continue
@@ -3652,12 +3850,22 @@ function Get-DSCResourceModules
foreach($moduleFolder in Get-ChildItem $folder -Directory)
{
$addModule = $false
foreach($psd1 in Get-ChildItem -Recurse -Filter "$($moduleFolder.Name).psd1" -Path $moduleFolder.fullname -Depth 2)
$dscFolders = Get-childitem "$($moduleFolder.FullName)\DscResources","$($moduleFolder.FullName)\*\DscResources" -ErrorAction Ignore
if($null -ne $dscFolders)
{
$containsDSCResource = select-string -LiteralPath $psd1 -pattern '^[^#]*\bDscResourcesToExport\b.*'
if($null -ne $containsDSCResource)
$addModule = $true
}
if(-not $addModule)
{
foreach($psd1 in Get-ChildItem -Recurse -Filter "$($moduleFolder.Name).psd1" -Path $moduleFolder.fullname -Depth 2)
{
$addModule = $true
$containsDSCResource = select-string -LiteralPath $psd1 -pattern '^[^#]*\bDscResourcesToExport\b.*'
if($null -ne $containsDSCResource)
{
$addModule = $true
}
}
}
@@ -3671,167 +3879,14 @@ function Get-DSCResourceModules
$dscModuleFolderList
}
function CimPropertyIsInherited
{
param(
[parameter(Mandatory)]
[string]
$PropertyName,
[parameter(Mandatory)]
[AllowNull()]
[System.Object]
$ParentClass)
if (-not ($ParentClass))
{
return $false;
}
else
{
foreach($property in $ParentClass.CimClassProperties)
{
if ($property.Name -eq $PropertyName)
{
return $true;
}
}
return CimPropertyIsInherited -PropertyName $PropertyName -ParentClass $ParentClass.CimSuperClass
}
}
function PrepareCimClassesForJsonConvertion
{
param(
[parameter(Mandatory)]
$classList)
$resultList = New-Object -TypeName 'System.Collections.Generic.List[PSObject]'
foreach($class in $classList)
{
Write-Verbose "Preprocessing class $($class.CimSystemProperties.ClassName)"
$properties = New-Object -TypeName 'System.Collections.Generic.List[System.Object]'
# remove inherited properties
foreach($property in $class.CimClassProperties)
{
if (-not (CimPropertyIsInherited -PropertyName $property.Name -ParentClass $class.CimSuperClass))
{
Write-Verbose "Adding property $($property.Name)"
$qualifiers = New-Object -TypeName 'System.Collections.Generic.Dictionary[System.String,System.Object]'
foreach($qualifier in $property.Qualifiers)
{
$qualifiers.Add($qualifier.Name, $qualifier.Value)
}
if ($qualifiers.Count -eq 0) { $qualifiers = $null}
$flags = $property.Flags
$flags = $flags -band -bnot [Microsoft.Management.Infrastructure.CimFlags]::Property # this is set for all properties
$flags = $flags -band -bnot [Microsoft.Management.Infrastructure.CimFlags]::NullValue # this is set for all properties
$flags = $flags -band -bnot [Microsoft.Management.Infrastructure.CimFlags]::Required # this is also specified in Qualifiers
$flags = $flags -band -bnot [Microsoft.Management.Infrastructure.CimFlags]::Key # this is also specified in Qualifiers
$flags = $flags -band -bnot [Microsoft.Management.Infrastructure.CimFlags]::ReadOnly # this is also specified in Qualifiers
if ($flags -eq 0) { $flags = $null}
$p = [pscustomobject]@{
Name = $property.Name
Value = $property.Value
CimType = $property.CimType
Flags = $flags
ReferenceClassName = $property.ReferenceClassName
Qualifiers = $qualifiers
}
# remove properties that have null value
$p.PSobject.Properties | % {if ($_.Value -eq $null) {$p.PSobject.Properties.Remove($_.Name)}}
$properties.Add($p);
}
else
{
Write-Verbose "Property $($property.Name) is inherited, ignoring it"
}
}
if ($properties.Count -eq 0) { $properties = $null}
# construct the processed class
$processedClass = [pscustomobject]@{
ClassName = $class.CimSystemProperties.ClassName
FriendlyName = ($class.CimClassQualifiers | Where-Object {$_.Name -eq "FriendlyName"}).Value
ClassVersion = ($class.CimClassQualifiers | Where-Object {$_.Name -eq "ClassVersion"}).Value
Description = ($class.CimClassQualifiers | Where-Object {$_.Name -eq "Description"}).Value
SuperClassName = $class.CimSuperClassName
ClassProperties = $properties
}
# remove properties that have null value
$processedClass.PSobject.Properties | % {if ($_.Value -eq $null) {$processedClass.PSobject.Properties.Remove($_.Name)}}
$resultList.Add($processedClass)
}
return $resultList
}
###########################################################
# ConvertTo-DscJsonSchema
###########################################################
#
# Reads CIM MOF schema files and creates json files with equivalent json schema
#
function ConvertTo-DscJsonSchema
{
param (
[Parameter(ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true)]
[ValidateNotNullOrEmpty()]
[Alias("Path")]
[string[]]
$Directory
)
Process
{
foreach($dir in $Directory)
{
Write-Verbose "Processing $dir"
if (-not (Test-Path -Path $dir))
{
Write-Error "Can not find directory $dir" # non-terminating error
}
else
{
[Microsoft.PowerShell.DesiredStateConfiguration.Internal.DscClassCache]::Initialize()
$schemaFilePaths = Get-ChildItem -Recurse -File -Path $dir -Filter '*.schema.mof'
foreach($mofPath in $schemaFilePaths)
{
$cimClasses = [Microsoft.PowerShell.DesiredStateConfiguration.Internal.DscClassCache]::ReadCimSchemaMof($mofPath)
Write-Verbose "Read $($cimClasses.Count) classes from $mofPath"
$preprocessedCimClasses = PrepareCimClassesForJsonConvertion $cimClasses
[string] $jsonPath = $mofPath.FullName.Substring(0, $mofPath.FullName.LastIndexOf('.')) + ".json";
Write-Verbose "Writing $jsonPath"
ConvertTo-Json -InputObject $preprocessedCimClasses -Depth 100 -EnumsAsStrings | Out-File -Force -Path $jsonPath
}
}
}
}
}
###########################################################
# Get-DSCResource
###########################################################
#
# Gets DSC resources on the machine. Allows to filter on a particular resource.
# It parses class-based resources defined in the psm1 module files.
# It parses all the resources defined in the schema.mof file and also the composite
# resources defined or imported from PowerShell modules
#
function Get-DscResource
{
@@ -3859,12 +3914,12 @@ function Get-DscResource
{
$initialized = $false
$ModuleString = $null
Write-Progress -Id 1 -Activity $LocalizedData.LoadingDefaultKeywords
Write-Progress -Id 1 -Activity $LocalizedData.LoadingDefaultCimKeywords
$keywordErrors = New-Object -TypeName 'System.Collections.ObjectModel.Collection[System.Exception]'
# Load the default Inbox providers (keyword) in cache, also allow caching the resources from multiple versions of modules.
[Microsoft.PowerShell.DesiredStateConfiguration.Internal.CrossPlatform.DscClassCache]::LoadDefaultCimKeywords($keywordErrors, $true)
[Microsoft.PowerShell.DesiredStateConfiguration.Internal.DscClassCache]::LoadDefaultCimKeywords($keywordErrors, $true)
foreach($ex in $keywordErrors)
{
@@ -3911,6 +3966,15 @@ function Get-DscResource
{
$null = ImportClassResourcesFromModule -Module $mod -Resources * -functionsToDefine $functionsToDefine
}
$dscResources = Join-Path -Path $mod.ModuleBase -ChildPath 'DscResources'
if(Test-Path $dscResources)
{
foreach ($resource in Get-ChildItem -Path $dscResources -Directory -Name)
{
$null = ImportCimAndScriptKeywordsFromModule -Module $mod -Resource $resource -functionsToDefine $functionsToDefine
}
}
}
$Resources = @()
@@ -3940,7 +4004,7 @@ function Get-DscResource
Write-Progress -Id 3 -Activity $LocalizedData.CreatingResourceList
# Get resources for CIM cache
$keywords = [Microsoft.PowerShell.DesiredStateConfiguration.Internal.CrossPlatform.DscClassCache]::GetKeywordsFromCachedClasses() | Where-Object -FilterScript {
$keywords = [Microsoft.PowerShell.DesiredStateConfiguration.Internal.DscClassCache]::GetCachedKeywords() | Where-Object -FilterScript {
(!$_.IsReservedKeyword) -and ($null -ne $_.ResourceName) -and !(IsHiddenResource $_.ResourceName) -and (![bool]$Module -or ($_.ImplementingModule -like $ModuleString))
}
@@ -3954,6 +4018,16 @@ function Get-DscResource
$_ -ne $null
}
# Get composite resources
$Resources += Get-Command -CommandType Configuration |
ForEach-Object -Process {
GetCompositeResource $patterns $_ $ignoreResourceParameters -modules $modules
} |
Where-Object -FilterScript {
$_ -ne $null -and (![bool]$ModuleString -or ($_.Module -like $ModuleString)) -and
($_.Path -and ((Split-Path -Leaf $_.Path) -eq "$($_.Name).schema.psm1"))
}
# check whether all resources are found
CheckResourceFound $Name $Resources
}
@@ -3962,7 +4036,7 @@ function Get-DscResource
if ($initialized)
{
[System.Management.Automation.Language.DynamicKeyword]::Reset()
[Microsoft.PowerShell.DesiredStateConfiguration.Internal.CrossPlatform.DscClassCache]::ClearCache()
[Microsoft.PowerShell.DesiredStateConfiguration.Internal.DscClassCache]::ClearCache()
$initialized = $false
}
@@ -3973,7 +4047,7 @@ function Get-DscResource
End
{
$Resources = $Resources | Sort-Object -Property Module, Name
$Resources = $Resources | Sort-Object -Property Module, Name -Unique
foreach ($resource in $Resources)
{
# return formatted string if required
@@ -3990,7 +4064,7 @@ function Get-DscResource
if ($initialized)
{
[System.Management.Automation.Language.DynamicKeyword]::Reset()
[Microsoft.PowerShell.DesiredStateConfiguration.Internal.CrossPlatform.DscClassCache]::ClearCache()
[Microsoft.PowerShell.DesiredStateConfiguration.Internal.DscClassCache]::ClearCache()
$initialized = $false
}
@@ -4043,23 +4117,69 @@ function GetResourceFromKeyword
$resource.Name = $keyword.Keyword
# only supporting class-based resources at this time
$implementationDetail = 'ClassBased'
$Module = $modules | Where-Object -FilterScript {
$_.Name -eq $keyword.ImplementingModule -and
$_.Version -eq $keyword.ImplementingModuleVersion
} | Select-Object -First 1
$schemaFiles = [Microsoft.PowerShell.DesiredStateConfiguration.Internal.DscClassCache]::GetFileDefiningClass($keyword.ResourceName)
if ($Module -and $Module.ExportedDscResources -contains $keyword.Keyword)
if ($schemaFiles.Count)
{
$resource.Module = $Module
$resource.Path = $Module.Path
$resource.ParentPath = Split-Path -Path $Module.Path
# Find the correct schema file that matches module name and version
# if same module/version is installed in multiple locations, then pick the first schema file.
foreach ($schemaFileName in $schemaFiles){
$moduleInfo = GetModule $modules $schemaFileName;
if ($moduleInfo.Name -eq $keyword.ImplementingModule -and $moduleInfo.Version -eq $keyword.ImplementingModuleVersion){
break
}
}
# if the class is not a resource we will ignore it except if it is DSC inbox resource.
if(-not $schemaFileName.StartsWith("$env:windir\system32\configuration",[stringComparison]::OrdinalIgnoreCase))
{
$classesFromSchema = [Microsoft.PowerShell.DesiredStateConfiguration.Internal.DscClassCache]::GetCachedClassByFileName($schemaFileName)
if($null -ne $classesFromSchema)
{
# check if the resource is proper DSC resource that always derives from OMI_BaseResource.
$schemaToProcess = $classesFromSchema | ForEach-Object -Process {
if(($_.CimSystemProperties.ClassName -ieq $keyword.ResourceName) -and ($_.CimSuperClassName -ieq 'OMI_BaseResource'))
{
$member = Get-Member -InputObject $_ -MemberType NoteProperty -Name 'ImplementationDetail'
if ($null -eq $member)
{
$_ | Add-Member -MemberType NoteProperty -Name 'ImplementationDetail' -Value $implementationDetail -PassThru
}
else
{
$_
}
}
}
if($null -eq $schemaToProcess)
{
return
}
}
}
$message = $LocalizedData.SchemaFileForResource -f @($schemaFileName)
Write-Verbose -Message $message
$resource.Module = $moduleInfo
$resource.Path = GetImplementingModulePath $schemaFileName
$resource.ParentPath = Split-Path $schemaFileName
}
else
{
# a class-based keyword must be in the ExportedDscResources of the module that implements it
return $null
$implementationDetail = 'ClassBased'
$Module = $modules | Where-Object -FilterScript {
$_.Name -eq $keyword.ImplementingModule -and
$_.Version -eq $keyword.ImplementingModuleVersion
}
if ($Module -and $Module.ExportedDscResources -contains $keyword.Keyword)
{
$implementationDetail = 'ClassBased'
$resource.Module = $Module
$resource.Path = $Module.Path
$resource.ParentPath = Split-Path -Path $Module.Path
}
}
if ([system.string]::IsNullOrEmpty($resource.Path) -eq $false)
@@ -4210,6 +4330,7 @@ function AddDscResourceProperty
$dscProperty.Values.Add($_)
}
}
$dscProperty.PropertyType = $Type
$dscProperty.IsMandatory = $property.Mandatory
@@ -4329,13 +4450,13 @@ function GetImplementingModulePath
$schemaFileName
)
$moduleFileName = ($schemaFileName -replace ".schema.json$", '') + '.psd1'
$moduleFileName = ($schemaFileName -replace ".schema.mof$", '') + '.psd1'
if (Test-Path $moduleFileName)
{
return $moduleFileName
}
$moduleFileName = ($schemaFileName -replace ".schema.json$", '') + '.psm1'
$moduleFileName = ($schemaFileName -replace ".schema.mof$", '') + '.psm1'
if (Test-Path $moduleFileName)
{
return $moduleFileName
@@ -4365,9 +4486,9 @@ function GetModule
}
$schemaFileExt = $null
if ($schemaFileName -match '.schema.json')
if ($schemaFileName -match '.schema.mof')
{
$schemaFileExt = ".schema.json$"
$schemaFileExt = ".schema.mof$"
}
if ($schemaFileName -match '.schema.psm1')
@@ -4625,27 +4746,30 @@ function Invoke-DscClassBasedResource
$type = $resource.ResourceType
Write-Debug "Importing $path ..."
$powershell = [PowerShell]::Create('CurrentRunspace')
$iss = [System.Management.Automation.Runspaces.InitialSessionState]::CreateDefault2()
$powershell = [PowerShell]::Create($iss)
$script = @"
using module $path
using module "$path"
Write-Host -Message ([$type]::new | out-string)
return [$type]::new()
"@
$null= $powershell.AddScript($script)
$dscObj=$powershell.Invoke() | Select-object -First 1
$dscType=$powershell.Invoke() | Select-object -First 1
foreach($key in $Property.Keys)
{
$value = $Property.$key
Write-Debug "Setting $key to $value"
$dscObj.$key = $value
$dscType.$key = $value
}
$info = $dscObj | Out-String
$info = $dscType | Out-String
Write-Debug $info
Write-Debug "calling $type.$Method() ..."
$global:DSCMachineStatus = $null
$output = $dscObj.$Method()
$output = $dscType.$Method()
return Get-InvokeDscResourceResult -Output $output -Method $Method
}
@@ -4710,7 +4834,6 @@ function Get-InvokeDscResourceResult
Export-ModuleMember -Function @(
'Invoke-DscResource'
'ConvertTo-DscJsonSchema'
)
###########################################################
@@ -24,7 +24,7 @@ namespace Microsoft.PowerShell.DesiredStateConfiguration
/// DSC resource implementation type not known
/// </summary>
None = 0,
/// <summary>
/// DSC resource is implemented using PowerShell module
/// </summary>
@@ -70,13 +70,13 @@ namespace Microsoft.PowerShell.DesiredStateConfiguration
public string FriendlyName { get; set; }
/// <summary>
/// Gets or sets module which implements the resource. This could point to parent module, if the DSC resource is implemented
/// Gets or sets module which implements the resource. This could point to parent module, if the DSC resource is implemented
/// by one of nested modules.
/// </summary>
public PSModuleInfo Module { get; set; }
/// <summary>
/// Gets name of the module which implements the resource.
/// Gets name of the module which implements the resource.
/// </summary>
public string ModuleName
{
@@ -88,7 +88,7 @@ namespace Microsoft.PowerShell.DesiredStateConfiguration
}
/// <summary>
/// Gets version of the module which implements the resource.
/// Gets version of the module which implements the resource.
/// </summary>
public Version Version
{
@@ -100,7 +100,7 @@ namespace Microsoft.PowerShell.DesiredStateConfiguration
}
/// <summary>
/// Gets or sets of the file which implements the resource. For the reosurces which are defined using
/// Gets or sets of the file which implements the resource. For the reosurces which are defined using
/// MOF file, this will be path to a module which resides in the same folder where schema.mof file is present.
/// For composite resources, this will be the module which implements the resource
/// </summary>
@@ -108,7 +108,7 @@ namespace Microsoft.PowerShell.DesiredStateConfiguration
/// <summary>
/// Gets or sets parent folder, where the resource is defined
/// It is the folder containing either the implementing module(=Path) or folder containing ".schema.mof".
/// It is the folder containing either the implementing module(=Path) or folder containing ".schema.mof".
/// For native providers, Path will be null and only ParentPath will be present.
/// </summary>
public string ParentPath { get; set; }
@@ -150,7 +150,7 @@ namespace Microsoft.PowerShell.DesiredStateConfiguration
{
this.Values = new List<string>();
}
/// <summary>
/// Gets or sets name of the property
/// </summary>
+368 -263
View File
@@ -21,7 +21,11 @@ Function Install-ModuleIfMissing {
}
}
Describe "Test PSDesiredStateConfiguration" {
Function Test-IsInvokeDscResourceEnable {
return [ExperimentalFeature]::IsEnabled("PSDesiredStateConfiguration.InvokeDscResource")
}
Describe "Test PSDesiredStateConfiguration" -tags CI {
Context "Module loading" {
BeforeAll {
Function BeCommand {
@@ -62,7 +66,7 @@ Describe "Test PSDesiredStateConfiguration" {
$commands | Should -HaveCommand -CommandName 'Configuration' -ModuleName PSDesiredStateConfiguration
}
It "The module should have the New-DscChecksum Command" {
It "The module should have the Configuration Command" {
$commands | Should -HaveCommand -CommandName 'New-DscChecksum' -ModuleName PSDesiredStateConfiguration
}
@@ -70,15 +74,195 @@ Describe "Test PSDesiredStateConfiguration" {
$commands | Should -HaveCommand -CommandName 'Get-DscResource' -ModuleName PSDesiredStateConfiguration
}
It "The module should have the Invoke-DscResource Command" {
It "The module should have the Invoke-DscResource Command" -Skip:(!(Test-IsInvokeDscResourceEnable)) {
$commands | Should -HaveCommand -CommandName 'Invoke-DscResource' -ModuleName PSDesiredStateConfiguration
}
}
Context "Get-DscResource - Composite Resources" {
BeforeAll {
$origProgress = $global:ProgressPreference
$global:ProgressPreference = 'SilentlyContinue'
Install-ModuleIfMissing -Name PSDscResources
$testCases = @(
@{
TestCaseName = 'case mismatch in resource name'
Name = 'groupset'
ModuleName = 'PSDscResources'
}
@{
TestCaseName = 'Both names have matching case'
Name = 'GroupSet'
ModuleName = 'PSDscResources'
}
@{
TestCaseName = 'case mismatch in module name'
Name = 'GroupSet'
ModuleName = 'psdscResources'
}
)
}
It "The module should have the ConvertTo-DscJsonSchema Command" {
$commands | Should -HaveCommand -CommandName 'ConvertTo-DscJsonSchema' -ModuleName PSDesiredStateConfiguration
AfterAll {
$Global:ProgressPreference = $origProgress
}
it "should be able to get <Name> - <TestCaseName>" -TestCases $testCases {
param($Name)
if ($IsWindows) {
Set-ItResult -Pending -Because "Will only find script from PSDesiredStateConfiguration without modulename"
}
if ($IsLinux) {
Set-ItResult -Pending -Because "https://github.com/PowerShell/PSDesiredStateConfiguration/issues/26"
}
$resource = Get-DscResource -Name $name
$resource | Should -Not -BeNullOrEmpty
$resource.Name | Should -Be $Name
if (Test-IsInvokeDscResourceEnable) {
$resource.ImplementationDetail | Should -BeNullOrEmpty
}
else {
$resource.ImplementationDetail | Should -BeNullOrEmpty
}
}
it "should be able to get <Name> from <ModuleName> - <TestCaseName>" -TestCases $testCases {
param($Name, $ModuleName, $PendingBecause)
if ($IsLinux) {
Set-ItResult -Pending -Because "https://github.com/PowerShell/PSDesiredStateConfiguration/issues/26"
}
if ($PendingBecause) {
Set-ItResult -Pending -Because $PendingBecause
}
$resource = Get-DscResource -Name $Name -Module $ModuleName
$resource | Should -Not -BeNullOrEmpty
$resource.Name | Should -Be $Name
if (Test-IsInvokeDscResourceEnable) {
$resource.ImplementationDetail | Should -BeNullOrEmpty
}
else {
$resource.ImplementationDetail | Should -BeNullOrEmpty
}
}
}
Context "Get-DscResource - ScriptResources" {
BeforeAll {
$origProgress = $global:ProgressPreference
$global:ProgressPreference = 'SilentlyContinue'
Install-ModuleIfMissing -Name PSDscResources -Force
# Install PowerShellGet only if PowerShellGet 2.2.1 or newer does not exist
Install-ModuleIfMissing -Name PowerShellGet -MinimumVersion '2.2.1'
$module = Get-Module PowerShellGet -ListAvailable | Sort-Object -Property Version -Descending | Select-Object -First 1
$psGetModuleSpecification = @{ModuleName = $module.Name; ModuleVersion = $module.Version.ToString() }
$psGetModuleCount = @(Get-Module PowerShellGet -ListAvailable).Count
$testCases = @(
@{
TestCaseName = 'case mismatch in resource name'
Name = 'script'
ModuleName = 'PSDscResources'
}
@{
TestCaseName = 'Both names have matching case'
Name = 'Script'
ModuleName = 'PSDscResources'
}
@{
TestCaseName = 'case mismatch in module name'
Name = 'Script'
ModuleName = 'psdscResources'
}
<#
Add these back when PowerShellGet is fixed https://github.com/PowerShell/PowerShellGet/pull/529
@{
TestCaseName = 'case mismatch in resource name'
Name = 'PsModule'
ModuleName = 'PowerShellGet'
}
@{
TestCaseName = 'Both names have matching case'
Name = 'PSModule'
ModuleName = 'PowerShellGet'
}
@{
TestCaseName = 'case mismatch in module name'
Name = 'PSModule'
ModuleName = 'powershellget'
}
#>
)
}
AfterAll {
$Global:ProgressPreference = $origProgress
}
it "should be able to get <Name> - <TestCaseName>" -TestCases $testCases {
param($Name)
if ($IsWindows) {
Set-ItResult -Pending -Because "Will only find script from PSDesiredStateConfiguration without modulename"
}
if ($PendingBecause) {
Set-ItResult -Pending -Because $PendingBecause
}
$resources = @(Get-DscResource -Name $name)
$resources | Should -Not -BeNullOrEmpty
foreach ($resource in $resource) {
$resource.Name | Should -Be $Name
if (Test-IsInvokeDscResourceEnable) {
$resource.ImplementationDetail | Should -Be 'ScriptBased'
}
else {
$resource.ImplementationDetail | Should -BeNullOrEmpty
}
}
}
it "should be able to get <Name> from <ModuleName> - <TestCaseName>" -TestCases $testCases {
param($Name, $ModuleName, $PendingBecause)
if ($IsLinux) {
Set-ItResult -Pending -Because "https://github.com/PowerShell/PSDesiredStateConfiguration/issues/12 and https://github.com/PowerShell/PowerShellGet/pull/529"
}
if ($PendingBecause) {
Set-ItResult -Pending -Because $PendingBecause
}
$resources = @(Get-DscResource -Name $name -Module $ModuleName)
$resources | Should -Not -BeNullOrEmpty
foreach ($resource in $resource) {
$resource.Name | Should -Be $Name
if (Test-IsInvokeDscResourceEnable) {
$resource.ImplementationDetail | Should -Be 'ScriptBased'
}
else {
$resource.ImplementationDetail | Should -BeNullOrEmpty
}
}
}
it "should throw when resource is not found" {
Set-ItResult -Pending -Because "https://github.com/PowerShell/PSDesiredStateConfiguration/issues/17"
{
Get-DscResource -Name antoehusatnoheusntahoesnuthao -Module tanshoeusnthaosnetuhasntoheusnathoseun
} |
Should -Throw -ErrorId 'Microsoft.PowerShell.Commands.WriteErrorException,CheckResourceFound'
}
}
Context "Get-DscResource - Class base Resources" {
BeforeAll {
@@ -118,11 +302,19 @@ Describe "Test PSDesiredStateConfiguration" {
$resource = Get-DscResource -Name $Name -Module $ModuleName
$resource | Should -Not -BeNullOrEmpty
$resource.Name | Should -Be $Name
$resource.ImplementationDetail | Should -Be 'ClassBased'
if (Test-IsInvokeDscResourceEnable) {
$resource.ImplementationDetail | Should -Be 'ClassBased'
}
else {
$resource.ImplementationDetail | Should -BeNullOrEmpty
}
}
it "should be able to get class resource - <Name> - <TestCaseName>" -TestCases $classTestCases {
param($Name, $ModuleName, $PendingBecause)
if ($IsWindows) {
Set-ItResult -Pending -Because "https://github.com/PowerShell/PSDesiredStateConfiguration/issues/19"
}
if ($PendingBecause) {
Set-ItResult -Pending -Because $PendingBecause
@@ -131,10 +323,14 @@ Describe "Test PSDesiredStateConfiguration" {
$resource = Get-DscResource -Name $Name
$resource | Should -Not -BeNullOrEmpty
$resource.Name | Should -Be $Name
$resource.ImplementationDetail | Should -Be 'ClassBased'
if (Test-IsInvokeDscResourceEnable) {
$resource.ImplementationDetail | Should -Be 'ClassBased'
}
else {
$resource.ImplementationDetail | Should -BeNullOrEmpty
}
}
}
Context "Invoke-DscResource" {
BeforeAll {
$origProgress = $global:ProgressPreference
@@ -150,6 +346,169 @@ Describe "Test PSDesiredStateConfiguration" {
$Global:ProgressPreference = $origProgress
}
Context "mof resources" {
BeforeAll {
$dscMachineStatusCases = @(
@{
value = '1'
expectedResult = $true
}
@{
value = '$true'
expectedResult = $true
}
@{
value = '0'
expectedResult = $false
}
@{
value = '$false'
expectedResult = $false
}
)
Install-ModuleIfMissing -Name PowerShellGet -Force -SkipPublisherCheck -MinimumVersion '2.2.1'
Install-ModuleIfMissing -Name xWebAdministration
$module = Get-Module PowerShellGet -ListAvailable | Sort-Object -Property Version -Descending | Select-Object -First 1
$psGetModuleSpecification = @{ModuleName = $module.Name; ModuleVersion = $module.Version.ToString() }
}
it "Set method should work" -Skip:(!(Test-IsInvokeDscResourceEnable)) {
if (!$IsLinux) {
$result = Invoke-DscResource -Name PSModule -ModuleName $psGetModuleSpecification -Method set -Property @{
Name = 'PsDscResources'
InstallationPolicy = 'Trusted'
}
}
else {
# workraound because of https://github.com/PowerShell/PowerShellGet/pull/529
Install-ModuleIfMissing -Name PsDscResources -Force
}
$result.RebootRequired | Should -BeFalse
$module = Get-module PsDscResources -ListAvailable
$module | Should -Not -BeNullOrEmpty -Because "Resource should have installed module"
}
it 'Set method should return RebootRequired=<expectedResult> when $global:DSCMachineStatus = <value>' -Skip:(!(Test-IsInvokeDscResourceEnable)) -TestCases $dscMachineStatusCases {
param(
$value,
$ExpectedResult
)
# using create scriptBlock because $using:<variable> doesn't work with existing Invoke-DscResource
# Verified in Windows PowerShell on 20190814
$result = Invoke-DscResource -Name Script -ModuleName PSDscResources -Method Set -Property @{TestScript = { Write-Output 'test'; return $false }; GetScript = { return @{ } }; SetScript = [scriptblock]::Create("`$global:DSCMachineStatus = $value;return") }
$result | Should -Not -BeNullOrEmpty
$result.RebootRequired | Should -BeExactly $expectedResult
}
it "Test method should return false" -Skip:(!(Test-IsInvokeDscResourceEnable)) {
$result = Invoke-DscResource -Name Script -ModuleName PSDscResources -Method Test -Property @{TestScript = { Write-Output 'test'; return $false }; GetScript = { return @{ } }; SetScript = { return } }
$result | Should -Not -BeNullOrEmpty
$result.InDesiredState | Should -BeFalse -Because "Test method return false"
}
it "Test method should return true" -Skip:(!(Test-IsInvokeDscResourceEnable)) {
$result = Invoke-DscResource -Name Script -ModuleName PSDscResources -Method Test -Property @{TestScript = { Write-Verbose 'test'; return $true }; GetScript = { return @{ } }; SetScript = { return } }
$result | Should -BeTrue -Because "Test method return true"
}
it "Test method should return true with moduleSpecification" -Skip:(!(Test-IsInvokeDscResourceEnable)) {
$module = get-module PsDscResources -ListAvailable
$moduleSpecification = @{ModuleName = $module.Name; ModuleVersion = $module.Version.ToString() }
$result = Invoke-DscResource -Name Script -ModuleName $moduleSpecification -Method Test -Property @{TestScript = { Write-Verbose 'test'; return $true }; GetScript = { return @{ } }; SetScript = { return } }
$result | Should -BeTrue -Because "Test method return true"
}
it "Invalid moduleSpecification" -Skip:(!(Test-IsInvokeDscResourceEnable)) {
Set-ItResult -Pending -Because "https://github.com/PowerShell/PSDesiredStateConfiguration/issues/17"
$moduleSpecification = @{ModuleName = 'PsDscResources'; ModuleVersion = '99.99.99.993' }
{
Invoke-DscResource -Name Script -ModuleName $moduleSpecification -Method Test -Property @{TestScript = { Write-Host 'test'; return $true }; GetScript = { return @{ } }; SetScript = { return } } -ErrorAction Stop
} |
Should -Throw -ErrorId 'InvalidResourceSpecification,Invoke-DscResource' -ExpectedMessage 'Invalid Resource Name ''Script'' or module specification.'
}
it "Test an embedded DSC resource" {
if (!(Test-IsInvokeDscResourceEnable)) {
Set-ItResult -Skipped -Because "Feature not enabled"
}
$resourceName="TestRes"
$moduleName="TestEmbeddedDSCResource"
$embObj = @(New-Object -TypeName psobject -Property @{embclassprop="property1"})
Install-ModuleIfMissing -Name $moduleName -Force
$resource = Get-DscResource -Name $resourceName -Module $moduleName -ErrorAction Stop
$resource | Should -Not -BeNullOrEmpty
$resource.Name | Should -Be $resourceName
$methodName="Test"
$result = Invoke-DscResource -Name $resourceName -ModuleName $moduleName -Method $methodName -Property @{embclassobj=$embObj;propName="property1"}
$result.InDesiredState | Should -BeTrue
$result = Invoke-DscResource -Name $resourceName -ModuleName $moduleName -Method $methodName -Property @{embclassobj=$embObj;propName="property2"}
$result.InDesiredState | Should -BeFalse
$methodName="Get"
$result = Invoke-DscResource -Name $resourceName -ModuleName $moduleName -Method $methodName -Property @{embclassobj=$embObj;propName="property1"}
$result.propName | Should -Be "property1"
$result = Invoke-DscResource -Name $resourceName -ModuleName $moduleName -Method $methodName -Property @{embclassobj=$embObj;propName="property2"}
$result.propName | Should -Not -Be "property1"
$methodName="Set"
$result = Invoke-DscResource -Name $resourceName -ModuleName $moduleName -Method $methodName -Property @{embclassobj=$embObj;propName="property1"}
$result | Should -Not -BeNullOrEmpty
$result.RebootRequired | Should -BeFalse
}
it "Using PsDscRunAsCredential should say not supported" -Skip:(!(Test-IsInvokeDscResourceEnable)) {
{
Invoke-DscResource -Name Script -ModuleName PSDscResources -Method Set -Property @{TestScript = { Write-Output 'test'; return $false }; GetScript = { return @{ } }; SetScript = {return}; PsDscRunAsCredential='natoheu'} -ErrorAction Stop
} |
Should -Throw -ErrorId 'PsDscRunAsCredentialNotSupport,Invoke-DscResource'
}
# waiting on Get-DscResource to be fixed
it "Invalid module name" -Skip:(!(Test-IsInvokeDscResourceEnable)) {
Set-ItResult -Pending -Because "https://github.com/PowerShell/PSDesiredStateConfiguration/issues/17"
{
Invoke-DscResource -Name Script -ModuleName santoheusnaasonteuhsantoheu -Method Test -Property @{TestScript = { Write-Host 'test'; return $true }; GetScript = { return @{ } }; SetScript = { return } } -ErrorAction Stop
} |
Should -Throw -ErrorId 'Microsoft.PowerShell.Commands.WriteErrorException,CheckResourceFound'
}
it "Invalid resource name" -Skip:(!(Test-IsInvokeDscResourceEnable)) {
if ($IsWindows) {
Set-ItResult -Pending -Because "https://github.com/PowerShell/PSDesiredStateConfiguration/issues/17"
}
{
Invoke-DscResource -Name santoheusnaasonteuhsantoheu -Method Test -Property @{TestScript = { Write-Host 'test'; return $true }; GetScript = { return @{ } }; SetScript = { return } } -ErrorAction Stop
} |
Should -Throw -ErrorId 'Microsoft.PowerShell.Commands.WriteErrorException,CheckResourceFound'
}
it "Get method should work" -Skip:(!(Test-IsInvokeDscResourceEnable)) {
if ($IsLinux) {
Set-ItResult -Pending -Because "https://github.com/PowerShell/PSDesiredStateConfiguration/issues/12 and https://github.com/PowerShell/PowerShellGet/pull/529"
}
$result = Invoke-DscResource -Name PSModule -ModuleName $psGetModuleSpecification -Method Get -Property @{ Name = 'PsDscResources' }
$result | Should -Not -BeNullOrEmpty
$result.Author | Should -BeLike 'Microsoft*'
$result.InstallationPolicy | Should -BeOfType [string]
$result.Guid | Should -BeOfType [Guid]
$result.Ensure | Should -Be 'Present'
$result.Name | Should -be 'PsDscResources'
$result.Description | Should -BeLike 'This*DSC*'
$result.InstalledVersion | should -BeOfType [Version]
$result.ModuleBase | Should -BeLike '*PSDscResources*'
$result.Repository | should -BeOfType [string]
$result.ModuleType | Should -Be 'Manifest'
}
}
Context "Class Based Resources" {
BeforeAll {
Install-ModuleIfMissing -Name XmlContentDsc -Force
@@ -171,7 +530,7 @@ Describe "Test PSDesiredStateConfiguration" {
$resolvedXmlPath = (Resolve-Path -Path $testXmlPath).ProviderPath
}
it 'Set method should work' {
it 'Set method should work' -Skip:(!(Test-IsInvokeDscResourceEnable)) {
param(
$value,
$ExpectedResult
@@ -180,263 +539,9 @@ Describe "Test PSDesiredStateConfiguration" {
$testString = '890574209347509120348'
$result = Invoke-DscResource -Name XmlFileContentResource -ModuleName XmlContentDsc -Property @{Path = $resolvedXmlPath; XPath = '/configuration/appSetting/Test1'; Ensure = 'Present'; Attributes = @{ TestValue2 = $testString; Name = $testString } } -Method Set
$result | Should -Not -BeNullOrEmpty
$result.GetType() | Should -Be 'InvokeDscResourceSetResult'
$result.RebootRequired | Should -BeFalse
$testXmlPath | Should -FileContentMatch $testString
}
it 'Get method should work' {
param(
$value,
$ExpectedResult
)
$result = Invoke-DscResource -Name XmlFileContentResource -ModuleName XmlContentDsc -Property @{Path = $resolvedXmlPath; XPath = '/configuration/appSetting/Test1'} -Method Get
$result.GetType() | Should -Be 'XmlFileContentResource'
}
it 'Test method should work' {
param(
$value,
$ExpectedResult
)
$result = Invoke-DscResource -Name XmlFileContentResource -ModuleName XmlContentDsc -Property @{Path = $resolvedXmlPath; XPath = '/configuration/appSetting/Test1'} -Method Test
$result | Should -Not -BeNullOrEmpty
$result.GetType() | Should -Be 'InvokeDscResourceTestResult'
$result.InDesiredState | Should -Not -BeNullOrEmpty
}
}
}
}
Describe "DSC MOF Compilation" {
BeforeAll {
# ensure that module is imported
Import-Module -Name PSDesiredStateConfiguration -MinimumVersion 3.0.0
Install-ModuleIfMissing -Name XmlContentDsc -Force
}
It "Should be able to compile a MOF using configuration keyword" {
Write-Verbose "DSC_HOME: ${env:DSC_HOME}" -Verbose
[Scriptblock]::Create(@"
configuration DSCTestConfig
{
Import-DscResource -ModuleName XmlContentDsc
Node "localhost" {
XmlFileContentResource f1
{
Path = 'testpath'
XPath = '/configuration/appSetting/Test1'
Ensure = 'Absent'
}
}
}
DSCTestConfig -OutputPath TestDrive:\DscTestConfig2
"@) | Should -Not -Throw
"TestDrive:\DscTestConfig2\localhost.mof" | Should -Exist
}
}
Describe "All types DSC resource tests" {
BeforeAll {
Import-Module -Name PSDesiredStateConfiguration -MinimumVersion 3.0.0
$SavedPSModulePath = $env:PSModulePath
$testModulesPath = Join-Path $PSScriptRoot "TestModules"
"TestModulesPath is " + $testModulesPath | Write-Verbose -Verbose
$env:PSModulePath = $testModulesPath + [System.IO.Path]::PathSeparator + $env:PSModulePath
"PSModulePath is " + $env:PSModulePath | Write-Verbose -Verbose
}
AfterAll {
$env:PSModulePath = $SavedPSModulePath
}
It "Check all property types in Get-DscResource" {
$resource = Get-DscResource | ? {$_.Name -eq "xTestClassResource"}
$resource | Should -Not -BeNullOrEmpty
$resource.Properties.Count | Should -Be 34
foreach($dscResourcePropertyInfo in $resource.Properties)
{
switch ($dscResourcePropertyInfo.Name)
{
"Name" {$dscResourcePropertyInfo.PropertyType | Should -Be '[string]'}
"Value" {$dscResourcePropertyInfo.PropertyType | Should -Be '[string]'}
"bValue" {$dscResourcePropertyInfo.PropertyType | Should -Be '[bool]'}
"sArray" {$dscResourcePropertyInfo.PropertyType | Should -Be '[string[]]'}
"bValueArray" {$dscResourcePropertyInfo.PropertyType | Should -Be '[bool[]]'}
"char16Value" {$dscResourcePropertyInfo.PropertyType | Should -Be '[char]'}
"char16ValueArray" {$dscResourcePropertyInfo.PropertyType | Should -Be '[char[]]'}
"dateTimeVal" {$dscResourcePropertyInfo.PropertyType | Should -Be '[DateTime]'}
"dateTimeArrayVal" {$dscResourcePropertyInfo.PropertyType | Should -Be '[DateTime[]]'}
"EmbClassObj" {$dscResourcePropertyInfo.PropertyType | Should -Be '[EmbClass]'}
"EmbClassObjArray" {$dscResourcePropertyInfo.PropertyType | Should -Be '[EmbClass[]]'}
"Ensure" {$dscResourcePropertyInfo.PropertyType | Should -Be '[string]'}
"Real32Value" {$dscResourcePropertyInfo.PropertyType | Should -Be '[Single]'}
"Real32ValueArray" {$dscResourcePropertyInfo.PropertyType | Should -Be '[Single[]]'}
"Real64Value" {$dscResourcePropertyInfo.PropertyType | Should -Be '[double]'}
"Real64ValueArray" {$dscResourcePropertyInfo.PropertyType | Should -Be '[double[]]'}
"sInt8Value" {$dscResourcePropertyInfo.PropertyType | Should -Be '[SByte]'}
"sInt8ValueArray" {$dscResourcePropertyInfo.PropertyType | Should -Be '[SByte[]]'}
"sInt16Value" {$dscResourcePropertyInfo.PropertyType | Should -Be '[Int16]'}
"sInt16ValueArray" {$dscResourcePropertyInfo.PropertyType | Should -Be '[Int16[]]'}
"sInt32Value" {$dscResourcePropertyInfo.PropertyType | Should -Be '[Int32]'}
"sInt32ValueArray" {$dscResourcePropertyInfo.PropertyType | Should -Be '[Int32[]]'}
"sInt64Value" {$dscResourcePropertyInfo.PropertyType | Should -Be '[Int64]'}
"sInt64ValueArray" {$dscResourcePropertyInfo.PropertyType | Should -Be '[Int64[]]'}
"uInt8Value" {$dscResourcePropertyInfo.PropertyType | Should -Be '[Byte]'}
"uInt8ValueArray" {$dscResourcePropertyInfo.PropertyType | Should -Be '[Byte[]]'}
"uInt16Value" {$dscResourcePropertyInfo.PropertyType | Should -Be '[UInt16]'}
"uInt16ValueArray" {$dscResourcePropertyInfo.PropertyType | Should -Be '[UInt16[]]'}
"uInt32Value" {$dscResourcePropertyInfo.PropertyType | Should -Be '[UInt32]'}
"uInt32ValueArray" {$dscResourcePropertyInfo.PropertyType | Should -Be '[UInt32[]]'}
"uInt64Value" {$dscResourcePropertyInfo.PropertyType | Should -Be '[UInt64]'}
"uInt64ValueArray" {$dscResourcePropertyInfo.PropertyType | Should -Be '[UInt64[]]'}
}
}
}
It "Check all property types in Invoke-DscResource" {
$resource = Invoke-DscResource -Name xTestClassResource -ModuleName xTestClassResource -Method Get -Property @{Name="Test"}
$resource | Should -Not -BeNullOrEmpty
$resource.GetType().Name | Should -Be "xTestClassResource"
$resource.Name | Should -Be "Test"
$resource.Value | Should -Be "Inside if"
$resource.Name.GetType().Name | Should -Be "String"
$resource.Value.GetType().Name | Should -Be "String"
$resource.sArray.GetType().Name | Should -Be "String[]"
$resource.bValue.GetType().Name | Should -Be "Boolean"
$resource.bValueArray.GetType().Name | Should -Be "Boolean[]"
$resource.char16Value.GetType().Name | Should -Be "Char"
$resource.char16ValueArray.GetType().Name | Should -Be "Char[]"
$resource.dateTimeVal.GetType().Name | Should -Be "DateTime"
$resource.dateTimeArrayVal.GetType().Name | Should -Be "DateTime[]"
$resource.EmbClassObj.GetType().Name | Should -Be "EmbClass"
$resource.EmbClassObjArray.GetType().Name | Should -Be "EmbClass[]"
$resource.Ensure.GetType().Name | Should -Be "Ensure"
$resource.Real32Value.GetType().Name | Should -Be "Single"
$resource.Real32ValueArray.GetType().Name | Should -Be "Single[]"
$resource.Real64Value.GetType().Name | Should -Be "Double"
$resource.Real64ValueArray.GetType().Name | Should -Be "Double[]"
$resource.sInt8Value.GetType().Name | Should -Be "SByte"
$resource.sInt8ValueArray.GetType().Name | Should -Be "SByte[]"
$resource.sInt16Value.GetType().Name | Should -Be "Int16"
$resource.sInt16ValueArray.GetType().Name | Should -Be "Int16[]"
$resource.sInt32Value.GetType().Name | Should -Be "Int32"
$resource.sInt32ValueArray.GetType().Name | Should -Be "Int32[]"
$resource.sInt64Value.GetType().Name | Should -Be "Int64"
$resource.sInt64ValueArray.GetType().Name | Should -Be "Int64[]"
$resource.uInt8Value.GetType().Name | Should -Be "Byte"
$resource.uInt8ValueArray.GetType().Name | Should -Be "Byte[]"
$resource.uInt16Value.GetType().Name | Should -Be "UInt16"
$resource.uInt16ValueArray.GetType().Name | Should -Be "UInt16[]"
$resource.uInt32Value.GetType().Name | Should -Be "UInt32"
$resource.uInt32ValueArray.GetType().Name | Should -Be "UInt32[]"
$resource.uInt64Value.GetType().Name | Should -Be "UInt64"
$resource.uInt64ValueArray.GetType().Name | Should -Be "UInt64[]"
# extra check for embedded objects
$resource.EmbClassObj.EmbClassStr1 | Should -Be "TestEmbObjValue"
$resource.EmbClassObjArray[0].EmbClassStr1 | Should -Be "TestEmbClassStr1Value"
}
It "Check all property types in configuration compilation" {
[Scriptblock]::Create(@"
configuration DSCAllTypesConfig
{
Import-DscResource -ModuleName xTestClassResource
Node "localhost" {
xTestClassResource f1
{
Name = 'TestName'
Value = 'TestValue'
char16Value = 'A'
char16ValueArray = @('A','B')
sArray = @('Test1','Test2')
bValue = `$true
bValueArray = @(`$true,`$false)
dateTimeVal = Get-Date
dateTimeArrayVal = @(`$(Get-Date), `$(Get-Date))
Ensure = 'Present'
uInt8Value = 255
sInt8Value = -128
uInt16Value = 65535
sInt16Value = -32768
uInt32Value = 4294967295
sInt32Value = -2147483648
uInt64Value = 18446744073709551615
sInt64Value = -9223372036854775808
Real32Value = [Single]-1.234
Real64Value = [Double]-1.234
uInt8ValueArray = @(255)
sInt8ValueArray = @(-128)
uInt16ValueArray = @(65535)
sInt16ValueArray = @(-32768)
uInt32ValueArray = @(4294967295)
sInt32ValueArray = @(-2147483648)
uInt64ValueArray = @(18446744073709551615)
sInt64ValueArray = @(-9223372036854775808)
}
}
}
DSCAllTypesConfig -OutputPath TestDrive:\DSCAllTypesConfig
"@) | Should -Not -Throw
"TestDrive:\DSCAllTypesConfig\localhost.mof" | Should -Exist
Get-Content -Raw -Path "TestDrive:\DSCAllTypesConfig\localhost.mof" | Write-Verbose -Verbose
}
It "Check multi-resource configuration compilation with dependencies" {
[Scriptblock]::Create(@"
configuration MultiResourceConfig
{
Import-DscResource -ModuleName xTestClassResource
ResourceForTests1 r1
{
Prop1 = 'Test'
}
ResourceForTests2 r2
{
Prop1 = 'Test'
DependsOn = '[ResourceForTests1]r1'
}
ResourceForTests3 r3
{
Prop1 = 'Test'
DependsOn = '[ResourceForTests1]r1','[ResourceForTests2]r2'
}
}
MultiResourceConfig -OutputPath TestDrive:\MultiResourceConfig
"@) | Should -Not -Throw
"TestDrive:\MultiResourceConfig\localhost.mof" | Should -Exist
Get-Content -Raw -Path "TestDrive:\MultiResourceConfig\localhost.mof" | Write-Verbose -Verbose
}
}
@@ -1,325 +0,0 @@
enum Ensure
{
Absent
Present
}
class EmbClass
{
[DscProperty()]
[string] $EmbClassStr1
}
[DscResource()]
class xTestClassResource
{
[DscProperty(Key)]
[string]$Name
[DscProperty(Mandatory)]
[string] $Value
[DscProperty()]
[Ensure] $Ensure
[DscProperty()]
[string[]] $sArray
[DscProperty()]
[EmbClass] $EmbClassObj
[DscProperty()]
[EmbClass[]] $EmbClassObjArray
[DscProperty()]
[DateTime] $dateTimeVal;
[DscProperty()]
[DateTime[]] $dateTimeArrayVal;
[DscProperty()]
[Boolean] $bValue;
[DscProperty()]
[Byte] $uInt8Value;
[DscProperty()]
[SByte] $sInt8Value;
[DscProperty()]
[UInt16] $uInt16Value;
[DscProperty()]
[Int16] $sInt16Value;
[DscProperty()]
[UInt32] $uInt32Value;
[DscProperty()]
[Int32] $sInt32Value;
[DscProperty()]
[UInt64] $uInt64Value;
[DscProperty()]
[Int64] $sInt64Value;
[DscProperty()]
[Single] $Real32Value;
[DscProperty()]
[Double] $Real64Value;
[DscProperty()]
[Char] $char16Value;
[DscProperty()]
[Boolean[]] $bValueArray;
[DscProperty()]
[Byte[]] $uInt8ValueArray;
[DscProperty()]
[SByte[]] $sInt8ValueArray;
[DscProperty()]
[UInt16[]] $uInt16ValueArray;
[DscProperty()]
[Int16[]] $sInt16ValueArray;
[DscProperty()]
[UInt32[]] $uInt32ValueArray;
[DscProperty()]
[Int32[]] $sInt32ValueArray;
[DscProperty()]
[UInt64[]] $uInt64ValueArray;
[DscProperty()]
[Int64[]] $sInt64ValueArray;
[DscProperty()]
[single[]] $Real32ValueArray;
[DscProperty()]
[double[]] $Real64ValueArray;
[DscProperty()]
[Char[]] $char16ValueArray;
[void] Set()
{
Set-StrictMode -Version Latest
if ($this.Ensure -eq [Ensure]::Present)
{
if ($this.Value -eq "fail")
{
Write-Error "Ensure=Present failed for $($this.Name) due to value $($this.Value)"
}
}
elseif ($this.Ensure -eq [Ensure]::Absent)
{
if ($this.Value -eq "fail")
{
Write-Error "Ensure=Absent failed for $($this.Name) due to value $($this.Value)"
}
}
}
[bool] Test()
{
Write-Debug "Inside Test()"
Set-StrictMode -Version Latest
[bool] $result = $false
if ($this.value -eq "fail")
{
Write-Error "Failing Test-TargetResource because Value is set to 'fail'"
}
else
{
Write-Verbose "Start of EmbClassObjArray" -Verbose
foreach ($classObj in $this.EmbClassObjArray)
{
$classObj.EmbClassStr1 | write-Verbose -verbose
}
Write-Verbose "End of EmbClassObjArray" -Verbose
Write-Verbose "Ensure: $($this.Ensure)" -verbose
Write-Verbose "sArray: $($this.sArray)" -verbose
Write-Verbose "dateTimeVal: $($this.dateTimeVal)" -verbose
Write-Verbose "dateTimeArrayVal: $($this.dateTimeArrayVal)" -verbose
Write-Verbose "bValue: $($this.bValue)" -verbose
Write-Verbose "uInt8Value: $($this.uInt8Value)" -verbose
Write-Verbose "sInt8Value: $($this.sInt8Value)" -verbose
Write-Verbose "uInt16Value: $($this.uInt16Value)" -verbose
Write-Verbose "sInt16Value: $($this.sInt16Value)" -verbose
Write-Verbose "uInt32Value: $($this.uInt32Value)" -verbose
Write-Verbose "sInt32Value: $($this.sInt32Value)" -verbose
Write-Verbose "uInt64Value: $($this.uInt64Value)" -verbose
Write-Verbose "sInt64Value: $($this.sInt64Value)" -verbose
Write-Verbose "Real32Value: $($this.Real32Value)" -verbose
Write-Verbose "Real64Value: $($this.Real64Value)" -verbose
Write-Verbose "bValueArray: $($this.bValueArray)" -verbose
Write-Verbose "char16Value: $($this.char16Value)" -verbose
Write-Verbose "uInt8ValueArray: $($this.uInt8ValueArray)" -verbose
Write-Verbose "sInt8ValueArray: $($this.sInt8ValueArray)" -verbose
Write-Verbose "uInt16ValueArray: $($this.uInt16ValueArray)" -verbose
Write-Verbose "sInt16ValueArray: $($this.sInt16ValueArray)" -verbose
Write-Verbose "uInt32ValueArray: $($this.uInt32ValueArray)" -verbose
Write-Verbose "sInt32ValueArray: $($this.sInt32ValueArray)" -verbose
Write-Verbose "uInt64ValueArray: $($this.uInt64ValueArray)" -verbose
Write-Verbose "sInt64ValueArray: $($this.sInt64ValueArray)" -verbose
Write-Verbose "Real32ValueArray: $($this.Real32ValueArray)" -verbose
Write-Verbose "Real64ValueArray: $($this.Real64ValueArray)" -verbose
Write-Verbose "char16ValueArray: $($this.char16ValueArray)" -verbose
[Single]$f = -1.000003
[double]$d = -1.234
$result = ($this.EmbClassObjArray[1].EmbClassStr1 -eq $this.Ensure) -and `
($this.sArray[1] -eq "s2") -and `
($this.dateTimeVal -lt (get-date 2020-12-12)) -and `
($this.dateTimeArrayVal[1] -gt (get-date 2020-08-20)) -and `
($this.bValue -eq $true) -and `
($this.uInt8Value -eq 255) -and `
($this.sInt8Value -eq -128) -and `
($this.uInt16Value -eq 65535) -and `
($this.sInt16Value -eq -32768) -and `
($this.uInt32Value -eq 4294967295) -and `
($this.sInt32Value -eq -2147483648) -and `
($this.uInt64Value -eq 18446744073709551615) -and `
($this.sInt64Value -eq -9223372036854775808) -and `
($this.Real32Value -eq $f) -and `
($this.Real64Value -eq $d) -and `
($this.bValueArray[1] -eq $true) -and `
($this.char16Value -eq 'c') -and `
($this.uInt8ValueArray[1] -eq 254) -and `
($this.sInt8ValueArray[1] -eq -127) -and `
($this.uInt16ValueArray[1] -eq 65534) -and `
($this.sInt16ValueArray[1] -eq -32767) -and `
($this.uInt32ValueArray[1] -eq 4294967294) -and `
($this.sInt32ValueArray[1] -eq -2147483647) -and `
($this.uInt64ValueArray[1] -eq 18446744073709551614) -and `
($this.sInt64ValueArray[1] -eq -9223372036854775807) -and `
($this.Real32ValueArray[1] -eq $f) -and `
($this.Real64ValueArray[1] -eq $d) -and `
($this.char16ValueArray[1] -eq 'd')
}
return $result
}
[xTestClassResource] Get()
{
Write-Debug "Inside Get()"
if ($this.Value -ne "fail")
{
$this.Value = "Inside if"
}
else
{
$this.Value = "Inside else"
}
# initialize properties so that they are not null
$this.char16Value = "A"
$this.sArray = [String[]]::new(0)
$this.EmbClassObj = [EmbClass]::new()
$this.EmbClassObj.EmbClassStr1 = "TestEmbObjValue"
$EmbObj = [EmbClass]::new()
$EmbObj.EmbClassStr1 = "TestEmbClassStr1Value"
$this.EmbClassObjArray = [EmbClass[]]::new(1)
$this.EmbClassObjArray[0] = $EmbObj
$this.dateTimeVal = [DateTime]::Now
$this.dateTimeArrayVal = [DateTime[]]::new(0)
$this.bValueArray = [Boolean[]]::new(0)
$this.char16ValueArray = [Char[]]::new(0)
$this.uInt8ValueArray = [Byte[]]::new(0)
$this.sInt8ValueArray = [SByte[]]::new(0)
$this.uInt16ValueArray = [UInt16[]]::new(0)
$this.sInt16ValueArray = [Int16[]]::new(0)
$this.uInt32ValueArray = [UInt32[]]::new(0)
$this.sInt32ValueArray = [Int32[]]::new(0)
$this.uInt64ValueArray = [UInt64[]]::new(0)
$this.sInt64ValueArray = [Int64[]]::new(0)
$this.Real32ValueArray = [single[]]::new(0)
$this.Real64ValueArray = [double[]]::new(0)
return $this
}
}
[DscResource()]
class ResourceForTests1
{
[DscProperty(Key)]
[string] $Prop1
[void] Set()
{
}
[bool] Test()
{
return $true
}
[ResourceForTests1] Get()
{
return $this
}
}
[DscResource()]
class ResourceForTests2
{
[DscProperty(Key)]
[string] $Prop1
[void] Set()
{
}
[bool] Test()
{
return $true
}
[ResourceForTests2] Get()
{
return $this
}
}
[DscResource()]
class ResourceForTests3
{
[DscProperty(Key)]
[string] $Prop1
[void] Set()
{
}
[bool] Test()
{
return $true
}
[ResourceForTests3] Get()
{
return $this
}
}
+38
View File
@@ -0,0 +1,38 @@
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License.
Describe "DSC MOF Compilation" -tags "CI" {
BeforeAll {
$module = Get-Module PowerShellGet -ListAvailable | Sort-Object -Property Version -Descending | Select-Object -First 1
$psGetModuleVersion = $module.Version.ToString()
if (!$env:DSC_HOME)
{
Import-Module PSDesiredStateConfiguration
}
}
It "Should be able to compile a MOF using PSModule resource" {
if ($IsLinux) {
Set-ItResult -Pending -Because "https://github.com/PowerShell/PowerShellGet/pull/529"
}
Write-Verbose "DSC_HOME: ${env:DSC_HOME}" -verbose
[Scriptblock]::Create(@"
configuration DSCTestConfig
{
Import-DscResource -ModuleName PowerShellGet -ModuleVersion $psGetModuleVersion
Node "localhost" {
PSModule f1
{
Name = 'PsDscResources'
InstallationPolicy = 'Trusted'
}
}
}
DSCTestConfig -OutputPath TestDrive:\DscTestConfig2
"@) | Should -Not -Throw
"TestDrive:\DscTestConfig2\localhost.mof" | Should -Exist
}
}
+7
View File
@@ -0,0 +1,7 @@
&$PSScriptRoot/build.ps1 -Build -Clean
Write-Verbose -Message "Updating signing.xml ..." -Verbose
$files = @(Get-ChildItem $PSScriptRoot/out/*.ps* -Recurse | Select-Object -ExpandProperty FullName)
&$PSScriptRoot/tools/releaseBuild/generatePackgeSigning.ps1 -AuthenticodeFiles $files -path $PSScriptRoot/tools/releaseBuild/signing.xml -rootPath $PSScriptRoot/out/
Write-Verbose -Message "Done ..." -Verbose
# Make sure the file ends with an empty line
Add-Content -value '' -Path $PSScriptRoot/tools/releaseBuild/signing.xml