Merge ~alextu/plainbox-provider-pc-sanity:nvidia-rtd3-checking-v2 into plainbox-provider-pc-sanity:master

[Alex Tu]

[Alex Tu (alextu)]

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

[Alex Tu (alextu)]

another run https://gitlab.com/alex-tu-cc/plainbox-provider-pc-sanity/-/pipelines/217781510

[Alex Tu (alextu)]

autopkgtest passed there:
https://gitlab.com/alex-tu-cc/plainbox-provider-pc-sanity/-/pipelines/217781510

[Alex Tu (alextu)]

this is a test result on 202010-28303 (IP: 192.168.101.32) in nvidia on-demand mode for reference :
https://pastebin.ubuntu.com/p/R7hxTS6sv8/

[Alex Tu (alextu)]

latest gitlab pipline is running : https://gitlab.com/alex-tu-cc/plainbox-provider-pc-sanity/-/pipelines/218083489

[Alex Tu (alextu)]

just rebased and did a pipline testing there : https://gitlab.com/alex-tu-cc/plainbox-provider-pc-sanity/-/pipelines/220357367

[Cyrus Lien (cyruslien)]

review: Approve

diff --git a/bin/check-nvidia.sh b/bin/check-nvidia.sh
new file mode 100755
index 0000000..85b0a04
--- /dev/null
+++ b/bin/check-nvidia.sh
@@ -0,0 +1,186 @@
+#!/bin/bash
+#set -x
+OUTPUT_FOLDER=/tmp
+test_result="PASS"
+#readonly function_pass=0
+readonly function_failed=1
+
+usage() {
+cat << EOF
+usage: $(basename "$0") options
+
+A script to check if nvidia driver behave as expected.
+Nvidia introduce runtime pm (RTD3) from version 450,
+this script is target to check the expected behavior of nviia driver, and gpu manager.
+
+This script will need some environment precondition that DISPLAY environment is assigned,
+nvidia-prime and ubuntu-drivers-common are installed. Nvidia drvier newer than version 450.
+Powertop is needed to check the sleep status of nvidia graphic.
+
+    -h|--help print this message
+    --dry-run dryrun
+    --out     The output folder for generated logs. The default one is /tmp/
+
+EOF
+}
+
+show_error() {
+    >&2 echo "[ERROR] ""$1"
+    test_result="FAILED"
+    if [ -n "$2" ]; then
+        case "$2" in
+            exit1 )
+                exit 1
+                ;;
+            exit0 )
+                exit 0
+                ;;
+            usage-exit1 )
+                usage
+                exit 1
+                ;;
+            * )
+                ;;
+        esac
+    fi
+}
+
+collect_nvidia_debug_info() {
+    local logs_folder="$OUTPUT_FOLDER/nvidia-debug-logs"
+    mkdir -p "$logs_folder"
+    echo "/proc/driver/nvidia/params:" >> $OUTPUT_FOLDER/nvidia-debug-log
+    if [ -f /proc/driver/nvidia/params ]; then
+        cat /proc/driver/nvidia/params >> $OUTPUT_FOLDER/nvidia-debug-log
+    else
+        echo "file is not there" >> $OUTPUT_FOLDER/nvidia-debug-log
+    fi
+
+    echo "/var/log/gpu-manager.log:" >> $OUTPUT_FOLDER/nvidia-debug-log
+    if [ -f /var/log/gpu-manager.log ]; then
+        cp /var/log/gpu-manager.log $logs_folder
+        echo "Copied file to $logs_folder" >> $OUTPUT_FOLDER/nvidia-debug-log
+    else
+        echo "file is not there" >> $OUTPUT_FOLDER/nvidia-debug-log
+    fi
+
+    echo "nvidia-smi:" >> $OUTPUT_FOLDER/nvidia-debug-log
+    nvidia-smi >> $OUTPUT_FOLDER/nvidia-debug-log
+}
+
+get_powertop_report() {
+    sudo powertop --csv="$OUTPUT_FOLDER"/"$filename" -t 3 || show_error "Powertop failed.." usage-exit1
+}
+check_nvidia_sleep() {
+    local result
+    local filename="$1powertop.csv"
+    get_powertop_report "$filename"
+    result="$(grep -i "NVIDIA" $OUTPUT_FOLDER/"$filename" | grep "%" | grep -v checkbox | awk -F'%' '{ if ($1 > 0) print "failed:"$0}')"
+    if [ -n "$result" ]; then
+       show_error "$result"
+       show_error "nvidia devices not sleep deep to 0%. Check $OUTPUT_FOLDER/$filename for detail."
+       return $function_failed
+    fi
+}
+check_environment() {
+    [ -n "$DISPLAY" ] || show_error "Please assign DISPLAY enviornment." usage-exit1
+    glxinfo > /dev/null || show_error "Failed to execute glxinfo" usage-exit1
+    dpkg --compare-versions "$(modinfo nvidia -F version)" "gt" "450" || show_error "[ERROR] $(basename "$0") only support nvidia driver >= 450." usage-exit1
+    command -v prime-select || show_error "nvidia-prime is not installed."  usage-exit1
+    command -v gpu-manager || show_error "ubuntu-drivers-common is not installed." usage-exit1
+    command -v powertop || show_error "powertop is not installed." usage-exit1
+}
+check_renderer() {
+    local renderer
+    case $1 in
+        on-demand-default )
+            renderer="$(__NV_PRIME_RENDER_OFFLOAD=0 __GLX_VENDOR_LIBRARY_NAME="" glxinfo | grep "OpenGL renderer string")"
+            [ -z "${renderer##*Intel*}" ] || show_error "The default renderer is NOT Intel in on-demand." exit1
+            ;;
+        on-demand-nvidia )
+            renderer="$(__NV_PRIME_RENDER_OFFLOAD=1 __GLX_VENDOR_LIBRARY_NAME=nvidia glxinfo | grep "OpenGL renderer string")"
+            [ -n "${renderer##*Intel*}" ] || show_error "renderer is Intel in on-demand with Nvidia runtime parameters." exit1
+            [ -n "${renderer##*LLVM*}" ] || show_error "renderer is  LLVM in nvidia mode (performance)." exit1
+            ;;
+        nvidia )
+            local renderer
+            renderer="$(glxinfo | grep "OpenGL renderer string")"
+            [ -n "${renderer##*Intel*}" ] || show_error "renderer is Intel in nvidia mode (performance)." exit1
+            [ -n "${renderer##*LLVM*}" ] || show_error "renderer is  LLVM in nvidia mode (performance)." exit1
+            ;;
+        intel )
+            renderer="$(glxinfo | grep "OpenGL renderer string")"
+            [ -z "${renderer##*Intel*}" ] || show_error "renderer is NOT Intel in intel mode(powersaving)." exit1
+            ;;
+        * )
+            show_error "[ERROR][CODE] Not assigned which mode to check." usage-exit1
+            ;;
+    esac
+}
+check_ondemand_mode() {
+    check_nvidia_sleep ondemand_
+    check_renderer on-demand-default
+    check_renderer on-demand-nvidia
+}
+check_nvidia_mode() {
+    check_renderer nvidia
+}
+check_intel_mode() {
+    check_renderer intel
+    check_nvidia_sleep intel_
+}
+check_behavior_of_current_mode() {
+    local NV_MODE
+    NV_MODE="$(prime-select query)"
+    case "$NV_MODE" in
+        on-demand)
+            echo "[INFO] current mode is on-demand mode."
+            check_ondemand_mode
+            ;;
+        nvidia)
+            echo "[INFO] current mode is nvidia mode."
+            check_nvidia_mode
+            ;;
+        intel)
+            echo "[INFO] current mode is intel mode."
+            check_intel_mode
+            ;;
+        *)
+            show_error "Unsupported mode: $NV_MODE" usage-exit1
+            ;;
+    esac
+}
+
+main() {
+    while [ $# -gt 0 ]
+    do
+        case "$1" in
+            -h | --help)
+                usage 0
+                exit 0
+                ;;
+            --out)
+                shift;
+                OUTPUT_FOLDER=$1;
+                ;;
+            *)
+            show_error "[ERROR] not support parameger $1" usage-exit1
+            usage
+           esac
+           shift
+    done
+
+    check_environment
+    check_behavior_of_current_mode
+}
+
+if [[ "${BASH_SOURCE[0]}" == "$0" ]]; then
+    main "$@"
+    if [ "$test_result" = "PASS" ]; then
+        echo "[INFO] passed"
+    else
+        collect_nvidia_debug_info
+        echo "[ERROR] $(basename "$0") testing failed."
+        exit "$function_failed"
+    fi
+fi
+
diff --git a/debian/control b/debian/control
index 441a981..4d2fdbb 100644
--- a/debian/control
+++ b/debian/control
@@ -9,6 +9,7 @@ Vcs-Browser: https://code.launchpad.net/~ville-team/ville/+git/plainbox-provider
 Package: plainbox-provider-pc-sanity
 Architecture: all
 Depends: plainbox-provider-checkbox (>= 0.27),
+         powertop,
          python3 (>= 3.2),
          python3-checkbox-support (>= 0.27),
          ${misc:Depends},
diff --git a/test/test-check-nvidia.bats b/test/test-check-nvidia.bats
new file mode 100644
index 0000000..b0daffd
--- /dev/null
+++ b/test/test-check-nvidia.bats
@@ -0,0 +1,133 @@
+#!/usr/bin/env bats
+
+# execute this test file by `bats test/test-check-nvidia.bats`
+BIN_FOLDER="bin"
+
+function setup() {
+    # shellcheck source=/dev/null
+    source "$BIN_FOLDER"/check-nvidia.sh
+}
+
+@test "recognize current mode" {
+    set -e
+    function prime-select() {
+        echo "$current_mode"
+    }
+    function check_ondemand_mode() {
+        return "$on_demand_mode"
+    }
+    function check_nvidia_mode() {
+        return "$nvidia_mode"
+    }
+    function check_intel_mode() {
+        return "$intel_mode"
+    }
+    on_demand_mode=1
+    nvidia_mode=2
+    intel_mode=3
+
+    echo "testing recognizing on-demand mode"
+    current_mode="on-demand"
+    run check_behavior_of_current_mode
+    [ "$status" -eq $on_demand_mode ]
+    echo "testing recognizing nvidia mode"
+    current_mode="nvidia"
+    run check_behavior_of_current_mode
+    [ "$status" -eq $nvidia_mode ]
+    echo "testing recognizing intel mode"
+    current_mode="intel"
+    run check_behavior_of_current_mode
+    [ "$status" -eq $intel_mode ]
+
+}
+
+@test "Check renderer when OpenGL renderer string: Mesa Intel(R)" {
+    set -e
+    glxinfo_string="OpenGL renderer string: Mesa Intel(R)"
+    function glxinfo() {
+        echo "$glxinfo_string"
+    }
+    echo run check_renderer intel
+    run check_renderer intel
+    [ "$status" -eq 0 ]
+
+    echo run check_renderer on-demand-default
+    run check_renderer on-demand-default
+    [ "$status" -eq 0 ]
+
+    echo run check_renderer on-demand-nvidia
+    run check_renderer on-demand-nvidia
+    [ "$status" -eq 1 ]
+    echo run check_renderer on-nvidia
+    run check_renderer nvidia
+    [ "$status" -eq 1 ]
+}
+
+@test "Check renderer when OpenGL renderer string: GeForce GTX" {
+    set -e
+    glxinfo_string="OpenGL renderer string: GeForce GTX"
+    function glxinfo() {
+        echo "$glxinfo_string"
+    }
+    echo run check_renderer intel
+    run check_renderer intel
+    [ "$status" -eq 1 ]
+
+    echo run check_renderer on-demand-default
+    run check_renderer on-demand-default
+    [ "$status" -eq 1 ]
+
+    echo run check_renderer on-demand-nvidia
+    run check_renderer on-demand-nvidia
+    [ "$status" -eq 0 ]
+    echo run check_renderer on-nvidia
+    run check_renderer nvidia
+    [ "$status" -eq 0 ]
+}
+@test "Check renderer when OpenGL renderer string: llvmpipe (LLVM 10.0.0, 256 bits)" {
+    set -e
+    glxinfo_string="OpenGL renderer string: llvmpipe (LLVM 10.0.0, 256 bits)"
+    function glxinfo() {
+        echo "$glxinfo_string"
+    }
+    echo run check_renderer intel
+    run check_renderer intel
+    [ "$status" -eq 1 ]
+
+    echo run check_renderer on-demand-default
+    run check_renderer on-demand-default
+    [ "$status" -eq 1 ]
+
+    echo run check_renderer on-demand-nvidia
+    run check_renderer on-demand-nvidia
+    [ "$status" -eq 1 ]
+    echo run check_renderer on-nvidia
+    run check_renderer nvidia
+    [ "$status" -eq 1 ]
+}
+
+@test "Check Nvidia sleep in on-demand and Intel mode" {
+    set -e
+    OUTPUT_FOLDER="$(mktemp -d)"
+
+    function get_powertop_report() {
+        rm -f "$OUTPUT_FOLDER"/"$1"
+        echo "$powertop_str1" > "$OUTPUT_FOLDER"/"$1"
+        echo "$powertop_str2" >> "$OUTPUT_FOLDER"/"$1"
+    }
+
+    # the string will show by checkbox process
+    powertop_str1="100.0%;checkbox nvidia"
+
+    echo "When Nvidia not sleep deep to 0%, it should be failed."
+    powertop_str2="30.0%;PCI Device: NVIDIA"
+    run check_nvidia_sleep ondemand_
+    run check_nvidia_sleep intel_
+    [ "$status" -eq 1 ]
+    echo "When Nvidia sleep deep to 0%, it should be pass."
+    powertop_str2="0.0%;PCI Device: NVIDIA"
+    run check_nvidia_sleep ondemand_
+    run check_nvidia_sleep intel_
+    [ "$status" -eq 0 ]
+}
+
diff --git a/units/pc-sanity/packaging.pxu b/units/pc-sanity/packaging.pxu
index 31ac911..953bef7 100644
--- a/units/pc-sanity/packaging.pxu
+++ b/units/pc-sanity/packaging.pxu
@@ -2,4 +2,3 @@
 unit: packaging meta-data
 os-id: debian
 Depends: plainbox-provider-certification-client
-
diff --git a/units/pc-sanity/pc-sanity-nvidia.pxu b/units/pc-sanity/pc-sanity-nvidia.pxu
new file mode 100644
index 0000000..3d7153a
--- /dev/null
+++ b/units/pc-sanity/pc-sanity-nvidia.pxu
@@ -0,0 +1,9 @@
+plugin: shell
+category_id: com.canonical.plainbox::miscellanea
+id: miscellanea/check-nvidia
+command:
+ set -x
+ check-nvidia.sh
+_summary: check if nvidia dgpu behave as we expected.
+_description:
+ Nvidia introduce runtime D3 (runtime pm) from Nvidia driver version 450. This test case is used to check if everything work as expected.