feature: add a comment to the PR when there are any changes that would change what's cached on windows VHDs

.github/workflows/validate-windows-ut.yml

@@ -8,6 +8,8 @@ jobs:
     steps:
       - name: Check out repository code
         uses: actions/checkout@v4
+        with:
+          fetch-depth: 1
       - name: Perform a Pester test from the parts/windows/*.tests.ps1 file
         shell: powershell
         run: |
@@ -21,3 +23,62 @@ jobs:
         run: |
           Install-Module -Name powershell-yaml -Force
           Invoke-Pester staging/cse/windows/*.tests.ps1 -Passthru
+
+  compare-components-output:
+    name: Compare components.json for each windows VHD
+    runs-on: windows-latest
+    permissions:
+      pull-requests: write
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v4
+        with:
+          ref: master
+          path: master
+          fetch-depth: 1
+
+      - name: Check out repository code
+        uses: actions/checkout@v4
+        with:
+          path: pr
+          fetch-depth: 1
+
+      - name: Produce vhd files - master
+        shell: pwsh
+        run: |
+          cd pr
+          mkdir vhd_files
+
+          pwsh -c vhdbuilder/scripts/windows/generate_cached_stuff_list.ps1 vhd_files vhdbuilder/packer/windows/components_json_helpers.ps1 ../master/vhdbuilder/packer/windows/windows_settings.json ../master/parts/common/components.json 
+
+          git add vhd_files
+          git config user.email "[email protected]"
+          git config user.name "Your Name"
+          git commit -m "versions of files from master"
+
+          pwsh -c vhdbuilder/scripts/windows/generate_cached_stuff_list.ps1 vhd_files vhdbuilder/packer/windows/components_json_helpers.ps1 vhdbuilder/packer/windows/windows_settings.json parts/common/components.json 
+
+          mkdir -p ../.github/workflows
+          $diffFile = "../.github/workflows/diff.md"
+
+          git diff --quiet
+          if ( $LASTEXITCODE -eq "0" ) {
+            Write-Output "No changes to cached containers or packages on Windows VHDs" > $diffFile
+          } else {
+            Write-Output "Changes cached containers or packages on windows VHDs" > $diffFile
+            Write-Output "" >> $diffFile
+            Write-Output '```diff' >> $diffFile
+            git diff >> $diffFile
+            Write-Output '```' >> $diffFile
+          }
+
+          dir $diffFile
+          Get-Content $diffFile
+
+      - name: Add comment to PR
+        uses: NejcZdovc/comment-pr@v2
+        with:
+            file: "diff.md"
+            identifier: "WINDOWS_VHD_CONTENT_DIFF"
+        env:
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

parts/parts.go

@@ -1,4 +1,4 @@
-// Package parts provides the the embedded templates used in Linux and Windows systems.
+// Package parts provides the embedded templates used in Linux and Windows systems.
 package parts
 
 import "embed"

vhdbuilder/packer/windows/components_json_helpers.ps1

@@ -279,4 +279,29 @@ function GetDefenderUpdateInfoUrl {
     )
 
     return $windowsSettingsContent.WindowsDefenderInfo.DefenderUpdateInfoUrl
+}
+
+function GetAllCachedThings {
+    Param(
+        [Parameter(Mandatory = $true)][Object]
+        $componentsJsonContent,
+        [Parameter(Mandatory = $true)][Object]
+        $windowsSettingsContent
+    )
+
+    $items = GetComponentsFromComponentsJson $componentsJsonContent
+    $packages = GetPackagesFromComponentsJson $componentsJsonContent
+    $regKeys = GetRegKeysToApply $windowsSettingsContent
+
+    foreach ($packageName in $packages.keys) {
+        foreach ($package in $packages[$packageName]) {
+            $items += $packageName + ": " + $package
+        }
+    }
+
+    foreach ($regKey in $regKeys) {
+        $items += $regKey.Path + "\" + $regKey.Name + "=" + $regKey.Value
+    }
+
+    return ($items | Sort-Object)
 }

vhdbuilder/packer/windows/components_json_helpers.tests.ps1

@@ -33,6 +33,109 @@ Describe 'SafeReplaceString' {
 
 
 
+Describe 'Tests of GetAllCachedThings ' {
+    BeforeEach {
+        $windowsSettingsTestString = '{
+"WindowsBaseVersions": {
+"2019": {
+  "base_image_sku": "2019-Datacenter-Core-smalldisk",
+  "windows_image_name": "windows-2019",
+  "base_image_version": "17763.6893.250210",
+  "patches_to_apply": [{"id": "patchid", "url": "patch_url"}]
+},
+ "23H2-gen2": {
+  "base_image_sku": "2019-Datacenter-Core-smalldisk",
+  "windows_image_name": "windows-2019",
+  "base_image_version": "17763.6893.250210",
+  "patches_to_apply": [{"id": "patchid", "url": "patch_url"}]
+}
+},
+  "WindowsRegistryKeys": [
+    {
+      "Comment": "Enables DNS resolution of SMB shares for containerD:  # https://github.com/kubernetes-sigs/windows-gmsa/issues/30#issuecomment-802240945",
+      "WindowsSkuMatch": "*",
+      "Path": "HKLM:\\SYSTEM\\CurrentControlSet\\Services\\hns\\State",
+      "Name": "EnableCompartmentNamespace",
+      "Value": "1",
+      "Type": "DWORD"
+    }
+  ]
+}'
+        $windowsSettings = echo $windowsSettingsTestString | ConvertFrom-Json
+
+        $componentsJsonTestString = '{
+        "ContainerImages": [
+{
+  "downloadURL": "mcr.microsoft.com/container/with/seperate/win/and/linux/versions:*",
+  "amd64OnlyVersions": [],
+  "multiArchVersionsV2": [],
+  "windowsVersions": [
+    {
+      "renovateTag": "registry=https://mcr.microsoft.com, name=oss/kubernetes/pause",
+      "latestVersion": "win-version"
+    },{
+      "renovateTag": "registry=https://mcr.microsoft.com, name=oss/kubernetes/pause",
+      "latestVersion": "other-version"
+    }
+  ]
+}],
+"Packages": [
+{
+  "windowsDownloadLocation": "c:\\akse-cache\\",
+  "downloadLocation": null,
+  "downloadUris": {
+    "windows": {
+      "default": {
+        "versionsV2": [
+          {
+            "renovateTag": "<DO_NOT_UPDATE>",
+            "latestVersion": "0.0.50",
+            "previousLatestVersion": "0.0.51"
+          }
+        ],
+        "downloadURL": "https://acs-mirror.azureedge.net/aks/windows/cse/aks-windows-cse-scripts-v${version}.zip"
+      }
+    }
+  }
+}
+]}'
+        $componentsJson = echo $componentsJsonTestString | ConvertFrom-Json
+    }
+
+    it 'has a component in it' {
+        $windowsSku = "2019-containerd"
+
+        $allpackages = GetAllCachedThings $componentsJson $windowsSettings
+
+        $allpackages | Should -Contain "mcr.microsoft.com/container/with/seperate/win/and/linux/versions:win-version"
+    }
+
+    it 'has a package in it' {
+        $windowsSku = "2019-containerd"
+
+        $allpackages = GetAllCachedThings $componentsJson $windowsSettings
+
+        $allpackages | Should -Contain "c:\akse-cache\: https://acs-mirror.azureedge.net/aks/windows/cse/aks-windows-cse-scripts-v0.0.50.zip"
+    }
+
+    it 'has a reg key in it' {
+        $windowsSku = "2019-containerd"
+
+        $allpackages = GetAllCachedThings $componentsJson $windowsSettings
+
+        $allpackages | Should -Contain "HKLM:\SYSTEM\CurrentControlSet\Services\hns\State\EnableCompartmentNamespace=1"
+    }
+
+    it 'is sorted' {
+        $windowsSku = "2019-containerd"
+
+        $allpackages = GetAllCachedThings $componentsJson $windowsSettings
+
+        $allpackages | Should -Be ( $allpackages | Sort-Object )
+    }
+}
+
+
 Describe 'GetWindowsDefenderInfo' {
     BeforeEach {
         $testString = '{
@@ -560,7 +663,7 @@ Describe 'Gets The Versions' {
         )
         $componentsJson.ContainerImages[0].downloadURL = "mcr.microsoft.com/oss/kubernetes/autoscaler/`${CPU_ARCH}/addon-resizer:*"
 
-        $CPU_ARCH="x86"
+        $CPU_ARCH = "x86"
         $components = GetComponentsFromComponentsJson $componentsJson
 
         $components | Should -HaveCount 1
@@ -575,7 +678,7 @@ Describe 'Gets The Versions' {
         )
         $componentsJson.ContainerImages[0].downloadURL = "mcr.microsoft.com/oss/kubernetes/autoscaler/`${varvarvar}/addon-resizer:*"
 
-        $varvarvar="x86"
+        $varvarvar = "x86"
         $components = GetComponentsFromComponentsJson $componentsJson
 
         $components | Should -HaveCount 1

vhdbuilder/scripts/windows/generate_cached_stuff_list.ps1

@@ -0,0 +1,65 @@
+
+param(
+    [string]
+    $outputDirParam,
+    [string]
+    $helpersFileParam,
+    [string]
+    $windowsSettingsFileParam,
+    [string]
+    $componentsJsonFileParam
+)
+
+$HelpersFile = "vhdbuilder/packer/windows/components_json_helpers.ps1"
+$WindowsSettingsFile = "vhdbuilder/packer/windows/windows_settings.json"
+$ComponentsJsonFile = "parts/common/components.json"
+$outputDir = "temp"
+
+if (![string]::IsNullOrEmpty($outputDirParam))
+{
+    Write-Output "Setting output dir to to to $outputDirParam"
+    $outputDir = $outputDirParam
+} else {
+    Write-Output "using default output dir: $outputDir"
+}
+
+if (![string]::IsNullOrEmpty($helpersFileParam))
+{
+    Write-Output "Setting helpers file to $helpersFileParam"
+    $HelpersFile = $helpersFileParam
+} else {
+    Write-Output "using default helpers file: $HelpersFile"
+}
+
+if (![string]::IsNullOrEmpty($windowsSettingsFileParam))
+{
+    Write-Output "Setting windows settings file to $windowsSettingsFileParam"
+    $WindowsSettingsFile = $windowsSettingsFileParam
+} else {
+    Write-Output "using default windows settings: $WindowsSettingsFile"
+}
+
+if (![string]::IsNullOrEmpty($componentsJsonFileParam))
+{
+    Write-Output "Setting components json file to to $componentsJsonFileParam"
+    $ComponentsJsonFile = $componentsJsonFileParam
+} else {
+    Write-Output "using default components json: $ComponentsJsonFile"
+}
+
+. "$HelpersFile"
+
+$componentsJson = Get-Content $ComponentsJsonFile | Out-String | ConvertFrom-Json
+$windowsSettingsJson = Get-Content $WindowsSettingsFile | Out-String | ConvertFrom-Json
+$BaseVersions = GetWindowsBaseVersions $windowsSettingsJson
+
+foreach ($WindowsSku in $BaseVersions)
+{
+    $cachedThings = GetAllCachedThings $componentsJson $windowsSettingsJson
+
+    $fileName = "${outputDir}/${WindowsSku}.txt"
+    Write-Output "Creating file $fileName"
+    Write-Output $WindowsSku > $fileName
+
+    echo $cachedThings | ConvertTo-Json | Write-Output >> $fileName
+}