Skip to content

Add parameter validation checks for length, allowed values, and number limits on defaultValue #1229

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

Merged
merged 4 commits into from
Nov 4, 2025
Merged

Add parameter validation checks for length, allowed values, and number limits on defaultValue #1229

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3c8d2c9
Add parameter validation checks for length, allowed values, and numbe…
Gijsreyn Nov 2, 2025
383cfa5
Remove line
Gijsreyn Nov 2, 2025
72db174
Resolve remarks
Gijsreyn Nov 3, 2025
b5defea
Fix up tests
Gijsreyn Nov 3, 2025
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
160 changes: 160 additions & 0 deletions dsc/tests/dsc_parameters.tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -577,4 +577,164 @@ Describe 'Parameters tests' {
$LASTEXITCODE | Should -Be 4
$testError | Should -Match 'Circular dependency or unresolvable parameter references detected in parameters'
}

It 'Default value violates <constraint> constraint' -TestCases @(
@{ constraint = 'minLength'; type = 'string'; value = 'ab'; min = 3; max = 20; errorMatch = 'minimum length' }
@{ constraint = 'maxLength'; type = 'string'; value = 'verylongusernamethatexceedslimit'; min = 3; max = 20; errorMatch = 'maximum length' }
@{ constraint = 'minValue'; type = 'int'; value = 0; min = 1; max = 65535; errorMatch = 'minimum value' }
@{ constraint = 'maxValue'; type = 'int'; value = 99999; min = 1; max = 65535; errorMatch = 'maximum value' }
) {
param($constraint, $type, $value, $min, $max, $errorMatch)

if ($type -eq 'string') {
$value = "'$value'"
# For string type, only use length constraints
$config_yaml = @"
`$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
parameters:
param1:
type: $type
minLength: $min
maxLength: $max
defaultValue: $value
resources:
- name: Echo
type: Microsoft.DSC.Debug/Echo
properties:
output: '[parameters(''param1'')]'
"@
} else {
# For int type, only use value constraints
$config_yaml = @"
`$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
parameters:
param1:
type: $type
minValue: $min
maxValue: $max
defaultValue: $value
resources:
- name: Echo
type: Microsoft.DSC.Debug/Echo
properties:
output: '[parameters(''param1'')]'
"@
}

$testError = & {$config_yaml | dsc config get -f - 2>&1}
$LASTEXITCODE | Should -Be 4
$testError | Should -Match $errorMatch
}

It 'Default value violates allowedValues constraint for <type>' -TestCases @(
@{ type = 'string'; value = 'staging'; allowed = @('dev', 'test', 'prod') }
@{ type = 'int'; value = 7; allowed = @(1, 5, 10) }
) {
param($type, $value, $allowed)

if ($type -eq 'string') {
$value = "'$value'"
}

$config_yaml = @"
`$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
parameters:
param1:
type: $type
allowedValues: $($allowed | ConvertTo-Json -Compress)
defaultValue: $value
resources:
- name: Echo
type: Microsoft.DSC.Debug/Echo
properties:
output: '[parameters(''param1'')]'
"@

$testError = & {$config_yaml | dsc config get -f - 2>&1}
$LASTEXITCODE | Should -Be 4
$testError | Should -Match 'allowed values'
}

It 'Default values pass constraint validation for <type>' -TestCases @(
@{ type = 'string'; value = 'admin'; min = 3; max = 20 }
@{ type = 'int'; value = 8080; min = 1; max = 65535 }
) {
param($type, $value, $min, $max)

if ($type -eq 'string') {
$value = "'$value'"
# For string type, only use length constraints
$config_yaml = @"
`$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
parameters:
param1:
type: $type
minLength: $min
maxLength: $max
defaultValue: $value
resources:
- name: Echo
type: Microsoft.DSC.Debug/Echo
properties:
output: '[parameters(''param1'')]'
"@
} else {
# For int type, only use value constraints
$config_yaml = @"
`$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
parameters:
param1:
type: $type
minValue: $min
maxValue: $max
defaultValue: $value
resources:
- name: Echo
type: Microsoft.DSC.Debug/Echo
properties:
output: '[parameters(''param1'')]'
"@
}

$out = $config_yaml | dsc config get -f - | ConvertFrom-Json
$LASTEXITCODE | Should -Be 0
if ($type -eq 'string') {
$out.results[0].result.actualState.output | Should -BeExactly 'admin'
} else {
$out.results[0].result.actualState.output | Should -BeExactly 8080
}
}

It 'Default values with allowedValues pass validation for <type>' -TestCases @(
@{ type = 'string'; value = 'dev'; allowed = @('dev', 'test', 'prod') }
@{ type = 'int'; value = 5; allowed = @(1, 5, 10) }
) {
param($type, $value, $allowed)

if ($type -eq 'string') {
$value = "'$value'"
}

$config_yaml = @"
`$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
parameters:
param1:
type: $type
allowedValues: $($allowed | ConvertTo-Json -Compress)
defaultValue: $value
resources:
- name: Echo
type: Microsoft.DSC.Debug/Echo
properties:
output: '[parameters(''param1'')]'
"@

$out = $config_yaml | dsc config get -f - | ConvertFrom-Json
$LASTEXITCODE | Should -Be 0
if ($type -eq 'string') {
$out.results[0].result.actualState.output | Should -BeExactly 'dev'
} else {
$out.results[0].result.actualState.output | Should -BeExactly 5
}
}
}
3 changes: 3 additions & 0 deletions lib/dsc-lib/src/configure/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -895,6 +895,9 @@ impl Configurator {
};

if let Ok(value) = value_result {
check_length(name, &value, parameter)?;
check_allowed_values(name, &value, parameter)?;
check_number_limits(name, &value, parameter)?;
validate_parameter_type(name, &value, &parameter.parameter_type)?;
self.context.parameters.insert(name.to_string(), (value, parameter.parameter_type.clone()));
resolved_in_this_pass.push(name.clone());
Expand Down