Add more documentation descriptions to each test suite

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

Author: phracek

test/test_container_application.py

@@ -36,8 +36,11 @@ def teardown_method(self):
             "--user 12345"
         ]
     )
-    # test_application
     def test_application(self, container_arg):
+        """
+        Test if container works under specific user
+        and not only with user --user 10001
+        """
         version = VERSION.replace("-micro", "")
         cid_file_name = "test-app"
         assert self.app.create_container(
@@ -46,20 +49,25 @@ def test_application(self, container_arg):
         )
         cip = self.app.get_cip(cid_file_name=cid_file_name)
         assert cip
+        # nginx -v returns proper version
         assert PodmanCLIWrapper.podman_run_command(
             f"--rm {self.app.image_name} /bin/bash -c 'nginx -v'"
         ).startswith(f"nginx version: nginx/{version}")
+        # Response code from HTTP url is 200 and contains proper output
         assert self.app.test_response(
             url=f"http://{cip}", expected_output="NGINX is working"
         )
+        # Response code from HTTP url is 200 and contains proper output
         assert self.app.test_response(
             url=f"http://{cip}", expected_output="NGINX2 is working",
             host="localhost2"
         )
+        # Response code from HTTP url is 200 and contains proper output
         assert self.app.test_response(
             url=f"http://{cip}", expected_output="NGINX2 is working",
             page="/aliased/index2.html"
         )
+        # Response code from HTTP url is 404 and nginx-cfg/default.conf is not accessible
         assert self.app.test_response(
             url=f"http://{cip}", expected_code=404,
             page="/nginx-cfg/default.conf"

test/test_container_basics.py

@@ -16,16 +16,25 @@ def teardown_method(self):
         self.app.cleanup()
 
     def test_run_s2i_usage(self, app):
+        """
+        Test if s2i usage works
+        """
         output = app.s2i_usage()
         assert output != ""
 
     def test_docker_run_usage(self):
+        """
+        Test if container is runnable
+        """
         assert PodmanCLIWrapper.call_podman_command(
             cmd=f"run --rm {IMAGE_NAME} &>/dev/null",
             return_output=False
         ) == 0
 
     def test_scl_usage(self):
+        """
+        Test if nginx -v returns proper output
+        """
         version = VERSION.replace("-micro", "")
         assert PodmanCLIWrapper.podman_run_command(
             f"--rm {IMAGE_NAME} /bin/bash -c 'nginx -v'"
@@ -39,6 +48,10 @@ def test_scl_usage(self):
         ]
     )
     def test_dockerfiles(self, app, dockerfile):
+        """
+        Test if building nginx-container based on
+        examples/Dockerfile works
+        """
         version = VERSION.replace("-micro", "")
         dp = DockerfileProcessor(dockerfile_path=f"{TEST_DIR}/examples/{dockerfile}")
         dp.update_env_in_dockerfile(version=version, what_to_replace="ENV NGINX_VERSION")
@@ -52,5 +65,4 @@ def test_dockerfiles(self, app, dockerfile):
         assert app.test_app_dockerfile()
         cip = app.get_cip()
         assert cip
-        assert app.test_response(url=cip, expected_code=200,
-                                 expected_output="NGINX is working")
+        assert app.test_response(url=cip, expected_output="NGINX is working")

test/test_container_example_apps.py

@@ -15,6 +15,11 @@
 
 
 def build_s2i_app(app_path: Path) -> ContainerTestLib:
+    """
+    Build S2I Container based on the app_path input
+    :param: app_path: path to example directory
+    :return new instance of ContainerTestLib
+    """
     container_lib = ContainerTestLib(IMAGE_NAME)
     app_name = app_path.name
     s2i_app = container_lib.build_as_df(
@@ -38,7 +43,9 @@ def teardown_method(self):
     def test_run_app_test(self, example_app_test):
         version = VERSION.replace("-micro", "")
         cid_file_name = example_app_test.app_name
+        # Create container with --user 10001
         assert self.s2i_app.create_container(cid_file_name=cid_file_name, container_args="--user 10001")
+        # Wait till container does not start
         assert ContainerImage.wait_for_cid(cid_file_name=cid_file_name)
         cid = self.s2i_app.get_cid(cid_file_name=cid_file_name)
         assert cid
@@ -47,7 +54,9 @@ def test_run_app_test(self, example_app_test):
         command = PodmanCLIWrapper.podman_get_file_content(
             cid_file_name=cid, filename="/opt/app-root/etc/nginx.d/default.conf"
         )
+        # Checks if nginx configuration contains resolver
         assert re.search("resolver", command)
+        # Checks if nginx configuration DO NOT container "DNS_SERVER"
         assert not re.search("DNS_SERVER", command)
         assert PodmanCLIWrapper.podman_run_command(
             f"--rm {example_app_test.image_name} /bin/bash -c 'nginx -v'"
@@ -83,6 +92,7 @@ def test_run_app_test(self):
         assert cid
         cip = self.s2i_app.get_cip(cid_file_name=cid_file_name)
         assert cip
+        # Checks if returns header of Perl version
         perl_version = PodmanCLIWrapper.podman_exec_shell_command(cid_file_name=cid, cmd="perl -e 'print \"$^V\"'")
         assert self.s2i_app.test_response(
             url=f"http://{cip}", port=8080,
@@ -115,14 +125,15 @@ def test_log_output(self, s2i_log_test):
             url=f"http://{cip}", port=8080, expected_output="NGINX is working"
         )
         assert '"GET / HTTP/1.1" 200' in s2i_log_test.get_logs(cid_file_name=cid_file_name)
+        # Check if /nothing-at-all is really no accessible
         assert self.s2i_app.test_response(
             url=f"http://{cip}", port=8080, page="/nothing-at-all", expected_code=404
         )
         logs = self.s2i_app.get_logs(cid_file_name=cid_file_name)
         assert logs
+        # Checks logs container 'failed' and 'No such file or directory'
         assert re.search("open.*failed.*No such file or directory", logs)
 
-    # test_log_volume_output
     def test_log_volume_output(self, s2i_log_test):
         cid_file_name = "test-app"
         s2i_log_test.set_new_image(image_name=f"{IMAGE_NAME}-{cid_file_name}")
@@ -138,9 +149,11 @@ def test_log_volume_output(self, s2i_log_test):
             cid_file_name=cid,
             filename="/var/log/nginx/access.log"
         )
+        # Check if /nothing-at-all is really no accessible
         assert self.s2i_app.test_response(
             url=f"http://{cip}", port=8080, page="/nothing-at-all", expected_code=404
         )
+        # Check if /nothing-at-all is really mentioned in 'access.log'
         assert '"GET /nothing-at-all HTTP/1.1" 404' in PodmanCLIWrapper.podman_get_file_content(
             cid_file_name=cid,
             filename="/var/log/nginx/access.log"
@@ -149,5 +162,6 @@ def test_log_volume_output(self, s2i_log_test):
             cid_file_name=cid,
             filename="/var/log/nginx/error.log"
         )
+        # Checks logs container 'failed' and 'No such file or directory'
         assert re.search("open.*failed.*No such file or directory", logs_to_check)