autopkg-wrapper 0.2.0__tar.gz → 2024.2.2__tar.gz

autopkg_wrapper-2024.2.2/PKG-INFO

@@ -0,0 +1,57 @@
+Metadata-Version: 2.1
+Name: autopkg-wrapper
+Version: 2024.2.2
+Summary: A package used to execute some autopkg functions, primarily within the context of a GitHub Actions runner
+Home-page: https://github.com/smithjw/autopkg-wrapper
+License: BSD-3-Clause
+Author: James Smith
+Author-email: james@smithjw.me
+Requires-Python: >=3.12,<4.0
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: chardet (==5.2.0)
+Requires-Dist: idna (==3.6)
+Requires-Dist: pygithub (==2.2.0)
+Requires-Dist: requests (==2.31.0)
+Requires-Dist: ruamel-yaml (==0.18.5)
+Requires-Dist: toml (==0.10.2)
+Requires-Dist: urllib3 (==2.2.0)
+Project-URL: Repository, https://github.com/smithjw/autopkg-wrapper
+Description-Content-Type: text/markdown
+
+# autopkg-wrapper
+
+`autopkg_wrapper` is a small package that can be used to run [`autopkg`](https://github.com/autopkg/autopkg) within CI/CD environments such as GitHub Actions.
+
+The easiest way to run it is by installing with pip.
+
+```shell
+pip install autopkg-wrapper
+```
+
+## Command Line Parameters
+
+```shell
+-h, --help                      Show this help message and exit
+--recipe-file RECIPE_FILE       Path to a list of recipes to run (cannot be run with --recipes)
+--recipes [RECIPES ...]         Recipes to run with autopkg (cannot be run with --recipe-file)
+--debug                         Enable debug logging when running script
+--override-trust                If set recipe override trust verification will be disabled. (Default: True)
+--github-token GITHUB_TOKEN     A token used to publish a PR to your GitHub repo if overrides require their trust to be updated
+--branch-name BRANCH_NAME       Branch name to be used where recipe overrides have failed their trust verification and need to be updated.
+                                By default, this will be in the format of "fix/update_trust_information/YYYY-MM-DDTHH-MM-SS"
+--create-pr                     If enabled, autopkg_wrapper will open a PR for updated trust information
+--autopkg-overrides-repo-path AUTOPKG_OVERRIDES_REPO_PATH
+                                The path on disk to the git repository containing the autopkg overrides directory. If none is provided, we will try to determine it for you.
+```
+
+## Example
+
+An example folder structure and GitHub Actions Workflow is available within the [`actions-demo`](actions-demo)
+
+## Credits
+
+- [`autopkg_tools` from Facebook](https://github.com/facebook/IT-CPE/tree/main/legacy/autopkg_tools)
+- [`autopkg_tools` from Facebook, modified by Gusto](https://github.com/Gusto/it-cpe-opensource/tree/main/autopkg)
+

autopkg_wrapper-2024.2.2/README.md

@@ -0,0 +1,34 @@
+# autopkg-wrapper
+
+`autopkg_wrapper` is a small package that can be used to run [`autopkg`](https://github.com/autopkg/autopkg) within CI/CD environments such as GitHub Actions.
+
+The easiest way to run it is by installing with pip.
+
+```shell
+pip install autopkg-wrapper
+```
+
+## Command Line Parameters
+
+```shell
+-h, --help                      Show this help message and exit
+--recipe-file RECIPE_FILE       Path to a list of recipes to run (cannot be run with --recipes)
+--recipes [RECIPES ...]         Recipes to run with autopkg (cannot be run with --recipe-file)
+--debug                         Enable debug logging when running script
+--override-trust                If set recipe override trust verification will be disabled. (Default: True)
+--github-token GITHUB_TOKEN     A token used to publish a PR to your GitHub repo if overrides require their trust to be updated
+--branch-name BRANCH_NAME       Branch name to be used where recipe overrides have failed their trust verification and need to be updated.
+                                By default, this will be in the format of "fix/update_trust_information/YYYY-MM-DDTHH-MM-SS"
+--create-pr                     If enabled, autopkg_wrapper will open a PR for updated trust information
+--autopkg-overrides-repo-path AUTOPKG_OVERRIDES_REPO_PATH
+                                The path on disk to the git repository containing the autopkg overrides directory. If none is provided, we will try to determine it for you.
+```
+
+## Example
+
+An example folder structure and GitHub Actions Workflow is available within the [`actions-demo`](actions-demo)
+
+## Credits
+
+- [`autopkg_tools` from Facebook](https://github.com/facebook/IT-CPE/tree/main/legacy/autopkg_tools)
+- [`autopkg_tools` from Facebook, modified by Gusto](https://github.com/Gusto/it-cpe-opensource/tree/main/autopkg)

autopkg_wrapper-2024.2.2/autopkg_wrapper/__init__.py

@@ -0,0 +1 @@
+__version__ = "2024.2.2"

{autopkg_wrapper-0.2.0 → autopkg_wrapper-2024.2.2}/autopkg_wrapper/autopkg_wrapper.py

@@ -1,6 +1,5 @@
 #!/usr/bin/env python3
 import logging
-import os
 import plistlib
 import subprocess
 import sys
@@ -13,8 +12,8 @@ from autopkg_wrapper.utils.logging import setup_logger
 
 
 class Recipe(object):
-    def __init__(self, path):
-        self.filename = path
+    def __init__(self, name):
+        self.filename = name
         self.error = False
         self.results = {}
         self.updated = False
@@ -81,10 +80,8 @@ class Recipe(object):
             self.results["failed"] = True
             self.results["imported"] = ""
         else:
-            report = "/tmp/autopkg.plist"
-            if not os.path.isfile(report):
-                # Letting autopkg create them has led to errors on github runners
-                Path(report).touch()
+            report = Path("/tmp/autopkg.plist")
+            report.touch(exist_ok=True)
 
             try:
                 cmd = [
@@ -95,7 +92,7 @@ class Recipe(object):
                     "--post",
                     "io.github.hjuutilainen.VirusTotalAnalyzer/VirusTotalAnalyzer",
                     "--report-plist",
-                    report,
+                    str(report),
                 ]
                 cmd = " ".join(cmd)
                 logging.debug(f"cmd: {str(cmd)}")
@@ -114,8 +111,8 @@ class Recipe(object):
 
 
 def get_override_repo_info(args):
-    if args.autopkg_overrides_repo:
-        override_repo_path = args.autopkg_overrides_repo
+    if args.autopkg_overrides_repo_path:
+        recipe_override_dirs = args.autopkg_overrides_repo_path
 
     else:
         logging.debug("Trying to determine overrides dir from default paths")
@@ -127,10 +124,12 @@ def get_override_repo_info(args):
 
         recipe_override_dirs = Path(autopkg_prefs["RECIPE_OVERRIDE_DIRS"]).resolve()
 
-        if Path(recipe_override_dirs / ".git").is_dir():
-            override_repo_path = recipe_override_dirs
-        elif Path(recipe_override_dirs.parent / ".git").is_dir():
-            override_repo_path = recipe_override_dirs.parent
+    if Path(recipe_override_dirs / ".git").is_dir():
+        override_repo_path = recipe_override_dirs
+    elif Path(recipe_override_dirs.parent / ".git").is_dir():
+        override_repo_path = recipe_override_dirs.parent
+
+    logging.debug(f"Override Repo Path: {override_repo_path}")
 
     override_repo_git_work_tree = f"--work-tree={override_repo_path}"
     override_repo_git_git_dir = f"--git-dir={override_repo_path / ".git"}"
@@ -171,10 +170,8 @@ def parse_recipe_list(recipes, recipe_file):
     """Parsing list of recipes into a common format"""
     recipe_list = None
 
-    if recipes:
-        logging.debug(f"Recipes: {recipes}")
-    if recipe_file:
-        logging.debug(f"Recipe List: {recipe_file}")
+    logging.debug(f"Recipes: {recipes}") if recipes else None
+    logging.debug(f"Recipe List: {recipe_file}") if recipe_file else None
 
     if isinstance(recipes, list):
         recipe_list = recipes
@@ -226,12 +223,10 @@ def main():
         logging.debug(f"Processing {recipe.name}")
         process_recipe(recipe=recipe, override_trust=args.override_trust)
         update_recipe_repo(git_info=override_repo_info, recipe=recipe)
+        slack.send_notification(recipe=recipe, token=args.slack_token) if args.slack_token else None
 
     recipe.pr_url = git.create_pull_request(git_info=override_repo_info, recipe=recipe) if args.create_pr else None
 
-    # Send Slack Notification if Slack token is present
-    slack.send_notification(recipe=recipe, token=args.slack_token) if args.slack_token else None
-
 
 if __name__ == "__main__":
     main()

autopkg_wrapper-2024.2.2/autopkg_wrapper/notifier/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.0.0"

autopkg_wrapper-2024.2.2/autopkg_wrapper/utils/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.0.0"

{autopkg_wrapper-0.2.0 → autopkg_wrapper-2024.2.2}/autopkg_wrapper/utils/args.py

@@ -4,24 +4,24 @@ from datetime import datetime
 from pathlib import Path
 
 
-def validate_file(file_path):
-    p = Path(file_path)
-    file_exists = p.exists()
+def validate_file(arg):
+    file_path = Path(arg).resolve()
+    file_exists = file_path.exists()
 
     if file_exists:
-        return file_exists
+        return file_path
     else:
-        message = f"Error! This is not valid file: {file_path}"
+        message = f"Error! This is not valid file: {arg}"
         raise argparse.ArgumentTypeError(message)
 
-def validate_directory(directory_path):
-    p = Path(directory_path)
-    directory_exists = p.is_dir()
+def validate_directory(arg):
+    dir_path = Path(arg).resolve()
+    dir_exists = dir_path.is_dir()
 
-    if directory_exists:
-        return directory_exists
+    if dir_exists:
+        return dir_path
     else:
-        message = f"Error! This is not valid directory: {directory_path}"
+        message = f"Error! This is not valid directory: {arg}"
         raise argparse.ArgumentTypeError(message)
 
 
@@ -52,7 +52,7 @@ def setup_args():
         action="store_false",
         help="If set recipe override trust verification will be disabled. (Default: True)",
     )
-    parser.add_argument("--slack-token", default=os.getenv("SLACK_WEBHOOK_TOKEN", None))
+    parser.add_argument("--slack-token", default=os.getenv("SLACK_WEBHOOK_TOKEN", None), help=argparse.SUPPRESS)
     parser.add_argument("--github-token", default=os.getenv("GITHUB_TOKEN", None))
     parser.add_argument(
         "--branch-name",
@@ -69,8 +69,8 @@ def setup_args():
         help="If enabled, autopkg_wrapper will open a PR for updated trust information",
     )
     parser.add_argument(
-        "--autopkg-overrides-repo",
-        default=os.getenv("AUTOPKG_OVERRIDES_REPO", None),
+        "--autopkg-overrides-repo-path",
+        default=os.getenv("AUTOPKG_OVERRIDES_REPO_PATH", None),
         type=validate_directory,
         help="""
         The path on disk to the git repository containing the autopkg overrides directory.

{autopkg_wrapper-0.2.0 → autopkg_wrapper-2024.2.2}/pyproject.toml

@@ -5,21 +5,22 @@
     name = "autopkg-wrapper"
     readme = "README.md"
     repository = "https://github.com/smithjw/autopkg-wrapper"
-    version = "0.2.0"
+    version = "2024.2.2"
 
     [tool.poetry.scripts]
         # When built and installed by pip, the command autopkg_wrapper will be availble in to run within that environment
+        autopkg-wrapper = "autopkg_wrapper.autopkg_wrapper:main"
         autopkg_wrapper = "autopkg_wrapper.autopkg_wrapper:main"
 
     [tool.poetry.dependencies]
         chardet = "5.2.0"
         idna = "3.6"
-        pygithub = "2.1.1"
+        pygithub = "2.2.0"
         python = "^3.12"
         requests = "2.31.0"
         ruamel-yaml = "0.18.5"
         toml = "0.10.2"
-        urllib3 = "2.1.0"
+        urllib3 = "2.2.0"
 
     [tool.poetry_bumpversion.file."autopkg_wrapper/__init__.py"]
 

autopkg_wrapper-0.2.0/PKG-INFO

@@ -1,24 +0,0 @@
-Metadata-Version: 2.1
-Name: autopkg-wrapper
-Version: 0.2.0
-Summary: A package used to execute some autopkg functions, primarily within the context of a GitHub Actions runner
-Home-page: https://github.com/smithjw/autopkg-wrapper
-License: BSD-3-Clause
-Author: James Smith
-Author-email: james@smithjw.me
-Requires-Python: >=3.12,<4.0
-Classifier: License :: OSI Approved :: BSD License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.12
-Requires-Dist: chardet (==5.2.0)
-Requires-Dist: idna (==3.6)
-Requires-Dist: pygithub (==2.1.1)
-Requires-Dist: requests (==2.31.0)
-Requires-Dist: ruamel-yaml (==0.18.5)
-Requires-Dist: toml (==0.10.2)
-Requires-Dist: urllib3 (==2.1.0)
-Project-URL: Repository, https://github.com/smithjw/autopkg-wrapper
-Description-Content-Type: text/markdown
-
-# autopkg-wrapper
-

autopkg_wrapper-0.2.0/README.md

@@ -1 +0,0 @@
-# autopkg-wrapper

autopkg_wrapper-0.2.0/autopkg_wrapper/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.2.0"