Add documentation to each tests.

Fix pre-commit issues

Signed-off-by: Petr "Stone" Hracek <phracek@redhat.com>

Author: phracek

test/conftest.py

@@ -33,6 +33,7 @@
     "rhel10": "-ubi10",
 }
 
+
 def skip_clear_env_tests():
     if VARS.OS == "rhel8" and VERSION == "8.2":
         skip(f"Skipping clear env tests for {VARS.VERSION} on {VARS.OS}.")

test/test_container_example_apps.py

@@ -112,6 +112,10 @@ def teardown_method(self):
         self.s2i_app.cleanup()
 
     def test_log_output(self):
+        """
+        Test checks if logging container works properly
+        and logs contain proper output
+        """
         cid_file_name = "test-app"
         self.s2i_app.set_new_image(image_name=f"{VARS.IMAGE_NAME}-{cid_file_name}")
         assert self.s2i_app.create_container(
@@ -135,6 +139,12 @@ def test_log_output(self):
         assert re.search("open.*failed.*No such file or directory", logs)
 
     def test_log_volume_output(self):
+        """
+        Test checks if logging container works properly
+        and logs contain proper output.
+        The logs are mounted from host and so we check
+        the logs in host directly
+        """
         cid_file_name = "test-app"
         self.s2i_app.set_new_image(image_name=f"{VARS.IMAGE_NAME}-{cid_file_name}")
         assert self.s2i_app.create_container(

test/test_ocp_imagestream_s2i.py

@@ -3,7 +3,7 @@
 
 from conftest import VARS
 
-# bash test=test_nginx_imagestream
+
 class TestNginxImagestreamS2I:
 
     def setup_method(self):
@@ -16,6 +16,11 @@ def teardown_method(self):
         self.oc_api.delete_project()
 
     def test_inside_cluster(self):
+        """
+        Test checks if example nginx container
+        works with imagestreams
+        The example application is in directory `examples/<VERSION>/test-app
+        """
         os_name = ''.join(i for i in VARS.OS if not i.isdigit())
         assert self.oc_api.deploy_imagestream_s2i(
             imagestream_file=f"imagestreams/nginx-{os_name}.json",

test/test_ocp_imagestreams.py

@@ -2,12 +2,16 @@
 
 from conftest import VARS
 
+
 class TestLatestImagestreams:
 
     def setup_method(self):
         self.isc = ImageStreamChecker(working_dir=VARS.TEST_DIR / ".." / "..")
 
     def test_latest_imagestream(self):
+        """
+        Test checks we have the latest imagestream in GitHub repository
+        """
         self.latest_version = self.isc.get_latest_version()
         assert self.latest_version != ""
         self.isc.check_imagestreams(self.latest_version)

test/test_ocp_local_example.py

@@ -4,7 +4,6 @@
 from conftest import VARS
 
 
-# Replacement with 'test_python_s2i_app_ex_standalone'
 class TestNginxLocalEx:
 
     def setup_method(self):
@@ -17,6 +16,11 @@ def teardown_method(self):
         self.oc_api.delete_project()
 
     def test_nginx_ex_template_inside_cluster(self):
+        """
+        Test checks if example nginx container
+        works with local test-app
+        The example application is in directory `examples/<VERSION>/test-app
+        """
         assert self.oc_api.deploy_s2i_app(
             image_name=VARS.IMAGE_NAME, app="test-app",
             context=".",

test/test_ocp_remote_example.py

@@ -4,8 +4,6 @@
 from conftest import VARS
 
 
-# Replacement with
-# test_nginx_remote_example
 class TestNginxLocalEx:
 
     def setup_method(self):
@@ -18,8 +16,13 @@ def teardown_method(self):
         self.oc_api.delete_project()
 
     def test_nginx_ex_template_inside_cluster(self):
+        """
+        Test checks if example GitHub application `nginx-ex`
+        works with properly
+        The response checks expected message
+        """
         assert self.oc_api.deploy_s2i_app(
-            image_name=VARS.IMAGE_NAME, app=f"https://github.com/sclorg/nginx-ex.git",
+            image_name=VARS.IMAGE_NAME, app="https://github.com/sclorg/nginx-ex.git",
             context=".",
             service_name=self.template_name
         )

test/test_ocp_shared_helm_imagestreams.py

@@ -34,6 +34,9 @@ def teardown_method(self):
         ],
     )
     def test_package_imagestream(self, version, registry, expected):
+        """
+        Test checks if Helm imagestream are present, including deprecated
+        """
         assert self.hc_api.helm_package()
         assert self.hc_api.helm_installation()
         assert self.hc_api.check_imagestreams(version=version, registry=registry) == expected

test/test_ocp_shared_helm_template.py

@@ -19,6 +19,10 @@ def teardown_method(self):
         self.hc_api.delete_project()
 
     def test_helm_connection(self):
+        """
+        Test checks if Helm imagestream and Helm nginx template application
+        works properly and response is as expected.
+        """
         self.hc_api.package_name = "redhat-nginx-imagestreams"
         assert self.hc_api.helm_package()
         assert self.hc_api.helm_installation()

test/test_ocp_template_example_app.py

@@ -2,8 +2,6 @@
 from conftest import VARS
 
 
-# bash test_nginx_template_from_example_app
-# Replacement with 'test_python_s2i_templates'
 class TestNginxDeployTemplate:
 
     def setup_method(self):
@@ -13,6 +11,10 @@ def teardown_method(self):
         self.oc_api.delete_project()
 
     def test_nginx_template_inside_cluster(self):
+        """
+        Test checks if Helm imagestream and Helm perl dancer application
+        works properly and response is as expected.
+        """
         service_name = "nginx-testing"
         template_url = self.oc_api.get_raw_url_for_json(
             container="nginx-ex", dir="openshift/templates", filename="nginx.json", branch="master"
@@ -22,7 +24,7 @@ def test_nginx_template_inside_cluster(self):
             template=template_url,
             name_in_template="nginx",
             openshift_args=[
-                f"SOURCE_REPOSITORY_REF=master",
+                "SOURCE_REPOSITORY_REF=master",
                 f"NGINX_VERSION={VARS.VERSION}",
                 f"NAME={service_name}"
             ]