Skip to contentSkip to conversation

misc docs/build/CI improvements

PATCH In review Nicholas Piggin 3 participants 5 messages Jun 5, 2024 KVM

lore
Share & tools
lore
#0 lore raw

v2 cover misc docs/build/CI improvements

This just tidies up the two outstanding patches from this series (fix the wording of the migration group documetation, and make the artifact when: always comment a bit more understandable).

Thanks,
Nick

Nicholas Piggin (2):
doc: update unittests doc
gitlab-ci: Always save artifacts

 .gitlab-ci.yml     |  4 ++++
 docs/unittests.txt | 11 ++++++++---
 2 files changed, 12 insertions(+), 3 deletions(-)
Signature · 1 line
2.43.0
#1 lore raw

PATCH v2 1/2 doc: update unittests doc

Document the special groups, check path restrictions, and a small fix for check option syntax.

---
 docs/unittests.txt | 11 ++++++++---
 1 file changed, 8 insertions(+), 3 deletions(-)
docs/unittests.txt +8 -3
index 6ff9872cf..c4269f623 100644
@@ -69,8 +69,11 @@ groups
 groups = <group_name1> <group_name2> ...
 
 Used to group the test cases for the `run_tests.sh -g ...` run group
-option. Adding a test to the nodefault group will cause it to not be
-run by default.
+option. The group name is arbitrary, except for these special groups:
+- Tests in the "nodefault" group are not run by default (with no -g option).
+- Tests in the "migration" group are run with the migration harness and
+  are expected to make migrate_*() calls.
+- Tests in the "panic" group expect QEMU to enter the GUEST_PANICKED state.
 
 accel
 -----
@@ -89,8 +92,10 @@ Optional timeout in seconds, after which the test will be killed and fail.
 
 check
 -----
-check = <path>=<<value>
+check = <path>=<value>
 
 Check a file for a particular value before running a test. The check line
 can contain multiple files to check separated by a space, but each check
 parameter needs to be of the form <path>=<value>
+
+The path and value cannot contain space, =, or shell wildcard characters.
Signature · 1 line
2.43.0
#3 lore raw

PATCH v2 2/2 gitlab-ci: Always save artifacts

In reply to Nicholas Piggin

The unit test logs are important to have when a test fails so mark these as always save.

---
 .gitlab-ci.yml | 4 ++++
 1 file changed, 4 insertions(+)
.gitlab-ci.yml +4 -0
index 23bb69e24..0e4d6205f 100644
@@ -4,14 +4,18 @@ before_script:
  - dnf update -y
  - dnf install -y make python
 
+# By default artifacts are only saved on success. This uses when:always
+# because the test logs are important to help diagnose failures.
 .intree_template:
  artifacts:
+  when: always
   expire_in: 2 days
   paths:
    - logs
 
 .outoftree_template:
  artifacts:
+  when: always
   expire_in: 2 days
   paths:
    - build/logs
Signature · 1 line
2.43.0
Reviewed-by on v2 1/2
#2 lore raw

Re: [kvm-unit-tests PATCH v2 1/2] doc: update unittests doc

In reply to Nicholas Piggin
Quoted 42 lines · Nicholas Piggin

Document the special groups, check path restrictions, and a small fix for check option syntax.

---
 docs/unittests.txt | 11 ++++++++---
 1 file changed, 8 insertions(+), 3 deletions(-)
docs/unittests.txt +8 -3
index 6ff9872cf..c4269f623 100644
@@ -69,8 +69,11 @@ groups
 groups = <group_name1> <group_name2> ...
 
 Used to group the test cases for the `run_tests.sh -g ...` run group
-option. Adding a test to the nodefault group will cause it to not be
-run by default.
+option. The group name is arbitrary, except for these special groups:
+- Tests in the "nodefault" group are not run by default (with no -g option).
+- Tests in the "migration" group are run with the migration harness and
+  are expected to make migrate_*() calls.
+- Tests in the "panic" group expect QEMU to enter the GUEST_PANICKED state.
 
 accel
 -----
@@ -89,8 +92,10 @@ Optional timeout in seconds, after which the test will be killed and fail.
 
 check
 -----
-check = <path>=<<value>
+check = <path>=<value>
 
 Check a file for a particular value before running a test. The check line
 can contain multiple files to check separated by a space, but each check
 parameter needs to be of the form <path>=<value>
+
+The path and value cannot contain space, =, or shell wildcard characters.
Signature · 1 line
2.43.0
#4 lore raw
In reply to Nicholas Piggin
Quoted 7 lines · Nicholas Piggin

This just tidies up the two outstanding patches from this series (fix the wording of the migration group documetation, and make the artifact when: always comment a bit more understandable).

Thanks,
Nick

Quoted 7 lines

Nicholas Piggin (2):
doc: update unittests doc
gitlab-ci: Always save artifacts

  .gitlab-ci.yml     |  4 ++++
  docs/unittests.txt | 11 ++++++++---
  2 files changed, 12 insertions(+), 3 deletions(-)

Thanks, merged now!

Thomas