feat: child modules telemetry check

utilities/pipelines/sharedScripts/helper/Get-CrossReferencedModuleList.ps1

@@ -75,9 +75,9 @@ function Get-ReferenceObject {
     $involvedFilePaths = Get-LocallyReferencedFileList -FilePath $ModuleTemplateFilePath -TemplateMap $TemplateMap
 
     $resultSet = @{
-        resourceReferences  = @()
-        remoteReferences    = @()
-        localPathReferences = $involvedFilePaths | Where-Object {
+        resourceReferences    = @()
+        remoteReferences      = @()
+        localPathReferences   = $involvedFilePaths | Where-Object {
             $involvedFilePath = $_
             # We only care about module templates
             (Split-Path $involvedFilePath -Leaf) -eq 'main.bicep' -and
@@ -86,6 +86,13 @@ function Get-ReferenceObject {
                 (Split-Path $involvedFilePath) -match ('{0}[\/|\\].+' -f [Regex]::Escape((Split-Path $_ -Parent))) # i.e., if a path has its parent in the list, kick it out
             }).count -eq 0
         }
+        childModuleReferences = $involvedFilePaths | Where-Object {
+            $involvedFilePath = $_
+            # We only care about module templates
+            (Split-Path $involvedFilePath -Leaf) -eq 'main.bicep' -and
+            # only return child modules
+            (Test-Path -Path (Join-Path (Split-Path $involvedFilePath) 'version.json') -PathType Leaf)
+        }
     }
 
     foreach ($involvedFilePath in (@($ModuleTemplateFilePath) + @($involvedFilePaths))) {
@@ -96,9 +103,10 @@ function Get-ReferenceObject {
     }
 
     return @{
-        resourceReferences  = $resultSet.resourceReferences | Sort-Object -Culture 'en-US' -Unique
-        remoteReferences    = $resultSet.remoteReferences | Sort-Object -Culture 'en-US' -Unique
-        localPathReferences = $resultSet.localPathReferences | Sort-Object -Culture 'en-US' -Unique
+        resourceReferences    = $resultSet.resourceReferences | Sort-Object -Culture 'en-US' -Unique
+        remoteReferences      = $resultSet.remoteReferences | Sort-Object -Culture 'en-US' -Unique
+        localPathReferences   = $resultSet.localPathReferences | Sort-Object -Culture 'en-US' -Unique
+        childModuleReferences = $resultSet.childModuleReferences | Sort-Object -Culture 'en-US' -Unique
     }
 }
 #endregion

utilities/pipelines/staticValidation/compliance/module.tests.ps1

@@ -116,7 +116,7 @@ Describe 'File/folder tests' -Tag 'Modules' {
         }
 
         # if the child modules version has been increased, the main modules version should be increased as well
-        It '[<moduleFolderName>] main module version should be increased if the child version number has been increased.' -TestCases ($moduleFolderTestCases | Where-Object { (-Not $_.isTopLevelModule) }) {
+        It '[<moduleFolderName>] main module version should be increased if the child version number has been increased.' -TestCases ($moduleFolderTestCases | Where-Object { -Not $_.isTopLevelModule }) {
 
             param (
                 [string] $moduleFolderPath
@@ -128,7 +128,8 @@ Describe 'File/folder tests' -Tag 'Modules' {
                 $parentFolderPath = Split-Path -Path $moduleFolderPath -Parent
                 $moduleVersion = Get-ModuleTargetVersion -ModuleFolderPath $parentFolderPath
 
-                ($childModuleVersion.EndsWith('.0') -and -not $moduleVersion.EndsWith('.0')) | Should -Be $false
+                # the first release of a child module does not require the parent module to be updated
+                ($childModuleVersion -ne '0.1.0' -and $childModuleVersion.EndsWith('.0') -and -not $moduleVersion.EndsWith('.0')) | Should -Be $false
             }
         }
 
@@ -481,6 +482,7 @@ Describe 'Module tests' -Tag 'Module' {
                 # Test file setup
                 $moduleFolderTestCases += @{
                     moduleFolderName       = $resourceTypeIdentifier
+                    moduleFolderPath       = Split-Path $templateFilePath
                     templateFileContent    = $templateFileContent
                     templateFilePath       = $templateFilePath
                     templateFileParameters = Resolve-ReadMeParameterList -TemplateFileContent $templateFileContent
@@ -491,6 +493,13 @@ Describe 'Module tests' -Tag 'Module' {
             }
         }
 
+        BeforeAll {
+            # Load function
+            . (Join-Path $repoRootPath 'utilities' 'pipelines' 'sharedScripts' 'helper' 'Get-CrossReferencedModuleList.ps1')
+            # load cross-references
+            $crossReferencedModuleList = Get-CrossReferencedModuleList
+        }
+
         Context 'General' {
 
             It '[<moduleFolderName>] The template file should not be empty.' -TestCases $moduleFolderTestCases {
@@ -992,6 +1001,52 @@ Describe 'Module tests' -Tag 'Module' {
                 $telemetryDeploymentName = $telemetryDeployment.name # The AVM telemetry prefix
                 $telemetryDeploymentName | Should -Match "$expectedTelemetryIdentifier"
             }
+
+            It '[<moduleFolderName>] Telemetry should be disabled for child modules.' -TestCases ($moduleFolderTestCases | Where-Object { $_.isTopLevelModule }) {
+
+                param(
+                    [hashtable] $templateFileContent,
+                    [string] $templateFilePath
+                )
+
+                $crossReferencedModuleList = Get-CrossReferencedModuleList -Path $moduleFolderPath
+                $modulesWithChildReferences = $crossReferencedModuleList.Values | Where-Object {
+                    $_.ContainsKey('childModuleReferences') -and $_['childModuleReferences'].Count -gt 0
+                }
+                if ($modulesWithChildReferences.Count -eq 0) {
+                    Set-ItResult -Skipped -Because 'no child modules found'
+                    return
+                }
+
+                $modulesWithChildReferences | ForEach-Object {
+                    $_['childModuleReferences'] | ForEach-Object {
+                        # 'avm/res|ptn|utl/<provider>/<resourceType>/<childResourceType>' would return 'avm', 'res|ptn|utl', '<provider>/<resourceType>/<childResourceType>'
+                        $null, $childModuleType, $childResourceTypeIdentifier = ((Split-Path $_) -split '[\/|\\]avm[\/|\\](res|ptn|utl)[\/|\\]')
+                        $childModuleName = (Split-Path $childResourceTypeIdentifier -Leaf)
+                        Write-Verbose "Checking telemetry for child module [$childModuleName]" -Verbose
+                        # find the child modules reference in the parent module
+                        $moduleBicep = Get-Content -Path $templateFilePath
+                        $regexPattern = "module\s+(\S+)\s+'$childModuleName/main.bicep'\s+="
+                        $moduleName = ''
+                        foreach ($line in $moduleBicep) {
+                            if ($line -match $regexPattern) {
+                                $moduleName = $matches[1]
+                                break
+                            }
+                        }
+                        # with the module name, get the resource and its properties
+                        $childModuleParameters = $templateFileContent.resources.$moduleName.properties.parameters
+                        $containsTelemetryParameter = $childModuleParameters.ContainsKey('enableTelemetry')
+                        $containsTelemetryParameter | Should -Be $true -Because "the child module [$childModuleName] should be referenced with a telemetry parameter."
+
+                        if ($containsTelemetryParameter) {
+                            $isTelemetryDisabled = $childModuleParameters.enableTelemetry.value -eq $false
+                            $isTelemetryDisabled | Should -Be $true -Because "the child module [$childModuleName] should have telemetry disabled."
+                        }
+                    }
+                }
+
+            }
         }
 
         Context 'Output' {