Rebased description to purpose/steps (bugfix) (#1450)

* move to _purpose from _description in 6LoWPAN * correct the dock test definitions * fix the acpi tests * fix the benchmarks job definitions * fix the Bluetooth job definitions * fix the camera job definitions * fix the codecs job definitions * fix the cpu job definitions * fix the cpu disk definitions * remove the problematic newline * Apply suggestions from code review Applied Max's suggestions (except one) Co-authored-by: Massimiliano <[email protected]> * Apply suggestions from code review Co-authored-by: Massimiliano <[email protected]> * Applied suggestion in bluetooth * Apply suggestions from code review Co-authored-by: Pierre Equoy <[email protected]> --------- Co-authored-by: Maciej Kisielewski <[email protected]> Co-authored-by: Fernando Bravo <[email protected]> Co-authored-by: ferbraher <[email protected]> Co-authored-by: Pierre Equoy <[email protected]>
canonical · Sep 3, 2024 · 93b2e02 · 93b2e02
1 parent c3ab17b
commit 93b2e02
Show file tree

Hide file tree

Showing 10 changed files with 458 additions and 434 deletions.
diff --git a/providers/base/units/6lowpan/jobs.pxu b/providers/base/units/6lowpan/jobs.pxu
@@ -7,5 +7,5 @@ command:
     grep -E "$config=(y|m)" /boot/config-"$(uname -r)" || exit 1
  done
 _summary: kernel config options for 6LoWPAN
-_description:
- Checks the kernel config options for 6LoWPAN / IEEE802.15.4 support
+_purpose: Checks the kernel config options for 6LoWPAN / IEEE802.15.4 support
+
diff --git a/providers/base/units/acpi/jobs.pxu b/providers/base/units/acpi/jobs.pxu
@@ -1,7 +1,7 @@
 id: acpi/oem_osi
-_summary: test ACPI OEM _OSI strings
-_description:
-  This checks if the depreciated OEM _OSI strings are still used by checking the ACPI DSDT and SSDT tables
+_summary: Test ACPI OEM _OSI strings
+_purpose:
+  This checks if the deprecated OEM _OSI strings are still used by checking the ACPI DSDT and SSDT tables
 plugin: shell
 category_id: acpi
 requires:

diff --git a/providers/base/units/benchmarks/jobs.pxu b/providers/base/units/benchmarks/jobs.pxu
@@ -10,7 +10,7 @@ estimated_duration: 15.0
 user: root
 command: hdparm -t /dev/{name}
 _summary: Raw read timing benchmark of {name} using hdparm
-_description: This test runs hdparm timing of device reads as a benchmark for {name}
+_purpose: This test runs hdparm timing of device reads as a benchmark for {name}
 
 unit: template
 template-resource: device
@@ -24,7 +24,7 @@ estimated_duration: 10.0
 user: root
 command: hdparm -T /dev/{name}
 _summary: Cached read timing benchmark of {name} using hdparm
-_description: This test runs hdparm timing of cache reads as a benchmark for {name}
+_purpose: This test runs hdparm timing of cache reads as a benchmark for {name}
 
 plugin: shell
 category_id: com.canonical.plainbox::benchmarks
@@ -33,16 +33,17 @@ depends: graphics/xorg-version
 requires: package.name == 'gtkperf'
 command: python3 -c 'import re,sys,subprocess; (s, o) = subprocess.getstatusoutput("gtkperf -a"); [sys.exit(1) for i in [s] if s]; m = re.search("Total time:\s+(.*)\n", o); [print(i.group(1)+" Seconds") for i in [m] if m]'
 estimated_duration: 30.000
-_description:
- Run gtkperf to make sure that GTK based test cases work
+_purpose: Run gtkperf to make sure that GTK based test cases work
+_summary: Ensures that GTK based test cases are operational by running gtkperf.
 
 plugin: shell
 category_id: com.canonical.plainbox::benchmarks
 id: benchmarks/graphics/render-bench
 requires: package.name == 'render-bench'
 command: /usr/bin/time -f "%e Seconds" render_bench > /dev/null 2>&1
 estimated_duration: 52.000
-_description: Run Render-Bench XRender/Imlib2 benchmark
+_summary: Run Render-Bench XRender/Imlib2 benchmark
+_purpose: Execute the Render-Bench XRender/Imlib2 benchmark to assess graphics performance.
 
 plugin: shell
 category_id: com.canonical.plainbox::benchmarks
@@ -52,7 +53,8 @@ requires:
  'arm' in cpuinfo.type
 command:
  glmark2-es2 2>&1 | sed -e :a -e '$!N;s/\n/ /;ta' | sed -E 's/.*(Score:\s+[0-9]+).*/\1/'
-_description: Run GLmark2-ES2 benchmark
+_purpose: Run GLmark2-ES2 benchmark
+_summary: Execute the GLmark2-ES2 benchmark on ARM devices.
 
 plugin: shell
 category_id: com.canonical.plainbox::benchmarks
@@ -63,30 +65,34 @@ requires:
 command:
  glmark2 2>&1 | sed -e :a -e '$!N;s/\n/ /;ta' | sed -E 's/.*(Score:\s+[0-9]+).*/\1/'
 estimated_duration: 306.000
-_description: Run GLmark2 benchmark
+_purpose: Run GLmark2 benchmark
+_summary: Execute GLmark2 benchmark and extract score.
 
 plugin: shell
 category_id: com.canonical.plainbox::benchmarks
 id: benchmarks/network/wifi_time_to_reconnect
 requires: device.category == 'WIRELESS'
 command: wifi_time2reconnect.py
-_description: Check the time needed to reconnect to a WIFI access point
+_purpose: Check the time needed to reconnect to a Wi-Fi access point
+_summary: Measure Wi-Fi reconnection time.
 
 plugin: shell
 category_id: com.canonical.plainbox::benchmarks
 id: benchmarks/system/cpu_on_idle
 estimated_duration: 10.0
 requires: package.name == 'sysstat'
 command: iostat -x -m 1 10 | python3 -c 'import sys, re; lines="".join(sys.stdin.readlines()); l=[float(n) for n in (re.findall("idle\n.*?(\S+)\n", lines))]; print(sum(l)/len(l),"%")'
-_description: CPU utilization on an idle system.
+_purpose: CPU utilization on an idle system.
+_summary: Measure CPU utilization on an idle system.
 
 plugin: shell
 category_id: com.canonical.plainbox::benchmarks
 id: benchmarks/system/disk_on_idle
 estimated_duration: 10.0
 requires: package.name == 'sysstat'
 command: iostat -x -m 1 10 | python3 -c 'import sys, re; lines="".join(sys.stdin.readlines()); l=[float(n) for n in (re.findall("util\n.*?(\S+)\n", lines))]; print(sum(l)/len(l),"%")'
-_description: Disk utilization on an idle system.
+_purpose: Disk utilization on an idle system.
+_summary: Measure disk utilization on an idle system.
 
 plugin: shell
 category_id: com.canonical.plainbox::benchmarks
@@ -96,9 +102,8 @@ requires:
  cpuinfo.platform == 'x86_64'
 command: gputest_benchmark.py fur --width 1920 --height 1080 -f
 estimated_duration: 75.000
-_description:
- Run a stress test based on FurMark (OpenGL 2.1 or 3.2)
- Fullscreen 1920x1080 no antialiasing
+_purpose: Run a stress test based on FurMark (OpenGL 2.1 or 3.2) in fullscreen 1920x1080 no anti-aliasing
+_summary: Conduct a FurMark stress test in fullscreen 1920x1080 without anti-aliasing.
 
 plugin: shell
 category_id: com.canonical.plainbox::benchmarks
@@ -108,9 +113,8 @@ requires:
  cpuinfo.platform == 'x86_64'
 command: gputest_benchmark.py fur
 estimated_duration: 75.000
-_description:
- Run a stress test based on FurMark (OpenGL 2.1 or 3.2)
- Windowed 1024x640 no antialiasing
+_purpose: Run a stress test based on FurMark (OpenGL 2.1 or 3.2) windowed 1024x640 no anti-aliasing
+_summary: Conduct a FurMark-based OpenGL stress test at 1024x640 without anti-aliasing.
 
 plugin: shell
 category_id: com.canonical.plainbox::benchmarks
@@ -120,9 +124,8 @@ requires:
  cpuinfo.platform == 'x86_64'
 command: gputest_benchmark.py gi --width 1920 --height 1080 -f
 estimated_duration: 75.00
-_description:
- Run GiMark, a geometry instancing test (OpenGL 3.3)
- Fullscreen 1920x1080 no antialiasing
+_purpose: Run GiMark, a geometry instancing test (OpenGL 3.3) fullscreen 1920x1080 no anti-aliasing
+_summary: Run GiMark OpenGL 3.3 benchmark at 1920x1080 fullscreen without anti-aliasing.
 
 plugin: shell
 category_id: com.canonical.plainbox::benchmarks
@@ -132,9 +135,9 @@ requires:
  cpuinfo.platform == 'x86_64'
 command: gputest_benchmark.py gi
 estimated_duration: 75.500
-_description:
- Run GiMark, a geometry instancing test (OpenGL 3.3)
- Windowed 1024x640 no antialiasing
+_purpose:
+ Run GiMark, a geometry instancing test (OpenGL 3.3) in a windowed 1024x640 resolution without anti-aliasing.
+_summary: Run GiMark OpenGL 3.3 geometry test at 1024x640 windowed without anti-aliasing.
 
 plugin: shell
 category_id: com.canonical.plainbox::benchmarks
@@ -144,9 +147,8 @@ requires:
  cpuinfo.platform == 'x86_64'
 command: gputest_benchmark.py tess --width 1920 --height 1080 -f
 estimated_duration: 75.000
-_description:
- Run a tessellation test based on TessMark (OpenGL 4.0)
- Fullscreen 1920x1080 no antialiasing
+_purpose: Run a tessellation test based on TessMark (OpenGL 4.0), fullscreen 1920x1080 with no anti-aliasing.
+_summary: Run TessMark tessellation test at 1920x1080 fullscreen without anti-aliasing.
 
 plugin: shell
 category_id: com.canonical.plainbox::benchmarks
@@ -155,6 +157,5 @@ requires:
  package.name == 'gputest'
  cpuinfo.platform == 'x86_64'
 command: gputest_benchmark.py tess
-_description:
- Run a tessellation test based on TessMark (OpenGL 4.0)
- Windowed 1024x640 no antialiasing
+_purpose: Run a tessellation test based on TessMark (OpenGL 4.0) Windowed 1024x640 no anti-aliasing
+_summary: Run TessMark tessellation test at 1024x640 windowed without anti-aliasing.