Improvement of database testing.

Call sql commands at once.
Change initial names to understandable.
Use DatabaseWrapper directly to call sql commands.

Check mariadb configuration values together. Do not duplicate code.

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

Author: phracek

test/test_container_basics.py

@@ -27,18 +27,18 @@ class TestMariaDBBasicsContainer:
     """
 
     def setup_method(self):
-        self.s2i_db = build_s2i_app(app_path=VARS.TEST_DIR / "test-app")
-        self.s2i_db.set_new_db_type(db_type="mysql")
+        self.app_image = build_s2i_app(app_path=VARS.TEST_DIR / "test-app")
+        self.app_image.set_new_db_type(db_type="mysql")
 
     def teardown_method(self):
-        self.s2i_db.cleanup()
+        self.app_image.cleanup()
 
     def test_s2i_usage(self):
         """
         Test container creation fails with invalid combinations of arguments.
         """
         cid_config_build = "s2i_config_build"
-        self.s2i_db.assert_container_creation_fails(
+        self.app_image.assert_container_creation_fails(
             cid_file_name=cid_config_build,
             command="",
             container_args=[
@@ -48,7 +48,7 @@ def test_s2i_usage(self):
                 "-e MYSQL_ROOT_PASSWORD=pass",
             ],
         )
-        assert self.s2i_db.create_container(
+        assert self.app_image.create_container(
             cid_file_name=cid_config_build,
             container_args=[
                 "-e MYSQL_USER=config_test_user",
@@ -58,17 +58,12 @@ def test_s2i_usage(self):
                 "-e MYSQL_OPERATIONS_PASSWORD=operations_user",
             ],
         )
-        cip = self.s2i_db.get_cip(cid_file_name=cid_config_build)
+        cip = self.app_image.get_cip(cid_file_name=cid_config_build)
         assert cip
-        assert self.s2i_db.test_db_connection(
+        assert self.app_image.test_db_connection(
             container_ip=cip, username="operations_user", password="operations_user"
         )
-        cid = self.s2i_db.get_cid(cid_file_name=cid_config_build)
-        db_configuration = PodmanCLIWrapper.podman_exec_shell_command(
-            cid_file_name=cid,
-            cmd="cat /etc/my.cnf /etc/my.cnf.d/*",
-        )
-        assert db_configuration
+        cid = self.app_image.get_cid(cid_file_name=cid_config_build)
         PodmanCLIWrapper.call_podman_command(cmd=f"stop {cid}")
 
     def test_s2i_usage_with_mount(self):
@@ -83,7 +78,7 @@ def test_s2i_usage_with_mount(self):
             ]
         )
         cid_s2i_test_mount = "s2i_test_mount"
-        self.s2i_db.create_container(
+        self.app_image.create_container(
             cid_file_name=cid_s2i_test_mount,
             container_args=[
                 "-e MYSQL_USER=config_test_user",
@@ -94,20 +89,15 @@ def test_s2i_usage_with_mount(self):
                 f"-v {data_dir}/test-app:/opt/app-root/src/:z",
             ],
         )
-        cip_test_mount = self.s2i_db.get_cip(cid_file_name=cid_s2i_test_mount)
+        cip_test_mount = self.app_image.get_cip(cid_file_name=cid_s2i_test_mount)
         assert cip_test_mount
-        assert self.s2i_db.test_db_connection(
+        assert self.app_image.test_db_connection(
             container_ip=cip_test_mount,
             username="operations_user",
             password="operations_pass",
             max_attempts=10,
         )
-        cid = self.s2i_db.get_cid(cid_file_name=cid_s2i_test_mount)
+        cid = self.app_image.get_cid(cid_file_name=cid_s2i_test_mount)
         assert cid
-        db_configuration = PodmanCLIWrapper.podman_exec_shell_command(
-            cid_file_name=cid,
-            cmd="cat /etc/my.cnf /etc/my.cnf.d/*",
-        )
-        assert db_configuration
         PodmanCLIWrapper.call_podman_command(cmd=f"stop {cid}")
         shutil.rmtree(data_dir)

test/test_container_configuration.py

@@ -4,6 +4,7 @@
 
 from container_ci_suite.container_lib import ContainerTestLib
 from container_ci_suite.engines.podman_wrapper import PodmanCLIWrapper
+from container_ci_suite.container_lib import DatabaseWrapper
 
 from conftest import VARS
 
@@ -14,9 +15,15 @@ class TestMariaDBConfigurationContainer:
     """
 
     def setup_method(self):
+        """
+        Setup the test environment.
+        """
         self.db = ContainerTestLib(image_name=VARS.IMAGE_NAME)
 
     def teardown_method(self):
+        """
+        Teardown the test environment.
+        """
         self.db.cleanup()
 
     def test_container_creation_fails(self):
@@ -155,11 +162,18 @@ class TestMariaDBConfigurationTests:
     """
 
     def setup_method(self):
-        self.db = ContainerTestLib(image_name=VARS.IMAGE_NAME)
-        self.db.set_new_db_type(db_type="mysql")
+        """
+        Setup the test environment.
+        """
+        self.db_config = ContainerTestLib(image_name=VARS.IMAGE_NAME)
+        self.db_config.set_new_db_type(db_type="mysql")
+        self.db_api = DatabaseWrapper(image_name=VARS.IMAGE_NAME)
 
     def teardown_method(self):
-        self.db.cleanup()
+        """
+        Teardown the test environment.
+        """
+        self.db_config.cleanup()
 
     def test_configuration_auto_calculated_settings(self):
         """
@@ -168,7 +182,7 @@ def test_configuration_auto_calculated_settings(self):
         cid_config_test = "auto-config_test"
         username = "config_test_user"
         password = "config_test"
-        assert self.db.create_container(
+        assert self.db_config.create_container(
             cid_file_name=cid_config_test,
             container_args=[
                 "--env MYSQL_COLLATION=latin2_czech_cs",
@@ -179,57 +193,48 @@ def test_configuration_auto_calculated_settings(self):
             ],
             docker_args="--memory=256m",
         )
-        cip = self.db.get_cip(cid_file_name=cid_config_test)
+        cip = self.db_config.get_cip(cid_file_name=cid_config_test)
         assert cip
-        return_value = self.db.test_db_connection(
+        assert self.db_config.test_db_connection(
             container_ip=cip,
             username=username,
             password=password,
             max_attempts=10,
             database=VARS.DB_NAME,
         )
-        assert return_value
-        cid = self.db.get_cid(cid_file_name=cid_config_test)
+        cid = self.db_config.get_cid(cid_file_name=cid_config_test)
         db_configuration = PodmanCLIWrapper.podman_exec_shell_command(
             cid_file_name=cid,
             cmd="cat /etc/my.cnf /etc/my.cnf.d/*",
         )
-        assert db_configuration
-        assert re.search(
-            r"key_buffer_size\s*=\s*25M",
-            db_configuration,
-        )
-        assert re.search(
-            r"read_buffer_size\s*=\s*12M",
-            db_configuration,
-        )
-        assert re.search(
-            r"innodb_log_file_size\s*=\s*38M",
-            db_configuration,
-        )
-        assert re.search(
-            r"innodb_log_buffer_size\s*=\s*38M",
-            db_configuration,
-        )
+        words = [
+            "key_buffer_size\\s*=\\s*25M",
+            "read_buffer_size\\s*=\\s*12M",
+            "innodb_log_file_size\\s*=\\s*38M",
+            "innodb_log_buffer_size\\s*=\\s*38M",
+        ]
+        for word in words:
+            assert re.search(word, db_configuration), (
+                f"Word {word} not found in {db_configuration}"
+            )
         # do some real work to test replication in practice
-        return_value = self.db.test_db_connection(
+        self.db_api.run_sql_command(
             container_ip=cip,
             username=username,
             password=password,
+            container_id=cid,
             database=VARS.DB_NAME,
-            sql_cmd="-e 'CREATE TABLE tbl (col VARCHAR(20));'",
+            sql_cmd="CREATE TABLE tbl (col VARCHAR(20));",
+            podman_run_command="exec",
         )
-        print(f"Creating table: {return_value}")
-        assert self.db.test_db_connection(
+        show_table_output = self.db_api.run_sql_command(
             container_ip=cip,
             username=username,
             password=password,
-            sql_cmd="-e 'SHOW CREATE TABLE tbl;'",
+            container_id=cid,
             database=VARS.DB_NAME,
-        )
-        show_table_output = PodmanCLIWrapper.call_podman_command(
-            cmd=f"exec {cid} mysql -uroot -e 'SHOW CREATE TABLE tbl;' {VARS.DB_NAME}",
-            ignore_error=True,
+            sql_cmd="SHOW CREATE TABLE tbl;",
+            podman_run_command="exec",
         )
         assert "CHARSET=latin2" in show_table_output
         assert "COLLATE=latin2_czech_cs" in show_table_output
@@ -240,7 +245,7 @@ def test_configuration_options_settings(self):
         Test MariaDB container configuration options.
         """
         cid_config_test = "config_test"
-        assert self.db.create_container(
+        assert self.db_config.create_container(
             cid_file_name=cid_config_test,
             container_args=[
                 "--env MYSQL_USER=config_test_user",
@@ -262,52 +267,43 @@ def test_configuration_options_settings(self):
                 "--env WORKAROUND_DOCKER_BUG_14203=",
             ],
         )
-        cip = self.db.get_cip(cid_file_name=cid_config_test)
+        cip = self.db_config.get_cip(cid_file_name=cid_config_test)
         assert cip
-        assert self.db.test_db_connection(
+        assert self.db_config.test_db_connection(
             container_ip=cip,
             username="config_test_user",
             password="config_test",
             database=VARS.DB_NAME,
         )
-        cip = self.db.get_cip(cid_file_name=cid_config_test)
+        cip = self.db_config.get_cip(cid_file_name=cid_config_test)
         assert cip
-        return_value = self.db.test_db_connection(
+        assert self.db_config.test_db_connection(
             container_ip=cip,
             username="config_test_user",
             password="config_test",
             max_attempts=10,
             database=VARS.DB_NAME,
         )
-        assert return_value
-        cid = self.db.get_cid(cid_file_name=cid_config_test)
+        cid = self.db_config.get_cid(cid_file_name=cid_config_test)
         db_configuration = PodmanCLIWrapper.podman_exec_shell_command(
             cid_file_name=cid,
             cmd="cat /etc/my.cnf /etc/my.cnf.d/*",
         )
-        assert db_configuration
-        assert re.search(
-            r"lower_case_table_names\s*=\s*1",
-            db_configuration,
-        )
-        assert re.search(
-            r"general_log\s*=\s*1",
-            db_configuration,
-        )
-        assert re.search(
-            r"max_connections\s*=\s*1337",
-            db_configuration,
-            re.MULTILINE | re.IGNORECASE,
-        )
-        assert re.search(r"ft_min_word_len\s*=\s*8", db_configuration)
-        assert re.search(
-            r"ft_max_word_len\s*=\s*15",
-            db_configuration,
-        )
-        assert re.search(r"max_allowed_packet\s*=\s*10M", db_configuration)
-        assert re.search(r"table_open_cache\s*=\s*100", db_configuration)
-        assert re.search(r"sort_buffer_size\s*=\s*256K", db_configuration)
-        assert re.search(r"key_buffer_size\s*=\s*16M", db_configuration)
-        assert re.search(r"read_buffer_size\s*=\s*16M", db_configuration)
-        assert re.search(r"innodb_log_file_size\s*=\s*4M", db_configuration)
-        assert re.search(r"innodb_log_buffer_size\s*=\s*4M", db_configuration)
+        words = [
+            "lower_case_table_names\\s*=\\s*1",
+            "general_log\\s*=\\s*1",
+            "max_connections\\s*=\\s*1337",
+            "ft_min_word_len\\s*=\\s*8",
+            "ft_max_word_len\\s*=\\s*15",
+            "max_allowed_packet\\s*=\\s*10M",
+            "table_open_cache\\s*=\\s*100",
+            "sort_buffer_size\\s*=\\s*256K",
+            "key_buffer_size\\s*=\\s*16M",
+            "read_buffer_size\\s*=\\s*16M",
+            "innodb_log_file_size\\s*=\\s*4M",
+            "innodb_log_buffer_size\\s*=\\s*4M",
+        ]
+        for word in words:
+            assert re.search(word, db_configuration), (
+                f"Word {word} not found in {db_configuration}"
+            )