Correctly detect and handle installation path collisions

`compilesketches.CompileSketches.install_from_path()` has code for detecting a pre-existing file/folder at the
installation destination path and either removing it or else failing with a helpful error message depending on the
setting of the `force` parameter.

The previous detection code did not work correctly in the event the pre-existing item was a broken symlink.

The previous removal code did not work correctly in the event the pre-existing item was a symlink or file.

Author: per1234

compilesketches/compilesketches.py

@@ -559,11 +559,14 @@ def install_from_path(self, source_path, destination_parent_path, destination_na
 
         destination_path = destination_parent_path.joinpath(destination_name)
 
-        if destination_path.exists():
+        if destination_path.exists() or destination_path.is_symlink():
             if force:
-                # Clear existing folder
+                # Clear existing item
                 self.verbose_print("Overwriting installation at:", destination_path)
-                shutil.rmtree(path=destination_path)
+                if destination_path.is_symlink() or destination_path.is_file():
+                    destination_path.unlink()
+                else:
+                    shutil.rmtree(path=destination_path)
             else:
                 print("::error::Installation already exists:", destination_path)
                 sys.exit(1)

compilesketches/tests/test_compilesketches.py

@@ -1245,38 +1245,60 @@ def test_get_list_from_multiformat_input(input_value, expected_list, expected_wa
 
 # noinspection PyUnresolvedReferences
 @pytest.mark.parametrize(
-    "source_path, destination_parent_path, destination_name, expected_destination_path",
-    [(pathlib.Path("foo/source-path"),
-      pathlib.Path("bar/destination-parent-path"),
+    "source_sub_path, destination_parent_sub_path, destination_name, expected_destination_sub_path",
+    [("foo/source-path",
+      "bar/destination-parent-path",
       None,
-      pathlib.Path("bar/destination-parent-path/source-path")),
-     (pathlib.Path("foo/source-path"),
-      pathlib.Path("bar/destination-parent-path"),
+      "bar/destination-parent-path/source-path"),
+     ("foo/source-path",
+      "bar/destination-parent-path",
       "destination-name",
-      pathlib.Path("bar/destination-parent-path/destination-name"))])
-@pytest.mark.parametrize("exists", [True, False])
+      "bar/destination-parent-path/destination-name")])
+@pytest.mark.parametrize("exists", ["no", "yes", "symlink", "broken"])
 @pytest.mark.parametrize("force", [True, False])
 @pytest.mark.parametrize("is_dir", [True, False])
 def test_install_from_path(capsys,
-                           mocker,
-                           source_path,
-                           destination_parent_path,
+                           tmp_path,
+                           source_sub_path,
+                           destination_parent_sub_path,
                            destination_name,
-                           expected_destination_path,
+                           expected_destination_sub_path,
                            exists,
                            force,
                            is_dir):
-    is_dir = unittest.mock.sentinel.is_dir
+    source_path = tmp_path.joinpath(source_sub_path)
 
-    compile_sketches = get_compilesketches_object()
+    # Generate source path
+    if is_dir:
+        source_path.mkdir(parents=True)
+    else:
+        source_path.parent.mkdir(parents=True, exist_ok=True)
+        source_path.touch()
 
-    mocker.patch.object(pathlib.Path, "exists", autospec=True, return_value=exists)
-    mocker.patch("shutil.rmtree", autospec=True)
-    mocker.patch.object(pathlib.Path, "mkdir", autospec=True)
-    mocker.patch.object(pathlib.Path, "is_dir", autospec=True, return_value=is_dir)
-    mocker.patch.object(pathlib.Path, "symlink_to", autospec=True)
+    destination_parent_path = tmp_path.joinpath(destination_parent_sub_path)
+    if destination_name is None:
+        destination_path = destination_parent_path.joinpath(source_path.name)
+    else:
+        destination_path = destination_parent_path.joinpath(destination_name)
+    destination_path.parent.mkdir(parents=True, exist_ok=True)
 
-    if exists and not force:
+    # Generate pre-existing destination path
+    if exists == "yes":
+        if is_dir:
+            destination_path.mkdir(parents=True)
+        else:
+            # source_path.parent.mkdir(parents=True)
+            destination_path.touch()
+    elif exists == "symlink":
+        destination_path.symlink_to(target=source_path, target_is_directory=source_path.is_dir())
+    elif exists == "broken":
+        destination_path.symlink_to(target=tmp_path.joinpath("nonexistent"), target_is_directory=is_dir)
+
+    expected_destination_path = tmp_path.joinpath(expected_destination_sub_path)
+
+    compile_sketches = get_compilesketches_object()
+
+    if exists != "no" and not force:
         with pytest.raises(expected_exception=SystemExit, match="1"):
             compile_sketches.install_from_path(source_path=source_path,
                                                destination_parent_path=destination_parent_path,
@@ -1291,13 +1313,8 @@ def test_install_from_path(capsys,
                                            destination_parent_path=destination_parent_path,
                                            destination_name=destination_name,
                                            force=force)
-        if exists and force:
-            shutil.rmtree.assert_called_once_with(path=expected_destination_path)
-        else:
-            shutil.rmtree.assert_not_called()
 
-        pathlib.Path.symlink_to.assert_called_once_with(expected_destination_path, target=source_path,
-                                                        target_is_directory=is_dir)
+        assert expected_destination_path.resolve() == source_path
 
 
 def test_install_from_path_functional(tmp_path):