Merge ~rodsmith/plainbox-provider-certification-server:fix-arm64-virt into plainbox-provider-certification-server:master

[Rod Smith]

If KVM_IMAGE in /etc/xdg/canonical-certification.conf points to a non-.img file, don't attempt to verify its validity in canonical-certification-precheck; instead, accept it as valid but issue a warning. This fixes a problem in that the precheck script would reject such files, which are used on ARM64 and ARMHF platforms.

This fix is a bit half-done, in that it would be better to extract the .img file from the tarball and verify it, or at least accept tarballs only on the platforms that use them; but the problem case seems to be pretty limited, and this is just the precheck script, not Checkbox itself, so writing a lot more code seems pointless.

This diff looks bigger than it is; I had problems with inconsistent formatting (tabs vs. spaces), which ended up growing the diff.

[Jeff Lane  (bladernr)]

FWIW, if you are using Vim, set the tab to be 4 spaces (as opposed to a single tab char):

set tabstop=4
set shiftwidth=4
set expandtab
set softtabstop=4

This way a "tab" is always a consistent 4 characters. Bash doesn't complain like Python will about inconsistency between tabs and spaces.

[Jeff Lane  (bladernr)]

More germaine, when are we using files that don't in with IMG for KVM testing?

the KVM images come from cloud-images.ubuntu.com, and there are clearly .IMG cloud images available for ARM64 and armhf:

http://cloud-images.ubuntu.com/xenial/current/xenial-server-cloudimg-arm64-disk1.img
http://cloud-images.ubuntu.com/xenial/current/xenial-server-cloudimg-armhf-disk1.img
http://cloud-images.ubuntu.com/artful/current/artful-server-cloudimg-arm64.img
http://cloud-images.ubuntu.com/artful/current/artful-server-cloudimg-armhf.img

review: Needs Information

[Jeff Lane  (bladernr)]

Thanks, the email tied these all together, makes more sense now.

review: Approve

diff --git a/tools/canonical-certification-precheck b/tools/canonical-certification-precheck
index 67ac2a1..c87c2ae 100755
--- a/tools/canonical-certification-precheck
+++ b/tools/canonical-certification-precheck
@@ -296,78 +296,85 @@ KVM_Image_Check(){
 name="KVM Image Check"
 echoname
 if grep "^KVM_IMAGE =" /etc/xdg/canonical-certification.conf >/dev/null; then
-	kvmurl=$(grep ^KVM_IMAGE /etc/xdg/canonical-certification.conf|awk '{print $3}')
-	/usr/bin/qemu-img check $kvmurl >/dev/null 2>&1
-	if [ $? = "0" ]; then
- 		echo -e " $kvmurl is a valid image.\n Continuing to use this image"
- 		pass
-		return 0
-	else
-		echo -e " $kvmurl is not a valid image.\n Would you like to reconfigure it now? [Y/n]"
-         	read -s -N1 a
-         	if [[ $a == "Y" || $a == "y" || -z $a ]]; then
-               		read -e -p " Enter the path of your KVM Image: " kvm 
-               		sudo sed -i "s,KVM_IMAGE =.*,KVM_IMAGE = $kvm,g" /etc/xdg/canonical-certification.conf
-	 		kvmurl=$(grep ^KVM_IMAGE /etc/xdg/canonical-certification.conf|awk '{print $3}')
-			/usr/bin/qemu-img check $kvmurl >/dev/null 2>&1
-			if [ $? = "0" ]; then
- 				echo -e " $kvmurl is a valid image.\n Continuing to use this image"
- 				pass
-				return 0
-			else
- 				echo -e " We cannot get our image from $kvmurl.\n Marking as failed."
-				fail
-				return 0
-			fi
-		else
-			echo -e " Leaving configuration but commenting out.\n Trying cloud image."
-			sudo sed -i '/^KVM_IMAGE/ s/^#*/#/' /etc/xdg/canonical-certification.conf
-		fi
-	fi
+    kvmurl=$(grep ^KVM_IMAGE /etc/xdg/canonical-certification.conf|awk '{print $3}')
+    if [[ "$kvmurl" =~ .*\.img$ ]] ; then
+        /usr/bin/qemu-img check $kvmurl >/dev/null 2>&1
+        if [ $? = "0" ]; then
+            echo -e " $kvmurl is a valid image.\n Continuing to use this image"
+            pass
+            return 0
+        else
+            echo -e " $kvmurl is not a valid image.\n Would you like to reconfigure it now? [Y/n]"
+            read -s -N1 a
+            if [[ $a == "Y" || $a == "y" || -z $a ]]; then
+                read -e -p " Enter the path of your KVM Image: " kvm
+                sudo sed -i "s,KVM_IMAGE =.*,KVM_IMAGE = $kvm,g" /etc/xdg/canonical-certification.conf
+                kvmurl=$(grep ^KVM_IMAGE /etc/xdg/canonical-certification.conf|awk '{print $3}')
+                /usr/bin/qemu-img check $kvmurl >/dev/null 2>&1
+                if [ $? = "0" ]; then
+                    echo -e " $kvmurl is a valid image.\n Continuing to use this image"
+                    pass
+                    return 0
+                else
+                    echo -e " We cannot get our image from $kvmurl.\n Marking as failed."
+                    fail
+                    return 0
+                fi
+            else
+                echo -e " Leaving configuration but commenting out.\n Trying cloud image."
+                sudo sed -i '/^KVM_IMAGE/ s/^#*/#/' /etc/xdg/canonical-certification.conf
+            fi
+        fi
+    else # URL does not end in ".img". No way to test, so pass it and hope for the best....
+        echo -e " $kvmurl is not a\n .img file, so its validity can't be tested."
+        warn
+        eval info${i}=\"Unable to test\"
+        return 0
+    fi
 
 else
-	echo -e " KVM_IMAGE is not configured.\n Note: If left unconfigured, we will pull our image from cloud-images.ubuntu.com.\n Would you like to configure it now? [Y/n]"
-       	read -s -N1 a
-       	if [[ $a == "Y" || $a == "y" || -z $a ]]; then
-       		read -e -p " Enter the path of your KVM Image: " kvm 
-       		sudo sed -i "s,#KVM_IMAGE =.*,KVM_IMAGE = $kvm,g" /etc/xdg/canonical-certification.conf
-		kvmurl=$(grep ^KVM_IMAGE /etc/xdg/canonical-certification.conf|awk '{print $3}')
-		/usr/bin/qemu-img check $kvmurl >/dev/null 2>&1
-		if [ $? = "0" ]; then
- 			echo -e " $kvmurl is a valid image.\n Continuing to use this image"
- 			pass
-			return 0
-		else
-			echo -e "\n $kvmurl is not a valid image.\n Would you like to reconfigure it now? [Y/n]"
-         		read -s -N1 a
-         		if [[ $a == "Y" || $a == "y" || -z $a ]]; then
-               			read -e -p " Enter the path of your KVM Image: " kvm 
-               			sudo sed -i "s,KVM_IMAGE =.*,KVM_IMAGE = $kvm,g" /etc/xdg/canonical-certification.conf
-	 			kvmurl=$(grep ^KVM_IMAGE /etc/xdg/canonical-certification.conf|awk '{print $3}')
-				/usr/bin/qemu-img check $kvmurl >/dev/null 2>&1
-				if [ $? = "0" ]; then
- 					echo -e " $kvmurl is a valid image.\n Continuing to use this image"
- 					pass
-					return 0
-				else
-					echo -e " Leaving configuration but commenting out.\n Trying cloud image."
-					sudo sed -i '/^KVM_IMAGE/ s/^#*/#/' /etc/xdg/canonical-certification.conf
-				fi
-			else
-				echo -e " Leaving configuration but commenting out.\n Trying cloud image."
-				sudo sed -i '/^KVM_IMAGE/ s/^#*/#/' /etc/xdg/canonical-certification.conf
-			fi
-		fi
-	fi
+    echo -e " KVM_IMAGE is not configured.\n Note: If left unconfigured, we will pull our image from\n cloud-images.ubuntu.com.\n Would you like to configure it now? [Y/n]"
+    read -s -N1 a
+    if [[ $a == "Y" || $a == "y" || -z $a ]]; then
+        read -e -p " Enter the path of your KVM Image: " kvm
+        sudo sed -i "s,#KVM_IMAGE =.*,KVM_IMAGE = $kvm,g" /etc/xdg/canonical-certification.conf
+        kvmurl=$(grep ^KVM_IMAGE /etc/xdg/canonical-certification.conf|awk '{print $3}')
+        /usr/bin/qemu-img check $kvmurl >/dev/null 2>&1
+        if [ $? = "0" ]; then
+            echo -e " $kvmurl is a valid image.\n Continuing to use this image"
+            pass
+            return 0
+        else
+            echo -e "\n $kvmurl is not a valid image.\n Would you like to reconfigure it now? [Y/n]"
+            read -s -N1 a
+            if [[ $a == "Y" || $a == "y" || -z $a ]]; then
+                read -e -p " Enter the path of your KVM Image: " kvm
+                sudo sed -i "s,KVM_IMAGE =.*,KVM_IMAGE = $kvm,g" /etc/xdg/canonical-certification.conf
+                kvmurl=$(grep ^KVM_IMAGE /etc/xdg/canonical-certification.conf|awk '{print $3}')
+                /usr/bin/qemu-img check $kvmurl >/dev/null 2>&1
+                if [ $? = "0" ]; then
+                    echo -e " $kvmurl is a valid image.\n Continuing to use this image"
+                    pass
+                    return 0
+                else
+                    echo -e " Leaving configuration but commenting out.\n Trying cloud image."
+                    sudo sed -i '/^KVM_IMAGE/ s/^#*/#/' /etc/xdg/canonical-certification.conf
+                fi
+            else
+                echo -e " Leaving configuration but commenting out.\n Trying cloud image."
+                sudo sed -i '/^KVM_IMAGE/ s/^#*/#/' /etc/xdg/canonical-certification.conf
+            fi
+        fi
+    fi
 fi
 kvmurl="http://cloud-images.ubuntu.com/$codename/current/$codename-server-cloudimg-$arch-disk1.img"
 if curl --output /dev/null --silent --head -fail "$kvmurl"; then
- 	echo -e " We can get our image from $kvmurl.\n Continuing to use this image"
-		pass
-	else
-		echo -e " We cannot get our image from $kvmurl.\n Marking as failed"
-		fail
-	fi
+    echo -e " We can get our image from $kvmurl.\n Continuing to use this image"
+    pass
+else
+    echo -e " We cannot get our image from $kvmurl.\n Marking as failed"
+    fail
+fi
 }
 
 # Check local availability of LXD images or pull from Internet, which tends to be slow