[kvm-unit-tests PATCH v2 0/2] misc docs/build/CI improvements

[kvm-unit-tests PATCH v2 0/2] misc docs/build/CI improvements

[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

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(-)

-- 
2.43.0

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

[Nicholas Piggin]

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

Reviewed-by: Thomas Huth <thuth@redhat.com>
Signed-off-by: Nicholas Piggin <npiggin@gmail.com>
---
 docs/unittests.txt | 11 ++++++++---
 1 file changed, 8 insertions(+), 3 deletions(-)

diff --git a/docs/unittests.txt b/docs/unittests.txt
index 6ff9872cf..c4269f623 100644
--- a/docs/unittests.txt
+++ b/docs/unittests.txt
@@ -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.
-- 
2.43.0

[kvm-unit-tests PATCH v2 2/2] gitlab-ci: Always save artifacts

[Nicholas Piggin]

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

Reviewed-by: Thomas Huth <thuth@redhat.com>
Signed-off-by: Nicholas Piggin <npiggin@gmail.com>
---
 .gitlab-ci.yml | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index 23bb69e24..0e4d6205f 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -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
-- 
2.43.0

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

[Andrew Jones]

On Wed, Jun 05, 2024 at 06:09:40PM GMT, Nicholas Piggin wrote:
> Document the special groups, check path restrictions, and a small fix
> for check option syntax.
> 
> Reviewed-by: Thomas Huth <thuth@redhat.com>
> Signed-off-by: Nicholas Piggin <npiggin@gmail.com>
> ---
>  docs/unittests.txt | 11 ++++++++---
>  1 file changed, 8 insertions(+), 3 deletions(-)
> 
> diff --git a/docs/unittests.txt b/docs/unittests.txt
> index 6ff9872cf..c4269f623 100644
> --- a/docs/unittests.txt
> +++ b/docs/unittests.txt
> @@ -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.
> -- 
> 2.43.0
>

Reviewed-by: Andrew Jones <andrew.jones@linux.dev>

Re: [kvm-unit-tests PATCH v2 0/2] misc docs/build/CI improvements

[Thomas Huth]

On 05/06/2024 10.09, Nicholas Piggin wrote:
> 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(-)

Thanks, merged now!

  Thomas