Add several comments to each test so we understand

what we tests.

Add description, why sleep(3) is present in HotPlug test

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

Author: phracek

test/test_container_basics.py

@@ -14,19 +14,28 @@ def setup_method(self):
     def teardown_method(self):
         self.app.cleanup()
 
-    # test_s2i_usage
     def test_run_s2i_usage(self):
+        """
+        Test checks if `usage` script works properly
+        """
         output = self.app.s2i_usage()
         assert output
 
     # # test_docker_run_usage
     def test_docker_run_usage(self):
+        """
+        Test checks if `docker run` script works properly and do not fail
+        """
         assert PodmanCLIWrapper.call_podman_command(
             cmd=f"run --rm {VARS.IMAGE_NAME} &>/dev/null",
             return_output=False
         ) == 0
 
     def test_scl_usage(self):
+        """
+        Test checks if command `perl --version` script works properly
+        and returns version without -mod_fcgid
+        """
         assert f"v{VARS.VERSION_NO_FCGID}" in PodmanCLIWrapper.podman_run_command(
             f"--rm {VARS.IMAGE_NAME} /bin/bash -c 'perl --version'"
         )
@@ -39,6 +48,10 @@ def test_scl_usage(self):
         ]
     )
     def test_dockerfiles(self, dockerfile):
+        """
+        Test checks if we are able to build a container from
+        `examples/from-dockerfile/<version>/{Dockerfile,Dockerfile.s2i}
+        """
         assert self.app.build_test_container(
             dockerfile=VARS.TEST_DIR / "examples/from-dockerfile" / VARS.VERSION / dockerfile,
             app_url="https://github.com/sclorg/dancer-ex.git",

test/test_container_s2i.py

@@ -51,11 +51,17 @@ def teardown_method(self):
         self.s2i_app.cleanup()
 
     def test_run_s2i_usage(self):
+        """
+        Test checks if `usage` script works properly
+        """
         output = self.s2i_app.s2i_usage()
         assert output
 
     # test_docker_run_usage
     def test_docker_run_usage(self):
+        """
+        Test checks if `docker run` script works properly and do not fail
+        """
         assert PodmanCLIWrapper.call_podman_command(
             cmd=f"run --rm {VARS.IMAGE_NAME} &>/dev/null",
             return_output=False
@@ -69,6 +75,10 @@ def test_docker_run_usage(self):
         ]
     )
     def test_run_app_test(self, container_arg):
+        """
+        Test checks if we are able to run a container as deamon
+        and response works as expected
+        """
         cid_file_name = self.s2i_app.app_name
         assert self.s2i_app.create_container(cid_file_name=cid_file_name, container_args=container_arg)
         assert ContainerImage.wait_for_cid(cid_file_name=cid_file_name)
@@ -97,6 +107,11 @@ def test_run_app_test(self, container_arg):
 )
 class TestPerlExampleAppContainer:
     def test_run_app_test(self, application_path, container_args, page, expected_output):
+        """
+        Test class checks specific applications
+        and response works as expected. See parametrized parameters for more
+        details
+        """
         self.s2i_app = build_s2i_app(application_path, container_args=container_args)
         cid_file_name = self.s2i_app.app_name
         assert self.s2i_app.create_container(
@@ -128,6 +143,9 @@ def teardown_method(self):
         self.s2i_app.cleanup()
 
     def test_npm_works(self):
+        """
+        Test checks if NPM works in container.
+        """
         assert self.s2i_app.npm_works(image_name=VARS.IMAGE_NAME)
 
 
@@ -140,6 +158,10 @@ def test_npm_works(self):
 )
 class TestPerlHotDeployAppContainer:
     def test_run_app_test(self, application_path, container_args, hot_deploy):
+        """
+        Test checks hot deploy application
+        It checks what is present in HTTP response
+        """
         self.s2i_app = build_s2i_app(application_path, container_args=container_args)
         cid_file_name = self.s2i_app.app_name
         assert self.s2i_app.create_container(
@@ -156,13 +178,19 @@ def test_run_app_test(self, application_path, container_args, hot_deploy):
         assert self.s2i_app.test_response(
             url=f"http://{cip}", expected_output="old initial value: 1"
         )
-        sleep(2)
+        # We need to wait couple seconds till container
+        # before changing 'string' in 'Test.pm' file
+        # If we don't set PSGI_RELOAD, this change don't affects application.
+        # If we set PSGI_RELOAD, this change affects application.
+        sleep(3)
         PodmanCLIWrapper.podman_exec_shell_command(
             cid_file_name=cid,
             cmd="sed -ie 's/old initial value/new initial value/' lib/My/Test.pm",
             used_shell="/bin/sh"
         )
         if hot_deploy:
+            # We need to wait couple seconds till container
+            # does not update page. HotDeploy needs at least 3 seconds
             sleep(3)
             assert PodmanCLIWrapper.podman_exec_shell_command(
                 cid_file_name=cid,
@@ -173,7 +201,6 @@ def test_run_app_test(self, application_path, container_args, hot_deploy):
                 url=f"http://{cip}", expected_output="new initial value: 0"
             )
         else:
-            sleep(2)
             assert self.s2i_app.test_response(
                 url=f"http://{cip}", expected_output="old initial value: 2"
             )

test/test_ocp_dancer_ex_standalone.py

@@ -3,7 +3,6 @@
 from conftest import VARS
 
 
-# Replacement with 'test_python_s2i_app_ex'
 class TestPerlDancerExTemplate:
 
     def setup_method(self):
@@ -17,6 +16,10 @@ def teardown_method(self):
         self.oc_api.delete_project()
 
     def test_dancer_ex_template_inside_cluster(self):
+        """
+        Test checks if example GitHub application dancer-ex
+        works properly and response is as expected
+        """
         service_name = f"perl-{VARS.SHORT_VERSION}-testing"
         assert self.oc_api.deploy_s2i_app(
             image_name=VARS.IMAGE_NAME, app="https://github.com/sclorg/dancer-ex.git",

test/test_ocp_dancer_ex_templates.py

@@ -16,6 +16,12 @@ def teardown_method(self):
         self.oc_api.delete_project()
 
     def test_perl_template_inside_cluster(self):
+        """
+        Test checks if local imagestream and GitHub application dancer-ex
+        works properly and response is as expected.
+        The response is taken from POD `command-app`
+        executed inside the same project.
+        """
         self.oc_api.import_is("imagestreams/perl-rhel.json", "", skip_check=True)
         service_name = f"perl-{VARS.SHORT_VERSION}-testing"
         template_url = self.oc_api.get_raw_url_for_json(
@@ -49,6 +55,13 @@ def teardown_method(self):
         self.oc_api.delete_project()
 
     def test_perl_template_inside_cluster(self):
+        """
+        Test checks if local imagestream and GitHub application dancer-ex
+        works properly and response is as expected.
+        MySQL persistent database is enabled as well.
+        The response is taken from POD `command-app`
+        executed inside the same project.
+        """
         self.oc_api.import_is("imagestreams/perl-rhel.json", "", skip_check=True)
         assert self.oc_api.upload_image(DEPLOYED_MYSQL_IMAGE, f"{IMAGE_TAG}")
         service_name = f"perl-{VARS.SHORT_VERSION}-testing"

test/test_ocp_deploy_templates.py

@@ -16,6 +16,12 @@ def teardown_method(self):
         self.oc_api.delete_project()
 
     def test_perl_template_inside_cluster(self):
+        """
+        Test checks if local imagestream and local sample app
+        works properly and response is as expected.
+        The response is taken from POD `command-app`
+        executed inside the same project.
+        """
         self.oc_api.import_is("imagestreams/perl-rhel.json", "", skip_check=True)
         service_name = f"perl-{VARS.SHORT_VERSION}-testing"
         assert self.oc_api.deploy_template_with_image(

test/test_ocp_helm_dancer_app.py

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

test/test_ocp_helm_dancer_mysql_template.py

@@ -17,6 +17,10 @@ def teardown_method(self):
         self.hc_api.delete_project()
 
     def test_dancer_application_helm_test(self):
+        """
+        Test checks if Helm imagestream and Helm perl dancer application
+        works properly and response is as expected.
+        """
         skip_helm_charts_tests()
         self.hc_api.package_name = "redhat-perl-imagestreams"
         assert self.hc_api.helm_package()

test/test_ocp_helm_perl_imagestreams.py

@@ -33,6 +33,9 @@ def teardown_method(self):
         ],
     )
     def test_package_imagestream(self, version, registry, expected):
+        """
+        Test checks if Helm imagestreams
+        """
         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_imagestreams_quickstart.py

@@ -4,7 +4,7 @@
 from conftest import VARS, TAGS, skip_helm_charts_tests
 
 
-# Replacement with 'test_python_s2i_templates'
+# Replacement with 'test_perl_s2i_templates'
 class TestImagestreamsQuickstart:
 
     def setup_method(self):
@@ -18,6 +18,12 @@ def teardown_method(self):
         self.oc_api.delete_project()
 
     def test_perl_template_inside_cluster(self):
+        """
+        Test checks if local imagestream and local sample app
+        works properly and response is as expected.
+        The response is taken from POD `command-app`
+        executed inside the same project.
+        """
         skip_helm_charts_tests()
         service_name = f"perl-{VARS.SHORT_VERSION}-testing"
         assert self.oc_api.imagestream_quickstart(

test/test_ocp_latest_imagestreams.py

@@ -10,6 +10,9 @@ def setup_method(self):
         self.isc = ImageStreamChecker(working_dir=VARS.TEST_DIR.parent.parent)
 
     def test_latest_imagestream(self):
+        """
+        Test checks if local imagestream is the latest one
+        """
         self.latest_version = self.isc.get_latest_version()
         assert self.latest_version != ""
         self.isc.check_imagestreams(self.latest_version)