Minor bug fixes in Cache Creator

Author: chennes

AddonCatalogCacheCreator.py

@@ -24,6 +24,7 @@
 """Classes and utility functions to generate a remotely hosted cache of all addon catalog entries.
 Intended to be run by a server-side systemd timer to generate a file that is then loaded by the
 Addon Manager in each FreeCAD installation."""
+import enum
 import xml.etree.ElementTree
 from dataclasses import dataclass, asdict
 from typing import List, Optional
@@ -45,7 +46,7 @@
     "https://raw.githubusercontent.com/FreeCAD/FreeCAD-addons/master/AddonCatalog.json"
 )
 BASE_DIRECTORY = "./CatalogCache"
-MAX_COUNT = 10  # Do at most this many repos (for testing purposes)
+MAX_COUNT = 10000  # Do at most this many repos (for testing purposes this can be made smaller)
 
 # Repos that are too large, or that should for some reason not be cloned here
 EXCLUDED_REPOS = ["parts_library"]
@@ -62,6 +63,14 @@ class CacheEntry:
     icon_data: str = ""
 
 
+class GitRefType(enum.IntEnum):
+    """Enum for the type of git ref (tag, branch, or hash)."""
+
+    TAG = 1
+    BRANCH = 2
+    HASH = 3
+
+
 class CatalogFetcher:
     """Fetches the addon catalog from the given URL and returns an AddonCatalog object. Separated
     from the main class for easy mocking during tests. Note that every instantiation of this class
@@ -181,10 +190,15 @@ def generate_cache_entry_from_package_xml(
             return None
 
         relative_icon_path = self.get_icon_from_metadata(metadata)
-        absolute_icon_path = os.path.join(os.path.dirname(path_to_package_xml), relative_icon_path)
-        if os.path.exists(absolute_icon_path):
-            with open(absolute_icon_path, "rb") as f:
-                cache_entry.icon_data = base64.b64encode(f.read()).decode("utf-8")
+        if relative_icon_path is not None:
+            absolute_icon_path = os.path.join(
+                os.path.dirname(path_to_package_xml), relative_icon_path
+            )
+            if os.path.exists(absolute_icon_path):
+                with open(absolute_icon_path, "rb") as f:
+                    cache_entry.icon_data = base64.b64encode(f.read()).decode("utf-8")
+            else:
+                print(f"ERROR: Could not find icon file {absolute_icon_path}")
         return cache_entry
 
     def create_local_copy_of_single_addon_with_git(
@@ -246,6 +260,8 @@ def clone_or_update(name: str, url: str, branch: str) -> None:
             print(f"Updating {name}", flush=True)
             old_dir = os.getcwd()
             os.chdir(os.path.join(old_dir, name))
+            # Determine if we are dealing with a tag, branch, or hash
+            git_ref_type = CacheWriter.determine_git_ref_type(name, url, branch)
             command = ["git", "fetch"]
             completed_process = subprocess.run(command)
             if completed_process.returncode != 0:
@@ -256,11 +272,12 @@ def clone_or_update(name: str, url: str, branch: str) -> None:
             if completed_process.returncode != 0:
                 os.chdir(old_dir)
                 raise RuntimeError(f"git checkout failed for {name} branch {branch}")
-            command = ["git", "merge", "--quiet"]
-            completed_process = subprocess.run(command)
-            if completed_process.returncode != 0:
-                os.chdir(old_dir)
-                raise RuntimeError(f"git merge failed for {name} branch {branch}")
+            if git_ref_type == GitRefType.BRANCH:
+                command = ["git", "merge", "--quiet"]
+                completed_process = subprocess.run(command)
+                if completed_process.returncode != 0:
+                    os.chdir(old_dir)
+                    raise RuntimeError(f"git merge failed for {name} branch {branch}")
             os.chdir(old_dir)
 
     def find_file(
@@ -293,6 +310,28 @@ def get_icon_from_metadata(metadata: addonmanager_metadata.Metadata) -> Optional
                     return icon
         return None
 
+    @staticmethod
+    def determine_git_ref_type(name: str, url: str, branch: str) -> GitRefType:
+        """Determine if the given branch, tag, or hash is a tag, branch, or hash. Returns the type
+        if determinable, otherwise raises a RuntimeError."""
+        command = ["git", "show-ref", "--verify", f"refs/remotes/origin/{branch}"]
+        completed_process = subprocess.run(command)
+        if completed_process.returncode == 0:
+            return GitRefType.BRANCH
+        command = ["git", "show-ref", "--tags"]
+        completed_process = subprocess.run(command, capture_output=True)
+        completed_process_output = completed_process.stdout.decode("utf-8")
+        if branch in completed_process_output:
+            return GitRefType.TAG
+        command = ["git", "rev-parse", branch]
+        completed_process = subprocess.run(command)
+        if completed_process.returncode == 0:
+            return GitRefType.HASH
+        raise RuntimeError(
+            f"Could not determine if {branch} of {name} is a tag, branch, or hash. "
+            f"Output was: {completed_process_output}"
+        )
+
 
 if __name__ == "__main__":
     writer = CacheWriter()