Update CI files

[noissue]

.ci/ansible/Containerfile.j2

@@ -9,20 +9,26 @@ ADD ./{{ item.name }} ./{{ item.name }}
 # S3 botocore needs to be patched to handle responses from minio during 0-byte uploads
 # Hacking botocore (https://github.com/boto/botocore/pull/1990)
 
-RUN pip3 install
+RUN pip3 install --upgrade pip setuptools wheel && \
+  rm -rf /root/.cache/pip && \
+  pip3 install
 {%- if s3_test | default(false) -%}
 {{ " " }}git+https://github.com/gerrod3/botocore.git@fix-100-continue
 {%- endif -%}
 {%- for item in plugins -%}
 {{ " " }}{{ item.source }}
+{%- if item.upperbounds | default(false) -%}
+{{ " " }}-c ./{{ item.name }}/upperbounds_constraints.txt
+{%- endif -%}
 {%- if item.lowerbounds | default(false) -%}
 {{ " " }}-c ./{{ item.name }}/lowerbounds_constraints.txt
 {%- endif -%}
 {%- if item.ci_requirements | default(false) -%}
 {{ " " }}-r ./{{ item.name }}/ci_requirements.txt
 {%- endif -%}
 {%- endfor %}
-{{ " " }}-c ./{{ plugins[0].name }}/.ci/assets/ci_constraints.txt
+{{ " " }}-c ./{{ plugins[0].name }}/.ci/assets/ci_constraints.txt && \
+  rm -rf /root/.cache/pip
 
 {% if pulp_env is defined and pulp_env %}
 {% for key, value in pulp_env.items() %}

.ci/scripts/calc_constraints.py

@@ -0,0 +1,118 @@
+# WARNING: DO NOT EDIT!
+#
+# This file was generated by plugin_template, and is managed by it. Please use
+# './plugin-template --github pulp_rpm' to update this file.
+#
+# For more info visit https://github.com/pulp/plugin_template
+
+import argparse
+import fileinput
+import urllib.request
+import sys
+from packaging.requirements import Requirement
+from packaging.version import Version
+import yaml
+
+
+CORE_TEMPLATE_URL = "https://raw.githubusercontent.com/pulp/pulpcore/main/template_config.yml"
+
+
+def fetch_pulpcore_upper_bound(requirement):
+    with urllib.request.urlopen(CORE_TEMPLATE_URL) as f:
+        template = yaml.safe_load(f.read())
+    supported_versions = template["supported_release_branches"]
+    supported_versions.append(template["latest_release_branch"])
+    applicable_versions = sorted(
+        requirement.specifier.filter((Version(v) for v in supported_versions))
+    )
+    if len(applicable_versions) == 0:
+        raise Exception("No supported pulpcore version in required range.")
+    return f"{requirement.name}~={applicable_versions[-1]}"
+
+
+def split_comment(line):
+    split_line = line.split("#", maxsplit=1)
+    try:
+        comment = "  # " + split_line[1].strip()
+    except IndexError:
+        comment = ""
+    return split_line[0].strip(), comment
+
+
+def to_upper_bound(req):
+    try:
+        requirement = Requirement(req)
+    except ValueError:
+        return f"# UNPARSABLE: {req}"
+    else:
+        if requirement.name == "pulpcore":
+            # An exception to allow for pulpcore deprecation policy.
+            return fetch_pulpcore_upper_bound(requirement)
+        for spec in requirement.specifier:
+            if spec.operator == "~=":
+                return f"# NO BETTER CONSTRAINT: {req}"
+            if spec.operator == "<=":
+                operator = "=="
+                max_version = spec.version
+                return f"{requirement.name}{operator}{max_version}"
+            if spec.operator == "<":
+                operator = "~="
+                version = Version(spec.version)
+                if version.micro != 0:
+                    max_version = f"{version.major}.{version.minor}.{version.micro-1}"
+                elif version.minor != 0:
+                    max_version = f"{version.major}.{version.minor-1}"
+                elif version.major != 0:
+                    max_version = f"{version.major-1}.0"
+                else:
+                    return f"# NO BETTER CONSTRAINT: {req}"
+                return f"{requirement.name}{operator}{max_version}"
+        return f"# NO UPPER BOUND: {req}"
+
+
+def to_lower_bound(req):
+    try:
+        requirement = Requirement(req)
+    except ValueError:
+        return f"# UNPARSABLE: {req}"
+    else:
+        for spec in requirement.specifier:
+            if spec.operator == ">=":
+                if requirement.name == "pulpcore":
+                    # Currently an exception to allow for pulpcore bugfix releases.
+                    # TODO Semver libraries should be allowed too.
+                    operator = "~="
+                else:
+                    operator = "=="
+                min_version = spec.version
+                return f"{requirement.name}{operator}{min_version}"
+        return f"# NO LOWER BOUND: {req}"
+
+
+def main():
+    """Calculate constraints for the lower bound of dependencies where possible."""
+    parser = argparse.ArgumentParser(
+        prog=sys.argv[0],
+        description="Calculate constraints for the lower or upper bound of dependencies where "
+        "possible.",
+    )
+    parser.add_argument("-u", "--upper", action="store_true")
+    parser.add_argument("filename", nargs="*")
+    args = parser.parse_args()
+
+    with fileinput.input(files=args.filename) as req_file:
+        for line in req_file:
+            if line.strip().startswith("#"):
+                # Shortcut comment only lines
+                print(line.strip())
+            else:
+                req, comment = split_comment(line)
+                if args.upper:
+                    new_req = to_upper_bound(req)
+                else:
+                    new_req = to_lower_bound(req)
+                print(new_req + comment)
+
+
+if __name__ == "__main__":
+    main()

.ci/scripts/validate_commit_message.py

@@ -9,21 +9,17 @@
 import sys
 from pathlib import Path
 import subprocess
-
-
 import os
 import warnings
 from github import Github
 
-
 NO_ISSUE = "[noissue]"
 CHANGELOG_EXTS = [".feature", ".bugfix", ".doc", ".removal", ".misc", ".deprecation"]
+KEYWORDS = ["fixes", "closes"]
+
 sha = sys.argv[1]
 message = subprocess.check_output(["git", "log", "--format=%B", "-n 1", sha]).decode("utf-8")
 
-
-KEYWORDS = ["fixes", "closes"]
-
 g = Github(os.environ.get("GITHUB_TOKEN"))
 repo = g.get_repo("pulp/pulp_rpm")
 

.github/template_gitref

@@ -1 +1 @@
-2021.08.26-349-gba81617
+2021.08.26-379-gece49c9

.github/workflows/ci.yml

@@ -46,6 +46,9 @@ jobs:
         run: |
           python .ci/scripts/check_requirements.py
 
+  docs:
+    uses: "./.github/workflows/docs.yml"
+
   lint:
     uses: "./.github/workflows/lint.yml"
 
@@ -84,6 +87,7 @@ jobs:
       - "check-commits"
       - "lint"
       - "test"
+      - "docs"
     if: "always()"
     steps:
       - name: "Collect needed jobs results"

.github/workflows/create-branch.yml

@@ -26,14 +26,20 @@ jobs:
           fetch-depth: 0
           path: "pulp_rpm"
 
+      - uses: "actions/checkout@v4"
+        with:
+          fetch-depth: 1
+          repository: "pulp/plugin_template"
+          path: "plugin_template"
+
       - uses: "actions/setup-python@v5"
         with:
           python-version: "3.11"
 
       - name: "Install python dependencies"
         run: |
           echo ::group::PYDEPS
-          pip install bump2version jinja2 pyyaml packaging
+          pip install bump2version packaging -r plugin_template/requirements.txt
           echo ::endgroup::
 
       - name: "Setting secrets"
@@ -71,13 +77,6 @@ jobs:
         run: |
           find CHANGES -type f -regex ".*\.\(bugfix\|doc\|feature\|misc\|deprecation\|removal\)" -exec git rm {} +
 
-      - name: Checkout plugin template
-        uses: actions/checkout@v4
-        with:
-          repository: pulp/plugin_template
-          path: plugin_template
-          fetch-depth: 0
-
       - name: Update CI branches in template_config
         working-directory: plugin_template
         run: |

.github/workflows/docs.yml

@@ -0,0 +1,54 @@
+# WARNING: DO NOT EDIT!
+#
+# This file was generated by plugin_template, and is managed by it. Please use
+# './plugin-template --github pulp_rpm' to update this file.
+#
+# For more info visit https://github.com/pulp/plugin_template
+
+---
+name: "Docs"
+on:
+  workflow_call:
+
+jobs:
+  test:
+    if: "endsWith(github.base_ref, 'main')"
+    runs-on: "ubuntu-20.04"
+    defaults:
+      run:
+        working-directory: "pulp_rpm"
+    steps:
+      - uses: "actions/checkout@v4"
+        with:
+          fetch-depth: 1
+          path: "pulp_rpm"
+      - uses: "actions/setup-python@v5"
+        with:
+          python-version: "3.11"
+      - name: "Setup cache key"
+        run: |
+          git ls-remote https://github.com/pulp/pulp-docs main | tee pulp-docs-main-sha
+      - uses: "actions/cache@v4"
+        with:
+          path: "~/.cache/pip"
+          key: ${{ runner.os }}-pip-${{ hashFiles('pulp-docs-main-sha') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+      - name: "Install python dependencies"
+        run: |
+          echo ::group::PYDEPS
+          pip install -r doc_requirements.txt
+          echo ::endgroup::
+      - name: "Build changelog"
+        run: |
+          towncrier build --yes --version 4.0.0.ci
+      - name: "Build docs"
+        run: |
+          pulp-docs build
+
+  no-test:
+    if: "!endsWith(github.base_ref, 'main')"
+    runs-on: "ubuntu-20.04"
+    steps:
+      - run: |
+          echo "Skip docs testing on non-main branches."