From 160fc627345fe80e81ea38f9470ec90d12229b64 Mon Sep 17 00:00:00 2001 From: stanley31huang Date: Mon, 15 Jul 2024 11:24:21 +0800 Subject: [PATCH] Update the readme files update the readme files --- .../units/crypto/cases_and_environ.md | 256 ++---------------- .../units/digital-io/cases_and_environ.md | 87 +++--- .../units/ethernet/cases_and_environ.md | 72 +++-- .../units/gpio/cases_and_environ.md | 53 ++-- .../units/iio-sensors/cases_and_environ.md | 41 ++- .../units/mir/cases_and_environ.md | 47 ++-- .../units/optee/cases_and_environ.md | 145 ++-------- .../units/otg/cases_and_environ.md | 86 ++---- .../units/rpmsg/cases_and_environ.md | 83 ++---- .../units/serial/cases_and_environ.md | 77 +++--- .../units/spi/cases_and_environ.md | 29 ++ .../units/stress/cases_and_environ.md | 156 +++++++---- .../strict-confinement/cases_and_environ.md | 161 +++-------- .../units/video-codec/cases_and_environ.md | 60 ++-- 14 files changed, 458 insertions(+), 895 deletions(-) create mode 100644 contrib/checkbox-ce-oem/checkbox-provider-ce-oem/units/spi/cases_and_environ.md diff --git a/contrib/checkbox-ce-oem/checkbox-provider-ce-oem/units/crypto/cases_and_environ.md b/contrib/checkbox-ce-oem/checkbox-provider-ce-oem/units/crypto/cases_and_environ.md index f26d4d0d92..b019b5cdbc 100644 --- a/contrib/checkbox-ce-oem/checkbox-provider-ce-oem/units/crypto/cases_and_environ.md +++ b/contrib/checkbox-ce-oem/checkbox-provider-ce-oem/units/crypto/cases_and_environ.md @@ -1,18 +1,27 @@ -## environ keys for crypto test +## environ keys for crypto tests + - HWRNG - - Affected Test Cases: - - [ce-oem-crypto/hwrng-current](#ce-oem-crypto/hwrng-current) + - Affected Test Cases: + - [ce-oem-crypto/hwrng-current](#ce-oem-crypto/hwrng-current) -## Detailed test cases +## Detailed test cases contains environ variable ### ce-oem-crypto/hwrng-current -- **environ :** HWRNG -- **summary :** Check if current Hardware Random Number Generate is expected. -- **description :** +- **summary:** +Check if current Hardware Random Number Generate is expected. + +- **description:** ``` None ``` -- **command :** + +- **file:** +[source file](accelerator.pxu#L1) + +- **environ:** +HWRNG + +- **command:** ``` path_hwrng='/sys/class/misc/hw_random/' if [ -e "$path_hwrng/rng_available" ]; then @@ -38,235 +47,4 @@ else exit 1 fi ``` - -[Back to top](#top) -### ce-oem-crypto/caam/caam_hwrng_test -- **environ :** None -- **summary :** Check if CAAM job ring increased after generate random number by using hwrng. -- **description :** -``` -None -``` -- **command :** -``` -init_interrupt=$(awk '/\.jr/ {printf "%s ",$2;next;}' /proc/interrupts|sed 's/ //g') -if [ -z "$init_interrupt" ] -then - echo "ERROR: Can not find CAAM job ring interrupts" - exit 1 -fi -echo "CAAM Job ring interrupt before using Hardware RNG: $init_interrupt" -echo "Starting DD of /dev/hwrng ..." -for i in {1..20} -do - dd if=/dev/hwrng bs=512K count=1 > /dev/null - echo "Finished $i/20 times DD ..." - interrupt=$(awk '/\.jr/ {printf "%s ",$2;next;}' /proc/interrupts|sed 's/ //g') - echo "Current job ring interrupt: $interrupt" - if [ "$interrupt" -gt "$init_interrupt" ]; - then - echo "PASS: CAAM job ring interrupts have increased." - exit 0 - fi -done -echo "FAIL: CAAM job ring interrupts didn't increase!" -exit 1 -``` - -[Back to top](#top) -### ce-oem-crypto/caam/algo_check -- **environ :** None -- **summary :** Check CAAM algorithm is in the system /proc/crypto -- **description :** -``` -None -``` -- **command :** -``` -status=0 -if grep -q caam /proc/crypto; then - echo -e "\nInfo: Found CAAM algorithm in /proc/crypto" -else - echo -e "\nError: No any CAAM algorithm has been found in /proc/crytpo" - status=1 -fi -echo -e "\nPlease refer to resource job cryptoinfo for more detail" -exit "$status" -``` - -[Back to top](#top) -### ce-oem-crypto/caam-crypto-profiles -- **environ :** None -- **summary :** Generates a crypto profiles for CAAM accelerator -- **description :** -``` -A set of crypto profile mapping for CAAm accelerator. -``` -- **command :** -``` -check_crypto_profile.py resource -t caam -``` - -[Back to top](#top) -### ce-oem-crypto/mcrc-crypto-profiles -- **environ :** None -- **summary :** Generates a crypto profiles for MCRC accelerator -- **description :** -``` -A set of crypto profile mapping for MCRC accelerator. -``` -- **command :** -``` -check_crypto_profile.py resource -t mcrc -``` - -[Back to top](#top) -### ce-oem-crypto/sa2ul-crypto-profiles -- **environ :** None -- **summary :** Generates a crypto profiles for SA2UL accelerator -- **description :** -``` -A set of crypto profile mapping for SA2UL accelerator. -``` -- **command :** -``` -check_crypto_profile.py resource -t sa2ul -``` - -[Back to top](#top) -### cryptoinfo -- **environ :** None -- **summary :** Collect information about the crypto algorithm in system -- **description :** -``` -Gets crypto algorithm resource info from /proc/crypto -``` -- **command :** -``` -cat /proc/crypto -``` - -[Back to top](#top) -### ce-oem-crypto/cryptsetup_benchmark -- **environ :** None -- **summary :** Measure the cryptographic performance of system -- **description :** -``` -Measure the cryptographic performance of system by using cryptsetup -``` -- **command :** -``` -log=$(mktemp) -echo "Starting cryptographic benchmark testing ..." -cryptsetup benchmark | tee "$log" -awk '/aes-xts *512b/ {encryption=$3; decryption=$5} END {print "Performace of AES-XTS 512b", "\nEncryption:", encryption, "Mib/s", "\nDecryption:", decryption, "Mib/s"}' "$log" -``` - -[Back to top](#top) -### ce-oem-crypto/af_alg_hash_crc64_test -- **environ :** None -- **summary :** Check kernel crypto API is functional with type HASH - CRC64 algorithm -- **description :** -``` -None -``` -- **command :** -``` -af_alg_test.py --type hash_crc64 -``` - -[Back to top](#top) -### ce-oem-crypto/af_alg_hash_sha256_test -- **environ :** None -- **summary :** Check kernel crypto API is functional with type HASH - SHA256 algorithm -- **description :** -``` -None -``` -- **command :** -``` -af_alg_test.py --type hash_sha256 -``` - -[Back to top](#top) -### ce-oem-crypto/af_alg_aead_gcm_aes_test -- **environ :** None -- **summary :** Check if kernel crypto API is functional with type AEAD - GCM AES algorithm. -- **description :** -``` -None -``` -- **command :** -``` -af_alg_test.py --type aead_gcm_aes -``` - -[Back to top](#top) -### ce-oem-crypto/af_alg_skcipher_cbc_aes_test -- **environ :** None -- **summary :** Check if kernel crypto API is functional with type SKCIPHER - CBC AES algorithm. -- **description :** -``` -None -``` -- **command :** -``` -af_alg_test.py --type skcipher_cbc_aes -``` - -[Back to top](#top) -### ce-oem-crypto/af_alg_rng_stdrng_test -- **environ :** None -- **summary :** Check if kernel crypto API is functional with type RNG - stdrng algorithm. -- **description :** -``` -None -``` -- **command :** -``` -af_alg_test.py --type rng_stdrng -``` - -[Back to top](#top) -### ce-oem-crypto/check-caam-crypto-profiles -- **environ :** None -- **summary :** Check CAAM crypto {name} profile and its driver in the system -- **template_summary :** Check CAAM crypto profile and its driver in the system -- **description :** -``` -None -``` -- **command :** -``` - check_crypto_profile.py check -n "{name}" -t {type} -d {driver_pattern} -``` - -[Back to top](#top) -### ce-oem-crypto/check-mcrc-crypto-profiles -- **environ :** None -- **summary :** Check MCRC crypto {name} profile and its driver in the system -- **template_summary :** Check MCRC crypto profile and its driver in the system -- **description :** -``` -None -``` -- **command :** -``` - check_crypto_profile.py check -n "{name}" -t {type} -d {driver_pattern} -``` - -[Back to top](#top) -### ce-oem-crypto/check-sa2ul-crypto-profiles -- **environ :** None -- **summary :** Check SA2UL crypto {name} profile and its driver in the system -- **template_summary :** Check SA2UL crypto profile and its driver in the system -- **description :** -``` -None -``` -- **command :** -``` - check_crypto_profile.py check -n "{name}" -t {type} -d {driver_pattern} -``` - [Back to top](#top) diff --git a/contrib/checkbox-ce-oem/checkbox-provider-ce-oem/units/digital-io/cases_and_environ.md b/contrib/checkbox-ce-oem/checkbox-provider-ce-oem/units/digital-io/cases_and_environ.md index 9da86201fb..ac95e29974 100644 --- a/contrib/checkbox-ce-oem/checkbox-provider-ce-oem/units/digital-io/cases_and_environ.md +++ b/contrib/checkbox-ce-oem/checkbox-provider-ce-oem/units/digital-io/cases_and_environ.md @@ -1,24 +1,33 @@ -## environ keys for digital-io test +## environ keys for digital-io tests + - DIGITAL_IO_LOOPBACK_GPIO - - Affected Test Cases: - - [ce-oem-digital-io/loopback_mapping_gpio](#ce-oem-digital-io/loopback_mapping_gpio) + - Affected Test Cases: + - [ce-oem-digital-io/loopback_mapping_gpio](#ce-oem-digital-io/loopback_mapping_gpio) - DIGITAL_IO_LOOPBACK_SERIAL - - Affected Test Cases: - - [ce-oem-digital-io/loopback_mapping_serial](#ce-oem-digital-io/loopback_mapping_serial) + - Affected Test Cases: + - [ce-oem-digital-io/loopback_mapping_serial](#ce-oem-digital-io/loopback_mapping_serial) -## Detailed test cases +## Detailed test cases contains environ variable ### ce-oem-digital-io/loopback_mapping_gpio -- **environ :** DIGITAL_IO_LOOPBACK_GPIO -- **summary :** Generates a digital I/O loopback ports mapping for digital I/O loopback test -- **description :** +- **summary:** +Generates a digital I/O loopback ports mapping for digital I/O loopback test + +- **description:** ``` A digital I/O loopback ports mapping. By giving a pair of digital I/O port on machnie to generates test jobs. Usage of parameter: DIGITAL_IO_LOOPBACK_GPIO=do_port:do_gpio_pin:di_port:di_gpio_pin do_port:do_gpio_pin:di_port:di_gpio_pin ... e.g. DIGITAL_IO_LOOPBACK_GPIO=1:733:2:765 3:734:4:766 ``` -- **command :** + +- **file:** +[source file](jobs.pxu#L1) + +- **environ:** +DIGITAL_IO_LOOPBACK_GPIO + +- **command:** ``` awk '{ split($0, record, " ") @@ -28,19 +37,27 @@ awk '{ } }' <<< "$DIGITAL_IO_LOOPBACK_GPIO" ``` - [Back to top](#top) + ### ce-oem-digital-io/loopback_mapping_serial -- **environ :** DIGITAL_IO_LOOPBACK_SERIAL -- **summary :** Generates a digital I/O loopback ports mapping for digital I/O loopback test -- **description :** +- **summary:** +Generates a digital I/O loopback ports mapping for digital I/O loopback test + +- **description:** ``` A digital I/O loopback ports mapping. By giving a pair of digital I/O port on machnie to generates test jobs. Usage of parameter: DIGITAL_IO_LOOPBACK_SERIAL=do_port:do_byte_pin:di_port:di_byte_pin do_port:do_byte_pin:di_port:di_byte_pin ... e.g. DIGITAL_IO_LOOPBACK_SERIAL=1:2:1:6 2:3:2:7 3:4:3:8 4:5:4:9 ``` -- **command :** + +- **file:** +[source file](jobs.pxu#L41) + +- **environ:** +DIGITAL_IO_LOOPBACK_SERIAL + +- **command:** ``` awk '{ split($0, record, " ") @@ -50,44 +67,4 @@ awk '{ } }' <<< "$DIGITAL_IO_LOOPBACK_SERIAL" ``` - -[Back to top](#top) -### ce-oem-digital-io/loopback_gpio_DODO-DIDI -- **environ :** None -- **summary :** To test loopback between DO{DO} and DI{DI} -- **template_summary :** Loopback tests for the DO{DO}-DI{DI} pin control by GPIO -- **description :** -``` -None -``` -- **command :** -``` - echo "## Perform the digital I/O loopback test" - echo "DO{DO} gpio pin is {DO_GPIO}" - echo "DI{DI} gpio pin is {DI_GPIO}" - digital_io_loopback_test.py -o {DO_GPIO} -i {DI_GPIO} -``` - -[Back to top](#top) -### ce-oem-digital-io/loopback_serial_DODO-DIDI -- **environ :** None -- **summary :** To test loopback between DO{DO} and DI{DI} -- **template_summary :** Loopback tests for the DO{DO}-DI{DI} pin control by serial console -- **description :** -``` - The scripts will connect to the Digital IO controller via serial console - the serial console port is defined in variable DIGITAL_IO_CONSOLE -``` -- **command :** -``` - if [[ -z "$DIGITAL_IO_CONSOLE" ]]; then - echo "DIGITAL_IO_CONSOLE variable is not defined" - exit 1 - fi - echo "## Perform the digital I/O loopback test" - echo "DO{DO} register byte is {DO_REGISTER_BYTE}" - echo "DI{DI} register byte is {DI_REGISTER_BYTE}" - digital_io_loopback_serial_test.py -o {DO_REGISTER_BYTE} -i {DI_REGISTER_BYTE} -s "$DIGITAL_IO_CONSOLE" -``` - [Back to top](#top) diff --git a/contrib/checkbox-ce-oem/checkbox-provider-ce-oem/units/ethernet/cases_and_environ.md b/contrib/checkbox-ce-oem/checkbox-provider-ce-oem/units/ethernet/cases_and_environ.md index 0100c0cb6b..98bf22be7e 100644 --- a/contrib/checkbox-ce-oem/checkbox-provider-ce-oem/units/ethernet/cases_and_environ.md +++ b/contrib/checkbox-ce-oem/checkbox-provider-ce-oem/units/ethernet/cases_and_environ.md @@ -1,32 +1,34 @@ -## environ keys for ethernet test +## environ keys for ethernet tests + - TCP_MULTI_CONNECTIONS_SERVER_IP - - Affected Test Cases: - - [ce-oem-ethernet/tcp-multi-connections](#ce-oem-ethernet/tcp-multi-connections) + - Affected Test Cases: + - [ce-oem-ethernet/tcp-multi-connections](#ce-oem-ethernet/tcp-multi-connections) - TCP_MULTI_CONNECTIONS_START_PORT - - Affected Test Cases: - - [ce-oem-ethernet/tcp-multi-connections](#ce-oem-ethernet/tcp-multi-connections) + - Affected Test Cases: + - [ce-oem-ethernet/tcp-multi-connections](#ce-oem-ethernet/tcp-multi-connections) - TCP_MULTI_CONNECTIONS_END_PORT - - Affected Test Cases: - - [ce-oem-ethernet/tcp-multi-connections](#ce-oem-ethernet/tcp-multi-connections) + - Affected Test Cases: + - [ce-oem-ethernet/tcp-multi-connections](#ce-oem-ethernet/tcp-multi-connections) - TCP_MULTI_CONNECTIONS_PAYLOAD_SIZE - - Affected Test Cases: - - [ce-oem-ethernet/tcp-multi-connections](#ce-oem-ethernet/tcp-multi-connections) + - Affected Test Cases: + - [ce-oem-ethernet/tcp-multi-connections](#ce-oem-ethernet/tcp-multi-connections) - TCP_ECHO_SERVER_IP - - Affected Test Cases: - - [ce-oem-ethernet/tcp-echo-stress-interface](#ce-oem-ethernet/tcp-echo-stress-interface) + - Affected Test Cases: + - [ce-oem-ethernet/tcp-echo-stress-interface](#ce-oem-ethernet/tcp-echo-stress-interface) - TCP_ECHO_SERVER_PORT - - Affected Test Cases: - - [ce-oem-ethernet/tcp-echo-stress-interface](#ce-oem-ethernet/tcp-echo-stress-interface) + - Affected Test Cases: + - [ce-oem-ethernet/tcp-echo-stress-interface](#ce-oem-ethernet/tcp-echo-stress-interface) - TCP_ECHO_LOOP_ITERATIONS - - Affected Test Cases: - - [ce-oem-ethernet/tcp-echo-stress-interface](#ce-oem-ethernet/tcp-echo-stress-interface) + - Affected Test Cases: + - [ce-oem-ethernet/tcp-echo-stress-interface](#ce-oem-ethernet/tcp-echo-stress-interface) -## Detailed test cases +## Detailed test cases contains environ variable ### ce-oem-ethernet/tcp-multi-connections -- **environ :** TCP_MULTI_CONNECTIONS_SERVER_IP TCP_MULTI_CONNECTIONS_START_PORT TCP_MULTI_CONNECTIONS_END_PORT TCP_MULTI_CONNECTIONS_PAYLOAD_SIZE -- **summary :** Check if the system can handle multiple connections on TCP without error. -- **description :** +- **summary:** +Check if the system can handle multiple connections on TCP without error. + +- **description:** ``` This job will connect to server listened ports(200 ports in total), and send the payload(64KB) for few times of each port. This job will @@ -36,25 +38,41 @@ before running the test. e.g. Run a server to listen on port range from 1024 to 1223. $ tcp_multi_connections.py server -p 1024 -e 1223 ``` -- **command :** + +- **file:** +[source file](jobs.pxu#L24) + +- **environ:** +TCP_MULTI_CONNECTIONS_SERVER_IP TCP_MULTI_CONNECTIONS_START_PORT TCP_MULTI_CONNECTIONS_END_PORT TCP_MULTI_CONNECTIONS_PAYLOAD_SIZE + +- **command:** ``` tcp_multi_connections.py client -H "$TCP_MULTI_CONNECTIONS_SERVER_IP" -p "$TCP_MULTI_CONNECTIONS_START_PORT" -e "$TCP_MULTI_CONNECTIONS_END_PORT" -P "$TCP_MULTI_CONNECTIONS_PAYLOAD_SIZE" ``` - [Back to top](#top) + ### ce-oem-ethernet/tcp-echo-stress-interface -- **environ :** TCP_ECHO_SERVER_IP TCP_ECHO_SERVER_PORT TCP_ECHO_LOOP_ITERATIONS -- **summary :** Check if TCP echo via {{ interface }} without error. -- **template_summary :** None -- **description :** +- **summary:** +Check if TCP echo via {{ interface }} without error. + +- **template_summary:** +None + +- **description:** ``` This job will use BASH to handle TCP socket via /dev/tcp. Need a server to run the following command before running the test. $ nc -lk -p {port_num} ``` -- **command :** + +- **file:** +[source file](jobs.pxu#L1) + +- **environ:** +TCP_ECHO_SERVER_IP TCP_ECHO_SERVER_PORT TCP_ECHO_LOOP_ITERATIONS + +- **command:** ``` tcpecho_stress.sh -s {{ interface }} -i "$TCP_ECHO_SERVER_IP" -p "$TCP_ECHO_SERVER_PORT" -l "$TCP_ECHO_LOOP_ITERATIONS" -o "${PLAINBOX_SESSION_SHARE}"/tcp_echo.log ``` - [Back to top](#top) diff --git a/contrib/checkbox-ce-oem/checkbox-provider-ce-oem/units/gpio/cases_and_environ.md b/contrib/checkbox-ce-oem/checkbox-provider-ce-oem/units/gpio/cases_and_environ.md index ba35482a49..a72f7ef98b 100644 --- a/contrib/checkbox-ce-oem/checkbox-provider-ce-oem/units/gpio/cases_and_environ.md +++ b/contrib/checkbox-ce-oem/checkbox-provider-ce-oem/units/gpio/cases_and_environ.md @@ -1,51 +1,30 @@ -## environ keys for gpio test +## environ keys for gpio tests + - EXPECTED_GADGET_GPIO - - Affected Test Cases: - - [ce-oem-gpio/check-slots](#ce-oem-gpio/check-slots) + - Affected Test Cases: + - [ce-oem-gpio/check-slots](#ce-oem-gpio/check-slots) -## Detailed test cases +## Detailed test cases contains environ variable ### ce-oem-gpio/check-slots -- **environ :** EXPECTED_GADGET_GPIO -- **summary :** Check gadget snap defined GPIO slots. -- **description :** +- **summary:** +Check gadget snap defined GPIO slots. + +- **description:** ``` Use checkbox config EXPECTED_GADGET_GPIO to define the expected GPIO. Usage EXPECTED_GADGET_GPIO=499,500:502 Sprate by comma, and also colon to define a range of ports ``` -- **command :** -``` -check_gpio.py check-gpio -c "$EXPECTED_GADGET_GPIO" -``` -[Back to top](#top) -### ce-oem-gpio-gadget-slots -- **environ :** None -- **summary :** Generates a GPIO list that defined in the gadget snap -- **description :** -``` -Generates a GPIO list that is defined in the gadget snap. -This GPIO list will be used to check if the GPIO nodes have -been exported after connecting the interfaces. -``` -- **command :** -``` -check_gpio.py dump -``` +- **file:** +[source file](jobs.pxu#L1) -[Back to top](#top) -### ce-oem-gpio/node-export-test -- **environ :** None -- **summary :** To test node of GPIO {gpio_number} been exported -- **template_summary :** None -- **description :** -``` -None -``` -- **command :** +- **environ:** +EXPECTED_GADGET_GPIO + +- **command:** ``` -check_gpio.py check-node -n {gpio_number} -s {slot} +check_gpio.py check-gpio -c "$EXPECTED_GADGET_GPIO" ``` - [Back to top](#top) diff --git a/contrib/checkbox-ce-oem/checkbox-provider-ce-oem/units/iio-sensors/cases_and_environ.md b/contrib/checkbox-ce-oem/checkbox-provider-ce-oem/units/iio-sensors/cases_and_environ.md index fcb16417b8..1d57539192 100644 --- a/contrib/checkbox-ce-oem/checkbox-provider-ce-oem/units/iio-sensors/cases_and_environ.md +++ b/contrib/checkbox-ce-oem/checkbox-provider-ce-oem/units/iio-sensors/cases_and_environ.md @@ -1,38 +1,31 @@ -## environ keys for iio-sensors test +## environ keys for iio-sensors tests + - IIO_SENSORS - - Affected Test Cases: - - [ce-oem-iio-sensors/resource](#ce-oem-iio-sensors/resource) + - Affected Test Cases: + - [ce-oem-iio-sensors/resource](#ce-oem-iio-sensors/resource) -## Detailed test cases +## Detailed test cases contains environ variable ### ce-oem-iio-sensors/resource -- **environ :** IIO_SENSORS -- **summary :** Generates a IIO sensors mapping for IIO sensor test -- **description :** +- **summary:** +Generates a IIO sensors mapping for IIO sensor test + +- **description:** ``` A IIO sensors mapping. By giving an IIO sensors on machnie to generates test jobs. Usage of parameter: IIO_SENSORS=device:sensor_type device:sensor_type ... e.g. IIO_SENSORS=0:pressure 1:accelerometer 2:humidityrelative ``` -- **command :** -``` -iio_sensor_test.py sensor-resource "$IIO_SENSORS" -``` -[Back to top](#top) -### ce-oem-iio-sensors/check_sensor_type_index -- **environ :** None -- **summary :** To test industrial IO {{ type }}-{{ index }} -- **template_summary :** None -- **description :** -``` -None -``` -- **command :** +- **file:** +[source file](jobs.pxu#L1) + +- **environ:** +IIO_SENSORS + +- **command:** ``` - echo "## Perform the industrial I/O {{ type }}-{{ index }} sensor test" - iio_sensor_test.py test -t {{ type }} -i {{ index }} +iio_sensor_test.py sensor-resource "$IIO_SENSORS" ``` - [Back to top](#top) diff --git a/contrib/checkbox-ce-oem/checkbox-provider-ce-oem/units/mir/cases_and_environ.md b/contrib/checkbox-ce-oem/checkbox-provider-ce-oem/units/mir/cases_and_environ.md index 00d7ae7035..1bfe1b775f 100644 --- a/contrib/checkbox-ce-oem/checkbox-provider-ce-oem/units/mir/cases_and_environ.md +++ b/contrib/checkbox-ce-oem/checkbox-provider-ce-oem/units/mir/cases_and_environ.md @@ -1,39 +1,34 @@ -## environ keys for mir test +## environ keys for mir tests + - PLAINBOX_SESSION_SHARE - - Affected Test Cases: - - [mir/glmark2-es2-wayland-auto](#mir/glmark2-es2-wayland-auto) + - Affected Test Cases: + - [mir/glmark2-es2-wayland-auto](#mir/glmark2-es2-wayland-auto) - GL_VENDOR - - Affected Test Cases: - - [mir/glmark2-es2-wayland-auto](#mir/glmark2-es2-wayland-auto) + - Affected Test Cases: + - [mir/glmark2-es2-wayland-auto](#mir/glmark2-es2-wayland-auto) - GL_RENDERER - - Affected Test Cases: - - [mir/glmark2-es2-wayland-auto](#mir/glmark2-es2-wayland-auto) - -## Detailed test cases -### mir/check-ubuntu-frame-launching-auto -- **environ :** None -- **summary :** Test if Ubuntu-Frame can be brought up -- **description :** -``` -None -``` -- **command :** -``` -graphics_test.sh frame -``` + - Affected Test Cases: + - [mir/glmark2-es2-wayland-auto](#mir/glmark2-es2-wayland-auto) -[Back to top](#top) +## Detailed test cases contains environ variable ### mir/glmark2-es2-wayland-auto -- **environ :** PLAINBOX_SESSION_SHARE GL_VENDOR GL_RENDERER -- **summary :** Run OpenGL ES 2.0 Wayland benchmark on the GPU -- **description :** +- **summary:** +Run OpenGL ES 2.0 Wayland benchmark on the GPU + +- **description:** ``` None ``` -- **command :** + +- **file:** +[source file](jobs.pxu#L15) + +- **environ:** +PLAINBOX_SESSION_SHARE GL_VENDOR GL_RENDERER + +- **command:** ``` graphics_test.sh glmark2 ``` - [Back to top](#top) diff --git a/contrib/checkbox-ce-oem/checkbox-provider-ce-oem/units/optee/cases_and_environ.md b/contrib/checkbox-ce-oem/checkbox-provider-ce-oem/units/optee/cases_and_environ.md index 49f6a13ad2..c030e97314 100644 --- a/contrib/checkbox-ce-oem/checkbox-provider-ce-oem/units/optee/cases_and_environ.md +++ b/contrib/checkbox-ce-oem/checkbox-provider-ce-oem/units/optee/cases_and_environ.md @@ -1,94 +1,28 @@ -## environ keys for optee test +## environ keys for optee tests + - OPTEE_CASES - - Affected Test Cases: - - [ce-oem-optee-test-list](#ce-oem-optee-test-list) - - [ce-oem-optee-test-list-pkcs11](#ce-oem-optee-test-list-pkcs11) + - Affected Test Cases: + - [ce-oem-optee-test-list](#ce-oem-optee-test-list) + - [ce-oem-optee-test-list-pkcs11](#ce-oem-optee-test-list-pkcs11) -## Detailed test cases -### ce-oem-optee/device-node -- **environ :** None -- **summary :** Check OP-TEE device node has been probed in the system. -- **description :** -``` -None -``` -- **command :** -``` -node="$(find /dev -type c -regex '.*/\(tee\|teepriv\)[0-9]')" -if [[ -n $node ]]; then - echo -e "\nInfo: Find OP-TEE node in the system!" - for x in $node - do - echo -e "\n$x" - done -else - echo -e "\nError: Not able to find OP-TEE node in the system!" - exit 1 -fi -``` +## Detailed test cases contains environ variable +### ce-oem-optee-test-list +- **summary:** +Collect the test cases support by OP-TEE test(xtest) -[Back to top](#top) -### ce-oem-optee/xtest-check -- **environ :** None -- **summary :** Check if xtest is in the system. -- **description :** +- **description:** ``` None ``` -- **command :** -``` -tool=$(look_up_xtest.py) -exit_status=$? -if [[ "$exit_status" -eq 0 ]]; then - echo "Info: Found xtest runnable $tool" -else - echo "Error: Not able to found xtest runnable tool" - exit 1 -fi -``` -[Back to top](#top) -### ce-oem-optee/ta-install -- **environ :** None -- **summary :** Install Trusted Applications for xtest -- **description :** -``` -None -``` -- **command :** -``` -tool=$(look_up_xtest.py) -ta_path="" -if [[ "$tool" == "x-test.xtest" ]]; then - ta_path="$(find /var/snap -wholename */lib/optee_armtz)" -else - gadget=$(awk -F"." '{ print $1}' <<< "$tool") - ta_path="/snap/$gadget/current/lib/optee_armtz/" -fi -if [[ -z "$(find "$ta_path" -mindepth 1 -type f -o -type d)" ]]; then - echo -e "\nError: Not able to find TA!" - exit 1 -else - echo -e '\nAttempting to install TA ...' - if ! "$tool" --install-ta "$ta_path"; then - echo -e '\nError: TA installed FAIL!' - exit 1 - else - echo -e '\nInfo: TA installed SUCCESS!' - fi -fi -``` +- **file:** +[source file](jobs.pxu#L68) -[Back to top](#top) -### ce-oem-optee-test-list -- **environ :** OPTEE_CASES -- **summary :** Collect the test cases support by OP-TEE test(xtest) -- **description :** -``` -None -``` -- **command :** +- **environ:** +OPTEE_CASES + +- **command:** ``` filepath="" if [[ -n "$OPTEE_CASES" ]]; then @@ -98,16 +32,24 @@ else fi parse_optee_test.py "$filepath" ``` - [Back to top](#top) + ### ce-oem-optee-test-list-pkcs11 -- **environ :** OPTEE_CASES -- **summary :** Collect the test cases related with PKCS11 support by OP-TEE test(xtest) -- **description :** +- **summary:** +Collect the test cases related with PKCS11 support by OP-TEE test(xtest) + +- **description:** ``` None ``` -- **command :** + +- **file:** +[source file](jobs.pxu#L83) + +- **environ:** +OPTEE_CASES + +- **command:** ``` filepath="" if [[ -n "$OPTEE_CASES" ]]; then @@ -117,33 +59,4 @@ else fi parse_optee_test.py "$filepath" -p ``` - -[Back to top](#top) -### ce-oem-optee/xtest-suite-description -- **environ :** None -- **summary :** OP-TEE test by using xtest to test suite {{ suite }} {{ description }} -- **template_summary :** None -- **description :** -``` -None -``` -- **command :** -``` - {{ tool }} -t {{ suite }} {{ test_id }} -``` - -[Back to top](#top) -### ce-oem-optee/xtest-pkcs11-description -- **environ :** None -- **summary :** OP-TEE test by using xtest to test PKCS11 related {{ description }} -- **template_summary :** None -- **description :** -``` -None -``` -- **command :** -``` - {{ tool }} -t {{ suite }} {{ test_id }} -``` - [Back to top](#top) diff --git a/contrib/checkbox-ce-oem/checkbox-provider-ce-oem/units/otg/cases_and_environ.md b/contrib/checkbox-ce-oem/checkbox-provider-ce-oem/units/otg/cases_and_environ.md index dcc4983997..fb43641479 100644 --- a/contrib/checkbox-ce-oem/checkbox-provider-ce-oem/units/otg/cases_and_environ.md +++ b/contrib/checkbox-ce-oem/checkbox-provider-ce-oem/units/otg/cases_and_environ.md @@ -1,20 +1,29 @@ -## environ keys for otg test +## environ keys for otg tests + - OTG - - Affected Test Cases: - - [otg_ports](#otg_ports) + - Affected Test Cases: + - [otg_ports](#otg_ports) -## Detailed test cases +## Detailed test cases contains environ variable ### otg_ports -- **environ :** OTG -- **summary :** Gather list of USB ports and UDC. -- **description :** +- **summary:** +Gather list of USB ports and UDC. + +- **description:** ``` A USB port and UDC mapping resource that relies on the user specifying in config varirable. Usage of parameter: OTG={port1}:{node1} {port2}:{node2} ... e.g. OTG=USB-C1:11200000 USB-Micro:112a1000 ``` -- **command :** + +- **file:** +[source file](jobs.pxu#L1) + +- **environ:** +OTG + +- **command:** ``` if [ "$OTG" ]; then multiple-otg.sh -c "$OTG" @@ -22,65 +31,4 @@ else echo "OTG config variable: not found" fi ``` - -[Back to top](#top) -### ce-oem-otg/g_serial-USB_port -- **environ :** None -- **summary :** Check {USB_port} can be detected as a serial device -- **template_summary :** None -- **description :** -``` - Check that after connecting the device under test (DUT) to another device - (host), {USB_port} can be detected as a serial device by the host. -``` -- **command :** -``` - # shellcheck disable=SC2050 - if [ {Mode} != "otg" ]; then - echo -e "Error: USB mode is {Mode} mode, but expected in otg mode." - exit 1 - fi - multiple-otg.sh -u {UDC} -f acm -``` - -[Back to top](#top) -### ce-oem-otg/g_mass_storage-USB_port -- **environ :** None -- **summary :** Check {USB_port} can be detected as a mass storage device -- **template_summary :** None -- **description :** -``` - Check that after connecting the device under test (DUT) to another device - (host), {USB_port} can be detected as a mass storage device by the host. -``` -- **command :** -``` - # shellcheck disable=SC2050 - if [ {Mode} != "otg" ]; then - echo -e "Error: USB mode is {Mode} mode, but expected in otg mode." - exit 1 - fi - multiple-otg.sh -u {UDC} -f mass_storage -``` - -[Back to top](#top) -### ce-oem-otg/g_ether-USB_port -- **environ :** None -- **summary :** Check {USB_port} can be detected as USB ethernet device. -- **template_summary :** None -- **description :** -``` - Check that after connecting the device under test (DUT) to another device - (host), {USB_port} can be detected as a USB ethernet device by the host. -``` -- **command :** -``` - # shellcheck disable=SC2050 - if [ {Mode} != "otg" ]; then - echo -e "Error: USB mode is {Mode} mode, but expected in otg mode." - exit 1 - fi - multiple-otg.sh -u {UDC} -f ecm -``` - [Back to top](#top) diff --git a/contrib/checkbox-ce-oem/checkbox-provider-ce-oem/units/rpmsg/cases_and_environ.md b/contrib/checkbox-ce-oem/checkbox-provider-ce-oem/units/rpmsg/cases_and_environ.md index 88deede6ac..08d9d2c41b 100644 --- a/contrib/checkbox-ce-oem/checkbox-provider-ce-oem/units/rpmsg/cases_and_environ.md +++ b/contrib/checkbox-ce-oem/checkbox-provider-ce-oem/units/rpmsg/cases_and_environ.md @@ -1,78 +1,33 @@ -## environ keys for rpmsg test +## environ keys for rpmsg tests + - RPMSG_RP_FIRMWARE_MAPPING - - Affected Test Cases: - - [ce-oem-rpmsg/rp-firmware-mapping](#ce-oem-rpmsg/rp-firmware-mapping) + - Affected Test Cases: + - [ce-oem-rpmsg/rp-firmware-mapping](#ce-oem-rpmsg/rp-firmware-mapping) - RPMSG_RP_FIRMWARE_PATH - - Affected Test Cases: - - [ce-oem-rpmsg/rp-firmware-mapping](#ce-oem-rpmsg/rp-firmware-mapping) - -## Detailed test cases -### ce-oem-rpmsg/detect-device -- **environ :** None -- **summary :** Check if the RPMSG devices is initialed. -- **description :** -``` -None -``` -- **command :** -``` -rpmsg_tests.py --type detect -``` - -[Back to top](#top) -### ce-oem-rpmsg/pingpong -- **environ :** None -- **summary :** Check if M series core RPMSG is loaded and pingpong demo is completed. -- **description :** -``` -None -``` -- **command :** -``` -rpmsg_tests.py --type pingpong -``` - -[Back to top](#top) -### ce-oem-rpmsg/serial-tty -- **environ :** None -- **summary :** Check if M series core RPMSG is loaded and RPMSG TTY works. -- **description :** -``` -None -``` -- **command :** -``` -rpmsg_tests.py --type serial-tty -``` + - Affected Test Cases: + - [ce-oem-rpmsg/rp-firmware-mapping](#ce-oem-rpmsg/rp-firmware-mapping) -[Back to top](#top) +## Detailed test cases contains environ variable ### ce-oem-rpmsg/rp-firmware-mapping -- **environ :** RPMSG_RP_FIRMWARE_MAPPING RPMSG_RP_FIRMWARE_PATH -- **summary :** List Remote Processor firmwares and RPMSG node mapping -- **description :** +- **summary:** +List Remote Processor firmwares and RPMSG node mapping + +- **description:** ``` List firmware and RPMSG node mapping for reload Remote Processor firmware test RPMSG_RP_FIRMWARE_MAPPING="remoteproc0:test-1.elf remoteproc0:test-2.elf" RPMSG_RP_FIRMWARE_PATH="/home/user1" ``` -- **command :** -``` -rpmsg_load_firmware.py resource-reload --path "$RPMSG_RP_FIRMWARE_PATH" --mapping "$RPMSG_RP_FIRMWARE_MAPPING" -``` -[Back to top](#top) -### ce-oem-rpmsg/reload-rp-firmware-test -- **environ :** None -- **summary :** Reload Remote Processor firmware to {firmware} via RPMSG {device} -- **template_summary :** Reload Remote Processor firmware via RPMSG -- **description :** -``` -None -``` -- **command :** +- **file:** +[source file](jobs.pxu#L36) + +- **environ:** +RPMSG_RP_FIRMWARE_MAPPING RPMSG_RP_FIRMWARE_PATH + +- **command:** ``` - rpmsg_load_firmware.py test-reload --device {device} --file {firmware} --path {path} +rpmsg_load_firmware.py resource-reload --path "$RPMSG_RP_FIRMWARE_PATH" --mapping "$RPMSG_RP_FIRMWARE_MAPPING" ``` - [Back to top](#top) diff --git a/contrib/checkbox-ce-oem/checkbox-provider-ce-oem/units/serial/cases_and_environ.md b/contrib/checkbox-ce-oem/checkbox-provider-ce-oem/units/serial/cases_and_environ.md index 45497d8ede..b460e43fe2 100644 --- a/contrib/checkbox-ce-oem/checkbox-provider-ce-oem/units/serial/cases_and_environ.md +++ b/contrib/checkbox-ce-oem/checkbox-provider-ce-oem/units/serial/cases_and_environ.md @@ -1,17 +1,19 @@ -## environ keys for serial test +## environ keys for serial tests + - SERIAL_CONSOLE_PORTS - - Affected Test Cases: - - [ce-oem-serial/serial-console-list](#ce-oem-serial/serial-console-list) + - Affected Test Cases: + - [ce-oem-serial/serial-console-list](#ce-oem-serial/serial-console-list) - SERIAL_PORTS - - Affected Test Cases: - - [ce-oem-serial/serial-list](#ce-oem-serial/serial-list) + - Affected Test Cases: + - [ce-oem-serial/serial-list](#ce-oem-serial/serial-list) -## Detailed test cases +## Detailed test cases contains environ variable ### ce-oem-serial/serial-console-list -- **environ :** SERIAL_CONSOLE_PORTS -- **summary :** Generates a serial console resource based on user supplied configuration -- **description :** +- **summary:** +Generates a serial console resource based on user supplied configuration + +- **description:** ``` A serial console resource that relies on the user specifying the number of serial console port. @@ -19,19 +21,27 @@ This is to allow template jobs to then be instantiated. TYPE:NODE:BAUDRATE SERIAL_CONSOLE_PORTS=USB:/dev/ttyUSB1:115200 ``` -- **command :** + +- **file:** +[source file](jobs.pxu#L1) + +- **environ:** +SERIAL_CONSOLE_PORTS + +- **command:** ``` if [ -z "$SERIAL_CONSOLE_PORTS" ]; then exit 0 fi serial_config_parser.py "$SERIAL_CONSOLE_PORTS" ``` - [Back to top](#top) + ### ce-oem-serial/serial-list -- **environ :** SERIAL_PORTS -- **summary :** Generates a serial resource based on user supplied configuration -- **description :** +- **summary:** +Generates a serial resource based on user supplied configuration + +- **description:** ``` A serial resource that relies on the user specifying the number of serial port. @@ -39,41 +49,18 @@ This is to allow template jobs to then be instantiated. TYPE:NODE:BAUDRATE SERIAL_PORTS="RS485:/dev/ttyS0:9600 RS485:/dev/ttyS1:9600 RS232:/dev/ttyS2:115200" ``` -- **command :** + +- **file:** +[source file](jobs.pxu#L44) + +- **environ:** +SERIAL_PORTS + +- **command:** ``` if [ -z "$SERIAL_PORTS" ]; then exit 0 fi serial_config_parser.py "$SERIAL_PORTS" ``` - -[Back to top](#top) -### ce-oem-serial/serial-console-tests -- **environ :** None -- **summary :** To check if the serial port {{ type }} ({{ node }}) can work as a console -- **template_summary :** To check if the serial ports can work as a console -- **description :** -``` - Have to connect the serial port back to itself - before starting this test -``` -- **command :** -``` - serial_test.py {{ node }} --mode console --type {{ type }} --baudrate {{ baudrate }} -``` - -[Back to top](#top) -### ce-oem-serial/serial-transmit-data-tests -- **environ :** None -- **summary :** None -- **template_summary :** Transmit data via serial ports -- **description :** -``` - Have to connect the serial port to serial testing server -``` -- **command :** -``` - serial_test.py {{ node }} --mode client --type {{ type }} --group {{ group }} --baudrate {{ baudrate }} -``` - [Back to top](#top) diff --git a/contrib/checkbox-ce-oem/checkbox-provider-ce-oem/units/spi/cases_and_environ.md b/contrib/checkbox-ce-oem/checkbox-provider-ce-oem/units/spi/cases_and_environ.md new file mode 100644 index 0000000000..f7d39fc063 --- /dev/null +++ b/contrib/checkbox-ce-oem/checkbox-provider-ce-oem/units/spi/cases_and_environ.md @@ -0,0 +1,29 @@ + +## environ keys for spi tests + +- SPI_DEVICE_COUNT + - Affected Test Cases: + - [ce-oem-spi/detect](#ce-oem-spi/detect) + +## Detailed test cases contains environ variable +### ce-oem-spi/detect +- **summary:** +To detect if the spi device exist + +- **description:** +``` +PURPOSE: +Check if the SPI devices exist +``` + +- **file:** +[source file](jobs.pxu#L1) + +- **environ:** +SPI_DEVICE_COUNT + +- **command:** +``` +spidev_test.py -d "${SPI_DEVICE_COUNT:-1}" +``` +[Back to top](#top) diff --git a/contrib/checkbox-ce-oem/checkbox-provider-ce-oem/units/stress/cases_and_environ.md b/contrib/checkbox-ce-oem/checkbox-provider-ce-oem/units/stress/cases_and_environ.md index 7f2960e9d6..0cd76516ef 100644 --- a/contrib/checkbox-ce-oem/checkbox-provider-ce-oem/units/stress/cases_and_environ.md +++ b/contrib/checkbox-ce-oem/checkbox-provider-ce-oem/units/stress/cases_and_environ.md @@ -1,43 +1,98 @@ -## environ keys for stress test +## environ keys for stress tests + - LD_LIBRARY_PATH - - Affected Test Cases: - - [ce-oem-init-boot-loop-data](#ce-oem-init-boot-loop-data) - - [ce-oem-post-cold-boot-loop-by-pdu-reboot1](#ce-oem-post-cold-boot-loop-by-pdu-reboot1) - - [ce-oem-post-cold-boot-loop-by-pdu-rebootreboot_id](#ce-oem-post-cold-boot-loop-by-pdu-rebootreboot_id) + - Affected Test Cases: + - [ce-oem-init-boot-loop-data](#ce-oem-init-boot-loop-data) + - [ce-oem-post-cold-boot-loop-by-pdu-reboot1](#ce-oem-post-cold-boot-loop-by-pdu-reboot1) + - [ce-oem-post-cold-boot-loop-by-pdu-rebootreboot_id](#ce-oem-post-cold-boot-loop-by-pdu-rebootreboot_id) - STRESS_BOOT_WAKEUP_DELAY - - Affected Test Cases: - - [ce-oem-cold-boot-loop-by-pdu-reboot1](#ce-oem-cold-boot-loop-by-pdu-reboot1) - - [ce-oem-cold-boot-loop-by-pdu-rebootreboot_id](#ce-oem-cold-boot-loop-by-pdu-rebootreboot_id) + - Affected Test Cases: + - [ce-oem-cold-boot-loop-by-pdu-reboot1](#ce-oem-cold-boot-loop-by-pdu-reboot1) + - [ce-oem-cold-boot-loop-by-pdu-rebootreboot_id](#ce-oem-cold-boot-loop-by-pdu-rebootreboot_id) - STRESS_BOOT_WAIT_DELAY - - Affected Test Cases: - - [ce-oem-cold-boot-loop-by-pdu-rebootreboot_id](#ce-oem-cold-boot-loop-by-pdu-rebootreboot_id) + - Affected Test Cases: + - [ce-oem-cold-boot-loop-by-pdu-rebootreboot_id](#ce-oem-cold-boot-loop-by-pdu-rebootreboot_id) - NETWORK_PDU_TYPE - - Affected Test Cases: - - [ce-oem-cold-boot-loop-by-pdu-rebootreboot_id](#ce-oem-cold-boot-loop-by-pdu-rebootreboot_id) + - Affected Test Cases: + - [ce-oem-cold-boot-loop-by-pdu-rebootreboot_id](#ce-oem-cold-boot-loop-by-pdu-rebootreboot_id) - NETWORK_PDU_CONF - - Affected Test Cases: - - [ce-oem-cold-boot-loop-by-pdu-rebootreboot_id](#ce-oem-cold-boot-loop-by-pdu-rebootreboot_id) + - Affected Test Cases: + - [ce-oem-cold-boot-loop-by-pdu-rebootreboot_id](#ce-oem-cold-boot-loop-by-pdu-rebootreboot_id) -## Detailed test cases +## Detailed test cases contains environ variable ### ce-oem-init-boot-loop-data -- **environ :** LD_LIBRARY_PATH -- **summary :** Generate the baseline data set to test against -- **description :** +- **summary:** +Generate the baseline data set to test against + +- **description:** ``` This creates baseline data sets which be considered the master copies and all further tests will be compared against these. ``` -- **command :** + +- **file:** +[source file](boot.pxu#L1) + +- **environ:** +LD_LIBRARY_PATH + +- **command:** ``` reboot_check_test.sh -d "$PLAINBOX_SESSION_SHARE/before_reboot" ``` +[Back to top](#top) + +### ce-oem-post-cold-boot-loop-by-pdu-reboot1 +- **summary:** +Post cold reboot service check - loop 1 + +- **description:** +``` +Check there are no failed services after the cold reboot +``` + +- **file:** +[source file](boot.pxu#L43) + +- **environ:** +LD_LIBRARY_PATH + +- **command:** +``` +reboot_check_test.sh -c "$PLAINBOX_SESSION_SHARE/before_reboot" -d "$PLAINBOX_SESSION_SHARE/reboot_cycle1" -s +``` +[Back to top](#top) +### ce-oem-post-cold-boot-loop-by-pdu-rebootreboot_id +- **summary:** +Post cold reboot service check - loop {reboot_id} + +- **template_summary:** +None + +- **description:** +``` +Check there are no failed services after the cold reboot +``` + +- **file:** +[source file](boot.pxu#L90) + +- **environ:** +LD_LIBRARY_PATH + +- **command:** +``` + reboot_check_test.sh -c "$PLAINBOX_SESSION_SHARE/before_reboot" -d "$PLAINBOX_SESSION_SHARE/reboot_cycle{reboot_id}" -s +``` [Back to top](#top) + ### ce-oem-cold-boot-loop-by-pdu-reboot1 -- **environ :** STRESS_BOOT_WAKEUP_DELAY -- **summary :** Cold reboot with PDU - loop 1 -- **description :** +- **summary:** +Cold reboot with PDU - loop 1 + +- **description:** ``` This tests powers off the system and then powers it on using Network PDU The 'NETWORK_PDU_CONF,NETWORK_PDU_TYPE,STRESS_BOOT_WAIT_DELAY,STRESS_BOOT_WAKEUP_DELAY' need to be provided as following format @@ -52,30 +107,27 @@ e.g. STRESS_BOOT_WAKEUP_DELAY=100 STRESS_BOOT_WAIT_DELAY=60 ``` -- **command :** + +- **file:** +[source file](boot.pxu#L16) + +- **environ:** +STRESS_BOOT_WAKEUP_DELAY + +- **command:** ``` cold_reboot_by_pdu.sh -t "$NETWORK_PDU_TYPE" -p "$NETWORK_PDU_CONF" -d "$STRESS_BOOT_WAKEUP_DELAY" ``` - [Back to top](#top) -### ce-oem-post-cold-boot-loop-by-pdu-reboot1 -- **environ :** LD_LIBRARY_PATH -- **summary :** Post cold reboot service check - loop 1 -- **description :** -``` -Check there are no failed services after the cold reboot -``` -- **command :** -``` -reboot_check_test.sh -c "$PLAINBOX_SESSION_SHARE/before_reboot" -d "$PLAINBOX_SESSION_SHARE/reboot_cycle1" -s -``` -[Back to top](#top) ### ce-oem-cold-boot-loop-by-pdu-rebootreboot_id -- **environ :** STRESS_BOOT_WAKEUP_DELAY STRESS_BOOT_WAIT_DELAY NETWORK_PDU_TYPE NETWORK_PDU_CONF -- **summary :** Cold reboot with PDU - loop {reboot_id} -- **template_summary :** None -- **description :** +- **summary:** +Cold reboot with PDU - loop {reboot_id} + +- **template_summary:** +None + +- **description:** ``` This tests powers off the system and then powers it on using Network PDU The 'NETWORK_PDU_CONF,NETWORK_PDU_TYPE,STRESS_BOOT_WAIT_DELAY,STRESS_BOOT_WAKEUP_DELAY' need to be provided as following format @@ -90,24 +142,16 @@ reboot_check_test.sh -c "$PLAINBOX_SESSION_SHARE/before_reboot" -d "$PLAINBOX_SE STRESS_BOOT_WAKEUP_DELAY=100 STRESS_BOOT_WAIT_DELAY=60 ``` -- **command :** + +- **file:** +[source file](boot.pxu#L59) + +- **environ:** +STRESS_BOOT_WAKEUP_DELAY STRESS_BOOT_WAIT_DELAY NETWORK_PDU_TYPE NETWORK_PDU_CONF + +- **command:** ``` sleep "${{STRESS_BOOT_WAIT_DELAY:-120}}" cold_reboot_by_pdu.sh -t "${{NETWORK_PDU_TYPE}}" -p "${{NETWORK_PDU_CONF}}" -d "${{STRESS_BOOT_WAKEUP_DELAY:-120}}" ``` - -[Back to top](#top) -### ce-oem-post-cold-boot-loop-by-pdu-rebootreboot_id -- **environ :** LD_LIBRARY_PATH -- **summary :** Post cold reboot service check - loop {reboot_id} -- **template_summary :** None -- **description :** -``` -Check there are no failed services after the cold reboot -``` -- **command :** -``` - reboot_check_test.sh -c "$PLAINBOX_SESSION_SHARE/before_reboot" -d "$PLAINBOX_SESSION_SHARE/reboot_cycle{reboot_id}" -s -``` - [Back to top](#top) diff --git a/contrib/checkbox-ce-oem/checkbox-provider-ce-oem/units/strict-confinement/cases_and_environ.md b/contrib/checkbox-ce-oem/checkbox-provider-ce-oem/units/strict-confinement/cases_and_environ.md index 954404e328..9931360705 100644 --- a/contrib/checkbox-ce-oem/checkbox-provider-ce-oem/units/strict-confinement/cases_and_environ.md +++ b/contrib/checkbox-ce-oem/checkbox-provider-ce-oem/units/strict-confinement/cases_and_environ.md @@ -1,150 +1,79 @@ -## environ keys for strict-confinement test +## environ keys for strict-confinement tests + - STRESS_BOOT_WAKEUP_DELAY - - Affected Test Cases: - - [dbus-cold-boot-reboot](#dbus-cold-boot-reboot) + - Affected Test Cases: + - [dbus-cold-boot-reboot](#dbus-cold-boot-reboot) - RTC_DEVICE_FILE - - Affected Test Cases: - - [dbus-cold-boot-reboot](#dbus-cold-boot-reboot) + - Affected Test Cases: + - [dbus-cold-boot-reboot](#dbus-cold-boot-reboot) - LD_LIBRARY_PATH - - Affected Test Cases: - - [dbus-cold-boot-test](#dbus-cold-boot-test) - - [dbus-warm-boot-test](#dbus-warm-boot-test) - -## Detailed test cases -### strict-confine/mediacard/sdhc-insert -- **environ :** None -- **summary :** Test that insertion of an SDHC card is detected -- **description :** -``` -Verify the SDHC card insertion by checking journal log. -``` -- **command :** -``` -test-strict-confinement.run-watcher insertion mediacard -``` - -[Back to top](#top) -### strict-confine/mediacard/sdhc-storage -- **environ :** None -- **summary :** Test reading & writing to a SDHC Card -- **description :** -``` -This test is automated and executes after the mediacard/sdhc-insert -test is run. It tests reading and writing to the SDHC card. -``` -- **command :** -``` -test-strict-confinement.usb-read-write -``` + - Affected Test Cases: + - [dbus-cold-boot-test](#dbus-cold-boot-test) + - [dbus-warm-boot-test](#dbus-warm-boot-test) -[Back to top](#top) -### strict-confine/mediacard/sdhc-remove -- **environ :** None -- **summary :** Test that removal of an SDHC card is detected -- **description :** -``` -Verify the SDHC card insertion by checking journal log. -``` -- **command :** -``` -test-strict-confinement.run-watcher removal mediacard -``` - -[Back to top](#top) +## Detailed test cases contains environ variable ### dbus-cold-boot-reboot -- **environ :** STRESS_BOOT_WAKEUP_DELAY RTC_DEVICE_FILE -- **summary :** Perform cold reboot via dbus -- **description :** +- **summary:** +Perform cold reboot via dbus + +- **description:** ``` This test will check your system shutdown/booting cycle via dbus command. ``` -- **command :** + +- **file:** +[source file](confinement.pxu#L1) + +- **environ:** +STRESS_BOOT_WAKEUP_DELAY RTC_DEVICE_FILE + +- **command:** ``` set -e rtcwake -d "${RTC_DEVICE_FILE:-rtc0}" -v -m on -s "${STRESS_BOOT_WAKEUP_DELAY:-120}" & test-strict-confinement.reboot cold ``` - [Back to top](#top) + ### dbus-cold-boot-test -- **environ :** LD_LIBRARY_PATH -- **summary :** Cold boot system configuration test via dbus -- **description :** +- **summary:** +Cold boot system configuration test via dbus + +- **description:** ``` This is a job to check system bootup without error after cold reboot. ``` -- **command :** + +- **file:** +[source file](confinement.pxu#L24) + +- **environ:** +LD_LIBRARY_PATH + +- **command:** ``` reboot_check_test.sh -c "$PLAINBOX_SESSION_SHARE/before_reboot" -d "$PLAINBOX_SESSION_SHARE/cold_reboot" -s -f ``` - [Back to top](#top) -### dbus-warm-boot-reboot -- **environ :** None -- **summary :** Perform warm reboot via dbus -- **description :** -``` -Perform warm reboot of the system via dbus command. -``` -- **command :** -``` -test-strict-confinement.reboot warm -``` -[Back to top](#top) ### dbus-warm-boot-test -- **environ :** LD_LIBRARY_PATH -- **summary :** Warm boot system configuration test via dbus -- **description :** +- **summary:** +Warm boot system configuration test via dbus + +- **description:** ``` This is a job to check system bootup without error after warm reboot. ``` -- **command :** -``` -reboot_check_test.sh -c "$PLAINBOX_SESSION_SHARE/before_reboot" -d "$PLAINBOX_SESSION_SHARE/warm_reboot" -s -f -``` -[Back to top](#top) -### strict-confinement/timedatectl-timezone -- **environ :** None -- **summary :** Test timezone control with timedatectl -- **description :** -``` -Test timezon control with timedatectl command in strict confinement mode. -``` -- **command :** -``` -test-strict-confinement.timedatectl-timezone -``` +- **file:** +[source file](confinement.pxu#L59) -[Back to top](#top) -### strict-confinement/timedatectl-ntp -- **environ :** None -- **summary :** Test NTP service with timedatectl -- **description :** -``` -The test ensures that the system's local time can sync with the NTP service. -Additionally, it verifies that the system's local time can be set up when -the NTP service is inactive in strict confinement mode. -``` -- **command :** -``` -test-strict-confinement.timedatectl-ntp -``` +- **environ:** +LD_LIBRARY_PATH -[Back to top](#top) -### strict-confine/temperature-test -- **environ :** None -- **summary :** Check Thermal temperature of {{ name }} - {{ type }} -- **template_summary :** None -- **description :** -``` - Test a thermal temperature for {{ name }} - {{ type }}. +- **command:** ``` -- **command :** -``` - test-strict-confinement.thermal-test monitor -n {{ name }} --extra-commands "dd if=/dev/zero of=/dev/null" +reboot_check_test.sh -c "$PLAINBOX_SESSION_SHARE/before_reboot" -d "$PLAINBOX_SESSION_SHARE/warm_reboot" -s -f ``` - [Back to top](#top) diff --git a/contrib/checkbox-ce-oem/checkbox-provider-ce-oem/units/video-codec/cases_and_environ.md b/contrib/checkbox-ce-oem/checkbox-provider-ce-oem/units/video-codec/cases_and_environ.md index 7d7a62bbbd..7587ad595a 100644 --- a/contrib/checkbox-ce-oem/checkbox-provider-ce-oem/units/video-codec/cases_and_environ.md +++ b/contrib/checkbox-ce-oem/checkbox-provider-ce-oem/units/video-codec/cases_and_environ.md @@ -1,43 +1,61 @@ -## environ keys for video-codec test +## environ keys for video-codec tests + - VIDEO_CODEC_JSON_CONFIG_NAME - - Affected Test Cases: - - [video_codec_resource](#video_codec_resource) + - Affected Test Cases: + - [video_codec_resource](#video_codec_resource) - VIDEO_CODEC_TESTING_DATA - - Affected Test Cases: - - [video_codec_resource](#video_codec_resource) + - Affected Test Cases: + - [video_codec_resource](#video_codec_resource) - PLAINBOX_PROVIDER_DATA - - Affected Test Cases: - - [video_codec_resource](#video_codec_resource) + - Affected Test Cases: + - [video_codec_resource](#video_codec_resource) - GST_LAUNCH_BIN - - Affected Test Cases: - - [ce-oem-video-codec/gst_v4l2_video_decoder_md5_checksum_comparison](#ce-oem-video-codec/gst_v4l2_video_decoder_md5_checksum_comparison) + - Affected Test Cases: + - [ce-oem-video-codec/gst_v4l2_video_decoder_md5_checksum_comparison](#ce-oem-video-codec/gst_v4l2_video_decoder_md5_checksum_comparison) -## Detailed test cases +## Detailed test cases contains environ variable ### video_codec_resource -- **environ :** VIDEO_CODEC_JSON_CONFIG_NAME VIDEO_CODEC_TESTING_DATA PLAINBOX_PROVIDER_DATA -- **summary :** Generates mappings for all Vedio Codec Scenarios -- **description :** +- **summary:** +Generates mappings for all Vedio Codec Scenarios + +- **description:** ``` Generate resource for all Video Codec scenarios. ``` -- **command :** + +- **file:** +[source file](jobs.pxu#L1) + +- **environ:** +VIDEO_CODEC_JSON_CONFIG_NAME VIDEO_CODEC_TESTING_DATA PLAINBOX_PROVIDER_DATA + +- **command:** ``` gst_resources_generator.py "$VIDEO_CODEC_JSON_CONFIG_NAME" -gtdp "$VIDEO_CODEC_TESTING_DATA" ``` - [Back to top](#top) + ### ce-oem-video-codec/gst_v4l2_video_decoder_md5_checksum_comparison -- **environ :** GST_LAUNCH_BIN -- **summary :** MD5 checksum comparison {{ width }}x{{ height }}-{{ decoder_plugin }}-{{ color_space }} -- **template_summary :** To check if the MD5 checksum is same as golden reference under specific decoder -- **description :** +- **summary:** +MD5 checksum comparison {{ width }}x{{ height }}-{{ decoder_plugin }}-{{ color_space }} + +- **template_summary:** +To check if the MD5 checksum is same as golden reference under specific decoder + +- **description:** ``` Compare the MD5 checksum to golden reference by decoding the {{ width }}x{{ height }}-{{ decoder_plugin }}-{{ color_space }} video via gstreamer ``` -- **command :** + +- **file:** +[source file](jobs.pxu#L11) + +- **environ:** +GST_LAUNCH_BIN + +- **command:** ``` gst_v4l2_video_decoder_md5_checksum_comparison.py -dp {{decoder_plugin}} -cs {{color_space}} -gp {{golden_sample_file}} -gmp {{golden_md5_checkum_file}} ``` - [Back to top](#top)