Catalog cache cleanup

Author: chennes

AddonCatalogCacheCreator.py

@@ -44,7 +44,7 @@
 ADDON_CATALOG_URL = (
     "https://raw.githubusercontent.com/FreeCAD/FreeCAD-addons/master/AddonCatalog.json"
 )
-BASE_DIRECTORY = "./"
+BASE_DIRECTORY = "./CatalogCache"
 MAX_COUNT = 10  # Do at most this many repos (for testing purposes)
 
 # Repos that are too large, or that should for some reason not be cloned here
@@ -62,13 +62,17 @@ class CacheEntry:
     icon_data: str = ""
 
 
-class AddonCatalogCacheCreator:
+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
+    will run a new fetch of the catalog."""
 
-    def __init__(self, addon_catalog_url=ADDON_CATALOG_URL):
+    def __init__(self, addon_catalog_url: str = ADDON_CATALOG_URL):
         self.addon_catalog_url = addon_catalog_url
         self.catalog = self.fetch_catalog()
 
     def fetch_catalog(self) -> AddonCatalog.AddonCatalog:
+        """Fetch the addon catalog from the given URL and return an AddonCatalog object."""
         response = requests.get(self.addon_catalog_url)
         if response.status_code != 200:
             raise RuntimeError(
@@ -78,22 +82,30 @@ def fetch_catalog(self) -> AddonCatalog.AddonCatalog:
 
 
 class CacheWriter:
+    """Writes a JSON file containing a cache of all addon catalog entries. The cache is a copy of
+    the package.xml, requirements.txt, and metadata.txt files from the addon repositories, as well
+    as a base64-encoded icon image. The cache is written to the current working directory."""
 
     def __init__(self):
         self.catalog: AddonCatalog = None
         if os.path.isabs(BASE_DIRECTORY):
             self.cwd = BASE_DIRECTORY
         else:
-            self.cwd = os.path.normpath(os.path.join(os.path.curdir, BASE_DIRECTORY))
+            self.cwd = os.path.normpath(os.path.join(os.getcwd(), BASE_DIRECTORY))
         self._cache = {}
 
     def write(self):
+        original_working_directory = os.getcwd()
+        os.makedirs(self.cwd, exist_ok=True)
+        os.chdir(self.cwd)
         self.create_local_copy_of_addons()
         with open("addon_catalog_cache.json", "w", encoding="utf-8") as f:
             f.write(json.dumps(self._cache, indent="  "))
+        os.chdir(original_working_directory)
+        print(f"Wrote cache to {os.path.join(self.cwd, 'addon_catalog_cache.json')}")
 
     def create_local_copy_of_addons(self):
-        self.catalog = AddonCatalogCacheCreator().catalog
+        self.catalog = CatalogFetcher().catalog
         counter = 0
         for addon_id, catalog_entries in self.catalog.get_catalog().items():
             if addon_id in EXCLUDED_REPOS:
@@ -128,7 +140,7 @@ def create_local_copy_of_single_addon(
     def generate_cache_entry(
         self, addon_id: str, index: int, catalog_entry: AddonCatalog.AddonCatalogEntry
     ) -> Optional[CacheEntry]:
-        """Create the cache entry for this catalog entry, if there is data to cache. If there is
+        """Create the cache entry for this catalog entry if there is data to cache. If there is
         nothing to cache, returns None."""
         path_to_package_xml = self.find_file("package.xml", addon_id, index, catalog_entry)
         cache_entry = None

AddonManagerTest/app/test_addon_catalog_cache_creator.py

@@ -222,7 +222,7 @@ def test_create_local_copy_of_single_addon_using_zip(
         self.assertEqual(3, len(writer._cache["TestMod"]))
 
     @patch("AddonCatalogCacheCreator.CacheWriter.create_local_copy_of_single_addon")
-    @patch("AddonCatalogCacheCreator.AddonCatalogCacheCreator.fetch_catalog")
+    @patch("AddonCatalogCacheCreator.CatalogFetcher.fetch_catalog")
     def test_create_local_copy_of_addons(self, mock_fetch_catalog, mock_create_single_addon):
         """Given a catalog, each addon is fetched and cached."""