Update the SDK persistent disk test cases

This commit updates the SDK persistent disk test cases to use the new
psdk-test script that semi-automate the execution of these tests.

Signed-off-by: Luis Araujo <luis.araujo@collabora.co.uk>

test-cases/sdk-persistent-disk-etc.yaml

@@ -15,37 +15,53 @@ metadata:
   pre-conditions:
     - "Download the virtual machine image for the latest SDK release from:"
     - "~https://images.apertis.org/"
-    - "Make a note of release version e.g v2020dev0"
-    - "Create a virtual machine, and name it old-sdk or old-basesdk"
-    - "Create a Full Clone of the virtual machine and name the clone new-sdk or new-basesdk:"
-    - "~https://www.virtualbox.org/manual/ch01.html#clone"
+    - "Make a note of release version (e.g v2020dev0)"
     - "Instructions on how to use the SDK persistent workspace on VirtualBox:"
     - "~https://developer.apertis.org/latest/sdk-usage.html#persistent-workspace"
+    - "Clone the apertis-tests repository:"
+    - $ git clone https://gitlab.apertis.org/infrastructure/apertis-tests.git
+
   expected:
-    - "Changes made in the etc folder should get reflected in the new sdk"
+    - "1) Changes made in the /etc folder should get reflected in the new sdk."
+
+  notes:
+    - The psdk-test will ask for the Apertis image SSH password in order to
+      access the virtual machine during some stages.
+    - Sometimes the SSH connection might show the error "Connection reset by peer",
+      in such a case, please start again the test.
+    - The psdk-test starts and poweroff the virtual machine several times, if
+      something goes wrong during booting or turning off a VM, please manually
+      close and restart the virtual machine and continue executing the test.
+
 run:
   steps:
-    - "The following steps are for the SDK virtual machine named with old:"
-    - "Power on the virtual machine, and open a terminal"  
-    - "Create a file called 90proxy under /etc/apt/apt.conf.d and enter the IP of your OSD in the file"
-    - "Acquire::http::Proxy \"http://10.168.128.45:3128\";
-       Acquire::https::Proxy \"http://10.168.128.45:3128\";"
-    - "Power off the virtual machine"
-    - "On VirtualBox add the persistent disk to the SDK virtual machine:"
-    - "~https://developer.apertis.org/latest/sdk-usage.html#virtualbox-adding-the-persistent-disk-to-the-old-sdk"
-    - "Power on the virtual machine"
+    - "Execute the psdk-test script from the apertis-tests repository, passing the
+       image release, the path to the Apertis SDK VDI image and with test type
+       'etc', for example:"
+    - $ cd apertis-tests/psdk-test
+    - $ ./psdk-test etc <image_release> <apertis_sdk_image>.vdi
+    - "The psdk-test command will open an interactive session that can be used
+       to execute the test through different stages. The prompt should look like:"
+    - $ psdk-test>
+    - "Execute the first stage of the test entering 'r':"
+    - $ psdk-test> r
+    - The stage1 command will setup the test environment (create and clone VMs)
+      and also will execute any necessary step for the initialization of the test.
+      After execution of stage1, there should be a virtual machine running
+      named Apertis_OldSDK, proceed to the next step.
     - "Use psdk to initialize the empty disk and to configure the SDK to use it:"
-    - "~https://developer.apertis.org/latest/sdk-usage.html#preparing-the-persistent-disk-on-the-old-sdk"  
-    - "The SDK will reboot when the configuration is completed. After the reboot click on psdk icon again to confirm that the persistent disk is in use"
-    - "The psdk needs to include the configuration file on the persistent disk, to do that enter the following command on the terminal"
-    - " $ psdk -e /etc/apt/apt.conf.d/90proxy"
-    - "Power off the virtual machine"
-    - "The following steps are for the SDK virtual machine named with new"
-    - "On VirtualBox add the same persistent disk used on previous steps to the SDK virtual machine:"
-    - "~https://developer.apertis.org/latest/sdk-usage.html#virtualbox-adding-the-persistent-disk-to-the-new-sdk"
-    - "Power on the virtual machine"
+    - ~https://developer.apertis.org/latest/sdk-usage.html#preparing-the-persistent-disk-on-the-old-sdk
+    - "The SDK will reboot when the configuration is completed. After the reboot
+       click on psdk icon again to confirm that the persistent disk is in use."
+    - "Continue executing the second stage of the test:"
+    - $ psdk-test> r
+    - "After the execution of stage2, there should be a virtual machine running
+       named Apertis_NewSDK, proceed to the next step."
     - "Use psdk to configure the SDK to use the persistent disk:"
-    - "~https://developer.apertis.org/latest/sdk-usage.html#using-the-persistent-disk-on-the-new-sdk"
-    - "The SDK will reboot when the configuration is completed. After the reboot click on psdk icon again to confirm that the persistent disk is in use"  
-    - "Check that the 90proxy file is present under /etc/apt/apt.conf.d folder in the NEW SDK"
-    - "Power off the virtual machine"
+    - ~https://developer.apertis.org/latest/sdk-usage.html#using-the-persistent-disk-on-the-new-sdk
+    - The SDK will reboot when the configuration is completed. After the reboot
+      click on psdk icon again to confirm that the persistent disk is in use.
+    - "Execute the final stage:"
+    - $ psdk-test> r
+    - This will complete the execution of the test, please check that the expected
+      result is obtained.

test-cases/sdk-persistent-disk-home-user.yaml

@@ -15,35 +15,54 @@ metadata:
   pre-conditions:
     - "Download the virtual machine image for the latest SDK release from:"
     - "~https://images.apertis.org/"
-    - "Make a note of release version e.g v2020dev0"
-    - "Create a virtual machine, and name it old-sdk or old-basesdk"
-    - "Create a Full Clone of the virtual machine, and name the clone new-sdk or new-basesdk:"
-    - "~https://www.virtualbox.org/manual/ch01.html#clone"
+    - "Make a note of release version (e.g v2020dev0)"
     - "Instructions on how to use the SDK persistent workspace on VirtualBox:"
     - "~https://developer.apertis.org/latest/sdk-usage.html#persistent-workspace"
+    - "Clone the apertis-tests repository:"
+    - $ git clone https://gitlab.apertis.org/infrastructure/apertis-tests.git
 
-  expected: 
-    - "Changes made in the /home/user folder should get reflected in the new sdk" 
-run: 
+  expected:
+    - "1) Changes made in the /home/user folder should get reflected in the new
+       SDK."
+
+  notes:
+    - The psdk-test will ask for the Apertis image SSH password in order to
+      access the virtual machine during some stages.
+    - Sometimes the SSH connection might show the error "Connection reset by peer",
+      in such a case, please start again the test.
+    - The psdk-test starts and poweroff the virtual machine several times, if
+      something goes wrong during booting or turning off a VM, please manually
+      close and restart the virtual machine and continue executing the test.
+
+run:
   steps:
-    - "The following steps are for the SDK virtual machine named with old"
-    - "Power on the virtual machine, and open a terminal"
-    - "Create a file called test under /home/user folder and add some content in the same file"
-    - "Power off the virtual machine"
-    - "On VirtualBox add the persistent disk to the SDK virtual machine:"
-    - "~https://developer.apertis.org/latest/sdk-usage.html#virtualbox-adding-the-persistent-disk-to-the-old-sdk"
-    - "Power on the virtual machine"
+    - "Execute the psdk-test script from the apertis-tests repository, passing the
+       image release, the path to the Apertis SDK VDI image and with test type
+       'user', for example:"
+    - $ cd apertis-tests/psdk-test
+    - $ ./psdk-test user <image_release> <apertis_sdk_image>.vdi
+    - "The psdk-test command will open an interactive session that can be used
+       to execute the test through different stages. The prompt should look like:"
+    - $ psdk-test>
+    - "Execute the first stage of the test entering 'r':"
+    - $ psdk-test> r
+    - The stage1 command will setup the test environment (create and clone VMs)
+      and also will execute any necessary step for the initialization of the test.
+      After execution of stage1, there should be a virtual machine running
+      named Apertis_OldSDK, proceed to the next step.
     - "Use psdk to initialize the empty disk and to configure the SDK to use it:"
-    - "~https://developer.apertis.org/latest/sdk-usage.html#preparing-the-persistent-disk-on-the-old-sdk"
-    - "The SDK will reboot when the configuration is completed. After the reboot click on psdk icon again to confirm that the persistent disk is in use"
-    - "Power off the virtual machine"
-    - "The following steps are for the SDK virtual machine named with new"
-    - "On VirtualBox add the same persistent disk used on previous steps to the SDK virtual machine:"
-    - "~https://developer.apertis.org/latest/sdk-usage.html#virtualbox-adding-the-persistent-disk-to-the-new-sdk"
-    - "Power on the virtual machine"
+    - ~https://developer.apertis.org/latest/sdk-usage.html#preparing-the-persistent-disk-on-the-old-sdk
+    - "The SDK will reboot when the configuration is completed. After the reboot
+       click on psdk icon again to confirm that the persistent disk is in use."
+    - "Continue executing the second stage of the test:"
+    - $ psdk-test> r
+    - "After the execution of stage2, there should be a virtual machine running
+       named Apertis_NewSDK, proceed to the next step."
     - "Use psdk to configure the SDK to use the persistent disk:"
-    - "~https://developer.apertis.org/latest/sdk-usage.html#using-the-persistent-disk-on-the-new-sdk"
-    - "The SDK will reboot when the configuration is completed. After the reboot click on psdk icon again to confirm that the persistent disk is in use"
-    - "Check that the file called test is present in /home/user/test on the NEW SDK"
-    - "Power off the virtual machine"
-
+    - ~https://developer.apertis.org/latest/sdk-usage.html#using-the-persistent-disk-on-the-new-sdk
+    - The SDK will reboot when the configuration is completed. After the reboot
+      click on psdk icon again to confirm that the persistent disk is in use.
+    - "Execute the final stage:"
+    - $ psdk-test> r
+    - This will complete the execution of the test, please check that the expected
+      result is obtained.

test-cases/sdk-persistent-disk.yaml

@@ -15,40 +15,56 @@ metadata:
   pre-conditions:
     - "Download the virtual machine image for the latest SDK release from:"
     - "~https://images.apertis.org/"
-    - "Make a note of release version e.g v2020dev0"
-    - "Create a virtual machine, and name it old-sdk or old-basesdk"
-    - "Create a Full Clone of the virtual machine, and name the clone new-sdk or new-basesdk:"
-    - "~https://www.virtualbox.org/manual/ch01.html#clone"
+    - "Make a note of release version (e.g v2020dev0)"
     - "Instructions on how to use the SDK persistent workspace on VirtualBox:"
     - "~https://developer.apertis.org/latest/sdk-usage.html#persistent-workspace"
+    - "Clone the apertis-tests repository:"
+    - $ git clone https://gitlab.apertis.org/infrastructure/apertis-tests.git
 
   expected:
-    - "When attempting to confirm if the SDK is using the persistent disk psdk should indicate that 'This SDK is currently using the persistent disk'"
-    - "'ade sysroot update' should indicate that the installed version is already up-to-date."
+    - "1) When attempting to confirm if the SDK is using the persistent disk psdk
+       should indicate that 'This SDK is currently using the persistent disk'."
+    - "2) 'ade sysroot update' should indicate that the installed version is
+       already up-to-date."
+
+  notes:
+    - The psdk-test will ask for the Apertis image SSH password in order to
+      access the virtual machine during some stages.
+    - Sometimes the SSH connection might show the error "Connection reset by peer",
+      in such a case, please start again the test.
+    - The psdk-test starts and poweroff the virtual machine several times, if
+      something goes wrong during booting or turning off a VM, please manually
+      close and restart the virtual machine and continue executing the test.
 
 run:
   steps:
-    - "The following steps are for the SDK virtual machine named with old:"
-    - "Power on the virtual machine, and run on a terminal:"
-    - $ ade sysroot install --release <release version>
-    - "Power off the virtual machine"
-    - "On VirtualBox add the persistent disk to the SDK virtual machine:"
-    - "~https://developer.apertis.org/latest/sdk-usage.html#virtualbox-adding-the-persistent-disk-to-the-old-sdk"
-    - "Power on the virtual machine"
+    - "Execute the psdk-test script from the apertis-tests repository, passing the
+       image release, the path to the Apertis SDK VDI image and with test type
+       'sysroot', for example:"
+    - $ cd apertis-tests/psdk-test
+    - $ ./psdk-test sysroot <image_release> <apertis_sdk_image>.vdi
+    - "The psdk-test command will open an interactive session that can be used
+       to execute the test through different stages. The prompt should look like:"
+    - $ psdk-test>
+    - "Execute the first stage of the test entering 'r':"
+    - $ psdk-test> r
+    - The stage1 command will setup the test environment (create and clone VMs)
+      and also will execute any necessary step for the initialization of the test.
+      After execution of stage1, there should be a virtual machine running
+      named Apertis_OldSDK, proceed to the next step.
     - "Use psdk to initialize the empty disk and to configure the SDK to use it:"
-    - "~https://developer.apertis.org/latest/sdk-usage.html#preparing-the-persistent-disk-on-the-old-sdk"
-    - "The SDK will reboot when the configuration is completed. After the reboot click on psdk icon again to confirm that the persistent disk is in use"
-    - "Run on a terminal:"
-    - $ ade sysroot update --release <release version>
-    - "Power off the virtual machine"
-
-    - "The following steps are for the SDK virtual machine named with new:"
-    - "On VirtualBox add the same persistent disk used on previous steps to the SDK virtual machine:"
-    - "~https://developer.apertis.org/latest/sdk-usage.html#virtualbox-adding-the-persistent-disk-to-the-new-sdk"
-    - "Power on the virtual machine"
+    - ~https://developer.apertis.org/latest/sdk-usage.html#preparing-the-persistent-disk-on-the-old-sdk
+    - "The SDK will reboot when the configuration is completed. After the reboot
+       click on psdk icon again to confirm that the persistent disk is in use."
+    - "Continue executing the second stage of the test:"
+    - $ psdk-test> r
+    - "After the execution of stage2, there should be a virtual machine running
+       named Apertis_NewSDK, proceed to the next step."
     - "Use psdk to configure the SDK to use the persistent disk:"
-    - "~https://developer.apertis.org/latest/sdk-usage.html#using-the-persistent-disk-on-the-new-sdk"
-    - "The SDK will reboot when the configuration is completed. After the reboot click on psdk icon again to confirm that the persistent disk is in use"
-    - "Run on a terminal:"
-    - $ ade sysroot update --release <release version>
-    - "Power off the virtual machine"
+    - ~https://developer.apertis.org/latest/sdk-usage.html#using-the-persistent-disk-on-the-new-sdk
+    - The SDK will reboot when the configuration is completed. After the reboot
+      click on psdk icon again to confirm that the persistent disk is in use.
+    - "Execute the final stage:"
+    - $ psdk-test> r
+    - This will complete the execution of the test, please check that the expected
+      result is obtained.