From 03a990188a1a846c1dcff904ceea309a63f5a0ff Mon Sep 17 00:00:00 2001 From: John Chittum Date: Tue, 10 Nov 2020 12:50:32 -0600 Subject: [PATCH 1/3] Backport vmtools version in vmdk (LP: #1893898) Backport LP: #1893898 describes missing vmtools version from the vmdk headers. The version should be added as ddb.toolsVersion = "2147483647" however the sed was no longer replacing a ddb.comment field with the tools version. Rather than subbing ddb.comment with toolsVersion, this commit deletes ddb.comment (which the comment mentions could cause errors), and adds the correct value. There was no visibility into the descriptor during hook creation, so debug statements were added. This allows us to quickly verify in the logs that bad statements are removed (the possibly offending comments), as well as ensuring that the toolsVersion is added --- live-build/functions | 47 ++++++++++++++++++++++++-------------------- 1 file changed, 26 insertions(+), 21 deletions(-) diff --git a/live-build/functions b/live-build/functions index 6f02277d..0f4eb8df 100644 --- a/live-build/functions +++ b/live-build/functions @@ -206,28 +206,33 @@ modify_vmdk_header() { # Extract the vmdk header for manipulation dd if="${vmdk_name}" of="${descriptor}" bs=1 skip=512 count=1024 + echo "Cat'ing original vmdk disk descriptor to console for debugging." + # cat header so we are aware of the original descriptor for debugging + cat $descriptor - # The sed lines below is where the magic is. Specifically: - # ddb.toolsVersion: sets the open-vm-tools so that VMware shows - # the tooling as current - # ddb.virtualHWVersion: set the version to 7, which covers most - # current versions of VMware - # createType: make sure its set to stream Optimized - # remove the vmdk-stream-converter comment and replace with - # # Disk DescriptorFile. This is needed for Virtualbox - # remove the comments from vmdk-stream-converter which causes - # VirtualBox and others to fail VMDK validation - - sed -e 's|# Description file.*|# Disk DescriptorFile|' \ - -e '/# Believe this is random*/d' \ - -e '/# Indicates no parent/d' \ - -e '/# The Disk Data Base/d' \ - -e 's|ddb.comment.*|ddb.toolsVersion = "2147483647"|' \ - "${descriptor}" > "${newdescriptor}" - - # The header is cannot be bigger than 1024 - expr $(stat --format=%s ${newdescriptor}) \< 1024 > /dev/null 2>&1 || { - echo "descriptor is too large, VMDK will be invalid!"; exit 1; } + # trim null bytes to treat as standard text file + tr -d '\000' < $descriptor > $newdescriptor + + # add newline to newdescriptor + echo "" >> $newdescriptor + + # add required tools version + echo -n 'ddb.toolsVersion = "2147483647"' >> $newdescriptor + + # diff original descriptor and new descriptor for debugging + # diff exits 1 if difference. pipefail not set so piping diff + # to cat prints diff and swallows exit 1 + echo "Printing diff of original and new descriptors." + diff --text $descriptor $newdescriptor | cat + + # The header must be 1024 or less before padding + if ! expr $(stat --format=%s ${newdescriptor}) \< 1025 > /dev/null 2>&1; then + echo "descriptor is too large, VMDK will be invalid!"; + exit 1 + fi + + # reset newdescriptor to be 1024 + truncate --no-create --size=1K $newdescriptor # Overwrite the vmdk header with our new, modified one dd conv=notrunc,nocreat \ From 45abf7c253a816b11711e89d0267a31b0ddc8cd2 Mon Sep 17 00:00:00 2001 From: John Chittum Date: Tue, 17 Nov 2020 14:54:54 -0600 Subject: [PATCH 2/3] re-add sed command Older version of vmdk-stream-converter has an incorrect header. The original sed command replaced the incorrect "Description File" comment with the correct "Disk DescriptorFile". --- live-build/functions | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/live-build/functions b/live-build/functions index 0f4eb8df..fa4bfd10 100644 --- a/live-build/functions +++ b/live-build/functions @@ -213,12 +213,25 @@ modify_vmdk_header() { # trim null bytes to treat as standard text file tr -d '\000' < $descriptor > $newdescriptor + # remove the vmdk-stream-converter comment and replace with + # # Disk DescriptorFile. This is needed for Virtualbox + # remove the comments from vmdk-stream-converter which causes + # VirtualBox and others to fail VMDK validation + sed -i -e 's|# Description file.*|# Disk DescriptorFile|' \ + -e '/# Believe this is random*/d' \ + -e '/# Indicates no parent/d' \ + -e '/# The Disk Data Base/d' \ + ${newdescriptor} + # add newline to newdescriptor echo "" >> $newdescriptor # add required tools version echo -n 'ddb.toolsVersion = "2147483647"' >> $newdescriptor + echo "Cat'ing modified descriptor for debugging." + cat $newdescriptor + # diff original descriptor and new descriptor for debugging # diff exits 1 if difference. pipefail not set so piping diff # to cat prints diff and swallows exit 1 From 183466629b5b2f0f27747ed01b4c2a6daa1951b8 Mon Sep 17 00:00:00 2001 From: John Chittum Date: Wed, 18 Nov 2020 11:36:00 -0600 Subject: [PATCH 3/3] Open and update changelog Open new version, add changelog description --- debian/changelog | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/debian/changelog b/debian/changelog index ea0ac0e8..873fcb90 100644 --- a/debian/changelog +++ b/debian/changelog @@ -1,3 +1,9 @@ +livecd-rootfs (2.525.48) UNRELEASED; urgency=medium + + * Ensure vmtools version entered into vmdk header (LP: #1893898) + + -- John Chittum Wed, 18 Nov 2020 11:35:00 -0600 + livecd-rootfs (2.525.47) bionic; urgency=medium * Apparently the lxd appliance needs to use a custom track (4.0) and since