Merge ~alextu/plainbox-provider-pc-sanity:pc10-s2i into plainbox-provider-pc-sanity:master

[Alex Tu]

    check expected power residency during s2i e.g. cpu pkg c10, s0ix, gfxrc6..etc

    this test case refer to Intel document : https://01.org/blogs/qwang59/2020/linux-s0ix-troubleshooting

[Kai-Chuan Hsieh (kchsieh)]

Seems have error while grep the file:

u@u-Latitude:/usr/share/plainbox-provider-checkbox/units/pc-sanity$ checkbox-cli run com.canonical.certification::miscellanea/turbostate-s2i-power-residency
===========================[ Running Selected Jobs ]============================
--------------[ Running job 1 / 1. Estimated time left: unknown ]---------------
[ check if target machine can get expected power residency on e.g. cpu pkg c10, s0ix, gfxrc6..etc ]
ID: com.canonical.certification::miscellanea/turbostate-s2i-power-residency
Category: com.canonical.plainbox::miscellanea
... 8< -------------------------------------------------------------------------
+ check-turbostat-power-residency.sh --s2i
/usr/bin/turbostat
[INFO] getting turbostat log. Please wait for 60s
rtcwake: assuming RTC uses UTC ...
rtcwake: wakeup from "freeze" using /dev/rtc0 at Wed Sep 2 08:58:59 2020
grep: /tmp/s2i-turbostat.log: No such file or directory
(standard_in) 2: syntax error
[INFO] checking s0ix : %
(standard_in) 1: syntax error
Failed avg s0ix : NOT > 70
(standard_in) 2: syntax error
[INFO] checking gfxrc6 : %
(standard_in) 1: syntax error
Failed avg gfxrc6 : NOT > 50
(standard_in) 2: syntax error
[INFO] checking pkg_pc10 : %
(standard_in) 1: syntax error
Failed avg pkg_pc10 : NOT > 80
------------------------------------------------------------------------- >8 ---
Outcome: job failed
Finalizing session that hasn't been submitted anywhere: checkbox-run-2020-09-02T08.57.57
==================================[ Results ]===================================
 ☒ : check if target machine can get expected power residency on e.g. cpu pkg c10, s0ix, gfxrc6..etc

review: Needs Fixing

[Alex Tu (alextu)]

fixed the missed, part

--------------[ Running job 2 / 2. Estimated time left: unknown ]---------------
[ check if target machine can get expected power residency on e.g. cpu pkg c10, s0ix, gfxrc6..etc ]
ID: com.canonical.certification::miscellanea/turbostate-s2i-power-residency
Category: com.canonical.plainbox::miscellanea
... 8< -------------------------------------------------------------------------
+ check-turbostat-power-residency.sh --s2i
/usr/bin/turbostat
[INFO] getting turbostat log. Please wait for 60s
rtcwake: assuming RTC uses UTC ...
rtcwake: wakeup from "freeze" using /dev/rtc0 at Wed Sep 2 10:06:54 2020
[INFO] checking s0ix : 0%
Failed avg s0ix : 0 NOT > 70
[INFO] checking gfxrc6 : 100%
Passed.
[INFO] checking pkg_pc10 : 93%
Passed.
------------------------------------------------------------------------- >8 ---
Outcome: job failed

[Kai-Chuan Hsieh (kchsieh)]

LGTM.

review: Approve

diff --git a/debian/changelog b/debian/changelog
index 2b8a186..4c34c92 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,6 +1,8 @@
 plainbox-provider-pc-sanity (0.2.9) UNRELEASED; urgency=medium
 
   * add debsums checking
+  * miscellanea/turbostate-s2i-power-residency : to check expected power state
+    during s2i
 
  -- Alex Tu <[e-mail]>  Tue, 18 Aug 2020 15:44:22 +0800
 
diff --git a/usr/sbin/check-turbostat-power-residency.sh b/usr/sbin/check-turbostat-power-residency.sh
new file mode 100755
index 0000000..58be121
--- /dev/null
+++ b/usr/sbin/check-turbostat-power-residency.sh
@@ -0,0 +1,95 @@
+#!/bin/bash
+
+#refer to https://01.org/blogs/qwang59/2020/linux-s0ix-troubleshooting
+set -e
+state="pass"
+command -v turbostat || exit 1
+session_folder="$PLAINBOX_SESSION_SHARE"
+
+declare -A stats_p=( [gfxrc6]=0 [pkg_pc10]=7 [s0ix]=8 )
+declare -A turbostat=( [gfxrc6]=0 [pkg_pc10]=0 [s0ix]=0 )
+declare -A avg_criteria=( [gfxrc6]=50 [pkg_pc10]=80 [s0ix]=70 )
+
+usage() {
+cat << EOF
+usage: $0 options
+    this tool will run turbostat and check if the power state meet our requirement.
+    most of operations are need root permission.
+
+    -h|--help print this message
+    --s2i     get into s2i before run turbostat
+    --folder  sepcify the path of folder that you want to store temp logs. The default one is $session_folder
+    -f        read external turbostat log instead of doing turbostat.; do not need root permission.
+              please get log by this command:
+              \$turbostat --out your-log --show GFX%rc6,Pkg%pc2,Pkg%pc3,Pkg%pc6,Pkg%pc7,Pkg%pc8,Pkg%pc9,Pk%pc10,SYS%LPI
+              then:
+              \$$0 -f path-to-your-log
+EOF
+exit 1
+}
+
+while [ $# -gt 0 ]
+do
+    case "$1" in
+        -h | --help)
+            usage 0
+            exit 0
+            ;;
+        --s2i)
+            S2I=1;
+            ;;
+        --folder)
+            shift
+            [ -d "$i" ] || usage
+            session_folder=$1;
+            ;;
+        -f)
+            shift
+            if [ -f "$1" ]; then
+                EX_FILE="$1";
+            fi
+            ;;
+        *)
+        usage
+       esac
+       shift
+done
+
+STAT_FILE="$session_folder/s2i-turbostat.log"
+
+if_root(){
+   if [ "$(id -u)" != "0" ]; then
+       >&2 echo "[ERROR]need root permission"
+       usage
+   fi
+}
+if [ "$S2I" == "1" ]; then
+    if_root
+    echo "[INFO] getting turbostat log. Please wait for 60s"
+    turbostat --out "$STAT_FILE" --show GFX%rc6,Pkg%pc2,Pkg%pc3,Pkg%pc6,Pkg%pc7,Pkg%pc8,Pkg%pc9,Pk%pc10,SYS%LPI rtcwake -m freeze -s 60
+elif [ -n "$EX_FILE" ]; then
+    cp "$EX_FILE" "$STAT_FILE"
+else
+    if_root
+    echo "[INFO] getting turbostat log. Please wait for about 240s"
+    turbostat --num_iterations 60 --out "$STAT_FILE" --show GFX%rc6,Pkg%pc2,Pkg%pc3,Pkg%pc6,Pkg%pc7,Pkg%pc8,Pkg%pc9,Pk%pc10,SYS%LPI
+fi
+while read -r -a line; do
+    c=$((c+1));
+    for i in "${!turbostat[@]}"; do
+        turbostat[$i]=$(bc <<< "${turbostat[$i]}+${line[${stats_p[$i]}]}");
+    done
+done < <(grep -v "[a-zA-Z]" "$STAT_FILE")
+
+for i in "${!turbostat[@]}"; do
+    turbostat[$i]=$(bc <<< "${turbostat[$i]}/$c");
+    echo "[INFO] checking $i : ${turbostat[$i]}%"
+    if [ "$(bc <<< "${turbostat[$i]} > ${avg_criteria[$i]}")" == "1" ]; then
+        echo "Passed."
+    else
+        >&2 echo "Failed" "avg $i : ${turbostat[$i]} NOT > ${avg_criteria[$i]} "
+        state="failed"
+    fi
+done
+
+[ "$state" == "pass" ] || exit 1
diff --git a/usr/share/plainbox-provider-checkbox/units/pc-sanity/pc-sanity-power-consumption.pxu b/usr/share/plainbox-provider-checkbox/units/pc-sanity/pc-sanity-power-consumption.pxu
index 3e5cffd..e9e4894 100644
--- a/usr/share/plainbox-provider-checkbox/units/pc-sanity/pc-sanity-power-consumption.pxu
+++ b/usr/share/plainbox-provider-checkbox/units/pc-sanity/pc-sanity-power-consumption.pxu
@@ -1,3 +1,18 @@
+
+
+plugin: shell
+category_id: com.canonical.plainbox::miscellanea
+id: miscellanea/turbostate-s2i-power-residency
+after: miscellanea/turbostate-long-idle-c10
+user: root
+command:
+ set -x
+ check-turbostat-power-residency.sh --s2i
+_summary: check if target machine can get expected power residency on e.g. cpu pkg c10, s0ix, gfxrc6..etc
+_description:
+ check if target machine can get expected power residency on e.g. cpu pkg c10, s0ix, gfxrc6..etc
+ this test case refer to Intel document : https://01.org/blogs/qwang59/2020/linux-s0ix-troubleshooting
+
 plugin: shell
 category_id: com.canonical.plainbox::miscellanea
 id: miscellanea/turbostate-short-idle-c10
diff --git a/usr/share/plainbox-provider-checkbox/units/pc-sanity/pc-sanity-smoke-test.pxu b/usr/share/plainbox-provider-checkbox/units/pc-sanity/pc-sanity-smoke-test.pxu
index 9e4a885..949b742 100644
--- a/usr/share/plainbox-provider-checkbox/units/pc-sanity/pc-sanity-smoke-test.pxu
+++ b/usr/share/plainbox-provider-checkbox/units/pc-sanity/pc-sanity-smoke-test.pxu
@@ -6,6 +6,7 @@ _description:
 include:
     com.canonical.certification::miscellanea/debsums
     com.canonical.certification::miscellanea/turbostate-long-idle-c10
+    com.canonical.certification::miscellanea/turbostate-s2i-power-residency
     com.canonical.certification::miscellanea/intel-rapl
     com.canonical.certification::miscellanea/intel-rapl-mmio
     com.canonical.certification::miscellanea/intel-p-state