Remove existing catalog entities in dest dir for clean sync with the content of the index image

This is to take into account the case where the catalog index image is updated and contains completely different catalog entities. Without this, we might still see the previous extensions displayed in the Extensions UI

Author: rm3l

docker/install-dynamic-plugins.py

@@ -1005,10 +1005,14 @@ def extract_catalog_index(catalog_index_image: str, catalog_index_mount: str, ca
     marketplace_dir_from_catalog_index = os.path.join(catalog_index_temp_dir, 'catalog-entities', 'marketplace')
     if os.path.isdir(marketplace_dir_from_catalog_index):
         os.makedirs(catalog_entities_parent_dir, exist_ok=True)
-        shutil.copytree(marketplace_dir_from_catalog_index, os.path.join(catalog_entities_parent_dir, 'catalog-entities'), dirs_exist_ok=True)
+        catalog_entities_dest = os.path.join(catalog_entities_parent_dir, 'catalog-entities')
+        # Ensure the destination directory is is sync with the catalog entities from the index image
+        if os.path.exists(catalog_entities_dest):
+            shutil.rmtree(catalog_entities_dest, ignore_errors=True, onerror=None)
+        shutil.copytree(marketplace_dir_from_catalog_index, catalog_entities_dest, dirs_exist_ok=True)
         print("\t==> Successfully extracted extensions catalog entities from index image", flush=True)
     else:
-        print(f"\t==> WARNING: Catalog index image {catalog_index_image} does not contain the expected 'catalog-entities/marketplace' directory", flush=True)
+        print(f"\t==> WARNING: Catalog index image {catalog_index_image} does not have a 'catalog-entities/marketplace' directory", flush=True)
 
     return default_plugins_file
 

docker/test_install-dynamic-plugins.py

@@ -2622,6 +2622,59 @@ def test_extract_catalog_index_creates_entities_directory(self, tmp_path, mocker
         entity_file = entities_dir / "test-entity.yaml"
         assert entity_file.exists(), "Entity file should be copied"
 
+    def test_extract_catalog_index_removes_existing_destination(self, tmp_path, mocker, mock_oci_image):
+        """Test that existing catalog-entities directory is removed before copying."""
+        catalog_mount = tmp_path / "catalog-mount"
+        catalog_mount.mkdir()
+        catalog_entities_parent_dir = tmp_path / "existing-dir"
+        catalog_entities_parent_dir.mkdir()
+
+        # Create an existing catalog-entities directory with old content
+        existing_entities_dir = catalog_entities_parent_dir / "catalog-entities"
+        existing_entities_dir.mkdir()
+        old_file = existing_entities_dir / "old-file.yaml"
+        old_file.write_text("old content")
+        old_subdir = existing_entities_dir / "old-subdir"
+        old_subdir.mkdir()
+        (old_subdir / "old-nested.yaml").write_text("old nested content")
+
+        # Verify old content exists
+        assert existing_entities_dir.exists()
+        assert old_file.exists()
+        assert old_subdir.exists()
+
+        mocker.patch('shutil.which', return_value='/usr/bin/skopeo')
+
+        mock_result = mocker.Mock()
+        mock_result.returncode = 0
+        mock_subprocess_run = create_mock_skopeo_copy(
+            mock_oci_image['manifest_path'],
+            mock_oci_image['layer_tarball'],
+            mock_result
+        )
+        mocker.patch('subprocess.run', side_effect=mock_subprocess_run)
+
+        install_dynamic_plugins.extract_catalog_index(
+            "quay.io/test/catalog-index:1.9",
+            str(catalog_mount),
+            str(catalog_entities_parent_dir)
+        )
+
+        # Verify old content was removed
+        assert not old_file.exists(), "Old file should have been removed"
+        assert not old_subdir.exists(), "Old subdirectory should have been removed"
+
+        # Verify new content exists
+        entities_dir = catalog_entities_parent_dir / "catalog-entities"
+        assert entities_dir.exists(), "Catalog entities directory should exist"
+        entity_file = entities_dir / "test-entity.yaml"
+        assert entity_file.exists(), "New entity file should exist"
+        assert "kind: Component" in entity_file.read_text()
+
+        # Verify old content is definitely gone
+        assert not (entities_dir / "old-file.yaml").exists(), "Old file should not exist"
+        assert not (entities_dir / "old-subdir").exists(), "Old subdirectory should not exist"
+
     def test_extract_catalog_index_without_catalog_entities(self, tmp_path, mocker, capsys):
         """Test that extraction succeeds with warning if catalog-entities directory doesn't exist in image."""
         import tarfile
@@ -2677,6 +2730,7 @@ def test_extract_catalog_index_without_catalog_entities(self, tmp_path, mocker,
         # Verify warning was printed
         captured = capsys.readouterr()
         assert 'WARNING' in captured.out
+        assert 'does not have a' in captured.out
         assert 'catalog-entities/marketplace' in captured.out
 
         # Verify catalog entities directory was not created