tests: refactor web/exec tests

Factorize reference testing database validation logic in
TestRacksDBReferenceDB common abstract class.

Author: rezib

Diff for: racksdb/tests/lib/reference.py

@@ -0,0 +1,75 @@
+# Copyright (c) 2025 Rackslab
+#
+# This file is part of RacksDB.
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+import unittest
+
+# Expected values from testing reference DB.
+REFDB_DATACENTERS = ["paris", "london"]
+REFDB_INFRASTRUCTURES = ["mercury", "jupiter", "sharednet"]
+REFDB_TOTAL_NODES = 130
+
+
+class TestRacksDBReferenceDB(unittest.TestCase):
+    """Abstract TestCase class with method to validate data from testing reference
+    database."""
+
+    def assertDatacentersResponse(self, content):
+        self.assertIsInstance(content, list)
+        self.assertEqual(len(content), 2)
+        self.assertCountEqual(
+            [datacenter["name"] for datacenter in content], REFDB_DATACENTERS
+        )
+        self.assertIsInstance(content[0], dict)
+        # tags key is optional, it may not be present in selected datacenter.
+        for key in ["name", "rooms", "location"]:
+            self.assertIn(
+                key,
+                content[0],
+            )
+
+    def assertInfrastructuresResponse(self, content):
+        self.assertIsInstance(content, list)
+        self.assertEqual(len(content), 3)
+        self.assertCountEqual(
+            [infrastructure["name"] for infrastructure in content],
+            REFDB_INFRASTRUCTURES,
+        )
+        self.assertIsInstance(content[0], dict)
+        # tags key is optional, it may not be present in selected infrastructure.
+        for key in ["name", "description", "layout"]:
+            self.assertIn(
+                key,
+                content[0],
+            )
+
+    def assertNodesResponse(self, content):
+        self.assertIsInstance(content, list)
+        self.assertEqual(len(content), 130)
+        self.assertIsInstance(content[0], dict)
+        self.assertCountEqual(
+            content[0].keys(),
+            ["name", "infrastructure", "rack", "type", "slot", "tags", "position"],
+        )
+
+    def assertRacksResponse(self, content):
+        self.assertIsInstance(content, list)
+        self.assertEqual(len(content), 101)
+        self.assertIsInstance(content[0], dict)
+        # tags key is optional, it may not be present in select rack.
+        for key in [
+            "name",
+            "slot",
+            "type",
+            "datacenter",
+            "room",
+            "row",
+            "nodes",
+            "fillrate",
+        ]:
+            self.assertIn(
+                key,
+                content[0].keys(),
+            )

Diff for: racksdb/tests/test_exec.py

@@ -4,7 +4,6 @@
 #
 # SPDX-License-Identifier: GPL-3.0-or-later
 
-import unittest
 from unittest import mock
 import io
 import tempfile
@@ -20,17 +19,19 @@
 from racksdb.version import get_version
 
 from .lib.common import schema_path, db_path, drawing_schema_path
+from .lib.reference import (
+    TestRacksDBReferenceDB,
+    REFDB_INFRASTRUCTURES,
+    REFDB_DATACENTERS,
+    REFDB_TOTAL_NODES,
+)
 
-# Expected values from example DB.
-EXAMPLE_DATACENTERS = ["paris", "london"]
-EXAMPLE_INFRASTRUCTURES = ["mercury", "jupiter", "sharednet"]
-EXAMPLE_TOTAL_NODES = 130
 
 CMD_BASE_ARGS = ["--schema", str(schema_path()), "--db", str(db_path())]
 CMD_DRAW_BASE_ARGS = ["draw", "--drawings-schema", str(drawing_schema_path())]
 
 
-class TestRacksDBExec(unittest.TestCase):
+class TestRacksDBExec(TestRacksDBReferenceDB):
     def test_version(self):
         for option in ["-v", "--version"]:
             with mock.patch("sys.stdout", new=io.StringIO()) as output:
@@ -70,20 +71,6 @@ def test_schema(self):
     # datacenters
     #
 
-    def assertDatacentersResponse(self, content):
-        self.assertIsInstance(content, list)
-        self.assertEqual(len(content), 2)
-        self.assertCountEqual(
-            [datacenter["name"] for datacenter in content], EXAMPLE_DATACENTERS
-        )
-        self.assertIsInstance(content[0], dict)
-        # tags key is optional, it may not be present in selected datacenter.
-        for key in ["name", "rooms", "location"]:
-            self.assertIn(
-                key,
-                content[0],
-            )
-
     def test_datacenters(self):
         with mock.patch("sys.stdout", new=io.StringIO()) as output:
             RacksDBExec(CMD_BASE_ARGS + ["datacenters"])
@@ -111,7 +98,7 @@ def test_datacenters_list(self):
                 ]
             )
             self.assertCountEqual(
-                output.getvalue().strip().split("\n"), EXAMPLE_DATACENTERS
+                output.getvalue().strip().split("\n"), REFDB_DATACENTERS
             )
 
     def test_datacenters_not_found(self):
@@ -130,21 +117,6 @@ def test_datacenters_not_found(self):
     # infrastructures
     #
 
-    def assertInfrastructuresResponse(self, content):
-        self.assertIsInstance(content, list)
-        self.assertEqual(len(content), 3)
-        self.assertCountEqual(
-            [infrastructure["name"] for infrastructure in content],
-            EXAMPLE_INFRASTRUCTURES,
-        )
-        self.assertIsInstance(content[0], dict)
-        # tags key is optional, it may not be present in selected infrastructure.
-        for key in ["name", "description", "layout"]:
-            self.assertIn(
-                key,
-                content[0],
-            )
-
     def test_infrastructures(self):
         with mock.patch("sys.stdout", new=io.StringIO()) as output:
             RacksDBExec(
@@ -177,7 +149,7 @@ def test_infrastructure_list(self):
                 ]
             )
             self.assertCountEqual(
-                output.getvalue().strip().split("\n"), EXAMPLE_INFRASTRUCTURES
+                output.getvalue().strip().split("\n"), REFDB_INFRASTRUCTURES
             )
 
     def test_infrastructure_not_found(self):
@@ -196,15 +168,6 @@ def test_infrastructure_not_found(self):
     # nodes
     #
 
-    def assertNodesResponse(self, content):
-        self.assertIsInstance(content, list)
-        self.assertEqual(len(content), EXAMPLE_TOTAL_NODES)
-        self.assertIsInstance(content[0], dict)
-        self.assertCountEqual(
-            content[0].keys(),
-            ["name", "infrastructure", "rack", "type", "slot", "tags", "position"],
-        )
-
     def test_nodes(self):
         with mock.patch("sys.stdout", new=io.StringIO()) as output:
             RacksDBExec(
@@ -237,7 +200,7 @@ def test_nodes_list(self):
                 ]
             )
             self.assertEqual(
-                len(output.getvalue().strip().split("\n")), EXAMPLE_TOTAL_NODES
+                len(output.getvalue().strip().split("\n")), REFDB_TOTAL_NODES
             )
 
     def test_nodes_name(self):
@@ -279,7 +242,7 @@ def test_nodes_tags(self):
             )
             nodes = yaml.safe_load(output.getvalue())
             self.assertIsInstance(nodes, list)
-            self.assertLess(len(nodes), EXAMPLE_TOTAL_NODES)
+            self.assertLess(len(nodes), REFDB_TOTAL_NODES)
 
     def test_nodes_multiple_tags(self):
         # Check less nodes are selected with multiple tags than with only one tag.
@@ -333,26 +296,6 @@ def test_nodes_fold(self):
     # racks
     #
 
-    def assertRacksResponse(self, content):
-        self.assertIsInstance(content, list)
-        self.assertEqual(len(content), 101)
-        self.assertIsInstance(content[0], dict)
-        # tags key is optional, it may not be present in select rack.
-        for key in [
-            "name",
-            "slot",
-            "type",
-            "datacenter",
-            "room",
-            "row",
-            "nodes",
-            "fillrate",
-        ]:
-            self.assertIn(
-                key,
-                content[0].keys(),
-            )
-
     def test_racks(self):
         with mock.patch("sys.stdout", new=io.StringIO()) as output:
             RacksDBExec(

Diff for: racksdb/tests/web/test_blueprint.py

@@ -4,7 +4,6 @@
 #
 # SPDX-License-Identifier: GPL-3.0-or-later
 
-import unittest
 import tempfile
 import json
 import parameterized
@@ -20,10 +19,11 @@
 
 from ..lib.web import RacksDBCustomTestResponse
 from ..lib.common import schema_path, db_path, drawing_schema_path
-
-# Expected values from example DB.
-EXAMPLE_DATACENTERS = ["paris", "london"]
-EXAMPLE_INFRASTRUCTURES = ["mercury", "jupiter", "sharednet"]
+from ..lib.reference import (
+    TestRacksDBReferenceDB,
+    REFDB_DATACENTERS,
+    REFDB_INFRASTRUCTURES,
+)
 
 
 class FakeRacksDBWebApp(flask.Flask):
@@ -38,7 +38,7 @@ def __init__(self, schema, db, drawing_schema, openapi):
         self.register_blueprint(self.blueprint)
 
 
-class TestRacksDBWebBlueprint(unittest.TestCase):
+class TestRacksDBWebBlueprint(TestRacksDBReferenceDB):
     def setUp(self):
         try:
             self.schema_path = schema_path()
@@ -120,26 +120,10 @@ def test_schema(self):
             tmp.write(response.text)
             RacksDB.load(schema=tmp.name, db=self.db_path)
 
-    # test schema
-
     #
     # datacenters
     #
 
-    def assertDatacentersResponse(self, content):
-        self.assertIsInstance(content, list)
-        self.assertEqual(len(content), 2)
-        self.assertCountEqual(
-            [datacenter["name"] for datacenter in content], EXAMPLE_DATACENTERS
-        )
-        self.assertIsInstance(content[0], dict)
-        # tags key is optional, it may not be present in selected datacenter.
-        for key in ["name", "rooms", "location"]:
-            self.assertIn(
-                key,
-                content[0],
-            )
-
     def test_datacenters(self):
         response = self.client.get(f"/v{get_version()}/datacenters")
         self.assertEqual(response.status_code, 200)
@@ -157,17 +141,17 @@ def test_datacenters_list(self):
         self.assertEqual(response.status_code, 200)
         self.assertEqual(response.mimetype, "application/json")
         self.assertIsInstance(response.json, list)
-        self.assertCountEqual(response.json, EXAMPLE_DATACENTERS)
+        self.assertCountEqual(response.json, REFDB_DATACENTERS)
 
     def test_datacenters_name(self):
         response = self.client.get(
-            f"/v{get_version()}/datacenters?name={EXAMPLE_DATACENTERS[0]}"
+            f"/v{get_version()}/datacenters?name={REFDB_DATACENTERS[0]}"
         )
         self.assertEqual(response.status_code, 200)
         self.assertEqual(response.mimetype, "application/json")
         self.assertIsInstance(response.json, list)
         self.assertEqual(len(response.json), 1)
-        self.assertCountEqual(response.json[0]["name"], EXAMPLE_DATACENTERS[0])
+        self.assertCountEqual(response.json[0]["name"], REFDB_DATACENTERS[0])
 
     def test_datacenters_name_not_found(self):
         response = self.client.get(f"/v{get_version()}/datacenters?name=fail")
@@ -216,21 +200,6 @@ def test_datacenters_fold(self):
     # infrastructures
     #
 
-    def assertInfrastructuresResponse(self, content):
-        self.assertIsInstance(content, list)
-        self.assertEqual(len(content), 3)
-        self.assertCountEqual(
-            [infrastructure["name"] for infrastructure in content],
-            EXAMPLE_INFRASTRUCTURES,
-        )
-        self.assertIsInstance(content[0], dict)
-        # tags key is optional, it may not be present in selected infrastructure.
-        for key in ["name", "description", "layout"]:
-            self.assertIn(
-                key,
-                content[0],
-            )
-
     def test_infrastructures(self):
         response = self.client.get(f"/v{get_version()}/infrastructures")
         self.assertEqual(response.status_code, 200)
@@ -248,16 +217,16 @@ def test_infrastructures_list(self):
         self.assertEqual(response.status_code, 200)
         self.assertEqual(response.mimetype, "application/json")
         self.assertIsInstance(response.json, list)
-        self.assertCountEqual(response.json, EXAMPLE_INFRASTRUCTURES)
+        self.assertCountEqual(response.json, REFDB_INFRASTRUCTURES)
 
     def test_infrastructures_name(self):
         response = self.client.get(
-            f"/v{get_version()}/infrastructures?name={EXAMPLE_INFRASTRUCTURES[0]}"
+            f"/v{get_version()}/infrastructures?name={REFDB_INFRASTRUCTURES[0]}"
         )
         self.assertEqual(response.status_code, 200)
         self.assertEqual(response.mimetype, "application/json")
         self.assertIsInstance(response.json, list)
-        self.assertEqual(response.json[0]["name"], EXAMPLE_INFRASTRUCTURES[0])
+        self.assertEqual(response.json[0]["name"], REFDB_INFRASTRUCTURES[0])
 
     def test_infrastructures_name_not_found(self):
         response = self.client.get(f"/v{get_version()}/infrastructures?name=fail")
@@ -321,15 +290,6 @@ def test_infrastructures_fold(self):
     # nodes
     #
 
-    def assertNodesResponse(self, content):
-        self.assertIsInstance(content, list)
-        self.assertEqual(len(content), 130)
-        self.assertIsInstance(content[0], dict)
-        self.assertCountEqual(
-            content[0].keys(),
-            ["name", "infrastructure", "rack", "type", "slot", "tags", "position"],
-        )
-
     def test_nodes(self):
         response = self.client.get(f"/v{get_version()}/nodes")
         self.assertEqual(response.status_code, 200)
@@ -438,26 +398,6 @@ def test_nodes_infrastructure_not_found(self):
     # racks
     #
 
-    def assertRacksResponse(self, content):
-        self.assertIsInstance(content, list)
-        self.assertEqual(len(content), 101)
-        self.assertIsInstance(content[0], dict)
-        # tags key is optional, it may not be present in select rack.
-        for key in [
-            "name",
-            "slot",
-            "type",
-            "datacenter",
-            "room",
-            "row",
-            "nodes",
-            "fillrate",
-        ]:
-            self.assertIn(
-                key,
-                content[0].keys(),
-            )
-
     def test_racks(self):
         response = self.client.get(f"/v{get_version()}/racks")
         self.assertEqual(response.status_code, 200)