gitlab-compliance 2.6.0__tar.gz → 2.7.0__tar.gz

{gitlab_compliance-2.6.0 → gitlab_compliance-2.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gitlab-compliance
-Version: 2.6.0
+Version: 2.7.0
 Summary: BDD compliance testing for GitLab CI/CD pipelines and project settings — by MaturityBuilder
 License-Expression: Apache-2.0
 License-File: LICENSE
@@ -19,21 +19,21 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Software Development :: Quality Assurance
 Classifier: Topic :: Software Development :: Testing
 Requires-Dist: behave (>=1.2.6,<2.0.0)
-Requires-Dist: click (>=8.1.8,<9.0.0)
-Requires-Dist: idna (==3.18)
+Requires-Dist: click (>=8.5.0,<9.0.0)
+Requires-Dist: idna (==3.20)
 Requires-Dist: jq (==1.12.0)
 Requires-Dist: loguru (==0.7.2)
 Requires-Dist: markdown-analysis (==0.1.5)
-Requires-Dist: oras (==0.2.42)
+Requires-Dist: oras (==0.2.43)
 Requires-Dist: oyaml
 Requires-Dist: prettytable
 Requires-Dist: pytablewriter (==1.2.1)
-Requires-Dist: python-gitlab (==8.4.0)
+Requires-Dist: python-gitlab (==8.6.0)
 Requires-Dist: pyyaml (==6.0.3)
 Requires-Dist: requests (==2.34.2)
 Requires-Dist: rich (==15.0.0)
-Requires-Dist: semver (==3.0.4)
-Requires-Dist: typer (==0.27.0)
+Requires-Dist: semver (==3.1.0)
+Requires-Dist: typer (==0.27.2)
 Requires-Dist: urllib3 (==2.8.0)
 Project-URL: Documentation, https://maturitybuilder.github.io/gitlab-compliance/
 Project-URL: Home Page, https://maturitybuilder.github.io/gitlab-compliance/

{gitlab_compliance-2.6.0 → gitlab_compliance-2.7.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "gitlab-compliance"
-version = "2.6.0"
+version = "2.7.0"
 dynamic = [ "readme" ]
 license = "Apache-2.0"
 requires-python = ">=3.12"
@@ -40,18 +40,18 @@ python = ">=3.12"
 prettytable = "*"
 pytablewriter = "1.2.1"
 oyaml = "*"
-typer = "0.27.0"
+typer = "0.27.2"
 markdown-analysis = "0.1.5"
 urllib3 = "2.8.0"
 jq = "1.12.0"
-click = "^8.1.8"
-semver = "3.0.4"
+click = "^8.5.0"
+semver = "3.1.0"
 pyyaml = "6.0.3"
 loguru = "0.7.2"
-python-gitlab = "8.4.0"
+python-gitlab = "8.6.0"
 rich = "15.0.0"
-oras = "0.2.42"
-idna = "3.18"
+oras = "0.2.43"
+idna = "3.20"
 requests = "2.34.2"
 behave = "^1.2.6"
 
@@ -60,13 +60,13 @@ gitlab-docs = 'src.gitlab_compliance:gitlab_compliance'
 gitlab-compliance = 'src.gitlab_compliance:gitlab_compliance'
 
 [tool.poetry.group.dev.dependencies]
-setuptools = "83.0.0"
+setuptools = "84.1.0"
 pytest = "^9.0.3"
 pytest-xdist = "^3.8.0"
-pytest-cov = "^6.2.1"
-pre-commit = "^4.6.1"
+pytest-cov = "^7.1.0"
+pre-commit = "^4.6.2"
 pyyaml = "^6.0.3"
-coverage = "^7.9.2"
+coverage = "^7.16.2"
 
 [tool.black]
 line-length = 88
@@ -79,7 +79,7 @@ max-line-length = 88
 extend-ignore = ["E203", "W503"]
 
 [tool.poetry.group.docs.dependencies]
-zensical = "^0.0.51"
+zensical = "^0.0.67"
 [build-system]
 requires = ["poetry-core","setuptools","poetry-bumpversion","id"]
 build-backend = "poetry.core.masonry.api"

{gitlab_compliance-2.6.0 → gitlab_compliance-2.7.0}/src/compliance/behave_support/environment.py

@@ -37,6 +37,10 @@ def before_scenario(context, scenario):
     if not context.compliance_entities:
         depth_raw = context.config.userdata.get("max_include_depth", "")
         max_include_depth = int(depth_raw) if str(depth_raw).strip() else None
+        generated_raw = context.config.userdata.get("generated_configs", "") or ""
+        generated_configs = tuple(
+            part.strip() for part in str(generated_raw).split(",") if part.strip()
+        )
         context.compliance_entities = load_pipeline_entities(
             pipeline_file=pipeline,
             include_nested=context.config.userdata.get("include_nested", "true")
@@ -54,6 +58,9 @@ def before_scenario(context, scenario):
             resolve_external_includes=_resolve_external_flag(
                 context.config.userdata.get("resolve_external_includes", "auto")
             ),
+            resolve_generated=context.config.userdata.get("resolve_generated", "true")
+            == "true",
+            generated_configs=generated_configs or None,
             cache=getattr(context, "release_cache", None),
         )
 

{gitlab_compliance-2.6.0 → gitlab_compliance-2.7.0}/src/compliance/behave_support/steps/given_steps.py

@@ -107,6 +107,25 @@ def given_any_container_image_with_release_metadata(context):
     )
 
 
+@given("I have any dynamic child pipeline defined")
+def given_any_dynamic_child_pipeline(context):
+    _set_stash(context, context.compliance_entities.get("dynamic_child_pipelines", []))
+
+
+@given('I have dynamic child pipeline "{name}" defined')
+def given_named_dynamic_child_pipeline(context, name):
+    pipelines = [
+        item
+        for item in context.compliance_entities.get("dynamic_child_pipelines", [])
+        if item.get("name") == name or item.get("trigger_job") == name
+    ]
+    _set_stash_or_skip(
+        context,
+        pipelines,
+        skip_reason=f'No dynamic child pipeline named "{name}" found in pipeline',
+    )
+
+
 @given("I have any variable defined")
 def given_any_variable(context):
     _set_stash(context, context.compliance_entities.get("variables", []))

{gitlab_compliance-2.6.0 → gitlab_compliance-2.7.0}/src/compliance/include_fetch.py

@@ -322,6 +322,12 @@ def include_reference_label(parsed: dict[str, Any]) -> str:
         return f"{parsed.get('project', '')}@{parsed.get('version', '')}"
     if include_type == "template":
         return str(parsed.get("project", ""))
+    if include_type == "artifact":
+        artifact = parsed.get("artifact") or parsed.get("project", "")
+        generator = parsed.get("generator_job") or ""
+        if generator:
+            return f"{artifact} (from job {generator})"
+        return str(artifact)
     return str(parsed.get("project", ""))
 
 

{gitlab_compliance-2.6.0 → gitlab_compliance-2.7.0}/src/compliance/include_resolution.py

@@ -16,6 +16,10 @@ REASON_MESSAGES = {
     "external_resolution_disabled": "external include resolution disabled",
     "path_rejected": "local include path rejected",
     "not_found": "include file not found",
+    "generated_at_runtime": (
+        "generated CI YAML not on disk yet "
+        "(run compliance after the generator job writes the artifact)"
+    ),
 }
 
 

{gitlab_compliance-2.6.0 → gitlab_compliance-2.7.0}/src/compliance/model.py

@@ -106,11 +106,32 @@ def _workflow_rule_entity(
     }
 
 
+def _dynamic_child_pipeline_entity(index: int, record: dict) -> dict:
+    trigger_job = str(record.get("trigger_job") or "")
+    artifact = str(record.get("artifact") or "")
+    name = trigger_job or artifact or f"dynamic-child-{index}"
+    return {
+        "address": f"dynamic_child_pipeline.{index}",
+        "type": "dynamic_child_pipeline",
+        "name": name,
+        "trigger_job": trigger_job,
+        "generator_job": str(record.get("generator_job") or ""),
+        "artifact": artifact,
+        "resolved": bool(record.get("resolved")),
+        "include_type": str(record.get("include_type") or "artifact"),
+        "values": dict(record),
+        "source_file": str(record.get("source_file") or ""),
+        "line": int(record.get("line") or 0),
+    }
+
+
 def load_yaml_entities(
     pipeline_file: str,
     include_nested: bool = True,
     max_include_depth: int | None = None,
     resolve_external_includes: bool | None = None,
+    resolve_generated: bool = True,
+    generated_configs: tuple[str, ...] | list[str] | None = None,
     gitlab_url: str | None = None,
     token: str | None = None,
 ) -> tuple[dict[str, list[dict]], list[dict]]:
@@ -125,6 +146,8 @@ def load_yaml_entities(
         include_scripts=True,
         resolve_job_composition=True,
         resolve_external_includes=resolve_external_includes,
+        resolve_generated=resolve_generated,
+        generated_configs=generated_configs,
         gitlab_url=gitlab_url,
         token=token,
     )
@@ -168,6 +191,12 @@ def load_yaml_entities(
             )
             for index, rule in enumerate(pipeline_data["workflow_rules"], 1)
         ],
+        "dynamic_child_pipelines": [
+            _dynamic_child_pipeline_entity(index, record)
+            for index, record in enumerate(
+                pipeline_data.get("dynamic_child_pipelines") or [], 1
+            )
+        ],
         "project_settings": [],
         "project_ci_variables": [],
         "group_settings": [],
@@ -201,6 +230,8 @@ def _job_values(job: dict) -> dict:
         "extends_chain",
         "unresolved_script_references",
         "script_provenance",
+        "dynamic_parent_job",
+        "generated_artifact",
     ):
         if key in job:
             values[key] = job[key]
@@ -212,6 +243,8 @@ def load_merged_job_scripts(
     include_nested: bool = True,
     max_include_depth: int | None = None,
     resolve_external_includes: bool | None = None,
+    resolve_generated: bool = True,
+    generated_configs: tuple[str, ...] | list[str] | None = None,
     gitlab_url: str | None = None,
     token: str | None = None,
 ) -> list[dict]:
@@ -224,6 +257,8 @@ def load_merged_job_scripts(
         include_scripts=True,
         resolve_job_composition=True,
         resolve_external_includes=resolve_external_includes,
+        resolve_generated=resolve_generated,
+        generated_configs=generated_configs,
         gitlab_url=gitlab_url,
         token=token,
     )
@@ -242,6 +277,8 @@ def load_pipeline_entities(
     enrich_images: bool = True,
     load_api_entities: bool = True,
     resolve_external_includes: bool | None = None,
+    resolve_generated: bool = True,
+    generated_configs: tuple[str, ...] | list[str] | None = None,
     cache: "ReleaseMetadataCache | None" = None,
 ) -> dict[str, list[dict]]:
     from src.compliance.api_config import resolve_group, resolve_project, resolve_token
@@ -252,6 +289,8 @@ def load_pipeline_entities(
         include_nested=include_nested,
         max_include_depth=max_include_depth,
         resolve_external_includes=resolve_external_includes,
+        resolve_generated=resolve_generated,
+        generated_configs=generated_configs,
         gitlab_url=gitlab_url,
         token=token,
     )

{gitlab_compliance-2.6.0 → gitlab_compliance-2.7.0}/src/compliance/runner.py

@@ -427,6 +427,8 @@ def run_compliance(
     group: str | None = None,
     strict: bool = False,
     resolve_external_includes: bool | None = None,
+    resolve_generated: bool = True,
+    generated_configs: tuple[str, ...] | list[str] | None = None,
     dry_run: bool = False,
     output_format: str = "console",
     policies_source: str | None = None,
@@ -513,6 +515,8 @@ def run_compliance(
         include_nested=include_nested,
         max_include_depth=max_include_depth,
         resolve_external_includes=resolve_external_includes,
+        resolve_generated=resolve_generated,
+        generated_configs=generated_configs,
         gitlab_url=gitlab_url,
         token=resolved_token or token,
     )
@@ -615,6 +619,8 @@ def run_compliance(
                 if resolve_external_includes is True
                 else "false" if resolve_external_includes is False else "auto"
             ),
+            "resolve_generated": "true" if resolve_generated else "false",
+            "generated_configs": ",".join(generated_configs or ()),
             "release_cache": release_cache,
             "shell_check_verbose": "true" if verbose else "false",
         }

{gitlab_compliance-2.6.0 → gitlab_compliance-2.7.0}/src/gitlab_compliance.py

@@ -11,6 +11,7 @@ from datetime import datetime
 import click
 
 import src.gitlab_docs as _gitlab_docs
+import src.modules.common as common
 import src.modules.doc_controller as md_writer
 import src.properties.includes as includes
 import src.properties.inputs as inputs
@@ -93,6 +94,37 @@ def _parse_generate_filters(exclude, group_by):
     return exclude_sections, exclude_attributes, group_by
 
 
+def _render_dynamic_child_pipelines(OUTPUT_FILE, pipeline_data: dict) -> None:
+    records = pipeline_data.get("dynamic_child_pipelines") or []
+    if not records:
+        return
+    add_between_markers(
+        file_path=OUTPUT_FILE, content="\n\n## Dynamic child pipelines\n\n"
+    )
+    table = common.table_design(
+        headers=[
+            "**Trigger job**",
+            "**Generator job**",
+            "**Artifact**",
+            "**Resolved**",
+        ]
+    )
+    for record in records:
+        table.add_row(
+            [
+                record.get("trigger_job") or "—",
+                record.get("generator_job") or "—",
+                record.get("artifact") or "—",
+                "yes" if record.get("resolved") else "no",
+            ]
+        )
+    add_between_markers(
+        file_path=OUTPUT_FILE,
+        content=common.markdown_table_from_prettytable(table),
+    )
+    add_between_markers(file_path=OUTPUT_FILE, content="\n")
+
+
 def _generate_markdown(
     OUTPUT_FILE,
     GLDOCS_CONFIG_FILE,
@@ -101,6 +133,8 @@ def _generate_markdown(
     exclude_attributes=None,
     group_by=None,
     max_include_depth=None,
+    resolve_generated=True,
+    generated_configs=None,
 ):
     ENABLE_WORKFLOW_DOCUMENTATION = detailed
     exclude_sections = exclude_sections or set()
@@ -133,6 +167,7 @@ def _generate_markdown(
             DISABLE_TITLE=True,
             OUTPUT_FILE=OUTPUT_FILE,
         )
+    pipeline_data = None
     if "jobs" not in exclude_sections:
         pipeline_data = collect_pipeline_data(
             config_file=GLDOCS_CONFIG_FILE,
@@ -141,12 +176,26 @@ def _generate_markdown(
             exclude_sections=exclude_sections,
             exclude_attributes=exclude_attributes,
             group_by=group_by,
+            resolve_generated=resolve_generated,
+            generated_configs=generated_configs,
         )
         jobs.render_jobs_from_pipeline(
             OUTPUT_FILE=OUTPUT_FILE,
             pipeline_data=pipeline_data,
             detailed=detailed,
         )
+    if pipeline_data is None:
+        pipeline_data = collect_pipeline_data(
+            config_file=GLDOCS_CONFIG_FILE,
+            detailed=detailed,
+            max_include_depth=max_include_depth,
+            exclude_sections=exclude_sections,
+            exclude_attributes=exclude_attributes,
+            group_by=group_by,
+            resolve_generated=resolve_generated,
+            generated_configs=generated_configs,
+        )
+    _render_dynamic_child_pipelines(OUTPUT_FILE, pipeline_data)
 
 
 def _generate_html(
@@ -157,6 +206,8 @@ def _generate_html(
     exclude_attributes=None,
     group_by=None,
     max_include_depth=None,
+    resolve_generated=True,
+    generated_configs=None,
 ):
     pipeline_data = collect_pipeline_data(
         config_file=GLDOCS_CONFIG_FILE,
@@ -165,6 +216,8 @@ def _generate_html(
         exclude_sections=exclude_sections,
         exclude_attributes=exclude_attributes,
         group_by=group_by,
+        resolve_generated=resolve_generated,
+        generated_configs=generated_configs,
     )
     html_output = render_swagger_html(pipeline_data)
     with open(OUTPUT_FILE, "w", encoding="utf-8") as output_file:
@@ -179,6 +232,8 @@ def _generate_swagger_markdown(
     exclude_attributes=None,
     group_by=None,
     max_include_depth=None,
+    resolve_generated=True,
+    generated_configs=None,
 ):
     pipeline_data = collect_pipeline_data(
         config_file=GLDOCS_CONFIG_FILE,
@@ -187,6 +242,8 @@ def _generate_swagger_markdown(
         exclude_sections=exclude_sections,
         exclude_attributes=exclude_attributes,
         group_by=group_by,
+        resolve_generated=resolve_generated,
+        generated_configs=generated_configs,
     )
     markdown_output = render_swagger_markdown(pipeline_data)
     with open(OUTPUT_FILE, "w", encoding="utf-8") as output_file:
@@ -365,6 +422,21 @@ def get_attributes(OUTPUT_FILE, GLDOCS_CONFIG_FILE, attributes, json_format):
     default=None,
     help="Max local include nesting depth from the root file (omit for unlimited).",
 )
+@click.option(
+    "--resolve-generated/--no-resolve-generated",
+    "resolve_generated",
+    default=True,
+    help=(
+        "Load dynamically generated child pipeline YAML from trigger.include "
+        "artifact paths when the file exists on disk (default: on)."
+    ),
+)
+@click.option(
+    "--generated-config",
+    "generated_configs",
+    multiple=True,
+    help=("Extra generated CI YAML path to merge into documentation (repeatable)."),
+)
 def generate(
     detailed,
     output_format,
@@ -374,6 +446,8 @@ def generate(
     exclude,
     group_by,
     max_include_depth,
+    resolve_generated,
+    generated_configs,
 ):
     """
     Will scan through your gitlab-ci yml and build documentation from the yml.
@@ -403,6 +477,8 @@ def generate(
         exclude_attributes=exclude_attributes,
         group_by=group_by,
         max_include_depth=max_include_depth,
+        resolve_generated=resolve_generated,
+        generated_configs=generated_configs,
     )
 
     if output_format == "html":
@@ -554,6 +630,24 @@ def _resolve_policies_dir(
         "project when a token is available)."
     ),
 )
+@click.option(
+    "--resolve-generated/--no-resolve-generated",
+    "resolve_generated",
+    default=True,
+    help=(
+        "Load dynamically generated child pipeline YAML from trigger.include "
+        "artifact paths when the file exists on disk (default: on)."
+    ),
+)
+@click.option(
+    "--generated-config",
+    "generated_configs",
+    multiple=True,
+    help=(
+        "Extra generated CI YAML path to merge (repeatable). Use when the artifact "
+        "is written somewhere other than the declared trigger.include path."
+    ),
+)
 @click.option(
     "--gitlab-url",
     default=None,
@@ -690,6 +784,8 @@ def check(
     include_nested,
     max_include_depth,
     resolve_external_includes,
+    resolve_generated,
+    generated_configs,
     gitlab_url,
     token,
     project,
@@ -739,6 +835,8 @@ def check(
             include_nested=include_nested,
             max_include_depth=max_include_depth,
             resolve_external_includes=resolve_external_includes,
+            resolve_generated=resolve_generated,
+            generated_configs=generated_configs,
             gitlab_url=gitlab_url,
             token=token,
             project=project,
@@ -849,6 +947,24 @@ def check(
         "project when a token is available)."
     ),
 )
+@click.option(
+    "--resolve-generated/--no-resolve-generated",
+    "resolve_generated",
+    default=True,
+    help=(
+        "Load dynamically generated child pipeline YAML from trigger.include "
+        "artifact paths when the file exists on disk (default: on)."
+    ),
+)
+@click.option(
+    "--generated-config",
+    "generated_configs",
+    multiple=True,
+    help=(
+        "Extra generated CI YAML path to merge (repeatable). Use when the artifact "
+        "is written somewhere other than the declared trigger.include path."
+    ),
+)
 @click.option(
     "--features",
     "-f",
@@ -924,6 +1040,8 @@ def supply_chain(
     include_nested,
     max_include_depth,
     resolve_external_includes,
+    resolve_generated,
+    generated_configs,
     features_dir,
     gitlab_url,
     token,
@@ -955,6 +1073,8 @@ def supply_chain(
             include_nested=include_nested,
             max_include_depth=max_include_depth,
             resolve_external_includes=resolve_external_includes,
+            resolve_generated=resolve_generated,
+            generated_configs=generated_configs,
             gitlab_url=gitlab_url,
             token=token,
             project=project,
@@ -1050,6 +1170,24 @@ def supply_chain(
         "project when a token is available)."
     ),
 )
+@click.option(
+    "--resolve-generated/--no-resolve-generated",
+    "resolve_generated",
+    default=True,
+    help=(
+        "Load dynamically generated child pipeline YAML from trigger.include "
+        "artifact paths when the file exists on disk (default: on)."
+    ),
+)
+@click.option(
+    "--generated-config",
+    "generated_configs",
+    multiple=True,
+    help=(
+        "Extra generated CI YAML path to merge (repeatable). Use when the artifact "
+        "is written somewhere other than the declared trigger.include path."
+    ),
+)
 @click.option(
     "--gitlab-url",
     default=None,
@@ -1118,6 +1256,8 @@ def shell_check(
     include_nested,
     max_include_depth,
     resolve_external_includes,
+    resolve_generated,
+    generated_configs,
     gitlab_url,
     token,
     project,
@@ -1147,6 +1287,8 @@ def shell_check(
             include_nested=include_nested,
             max_include_depth=max_include_depth,
             resolve_external_includes=resolve_external_includes,
+            resolve_generated=resolve_generated,
+            generated_configs=generated_configs,
             gitlab_url=gitlab_url,
             token=token,
             project=project,