AzPolicyTest.psm1
|
# .EXTERNALHELP AzPolicyTest-help.xml Function Test-JSONContent { [CmdLetBinding()] Param ( [Parameter(Mandatory = $true, ValueFromPipeline = $true, ParameterSetName = 'ProduceOutputFile', HelpMessage = 'Specify the file paths for the policy definition files.')] [Parameter(Mandatory = $true, ValueFromPipeline = $true, ParameterSetName = 'NoOutputFile', HelpMessage = 'Specify the file paths for the policy definition files.')] [String]$path, [Parameter(Mandatory = $false, ParameterSetName = 'ProduceOutputFile', HelpMessage = 'Specify the excluded file paths for the policy definition files.')] [Parameter(Mandatory = $false, ParameterSetName = 'NoOutputFile', HelpMessage = 'Specify the excluded file paths for the policy definition files.')] [String[]]$excludePath, [Parameter(Mandatory = $false, ParameterSetName = 'ProduceOutputFile', HelpMessage = 'Specify the tags for excluded tests.')] [Parameter(Mandatory = $false, ParameterSetName = 'NoOutputFile', HelpMessage = 'Specify the tags for excluded tests.')] [String[]]$ExcludeTags = @(), [Parameter(ParameterSetName = 'ProduceOutputFile', Mandatory = $true)][ValidateNotNullOrEmpty()][string]$OutputFile, [Parameter(ParameterSetName = 'ProduceOutputFile', Mandatory = $false)][ValidateSet('NUnitXml', 'LegacyNUnitXML')][string]$OutputFormat = 'NUnitXml' ) #Test files $FileContentTestFilePath = Join-Path $PSScriptRoot 'fileContent.tests.ps1' Write-Verbose "JSON Content Pester Test file Path: '$DefinitionStructureTestFilePath'" -verbose $testContainerData = @{ path = $path excludePath = $excludePath } $container = New-PesterContainer -Path $FileContentTestFilePath -Data $testContainerData $config = New-PesterConfiguration $config.Run.Container = $container $config.Run.PassThru = $true $config.Output.verbosity = 'Detailed' $config.TestResult.Enabled = $true $config.TestResult.TestSuiteName = 'Json Content Tests' $config.should.ErrorAction = 'Continue' #File Content tests If ($PSCmdlet.ParameterSetName -eq 'ProduceOutputFile') { $config.TestResult.OutputFormat = $OutputFormat $config.TestResult.OutputPath = $OutputFile } if ($ExcludeTags.count -gt 0) { $config.Filter.ExcludeTag = $ExcludeTags } Invoke-Pester -Configuration $config } # .EXTERNALHELP AzPolicyTest-help.xml Function Test-AzPolicyDefinition { [CmdLetBinding()] Param ( [Parameter(Mandatory = $true, ValueFromPipeline = $true, ParameterSetName = 'ProduceOutputFile', HelpMessage = 'Specify the file paths for the policy definition files.')] [Parameter(Mandatory = $true, ValueFromPipeline = $true, ParameterSetName = 'NoOutputFile', HelpMessage = 'Specify the file paths for the policy definition files.')] [String]$path, [Parameter(Mandatory = $false, ParameterSetName = 'ProduceOutputFile', HelpMessage = 'Specify the excluded file paths for the policy definition files.')] [Parameter(Mandatory = $false, ParameterSetName = 'NoOutputFile', HelpMessage = 'Specify the excluded file paths for the policy definition files.')] [String[]]$excludePath, [Parameter(Mandatory = $false, ParameterSetName = 'ProduceOutputFile', HelpMessage = 'Specify the tags for excluded tests.')] [Parameter(Mandatory = $false, ParameterSetName = 'NoOutputFile', HelpMessage = 'Specify the tags for excluded tests.')] [String[]]$ExcludeTags = @(), [Parameter(ParameterSetName = 'ProduceOutputFile', Mandatory = $true)][ValidateNotNullOrEmpty()][string]$OutputFile, [Parameter(ParameterSetName = 'ProduceOutputFile', Mandatory = $false)][ValidateSet('NUnitXml', 'LegacyNUnitXML')][string]$OutputFormat = 'NUnitXml' ) #Test files $DefinitionStructureTestFilePath = join-path $PSScriptRoot 'policyDefStructure.tests.ps1' Write-Verbose "Policy Definition Pester Test file Path: '$DefinitionStructureTestFilePath'" -verbose $testContainerData = @{ path = $path excludePath = $excludePath } $container = New-PesterContainer -Path $DefinitionStructureTestFilePath -Data $testContainerData $config = New-PesterConfiguration $config.Run.Container = $container $config.Run.PassThru = $true $config.Output.verbosity = 'Detailed' $config.TestResult.Enabled = $true $config.TestResult.TestSuiteName = 'Policy Definition Tests' $config.should.ErrorAction = 'Continue' #Policy Definition tests If ($PSCmdlet.ParameterSetName -eq 'ProduceOutputFile') { $config.TestResult.OutputFormat = $OutputFormat $config.TestResult.OutputPath = $OutputFile } if ($ExcludeTags.count -gt 0) { $config.Filter.ExcludeTag = $ExcludeTags } Invoke-Pester -Configuration $config } # .EXTERNALHELP AzPolicyTest-help.xml Function Test-AzPolicySetDefinition { [CmdLetBinding()] Param ( [Parameter(Mandatory = $true, ValueFromPipeline = $true, ParameterSetName = 'ProduceOutputFile', HelpMessage = 'Specify the file paths for the policy set definition files.')] [Parameter(Mandatory = $true, ValueFromPipeline = $true, ParameterSetName = 'NoOutputFile', HelpMessage = 'Specify the file paths for the policy set definition files.')] [String]$path, [Parameter(Mandatory = $false, ParameterSetName = 'ProduceOutputFile', HelpMessage = 'Specify the excluded file paths for the policy set definition files.')] [Parameter(Mandatory = $false, ParameterSetName = 'NoOutputFile', HelpMessage = 'Specify the excluded file paths for the policy set definition files.')] [String[]]$excludePath, [Parameter(Mandatory = $false, ParameterSetName = 'ProduceOutputFile', HelpMessage = 'Specify the tags for excluded tests.')] [Parameter(Mandatory = $false, ParameterSetName = 'NoOutputFile', HelpMessage = 'Specify the tags for excluded tests.')] [String[]]$ExcludeTags = @(), [Parameter(ParameterSetName = 'ProduceOutputFile', Mandatory = $true)][ValidateNotNullOrEmpty()][string]$OutputFile, [Parameter(ParameterSetName = 'ProduceOutputFile', Mandatory = $false)][ValidateSet('NUnitXml', 'LegacyNUnitXML')][string]$OutputFormat = 'NUnitXml' ) #Test files $DefinitionStructureTestFilePath = join-path $PSScriptRoot 'policySetDefStructure.tests.ps1' Write-Verbose "Policy Initiative Pester Test file Path: '$DefinitionStructureTestFilePath'" -verbose $testContainerData = @{ path = $path excludePath = $excludePath } $container = New-PesterContainer -Path $DefinitionStructureTestFilePath -Data $testContainerData $config = New-PesterConfiguration $config.Run.Container = $container $config.Run.PassThru = $true $config.Output.verbosity = 'Detailed' $config.TestResult.Enabled = $true $config.TestResult.TestSuiteName = 'JPolicy Initiative Tests' $config.should.ErrorAction = 'Continue' #Policy Initiative tests If ($PSCmdlet.ParameterSetName -eq 'ProduceOutputFile') { $config.TestResult.OutputFormat = $OutputFormat $config.TestResult.OutputPath = $OutputFile } if ($ExcludeTags.count -gt 0) { $config.Filter.ExcludeTag = $ExcludeTags } Invoke-Pester -Configuration $config } Function GetRelativeFilePath { [CmdletBinding()] Param ( [Parameter(Mandatory = $true)] [ValidateScript({ Test-Path $_ })] [String]$path ) #Try to get git root directory if ((Get-Item $path).PSIsContainer) { $gitRoot = GetGitRoot -path $path } else { $gitRoot = GetGitRoot -path (Get-Item $path).Directory } if ($gitRoot) { $relativePath = Resolve-Path -Path $path -RelativeBasePath $gitRoot -Relative } else { $relativePath = $path } $relativePath } Function GetGitRoot { [CmdletBinding()] Param ( [Parameter(Mandatory = $true, ValueFromPipeline = $true, HelpMessage = 'Specify the folder path.')] [ValidateScript({ Test-Path $_ -PathType Container })] [String]$path ) #store the current Directory in a variable $currentDir = $pwd #Change the working directory to the specified path Set-Location $path #Check if the current directory is inside a git repository try { $isGitRepo = Invoke-Expression 'git rev-parse --is-inside-work-tree 2>&1' -ErrorAction SilentlyContinue } catch { $isGitRepo = 'false' } if ($isGitRepo -eq 'true') { #Get the root directory of the git repository $gitRootDir = Invoke-expression 'git rev-parse --show-toplevel 2>&1' -ErrorAction SilentlyContinue if (Test-Path $gitRootDir) { $gitRootDir = Convert-Path $gitRootDir } } else { Write-Verbose "The specified path '$path' is not inside a git repository or git command tool is not installed." } #Change the working directory back to the original directory Set-Location $currentDir $gitRootDir } |