Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: CI - Fixed and expanded upon required/optional validation #3621

Merged
merged 4 commits into from
Oct 26, 2024
Merged

fix: CI - Fixed and expanded upon required/optional validation #3621

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
860b1af
Updated script
AlexanderSehr Oct 23, 2024
35f2552
Merge branch 'main' into users/alsehr/udtTestFix
eriqua Oct 25, 2024
4960542
Merge branch 'main' into users/alsehr/udtTestFix
AlexanderSehr Oct 26, 2024
d2526de
Merge branch 'users/alsehr/udtTestFix' of https://github.com/Azure/bi…
AlexanderSehr Oct 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 26 additions & 5 deletions avm/utilities/pipelines/staticValidation/compliance/module.tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -629,7 +629,7 @@ Describe 'Module tests' -Tag 'Module' {

if (-not $isRequired) {
$description = $templateFileParameters.$parameter.metadata.description
if ($description -match "\('Required\.") {
if ($description -match '^Required\.') {
AlexanderSehr marked this conversation as resolved.
Show resolved Hide resolved
$incorrectParameters += $parameter
}
}
Expand All @@ -638,6 +638,27 @@ Describe 'Module tests' -Tag 'Module' {
$incorrectParameters | Should -BeNullOrEmpty -Because ('only required parameters in the template file should have a description that starts with "Required.". Found incorrect items: [{0}].' -f ($incorrectParameters -join ', '))
}

It '[<moduleFolderName>] All required parameters & UDTs in template file should have description that start with "(Required|Conditional).".' -TestCases $moduleFolderTestCases {
param (
[hashtable] $templateFileContent,
[hashtable] $templateFileParameters
)

$incorrectParameters = @()
foreach ($parameter in ($templateFileParameters.PSBase.Keys | Sort-Object -Culture 'en-US')) {
$isRequired = Get-IsParameterRequired -TemplateFileContent $templateFileContent -Parameter $templateFileParameters.$parameter

if ($isRequired) {
$description = $templateFileParameters.$parameter.metadata.description
if ($description -notmatch '^(Required|Conditional)\.') {
$incorrectParameters += $parameter
}
}
}

$incorrectParameters | Should -BeNullOrEmpty -Because ('required parameters in the template file should have a description that starts with "Required.". Found incorrect items: [{0}].' -f ($incorrectParameters -join ', '))
}

Context 'Schema-based User-defined-types tests' -Tag 'UDT' {

# Creating custom test cases for the UDT schema-based tests
Expand Down Expand Up @@ -670,12 +691,12 @@ Describe 'Module tests' -Tag 'Module' {
link = "$interfaceBase/diagnostic-settings"
}
@{
parameterName = 'roleAssignments'
link = "$interfaceBase/role-assignments"
parameterName = 'roleAssignments'
link = "$interfaceBase/role-assignments"
}
@{
parameterName = 'lock'
link = "$interfaceBase/resource-locks"
parameterName = 'lock'
link = "$interfaceBase/resource-locks"
}
@{
parameterName = 'managedIdentities'
Expand Down