Merge ~alextu/pc-enablement/+git/prepare-checkbox-sanity:autopkgtest-init into ~oem-solutions-engineers/pc-enablement/+git/prepare-checkbox-sanity:master

[Alex Tu]

the work prepared for autopkgtest.

created testbed by referring to comment of commit d2f8a10

$ sudo autopkgtest -U --summary-file=summary.log --log-file=complete.log -- lxc autopkgtest-focal-amd64

$ cat complete.log
https://pastebin.canonical.com/p/2HvJGFHSDZ/

$ cat
help PASS

[Shih-Yuan Lee (fourdollars)]

LGTM

But it has the following problem that makes me have to checkout it manually.

$ sudo autopkgtest https://git.launchpad.net/~alextu/pc-enablement/+git/prepare-checkbox-sanity -- lxc autopkgtest-focal-amd64
...
Cloning into 'prepare-checkbox-sanity'...
remote: Counting objects: 98, done.
remote: Compressing objects: 100% (86/86), done.
remote: Total 98 (delta 38), reused 0 (delta 0)
Unpacking objects: 100% (98/98), 14.48 KiB | 322.00 KiB/s, done.
warning: remote HEAD refers to nonexistent ref, unable to checkout.

sed: can't read debian/changelog: No such file or directory
blame: https://git.launchpad.net/~alextu/pc-enablement/+git/prepare-checkbox-sanity
badpkg: rules extract failed with exit code 2
autopkgtest [12:29:00]: ERROR: erroneous package: rules extract failed with exit code 2

review: Approve

[Alex Tu (alextu)]

refer to [1] the correct parameter to autopkgtest a branch should be: URL#branch

e.g.
$ sudo autopkgtest https://git.launchpad.net/\~alextu/pc-enablement/+git/prepare-checkbox-sanity\#autopkgtest-init -- lxc autopkgtest-focal-amd64

[1] https://manpages.debian.org/testing/autopkgtest/autopkgtest.1.en.html

[Shih-Yuan Lee (fourdollars)]

You can use https://code.launchpad.net/~alextu/pc-enablement/+git/prepare-checkbox-sanity/+edit to set the default branch too.

diff --git a/README.md b/README.md
index cfcc852..8f646da 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 # Background
 
-[Checkbox](checkbox.readthedocs.io/en/latest/) is a flexible test automation software. It’s the main tool used in Ubuntu Certification program.
+[Checkbox](https://checkbox.readthedocs.io/) is a flexible test automation software. It’s the main tool used in Ubuntu Certification program.
 
 prepare-checkbox-sanity is a wrapper to help people prepare the environment for PC sanity with checkbox and run plans easier.
 
@@ -59,53 +59,29 @@ $ checkbox-cli list | grep plan  | grep poweroff | grep auto
         test plan 'com.canonical.certification::power-management-reboot-poweroff-cert-automated'
         test plan 'com.canonical.certification::stress-30-reboot-poweroff-automated'
 $ checkbox-run-plan stress-30-reboot-poweroff-automated
+
+$ checkbox-cli list | grep plan  | grep tpm2 | grep auto
+# -b is to skip asking for configuration file
+$ checkbox-run-plan tpm2.0_3.0.4-automated -b
 ```
 
 ## All usage can also be refered to help:
-
-
-~~~ sh
+```sh
 $ prepare-checkbox-sanity --help
-usage: prepare-checkbox-sanity options
-
-    -h|--help   print this message
-    --init      If you installed this package by baser from git repository directly,
-                Then you need to do this first to setup the environment.
-                If you install it by debian package, then all things be done automatically.
-    --dev       Get dev packages for plans under development from https://launchpad.net/~oem-solutions-group/+archive/ubuntu/pc-sanity-daily
-
-$ prepare-checkbox-sanity --help
-usage: ./checkbox-run-plan options plan
-
-    options:
-        -h|--help           print this message
-        -e|--exclude-unites exclude unites
-                            e.g. -e ".*audio/alsa_record_playback_automated .*suspend/record_playback_after_suspend_auto"
-        --checkbox-conf     The path of checkbox.conf, refer to https://checkbox.readthedocs.io/en/latest/launcher-tutorial.html
-                            The default path will refer to CHECKBOX_CONF in /etc/default/prepare-checkbox-sanity.conf
-                            See usage below for detail.
-        -b                  batch mode, which will go all default way.
-
-    plan:
-        pc_sanity_before_suspend
-            the plan in plainbox-provider-pc-sanity on ppa:oem-solutions-group/pc-sanity
-
-        pc_sanity_after_suspend
-            the plan in plainbox-provider-pc-sanity on ppa:oem-solutions-group/pc-sanity
-
-        stress-suspend-30-cycles-with-reboots-automated
-            the plan in plainbox-provider-checkbox
-
-        sru
-            the plan in plainbox-provider-sru
-
-        Or any plan in /usr/share/plainbox-provider-*/units could be used here as well.
-
-    usage:
-        run sru plan, and use the checkbox.conf from current folder
-        ./checkbox-run-plan sru --checkbox-conf `pwd`/checkbox.conf -b
-
-        run sru plan, and get the checkbox.conf from http://192.168.0.40/checkbox.conf
-        ./checkbox-run-plan sru --checkbox-conf http://192.168.0.40/checkbox.conf -b
-
-~~~
+$ checkbox-run-plan --help
+```
+## Tips for checkbox
+## [checkbox remote](https://checkbox.readthedocs.io/en/latest/remote.html)
+## [side-loading proficders](https://checkbox.readthedocs.io/en/latest/side-loading.html)
+```
+Invocation:
+    Slave:
+$ checkbox-cli slave
+    Master:
+$ checkbox-cli master HOST [/PATH/TO/LAUNCHER]
+```
+## checkbox bootstrap
+```
+# checkbox-cli list-bootstrapped ${target-plan}
+$ checkbox-cli list-bootstrapped com.canonical.certification::client-cert-auto
+```
diff --git a/TODO b/TODO
index 1e2f8a6..e6f8b1a 100644
--- a/TODO
+++ b/TODO
@@ -1,3 +1,5 @@
+- the way to edit pxu test items without root.
+https://checkbox.readthedocs.io/en/latest/tutorials.html#developing-provider-without-constantly-reinstalling-it
 - interactive to generate launcher to run plan by plan.
 - interactive to make change SSID easier.
 - contribute the checkbox-run-plan model to upstream.
diff --git a/debian/changelog b/debian/changelog
index 971bc27..052edaf 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,3 +1,9 @@
+prepare-checkbox-sanity (1.0.5ubuntu1) UNRELEASED; urgency=medium
+
+  * autodpkgtest
+
+ -- Alex Tu <[e-mail]>  Thu, 14 May 2020 21:59:46 +0800
+
 prepare-checkbox-sanity (1.0.5) bionic; urgency=medium
 
   * remove the dependency of sru
diff --git a/debian/tests/control b/debian/tests/control
new file mode 100644
index 0000000..f91925d
--- /dev/null
+++ b/debian/tests/control
@@ -0,0 +1,2 @@
+Tests: help
+Depends: @
diff --git a/debian/tests/help b/debian/tests/help
new file mode 100755
index 0000000..3a2c83a
--- /dev/null
+++ b/debian/tests/help
@@ -0,0 +1,2 @@
+#!/bin/sh
+checkbox-run-plan --help
diff --git a/usr/lib/prepare-checkbox-sanity/fall-back-checkbox.conf b/usr/lib/prepare-checkbox-sanity/fall-back-checkbox.conf
new file mode 100644
index 0000000..f705efa
--- /dev/null
+++ b/usr/lib/prepare-checkbox-sanity/fall-back-checkbox.conf
@@ -0,0 +1,20 @@
+#!/usr/bin/env checkbox-cli
+[launcher]
+launcher_version = 1
+stock_reports = text, submission_files
+
+[transport:example_local_file]
+type = file
+path = /tmp/c3-local-submission.tar.xz
+
+[exporter:example_tar]
+unit = com.canonical.plainbox::tar
+
+[report:report_example_file]
+transport = example_local_file
+exporter = example_tar
+forced = yes
+
+[environment]
+ROUTERS = multiple
+TRANSFER_SERVER = cdimage.ubuntu.com
diff --git a/usr/sbin/checkbox-run-plan b/usr/sbin/checkbox-run-plan
index aea820a..48f07c1 100755
--- a/usr/sbin/checkbox-run-plan
+++ b/usr/sbin/checkbox-run-plan
@@ -1,8 +1,6 @@
 #!/bin/bash
-set -x
 
-
-EXCLUDE=".*usb/storage-preinserted .*suspend/usb_storage_preinserted_after_suspend .*stress/cpu_stress_ng_test .*disk/disk_stress_.*"
+EXCLUDE=""
 DEF_ENV="/etc/default/prepare-checkbox-sanity.conf"
 source $DEF_ENV
 
@@ -42,8 +40,14 @@ usage: $0 options plan
         $0 sru --checkbox-conf http://192.168.0.40/checkbox.conf -b
 
 EOF
+}
+
+error(){
+usage
 exit 1
 }
+
+
 while [ $# -gt 0 ]
 do
     case "$1" in
@@ -53,7 +57,7 @@ do
             ;;
         -e | --exclude)
             shift
-            [ -z "$1" ] && usage
+            [ -z "$1" ] && error
             EXCLUDE="$EXCLUDE $1"
             ;;
         --checkbox-conf)
@@ -64,7 +68,7 @@ do
             SILENCE="TRUE"
             ;;
         *)
-            [ -z "$1" ] && usage
+            [ -z "$1" ] && error
             if [ -z "${1##exclude = *}" ];then
                 # a back door for jenkins testflinger job
                 EXCLUDE="$EXCLUDE ${1##exclude = }"
@@ -76,7 +80,7 @@ do
        shift
 done
 
-[ -z "$PLAN" ] && usage
+[ -z "$PLAN" ] && error
 
 interactive(){
     echo "do you want to set the path of checkbox.conf? (refer to https://checkbox.readthedocs.io/en/latest/launcher-tutorial.html)"
@@ -90,8 +94,11 @@ interactive(){
 [ "$SILENCE" == "TRUE"  ] || interactive
 if [ -n "$CHECKBOX_CONF" ] && [ -z "${CHECKBOX_CONF##http*}" ]; then
     mkdir -p $HOME/.cache/prepare-checkbox
-    wget $CHECKBOX_CONF -O $HOME/.cache/prepare-checkbox/checkbox.conf
-    CHECKBOX_CONF="$HOME/.cache/prepare-checkbox/checkbox.conf"
+    if wget --waitretry=5 -T 5 -t 3 $CHECKBOX_CONF -O $HOME/.cache/prepare-checkbox/checkbox.conf; then
+        CHECKBOX_CONF="$HOME/.cache/prepare-checkbox/checkbox.conf"
+    else
+        CHECKBOX_CONF="usr/lib/prepare-checkbox-sanity/fall-back-checkbox.conf"
+    fi
 fi
 
 # always use the latest plan