Merge ~alextu/plainbox-provider-pc-sanity:checkbox-remote-need-specific-out-folder into plainbox-provider-pc-sanity:master

[Alex Tu]

[Alex Tu (alextu)]

checkbox remote reject test cases writing any file in $PWD, so I moved out file to shared session folder instead.

[Alex Tu (alextu)]

╰─>bats test/test-screen-pkg-not-public.bats
 ✓ run_main() reflect the JOB_STATUS
 ✓ allow pkgs came from ubuntu archive
 ✓ screen out pkgs we hacked
 ✓ screen out pkgs only in unexpected archive.
 ✓ screen out pkgs not in any archive.
 ✓ screen out pkgs only on oem archive.

6 tests, 0 failures

[Alex Tu (alextu)]

just verified latest xstaging ubuntu-desktop and only nvidia is from private ppa.

 - https://oem-share.canonical.com/partners/somerville/share/Platforms/fossa-edge/fossa-edge_X64.html

 - https://pastebin.canonical.com/p/w47d9WdR38/

[Alex Tu (alextu)]

gitlab pipline: https://gitlab.com/alex-tu-cc/plainbox-provider-pc-sanity/-/pipelines/238555925

[jeremyszu (os369510)]

review: Needs Fixing

[Alex Tu (alextu)]

https://gitlab.com/alex-tu-cc/plainbox-provider-pc-sanity/-/pipelines/238892692

[Alex Tu (alextu)]

fixed the comment from reviewer.
and verified on gitlab pipeline, so I will just merge it.

https://gitlab.com/alex-tu-cc/plainbox-provider-pc-sanity/-/pipelines/238892692

diff --git a/bin/screen-pkg-not-public.sh b/bin/screen-pkg-not-public.sh
index a3a3ae8..c4e4db7 100755
--- a/bin/screen-pkg-not-public.sh
+++ b/bin/screen-pkg-not-public.sh
@@ -10,6 +10,17 @@ oem=""
 platform=""
 allowlst_folder=""
 JOB_STATUS="pass"
+out_folder="$PWD";
+
+usage() {
+cat << EOF
+usage: $0 options
+
+    -h|--help   Print this message
+    --out       Define the folder for generated data. The default is \$PWD
+EOF
+exit 1
+}
 clean() {
    rm -rf "$allowlst_folder"
    [ -z "$1" ] || exit "$1"
@@ -46,9 +57,9 @@ prepare() {
     pf_factory_meta_pkg="${pf_meta_pkg/oem-${oem}-/oem-${oem}-factory-}"
     echo "[INFO] getting allowlist from $allowlist_git."
     [ -n "$allowlist_git" ] &&\
-    allowlst_folder="$PWD"/"$(basename "$allowlist_git")" &&\
+    allowlst_folder="$out_folder"/"$(basename "$allowlist_git")" &&\
     rm -rf "$allowlst_folder" &&\
-    (git clone --depth=1 "$allowlist_git" || (>&2 echo "[ERROR]git clone ""$allowlist_git"" failed, please check it." | exit 1))
+    (git -C "$out_folder" clone --depth=1 "$allowlist_git" || (>&2 echo "[ERROR]git clone ""$allowlist_git"" failed, please check it." | exit 1))
     echo "[INFO] git hash of current allowlist: $(git -C "$allowlst_folder" rev-parse --short HEAD)"
 }
 pkg_need_allowing() {
@@ -154,6 +165,22 @@ screen_pkg() {
 }
 
 run_main() {
+    while [ $# -gt 0 ]
+    do
+        case "$1" in
+            -h | --help)
+                usage
+                ;;
+            --out)
+                shift
+                [ -d "$1" ] || usage
+                out_folder="$1";
+                ;;
+            *)
+            usage
+           esac
+           shift
+    done
     prepare
     >&2 echo "[INFO] staring screen all installed packages."
     while IFS= read -r line; do
@@ -164,5 +191,5 @@ run_main() {
     clean
 }
 if [[ "${BASH_SOURCE[0]}" == "${0}" ]]; then
-  run_main
+  run_main "$@"
 fi
diff --git a/units/pc-sanity/pc-sanity-screen-oem-gaps.pxu b/units/pc-sanity/pc-sanity-screen-oem-gaps.pxu
index dbb2a75..23c5839 100644
--- a/units/pc-sanity/pc-sanity-screen-oem-gaps.pxu
+++ b/units/pc-sanity/pc-sanity-screen-oem-gaps.pxu
@@ -1,7 +1,7 @@
 plugin: shell
 category_id: com.canonical.plainbox::miscellanea
 id: miscellanea/screen-pkg-not-public
-command: screen-pkg-not-public.sh
+command: screen-pkg-not-public.sh --out "$PLAINBOX_SESSION_SHARE"
 _summary: check if pkgs not on public archive
 _description:
  check if pkgs not on public archive