Merge pull request #1256 from HuijingHei/tests-description

tests: add `description` for tests
openshift · May 5, 2023 · c122421 · c122421
2 parents e3b0186 + 7aef742
commit c122421
Show file tree

Hide file tree

Showing 21 changed files with 71 additions and 64 deletions.
diff --git a/tests/kola/afterburn/platform-id b/tests/kola/afterburn/platform-id
@@ -1,10 +1,9 @@
 #!/bin/bash
 ## kola:
 ##   platforms: aws gcp
-#
-# Make sure afterburn with old ignition.platform.id kernel argument 
-# ec2 and gce works.
-# See https://issues.redhat.com/browse/OCPBUGS-7733
+##   description: Verify afterburn works with old kernel argument 
+##     ignition.platform.id=ec2/gce.
+##     https://issues.redhat.com/browse/OCPBUGS-7733
 
 set -xeuo pipefail
 

diff --git a/tests/kola/afterburn/sshkey-service b/tests/kola/afterburn/sshkey-service
@@ -1,9 +1,9 @@
 #!/bin/bash
 ## kola:
 ##   exclusive: false
-#
-# By default afterburn-sshkeys@core is disabled on RHCOS, enabled on FCOS
-# https://github.com/coreos/afterburn/issues/405
+##   description: Verify afterburn-sshkeys@core is disabled
+##     by default on RHCOS (enabled on FCOS).
+##     https://github.com/coreos/afterburn/issues/405
 
 set -xeuo pipefail
 

diff --git a/tests/kola/console/console-login-helper-service b/tests/kola/console/console-login-helper-service
@@ -1,15 +1,17 @@
 #!/bin/bash
 ## kola:
 ##   exclusive: false
-#
-# This is RHCOS only
+##   description: >
+##     Verify that we have the proper presets for 
+##     console-login-helper-messages in RHCOS.
+##     Verify versions of CLHM prior to v0.21 have `issuegen`-related  
+##     systemd units.
+##     This is RHCOS only.
 
 set -xeuo pipefail
 
 . $KOLA_EXT_DATA/commonlib.sh
 
-# Check that we have the proper presets for console-login-helper-messages in RHCOS.
-# Versions of CLHM prior to v0.21 have `issuegen`-related systemd units.
 if test -f /usr/lib/systemd/system/console-login-helper-messages-issuegen.service; then
   if ! systemctl is-enabled console-login-helper-messages-issuegen.path; then
     fatal "Error: console-login-helper-messages-issuegen.path required but not enabled"

diff --git a/tests/kola/disk/iscsi-initiatorname-service b/tests/kola/disk/iscsi-initiatorname-service
@@ -1,10 +1,9 @@
 #!/bin/bash
 ## kola:
 ##   exclusive: false
-#
-# By default coreos-generate-iscsi-initiatorname.service is active on RHCOS,
-# inactive on FCOS
-# https://github.com/openshift/os/pull/453
+##   description: Verify coreos-generate-iscsi-initiatorname.service 
+##     is enabled by default on RHCOS (disabled on FCOS).
+##     https://github.com/openshift/os/pull/453
 
 set -xeuo pipefail
 

diff --git a/tests/kola/disk/nvme-compat-symlink b/tests/kola/disk/nvme-compat-symlink
@@ -5,10 +5,9 @@
 ##   platforms: qemu
 ##   # qemu on s390x does not support nvme emulation
 ##   architectures: "!s390x"
-#
-# By default coreos-generate-iscsi-initiatorname.service is active on RHCOS,
-# inactive on FCOS
-# https://github.com/openshift/os/pull/453
+##   description: Verify that we are compatible with the old symlinks 
+##     for NVME disks.
+##     https://github.com/openshift/os/pull/1243
 
 set -xeuo pipefail
 

diff --git a/tests/kola/files/check-qemu-ga b/tests/kola/files/check-qemu-ga
@@ -1,6 +1,7 @@
 #!/bin/bash
 ## kola:
 ##   exclusive: false
+##   description: Verify /usr/bin/qemu-ga exists.
 
 set -xeuo pipefail
 

diff --git a/tests/kola/files/conntrack-tools b/tests/kola/files/conntrack-tools
@@ -1,8 +1,8 @@
 #!/bin/bash
 ## kola:
 ##   exclusive: false
-#
-# This is RHCOS only, by default conntrack-tools is not installed on FCOS
+##   description: Verify conntrack-tools is installed by default 
+##     on RHCOS (not installed on FCOS).
 
 set -xeuo pipefail
 

diff --git a/tests/kola/files/env-godebug b/tests/kola/files/env-godebug
@@ -1,11 +1,10 @@
 #!/bin/bash
 ## kola:
 ##   exclusive: false
-#
-# Verify environment variable `GODEBUG=x509ignoreCN=0` in initrd
-# See:
-# - https://bugzilla.redhat.com/show_bug.cgi?id=1886134
-# - https://github.com/openshift/os/pull/441
+##   description: Verify environment variable `GODEBUG=x509ignoreCN=0` 
+##     found in initrd.
+##     https://bugzilla.redhat.com/show_bug.cgi?id=1886134
+##     https://github.com/openshift/os/pull/441
 
 set -xeuo pipefail
 

diff --git a/tests/kola/files/kata-osbuilder b/tests/kola/files/kata-osbuilder
@@ -1,13 +1,11 @@
 #!/bin/bash
 ## kola:
 ##   exclusive: false
-#
-# Check that `kata-osbuilder-generate.service` as part of the default presets
-# - defined in /usr/lib/systemd/system-preset/45-rhcos-extensions.preset
-#
-# See:
-# - https://bugzilla.redhat.com/show_bug.cgi?id=1941342
-# - https://github.com/openshift/os/pull/524
+##   description: Verify `kata-osbuilder-generate.service` is 
+##     part of the default presets, defined in 
+##     /usr/lib/systemd/system-preset/45-rhcos-extensions.preset
+##     https://bugzilla.redhat.com/show_bug.cgi?id=1941342
+##     https://github.com/openshift/os/pull/524
 
 set -xeuo pipefail
 

diff --git a/tests/kola/files/localtime b/tests/kola/files/localtime
@@ -1,10 +1,12 @@
 #!/bin/bash
 ## kola:
 ##   exclusive: false
+##   description: Verify /etc/localtime link exists.
+##     https://github.com/openshift/os/pull/1021
+##     https://issues.redhat.com/browse/LOG-3117
 
 set -xeuo pipefail
 
 . $KOLA_EXT_DATA/commonlib.sh
 
-# See https://issues.redhat.com/browse/LOG-3117
 test -L /etc/localtime
diff --git a/tests/kola/files/trust-cpu b/tests/kola/files/trust-cpu
@@ -1,18 +1,18 @@
 #!/bin/bash
 ## kola:
 ##   exclusive: false
-#
-# This is RHCOS only.
-# This test will start failing and can be removed when RHCOS
-# gets to kernel version 6.2+
-# https://github.com/coreos/fedora-coreos-tracker/issues/1369
-# https://github.com/coreos/fedora-coreos-config/pull/2155
+##   description: Verify CONFIG_RANDOM_TRUST_CPU is enabled by default.
+##     This is RHCOS only.
+##     This test will start failing and can be removed when RHCOS
+##     gets to kernel version 6.2+
+##     https://github.com/coreos/fedora-coreos-tracker/issues/1369
+##     https://github.com/coreos/fedora-coreos-config/pull/2155
+##     https://bugzilla.redhat.com/show_bug.cgi?id=1830280  
 
 set -xeuo pipefail
 
 . $KOLA_EXT_DATA/commonlib.sh
 
-# https://bugzilla.redhat.com/show_bug.cgi?id=1830280
 case "$(arch)" in
     x86_64)
         config=$(grep ^CONFIG_RANDOM_TRUST_CPU /lib/modules/$(uname -r)/config)

diff --git a/tests/kola/files/usrlocal-fixup b/tests/kola/files/usrlocal-fixup
@@ -1,9 +1,9 @@
 #!/bin/bash
 ## kola:
 ##   exclusive: false
-#
-# This is RHCOS only
-# https://github.com/openshift/os/pull/672
+##   description: Verify /var/lib/.coreos-usrlocal-fixup.stamp exists.
+##     This is RHCOS only.
+##     https://github.com/openshift/os/pull/672
 
 set -xeuo pipefail
 

diff --git a/tests/kola/rebuild-selinux-policy/test.sh b/tests/kola/rebuild-selinux-policy/test.sh
@@ -1,5 +1,9 @@
 #!/bin/bash
-# Test for https://issues.redhat.com/browse/OCPBUGS-595
+## kola:
+##   description: Verify SELinux policy is rebuilt on 8.[0-6] 
+##     on first boot.
+##     https://issues.redhat.com/browse/OCPBUGS-595
+##     https://github.com/openshift/os/pull/962
 
 set -xeuo pipefail
 

diff --git a/tests/kola/rpm-ostree/replace-rt-kernel b/tests/kola/rpm-ostree/replace-rt-kernel
@@ -2,9 +2,8 @@
 ## kola:
 ##   tags: "needs-internet"
 ##   timeoutMin: 30
-#
-# Verify that replacing with an older centos kernel works, and that
-# replacing with kernel-rt works.
+##   description: Verify replacing the current kernel with an 
+##     older centos kernel and replacing with kernel-rt.
 
 set -euo pipefail
 

diff --git a/tests/kola/rpm-ostree/startlimit b/tests/kola/rpm-ostree/startlimit
@@ -1,5 +1,10 @@
 #!/bin/bash
+## kola:
+##   description: Verify rpm-ostreed.service works when invoking
+##      `rpm-ostree status` frequently.
+##      https://github.com/coreos/rpm-ostree/pull/3523/commits/0556152adb14a8e1cdf6c5d6f234aacbe8dd4e3f
+
 set -euo pipefail
-# https://github.com/coreos/rpm-ostree/pull/3523/commits/0556152adb14a8e1cdf6c5d6f234aacbe8dd4e3f
+
 for x in $(seq 10); do rpm-ostree status >/dev/null; done
 echo ok
diff --git a/tests/kola/ssh/config b/tests/kola/ssh/config
@@ -1,11 +1,11 @@
 #!/bin/bash
 ## kola:
 ##   exclusive: false
-#
-# Verify OpenSSH config options
-# See: https://github.com/openshift/os/pull/1251
-# See: https://github.com/openshift/os/issues/1216
-# See: https://issues.redhat.com/browse/OCPBUGS-11613
+##   description: Verify OpenSSH config options are expected.
+##     See
+##     - https://github.com/openshift/os/pull/1251
+##     - https://github.com/openshift/os/issues/1216
+##     - https://issues.redhat.com/browse/OCPBUGS-11613
 
 set -euo pipefail
 

diff --git a/tests/kola/systemd/journal-compat b/tests/kola/systemd/journal-compat
@@ -3,8 +3,8 @@
 ##   # Since we pull a container image
 ##   tags: "needs-internet" 
 ##   timeoutMin: 30
-#
-# Verify that rhel8 journalctl can still read our journals https://issues.redhat.com/browse/OCPBUGS-11492
+##   description: Verify that rhel8 journalctl can still read our journals.
+##     https://issues.redhat.com/browse/OCPBUGS-11492
 
 set -euo pipefail
 

diff --git a/tests/kola/version/drop-azure-ptp b/tests/kola/version/drop-azure-ptp
@@ -1,6 +1,7 @@
 #!/bin/bash
 ## kola:
 ##   exclusive: false
+##   description: Verify we should not have 50-azure-ptp.rules. 
 
 set -xeuo pipefail
 

diff --git a/tests/kola/version/rhaos-pkgs-match-openshift b/tests/kola/version/rhaos-pkgs-match-openshift
@@ -1,14 +1,14 @@
 #!/bin/bash
 ## kola:
 ##   exclusive: false
-#
-# This is RHCOS only
+##   description: Verify that packages coming from the rhaos 
+##     branches match the OpenShift version.
+##     This is RHCOS only.
 
 set -xeuo pipefail
 
 . $KOLA_EXT_DATA/commonlib.sh
 
-# Check that rhaos packages do not match the OpenShift version
 if [[ $(rpm -qa | grep rhaos | grep -v $OPENSHIFT_VERSION) ]]; then
     fatal "Error: rhaos packages do not match OpenShift version"
 fi
diff --git a/tests/kola/version/rhel-major-version b/tests/kola/version/rhel-major-version
@@ -1,8 +1,8 @@
 #!/bin/bash
 ## kola:
 ##   exclusive: false
-#
-# Ensure that only packages from the RHEL major version are included
+##   description: Verify that only packages from the RHEL major 
+##     version are included.
 
 set -xeuo pipefail
 

diff --git a/tests/kola/version/rhel-matches-rhcos-build b/tests/kola/version/rhel-matches-rhcos-build
@@ -1,9 +1,8 @@
 #!/bin/bash
 ## kola:
 ##   exclusive: false
-#
-# Check that the OS version (C9S, RHEL 9.x) matches the version stored in
-# /etc/os-release
+##   description: Verify that the OS version (C9S, RHEL 9.x) matches  
+##     the version stored in /etc/os-release.
 
 set -xeuo pipefail