Compare commits

...

34 Commits

Author SHA1 Message Date
DoLearnWhileAlive 8f5c724737 ConvertTo-MOFInstance: Include resource properties with empty array value (#127)
* ConvertTo-MOFInstance: Include resource properties with empty array value

* Add test for checking mof compilation with empty array value
2025-12-04 12:48:57 -08:00
Raimund Andrée e32eb0fe51 Fixed an issue with array parameters is key-value pairs (#128) (#129)
* Fixed an issue with array parameters is key-value pairs (#128)

* Add hashtable property to xTestClassResource

* Add support for Hashtable property in DSC resource tests
2025-12-04 12:47:16 -08:00
Andy Jordan c26e6b79d0 Update Code of Conduct and Security Policy (#124)
Updates the readme, code of conduct and security policy per OSPO request.
2024-07-03 15:29:29 -07:00
Michael Greene b711f75b46 Update ReadMe (#114)
* Update README.md

* Update README.md

* Update README.md

Co-authored-by: Mikey Lombardi (He/Him) <michael.t.lombardi@gmail.com>

---------

Co-authored-by: Mikey Lombardi (He/Him) <michael.t.lombardi@gmail.com>
2023-08-04 09:34:33 -07:00
Andrew d6e028d39c Updated changelog for v2.0.7 2023-05-13 12:11:56 -07:00
Andrew 8249681ba9 Fixed link in v2 changelog 2023-02-27 13:54:18 -08:00
Andrew 8daa912f90 Added v2 changelog 2023-02-27 13:49:07 -08:00
Steve Lee 025d75fa4b Change ErrorAction to Ignore so that the error doesn't show up in $Error (#93) 2023-02-14 12:28:13 -08:00
Mikey Lombardi (He/Him) 04830ef480 (AB#5129) Add issue templates and configuration (#92)
This change replaces the default issue templates with YAML issue
templates based on those used across the other PowerShell modules.

It introduces configuration for the issues, including links to filing
feedback for PowerShell, Windows PowerShell, documentation, and Azure
Policy (as **PSDesiredStateConfiguration** v2+ is users of Azure
Policy's machine configuration feature).
2022-08-31 14:12:43 -07:00
Jason Helmick 805041c8fe adding LICENSE (#71) 2022-04-21 14:10:44 -07:00
Jason Helmick 62d16f9563 updated readme (#70) 2022-04-21 11:34:19 -07:00
Andrew a201b69203 Added SBOM generation and changed image to PSMMS2019-Secure (#69) 2022-01-28 14:07:57 -08:00
Steve Lee 2eb60a3b42 Revert "add issue template (#64)" (#66)
This reverts commit 98b309a072.
2021-09-13 17:18:23 -07:00
Steve Lee 98b309a072 add issue template (#64) 2021-08-05 17:33:46 -07:00
Andrew 358ad24f02 Release pipeline updates for 1ES (#63) 2021-06-24 10:29:53 -07:00
Andrew 442570873b Update release pipeline for 1ES (#61) 2021-06-22 17:01:27 -07:00
Andrew f313360adb Updated Readme with v3 build and release information (#62) 2021-06-22 13:22:51 -07:00
Andrew 16b9577570 Removed unused infra files (#60) 2021-06-22 11:57:18 -07:00
Andrew e38eff71dd Removed CR character from MOF compilation code (#59) 2021-06-21 18:06:57 -07:00
Michael Greene 1cf55c3b43 MOF formatting issues (#58) 2021-06-21 17:50:30 -07:00
Andrew 3f9fc054d0 Fixed DependsOn and other OMI_BaseResource properties (#56) 2021-06-18 15:05:06 -07:00
Andrew f7cf284699 Update progress bar message by removing CIM (#57) 2021-06-17 14:52:41 -07:00
Andrew 892e1035f2 Updating tests for v3 (#55) 2021-06-15 15:52:39 -07:00
Andrew 840fe859a4 Updates to azure-pipelines-ci.yml (#53) 2021-06-10 14:39:38 -07:00
Andrew e068c6e29a Fixed missed closing bracket in module manifest (#54) 2021-06-10 13:26:48 -07:00
Andrew b73efca1fc Remove PSDesiredStateConfiguration.InvokeDscResource experimental feature. (#52) 2021-06-07 19:10:24 -07:00
Andrew 0d1eb75731 Added Prerelease-beta1 to module version, tags and ProjectUri (#50) 2021-06-02 14:15:20 -07:00
Andrew e3ec5c52d9 Build update related to compiling subsystem dll (#49) 2021-06-01 20:39:48 -07:00
Andrew 29c6dbd52d Update Invoke-DscClassBasedResource (#48) 2021-05-28 14:50:48 -07:00
Andrew 387eff0c97 Updated required PS version (#47) 2021-05-28 12:23:40 -07:00
Andrew f35d20ad91 Updating CI and Release pipelines with latest Compliance (#43) 2021-05-24 16:41:23 -07:00
Andrew 5df94aa00b Initial DSC v3 changes (#39) 2021-05-24 16:03:35 -07:00
bagajjal 836f7e532c support embedded resource (#38) 2020-08-31 17:20:16 -07:00
Travis Plunk 7ac2ce4d07 Fix CI issues (#40) 2020-08-13 17:22:12 -07:00
39 changed files with 5207 additions and 1212 deletions
+10
View File
@@ -0,0 +1,10 @@
# Microsoft Open Source Code of Conduct
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
Resources:
- [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/)
- [Microsoft Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
- Contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with questions or concerns
- Employees can reach out at [aka.ms/opensource/moderation-support](https://aka.ms/opensource/moderation-support)
+77
View File
@@ -0,0 +1,77 @@
name: Bug report 🐛
description: Report errors or unexpected behavior 🤔
labels:
- bug
- Needs-Triage
body:
- type: markdown
attributes:
value: >-
This repository is **ONLY** for issues related to DSC in the published
PSDesiredStateConfiguration module.
- type: checkboxes
attributes:
label: Prerequisites
options:
- label: Write a descriptive title.
required: true
- label: Make sure you are able to repro it on the [latest released version](https://www.powershellgallery.com/packages/PSDesiredStateConfiguration)
required: true
- label: Search the existing issues.
required: true
- type: textarea
attributes:
label: Steps to reproduce
description: >
List of steps, sample code, failing test or link to a project that reproduces the behavior.
Make sure you place a stack trace inside a code (```) block to avoid linking unrelated issues.
placeholder: >
I am experiencing a problem with X.
I think Y should be happening but Z is actually happening.
validations:
required: true
- type: textarea
attributes:
label: Expected behavior
render: console
placeholder: |
PS> 2 + 2
4
validations:
required: true
- type: textarea
attributes:
label: Actual behavior
render: console
placeholder: |
PS> 2 + 2
5
validations:
required: true
- type: textarea
attributes:
label: Error details
description: Paste verbatim output from `Get-Error` if PowerShell returns an error.
render: console
placeholder: PS> Get-Error
- type: textarea
attributes:
label: Environment data
description: Paste verbatim output from `$PSVersionTable` below.
render: PowerShell
placeholder: PS> $PSVersionTable
validations:
required: true
- type: input
validations:
required: true
attributes:
label: Version
description: Specify the version of Crescendo you are using.
- type: textarea
attributes:
label: Visuals
description: >
Please upload images or animations that can be used to reproduce issues in the area below.
Try the [Steps Recorder](https://support.microsoft.com/en-us/windows/record-steps-to-reproduce-a-problem-46582a9b-620f-2e36-00c9-04e25d784e47)
on Windows or [Screenshot](https://support.apple.com/en-us/HT208721) on macOS.
@@ -0,0 +1,23 @@
name: Feature Request / Idea 🚀
description: Suggest a new feature or improvement (this does not mean you have to implement it)
labels:
- enhancement
- Needs-Triage
body:
- type: textarea
attributes:
label: Summary of the new feature / enhancement
description: >
A clear and concise description of what the problem is that the new feature would solve. Try
formulating it in user story style (if applicable).
placeholder: >
'As a user I want X so that Y...' with X being the being the action and Y being the value of
the action.
validations:
required: true
- type: textarea
attributes:
label: Proposed technical implementation details (optional)
placeholder: >
A clear and concise description of what you want to happen. Consider providing an example
experience with expected result.
+17
View File
@@ -0,0 +1,17 @@
blank_issues_enabled: false
contact_links:
- name: PowerShell Issues
url: https://github.com/PowerShell/PowerShell/issues/new
about: PowerShell issues or suggestions.
- name: Windows PowerShell Issues
url: https://support.microsoft.com/windows/send-feedback-to-microsoft-with-the-feedback-hub-app-f59187f8-8739-22d6-ba93-f66612949332
about: Windows PowerShell issues or suggestions.
- name: Support
url: https://github.com/PowerShell/PowerShell/blob/master/.github/SUPPORT.md
about: PowerShell Support Questions/Help
- name: Documentation Issue
url: https://github.com/MicrosoftDocs/PowerShell-Docs-DSC/issues/new/choose
about: Please open issues on documentation for DSC here.
- name: Azure Policy Feedback
about: File feedback for Azure Policy's machine configuration feature
url: https://feedback.azure.com/d365community/forum/675ae472-f324-ec11-b6e6-000d3a4f0da0
+41
View File
@@ -0,0 +1,41 @@
<!-- BEGIN MICROSOFT SECURITY.MD V0.0.9 BLOCK -->
## Security
Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/Microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet), [Xamarin](https://github.com/xamarin) and [PowerShell](https://github.com/PowerShell).
If you believe you have found a security vulnerability in any Microsoft-owned repository that meets [Microsoft's definition of a security vulnerability](https://aka.ms/security.md/definition), please report it to us as described below.
## Reporting Security Issues
**Please do not report security vulnerabilities through public GitHub issues.**
Instead, please report them to the Microsoft Security Response Center (MSRC) at [https://msrc.microsoft.com/create-report](https://aka.ms/security.md/msrc/create-report).
If you prefer to submit without logging in, send email to [secure@microsoft.com](mailto:secure@microsoft.com). If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://aka.ms/security.md/msrc/pgp).
You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://www.microsoft.com/msrc).
Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:
* Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
* Full paths of source file(s) related to the manifestation of the issue
* The location of the affected source code (tag/branch/commit or direct URL)
* Any special configuration required to reproduce the issue
* Step-by-step instructions to reproduce the issue
* Proof-of-concept or exploit code (if possible)
* Impact of the issue, including how an attacker might exploit the issue
This information will help us triage your report more quickly.
If you are reporting for a bug bounty, more complete reports can contribute to a higher bounty award. Please visit our [Microsoft Bug Bounty Program](https://aka.ms/security.md/msrc/bounty) page for more details about our active programs.
## Preferred Languages
We prefer all communications to be in English.
## Policy
Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://aka.ms/security.md/cvd).
<!-- END MICROSOFT SECURITY.MD BLOCK -->
+115 -42
View File
@@ -9,70 +9,143 @@ pr:
branches: branches:
include: include:
- master - master
- feature-*
paths: resources:
exclude: repositories:
- /.dependabot/* - repository: ComplianceRepo
- /.poshchan/* type: github
- /.github/**/* endpoint: ComplianceGHRepo
- /.vscode/**/* name: PowerShell/compliance
- /.vsts-ci/misc-analysis.yml
- /tools/**/*
- .editorconfig
- .gitattributes
- .gitignore
- /docs/**/*
- /CHANGELOG.md
- /CONTRIBUTING.md
- /README.md
- /LICENSE.txt
- /CODE_OF_CONDUCT.md
stages: stages:
- stage: Build - stage: Build
displayName: Build PowerShell Package displayName: Build PSDesiredStateConfiguration module
pool:
vmImage: windows-latest
jobs: jobs:
- job: BuildPkg - job: BuildPkg
displayName: Build Package displayName: Build Package
pool:
vmImage: windows-2019
steps: steps:
- template: templates/ci-build.yml - powershell: |
$powerShellPath = Join-Path -Path $env:AGENT_TEMPDIRECTORY -ChildPath 'powershell'
Invoke-WebRequest -Uri https://raw.githubusercontent.com/PowerShell/PowerShell/master/tools/install-powershell.ps1 -outfile ./install-powershell.ps1
./install-powershell.ps1 -Destination $powerShellPath
$vstsCommandString = "vso[task.setvariable variable=PATH]$powerShellPath;$env:PATH"
Write-Host "sending " + $vstsCommandString
Write-Host "##$vstsCommandString"
displayName: Install PowerShell Core
- task: NuGetToolInstaller@1
displayName: 'Install NuGet 5.9.1'
inputs:
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: | - pwsh: |
Write-Verbose "BUILD_OUTPUT_PATH- $env:BUILD_OUTPUT_PATH" -Verbose Get-ChildItem -Path env:
Write-Verbose "SIGNED_OUTPUT_PATH- $env:SIGNED_OUTPUT_PATH" -Verbose displayName: Capture environment for build
Copy-Item $env:BUILD_OUTPUT_PATH $env:SIGNED_OUTPUT_PATH -Recurse -Force condition: succeededOrFailed()
displayName: Build Signing Placeholder
- pwsh: | - pwsh: |
$(Build.SourcesDirectory)/build.ps1 -Publish -Signed $modulePath = Join-Path -Path $env:AGENT_TEMPDIRECTORY -ChildPath 'TempModules'
displayName: Publish if (Test-Path -Path $modulePath) {
timeoutInMinutes: 10 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
- 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
displayName: Install PSPackageProject and dependencies
- pwsh: |
$modulePath = Join-Path -Path $env:AGENT_TEMPDIRECTORY -ChildPath 'TempModules'
$env:PSModulePath = $modulePath + [System.IO.Path]::PathSeparator + $env:PSModulePath
$modPath = Join-Path -Path $modulePath -ChildPath PSPackageProject
Write-Verbose -Verbose "Importing PSPackageProject from: $modPath"
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)"
artifact: Build
displayName: Publish build
- stage: Compliance
displayName: Compliance
dependsOn: Build
jobs:
- job: Compliance_Job
pool:
vmImage: windows-latest
steps:
- checkout: self
- checkout: ComplianceRepo
- download: current
artifact: Build
- pwsh: |
Get-ChildItem -Path "$(Pipeline.Workspace)\Build" -Recurse
displayName: Capture downloaded artifacts
- template: ci-compliance.yml@ComplianceRepo
parameters:
# component-governance
sourceScanPath: '$(Pipeline.Workspace)\Build'
# credscan
suppressionsFile: ''
# TermCheck
optionsRulesDBPath: ''
optionsFTPath: ''
# tsa-upload
codeBaseName: 'PSDesiredStateConfiguration_20210423'
# selections
APIScan: false # set to false when not using Windows APIs.
- stage: Test - stage: Test
displayName: Test Package displayName: Test Package
dependsOn: Build
jobs: jobs:
- template: templates/ci-test.yml - template: templates/ci-test.yml
parameters: parameters:
jobName: TestPkgWin jobName: TestPkgWin
displayName: PowerShell Core on Windows displayName: PowerShell Core on Windows
imageName: windows-2019 imageName: windows-latest
# Not supported on Windows PowerShell per PSD1
# - template: test.yml
# parameters:
# jobName: TestPkgWinPS
# displayName: Windows PowerShell on Windows
# imageName: windows-2019
# powershellExecutable: powershell
- template: templates/ci-test.yml - template: templates/ci-test.yml
parameters: parameters:
jobName: TestPkgUbuntu16 jobName: TestPkgUbuntu
displayName: PowerShell Core on Ubuntu 16.04 displayName: PowerShell Core on Ubuntu
imageName: ubuntu-16.04 imageName: ubuntu-latest
- template: templates/ci-test.yml - template: templates/ci-test.yml
parameters: parameters:
jobName: TestPkgWinMacOS jobName: TestPkgWinMacOS
displayName: PowerShell Core on macOS displayName: PowerShell Core on macOS
imageName: macOS-10.14 imageName: macOS-latest
+191 -128
View File
@@ -1,150 +1,213 @@
name: $(BuildDefinitionName)_$(date:yyMM).$(date:dd)$(rev:rrr) name: $(BuildDefinitionName)_$(date:yyMM).$(date:dd)$(rev:rrr)
trigger: trigger: none
batch: true
branches: resources:
include: repositories:
- master - repository: ComplianceRepo
paths: type: github
exclude: endpoint: ComplianceGHRepo
- /.dependabot/* name: PowerShell/compliance
- /.poshchan/*
- /.github/**/* variables:
- /.vscode/**/* - name: PackageName
- /.vsts-ci/misc-analysis.yml value: 'PSDesiredStateConfiguration'
- /tools/**/* - name: PackageVersion
- .editorconfig value: '3.0.0'
- .gitattributes
- .gitignore
- /docs/**/*
- /CHANGELOG.md
- /CONTRIBUTING.md
- /README.md
- /LICENSE.txt
- /CODE_OF_CONDUCT.md
stages: stages:
- stage: Build - stage: Build
displayName: Build PowerShell Package displayName: Build PSDesiredStateConfiguration module
pool:
name: 1ES
demands:
- ImageOverride -equals PSMMS2019-Secure
jobs: jobs:
- job: BuildPkg - job: BuildPkg
displayName: Build Package displayName: Build Package
pool: variables:
name: 'Package ES CodeHub Lab E' - group: ESRP
steps: steps:
- powershell: | - powershell: |
$powerShellPath = Join-Path -Path $env:AGENT_TEMPDIRECTORY -ChildPath 'powershell' $powerShellPath = Join-Path -Path $env:AGENT_TEMPDIRECTORY -ChildPath 'powershell'
Invoke-WebRequest -Uri https://raw.githubusercontent.com/PowerShell/PowerShell/master/tools/install-powershell.ps1 -outfile ./install-powershell.ps1 Invoke-WebRequest -Uri https://raw.githubusercontent.com/PowerShell/PowerShell/master/tools/install-powershell.ps1 -outfile ./install-powershell.ps1
./install-powershell.ps1 -Destination $powerShellPath ./install-powershell.ps1 -Preview -Destination $powerShellPath
$vstsCommandString = "vso[task.setvariable variable=PATH]$powerShellPath;$env:PATH" $vstsCommandString = "vso[task.setvariable variable=PATH]$powerShellPath;$env:PATH"
Write-Host "sending " + $vstsCommandString Write-Host "sending " + $vstsCommandString
Write-Host "##$vstsCommandString" Write-Host "##$vstsCommandString"
displayName: Install PowerShell Core displayName: Install PowerShell Core
- task: PkgESSetupBuild@10 - task: NuGetToolInstaller@1
displayName: 'Package ES - Setup Build' displayName: 'Install NuGet'
inputs: inputs:
productName: PSDesiredStateConfiguration checkLatest: false
version: 5.9.1
- template: templates/shouldsign.yml - task: UseDotNet@2
displayName: 'Install .NET Core SDK'
- powershell: |
Get-ChildItem -Path env:
displayName: Capture environment
condition: succeededOrFailed()
- template: templates/ci-build.yml
- powershell: |
Write-Verbose "BUILD_OUTPUT_PATH- $env:BUILD_OUTPUT_PATH" -Verbose
Write-Verbose "SIGNED_OUTPUT_PATH- $env:SIGNED_OUTPUT_PATH" -Verbose
Copy-Item $env:BUILD_OUTPUT_PATH $env:SIGNED_OUTPUT_PATH -Recurse -Force
displayName: Copy unsigned files first
- task: PkgESCodeSign@10
displayName: 'CodeSign tools/releaseBuild/signing.xml'
env:
SYSTEM_ACCESSTOKEN: $(System.AccessToken)
inputs: inputs:
signConfigXml: tools/releaseBuild/signing.xml packageType: sdk
inPathRoot: '$(BUILD_OUTPUT_PATH)' useGlobalJson: true
outPathRoot: '$(SIGNED_OUTPUT_PATH)' includePreviewVersions: true
condition: and(succeeded(), eq(variables['SHOULD_SIGN'], 'true')) workingDirectory: '$(Build.SourcesDirectory)'
- task: PowerShell@1
displayName: 'Create catalog file'
inputs:
scriptType: inlineScript
inlineScript: |
$signedDir = "$env:SIGNED_OUTPUT_PATH\PSDesiredStateConfiguration"
New-FileCatalog -CatalogFilePath "$env:SIGNED_OUTPUT_PATH\PSDesiredStateConfiguration\PSDesiredStateConfiguration.cat" -Path "$signedDir"
- task: PkgESCodeSign@10
displayName: 'CodeSign tools/releaseBuild/FileCatalogSigning.xml'
env:
SYSTEM_ACCESSTOKEN: $(System.AccessToken)
inputs:
signConfigXml: tools/releaseBuild/FileCatalogSigning.xml
inPathRoot: '$(SIGNED_OUTPUT_PATH)'
outPathRoot: '$(SIGNED_OUTPUT_PATH)'
condition: and(succeeded(), eq(variables['SHOULD_SIGN'], 'true'))
- task: ms.vss-governance-buildtask.governance-build-task-component-detection.ComponentGovernanceComponentDetection@0
displayName: 'Component Detection'
- task: AntiMalware@3
inputs:
InputType: 'Basic'
ScanType: 'CustomScan'
FileDirPath: '$(SIGNED_OUTPUT_PATH)'
EnableServices: false
SupportLogOnError: false
TreatSignatureUpdateFailureAs: 'Warning'
SignatureFreshness: 'UpToDate'
TreatStaleSignatureAs: 'Error'
- task: PoliCheck@1
condition: succeededOrFailed()
inputs:
targetType: F
optionsFC: 0
optionsXS: 0
optionsPE: '1|2|3|4'
optionsHMENABLE: 0
optionsFTPATH: '$(Build.SourcesDirectory)\tools\terms\FileTypeSet.xml'
- task: CredScan@2
condition: succeededOrFailed()
# Publish results as artifacts
- task: PublishSecurityAnalysisLogs@3
condition: succeededOrFailed()
inputs:
ArtifactName: 'CodeAnalysisLogs'
ArtifactType: 'Container'
# Publish to TSA server
# - task: TSAUpload@1
# condition: succeededOrFailed()
# continueOnError: true
# inputs:
# tsaVersion: 'TsaV2'
# codebase: 'Existing'
# tsaEnvironment: 'PROD'
# codeBaseName: 'PSDesiredStateConfiguration_20190828'
# uploadAPIScan: false
# uploadBinSkim: false
# uploadCredScan: true
# uploadFortifySCA: false
# uploadFxCop: false
# uploadModernCop: false
# uploadPoliCheck: true
# uploadPREfast: false
# uploadRoslyn: false
# uploadTSLint: false
# uploadAsync: true
- pwsh: | - pwsh: |
$(Build.SourcesDirectory)/build.ps1 -Publish -Signed Get-ChildItem -Path env:
displayName: Publish displayName: Capture environment for build
timeoutInMinutes: 10 condition: succeededOrFailed()
- 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
- 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
displayName: Install PSPackageProject and dependencies
- pwsh: |
$modulePath = Join-Path -Path $env:AGENT_TEMPDIRECTORY -ChildPath 'TempModules'
$env:PSModulePath = $modulePath + [System.IO.Path]::PathSeparator + $env:PSModulePath
$modPath = Join-Path -Path $modulePath -ChildPath PSPackageProject
Write-Verbose -Verbose "Importing PSPackageProject from: $modPath"
Import-Module -Name $modPath -Force
#
$(Build.SourcesDirectory)/build.ps1 -Build -Clean
displayName: Execute build
- 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,Microsoft.PowerShell.DscSubsystem.dll'
- template: Sbom.yml@ComplianceRepo
parameters:
BuildDropPath: "$(Build.SourcesDirectory)/signed/PSDesiredStateConfiguration/PSDesiredStateConfiguration"
Build_Repository_Uri: 'https://github.com/PowerShell/PSDesiredStateConfiguration'
PackageName: $(PackageName)
PackageVersion: $(PackageVersion)
- 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:
name: 1ES
demands:
- ImageOverride -equals MMS2019
steps:
- checkout: self
- checkout: ComplianceRepo
- download: current
artifact: SignedBuild
- pwsh: |
Get-ChildItem -Path "$(Pipeline.Workspace)\SignedBuild" -Recurse
displayName: Capture downloaded artifacts
- template: script-module-compliance.yml@ComplianceRepo
parameters:
# component-governance
sourceScanPath: '$(Pipeline.Workspace)\SignedBuild'
# credscan
suppressionsFile: ''
# TermCheck
optionsRulesDBPath: ''
optionsFTPath: ''
# tsa-upload
codeBaseName: 'PSDesiredStateConfiguration_20210423'
# selections
APIScan: false # set to false when not using Windows APIs.
- stage: Deploy
displayName: Publish to PowerShell gallery
dependsOn:
- Build
- Compliance
jobs:
- deployment: DeployPowerShellGallery
displayName: Deploy nupkg to PowerShell Gallery
pool:
name: 1ES
demands:
- ImageOverride -equals MMS2019
environment: 'PSDesiredStateConfiguration-ReleaseApproval'
strategy:
runOnce:
deploy:
steps:
- download: current
artifact: 'nupkg'
- task: NuGetToolInstaller@1
displayName: 'Install NuGet'
inputs:
checkLatest: false
version: 5.9.1
- task: NuGetCommand@2
displayName: 'NuGet push'
inputs:
command: push
packagesToPush: '$(Pipeline.Workspace)\nupkg\PSDesiredStateConfiguration.*.nupkg'
nuGetFeedType: external
publishFeedCredentials: 'PowerShellGallery'
-19
View File
@@ -1,19 +0,0 @@
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
@@ -1,16 +0,0 @@
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
+51 -89
View File
@@ -10,103 +10,65 @@ jobs:
vmImage: ${{ parameters.imageName }} vmImage: ${{ parameters.imageName }}
displayName: ${{ parameters.displayName }} displayName: ${{ parameters.displayName }}
steps: steps:
- ${{ parameters.powershellExecutable }}: | - powershell: |
if($IsMacOs) $powerShellPath = Join-Path -Path $env:AGENT_TEMPDIRECTORY -ChildPath 'powershell'
{
brew update
brew cask install powershell-preview
sudo ln -s -f /usr/local/microsoft/powershell/7-preview/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 Invoke-WebRequest -Uri https://raw.githubusercontent.com/PowerShell/PowerShell/master/tools/install-powershell.ps1 -outfile ./install-powershell.ps1
./install-powershell.ps1 -AddToPath -Preview -Destination C:\powershell-preview ./install-powershell.ps1 -Preview -Destination $powerShellPath
$vstsCommandString = "vso[task.setvariable variable=PATH]C:\powershell-preview;$env:PATH" $newPath = $powerShellPath + [System.IO.Path]::PathSeparator + $env:PATH
$vstsCommandString = "vso[task.setvariable variable=PATH]$newPath"
Write-Host "sending " + $vstsCommandString Write-Host "sending " + $vstsCommandString
Write-Host "##$vstsCommandString" Write-Host "##$vstsCommandString"
displayName: Install PowerShell Core
- 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
} }
displayName: Setup PowerShell preview 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 }}: | - pwsh: |
$PSVersionTable $modulePath = Join-Path -Path $env:AGENT_TEMPDIRECTORY -ChildPath 'TempModules'
$vstsCommandString = "vso[task.setvariable variable=PSHOME]$pshome" 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 "sending " + $vstsCommandString
Write-Host "##$vstsCommandString" Write-Host "##$vstsCommandString"
displayName: Capture PowerShellVersion displayName: Install PSPackageProject and dependencies
- ${{ parameters.powershellExecutable }}: | - download: current
dir env:PATH artifact: Build
displayName: Capture Path
- ${{ parameters.powershellExecutable }}: | - pwsh: |
Get-PSRepository "PSVersionTable is"| Write-Verbose -Verbose
displayName: Capture PSRepository $PSVersionTable | Out-String | Write-Verbose -Verbose
#
- ${{ parameters.powershellExecutable }}: | $targetModuleLocation = Join-Path -Path $(modulePath) -ChildPath 'PSDesiredStateConfiguration'
Install-Module -Name "platyPS","Pester" -Force Move-Item -Path "$(Pipeline.Workspace)\Build" -Destination $targetModuleLocation -Force
displayName: Install dependencies #
timeoutInMinutes: 10 $env:PSModulePath = '$(modulePath)' + [System.IO.Path]::PathSeparator + $env:PSModulePath
"PSModulePath is"| Write-Verbose -Verbose
- ${{ parameters.powershellExecutable }}: | $env:PSModulePath | Write-Verbose -Verbose
Install-Module -Name "PSScriptAnalyzer" -RequiredVersion 1.18.0 -Force #
displayName: Install dependencies Get-Module -ListAvailable -Name PSDesiredStateConfiguration | select Name,Version,PreRelease,Path | Write-Verbose -Verbose
timeoutInMinutes: 10 #
"Listing contents of $targetModuleLocation"| Write-Verbose -Verbose
- ${{ parameters.powershellExecutable }}: | Get-ChildItem -Recurse -Path $targetModuleLocation | Write-Verbose -Verbose
Install-Module -Name PSPackageProject -Force #
displayName: Install PSPackageProject module
- 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 Invoke-PSPackageProjectTest -Type Functional
displayName: Execute functional tests - InvokeDscResource Disabled displayName: Execute functional tests
errorActionPreference: continue 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
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
@@ -1,31 +0,0 @@
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
@@ -1,17 +0,0 @@
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)
+24
View File
@@ -0,0 +1,24 @@
# v2 Changelog
## [v2.0.7]
### Main changes
- Fixed Invoke-DscResource error when a class-based resource module path contains a space.
- Fixed an issue with array parameters is key-value pairs (#128).
[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
+21
View File
@@ -0,0 +1,21 @@
MIT License
Copyright (c) 2022 PowerShell Team
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
+62 -24
View File
@@ -1,31 +1,69 @@
# How to Create PSDesiredStateConfiguration NuGet package for PoweShell Core # PSDesiredStateConfiguration module
- 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" />
- Other files under PSDesiredStateConfiguration module doesnt need to be signed, you can modify them directly. > [!NOTE]
> The next generation of this platform is in development. Please submit your feedback on [DSC v3](https://github.com/powershell/dsc).
- Change the version in nuget spec file. **PSDesiredStateConfiguration** (DSC) is the PowerShell module that enables writing configuration as code.
- Check-in these changes in DesiredStateConfiguration repository. The DSC platform was originally built on top of WMI for Windows. Starting in PowerShell 7.1 and working
with internal partner teams
[Azure Guest Configuration](https://docs.microsoft.com/azure/governance/policy/concepts/guest-configuration)
and [Automanage](https://azure.microsoft.com/services/azure-automanage), we started making
DSC cross-platform by enabling `Invoke-DSCResource` to directly use resources without going through
the Local Configuration Manager (LCM).
- Create a NuGet package by running following command, it will generate NuGet package (PSDesiredStateConfiguration.6.2.0.nupkg). Get it published by PowerShell team. Our initial cross-platform work to enable partner teams:
nuget pack .\psdesiredstateconfiguration.nuspec
# Modify PowerShell code to pick up new version of NuGet package. - Separated out the DSC parts in the PowerShell engine and moved them as a subsystem into the
- Sync PowerShell/PowerShell repository and change NuGet package version in following files PSDesiredStateConfiguration module
src/powershell-unix/powershell-unix.csproj - Remove PSDesiredStateConfiguration module from the PowerShell 7 package. This allows the
src/powershell-win-core/powershell-win-core.csproj PSDesiredStateConfiguration module to be developed independently of PowerShell and users can mix
and match versions of PowerShell and PSDesiredStateConfiguration for their environment.
- This is now available on the PowerShell Gallery: [PSDesiredStateConfiguration 2.x](https://www.powershellgallery.com/packages/PSDesiredStateConfiguration)
- Removing the dependency on MOF: Initially, only support DSC Resources written as PowerShell
classes. This includes tooling to convert existing script based DSC Resources to be wrapped as
PowerShell classes.
```sh ## Documentation and resources
<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 The documentation for **PSDesiredStateConfiguration** 3.0.0-beta1 is a work-in-progress. We invite the
community to review the documentation and assist us as we work on new documentation during the platform
development.
For more information about DSC v3, see [PowerShell Desired State Configuration Overview](https://docs.microsoft.com/powershell/dsc/overview?view=dsc-3.0)
To download the latest release from the PowerShell Gallery, see [PSDesiredStateConfiguration 3.0.0-beta1](https://www.powershellgallery.com/packages/PSDesiredStateConfiguration/3.0.0-beta1)
## Community Feedback
As we continue this journey to make DSC a cross-platform technology, we invite the community to
share your ideas and open
[issues](https://github.com/PowerShell/PSDesiredStateConfiguration/issues). During the PowerShell
7.3 timeframe, we remain focused on enabling partner teams and will not be accepting public pull
requests.
## Build
### 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
### Build Process
- Run `build.ps1 -Build -Clean`
- Compiled module will be in `./out/PSDesiredStateConfiguration`
## 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.
## 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.
## Code of Conduct
Please see our [Code of Conduct](.github/CODE_OF_CONDUCT.md) before participating in this project.
## Security Policy
For any security issues, please see our [Security Policy](.github/SECURITY.md).
-1
View File
@@ -1 +0,0 @@
{"ExperimentalFeatures":["PSCommandNotFoundSuggestion","PSForEachObjectParallel","PSImplicitRemotingBatching","Microsoft.PowerShell.Utility.PSDebugRunspaceWithBreakpoints","PSDesiredStateConfiguration.InvokeDscResource"]}
-19
View File
@@ -1,19 +0,0 @@
# Starter pipeline
# Start with a minimal pipeline that you can customize to build and deploy your code.
# Add steps that build, run tests, deploy, and more:
# https://aka.ms/yaml
trigger:
- master
pool:
vmImage: 'ubuntu-latest'
steps:
- script: echo Hello, world!
displayName: 'Run a one-line script'
- script: |
echo Add other tasks to build, test, and deploy your project.
echo See https://aka.ms/yaml
displayName: 'Run a multi-line script'
+23 -17
View File
@@ -13,36 +13,42 @@ Implement build and packaging of the package and place the output $OutDirectory/
function DoBuild function DoBuild
{ {
Write-Verbose -Verbose -Message "Starting 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}'" Write-Verbose -Verbose -Message "Copying module files to '${OutDirectory}/${ModuleName}'"
# copy psm1 and psd1 files # copy psm1 and psd1 files
copy-item "${SrcPath}/*" "${OutDirectory}/${ModuleName}" -Recurse copy-item "${SrcPath}/*" "${OutDirectory}/${ModuleName}" -Recurse
#
# copy help $smaPackageVersionToUse = "7.2.0-preview.6" # 7.2.0-preview.6 - is the first SMA version that has DSC subsystem changes
Write-Verbose -Verbose -Message "Copying help files to '${OutDirectory}/${ModuleName}'" $subsystemCodePath = Resolve-Path "${SrcPath}/../DscSubsystem"
copy-item -Recurse "${HelpPath}/${Culture}" "${OutDirectory}/${ModuleName}" Write-Verbose -Verbose -Message "Subsystem code path ${subsystemCodePath}"
if ( Test-Path "${SrcPath}/code" ) { if ( Test-Path $subsystemCodePath )
{
Write-Verbose -Verbose -Message "Building assembly and copying to '${OutDirectory}/${ModuleName}'" Write-Verbose -Verbose -Message "Building assembly and copying to '${OutDirectory}/${ModuleName}'"
# build code and place it in the staging location
try { Push-Location $subsystemCodePath
Push-Location "${SrcPath}/code"
$result = dotnet publish $PackageReferencesPath = Join-Path $subsystemCodePath "PackageReferences"
copy-item "bin/Debug/netstandard2.0/publish/${ModuleName}.dll" "${OutDirectory}/${ModuleName}"
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}"
} }
catch { else
$result | ForEach-Object { Write-Warning $_ } {
Write-Error "dotnet build failed" Write-Error -Message "dotnet build failed - $subsystemBinPath not found"
} }
finally {
Pop-Location Pop-Location
} }
}
else { else {
Write-Verbose -Verbose -Message "No code to build in '${SrcPath}/code'" Write-Error -Message "No code to build in '$subsystemCodePath'"
} }
## Add build and packaging here
Write-Verbose -Verbose -Message "Ending DoBuild" Write-Verbose -Verbose -Message "Ending DoBuild"
} }
+5
View File
@@ -0,0 +1,5 @@
{
"sdk": {
"version": "6.0.100-preview.4.21255.9"
}
}
+10
View File
@@ -0,0 +1,10 @@
<?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
@@ -1,17 +0,0 @@
<?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
@@ -0,0 +1,89 @@
// 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
@@ -0,0 +1,68 @@
// 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
@@ -0,0 +1,72 @@
// 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
@@ -0,0 +1,20 @@
<!-- 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.
@@ -0,0 +1,232 @@
[
{
"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"
}
]
@@ -0,0 +1,218 @@
{
"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"
}
]
}
@@ -0,0 +1,455 @@
[
{
"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' RootModule = 'PSDesiredStateConfiguration.psm1'
# Version number of this module. # Version number of this module.
moduleVersion = '2.0.5' moduleVersion = '3.0.0'
# Supported PSEditions # Supported PSEditions
CompatiblePSEditions = @('Core') CompatiblePSEditions = @('Core')
@@ -30,7 +30,7 @@ Copyright = '(c) Microsoft Corporation. All rights reserved.'
Description = 'PowerShell Desired State Configuration' Description = 'PowerShell Desired State Configuration'
# Minimum version of the Windows PowerShell engine required by this module # Minimum version of the Windows PowerShell engine required by this module
PowerShellVersion = '6.1' PowerShellVersion = '7.2'
# Name of the Windows PowerShell host required by this module # Name of the Windows PowerShell host required by this module
# PowerShellHostName = '' # PowerShellHostName = ''
@@ -48,7 +48,7 @@ PowerShellVersion = '6.1'
# ProcessorArchitecture = '' # ProcessorArchitecture = ''
# Modules that must be imported into the global environment prior to importing this module # 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 # Assemblies that must be loaded prior to importing this module
# RequiredAssemblies = @() # RequiredAssemblies = @()
@@ -63,7 +63,7 @@ PowerShellVersion = '6.1'
# FormatsToProcess = @() # FormatsToProcess = @()
# Modules to import as nested modules of the module specified in RootModule/ModuleToProcess # Modules to import as nested modules of the module specified in RootModule/ModuleToProcess
# NestedModules = @() NestedModules = @('Microsoft.PowerShell.DscSubsystem.dll')
# 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. # 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 = @( FunctionsToExport = @(
@@ -71,6 +71,7 @@ FunctionsToExport = @(
'New-DscChecksum' 'New-DscChecksum'
'Get-DscResource' 'Get-DscResource'
'Invoke-DscResource' 'Invoke-DscResource'
'ConvertTo-DscJsonSchema'
) )
@@ -100,13 +101,13 @@ HelpInfoURI = 'https://go.microsoft.com/fwlink/?linkid=2113535'
PrivateData = @{ PrivateData = @{
PSData = @{ PSData = @{
ExperimentalFeatures = @( Prerelease = 'beta1'
@{ Tags = @('PSDesiredStateConfiguration',
Name = 'PSDesiredStateConfiguration.InvokeDscResource' 'PSEdition_Core',
Description = "Enables the Invoke-DscResource cmdlet and related features." '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. 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. 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. UnsupportedResourceImplementation = The resource '{0}' implemented as '{1}' is not supported by Invoke-DscResource.
NoValidConfigFileFound = No valid config files (mof,zip) were found. NoValidConfigFileFound = No valid config files (json,zip) were found.
InputFileNotExist=File {0} doesn't exist. InputFileNotExist=File {0} doesn't exist.
FileReadError=Error Reading file {0}. FileReadError=Error Reading file {0}.
MatchingFileNotFound=No matching file found. MatchingFileNotFound=No matching file found.
@@ -47,7 +47,7 @@ data LocalizedData
GetDscResourceInputName=The Get-DscResource input '{0}' parameter value is '{1}'. GetDscResourceInputName=The Get-DscResource input '{0}' parameter value is '{1}'.
ResourceNotMatched=Skipping resource '{0}' as it does not match the requested name. ResourceNotMatched=Skipping resource '{0}' as it does not match the requested name.
InitializingClassCache=Initializing class cache InitializingClassCache=Initializing class cache
LoadingDefaultCimKeywords=Loading default CIM keywords LoadingDefaultKeywords=Loading default keywords
GettingModuleList=Getting module list GettingModuleList=Getting module list
CreatingResourceList=Creating resource list CreatingResourceList=Creating resource list
CreatingResource=Creating resource '{0}'. CreatingResource=Creating resource '{0}'.
@@ -66,18 +66,17 @@ data LocalizedData
ImportDscResourceWarningForInbuiltResource=The configuration '{0}' is loading one or more built-in resources without explicitly importing associated modules. Add Import-DscResource -ModuleName 'PSDesiredStateConfiguration' to your configuration to avoid this message. ImportDscResourceWarningForInbuiltResource=The configuration '{0}' is loading one or more built-in resources without explicitly importing associated modules. Add Import-DscResource -ModuleName 'PSDesiredStateConfiguration' to your configuration to avoid this message.
PasswordTooLong=An error occurred during encryption of a password in node '{0}'. Most likely the password entered is too long to be encrypted using the selected certificate. Please either use a shorter password or select a certificate with a larger key. PasswordTooLong=An error occurred during encryption of a password in node '{0}'. Most likely the password entered is too long to be encrypted using the selected certificate. Please either use a shorter password or select a certificate with a larger key.
PsDscRunAsCredentialNotSupport=The 'PsDscRunAsCredential' property is not currently support when using Invoke-DscResource. PsDscRunAsCredentialNotSupport=The 'PsDscRunAsCredential' property is not currently support when using Invoke-DscResource.
EmbeddedResourcesNotSupported=Embedded resources are not support on Linux or macOS. Please see https://aka.ms/PSCoreDSC for more details.
'@ '@
} }
Set-StrictMode -Off 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. # 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 Import-Module $PSScriptRoot/helpers/DscResourceInfo.psm1
# Set DSC HOME environment variable. # Set DSC HOME environment variable.
$env:DSC_HOME = "$PSScriptRoot/Configuration" $env:DSC_HOME = Join-Path $PSScriptRoot "Configuration"
$script:V1MetaConfigPropertyList = @('ConfigurationModeFrequencyMins', 'RebootNodeIfNeeded', 'ConfigurationMode', 'ActionAfterReboot', 'RefreshMode', 'CertificateID', 'ConfigurationID', 'DownloadManagerName', 'DownloadManagerCustomData', 'RefreshFrequencyMins', 'AllowModuleOverwrite', 'DebugMode', 'Credential') $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') $script:DirectAccessMetaConfigPropertyList = @('AllowModuleOverWrite', 'CertificateID', 'ConfigurationDownloadManagers', 'ResourceModuleManagers', 'DebugMode', 'RebootNodeIfNeeded', 'RefreshMode', 'ConfigurationAgent')
@@ -308,7 +307,7 @@ function ConvertTo-MOFInstance
elseif ($Value -is [PSCredential] ) elseif ($Value -is [PSCredential] )
{ {
# If the input object is a PSCredential, turn it into an MSFT_Credential with an encrypted password. # If the input object is a PSCredential, turn it into an MSFT_Credential with an encrypted password.
$clearText = [Microsoft.PowerShell.DesiredStateConfiguration.Internal.DscClassCache]::GetStringFromSecureString($Value.Password) $clearText = [Microsoft.PowerShell.DesiredStateConfiguration.Internal.CrossPlatform.DscClassCache]::GetStringFromSecureString($Value.Password)
$newValue = @{ $newValue = @{
UserName = $Value.UserName UserName = $Value.UserName
Password = $clearText Password = $clearText
@@ -510,7 +509,7 @@ function ConvertTo-MOFInstance
$targetTypeName = $PropertyTypes[$p.Name].TypeConstraint $targetTypeName = $PropertyTypes[$p.Name].TypeConstraint
# see if the target type is an array # see if the target type is an array
$asArray = $p.Name -eq 'DependsOn' -or $targetTypeName -match 'Array' $asArray = $p.Name -eq 'DependsOn' -or $targetTypeName -match 'Array' -or ((-not [string]::IsNullOrEmpty($targetTypeName)) -and $targetTypeName.EndsWith('[]'))
# Convert the CIM typename to the appropriate .NET type to use # Convert the CIM typename to the appropriate .NET type to use
# to convert the input object into an appropriately encoded string # to convert the input object into an appropriately encoded string
@@ -671,15 +670,12 @@ function ConvertTo-MOFInstance
} }
} }
else else
{
if ($targetTypeName -notmatch 'Array' -or $p.Value.Count)
{ {
$p.Name + ' = ' + (stringify -value $p.Value -asArray $asArray -targetType $targetType ) + ";`n" $p.Name + ' = ' + (stringify -value $p.Value -asArray $asArray -targetType $targetType ) + ";`n"
} }
} }
} }
} }
}
else else
{ {
if ($Type -notmatch 'OMI_ConfigurationDocument') if ($Type -notmatch 'OMI_ConfigurationDocument')
@@ -702,33 +698,6 @@ function ConvertTo-MOFInstance
$OFS = $oldOFS $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 # Append the completed mof instance text to the overall document
# #
@@ -1794,59 +1763,6 @@ function ValidateUpdate-ConfigurationData
return $true 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 # Configuration keyword implementation
########################################################### ###########################################################
@@ -1905,10 +1821,6 @@ function Configuration
return $moduleInfos return $moduleInfos
} }
if ( $IsMacOS -or $IsLinux ) {
Write-Warning -Message $LocalizedData.EmbeddedResourcesNotSupported
}
try try
{ {
Write-Debug -Message "BEGIN CONFIGURATION '$Name' PROCESSING: OutputPath: '$OutputPath'" Write-Debug -Message "BEGIN CONFIGURATION '$Name' PROCESSING: OutputPath: '$OutputPath'"
@@ -1976,7 +1888,7 @@ function Configuration
# Load the default CIM keyword/function definitions set, populating the function collection # Load the default CIM keyword/function definitions set, populating the function collection
# with the default functions. # with the default functions.
[Microsoft.PowerShell.DesiredStateConfiguration.Internal.DscClassCache]::LoadDefaultCimKeywords($functionsToDefine) [Microsoft.PowerShell.DesiredStateConfiguration.Internal.CrossPlatform.DscClassCache]::LoadDefaultCimKeywords($functionsToDefine)
# Set up the rest of the configuration runtime state. # Set up the rest of the configuration runtime state.
Initialize-ConfigurationRuntimeState $Name Initialize-ConfigurationRuntimeState $Name
@@ -2067,25 +1979,8 @@ function Configuration
foreach ($mod in $modulesInfo) { foreach ($mod in $modulesInfo) {
$null = ImportClassResourcesFromModule -Module $mod -Resources $res -functionsToDefine $functionsToDefine $null = ImportClassResourcesFromModule -Module $mod -Resources $res -functionsToDefine $functionsToDefine
$dscResourcesPath = Join-Path -Path $mod.ModuleBase -ChildPath 'DscResources'
if(Test-Path $dscResourcesPath) if ($moduleInfos.Count -eq 1)
{
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) $modules.Add($moduleInfos)
} }
@@ -2321,7 +2216,7 @@ function Configuration
{ {
Write-Debug -Message " CONFIGURATION $Name : DOING TOP-LEVEL CLEAN UP" Write-Debug -Message " CONFIGURATION $Name : DOING TOP-LEVEL CLEAN UP"
[System.Management.Automation.Language.DynamicKeyword]::Reset() [System.Management.Automation.Language.DynamicKeyword]::Reset()
[Microsoft.PowerShell.DesiredStateConfiguration.Internal.DscClassCache]::ClearCache() [Microsoft.PowerShell.DesiredStateConfiguration.Internal.CrossPlatform.DscClassCache]::ClearCache()
Initialize-ConfigurationRuntimeState Initialize-ConfigurationRuntimeState
} }
@@ -2374,7 +2269,7 @@ function Update-ModuleVersion
$moduleVersionstring = "ModuleVersion = " $moduleVersionstring = "ModuleVersion = "
$moduleVersionstring += "`"$moduleVersionValue`"" + ";" $moduleVersionstring += "`"$moduleVersionValue`"" + ";"
$NodeInstanceAliases[$alias] = $first + $moduleVersionstring + "`r`n};" $NodeInstanceAliases[$alias] = $first + $moduleVersionstring + "`n};"
} }
} }
} }
@@ -2410,14 +2305,14 @@ function Update-DependsOn
$needAdd = $true $needAdd = $true
$first = $instanceText.Substring(0, $curlyPosition) $first = $instanceText.Substring(0, $curlyPosition)
$dependsOn = "DependsOn = {`r`n" $dependsOn = "DependsOn = {`n"
$len = @($NodeResources[$resourceId]).Length $len = @($NodeResources[$resourceId]).Length
$dependsOn += foreach ($resourceId in $NodeResources[$resourceId]) $dependsOn += foreach ($resourceId in $NodeResources[$resourceId])
{ {
' ' + "`"$($resourceId -replace '\\', '\\' -replace '"', '\"')`"" + ' ' + "`"$($resourceId -replace '\\', '\\' -replace '"', '\"')`"" +
$(if (--$len -gt 0) $(if (--$len -gt 0)
{ {
",`r`n" ",`n"
} }
else else
{ {
@@ -2431,7 +2326,7 @@ function Update-DependsOn
if($needAdd) if($needAdd)
{ {
$NodeInstanceAliases[$alias] = $first + $dependsOn + "`r`n};" $NodeInstanceAliases[$alias] = $first + $dependsOn + "`n};"
} }
} }
} }
@@ -2473,12 +2368,12 @@ function Update-ConfigurationDocumentRef
$needAdd = $true $needAdd = $true
$first = $instanceText.Substring(0, $curlyPosition).TrimEnd() $first = $instanceText.Substring(0, $curlyPosition).TrimEnd()
$ConfigurationNameRef = "`r`n ConfigurationName = `"$ConfigurationName`";" $ConfigurationNameRef = "`n ConfigurationName = `"$ConfigurationName`";"
} }
if($needAdd) if($needAdd)
{ {
$NodeInstanceAliases[$alias] = $first + $ConfigurationNameRef + "`r`n};" $NodeInstanceAliases[$alias] = $first + $ConfigurationNameRef + "`n};`n"
} }
} }
} }
@@ -2498,66 +2393,16 @@ function ImportClassResourcesFromModule
$functionsToDefine $functionsToDefine
) )
$resourcesFound = [Microsoft.PowerShell.DesiredStateConfiguration.Internal.DscClassCache]::ImportClassResourcesFromModule($Module, $Resources, $functionsToDefine) $Errors = New-Object -TypeName 'System.Collections.ObjectModel.Collection[System.Exception]'
return ,$resourcesFound
}
function ImportCimAndScriptKeywordsFromModule $resourcesFound = [Microsoft.PowerShell.DesiredStateConfiguration.Internal.CrossPlatform.DscClassCache]::ImportClassResourcesFromModule($Module, $Resources, $functionsToDefine, $Errors)
{
param (
[Parameter(Mandatory)]
$Module,
[Parameter(Mandatory)] foreach($ex in $Errors)
$resource,
$functionsToDefine
)
trap
{
continue
}
$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 Write-Error -Exception $ex
if($ex.InnerException)
{
Write-Error -Exception $ex.InnerException
}
} }
$functionsAdded = $functionsToDefine.Count - $oldCount return ,$resourcesFound
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
} }
# #
@@ -2581,7 +2426,7 @@ function Write-MetaConfigFile
) )
# Set up prefix for both the configuration and metaconfiguration documents. # Set up prefix for both the configuration and metaconfiguration documents.
$nodeDoc = "/*`n@TargetNode='$mofNode'`n" + "@GeneratedBy=$([system.environment]::UserName)`n@GenerationDate=$(Get-Date)`n@GenerationHost=$([system.environment]::MachineName)`n*/`n" $nodeDoc = $null
$nodeConfigurationDocument = $null $nodeConfigurationDocument = $null
[int]$nodeDocCount = 0 [int]$nodeDocCount = 0
$resourceManagers = $null $resourceManagers = $null
@@ -2707,18 +2552,15 @@ function Write-MetaConfigFile
Write-Debug -Message " ${ConfigurationName}: Adding missing OMI_ConfigurationDocument element to the document" Write-Debug -Message " ${ConfigurationName}: Adding missing OMI_ConfigurationDocument element to the document"
if($Script:NodesPasswordEncrypted[$mofNode]) 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 Author=`"$([system.environment]::UserName)`";`n GenerationDate=`"$(Get-Date)`";`n GenerationHost=`"$([system.environment]::MachineName)`";`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 ContentType=`"PasswordEncrypted`";`n Name=`"$(Get-PSTopConfigurationName)`";`n};"
} }
else else
{ {
$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};" $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};"
} }
} }
} }
# Fix up newlines to be CRLF
$nodeDoc = $nodeDoc -replace "`n", "`r`n"
# todo: meta configuration might not be verifiable currently # todo: meta configuration might not be verifiable currently
$errMsg = Test-MofInstanceText $nodeDoc $errMsg = Test-MofInstanceText $nodeDoc
if($errMsg) if($errMsg)
@@ -2813,7 +2655,7 @@ function Write-NodeMOFFile
) )
# Set up prefix for both the configuration and metaconfiguration documents. # Set up prefix for both the configuration and metaconfiguration documents.
$nodeDoc = "/*`n@TargetNode='$mofNode'`n" + "@GeneratedBy=$([system.environment]::UserName)`n@GenerationDate=$(Get-Date)`n@GenerationHost=$([system.environment]::MachineName)`n*/`n" $nodeDoc = $null
$nodeMetaDoc = $nodeDoc $nodeMetaDoc = $nodeDoc
$nodeConfigurationDocument = $null $nodeConfigurationDocument = $null
[int]$metaDocCount = 0 [int]$metaDocCount = 0
@@ -2871,11 +2713,11 @@ function Write-NodeMOFFile
Write-Debug -Message " ${ConfigurationName}: Adding missing OMI_ConfigurationDocument element to the document" Write-Debug -Message " ${ConfigurationName}: Adding missing OMI_ConfigurationDocument element to the document"
if($Script:NodesPasswordEncrypted[$mofNode]) 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 Author=`"$([system.environment]::UserName)`";`n GenerationDate=`"$(Get-Date)`";`n GenerationHost=`"$([system.environment]::MachineName)`";`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 ContentType=`"PasswordEncrypted`";`n Name=`"$(Get-PSTopConfigurationName)`";`n};"
} }
else else
{ {
$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};" $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};"
} }
} }
} }
@@ -2894,72 +2736,26 @@ function Write-NodeMOFFile
{ {
if($nodeDoc.Contains("PsDscRunAsCredential")) if($nodeDoc.Contains("PsDscRunAsCredential"))
{ {
$nodeDoc += "`ninstance of OMI_ConfigurationDocument`n $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};"
{`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 else
{ {
$nodeDoc += "`ninstance of OMI_ConfigurationDocument`n $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};"
{`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 else
{ {
if($nodeDoc.Contains("PsDscRunAsCredential")) if($nodeDoc.Contains("PsDscRunAsCredential"))
{ {
$nodeDoc += "`ninstance of OMI_ConfigurationDocument`n $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};"
{`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 else
{ {
$nodeDoc += "`ninstance of OMI_ConfigurationDocument`n $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};"
{`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) if($nodeDocCount -gt 0)
{ {
@@ -2973,7 +2769,6 @@ function Write-NodeMOFFile
if($nodeMetaDoc -match 'MSFT_DSCMetaConfiguration' -and $Script:PSConfigurationErrors -eq 0) if($nodeMetaDoc -match 'MSFT_DSCMetaConfiguration' -and $Script:PSConfigurationErrors -eq 0)
{ {
$nodeMetaDoc = $nodeMetaDoc -replace "`n", "`r`n"
$nodeMetaDoc > $nodeMetaOutfile $nodeMetaDoc > $nodeMetaOutfile
Get-ChildItem $nodeMetaOutfile Get-ChildItem $nodeMetaOutfile
} }
@@ -3417,7 +3212,7 @@ function Test-MofInstanceText
{ {
try try
{ {
[Microsoft.PowerShell.DesiredStateConfiguration.Internal.DscClassCache]::ValidateInstanceText($instanceText) [Microsoft.PowerShell.DesiredStateConfiguration.Internal.CrossPlatform.DscClassCache]::ValidateInstanceText($instanceText)
} }
catch [System.Management.Automation.MethodInvocationException] catch [System.Management.Automation.MethodInvocationException]
{ {
@@ -3660,7 +3455,7 @@ function New-DscChecksum
# Retrieve all valid configuration files at the specified $Path # Retrieve all valid configuration files at the specified $Path
$allConfigFiles = $Path | ForEach-Object -Process { $allConfigFiles = $Path | ForEach-Object -Process {
(Get-ChildItem -Path $_ -Recurse | Where-Object -FilterScript { (Get-ChildItem -Path $_ -Recurse | Where-Object -FilterScript {
$_.Extension -eq '.mof' -or $_.Extension -eq '.zip' $_.Extension -eq '.json' -or $_.Extension -eq '.zip'
} }
) )
} }
@@ -3669,7 +3464,6 @@ function New-DscChecksum
if ($allConfigFiles.Length -eq 0) if ($allConfigFiles.Length -eq 0)
{ {
Write-Log -Message $LocalizedData.NoValidConfigFileFound Write-Log -Message $LocalizedData.NoValidConfigFileFound
return return
} }
@@ -3684,7 +3478,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 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) Write-Log -Message ($LocalizedData.CheckSumFileExists -f $fileOutpath)
continue continue
@@ -3842,7 +3636,7 @@ function ReadEnvironmentFile
function Get-DSCResourceModules function Get-DSCResourceModules
{ {
$listPSModuleFolders = $env:PSModulePath.Split(":") $listPSModuleFolders = $env:PSModulePath.Split([IO.Path]::PathSeparator)
$dscModuleFolderList = [System.Collections.Generic.HashSet[System.String]]::new() $dscModuleFolderList = [System.Collections.Generic.HashSet[System.String]]::new()
foreach ($folder in $listPSModuleFolders) foreach ($folder in $listPSModuleFolders)
@@ -3855,15 +3649,6 @@ function Get-DSCResourceModules
foreach($moduleFolder in Get-ChildItem $folder -Directory) foreach($moduleFolder in Get-ChildItem $folder -Directory)
{ {
$addModule = $false $addModule = $false
$dscFolders = Get-childitem "$($moduleFolder.FullName)\DscResources","$($moduleFolder.FullName)\*\DscResources" -ErrorAction Ignore
if($null -ne $dscFolders)
{
$addModule = $true
}
if(-not $addModule)
{
foreach($psd1 in Get-ChildItem -Recurse -Filter "$($moduleFolder.Name).psd1" -Path $moduleFolder.fullname -Depth 2) foreach($psd1 in Get-ChildItem -Recurse -Filter "$($moduleFolder.Name).psd1" -Path $moduleFolder.fullname -Depth 2)
{ {
$containsDSCResource = select-string -LiteralPath $psd1 -pattern '^[^#]*\bDscResourcesToExport\b.*' $containsDSCResource = select-string -LiteralPath $psd1 -pattern '^[^#]*\bDscResourcesToExport\b.*'
@@ -3872,7 +3657,6 @@ function Get-DSCResourceModules
$addModule = $true $addModule = $true
} }
} }
}
if($addModule) if($addModule)
{ {
@@ -3884,14 +3668,167 @@ function Get-DSCResourceModules
$dscModuleFolderList $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 # Get-DSCResource
########################################################### ###########################################################
# #
# Gets DSC resources on the machine. Allows to filter on a particular resource. # Gets DSC resources on the machine. Allows to filter on a particular resource.
# It parses all the resources defined in the schema.mof file and also the composite # It parses class-based resources defined in the psm1 module files.
# resources defined or imported from PowerShell modules
# #
function Get-DscResource function Get-DscResource
{ {
@@ -3919,12 +3856,12 @@ function Get-DscResource
{ {
$initialized = $false $initialized = $false
$ModuleString = $null $ModuleString = $null
Write-Progress -Id 1 -Activity $LocalizedData.LoadingDefaultCimKeywords Write-Progress -Id 1 -Activity $LocalizedData.LoadingDefaultKeywords
$keywordErrors = New-Object -TypeName 'System.Collections.ObjectModel.Collection[System.Exception]' $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. # Load the default Inbox providers (keyword) in cache, also allow caching the resources from multiple versions of modules.
[Microsoft.PowerShell.DesiredStateConfiguration.Internal.DscClassCache]::LoadDefaultCimKeywords($keywordErrors, $true) [Microsoft.PowerShell.DesiredStateConfiguration.Internal.CrossPlatform.DscClassCache]::LoadDefaultCimKeywords($keywordErrors, $true)
foreach($ex in $keywordErrors) foreach($ex in $keywordErrors)
{ {
@@ -3971,15 +3908,6 @@ function Get-DscResource
{ {
$null = ImportClassResourcesFromModule -Module $mod -Resources * -functionsToDefine $functionsToDefine $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 = @() $Resources = @()
@@ -4009,28 +3937,20 @@ function Get-DscResource
Write-Progress -Id 3 -Activity $LocalizedData.CreatingResourceList Write-Progress -Id 3 -Activity $LocalizedData.CreatingResourceList
# Get resources for CIM cache # Get resources for CIM cache
$keywords = [Microsoft.PowerShell.DesiredStateConfiguration.Internal.DscClassCache]::GetCachedKeywords() | Where-Object -FilterScript { $keywords = [Microsoft.PowerShell.DesiredStateConfiguration.Internal.CrossPlatform.DscClassCache]::GetKeywordsFromCachedClasses() | Where-Object -FilterScript {
(!$_.IsReservedKeyword) -and ($null -ne $_.ResourceName) -and !(IsHiddenResource $_.ResourceName) -and (![bool]$Module -or ($_.ImplementingModule -like $ModuleString)) (!$_.IsReservedKeyword) -and ($null -ne $_.ResourceName) -and !(IsHiddenResource $_.ResourceName) -and (![bool]$Module -or ($_.ImplementingModule -like $ModuleString))
} }
$dscResourceNames = $keywords.keyword
$Resources += $keywords | $Resources += $keywords |
ForEach-Object -Process { ForEach-Object -Process {
GetResourceFromKeyword -keyword $_ -patterns $patterns -modules $modules GetResourceFromKeyword -keyword $_ -patterns $patterns -modules $modules -dscResourceNames $dscResourceNames
} | } |
Where-Object -FilterScript { Where-Object -FilterScript {
$_ -ne $null $_ -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 # check whether all resources are found
CheckResourceFound $Name $Resources CheckResourceFound $Name $Resources
} }
@@ -4039,7 +3959,7 @@ function Get-DscResource
if ($initialized) if ($initialized)
{ {
[System.Management.Automation.Language.DynamicKeyword]::Reset() [System.Management.Automation.Language.DynamicKeyword]::Reset()
[Microsoft.PowerShell.DesiredStateConfiguration.Internal.DscClassCache]::ClearCache() [Microsoft.PowerShell.DesiredStateConfiguration.Internal.CrossPlatform.DscClassCache]::ClearCache()
$initialized = $false $initialized = $false
} }
@@ -4067,7 +3987,7 @@ function Get-DscResource
if ($initialized) if ($initialized)
{ {
[System.Management.Automation.Language.DynamicKeyword]::Reset() [System.Management.Automation.Language.DynamicKeyword]::Reset()
[Microsoft.PowerShell.DesiredStateConfiguration.Internal.DscClassCache]::ClearCache() [Microsoft.PowerShell.DesiredStateConfiguration.Internal.CrossPlatform.DscClassCache]::ClearCache()
$initialized = $false $initialized = $false
} }
@@ -4088,9 +4008,11 @@ function GetResourceFromKeyword
$patterns, $patterns,
[Parameter(Mandatory)] [Parameter(Mandatory)]
[System.Management.Automation.PSModuleInfo[]] [System.Management.Automation.PSModuleInfo[]]
$modules $modules,
[Parameter(Mandatory)]
[Object[]]
$dscResourceNames
) )
$implementationDetail = 'ScriptBased' $implementationDetail = 'ScriptBased'
# Find whether $name follows the pattern # Find whether $name follows the pattern
@@ -4118,68 +4040,23 @@ function GetResourceFromKeyword
$resource.Name = $keyword.Keyword $resource.Name = $keyword.Keyword
$schemaFiles = [Microsoft.PowerShell.DesiredStateConfiguration.Internal.DscClassCache]::GetFileDefiningClass($keyword.ResourceName) # only supporting class-based resources at this time
if ($schemaFiles.Count)
{
# 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'))
{
if ([ExperimentalFeature]::IsEnabled("PSDesiredStateConfiguration.InvokeDscResource"))
{
$_ | 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
{
$implementationDetail = 'ClassBased' $implementationDetail = 'ClassBased'
$Module = $modules | Where-Object -FilterScript { $Module = $modules | Where-Object -FilterScript {
$_.Name -eq $keyword.ImplementingModule -and $_.Name -eq $keyword.ImplementingModule -and
$_.Version -eq $keyword.ImplementingModuleVersion $_.Version -eq $keyword.ImplementingModuleVersion
} } | Select-Object -First 1
if ($Module -and $Module.ExportedDscResources -contains $keyword.Keyword) if ($Module -and $Module.ExportedDscResources -contains $keyword.Keyword)
{ {
$implementationDetail = 'ClassBased'
$resource.Module = $Module $resource.Module = $Module
$resource.Path = $Module.Path $resource.Path = $Module.Path
$resource.ParentPath = Split-Path -Path $Module.Path $resource.ParentPath = Split-Path -Path $Module.Path
} }
else
{
# a class-based keyword must be in the ExportedDscResources of the module that implements it
return $null
} }
if ([system.string]::IsNullOrEmpty($resource.Path) -eq $false) if ([system.string]::IsNullOrEmpty($resource.Path) -eq $false)
@@ -4199,7 +4076,7 @@ function GetResourceFromKeyword
# add properties # add properties
$keyword.Properties.Values | ForEach-Object -Process { $keyword.Properties.Values | ForEach-Object -Process {
AddDscResourceProperty $resource $_ AddDscResourceProperty $resource $_ $dscResourceNames
} }
# sort properties # sort properties
@@ -4211,10 +4088,8 @@ function GetResourceFromKeyword
Ascending = $true Ascending = $true
} }
$resource.UpdateProperties($updatedProperties) $resource.UpdateProperties($updatedProperties)
if ([ExperimentalFeature]::IsEnabled("PSDesiredStateConfiguration.InvokeDscResource"))
{
$resource | Add-Member -MemberType NoteProperty -Name 'ImplementationDetail' -Value $implementationDetail $resource | Add-Member -MemberType NoteProperty -Name 'ImplementationDetail' -Value $implementationDetail
}
return $resource return $resource
} }
@@ -4291,7 +4166,9 @@ function AddDscResourceProperty
[Microsoft.PowerShell.DesiredStateConfiguration.DscResourceInfo] [Microsoft.PowerShell.DesiredStateConfiguration.DscResourceInfo]
$dscresource, $dscresource,
[Parameter(Mandatory)] [Parameter(Mandatory)]
$property $property,
[Parameter(Mandatory)]
$dscResourceNames
) )
$convertTypeMap = @{ $convertTypeMap = @{
@@ -4315,6 +4192,11 @@ function AddDscResourceProperty
else else
{ {
$Type = [System.Management.Automation.LanguagePrimitives]::ConvertTypeNameToPSTypeName($property.TypeConstraint) $Type = [System.Management.Automation.LanguagePrimitives]::ConvertTypeNameToPSTypeName($property.TypeConstraint)
if ([string]::IsNullOrEmpty($Type)) {
$dscResourceNames | ForEach-Object -Process {
if (($property.TypeConstraint -eq $_) -or ($property.TypeConstraint -eq ($_ + "[]"))) { $Type = "[$($property.TypeConstraint)]" }
}
}
} }
if ($null -ne $property.ValueMap) if ($null -ne $property.ValueMap)
@@ -4325,7 +4207,6 @@ function AddDscResourceProperty
$dscProperty.Values.Add($_) $dscProperty.Values.Add($_)
} }
} }
$dscProperty.PropertyType = $Type $dscProperty.PropertyType = $Type
$dscProperty.IsMandatory = $property.Mandatory $dscProperty.IsMandatory = $property.Mandatory
@@ -4445,13 +4326,13 @@ function GetImplementingModulePath
$schemaFileName $schemaFileName
) )
$moduleFileName = ($schemaFileName -replace ".schema.mof$", '') + '.psd1' $moduleFileName = ($schemaFileName -replace ".schema.json$", '') + '.psd1'
if (Test-Path $moduleFileName) if (Test-Path $moduleFileName)
{ {
return $moduleFileName return $moduleFileName
} }
$moduleFileName = ($schemaFileName -replace ".schema.mof$", '') + '.psm1' $moduleFileName = ($schemaFileName -replace ".schema.json$", '') + '.psm1'
if (Test-Path $moduleFileName) if (Test-Path $moduleFileName)
{ {
return $moduleFileName return $moduleFileName
@@ -4481,9 +4362,9 @@ function GetModule
} }
$schemaFileExt = $null $schemaFileExt = $null
if ($schemaFileName -match '.schema.mof') if ($schemaFileName -match '.schema.json')
{ {
$schemaFileExt = ".schema.mof$" $schemaFileExt = ".schema.json$"
} }
if ($schemaFileName -match '.schema.psm1') if ($schemaFileName -match '.schema.psm1')
@@ -4641,7 +4522,6 @@ Export-ModuleMember -Function Get-DscResource, Configuration
function Invoke-DscResource function Invoke-DscResource
{ {
[Experimental("PSDesiredStateConfiguration.InvokeDscResource", "Show")]
[CmdletBinding(HelpUri = '')] [CmdletBinding(HelpUri = '')]
param ( param (
[Parameter(ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory)] [Parameter(ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory)]
@@ -4692,10 +4572,6 @@ function Invoke-DscResource
ThrowError -ExceptionName 'System.ArgumentException' -ExceptionMessage $errorMessage -ExceptionObject $exception -ErrorId 'InvalidResourceSpecification,Invoke-DscResource' -ErrorCategory InvalidArgument ThrowError -ExceptionName 'System.ArgumentException' -ExceptionMessage $errorMessage -ExceptionObject $exception -ErrorId 'InvalidResourceSpecification,Invoke-DscResource' -ErrorCategory InvalidArgument
} }
if ( @($resource.Properties | Where-Object { $_.PropertyType -eq '' }).Count -gt 0 -and ($IsMacOS -or $IsLinux)) {
Write-Warning -Message $LocalizedData.EmbeddedResourcesNotSupported
}
[Microsoft.PowerShell.DesiredStateConfiguration.DscResourceInfo] $resource = $resource[0] [Microsoft.PowerShell.DesiredStateConfiguration.DscResourceInfo] $resource = $resource[0]
if($resource.ImplementedAs -ne 'PowerShell') if($resource.ImplementedAs -ne 'PowerShell')
{ {
@@ -4746,30 +4622,27 @@ function Invoke-DscClassBasedResource
$type = $resource.ResourceType $type = $resource.ResourceType
Write-Debug "Importing $path ..." Write-Debug "Importing $path ..."
$iss = [System.Management.Automation.Runspaces.InitialSessionState]::CreateDefault2() $powershell = [PowerShell]::Create('CurrentRunspace')
$powershell = [PowerShell]::Create($iss)
$script = @" $script = @"
using module $path using module $path
Write-Host -Message ([$type]::new | out-string)
return [$type]::new() return [$type]::new()
"@ "@
$null= $powershell.AddScript($script) $null= $powershell.AddScript($script)
$dscType=$powershell.Invoke() | Select-object -First 1 $dscObj=$powershell.Invoke() | Select-object -First 1
foreach($key in $Property.Keys) foreach($key in $Property.Keys)
{ {
$value = $Property.$key $value = $Property.$key
Write-Debug "Setting $key to $value" Write-Debug "Setting $key to $value"
$dscType.$key = $value $dscObj.$key = $value
} }
$info = $dscType | Out-String $info = $dscObj | Out-String
Write-Debug $info Write-Debug $info
Write-Debug "calling $type.$Method() ..." Write-Debug "calling $type.$Method() ..."
$global:DSCMachineStatus = $null $global:DSCMachineStatus = $null
$output = $dscType.$Method() $output = $dscObj.$Method()
return Get-InvokeDscResourceResult -Output $output -Method $Method return Get-InvokeDscResourceResult -Output $output -Method $Method
} }
@@ -4834,6 +4707,7 @@ function Get-InvokeDscResourceResult
Export-ModuleMember -Function @( Export-ModuleMember -Function @(
'Invoke-DscResource' 'Invoke-DscResource'
'ConvertTo-DscJsonSchema'
) )
########################################################### ###########################################################
+296 -354
View File
@@ -21,11 +21,7 @@ Function Install-ModuleIfMissing {
} }
} }
Function Test-IsInvokeDscResourceEnable { Describe "Test PSDesiredStateConfiguration" {
return [ExperimentalFeature]::IsEnabled("PSDesiredStateConfiguration.InvokeDscResource")
}
Describe "Test PSDesiredStateConfiguration" -tags CI {
Context "Module loading" { Context "Module loading" {
BeforeAll { BeforeAll {
Function BeCommand { Function BeCommand {
@@ -66,7 +62,7 @@ Describe "Test PSDesiredStateConfiguration" -tags CI {
$commands | Should -HaveCommand -CommandName 'Configuration' -ModuleName PSDesiredStateConfiguration $commands | Should -HaveCommand -CommandName 'Configuration' -ModuleName PSDesiredStateConfiguration
} }
It "The module should have the Configuration Command" { It "The module should have the New-DscChecksum Command" {
$commands | Should -HaveCommand -CommandName 'New-DscChecksum' -ModuleName PSDesiredStateConfiguration $commands | Should -HaveCommand -CommandName 'New-DscChecksum' -ModuleName PSDesiredStateConfiguration
} }
@@ -74,195 +70,15 @@ Describe "Test PSDesiredStateConfiguration" -tags CI {
$commands | Should -HaveCommand -CommandName 'Get-DscResource' -ModuleName PSDesiredStateConfiguration $commands | Should -HaveCommand -CommandName 'Get-DscResource' -ModuleName PSDesiredStateConfiguration
} }
It "The module should have the Invoke-DscResource Command" -Skip:(!(Test-IsInvokeDscResourceEnable)) { It "The module should have the Invoke-DscResource Command" {
$commands | Should -HaveCommand -CommandName 'Invoke-DscResource' -ModuleName PSDesiredStateConfiguration $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'
}
)
}
AfterAll { It "The module should have the ConvertTo-DscJsonSchema Command" {
$Global:ProgressPreference = $origProgress $commands | Should -HaveCommand -CommandName 'ConvertTo-DscJsonSchema' -ModuleName PSDesiredStateConfiguration
}
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" { Context "Get-DscResource - Class base Resources" {
BeforeAll { BeforeAll {
@@ -302,19 +118,11 @@ Describe "Test PSDesiredStateConfiguration" -tags CI {
$resource = Get-DscResource -Name $Name -Module $ModuleName $resource = Get-DscResource -Name $Name -Module $ModuleName
$resource | Should -Not -BeNullOrEmpty $resource | Should -Not -BeNullOrEmpty
$resource.Name | Should -Be $Name $resource.Name | Should -Be $Name
if (Test-IsInvokeDscResourceEnable) {
$resource.ImplementationDetail | Should -Be 'ClassBased' $resource.ImplementationDetail | Should -Be 'ClassBased'
} }
else {
$resource.ImplementationDetail | Should -BeNullOrEmpty
}
}
it "should be able to get class resource - <Name> - <TestCaseName>" -TestCases $classTestCases { it "should be able to get class resource - <Name> - <TestCaseName>" -TestCases $classTestCases {
param($Name, $ModuleName, $PendingBecause) param($Name, $ModuleName, $PendingBecause)
if ($IsWindows) {
Set-ItResult -Pending -Because "https://github.com/PowerShell/PSDesiredStateConfiguration/issues/19"
}
if ($PendingBecause) { if ($PendingBecause) {
Set-ItResult -Pending -Because $PendingBecause Set-ItResult -Pending -Because $PendingBecause
@@ -323,14 +131,10 @@ Describe "Test PSDesiredStateConfiguration" -tags CI {
$resource = Get-DscResource -Name $Name $resource = Get-DscResource -Name $Name
$resource | Should -Not -BeNullOrEmpty $resource | Should -Not -BeNullOrEmpty
$resource.Name | Should -Be $Name $resource.Name | Should -Be $Name
if (Test-IsInvokeDscResourceEnable) {
$resource.ImplementationDetail | Should -Be 'ClassBased' $resource.ImplementationDetail | Should -Be 'ClassBased'
} }
else {
$resource.ImplementationDetail | Should -BeNullOrEmpty
}
}
} }
Context "Invoke-DscResource" { Context "Invoke-DscResource" {
BeforeAll { BeforeAll {
$origProgress = $global:ProgressPreference $origProgress = $global:ProgressPreference
@@ -346,157 +150,6 @@ Describe "Test PSDesiredStateConfiguration" -tags CI {
$Global:ProgressPreference = $origProgress $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 "Resource with embedded resource not supported and a warning should be produced" {
if (!(Test-IsInvokeDscResourceEnable)) {
Set-ItResult -Skipped -Because "Feature not enabled"
}
if (!$IsMacOS) {
Set-ItResult -Skipped -Because "Not applicable on Windows and xWebAdministration resources don't load on linux"
}
try {
Invoke-DscResource -Name xWebSite -ModuleName 'xWebAdministration' -Method Test -Property @{TestScript = 'foobar' } -ErrorAction Stop -WarningVariable warnings
}
catch{
#this will fail too, but that is nat what we are testing...
}
$warnings.Count | Should -Be 1 -because "There should be 1 warning on macOS and Linux"
$warnings[0] | Should -Match 'embedded resources.*not support'
}
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" { Context "Class Based Resources" {
BeforeAll { BeforeAll {
Install-ModuleIfMissing -Name XmlContentDsc -Force Install-ModuleIfMissing -Name XmlContentDsc -Force
@@ -518,7 +171,7 @@ Describe "Test PSDesiredStateConfiguration" -tags CI {
$resolvedXmlPath = (Resolve-Path -Path $testXmlPath).ProviderPath $resolvedXmlPath = (Resolve-Path -Path $testXmlPath).ProviderPath
} }
it 'Set method should work' -Skip:(!(Test-IsInvokeDscResourceEnable)) { it 'Set method should work' {
param( param(
$value, $value,
$ExpectedResult $ExpectedResult
@@ -527,10 +180,299 @@ Describe "Test PSDesiredStateConfiguration" -tags CI {
$testString = '890574209347509120348' $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 = 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 | Should -Not -BeNullOrEmpty
$result.GetType() | Should -Be 'InvokeDscResourceSetResult'
$result.RebootRequired | Should -BeFalse $result.RebootRequired | Should -BeFalse
$testXmlPath | Should -FileContentMatch $testString $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[]]'}
"HashTableValue" {$dscResourcePropertyInfo.PropertyType | Should -Be '[Hashtable]'}
}
}
}
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[]"
$resource.HashTableValue.GetType().Name | Should -Be "Hashtable"
# 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)
HashTableValue = @{
Key1 = 'Value1'
Key2 = 'Value2'
}
}
}
}
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
}
It "Check empty array compilation" {
[Scriptblock]::Create(@"
configuration DSCEmptyArrayConfig
{
Import-DscResource -ModuleName xTestClassResource
Node "localhost" {
xTestClassResource f2
{
Name = 'TestName'
Value = 'TestValue'
sArray = @()
}
}
}
DSCEmptyArrayConfig -OutputPath TestDrive:\DSCEmptyArrayConfig
"@) | Should -Not -Throw
"TestDrive:\DSCEmptyArrayConfig\localhost.mof" | Should -Exist
$mofContent = Get-Content -Raw -Path "TestDrive:\DSCEmptyArrayConfig\localhost.mof"
$mofContent | Write-Verbose -Verbose
$mofContent -match '\ssArray\s=\s{\r\n};' | Should -BeTrue
}
}
@@ -0,0 +1,330 @@
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;
[DscProperty()]
[hashtable] $HashTableValue;
[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)
$this.HashTableValue = @{}
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
@@ -1,38 +0,0 @@
# 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
@@ -1,7 +0,0 @@
&$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