Check optional vs required parameter description Feature Request

[eriqua]

Description

Verify the description for Optional parameters is correct, i.e. parameter description should start with "Optional" if a default value is provided.

Verify the description for Required and Conditional parameters is correct, i.e. if the parameter description starts with "Required" or "Conditional" no default value should be provided.

For each of these scenarios a Pester test should be created.

[MariusStorhaug]

Is this not already done?

ResourceModules/arm/.global/global.module.tests.ps1

Lines 692 to 713 in b1af5ff

	It "[<moduleFolderName>] parameters' description shoud start either by 'Optional.' or 'Required.' or 'Generated.'" -TestCases $deploymentFolderTestCases {
	param(
	$moduleFolderName,
	$templateContent
	)
	if (-not $templateContent.parameters) {
	# Skip test
	$true | Should -Be $true
	return
	}
	$IncorrectParameters = @()
	$Paramdescoutput = $templateContent.parameters.Keys
	foreach ($Param in $Paramdescoutput) {
	$Data = ($templateContent.parameters.$Param.metadata).description
	if ($Data -notlike 'Optional. [a-zA-Z]*' -and $Data -notlike 'Required. [a-zA-Z]*' -and $Data -notlike 'Generated. [a-zA-Z]*') {
	$IncorrectParameters += $Param
	}
	}
	$IncorrectParameters | Should -BeNullOrEmpty
	}

[eriqua]

That is checking for the description regex but does not check if a default value is provided in case the description is Optional.