feat: update code scanning packs support

Author: GeekMasher

examples/packs/codeql-pack.lock.yml

@@ -0,0 +1,14 @@
+---
+lockVersion: 1.0.0
+dependencies:
+  codeql/python-all:
+    version: 0.9.4
+  codeql/regex:
+    version: 0.0.15
+  codeql/tutorial:
+    version: 0.0.12
+  codeql/util:
+    version: 0.0.12
+  codeql/yaml:
+    version: 0.0.4
+compiled: false

examples/packs/qlpack.yml

@@ -0,0 +1,8 @@
+---
+library: false
+name: geekmasher/ghastoolkit-python
+version: 0.1.0
+dependencies:
+  codeql/python-all: "^0.9.2"
+defaultSuiteFile: default.qls
+

src/ghastoolkit/codeql/packs/__main__.py

@@ -3,6 +3,7 @@
 import logging
 from argparse import ArgumentParser
 from ghastoolkit import __banner__
+from ghastoolkit.codeql.packs.pack import CodeQLPack
 from ghastoolkit.codeql.packs.packs import CodeQLPacks
 from ghastoolkit.octokit.codescanning import CodeScanning
 from ghastoolkit.octokit.github import GitHub
@@ -21,6 +22,9 @@
     "-dd", "--display-dependencies", action="store_true", help="Display Dependencies"
 )
 
+parser_bumper = parser.add_argument_group("Bumper")
+parser_bumper.add_argument("-b", "--bump", default="minor", help="Bump version")
+
 arguments = parser.parse_args()
 remote = True if arguments.repository else False
 
@@ -33,24 +37,46 @@
 
 code_scanning = CodeScanning()
 
+if arguments.bump:
+    # version bump mode
+    logging.info(f"Bumping CodeQL Pack Versions")
+    logging.info(f" - Bump: {arguments.bump}")
+
+    if os.path.isdir(arguments.packs_path):
+        packs = CodeQLPacks(arguments.packs_path)
+        for pack in packs:
+            old_version = pack.version
+            v = pack.updateVersion(arguments.bump)
+            logging.info(f"Pack :: {pack.name} - {old_version} -> {v}")
+            pack.updatePack()
+
+    elif os.path.isfile(arguments.packs_path):
+        pack = CodeQLPack(arguments.packs_path)
+        old_version = pack.version
+        new_version = pack.updateVersion(arguments.bump)
+        logging.info(f"Pack :: {pack.name} - {old_version} -> {new_version}")
 
-logging.debug(f"Loading packs from environment...")
+        pack.updatePack()
+
+else:
+    # display-only mode
+    logging.debug(f"Loading packs from environment...")
 
-packs = CodeQLPacks()
-packs.load(arguments.packs_path)
+    packs = CodeQLPacks()
+    packs.load(arguments.packs_path)
 
-logging.info(f"CodeQL Packs :: {len(packs)}")
-logging.info("")
+    logging.info(f"CodeQL Packs :: {len(packs)}")
+    logging.info("")
 
-for pack in packs:
-    logging.info(f" - {pack}")
+    for pack in packs:
+        logging.info(f" - {pack}")
 
-    if remote:
-        remote_version = pack.remote_version
-        if remote_version:
-            logging.info(f"   |> Remote Version: `{pack.remote_version}`")
+        if remote:
+            remote_version = pack.remote_version
+            if remote_version:
+                logging.info(f"   |> Remote Version: `{pack.remote_version}`")
 
-    if arguments.display_dependencies:
-        logging.info(f"   |> Dependencies")
-        for dep in pack.dependencies:
-            logging.info(f"   |--> {dep}")
+        if arguments.display_dependencies:
+            logging.info(f"   |> Dependencies")
+            for dep in pack.dependencies:
+                logging.info(f"   |--> {dep}")

src/ghastoolkit/codeql/packs/pack.py

@@ -4,7 +4,9 @@
 import json
 import glob
 import logging
-from typing import List, Optional
+from typing import Any, List, Optional
+from collections import OrderedDict
+from semantic_version import Version
 import yaml
 
 from ghastoolkit.codeql.cli import CodeQL
@@ -20,16 +22,22 @@ class CodeQLPack:
     """CodeQL Packages Location"""
 
     def __init__(
-        self, path: Optional[str] = None, cli: Optional[CodeQL] = None
+        self,
+        path: Optional[str] = None,
+        library: Optional[bool] = None,
+        name: Optional[str] = None,
+        version: Optional[str] = None,
+        cli: Optional[CodeQL] = None,
     ) -> None:
         """Initialise CodeQL Pack."""
         self.cli = cli or CodeQL()
 
         self.path = path
-        self.library = False
-        self.name = ""
-        self.version = ""
-        self.dependencies = []
+        self.library: bool = library or False
+        self.name: str = name or ""
+        self.version: str = version or "0.0.0"
+        self.dependencies: List["CodeQLPack"] = []
+        self.default_suite: Optional[str] = None
 
         if path:
             # if its a file
@@ -39,6 +47,8 @@ def __init__(
             self.path = os.path.realpath(os.path.expanduser(path))
             self.load()
 
+        logger.debug(f"Finished loading Pack :: {self}")
+
     @property
     def qlpack(self) -> str:
         """QL Pack Location."""
@@ -62,7 +72,11 @@ def load(self):
         self.library = bool(data.get("library"))
         self.name = data.get("name", "")
         self.version = data.get("version", "")
-        self.dependencies.extend(data.get("dependencies", []))
+        self.default_suite = data.get("defaultSuiteFile")
+
+        for name, version in data.get("dependencies", {}).items():
+            print(f" >> {name} == {version}")
+            self.dependencies.append(CodeQLPack(name=name, version=version))
 
     def run(self, *args, display: bool = False) -> Optional[str]:
         """Run Pack command."""
@@ -128,6 +142,42 @@ def remote_version(self) -> Optional[str]:
             logging.debug(f"Error getting remote version")
         return None
 
+    def updatePack(self) -> dict[str, Any]:
+        """Update Local CodeQL Pack."""
+        deps = {}
+        for dep in self.dependencies:
+            deps[dep.name] = dep.version
+
+        data = {
+            "library": self.library,
+            "name": self.name,
+            "version": self.version,
+            "dependencies": deps,
+        }
+
+        if self.path:
+            logger.info(f"Saving pack to path :: {self.path}")
+            with open(self.qlpack, "w") as handle:
+                yaml.safe_dump(data, handle, sort_keys=False)
+
+        return data
+
+    def updateVersion(self, name: str = "patch", version: Optional[str] = None) -> str:
+        """Update CodeQL Pack version."""
+        if version:
+            self.version = version
+            return version
+
+        v = Version(self.version)
+        if name == "major":
+            v = v.next_major()
+        elif name == "minor":
+            v = v.next_minor()
+        elif name == "patch":
+            v = v.next_patch()
+        self.version = str(v)
+        return self.version
+
     def __str__(self) -> str:
         """To String."""
         if self.name != "":