[Release 1.0] Add support for 4096 byte sector size input base images (…

…#462) Added support for 4096 byte sector size input base images (#448) * Added support for 4096 byte sector size input base images * Fixing tests * Fixing RAW_FILE misplacement Co-authored-by: Rhys Oxenham <[email protected]>
suse-edge · Jun 3, 2024 · 5eaeada · 5eaeada
1 parent 09c5508
commit 5eaeada
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 6 deletions.
diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
@@ -4,6 +4,7 @@
 
 ## General
 
+* Added the ability to consume both 512/4096 byte sector size disk input base-images
 * Added version command and version marker on CRB images
 
 ## API
@@ -16,6 +17,7 @@
 
 * [#442](https://github.com/suse-edge/edge-image-builder/issues/442) - Only get images from specific Kubernetes objects
 * [#429](https://github.com/suse-edge/edge-image-builder/issues/429) - Automatically set execute bit on scripts
+* [#447](https://github.com/suse-edge/edge-image-builder/issues/447) - Support >512 byte sector size base images
 
 ---
 

diff --git a/pkg/build/raw_test.go b/pkg/build/raw_test.go
@@ -72,7 +72,7 @@ func TestWriteModifyScript(t *testing.T) {
 			includeCombustion: true,
 			renameFilesystem:  true,
 			expectedContains: []string{
-				fmt.Sprintf("guestfish --format=raw --rw -a %s", outputImageFilename),
+				fmt.Sprintf("guestfish --blocksize=$BLOCKSIZE --format=raw --rw -a %s", outputImageFilename),
 				fmt.Sprintf("copy-in %s", builder.context.CombustionDir),
 				"download /boot/grub2/grub.cfg /tmp/grub.cfg",
 				"btrfs filesystem label / INSTALL",
@@ -87,7 +87,7 @@ func TestWriteModifyScript(t *testing.T) {
 			includeCombustion: false,
 			renameFilesystem:  false,
 			expectedContains: []string{
-				fmt.Sprintf("guestfish --format=raw --rw -a %s", outputImageFilename),
+				fmt.Sprintf("guestfish --blocksize=$BLOCKSIZE --format=raw --rw -a %s", outputImageFilename),
 				"download /boot/grub2/grub.cfg /tmp/grub.cfg",
 				"sed -i '/ignition.platform/ s/$/ alpha beta /' /tmp/grub.cfg",
 			},

diff --git a/pkg/build/templates/modify-raw-image.sh.tpl b/pkg/build/templates/modify-raw-image.sh.tpl
@@ -13,6 +13,13 @@ set -euo pipefail
 #
 # Guestfish Command Documentation: https://libguestfs.org/guestfish.1.html
 
+# Test the block size of the base image and adapt to suit either 512/4096 byte images
+BLOCKSIZE=512
+if ! guestfish -i --blocksize=$BLOCKSIZE -a {{.ImagePath}} echo "[INFO] 512 byte sector check successful."; then
+        echo "[WARN] Failed to access image with 512 byte sector size, trying 4096 bytes."
+        BLOCKSIZE=4096
+fi
+
 # Resize the raw disk image to accommodate the users desired raw disk image size
 # This is also required if embedding content into /combustion, especially for airgap.
 # Should *only* execute if the user is building a raw disk image.
@@ -24,7 +31,7 @@ cp {{.ImagePath}}.expanded {{.ImagePath}}
 rm -f {{.ImagePath}}.expanded
 {{ end }}
 
-guestfish --format=raw --rw -a {{.ImagePath}} -i <<'EOF'
+guestfish --blocksize=$BLOCKSIZE --format=raw --rw -a {{.ImagePath}} -i <<'EOF'
   # Enables write access to the read only filesystem
   sh "btrfs property set / ro false"
 

diff --git a/pkg/rpm/resolver/templates/prepare-tarball.sh.tpl b/pkg/rpm/resolver/templates/prepare-tarball.sh.tpl
@@ -33,7 +33,23 @@ if [ `wc -w <<< $RAW_FILE` -ne 1 ]; then
 	exit 1
 fi
 
-virt-tar-out -a $RAW_FILE / - | pigz --best > $WORK_DIR/{{.ArchiveName}}
+# Test the block size of the base image and adapt to suit either 512/4096 byte images
+BLOCKSIZE=512
+if ! guestfish -i --blocksize=$BLOCKSIZE -a $RAW_FILE echo "[INFO] 512 byte sector check successful."; then
+        echo "[WARN] Failed to access image with 512 byte sector size, trying 4096 bytes."
+        BLOCKSIZE=4096
+fi
+
+virt-tar-out --blocksize=$BLOCKSIZE -a $RAW_FILE / - | pigz --best > $WORK_DIR/{{.ArchiveName}}
 {{ else }}
-virt-tar-out -a $IMG_PATH / - | pigz --best > $WORK_DIR/{{.ArchiveName}}
-{{ end }}
+
+# Test the block size of the base image and adapt to suit either 512/4096 byte images
+BLOCKSIZE=512
+if ! guestfish -i --blocksize=$BLOCKSIZE -a $IMG_PATH echo "[INFO] 512 byte sector check successful."; then
+        echo "[WARN] Failed to access image with 512 byte sector size, trying 4096 bytes."
+        BLOCKSIZE=4096
+fi
+
+virt-tar-out --blocksize=$BLOCKSIZE -a $IMG_PATH / - | pigz --best > $WORK_DIR/{{.ArchiveName}}
+
+{{ end }}