DscResource.Test.psd1
|
@{ # Script module or binary module file associated with this manifest. RootModule = 'DscResource.Test.psm1' # Version number of this module. ModuleVersion = '0.15.0' # Supported PSEditions # CompatiblePSEditions = @() # ID used to uniquely identify this module GUID = '036f67a1-21a3-43b6-95a0-73d5549e854e' # Author of this module Author = 'DSC Community' # Company or vendor of this module CompanyName = 'DSC Community' # Copyright statement for this module Copyright = '(c) dsccommunity. All rights reserved.' # Description of the functionality provided by this module Description = 'Testing DSC Resources against HQRM guidelines' # Minimum version of the PowerShell engine required by this module PowerShellVersion = '5.0' # Name of the PowerShell host required by this module # PowerShellHostName = '' # Minimum version of the PowerShell host required by this module # PowerShellHostVersion = '' # Minimum version of Microsoft .NET Framework required by this module. This prerequisite is valid for the PowerShell Desktop edition only. # DotNetFrameworkVersion = '' # Minimum version of the common language runtime (CLR) required by this module. This prerequisite is valid for the PowerShell Desktop edition only. # CLRVersion = '' # Processor architecture (None, X86, Amd64) required by this module # ProcessorArchitecture = '' # Modules that must be imported into the global environment prior to importing this module RequiredModules = @() # Assemblies that must be loaded prior to importing this module # RequiredAssemblies = @() # Script files (.ps1) that are run in the caller's environment prior to importing this module. # ScriptsToProcess = @() # Type files (.ps1xml) to be loaded when importing this module # TypesToProcess = @() # Format files (.ps1xml) to be loaded when importing this module # FormatsToProcess = @() # Modules to import as nested modules of the module specified in RootModule/ModuleToProcess # NestedModules = @() # Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export. FunctionsToExport = @('Clear-DscLcmConfiguration','Get-DscResourceTestContainer','Get-InvalidOperationRecord','Get-InvalidResultRecord','Initialize-TestEnvironment','Invoke-DscResourceTest','New-DscSelfSignedCertificate','Restore-TestEnvironment','Task.Fail_Build_If_HQRM_Tests_Failed','Task.Invoke_HQRM_Tests_Stop_On_Fail','Task.Invoke_HQRM_Tests','Wait-ForIdleLcm') # Cmdlets 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 cmdlets to export. CmdletsToExport = @() # Variables to export from this module VariablesToExport = @() # Aliases 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 aliases to export. AliasesToExport = @('Get-ObjectNotFoundRecord','Task.Invoke_HQRM_Tests','Task.Fail_Build_If_HQRM_Tests_Failed','Task.Invoke_HQRM_Tests_Stop_On_Fail') # DSC resources to export from this module # DscResourcesToExport = @() # List of all modules packaged with this module # ModuleList = @() # List of all files packaged with this module # FileList = @() # Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell. PrivateData = @{ PSData = @{ # Tags applied to this module. These help with module discovery in online galleries. Tags = @('DesiredStateConfiguration', 'DSC', 'DSCResourceKit', 'DSCResource') # A URL to the license for this module. LicenseUri = 'https://github.com/dsccommunity/DscResource.Test/blob/master/LICENSE' # A URL to the main website for this project. ProjectUri = 'https://github.com/dsccommunity/DscResource.Test' ExternalModuleDependencies = @('DscResource.AnalyzerRules', 'Pester', 'xDSCResourceDesigner', 'PSPKI') # A URL to an icon representing this module. IconUri = 'https://dsccommunity.org/images/DSC_Logo_300p.png' Prerelease = 'preview0003' # ReleaseNotes of this module ReleaseNotes = '## [0.15.0-preview0003] - 2021-02-09 ### Added - Added test helper functions `Get-InvalidResultRecord` and `Get-InvalidOperationRecord`. - Added alias `Get-ObjectNotFoundRecord` that points to `Get-InvalidResultRecord`. - Added build task `Invoke_HQRM_Tests` and `Fail_Build_If_HQRM_Tests_Failed`. - Added meta build task `Invoke_HQRM_Tests_Stop_On_Fail` that runs both build tasks `Invoke_HQRM_Tests` and `Fail_Build_If_HQRM_Tests_Failed` in correct order. - New QA (HQRM) tests for Pester 5 was added that will only run if Pester 5.1 is used by the test pipeline. - Added (converted) HQRM test for Pester 5 - Added `Changelog.common.v5.Tests.ps1` - Added `ExampleFiles.common.v5.Tests.ps1` - Added `FileFormatting.common.v5.Tests.ps1` - The individual test for checking BOM on markdown files was remove and replaced by a test that checks for BOM on all text files (code, configuration, and markdown). That also replaced the Pester 4 tests `ModuleFiles.common.v4.Tests.ps1` (that only checked for BOM on `.psm1`files), and `ScriptFiles.common.v4.Tests.ps1` (that only checked for BOM on `.ps1` files). No changes were made to the Pester 4 tests, just the Pester 5 tests. - Added `MarkdownLinks.common.v5.Tests.ps1` - Added `ModuleManifest.common.v5.Tests.ps1` - Added `ModuleScriptFiles.common.v5.Tests.ps1` - Contain the converted Pester 4 tests from `Psm1Parsing.common.v4.Tests.ps1`. - Added `PSSAResource.common.v5.Tests.ps1` - Any test that is excluded by using Pester `ExcludeTag` under the key `DscTest:` will now be silently excluded due to how Pester does _Discovery_. - Added `PublishExampleFiles.v5.Tests.ps1` - Added `ResourceSchema.common.v5.Tests.ps1` - Added public function `Get-DscResourceTestContainer` which returns a Pester container for each available Pester 5 HQRM test. ### Changed - Renamed all existing QA (HQRM) tests to `*.v4.Tests.ps1*` and made them not run if test pipeline is using Pester 5. - The function `Get-TextFilesList` can now take an optional parameter `FileExtension` to only return those files, e.g. `@(''.psm1'')`. This makes the function `Get-Psm1FileList` obsolete. - `Get-DscResourceTestContainer` - Changed to support the new Pester 5 HQRM tests, and code for an older Pester 5 Beta iteration was removed. - Added a `build.yaml` task script `Add_Aliases_To_Module_Manifest` that update module manifest with a list of aliases that is configured in the `build.yaml` file under the key `AliasesToExport:`. This is quick fix for the issue [Export alias create with Set-Alias and New-Alias](https://github.com/PoshCode/ModuleBuilder/issues/103). ### Fixed - Fix issue with running pester 4 HQRM test after preview release `v0.15.0-preview0002`. ' } # End of PSData hashtable } # End of PrivateData hashtable # HelpInfo URI of this module # HelpInfoURI = '' # Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix. # DefaultCommandPrefix = '' } |