cici-tools 0.18.3__tar.gz → 0.19.1__tar.gz

{cici_tools-0.18.3 → cici_tools-0.19.1}/.gitlab-ci.yml

@@ -33,11 +33,11 @@ include:
     file:
       - mkdocs-build.yml
   - project: saferatday0/library/pages
-    ref: 0.5.0
+    ref: 0.6.0
     file:
       - pages.yml
   - project: saferatday0/library/prettier
-    ref: 0.7.1
+    ref: 0.8.0
     file:
       - prettier.yml
   - project: saferatday0/library/python

{cici_tools-0.18.3 → cici_tools-0.19.1}/.pre-commit-config.yaml

@@ -30,18 +30,18 @@ repos:
           ]
 
   - repo: https://gitlab.com/saferatday0/library/container
-    rev: "0.8.1"
+    rev: "0.9.2"
     hooks:
       - id: container-hadolint
 
   - repo: https://gitlab.com/saferatday0/library/prettier
-    rev: "0.7.1"
+    rev: "0.8.0"
     hooks:
       - id: prettier
         exclude: "^\\.gitlab-ci\\.yml$"
 
   - repo: https://gitlab.com/saferatday0/badgie
-    rev: "0.14.2"
+    rev: "0.14.4"
     hooks:
       - id: badgie
 

{cici_tools-0.18.3 → cici_tools-0.19.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cici-tools
-Version: 0.18.3
+Version: 0.19.1
 Summary: Continuous Integration Catalog Interface
 Author-email: Digital Safety Research Institute <contact@dsri.org>
 License: Apache-2.0

{cici_tools-0.18.3 → cici_tools-0.19.1}/cici/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '0.18.3'
-__version_tuple__ = version_tuple = (0, 18, 3)
+__version__ = version = '0.19.1'
+__version_tuple__ = version_tuple = (0, 19, 1)
 
-__commit_id__ = commit_id = 'g5f54b28ca'
+__commit_id__ = commit_id = 'ga17385576'

{cici_tools-0.18.3 → cici_tools-0.19.1}/cici/providers/gitlab/models.py

@@ -85,7 +85,7 @@ class IDToken(msgspec.Struct, omit_defaults=True, frozen=True, kw_only=True):
     aud: Union[str, list[str]] = field(default_factory=list)
 
 
-class Image(msgspec.Struct, omit_defaults=True, frozen=True, kw_only=True, tag="image"):
+class Image(msgspec.Struct, omit_defaults=True, frozen=True, kw_only=True, tag=False):
     name: str
     entrypoint: Union[str, list[str]] = field(default_factory=list)
     pull_policy: Union[str, list[str]] = field(default_factory=list)
@@ -153,6 +153,12 @@ class Service(msgspec.Struct, omit_defaults=True, frozen=True, kw_only=True):
     pull_policy: Union[str, list[str]] = field(default_factory=list)
 
 
+class Pages(msgspec.Struct, omit_defaults=True, frozen=True, kw_only=True):
+    publish: Optional[str] = None
+    expire_in: Optional[str] = None
+    path_prefix: Optional[str] = None
+
+
 class Job(
     msgspec.Struct,
     omit_defaults=True,
@@ -178,6 +184,7 @@ class Job(
     id_tokens: Dict[str, IDToken] = field(default_factory=dict)
     interruptible: bool = False
     needs: Optional[list[str]] = None
+    pages: Optional[Union[bool, Pages]] = None
     retry: Union[int, Retry] = 0
     resource_group: str = ""
     rules: List[Rule] = field(default_factory=list)

{cici_tools-0.18.3 → cici_tools-0.19.1}/cici_tools.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cici-tools
-Version: 0.18.3
+Version: 0.19.1
 Summary: Continuous Integration Catalog Interface
 Author-email: Digital Safety Research Institute <contact@dsri.org>
 License: Apache-2.0

{cici_tools-0.18.3 → cici_tools-0.19.1}/cici_tools.egg-info/SOURCES.txt

@@ -92,6 +92,9 @@ tests/fixtures/gitlab/helm/helm-cm-push.yml
 tests/fixtures/gitlab/helm/helm-docs.yml
 tests/fixtures/gitlab/helm/helm-lint.yml
 tests/fixtures/gitlab/helm/.cici/.gitlab-ci.yml
+tests/fixtures/gitlab/image/image-check.yml
+tests/fixtures/gitlab/image/.cici/.gitlab-ci.yml
+tests/fixtures/gitlab/image/.cici/config.yaml
 tests/fixtures/gitlab/job-variables/opentofu-development-apply.yml
 tests/fixtures/gitlab/job-variables/opentofu-development-auto-apply.yml
 tests/fixtures/gitlab/job-variables/opentofu-development-destroy.yml
@@ -117,6 +120,14 @@ tests/fixtures/gitlab/job-variables/opentofu-trivy.yml
 tests/fixtures/gitlab/job-variables/opentofu-validate.yml
 tests/fixtures/gitlab/job-variables/.cici/.gitlab-ci.yml
 tests/fixtures/gitlab/job-variables/.cici/config.yaml
+tests/fixtures/gitlab/keyword-pages/no-pages.yml
+tests/fixtures/gitlab/keyword-pages/pages-all.yml
+tests/fixtures/gitlab/keyword-pages/pages-expire-in.yml
+tests/fixtures/gitlab/keyword-pages/pages-expires-in.yml
+tests/fixtures/gitlab/keyword-pages/pages-path-prefix.yml
+tests/fixtures/gitlab/keyword-pages/pages-publish.yml
+tests/fixtures/gitlab/keyword-pages/pages.yml
+tests/fixtures/gitlab/keyword-pages/.cici/.gitlab-ci.yml
 tests/fixtures/gitlab/library-validator/README.md
 tests/fixtures/gitlab/library-validator/.cici/README.md.j2
 tests/fixtures/gitlab/library-validator/.cici/config.yaml

cici_tools-0.19.1/tests/fixtures/gitlab/image/.cici/.gitlab-ci.yml

@@ -0,0 +1,27 @@
+# SPDX-FileCopyrightText: UL Research Institutes
+# SPDX-License-Identifier: Apache-2.0
+
+stages:
+  - test
+  - build
+  - deploy
+
+workflow:
+  rules:
+    - if: $CI_PIPELINE_SOURCE == "push" && $CI_OPEN_MERGE_REQUESTS
+      when: never
+    - when: always
+
+image-check:
+  stage: test
+  image:
+    name: "${CONTAINER_PROXY}apache/skywalking-eyes"
+    entrypoint: ["/bin/sh", "-ce"]
+  cache: {}
+  dependencies: []
+  variables:
+    GIT_DEPTH: "1"
+    GIT_SUBMODULE_STRATEGY: "none"
+  script:
+    - license-eye header check
+  needs: []

cici_tools-0.19.1/tests/fixtures/gitlab/image/.cici/config.yaml

@@ -0,0 +1,14 @@
+# SPDX-FileCopyrightText: UL Research Institutes
+# SPDX-License-Identifier: Apache-2.0
+
+name: image-check
+
+brief: >-
+  Check image keyword.
+
+targets:
+  - name: image-check
+    brief: >-
+      check image keyword works
+    groups:
+      - format

cici_tools-0.19.1/tests/fixtures/gitlab/image/image-check.yml

@@ -0,0 +1,31 @@
+#
+# This file is generated by cici-tools with the following command:
+#
+#     cici bundle
+#
+stages:
+  - test
+  - build
+  - deploy
+
+workflow:
+  rules:
+    - if: $CI_PIPELINE_SOURCE == "push" && $CI_OPEN_MERGE_REQUESTS
+      when: never
+    - when: always
+
+image-check:
+  stage: test
+  image:
+    name: ${CONTAINER_PROXY}apache/skywalking-eyes
+    entrypoint:
+      - "/bin/sh"
+      - "-ce"
+  variables:
+    GIT_DEPTH: "1"
+    GIT_SUBMODULE_STRATEGY: none
+  script:
+    - license-eye header check
+  cache: {}
+  dependencies: []
+  needs: []

cici_tools-0.19.1/tests/fixtures/gitlab/keyword-pages/.cici/.gitlab-ci.yml

@@ -0,0 +1,52 @@
+# SPDX-FileCopyrightText: UL Research Institutes
+# SPDX-License-Identifier: Apache-2.0
+
+# check pages keywords are rendered correctly
+
+
+no-pages:
+  stage: test
+  image: whatever
+  script:
+    - pass
+
+pages:
+  stage: test
+  image: whatever
+  pages: false
+  script:
+    - pass
+
+pages-publish:
+  stage: test
+  image: whatever
+  pages:
+    publish: public
+  script:
+    - pass
+
+pages-path_prefix:
+  stage: test
+  image: whatever
+  pages:
+    path_prefix: mr-$CI_COMMIT_REF_SLUG
+  script:
+    - pass
+
+pages-expire_in:
+  stage: test
+  image: whatever
+  pages:
+    expire_in: 1 day
+  script:
+    - pass
+
+pages-all:
+  stage: test
+  image: whatever
+  pages:
+    publish: public
+    path_prefix: preview-$CI_COMMIT_REF_SLUG
+    expire_in: 1 hour
+  script:
+    - pass

cici_tools-0.19.1/tests/fixtures/gitlab/keyword-pages/no-pages.yml

@@ -0,0 +1,10 @@
+#
+# This file is generated by cici-tools with the following command:
+#
+#     cici bundle
+#
+no-pages:
+  stage: test
+  image: whatever
+  script:
+    - pass

cici_tools-0.19.1/tests/fixtures/gitlab/keyword-pages/pages-all.yml

@@ -0,0 +1,14 @@
+#
+# This file is generated by cici-tools with the following command:
+#
+#     cici bundle
+#
+pages-all:
+  stage: test
+  image: whatever
+  script:
+    - pass
+  pages:
+    publish: public
+    expire_in: 1 hour
+    path_prefix: "preview-$CI_COMMIT_REF_SLUG"

cici_tools-0.19.1/tests/fixtures/gitlab/keyword-pages/pages-expire-in.yml

@@ -0,0 +1,12 @@
+#
+# This file is generated by cici-tools with the following command:
+#
+#     cici bundle
+#
+pages-expire_in:
+  stage: test
+  image: whatever
+  script:
+    - pass
+  pages:
+    expire_in: 1 day

cici_tools-0.19.1/tests/fixtures/gitlab/keyword-pages/pages-expires-in.yml

@@ -0,0 +1,11 @@
+#
+# This file is generated by cici-tools with the following command:
+#
+#     cici bundle
+#
+pages-expires_in:
+  stage: test
+  image: whatever
+  script:
+    - pass
+  pages: {}

cici_tools-0.19.1/tests/fixtures/gitlab/keyword-pages/pages-path-prefix.yml

@@ -0,0 +1,12 @@
+#
+# This file is generated by cici-tools with the following command:
+#
+#     cici bundle
+#
+pages-path_prefix:
+  stage: test
+  image: whatever
+  script:
+    - pass
+  pages:
+    path_prefix: "mr-$CI_COMMIT_REF_SLUG"

cici_tools-0.19.1/tests/fixtures/gitlab/keyword-pages/pages-publish.yml

@@ -0,0 +1,12 @@
+#
+# This file is generated by cici-tools with the following command:
+#
+#     cici bundle
+#
+pages-publish:
+  stage: test
+  image: whatever
+  script:
+    - pass
+  pages:
+    publish: public

cici_tools-0.19.1/tests/fixtures/gitlab/keyword-pages/pages.yml

@@ -0,0 +1,11 @@
+#
+# This file is generated by cici-tools with the following command:
+#
+#     cici bundle
+#
+pages:
+  stage: test
+  image: whatever
+  script:
+    - pass
+  pages: false

{cici_tools-0.18.3 → cici_tools-0.19.1}/tests/test_cli.py

@@ -53,6 +53,10 @@ def pushd(path):
             "gitlab",
             "job-variables",
         ),
+        (
+            "gitlab",
+            "image",
+        ),
     ],
 )
 def test_end_to_end_bundle(platform, name, tmp_path):
@@ -70,7 +74,6 @@ def test_end_to_end_bundle(platform, name, tmp_path):
     for file in files:
         shutil.copyfile(fixture_dir / file, test_dir / file)
     with pushd(test_dir):
-        print([path.name for path in Path.cwd().glob("*")])
         cici(["bundle"])
 
     for file in files:

{cici_tools-0.18.3 → cici_tools-0.19.1}/tests/test_resolve_targets.py

@@ -45,13 +45,11 @@ def strip_proxy(image: Optional[str]) -> Optional[str]:
                 container:
                   image: busybox
             """,
-            {
-                "gamma.yaml": """
+            {"gamma.yaml": """
                 name: gamma
                 container:
                   image: alpine:latest
-                """
-            },
+                """},
             ["theta", "delta", "gamma"],
             ["old:version", "busybox", "alpine:latest"],
         ),

{cici_tools-0.18.3 → cici_tools-0.19.1}/tests/test_yaml_style.py

@@ -7,7 +7,7 @@ import pytest
 import ruamel.yaml
 from ruamel.yaml.scalarstring import FoldedScalarString
 
-from cici.providers.gitlab.yaml_style import make_scalar_string
+from cici.providers.gitlab.yaml_style import make_scalar_string, style_scalars
 
 
 # test the folding when handling string literals
@@ -145,3 +145,98 @@ def test_folded_scalar_does_not_insert_blank_lines(command):
     # 5. The command must still appear intact
     for part in command.split():
         assert part in output
+
+
+def get_path(obj, path: str):
+    """Traverse dict/list using dotted paths and [index] access.
+
+    Examples:
+      - "job.image"
+      - "job.rules[0].if"
+      - "job.script[1]"
+      - "job.variables.GIT_DEPTH"
+    """
+    cur = obj
+    for part in path.split("."):
+        if "[" in part:
+            # e.g. rules[0]
+            key, rest = part.split("[", 1)
+            idx = int(rest.rstrip("]"))
+            cur = cur[key][idx]
+        else:
+            cur = cur[part]
+    return cur
+
+
+@pytest.mark.parametrize(
+    "input_data, expected_paths",
+    [
+        pytest.param(
+            {
+                "job": {
+                    "image": "alpine:3.19",
+                    "variables": {
+                        "GIT_DEPTH": {"value": "1"},
+                        "TOKEN": {"value": "$TOKEN"},
+                        "PATHS": {"value": "/certs"},
+                    },
+                    "script": [
+                        'echo "token" | docker login registry -u user --password-stdin',
+                        "FOO=bar",
+                        "echo ok",
+                    ],
+                    "rules": [{"if": '$CI_COMMIT_BRANCH == "main"', "when": "always"}],
+                    "environment": {"name": "$STATE/apply", "action": "stop"},
+                }
+            },
+            {
+                "job.image": "alpine:3.19",
+                "job.variables.GIT_DEPTH": "1",
+                "job.variables.TOKEN": "$TOKEN",
+                "job.variables.PATHS": "/certs",
+                "job.script[1]": "FOO=bar",
+                "job.rules[0].if": '$CI_COMMIT_BRANCH == "main"',
+                "job.environment.name": "$STATE/apply",
+                "job.environment.action": "stop",
+            },
+            id="generic-job-case",
+        ),
+        pytest.param(
+            {
+                "job": {
+                    "image": "alpine",
+                    "script": ["echo hello"],
+                }
+            },
+            {
+                "job.image": "alpine",
+                "job.script[0]": "echo hello",
+            },
+            id="minimal-generic-case",
+        ),
+    ],
+)
+def test_style_scalars(input_data, expected_paths):
+
+    # send input_data through style_scalars() function
+    styled = style_scalars(input_data)
+
+    # send the now styled input_data through the dump() function
+    y = ruamel.yaml.YAML()
+    y.width = 120
+    y.indent(mapping=2, sequence=4, offset=2)
+
+    buf = io.StringIO()
+    y.dump(styled, buf)
+    emitted = buf.getvalue()
+
+    # parse back the dumped output like GitLab would
+    parsed = ruamel.yaml.YAML(typ="safe").load(emitted)
+
+    # read the nested values and compare to expected
+    for path, expected in expected_paths.items():
+        assert get_path(parsed, path) == expected, f"path {path!r} mismatched"
+
+    # just make sure no blank lines in any folded blocks
+    # I already test for this in test_folded_scalar_does_not_insert_blank_lines()
+    assert "\n\n" not in emitted