chore(deps): added base_image_publisher and base_image_offer fields for windows_settings.json (#7998)

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
former name: chore(deps): add publisherID and offerID to WS2022 config for new image

Author: janenotjung-hue

schemas/windows_settings.cue

@@ -19,12 +19,14 @@
 #WindowsPatches: [...#WindowsPatch]
 
 #WindowsBaseVersion: {
-  comment?:           string
-  os_disk_size:      string
-  base_image_sku:     string,
-  base_image_version: string
-  windows_image_name: string
-  patches_to_apply:   #WindowsPatches
+  comment?:              string
+  os_disk_size:          string
+  base_image_publisher?: string
+  base_image_offer?:     string
+  base_image_sku:        string
+  base_image_version:    string
+  windows_image_name:    string
+  patches_to_apply:      #WindowsPatches
 }
 
 #WindowsComments: [...string]

vhdbuilder/packer/produce-packer-settings-functions.sh

@@ -268,6 +268,20 @@ function prepare_windows_vhd() {
 	WINDOWS_IMAGE_VERSION=$(jq -r ".WindowsBaseVersions.\"${WINDOWS_SKU}\".base_image_version" <$CDIR/windows/windows_settings.json)
 	WINDOWS_IMAGE_NAME=$(jq -r ".WindowsBaseVersions.\"${WINDOWS_SKU}\".windows_image_name" <$CDIR/windows/windows_settings.json)
 	OS_DISK_SIZE=$(jq -r ".WindowsBaseVersions.\"${WINDOWS_SKU}\".os_disk_size" <$CDIR/windows/windows_settings.json)
+
+	local sku_publisher
+	if sku_publisher=$(jq -re ".WindowsBaseVersions.\"${WINDOWS_SKU}\".base_image_publisher" <$CDIR/windows/windows_settings.json); then
+		if [ -n "${sku_publisher}" ] && [ "${sku_publisher}" != "null" ]; then
+			WINDOWS_IMAGE_PUBLISHER="${sku_publisher}"
+		fi
+	fi
+	local sku_offer
+	if sku_offer=$(jq -re ".WindowsBaseVersions.\"${WINDOWS_SKU}\".base_image_offer" <$CDIR/windows/windows_settings.json); then
+		if [ -n "${sku_offer}" ] && [ "${sku_offer}" != "null" ]; then
+			WINDOWS_IMAGE_OFFER="${sku_offer}"
+		fi
+	fi
+
 	if [ "null" != "${OS_DISK_SIZE}" ]; then
 		echo "Setting os_disk_size_gb to the value in windows-settings.json for ${WINDOWS_SKU}: ${OS_DISK_SIZE}"
 		os_disk_size_gb=${OS_DISK_SIZE}
@@ -278,6 +292,8 @@ function prepare_windows_vhd() {
 	imported_windows_image_name="${WINDOWS_IMAGE_NAME}-imported-${CREATE_TIME}-${RANDOM}"
 
 	echo "Got base image data: "
+	echo "  WINDOWS_IMAGE_PUBLISHER: ${WINDOWS_IMAGE_PUBLISHER}"
+	echo "  WINDOWS_IMAGE_OFFER: ${WINDOWS_IMAGE_OFFER}"
 	echo "  WINDOWS_IMAGE_SKU: ${WINDOWS_IMAGE_SKU}"
 	echo "  WINDOWS_IMAGE_VERSION: ${WINDOWS_IMAGE_VERSION}"
 	echo "  WINDOWS_IMAGE_NAME: ${WINDOWS_IMAGE_NAME}"

vhdbuilder/packer/windows/components_json_helpers.ps1

@@ -391,8 +391,27 @@ function GetAllCachedThings {
     $ociArtifacts = GetOCIArtifactsFromComponentsJson $componentsJsonContent
     $regKeys = GetRegKeysToApply $windowsSettingsContent
     $baseVersion =  GetWindowsBaseVersion -windowsSku $windowsSku -windowsSettingsContent $windowsSettingsContent
+    $baseVersionBlock = $windowsSettingsContent.WindowsBaseVersions."$windowsSku"
 
     $items += "Windows ${windowsSku} base version: ${baseVersion}"
+    if ($baseVersionBlock -ne $null) {
+        $items += "Windows ${windowsSku} base image sku: $($baseVersionBlock.base_image_sku)"
+        $items += "Windows ${windowsSku} os disk size: $($baseVersionBlock.os_disk_size)"
+
+        if (-not [string]::IsNullOrEmpty($baseVersionBlock.base_image_publisher)) {
+            $items += "Windows ${windowsSku} base image publisher: $($baseVersionBlock.base_image_publisher)"
+        }
+        if (-not [string]::IsNullOrEmpty($baseVersionBlock.base_image_offer)) {
+            $items += "Windows ${windowsSku} base image offer: $($baseVersionBlock.base_image_offer)"
+        }
+    }
+
+    $patchInfo = GetPatchInfo -windowsSku $windowsSku -windowsSettingsContent $windowsSettingsContent
+    if ($patchInfo -ne $null -and $patchInfo.Count -gt 0) {
+        foreach ($patch in $patchInfo) {
+            $items += "Windows ${windowsSku} patch: $($patch.id) $($patch.url)"
+        }
+    }
 
     foreach ($packageName in $packages.keys) {
         foreach ($package in $packages[$packageName]) {

vhdbuilder/packer/windows/components_json_helpers.tests.ps1

@@ -38,12 +38,16 @@ Describe 'Tests of GetAllCachedThings ' {
         $windowsSettingsTestString = '{
 "WindowsBaseVersions": {
 "2019": {
+  "os_disk_size": "35",
+  "base_image_publisher": "MicrosoftWindowsServer",
+  "base_image_offer": "WindowsServer",
   "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": {
+  "os_disk_size": "40",
   "base_image_sku": "2019-Datacenter-Core-smalldisk",
   "windows_image_name": "windows-2019",
   "base_image_version": "17763.6893.250210",
@@ -161,6 +165,54 @@ Describe 'Tests of GetAllCachedThings ' {
 
         $allpackages | Should -Be ( $allpackages | Sort-Object )
     }
+
+    it 'has the base image sku in it' {
+        $windowsSku = "2019"
+
+        $allpackages = GetAllCachedThings $componentsJson $windowsSettings
+
+        $allpackages | Should -Contain "Windows 2019 base image sku: 2019-Datacenter-Core-smalldisk"
+    }
+
+    it 'has the os disk size in it' {
+        $windowsSku = "2019"
+
+        $allpackages = GetAllCachedThings $componentsJson $windowsSettings
+
+        $allpackages | Should -Contain "Windows 2019 os disk size: 35"
+    }
+
+    it 'has the base image publisher when set' {
+        $windowsSku = "2019"
+
+        $allpackages = GetAllCachedThings $componentsJson $windowsSettings
+
+        $allpackages | Should -Contain "Windows 2019 base image publisher: MicrosoftWindowsServer"
+    }
+
+    it 'has the base image offer when set' {
+        $windowsSku = "2019"
+
+        $allpackages = GetAllCachedThings $componentsJson $windowsSettings
+
+        $allpackages | Should -Contain "Windows 2019 base image offer: WindowsServer"
+    }
+
+    it 'does not have base image publisher when not set' {
+        $windowsSku = "23H2-gen2"
+
+        $allpackages = GetAllCachedThings $componentsJson $windowsSettings
+
+        ($allpackages | Where-Object { $_ -like "Windows 23H2-gen2 base image publisher:*" }) | Should -BeNullOrEmpty
+    }
+
+    it 'does not have base image offer when not set' {
+        $windowsSku = "23H2-gen2"
+
+        $allpackages = GetAllCachedThings $componentsJson $windowsSettings
+
+        ($allpackages | Where-Object { $_ -like "Windows 23H2-gen2 base image offer:*" }) | Should -BeNullOrEmpty
+    }
 }
 
 

vhdbuilder/packer/windows/windows_settings.json

@@ -15,13 +15,17 @@
   "WindowsBaseVersions": {
     "2022-containerd": {
       "os_disk_size": "35",
+      "base_image_publisher": "MicrosoftWindowsServer",
+      "base_image_offer": "windowsserver2022",
       "base_image_sku": "2022-Datacenter-Core-smalldisk",
       "windows_image_name": "windows-2022-containerd",
       "base_image_version": "20348.4893.260303",
       "patches_to_apply": []
     },
     "2022-containerd-gen2": {
       "os_disk_size": "35",
+      "base_image_publisher": "MicrosoftWindowsServer",
+      "base_image_offer": "windowsserver2022",
       "base_image_sku": "2022-datacenter-core-smalldisk-g2",
       "windows_image_name": "windows-2022-containerd",
       "base_image_version": "20348.4893.260303",
@@ -746,4 +750,4 @@
       "Type": "DWORD"
     }
   ]
-}
+}