Add description for misc tests

coreos · May 4, 2023 · 857995f · 857995f
1 parent 4f37a1a
commit 857995f
Show file tree

Hide file tree

Showing 73 changed files with 221 additions and 184 deletions.
diff --git a/tests/kola/binfmt/qemu b/tests/kola/binfmt/qemu
@@ -9,9 +9,9 @@
 ##   distros: fcos
 ##   # We ship the x86_64 on all non-x86_64 arches.
 ##   architectures: "! x86_64"
-#
-# Test the x86_64 emulator on non-x86_64 instances.
-# https://github.com/coreos/fedora-coreos-tracker/issues/1237
+##   description: Verify the x86_64 qemu emulator works on non-x86_64 
+##     instances.
+##     See https://github.com/coreos/fedora-coreos-tracker/issues/1237
 
 set -xeuo pipefail
 

diff --git a/tests/kola/boot/bootupd b/tests/kola/boot/bootupd
@@ -1,11 +1,11 @@
 #!/bin/bash
 ## kola:
 ##   exclusive: false
-#
-# This is just a basic sanity check; at some point we
-# will implement "project-owned tests run in the pipeline"
-# and be able to run the existing bootupd tests:
-# https://github.com/coreos/fedora-coreos-config/pull/677
+##   description: Verify that bootupd works.
+
+# We gernally implement project-owned tests run in the pipeline
+# and be able to run the existing bootupd tests.
+# See https://github.com/coreos/fedora-coreos-config/pull/677
 
 set -xeuo pipefail
 

diff --git a/tests/kola/boot/grub2-install b/tests/kola/boot/grub2-install
@@ -4,12 +4,11 @@
 ##   # The test is not available for aarch64 and s390x,
 ##   # as aarch64 is UEFI only and s390x is not using grub2
 ##   architectures: "!aarch64 s390x"
-#
-# Verify to install BIOS/PReP bootloader using grub2-install from
-# the target system.
-# See:
-#  - https://github.com/coreos/coreos-assembler/pull/3190
-#  - https://github.com/coreos/coreos-assembler/issues/3148
+##   description: Verify that we install BIOS/PReP bootloader 
+##     using grub2-install from the target system.
+##     See
+##     - https://github.com/coreos/coreos-assembler/pull/3190
+##     - https://github.com/coreos/coreos-assembler/issues/3148
 
 set -xeuo pipefail
 

diff --git a/tests/kola/butane/grub-users/test.sh b/tests/kola/butane/grub-users/test.sh
@@ -1,13 +1,12 @@
 #!/bin/bash
 ## kola:
-##  tags: "platform-independent"
-##  # GRUB sugar currently only exists in FCOS
-##  distros: fcos
-##  # coreos-post-ignition-checks.service forbids GRUB passwords on
-##  # ppc64le and s390x
-##  architectures: "!ppc64le s390x"
-#
-# Check Butane GRUB sugar as best we can from inside the OS.
+##   tags: "platform-independent"
+##   # GRUB sugar currently only exists in FCOS
+##   distros: fcos
+##   # coreos-post-ignition-checks.service forbids GRUB passwords on
+##   # ppc64le and s390x
+##   architectures: "!ppc64le s390x"
+##   description: Verify that setting GRUB password works.
 
 set -xeuo pipefail
 

diff --git a/tests/kola/clhm/ignition-warnings/test.sh b/tests/kola/clhm/ignition-warnings/test.sh
@@ -4,8 +4,8 @@
 ##   # We intentionally exclude the Install section from a systemd unit.
 ##   # This is valid but not ideal, so Butane warns about it.
 ##   allowConfigWarnings: true
-#
-# This test ensures that Ignition warnings are displayed on the console.
+##   description: Verify the Ignition warnings are displayed on 
+##     the console.
 
 set -xeuo pipefail
 

diff --git a/tests/kola/clhm/network-device-info b/tests/kola/clhm/network-device-info
@@ -2,9 +2,8 @@
 ## kola:
 ##   # This is a read-only test that can be run with other tests.
 ##   exclusive: false
-#
-# This test makes sure CLHM wrote a snippet for the NIC IP info.
-# See - https://github.com/coreos/fedora-coreos-tracker/issues/1153
+##   description: Verify that CLHM wrote a snippet for the NIC IP info.
+##     See https://github.com/coreos/fedora-coreos-tracker/issues/1153
 
 set -xeuo pipefail
 

diff --git a/tests/kola/containers/cgroups-v2 b/tests/kola/containers/cgroups-v2
@@ -5,6 +5,7 @@
 ##   # TODO-RHCOS: drop "fcos" tag when cgroupsv2 lands in RHCOS
 ##   distros: fcos
 ##   exclusive: false
+##   description: Verify the system supports cgroupsv2.
 
 set -xeuo pipefail
 

diff --git a/tests/kola/containers/quadlet/test.sh b/tests/kola/containers/quadlet/test.sh
@@ -2,8 +2,7 @@
 ## kola:
 ##   # We're pulling a container image from Quay.io
 ##   tags: "platform-independent needs-internet"
-#
-# Ensure that basic quadlet functionality works
+##   description: Verify that basic quadlet functionality works.
 
 set -xeuo pipefail
 

diff --git a/tests/kola/content-origins/test.sh b/tests/kola/content-origins/test.sh
@@ -5,8 +5,8 @@
 ##   exclusive: false
 ##   # May support e.g. centos in the future
 ##   distros: "fcos rhcos"
-#
-# Verify the RPM %{vendor} flag for everything installed matches what we expect.
+##   description: Verify the RPM %{vendor} flag for everything 
+##     installed matches what we expect.
 
 set -xeuo pipefail
 

diff --git a/tests/kola/extensions/module b/tests/kola/extensions/module
@@ -7,8 +7,7 @@
 ##   # test take longer than 10 minutes in our aarch64 qemu tests.
 ##   timeoutMin: 15
 ##   minMemory: 1536
-#
-# This test ensures that we can install some common tools as OS extensions.
+##   description: Verify that we can install some common tools as OS extensions.
 
 set -xeuo pipefail
 

diff --git a/tests/kola/extensions/package b/tests/kola/extensions/package
@@ -7,8 +7,7 @@
 ##   # test take longer than 10 minutes in our aarch64 qemu tests.
 ##   timeoutMin: 15
 ##   minMemory: 1536
-#
-# This test ensures that we can install some common tools as OS extensions.
+##   description: Verify that we can install some common tools as OS extensions.
 
 set -xeuo pipefail
 

diff --git a/tests/kola/files/check-symlink b/tests/kola/files/check-symlink
@@ -2,8 +2,9 @@
 ## kola:
 ##   exclusive: false
 ##   description: Verify /etc release symlinks are valid.
-##     See https://bugzilla.redhat.com/show_bug.cgi?id=2068148
-##     https://github.com/openshift/os/pull/815
+##     See
+##     - https://bugzilla.redhat.com/show_bug.cgi?id=2068148
+##     - https://github.com/openshift/os/pull/815
 
 set -xeuo pipefail
 

diff --git a/tests/kola/files/kernel-headers b/tests/kola/files/kernel-headers
@@ -3,8 +3,9 @@
 ##   exclusive: false
 ##   description: Verify that we are not including the kernel 
 ##     headers on the host.
-##     See https://bugzilla.redhat.com/show_bug.cgi?id=1814719
-##     https://gitlab.cee.redhat.com/coreos/redhat-coreos/-/merge_requests/1116
+##     See
+##     - https://bugzilla.redhat.com/show_bug.cgi?id=1814719
+##     - https://gitlab.cee.redhat.com/coreos/redhat-coreos/-/merge_requests/1116
 
 set -xeuo pipefail
 

diff --git a/tests/kola/files/remove-manifest-files b/tests/kola/files/remove-manifest-files
@@ -1,5 +1,9 @@
 #!/bin/bash
 ## kola:
+##   # This test only runs on FCOS bceause RHCOS does ship `info` which is a
+##   # Requires on a number of RHCOS packages.
+##   # TODO-RHCOS: modify test to check for RHCOS-specific `remove-files` entry
+##   distros: fcos
 ##   exclusive: false
 ##   description: Verify remove-files works in the manifest.
 

diff --git a/tests/kola/firewall/iptables-legacy/test.sh b/tests/kola/firewall/iptables-legacy/test.sh
@@ -1,9 +1,10 @@
 #!/bin/bash
 ## kola:
-##   # This test verifies that one can configure a node to use the legacy iptables
-##   # backend. It is scoped to only FCOS because RHCOS only supports nft.
 ##   distros: fcos
 ##   exclusive: true
+##   description: Verify that one can configure a node to use the legacy 
+##     iptables backend. It is scoped to only FCOS because RHCOS only 
+##     supports nft.
 
 set -xeuo pipefail
 

diff --git a/tests/kola/firewall/iptables/test.sh b/tests/kola/firewall/iptables/test.sh
@@ -1,9 +1,8 @@
 #!/bin/bash
 ## kola:
 ##   exclusive: false
-#
-# Verifies that the expected iptables backend is configured.
-# https://github.com/coreos/fedora-coreos-tracker/issues/676
+##   description: Verifies that the expected iptables backend is configured.
+##     https://github.com/coreos/fedora-coreos-tracker/issues/676
 
 set -xeuo pipefail
 

diff --git a/tests/kola/gshadow b/tests/kola/gshadow
@@ -1,6 +1,8 @@
 #!/bin/bash
-# Verify that glibc's parsing of /etc/gshadow does not cause systemd-sysusers
-# to segfault on specially constructed lines.
+## kola:
+##   description: Verify that glibc's parsing of /etc/gshadow does 
+##     not cause systemd-sysusers to segfault on specially constructed lines.
+##     See https://github.com/coreos/bugs/issues/1394
 #
 # One line must fit into the character buffer (1024 bytes, unless a previous
 # line was longer) but have enough group members such that
@@ -10,8 +12,6 @@
 # The parser would return early to avoid overflow, leaving the static result
 # struct pointing to pointers from the previous line which are now invalid,
 # causing segfaults when those pointers are dereferenced.
-#
-# Tests: https://github.com/coreos/bugs/issues/1394
 
 set -xeuo pipefail
 

diff --git a/tests/kola/ignition/delete-config/test.sh b/tests/kola/ignition/delete-config/test.sh
@@ -1,21 +1,24 @@
 #!/bin/bash
 ## kola:
 ##   platforms: qemu
-##   description: >
-##     There are 2 services: 
-##     1)ignition-delete-config.service, which deletes Ignition 
-##     configs from VMware and VirtualBox on first boot.
-##     2)coreos-ignition-delete-config.service, do the same thing 
-##     on existing machines on upgrade, using a stamp file in /var/lib 
-##     to avoid multiple runs.
-##     Ideally we'd test on virtualbox and vmware, but we don't have tests
-##     there, so we mock specifically for ignition.platform.id=qemu.
-##     Test scenarios:
-##     On first boot, verify that both 2 services ran. 
-##     On upgrade boot, verify that 1) should not run, 2) should run.
-##     On normal boot, verify that both 2 services should not run.
-##     On upgrade boot with 2) masked, verify that both 2 services 
-##     should not run.
+##   description: Verify that we delete userdata from provider 
+##     after Ignition completes.
+##     See https://github.com/coreos/ignition/issues/1315
+
+# There are 2 services: 
+# 1)ignition-delete-config.service, which deletes Ignition 
+# configs from VMware and VirtualBox on first boot.
+# 2)coreos-ignition-delete-config.service, do the same thing 
+# on existing machines on upgrade, using a stamp file in /var/lib 
+# to avoid multiple runs.
+# Ideally we'd test on virtualbox and vmware, but we don't have tests
+# there, so we mock specifically for ignition.platform.id=qemu.
+# Test scenarios:
+# On first boot, verify that both 2 services ran. 
+# On upgrade boot, verify that 1) should not run, 2) should run.
+# On normal boot, verify that both 2 services should not run.
+# On upgrade boot with 2) masked, verify that both 2 services 
+# should not run.
 
 set -xeuo pipefail
 

diff --git a/tests/kola/ignition/kargs/test.sh b/tests/kola/ignition/kargs/test.sh
@@ -1,8 +1,7 @@
 #!/bin/bash
-# TODO: Doc
 ## kola:
 ##   platforms: qemu
-##   description: Verify ignition supports kernel arguments.
+##   description: Verify Ignition supports kernel arguments.
 
 set -xeuo pipefail
 

diff --git a/tests/kola/ignition/remote/test.sh b/tests/kola/ignition/remote/test.sh
@@ -1,12 +1,14 @@
 #!/bin/bash
 ## kola:
 ##   tags: needs-internet
-##   description: Verify ignition supports remote config.
-##     remote.ign on github: inject kernelArguments and write 
-##     something to /etc/testfile.
-##     config.ign to include remote kargsfile.ign.
+##   description: Verify Ignition supports remote config.
 ##     See https://bugzilla.redhat.com/show_bug.cgi?id=1980679
 
+# remote.ign is on github, inject kernelArguments and write 
+# something to /etc/testfile.
+# config.ign is to include remote kargsfile.ign.
+
+
 set -xeuo pipefail
 
 . $KOLA_EXT_DATA/commonlib.sh

diff --git a/tests/kola/ignition/stable-boot/test.sh b/tests/kola/ignition/stable-boot/test.sh
@@ -1,7 +1,7 @@
 #!/bin/bash
 ## kola:
 ##   tags: "platform-independent"
-##   description: Verify that ignition is able to use 
+##   description: Verify that Ignition is able to use 
 ##     `coreos-boot-disk` symlink.
 
 set -xeuo pipefail

diff --git a/tests/kola/ignition/systemd-disable/test.sh b/tests/kola/ignition/systemd-disable/test.sh
@@ -5,7 +5,7 @@
 ##   # on FCOS.
 ##   # TODO-RHCOS: Determine if any services on RHCOS may be disabled and adapt test
 ##   distros: fcos
-##   description: Verify that ignition supports to disable units.
+##   description: Verify that Ignition supports to disable units.
 ##     See https://github.com/coreos/fedora-coreos-tracker/issues/392
 
 set -xeuo pipefail

diff --git a/tests/kola/ignition/systemd-enable-units/test.sh b/tests/kola/ignition/systemd-enable-units/test.sh
@@ -1,10 +1,11 @@
 #!/bin/bash
 ## kola:
 ##   tags: "platform-independent"
-##   description: Verify that ignition supports to enable systemd units 
+##   description: Verify that Ignition supports to enable systemd units 
 ##     of different types.
-##     See https://github.com/coreos/ignition/issues/586
-##     https://github.com/systemd/systemd/pull/9901
+##     See
+##     - https://github.com/coreos/ignition/issues/586
+##     - https://github.com/systemd/systemd/pull/9901
 
 set -xeuo pipefail
 

diff --git a/tests/kola/ignition/systemd-unmasking/test.sh b/tests/kola/ignition/systemd-unmasking/test.sh
@@ -5,7 +5,7 @@
 ##   # RHCOS.
 ##   # TODO-RHCOS: determine if any services on RHCOS are masked and adapt test
 ##   distros: fcos
-##   description: Verify that ignition supports to unmask units.
+##   description: Verify that Ignition supports to unmask units.
 
 set -xeuo pipefail
 

diff --git a/tests/kola/k8s/node-e2e/master b/tests/kola/k8s/node-e2e/master
@@ -7,6 +7,8 @@
 ##   architectures: x86_64
 ##   requiredTag: k8s
 ##   tags: needs-internet
+##   description: Verify the Kubernetes e2e node tests work, and 
+##     ensure that we don't inadvertedly break Kubernetes.
 
 set -xeuo pipefail
 

diff --git a/tests/kola/kdump/crash/test.sh b/tests/kola/kdump/crash/test.sh
@@ -8,8 +8,8 @@
 ##   # This test includes a few reboots and the generation of a vmcore,
 ##   # which can take longer than the default 10 minute timeout.
 ##   timeoutMin: 15
-#
-# https://docs.fedoraproject.org/en-US/fedora-coreos/debugging-kernel-crashes/
+##   description: Verify that the crashkernel reserved memory is large enough.
+##     See https://docs.fedoraproject.org/en-US/fedora-coreos/debugging-kernel-crashes/
 
 set -xeuo pipefail
 

diff --git a/tests/kola/kdump/service b/tests/kola/kdump/service
@@ -1,9 +1,9 @@
 #!/bin/bash
 ## kola:
 ##   exclusive: false
-#
-# Make sure that kdump didn't start (it's either disabled, or enabled but
-# conditional on crashkernel= karg, which we don't bake).
+##   description: Verify that kdump didn't start (it's either 
+##     disabled, or enabled but conditional on crashkernel= karg, 
+##     which we don't bake).
 
 set -xeuo pipefail
 

diff --git a/tests/kola/kubernetes/kube-watch/test.sh b/tests/kola/kubernetes/kube-watch/test.sh
@@ -1,11 +1,11 @@
 #!/bin/bash
 ## kola:
 ##   exclusive: false
-#
-# This is for verifying that `kubernetes_file_t` labeled files can be
-# watched by systemd
-# See: https://github.com/coreos/fedora-coreos-tracker/issues/861
-# See: https://github.com/containers/container-selinux/issues/135
+##   description: Verify that `kubernetes_file_t` labeled files can be
+##     watched by systemd.
+##     See
+##     - https://github.com/coreos/fedora-coreos-tracker/issues/861
+##     - https://github.com/containers/container-selinux/issues/135
 
 set -xeuo pipefail