NickSpag
commented
1 year ago In an effort to isolate the issue I've been able to reproduce the InvalidOperation error in as small of a case as possible, and it's created some interesting behavior:
In this case, we're running arm-ttk with this command:
TESTAZTEMPLATE_ARGS="Test-AzMarketplacePackage -TemplatePath $TARGET_DIRECTORY/mainTemplate.json"
pwsh -noprofile -nologo -command "Import-Module '${LOCAL_ARMTTK_ROOT}/arm-ttk/arm-ttk.psd1'; ${TESTAZTEMPLATE_ARGS} ; if (\$error.Count) { exit 1}"--
There are three bicep files that generate a single mainTemplate.json, with the following structure and resources:
- main.bicep (a call to keyvaults.bicep, and an appconfig resource that, if removed, removes the error)
- keyvaults.bicep (a call to keyvault.bicep, and a commented out keyvault resource that, if added, removes the error)
- keyvault.bicep (a keyvault resource)
Files
main.bicep
param location string
// if you remove this, the error will not happen
resource azureAppConfig 'Microsoft.AppConfiguration/configurationStores@2022-05-01' = {
name: '$appconfig'
location: location
sku: {
name: 'standard'
}
properties: {
publicNetworkAccess: 'Enabled'
}
}
// nested module
module keyVaults 'keyvaults.bicep' = {
name: 'keyvaults-module'
params: {
keyVaultName: 'keyvaultname'
}
}keyvaults.bicep
param keyVaultName string
module bots 'keyvault.bicep' = {
name: 'keyvault-module'
params:{
keyVaultName: keyVaultName
}
}
// curiously, if you add this the error goes away
// resource keyVaultName_appPasswordSecret 'Microsoft.KeyVault/vaults/secrets@2019-09-01' = {
// name: '${keyVaultName}/appPasswordSecret1'
// properties: {
// attributes: {
// enabled: true
// }
// value: 'blah'
// }
// }keyvault.bicep
param keyVaultName string
// including this triggers the error
resource keyVaultName_appPasswordSecret 'Microsoft.KeyVault/vaults/secrets@2019-09-01' = {
name: '${keyVaultName}/appPasswordSecret'
properties: {
attributes: {
enabled: true
}
value: 'blah'
}
}Produces this mainTemplate.json:
{
"$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
"contentVersion": "1.0.0.0",
"metadata": {
"_generator": {
"name": "bicep",
"version": "0.10.61.36676",
"templateHash": "17942593897169903016"
}
},
"parameters": {
"location": {
"type": "string"
}
},
"resources": [
{
"type": "Microsoft.AppConfiguration/configurationStores",
"apiVersion": "2022-05-01",
"name": "$appconfig",
"location": "[parameters('location')]",
"sku": {
"name": "standard"
},
"properties": {
"publicNetworkAccess": "Enabled"
}
},
{
"type": "Microsoft.Resources/deployments",
"apiVersion": "2020-10-01",
"name": "keyvaults-module",
"properties": {
"expressionEvaluationOptions": {
"scope": "inner"
},
"mode": "Incremental",
"parameters": {
"keyVaultName": {
"value": "keyvaultname"
}
},
"template": {
"$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
"contentVersion": "1.0.0.0",
"metadata": {
"_generator": {
"name": "bicep",
"version": "0.10.61.36676",
"templateHash": "5774184200920166479"
}
},
"parameters": {
"keyVaultName": {
"type": "string"
}
},
"resources": [
{
"type": "Microsoft.Resources/deployments",
"apiVersion": "2020-10-01",
"name": "keyvault-module",
"properties": {
"expressionEvaluationOptions": {
"scope": "inner"
},
"mode": "Incremental",
"parameters": {
"keyVaultName": {
"value": "[parameters('keyVaultName')]"
}
},
"template": {
"$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
"contentVersion": "1.0.0.0",
"metadata": {
"_generator": {
"name": "bicep",
"version": "0.10.61.36676",
"templateHash": "17207296097468162821"
}
},
"parameters": {
"keyVaultName": {
"type": "string"
}
},
"resources": [
{
"type": "Microsoft.KeyVault/vaults/secrets",
"apiVersion": "2019-09-01",
"name": "[format('{0}/appPasswordSecret', parameters('keyVaultName'))]",
"properties": {
"attributes": {
"enabled": true
},
"value": "blah"
}
}
]
}
}
}
]
}
}
}
]
}Files here: arm-ttk-repro.zip
Error
It will create one error:
InvalidOperation: /Users/nickspagnola/Development/Projects/arm-ttk/arm-ttk/Test-AzTemplate.ps1:428
Line |
428 | … $location.Line += $testOut.InnerTemplateLocation.Line - 1 …|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
| The property 'Line' cannot be found on this object. Verify that the property exists and can be set.Notes
- This is just a subset of the errors we see in our broader solution.
- I haven't tried many other resources besides a keyvault, but I have tried others that are similar (azure app config values that also construct their parent resource with a '{parentResourceName}/resourceType' syntax) and it does not produce the error.
- I've isolated the mainTemplate here and ran arm-ttk against it directly, but if I add a basic createUiDefinition.json and run tests against the directory, the
Parameters Without Default Must Exist In CreateUIDefinitiontest will fail twice on the keyVaultName parameter in keyvaults.bicep and keyvault.bicep. Not sure if that is intended behavior, but it forces us to add defaults to all of our nested tempaltes in bicep which eliminates some of the type safety benefits and indicates there may be confusion in the nested template graph. edit: I see #681 is pointing out this issue as well - At the end of main.bicep, if I replaced the keyvaultname string with an empty string for the keyvaults.bicep argument, it creates a
Cannot bind argument to parameter 'Match' because it is an empty string.error in theParameter Types Should Be Consistenttest. Again not sure if that's intended behavior, since in this case it would be catching something problematic, but not exactly reporting the test failure properly.
If there is anything else that we can provide or any other way to help, we're happy to hear it. If you also suspect a certain area of the arm-ttk source we'd be happy to get pointed in the right direction. thanks!
StartAutomating
bmoore-msft
bkanda
Background
Issues
Broadly, we see a littany of issues that we think are related to nested templates. They most commonly surface by erroring certain tests with a
Cannot bind argument to parameter 'TemplateText' because it is (an empty <type>|null)but there are also unreferenced variable or empty property warnings.But we also see multiple outright errors during ingestion that usually point to lines 428, 711, 775:
We amended the arm-ttk scripts to print out which template was responsible for the error, and its typically in areas where our bicep modules are nested two or three times deep.
Impact
While we think this is a broader issue related to nested templates, it just so happens that it is hitting a required Marketplace test- Location Should Not Be Hardcoded. But we do not hardcode any locations. I've changed any references to locations (like in urls in deployment scripts, azure app config key values, etc) to use only the top level parameter provided by the createUiDefinition.json. There are no words in our mainTemplate.json that use an azure region. But the error persists.
Thank you!