fix: fix update_zuul_project_config script

Some of the previous changes broken update_zuul_project_config part of
the script responsible for verifying required zuul template is present.
It is verifying that, but mistankengly not raising a flag that update is
required.

otc_metadata/templates/tox.ini.j2

@@ -35,7 +35,7 @@ commands =
   {[testenv:json-{{ doc.type }}]commands}
 {%- endfor %}
 
-[testenv:pdf-docs]
+[testenv:docs-pdf]
 deps = -r{toxinidir}/doc/requirements.txt
 allowlist_externals =
   rm

otc_metadata/tests/test_otc_metadata.py

@@ -21,8 +21,45 @@ Tests for `otc-metadata` module.
 
 from unittest import TestCase
 
+from otc_metadata import services
+
 
 class TestOtcMetadata(TestCase):
+    def setUp(self):
+        self.data = services.Services()
 
-    def test_something(self):
+    def test_data_is_sorted(self):
-        pass
+        curr = self.data
+        new = services.Services()
+        new._sort_data()
+        self.assertEqual(
+            curr._service_data, new._service_data, "Data is sorted properly"
+        )
+
+    def test_service_categories(self):
+        category = dict()
+        for cat in self.data._service_data["service_categories"]:
+            category[cat["name"]] = cat["title"]
+        for srv in self.data.all_services:
+            self.assertTrue(
+                srv["service_category"] in category,
+                f"Category {srv['service_category']} is present",
+            )
+
+    def test_doc_contains_required_data(self):
+        srv_types = dict()
+        for srv in self.data.all_services:
+            srv_types[srv["service_type"]] = srv
+        for doc in self.data.all_docs:
+            for attr in [
+                "rst_location",
+                "service_type",
+                "title",
+                "type",
+            ]:
+                self.assertIn(attr, doc, f"Document {doc} contains {attr}")
+            self.assertIn(
+                doc["service_type"],
+                srv_types,
+                f"Document {doc} contains valid service_type",
+            )

test-requirements.txt

@@ -4,4 +4,4 @@
 
 stestr>=2.0.0 # Apache-2.0
 testtools>=2.2.0 # MIT
-flake8
+flake8>=6.0

tools/update_zuul_project_configs.py

@@ -130,7 +130,6 @@ def process_repositories(args, service):
         zuul_templates = None
         zuul_jobs = dict()
         zuul_new_jobs = list()
-        zuul_vars = dict()
         zuul_config_updated = False
         for item in zuul_config:
             if "project" in item.keys():
@@ -138,11 +137,10 @@ def process_repositories(args, service):
                 zuul_templates = project.setdefault("templates", [])
                 if not zuul_templates:
                     zuul_templates = []
-                zuul_vars = project.setdefault("vars", {})
             elif "job" in item.keys():
                 job = item["job"]
                 zuul_jobs[job["name"]] = job
-        logging.debug(f"Existing jobs {zuul_jobs}")
+        print(f"Existing jobs {zuul_jobs}")
         if "helpcenter-base-jobs" not in zuul_templates:
             zuul_templates.append("helpcenter-base-jobs")
             zuul_config_updated = True
@@ -150,24 +148,22 @@ def process_repositories(args, service):
         job_suffix = (
             "-hc-int-jobs" if args.environment == "internal" else "-hc-jobs"
         )
-        sphinx_pdf_files = zuul_vars.setdefault('sphinx_pdf_files', [])
         for doc in data.docs_by_service_type(service["service_type"]):
-            logging.debug(f"Analyzing document {doc}")
+            logging.info("Analyzing document %s" % doc)
             if not doc.get("type"):
+                logging.debug("Skipping unsupported type")
                 continue
             if doc["type"] == "dev":
                 doc_type = "dev-guide"
             else:
                 doc_type = doc["type"]
-            # Collect all PDF files into sphinx_pdf_files var
-            pdf_name = doc.get('pdf_name')
-            if pdf_name and f"{pdf_name}.pdf" not in sphinx_pdf_files:
-                sphinx_pdf_files.append(f"{pdf_name}.pdf")
-                zuul_config_updated = True
-
             template_name = f"{doc_type}{job_suffix}"
             if doc_type in ["api-ref", "umn", "dev-guide"]:
+                logging.debug(
+                    "Ensuring required zuul template %s is present" % template_name)
                 if template_name not in zuul_templates:
+                    logging.debug("Adding template %s" % template_name)
+                    zuul_config_updated = True
                     zuul_templates.append(template_name)
             else:
                 job_name = f"build-otc-{doc['service_type']}-{doc_type}"
@@ -199,7 +195,6 @@ def process_repositories(args, service):
                 if "project" in item.keys():
                     project = item["project"]
                     project["templates"] = zuul_templates
-                    project["vars"] = zuul_vars
                     # Ensure new jobs are in check
                     if len(zuul_new_jobs) > 0:
                         project.setdefault(
@@ -255,6 +250,8 @@ def process_repositories(args, service):
                         head=branch_name,
                     ),
                 )
+        else:
+            logging.info("No update is necessary")
 
 
 def main():

tox.ini

@@ -19,7 +19,6 @@ commands = {posargs}
 
 [flake8]
 # E123, E125 skipped as they are invalid PEP-8.
-
 show-source = True
 ignore = E123,E125,W503
 builtins = _

zuul.yaml

@@ -1,3 +1,4 @@
+---
 - project:
     merge-mode: squash-merge
     default-branch: main