Support ~ in input paths

The Arduino user folder (sketchbook) is at /home/github/Arduino and the Arduino data folder at /home/github, but the /home/github path is not obvious or documented and there is no way to use the HOME environment variable in inputs to this action. So the most user friendly way to specify these paths outside the workspace is using ~. This is not supported by default.

Author: per1234

compilesketches/compilesketches.py

@@ -626,7 +626,7 @@ def install_libraries_from_path(self, library_list):
                 # If a name was specified, use it
                 destination_name = library[self.dependency_destination_name_key]
             elif (
-                source_path == pathlib.Path(os.environ["GITHUB_WORKSPACE"])
+                source_path == absolute_path(os.environ["GITHUB_WORKSPACE"])
             ):
                 # If source_path is the root of the workspace (i.e., repository root), name the folder according to the
                 # repository name, otherwise it will unexpectedly be "workspace"
@@ -1047,9 +1047,9 @@ def path_relative_to_workspace(path):
     Keyword arguments:
     path -- the path to make relative
     """
-    path = pathlib.Path(path)
+    path = absolute_path(path=path)
     try:
-        relative_path = path.relative_to(os.environ["GITHUB_WORKSPACE"])
+        relative_path = path.relative_to(absolute_path(path=os.environ["GITHUB_WORKSPACE"]))
     except ValueError:
         # Path is outside workspace, so just use the given path
         relative_path = path
@@ -1064,11 +1064,15 @@ def absolute_path(path):
     Keyword arguments:
     path -- the path to make absolute
     """
-    path = pathlib.Path(path)
+    # Make path into a pathlib.Path object, with ~ expanded
+    path = pathlib.Path(path).expanduser()
     if not path.is_absolute():
         # path is relative
         path = pathlib.Path(os.environ["GITHUB_WORKSPACE"], path)
 
+    # Resolve .. and symlinks to get a true absolute path
+    path = path.resolve()
+
     return path
 
 

compilesketches/tests/test_compilesketches.py

@@ -899,7 +899,9 @@ def test_install_libraries_from_path(capsys, monkeypatch, mocker, path_exists, l
             joinpath_calls.append(unittest.mock.call(libraries_path, expected_destination_name))
             symlink_to_calls.append(
                 unittest.mock.call(symlink_source_path,
-                                   target=library[compilesketches.CompileSketches.dependency_source_path_key],
+                                   target=compilesketches.absolute_path(
+                                       library[compilesketches.CompileSketches.dependency_source_path_key]
+                                   ),
                                    target_is_directory=True))
 
         # noinspection PyUnresolvedReferences
@@ -1500,22 +1502,47 @@ def test_parse_boolean_input(boolean_input, expected_output):
     assert compilesketches.parse_boolean_input(boolean_input=boolean_input) == expected_output
 
 
-def test_path_relative_to_workspace(monkeypatch):
+@pytest.mark.parametrize("path, expected_relative_path",
+                         # Path under workspace
+                         [("/fooWorkspace/baz", pathlib.PurePath("baz")),
+                          # Path outside workspace
+                          ("/bar/foo", pathlib.Path("/").resolve().joinpath("bar", "foo"))])
+def test_path_relative_to_workspace(monkeypatch, path, expected_relative_path):
     monkeypatch.setenv("GITHUB_WORKSPACE", "/fooWorkspace")
 
-    assert compilesketches.path_relative_to_workspace(path=pathlib.PurePath("/fooWorkspace", "baz")
-                                                      ) == pathlib.PurePath("baz")
-    assert compilesketches.path_relative_to_workspace(path="/fooWorkspace/baz") == pathlib.PurePath("baz")
-    # Test path outside workspace
-    assert compilesketches.path_relative_to_workspace(path="/bar/foo") == pathlib.PurePath("/bar/foo")
+    assert compilesketches.path_relative_to_workspace(path=path) == expected_relative_path
+    assert compilesketches.path_relative_to_workspace(path=pathlib.PurePath(path)) == expected_relative_path
 
 
-@pytest.mark.parametrize("path, expected_absolute_path", [("/asdf", "/asdf"), ("asdf", "/fooWorkspace/asdf")])
+@pytest.mark.parametrize("path, expected_absolute_path",
+                         # Absolute path
+                         [("/asdf", pathlib.Path("/").resolve().joinpath("asdf")),
+                          # Relative path
+                          ("asdf", pathlib.Path("/").resolve().joinpath("fooWorkspace", "asdf")),
+                          # Use of ~
+                          ("~/foo", pathlib.Path.home().joinpath("foo")),
+                          # Use of ..
+                          ("/foo/bar/../baz", pathlib.Path("/").resolve().joinpath("foo", "baz"))
+                          ])
 def test_absolute_path(monkeypatch, path, expected_absolute_path):
     monkeypatch.setenv("GITHUB_WORKSPACE", "/fooWorkspace")
 
-    assert compilesketches.absolute_path(path=path) == pathlib.PurePath(expected_absolute_path)
-    assert compilesketches.absolute_path(path=pathlib.PurePath(path)) == pathlib.PurePath(expected_absolute_path)
+    assert compilesketches.absolute_path(path=path) == expected_absolute_path
+    assert compilesketches.absolute_path(path=pathlib.PurePath(path)) == expected_absolute_path
+
+
+@pytest.mark.parametrize(
+    "path, expected_path",
+    [("foo/bar-relative-path", pathlib.PurePath("foo/bar-relative-path")),
+     ("/foo/bar-absolute-path", pathlib.Path("/").resolve().joinpath("foo", "bar-absolute-path"))]
+)
+def test_absolute_relative_path_conversion(monkeypatch, path, expected_path):
+    monkeypatch.setenv("GITHUB_WORKSPACE", "/fooWorkspace")
+    assert compilesketches.path_relative_to_workspace(
+        path=compilesketches.absolute_path(
+            path=path
+        )
+    ) == expected_path
 
 
 def test_list_to_string():