autopkg-wrapper 2024.6.1__tar.gz → 2024.8.1__tar.gz

{autopkg_wrapper-2024.6.1 → autopkg_wrapper-2024.8.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: autopkg-wrapper
-Version: 2024.6.1
+Version: 2024.8.1
 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
@@ -42,6 +42,8 @@ pip install autopkg-wrapper
 --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-prefs AW_AUTOPKG_PREFS_FILE
+                                Path to the autopkg preferences you'd like to use
 --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.
 ```

{autopkg_wrapper-2024.6.1 → autopkg_wrapper-2024.8.1}/README.md

@@ -20,6 +20,8 @@ pip install autopkg-wrapper
 --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-prefs AW_AUTOPKG_PREFS_FILE
+                                Path to the autopkg preferences you'd like to use
 --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.
 ```

autopkg_wrapper-2024.8.1/autopkg_wrapper/__init__.py

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

{autopkg_wrapper-2024.6.1 → autopkg_wrapper-2024.8.1}/autopkg_wrapper/autopkg_wrapper.py

@@ -33,10 +33,14 @@ class Recipe(object):
 
         return name
 
-    def verify_trust_info(self, debug):
-        verbose_output = ["-vvvv"]
+    def verify_trust_info(self, args):
+        verbose_output = ["-vvvv"] if args.debug else None
+        prefs_file = (
+            ["--prefs", args.autopkg_prefs.as_posix()] if args.autopkg_prefs else None
+        )
         cmd = ["/usr/local/bin/autopkg", "verify-trust-info", self.filename]
-        cmd = cmd + verbose_output if debug else cmd
+        cmd = cmd + verbose_output if verbose_output else cmd
+        cmd = cmd + prefs_file if prefs_file else cmd
         cmd = " ".join(cmd)
         logging.debug(f"cmd: {str(cmd)}")
 
@@ -53,8 +57,12 @@ class Recipe(object):
             self.verified = False
         return self.verified
 
-    def update_trust_info(self):
+    def update_trust_info(self, args):
+        prefs_file = (
+            ["--prefs", args.autopkg_prefs.as_posix()] if args.autopkg_prefs else None
+        )
         cmd = ["/usr/local/bin/autopkg", "update-trust-info", self.filename]
+        cmd = cmd + prefs_file if prefs_file else cmd
         cmd = " ".join(cmd)
         logging.debug(f"cmd: {str(cmd)}")
 
@@ -80,7 +88,7 @@ class Recipe(object):
 
         return {"imported": imported_items, "failed": failed_items}
 
-    def run(self, debug):
+    def run(self, args):
         if self.verified is False:
             self.error = True
             self.results["failed"] = True
@@ -95,8 +103,24 @@ class Recipe(object):
             report.touch(exist_ok=True)
 
             try:
-                post_processor_cmd = list(chain.from_iterable([("--post", processor) for processor in self.post_processors])) if self.post_processors else None
-                verbose_output = ["-vvvv"]
+                prefs_file = (
+                    ["--prefs", args.autopkg_prefs.as_posix()]
+                    if args.autopkg_prefs
+                    else None
+                )
+                verbose_output = ["-vvvv"] if args.debug else None
+                post_processor_cmd = (
+                    list(
+                        chain.from_iterable(
+                            [
+                                ("--post", processor)
+                                for processor in self.post_processors
+                            ]
+                        )
+                    )
+                    if self.post_processors
+                    else None
+                )
                 cmd = [
                     "/usr/local/bin/autopkg",
                     "run",
@@ -105,7 +129,8 @@ class Recipe(object):
                     str(report),
                 ]
                 cmd = cmd + post_processor_cmd if post_processor_cmd else cmd
-                cmd = cmd + verbose_output if debug else cmd
+                cmd = cmd + verbose_output if verbose_output else cmd
+                cmd = cmd + prefs_file if prefs_file else cmd
                 cmd = " ".join(cmd)
 
                 logging.debug(f"cmd: {str(cmd)}")
@@ -129,12 +154,28 @@ def get_override_repo_info(args):
 
     else:
         logging.debug("Trying to determine overrides dir from default paths")
-        user_home = Path.home()
-        autopkg_prefs_path = user_home / "Library/Preferences/com.github.autopkg.plist"
 
-        if autopkg_prefs_path.is_file():
-            autopkg_prefs = plistlib.loads(autopkg_prefs_path.resolve().read_bytes())
+        if args.autopkg_prefs:
+            autopkg_prefs_path = Path(args.autopkg_prefs).resolve()
 
+            if autopkg_prefs_path.suffix == ".json":
+                with open(autopkg_prefs_path, "r") as f:
+                    autopkg_prefs = json.load(f)
+            elif autopkg_prefs_path.suffix == ".plist":
+                autopkg_prefs = plistlib.loads(autopkg_prefs_path.read_bytes())
+        else:
+            user_home = Path.home()
+            autopkg_prefs_path = (
+                user_home / "Library/Preferences/com.github.autopkg.plist"
+            )
+
+            if autopkg_prefs_path.is_file():
+                autopkg_prefs = plistlib.loads(
+                    autopkg_prefs_path.resolve().read_bytes()
+                )
+
+        logging.debug(f"autopkg prefs path: {autopkg_prefs_path}")
+        logging.debug(f"autopkg prefs: {autopkg_prefs}")
         recipe_override_dirs = Path(autopkg_prefs["RECIPE_OVERRIDE_DIRS"]).resolve()
 
     if Path(recipe_override_dirs / ".git").is_dir():
@@ -146,7 +187,9 @@ def get_override_repo_info(args):
 
     override_repo_git_work_tree = f"--work-tree={override_repo_path}"
     override_repo_git_git_dir = f"--git-dir={override_repo_path / ".git"}"
-    override_repo_url, override_repo_remote_ref = git.get_repo_info(override_repo_git_git_dir)
+    override_repo_url, override_repo_remote_ref = git.get_repo_info(
+        override_repo_git_git_dir
+    )
 
     git_info = {
         "override_repo_path": override_repo_path,
@@ -179,22 +222,28 @@ def update_recipe_repo(recipe, git_info, disable_recipe_trust_check, args):
             current_branch = git.get_current_branch(git_info)
 
             if args.disable_git_commands:
-                logging.info("Not runing git commands as --disable-git-commands has been set")
+                logging.info(
+                    "Not runing git commands as --disable-git-commands has been set"
+                )
                 return
 
             if current_branch != git_info["override_trust_branch"]:
-                logging.debug(f"override_trust_branch: {git_info["override_trust_branch"]}")
+                logging.debug(
+                    f"override_trust_branch: {git_info["override_trust_branch"]}"
+                )
                 git.create_branch(git_info)
 
             git.stage_recipe(git_info)
-            git.commit_recipe(git_info, message=f"Updating Trust Info for {recipe.name}")
+            git.commit_recipe(
+                git_info, message=f"Updating Trust Info for {recipe.name}"
+            )
             git.pull_branch(git_info)
             git.push_branch(git_info)
 
             return
 
 
-def parse_recipe_list(recipes, recipe_file, post_processors):
+def parse_recipe_list(recipes, recipe_file, post_processors, args):
     """Parsing list of recipes into a common format"""
     recipe_list = None
 
@@ -214,10 +263,14 @@ def parse_recipe_list(recipes, recipe_file, post_processors):
         elif isinstance(recipes, str):
             if recipes.find(",") != -1:
                 # Assuming recipes separated by commas
-                recipe_list = [recipe.strip() for recipe in recipes.split(",") if recipe]
+                recipe_list = [
+                    recipe.strip() for recipe in recipes.split(",") if recipe
+                ]
             else:
                 # Assuming recipes separated by space
-                recipe_list = [recipe.strip() for recipe in recipes.split(" ") if recipe]
+                recipe_list = [
+                    recipe.strip() for recipe in recipes.split(" ") if recipe
+                ]
 
     if recipe_list is None:
         logging.error(
@@ -233,6 +286,7 @@ def parse_recipe_list(recipes, recipe_file, post_processors):
 
     return recipe_map
 
+
 def parse_post_processors(post_processors):
     """Parsing list of post_processors"""
     logging.debug("Parsing post processors")
@@ -247,32 +301,42 @@ def parse_post_processors(post_processors):
         case list():
             post_processors_list = post_processors
         case str() if post_processors.find(",") != -1:
-            post_processors_list = [post_processor.strip() for post_processor in post_processors.split(",") if post_processor.strip()]
+            post_processors_list = [
+                post_processor.strip()
+                for post_processor in post_processors.split(",")
+                if post_processor.strip()
+            ]
         case str():
-            post_processors_list = [post_processor.strip() for post_processor in post_processors.split(" ") if post_processor.strip()]
+            post_processors_list = [
+                post_processor.strip()
+                for post_processor in post_processors.split(" ")
+                if post_processor.strip()
+            ]
 
-    logging.info(f"Post Processors List: {post_processors_list}") if post_processors_list else None
+    logging.info(
+        f"Post Processors List: {post_processors_list}"
+    ) if post_processors_list else None
 
     return post_processors_list
 
 
-def process_recipe(recipe, disable_recipe_trust_check, debug):
+def process_recipe(recipe, disable_recipe_trust_check, args):
     if disable_recipe_trust_check:
         logging.debug("Setting Recipe verification to None")
         recipe.verified = None
     else:
         logging.debug("Checking Recipe verification")
-        recipe.verify_trust_info(debug)
+        recipe.verify_trust_info(args)
 
     match recipe.verified:
         case False | None if disable_recipe_trust_check:
             logging.debug("Running Recipe without verification")
-            recipe.run(debug)
+            recipe.run(args)
         case True:
             logging.debug("Running Recipe after successful verification")
-            recipe.run(debug)
+            recipe.run(args)
         case False:
-            recipe.update_trust_info()
+            recipe.update_trust_info(args)
 
     return recipe
 
@@ -285,15 +349,35 @@ def main():
     override_repo_info = get_override_repo_info(args)
 
     post_processors_list = parse_post_processors(post_processors=args.post_processors)
-    recipe_list = parse_recipe_list(recipes=args.recipes, recipe_file=args.recipe_file, post_processors=post_processors_list)
+    recipe_list = parse_recipe_list(
+        recipes=args.recipes,
+        recipe_file=args.recipe_file,
+        post_processors=post_processors_list,
+        args=args,
+    )
 
     for recipe in recipe_list:
         logging.info(f"Processing Recipe: {recipe.name}")
-        process_recipe(recipe=recipe, disable_recipe_trust_check=args.disable_recipe_trust_check, debug=args.debug)
-        update_recipe_repo(git_info=override_repo_info, recipe=recipe, disable_recipe_trust_check=args.disable_recipe_trust_check, args=args)
-        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
+        process_recipe(
+            recipe=recipe,
+            disable_recipe_trust_check=args.disable_recipe_trust_check,
+            args=args,
+        )
+        update_recipe_repo(
+            git_info=override_repo_info,
+            recipe=recipe,
+            disable_recipe_trust_check=args.disable_recipe_trust_check,
+            args=args,
+        )
+        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
+    )
 
 
 if __name__ == "__main__":

{autopkg_wrapper-2024.6.1 → autopkg_wrapper-2024.8.1}/autopkg_wrapper/utils/args.py

@@ -14,6 +14,7 @@ def validate_file(arg):
         message = f"Error! This is not valid file: {arg}"
         raise argparse.ArgumentTypeError(message)
 
+
 def validate_directory(arg):
     dir_path = Path(arg).resolve()
     dir_exists = dir_path.is_dir()
@@ -24,14 +25,25 @@ def validate_directory(arg):
         message = f"Error! This is not valid directory: {arg}"
         raise argparse.ArgumentTypeError(message)
 
+
 def validate_bool(arg):
     if isinstance(arg, bool):
         return arg
-    elif isinstance(arg, str) and arg.lower() in ['0','false','no', 'f']:
+    elif isinstance(arg, str) and arg.lower() in ["0", "false", "no", "f"]:
         return False
-    elif isinstance(arg, str) and arg.lower() in ['1','true','yes', 't']:
+    elif isinstance(arg, str) and arg.lower() in ["1", "true", "yes", "t"]:
         return True
 
+
+def find_github_token():
+    if os.getenv("GITHUB_TOKEN", None):
+        return os.getenv("GITHUB_TOKEN")
+    elif os.getenv("GH_TOKEN", None):
+        return os.getenv("GH_TOKEN")
+    else:
+        return None
+
+
 def setup_args():
     parser = argparse.ArgumentParser(description="Run autopkg recipes")
     recipe_arguments = parser.add_mutually_exclusive_group()
@@ -78,11 +90,18 @@ def setup_args():
             If this option is used, git commands won't be run
             """,
     )
-    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(
+        "--slack-token",
+        default=os.getenv("SLACK_WEBHOOK_TOKEN", None),
+        help=argparse.SUPPRESS,
+    )
+    parser.add_argument("--github-token", default=find_github_token())
     parser.add_argument(
         "--branch-name",
-        default=os.getenv("AW_TRUST_BRANCH", f"fix/update_trust_information/{datetime.now().strftime("%Y-%m-%dT%H-%M-%S")}"),
+        default=os.getenv(
+            "AW_TRUST_BRANCH",
+            f"fix/update_trust_information/{datetime.now().strftime("%Y-%m-%dT%H-%M-%S")}",
+        ),
         help="""
             Branch name to be used 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\"
@@ -111,5 +130,13 @@ def setup_args():
         One or more autopkg post processors to run after each recipe execution
         """,
     )
+    parser.add_argument(
+        "--autopkg-prefs",
+        default=os.getenv("AW_AUTOPKG_PREFS_FILE", None),
+        type=validate_file,
+        help="""
+        Path to the autopkg preferences you'd like to use
+        """,
+    )
 
     return parser.parse_args()

{autopkg_wrapper-2024.6.1 → autopkg_wrapper-2024.8.1}/pyproject.toml

@@ -5,7 +5,7 @@
     name = "autopkg-wrapper"
     readme = "README.md"
     repository = "https://github.com/smithjw/autopkg-wrapper"
-    version = "2024.6.1"
+    version = "2024.8.1"
 
     [tool.poetry.scripts]
         # When built and installed by pip, the command autopkg_wrapper will be availble in to run within that environment

autopkg_wrapper-2024.6.1/autopkg_wrapper/__init__.py

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