Update plugin template

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 1.11.0.dev
+current_version = 1.12.0.dev
 commit = False
 tag = False
 parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(\.(?P<release>[a-z]+))?

.ci/ansible/settings.py.j2

@@ -8,6 +8,7 @@ TOKEN_SIGNATURE_ALGORITHM = "ES256"
 CACHE_ENABLED = True
 REDIS_HOST = "localhost"
 REDIS_PORT = 6379
+TELEMETRY = False
 
 {% if api_root is defined %}
 API_ROOT = {{ api_root | repr }}
@@ -19,6 +20,12 @@ API_ROOT = {{ api_root | repr }}
 {% endfor %}
 {% endif %}
 
+{% if pulp_scenario_settings is defined and pulp_scenario_settings %}
+{% for key, value in pulp_scenario_settings.items() %}
+{{ key | upper }} = {{ value | repr }}
+{% endfor %}
+{% endif %}
+
 {% if stream_test | default(false) -%}
 REDIRECT_TO_OBJECT_STORAGE = False
 DEFAULT_FILE_STORAGE = "pulpcore.app.models.storage.PulpSFTPStorage"

.ci/ansible/smash-config.json

@@ -6,7 +6,7 @@
     ],
     "selinux enabled": false,
     "version": "3",
-    "aiohttp_fixtures_origin": "172.18.0.1"
+    "aiohttp_fixtures_origin": "127.0.0.1"
   },
   "hosts": [
     {
@@ -26,7 +26,7 @@
         "pulp workers": {},
         "redis": {},
         "shell": {
-          "transport": "docker"
+          "transport": "local"
         }
       }
     }

.ci/ansible/start_container.yaml

@@ -41,7 +41,7 @@
         image: "{{ item.image }}"
         auto_remove: true
         recreate: true
-        privileged: false
+        privileged: true
         networks:
           - name: pulp_ci_bridge
             aliases: "{{ item.name }}"

.ci/scripts/tweet.py

@@ -0,0 +1,16 @@
+import os
+import sys
+from tweepy import Client
+
+release_version = sys.argv[1]
+if release_version.endswith(".0"):
+    client = Client(
+        consumer_key=os.getenv("TWITTER_API_KEY"),
+        consumer_secret=os.getenv("TWITTER_API_KEY_SECRET"),
+        access_token=os.getenv("TWITTER_ACCESS_TOKEN"),
+        access_token_secret=os.getenv("TWITTER_ACCESS_TOKEN_SECRET"),
+    )
+    link = "https://docs.pulpproject.org/pulp_file/changes.html"
+    msg = f"pulp_file-{release_version} - Check out for more details: {link}"
+    release_msg = f"Hey! We've just released {msg}"
+    client.create_tweet(text=release_msg)

.ci/scripts/update_ci_branches.py

@@ -1,34 +1,25 @@
+# WARNING: DO NOT EDIT!
+#
+# This file was generated by plugin_template, and is managed by it. Please use
+# './plugin-template --github pulp_file' to update this file.
+#
+# For more info visit https://github.com/pulp/plugin_template
+
 import os
-import re
 import sys
 import requests
-from packaging.version import Version
-from git import Repo
-
-try:
-    initial_branch = sys.argv[1]
-except IndexError:
-    initial_branch = None
 
-repo = Repo(os.getcwd())
-heads = repo.git.ls_remote("--heads", "https://github.com/pulp/pulp_file.git").split("\n")
-branches = [h.split("/")[-1] for h in heads if re.search(r"^([0-9]+)\.([0-9]+)$", h.split("/")[-1])]
-branches.sort(key=lambda ver: Version(ver))
+branches = sys.argv[1:]
 
 headers = {
     "Authorization": f"Bearer {os.environ['GITHUB_TOKEN']}",
     "Accept": "application/vnd.github.v3+json",
 }
 
-if not initial_branch or initial_branch not in branches:
-    exit("Initial branch not found")
-else:
-    starting = branches.index(initial_branch)
-
 github_api = "https://api.github.com"
 workflow_path = "/actions/workflows/update_ci.yml/dispatches"
 url = f"{github_api}/repos/pulp/pulp_file{workflow_path}"
 
-for branch in branches[starting:]:
+for branch in branches:
     print(f"Updating {branch}")
     requests.post(url, headers=headers, json={"ref": branch})

.ci/scripts/upper_bound.py

@@ -1,13 +1,23 @@
+import warnings
 from pkg_resources import Requirement
 
 packages = []
-with open("requirements.txt", "r") as fd:
-    for line in fd.readlines():
-        if not line.startswith("#"):
-            req = Requirement.parse(line)
-            spec = str(req.specs)
-            if len(req.specs) < 2 and "~=" not in spec and "==" not in spec and "<" not in spec:
-                packages.append(req.name)
+
+try:
+    with open("requirements.txt", "r") as fd:
+        for line in fd.readlines():
+            if not line.startswith("#"):
+                req = Requirement.parse(line)
+                spec = str(req.specs)
+                if "~=" in spec:
+                    warnings.warn(f"Please avoid using ~= on {req.name}")
+                    continue
+                if len(req.specs) < 2 and "==" not in spec and "<" not in spec:
+                    packages.append(req.name)
+except FileNotFoundError:
+    # skip this test for plugins that don't use a requirements.txt
+    pass
+
 if packages:
     raise RuntimeError(
         "The following packages are missing upper bound: {}".format(", ".join(packages))

.ci/scripts/validate_commit_message.py

@@ -6,24 +6,24 @@
 # For more info visit https://github.com/pulp/plugin_template
 
 import re
-import subprocess
 import sys
-import warnings
 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"]
+sha = sys.argv[1]
+message = subprocess.check_output(["git", "log", "--format=%B", "-n 1", sha]).decode("utf-8")
 
 
 KEYWORDS = ["fixes", "closes"]
 
-sha = sys.argv[1]
-message = subprocess.check_output(["git", "log", "--format=%B", "-n 1", sha]).decode("utf-8")
 g = Github(os.environ.get("GITHUB_TOKEN"))
 repo = g.get_repo("pulp/pulp_file")
 

flake8.cfg → .flake8

@@ -1,19 +1,31 @@
+# WARNING: DO NOT EDIT!
+#
+# This file was generated by plugin_template, and is managed by it. Please use
+# './plugin-template --github pulp_file' to update this file.
+#
+# For more info visit https://github.com/pulp/plugin_template
 [flake8]
-exclude = ./docs/*,*/migrations/*,*/tests/*
-ignore = W503,Q000,Q003,D100,D104,D106,D200,D205,D400,D401,D402,D202
+exclude = ./docs/*,*/migrations/*
+ignore = E203,W503,Q000,Q003,D100,D104,D106,D200,D205,D400,D401,D402
 max-line-length = 100
 
+# Flake8 builtin codes
+# --------------------
+# E203: no whitespace around ':'. disabled until https://github.com/PyCQA/pycodestyle/issues/373 is fixed
+# W503: This enforces operators before line breaks which is not pep8 or black compatible.
+
 # Flake8-quotes extension codes
 # -----------------------------
-# W503: This enforces operators before line breaks which is not pep8 or black compatible.
 # Q000: double or single quotes only, default is double (don't want to enforce this)
+# Q003: Change outer quotes to avoid escaping inner quotes
 
 # Flake8-docstring extension codes
 # --------------------------------
 # D100: missing docstring in public module
 # D104: missing docstring in public package
 # D106: missing docstring in public nested class (complains about "class Meta:" and documenting those is silly)
 # D200: one-line docstring should fit on one line with quotes
-# D202: no blank line after docstring--disabled until https://github.com/PyCQA/pydocstyle/issues/361 is fixed
+# D205: 1 blank line required between summary line and description
+# D400: First line should end with a period
 # D401: first line should be imperative (nitpicky)
 # D402: first line should not be the function’s “signature” (false positives)

.github/stale.yml

@@ -0,0 +1,59 @@
+# WARNING: DO NOT EDIT!
+#
+# This file was generated by plugin_template, and is managed by it. Please use
+# './plugin-template --github pulp_file' to update this file.
+#
+# For more info visit https://github.com/pulp/plugin_template
+# Configuration for probot-stale - https://github.com/probot/stale
+
+# Number of days of inactivity before an Issue or Pull Request becomes stale
+daysUntilStale: 90
+
+# Number of days of inactivity before an Issue or Pull Request with the stale label is closed.
+# Set to false to disable. If disabled, issues still need to be closed manually, but will remain marked as stale.
+daysUntilClose: 30
+
+# Only issues or pull requests with all of these labels are check if stale. Defaults to `[]` (disabled)
+onlyLabels: []
+
+# Issues or Pull Requests with these labels will never be considered stale. Set to `[]` to disable
+exemptLabels:
+  - security
+  - planned
+
+# Set to true to ignore issues in a project (defaults to false)
+exemptProjects: false
+
+# Set to true to ignore issues in a milestone (defaults to false)
+exemptMilestones: false
+
+# Set to true to ignore issues with an assignee (defaults to false)
+exemptAssignees: false
+
+# Label to use when marking as stale
+staleLabel: stale
+
+# Limit the number of actions per hour, from 1-30. Default is 30
+limitPerRun: 30
+# Limit to only `issues` or `pulls`
+only: pulls
+
+pulls:
+  markComment: |-
+    This pull request has been marked 'stale' due to lack of recent activity. If there is no further activity, the PR will be closed in another 30 days. Thank you for your contribution!
+
+  unmarkComment: >-
+    This pull request is no longer marked for closure.
+
+  closeComment: >-
+    This pull request has been closed due to inactivity. If you feel this is in error, please reopen the pull request or file a new PR with the relevant details.
+
+issues:
+  markComment: |-
+    This issue has been marked 'stale' due to lack of recent activity. If there is no further activity, the issue will be closed in another 30 days. Thank you for your contribution!
+
+  unmarkComment: >-
+    This issue is no longer marked for closure.
+
+  closeComment: >-
+    This issue has been closed due to inactivity. If you feel this is in error, please reopen the issue or file a new issue with the relevant details.

.github/template_gitref

@@ -1 +1 @@
-2021.08.26-130-ge87b661
+2021.08.26-174-g23ccb65