test: add test purpose

Most test scripts don't have any documentation regarding it's purpose,
although it can be guessed by the code. There's value in adding this
small comment.

[skip-ci]

test/cases/aws.sh

@@ -1,4 +1,12 @@
 #!/bin/bash
+
+#
+# Test osbuild-composer 'upload to aws' functionality. To do so, create and
+# push a blueprint with composer cli. Then, create an instance in aws 
+# from the uploaded image. Finally, verify that the instance is running and 
+# cloud init ran.
+#
+
 set -euo pipefail
 
 source /usr/libexec/osbuild-composer-test/set-env-variables.sh

test/cases/azure.sh

@@ -1,4 +1,12 @@
 #!/bin/bash
+
+#
+# Test osbuild-composer 'upload to azure' functionality. To do so, create and
+# push a blueprint with composer cli. Then, use terraform to create 
+# an instance in azure from the uploaded image. Finally, verify the instance
+# is running with cloud-init ran.
+#
+
 shopt -s expand_aliases
 set -euo pipefail
 

test/cases/base_tests.sh

@@ -1,6 +1,10 @@
 #!/bin/bash
 set -euo pipefail
 
+#
+# Script that executes different high level sanity tests writen in GO. 
+#
+
 WORKING_DIRECTORY=/usr/libexec/osbuild-composer
 TESTS_PATH=/usr/libexec/osbuild-composer-test
 mkdir --parents /tmp/logs

test/cases/generation.sh

@@ -1,4 +1,11 @@
 #!/usr/bin/bash
+
+#
+# The objective of this script is to provide special requirement needed
+# for generate-test-cases. For example, disable the dnf-json daemon
+# and then execute generate-test-cases.
+#
+
 set -euxo pipefail
 
 # Provision the software under test.

test/cases/installers.sh

@@ -1,6 +1,13 @@
 #!/bin/bash
 set -euo pipefail
 
+#
+# This test builds a image-installer iso which is then used for OS installation. 
+# To do so, it creates an image-installer iso, then modifies the kickstart so it 
+# can be installed automatically, installs the VM with virt-install waits for it 
+# to boot and then run some test using ansible to check if everything is as expected
+#
+
 # Provision the software under test.
 /usr/libexec/osbuild-composer-test/provision.sh
 

test/cases/libvirt.sh

@@ -1,6 +1,10 @@
 #!/bin/bash
 set -euo pipefail
 
+#
+# Helper script that executes `tools/libvirt_test.sh` with the appropiate image type and boot type
+#
+
 # Get OS data.
 source /usr/libexec/osbuild-composer-test/set-env-variables.sh
 

test/cases/regression-composer-works-behind-satellite-fallback.sh

@@ -1,5 +1,10 @@
 #!/bin/bash
 
+#
+# test osbuild-composer when the host system doesn't have redhat.repo file,
+# but there is a certificate that can be used to access the repositories
+#
+
 set -exuo pipefail
 
 function greenprint {

test/cases/regression-composer-works-behind-satellite.sh

@@ -1,5 +1,11 @@
 #!/bin/bash
 
+#
+# osbuild-composer can work with multiple subscriptions on the host system.
+# test this by simulating a custom repository with custom certificates and 
+# verifies that an image can be built using those.
+#
+
 set -exuo pipefail
 
 function greenprint {

test/cases/regression.sh

@@ -1,6 +1,10 @@
 #!/bin/bash
 set -euo pipefail
 
+#
+# script that servers as a base for all the regression tests
+#
+
 source /usr/libexec/osbuild-composer-test/set-env-variables.sh
 
 TESTS_PATH=/usr/libexec/tests/osbuild-composer/

test/cases/vmware.sh

@@ -1,4 +1,12 @@
 #!/bin/bash
+
+#
+# Test osbuild-composer 'upload to vmware' functionality. To do so, create and
+# push a blueprint with composer cli. Then, create an instance in vSphere
+# from the uploaded image. Finally, verify that the instance is running and 
+# cloud init ran.
+#
+
 set -euo pipefail
 
 source /usr/libexec/osbuild-composer-test/set-env-variables.sh

tools/libvirt_test.sh

@@ -1,6 +1,11 @@
 #!/bin/bash
 set -euo pipefail
 
+#
+# tests that guest images are buildable using composer-cli and and verifies 
+# they boot with cloud-init using libvirt
+#
+
 OSBUILD_COMPOSER_TEST_DATA=/usr/share/tests/osbuild-composer/
 
 # Get OS data.