Allow installation of platform dependencies from repositories

Benefits:
- Allows testing against non-release versions of platforms.
- Allows the installation of platforms which don't have Board Manager installation support.

Author: per1234

README.md

@@ -47,6 +47,14 @@ Keys:
 - `source-path` - path to install as a platform. Relative paths are assumed to be relative to the root of the repository.
 - `name` - platform name in the form of `VENDOR:ARCHITECTURE`.
 
+##### Repository
+
+Keys:
+- `source-url` - URL to clone the repository from. It must start with `git://` or end with `.git`.
+- `version` - [Git ref](https://git-scm.com/book/en/v2/Git-Internals-Git-References) of the repository to checkout. The special version name `latest` will cause the latest tag to be used. By default, the repository will be checked out to the tip of the default branch.
+- `source-path` - path to install as a library. Paths are relative to the root of the repository. The default is to install from the root of the repository.
+- `name` - platform name in the form of `VENDOR:ARCHITECTURE`.
+
 ### `libraries`
 
 YAML-format list of library dependencies to install.

compilesketches/compilesketches.py

@@ -234,6 +234,9 @@ def install_platforms(self):
         if len(platform_list.path) > 0:
             self.install_platforms_from_path(platform_list=platform_list.path)
 
+        if len(platform_list.repository) > 0:
+            self.install_platforms_from_repository(platform_list=platform_list.repository)
+
     def get_fqbn_platform_dependency(self):
         """Return the platform dependency definition automatically generated from the FQBN."""
         # Extract the platform name from the FQBN (e.g., arduino:avr:uno => arduino:avr)
@@ -466,6 +469,30 @@ def __init__(self):
 
         return platform_installation_path
 
+    def install_platforms_from_repository(self, platform_list):
+        """Install libraries by cloning Git repositories
+
+        Keyword arguments:
+        platform_list -- list of dictionaries defining the dependencies
+        """
+        for platform in platform_list:
+            self.verbose_print("Installing platform from repository:", platform[self.dependency_source_url_key])
+
+            git_ref = self.get_repository_dependency_ref(dependency=platform)
+
+            if self.dependency_source_path_key in platform:
+                source_path = platform[self.dependency_source_path_key]
+            else:
+                source_path = "."
+
+            destination_path = self.get_platform_installation_path(platform=platform)
+
+            self.install_from_repository(url=platform[self.dependency_source_url_key],
+                                         git_ref=git_ref,
+                                         source_path=source_path,
+                                         destination_parent_path=destination_path.base,
+                                         destination_name=destination_path.platform)
+
     def get_repository_dependency_ref(self, dependency):
         """Return the appropriate git ref value for a repository dependency
 

compilesketches/tests/test_compilesketches.py

@@ -704,6 +704,59 @@ def __init__(self, stdout):
         shutil.rmtree.assert_not_called()
 
 
+def test_install_platforms_from_repository(mocker):
+    platform_list = [
+        {compilesketches.CompileSketches.dependency_source_url_key: unittest.mock.sentinel.source_url,
+         compilesketches.CompileSketches.dependency_source_path_key: unittest.mock.sentinel.source_path,
+         compilesketches.CompileSketches.dependency_destination_name_key: unittest.mock.sentinel.destination_name},
+        {compilesketches.CompileSketches.dependency_source_url_key: unittest.mock.sentinel.source_url2}
+    ]
+
+    git_ref = unittest.mock.sentinel.git_ref
+
+    class PlatformInstallationPath:
+        def __init__(self):
+            self.base = pathlib.PurePath()
+            self.platform = pathlib.PurePath()
+
+    platform_installation_path = PlatformInstallationPath()
+    platform_installation_path.base = pathlib.Path("/foo/PlatformInstallationPathParent")
+    platform_installation_path.platform = pathlib.Path("PlatformInstallationPathName")
+
+    expected_source_path_list = [unittest.mock.sentinel.source_path, "."]
+    expected_destination_name_list = [unittest.mock.sentinel.destination_name, None]
+
+    compile_sketches = get_compilesketches_object()
+
+    mocker.patch("compilesketches.CompileSketches.get_repository_dependency_ref", autospec=True, return_value=git_ref)
+    mocker.patch("compilesketches.CompileSketches.get_platform_installation_path",
+                 autospec=True,
+                 return_value=platform_installation_path)
+    mocker.patch("compilesketches.CompileSketches.install_from_repository", autospec=True, return_value=git_ref)
+
+    compile_sketches.install_platforms_from_repository(platform_list=platform_list)
+
+    get_repository_dependency_ref_calls = []
+    get_platform_installation_path_calls = []
+    install_from_repository_calls = []
+    for platform, expected_source_path, expected_destination_name in zip(platform_list,
+                                                                         expected_source_path_list,
+                                                                         expected_destination_name_list):
+        get_repository_dependency_ref_calls.append(unittest.mock.call(compile_sketches, dependency=platform))
+        get_platform_installation_path_calls.append(unittest.mock.call(compile_sketches, platform=platform))
+        install_from_repository_calls.append(
+            unittest.mock.call(compile_sketches,
+                               url=platform[compilesketches.CompileSketches.dependency_source_url_key],
+                               git_ref=git_ref,
+                               source_path=expected_source_path,
+                               destination_parent_path=platform_installation_path.base,
+                               destination_name=platform_installation_path.platform)
+        )
+
+    compile_sketches.get_repository_dependency_ref.assert_has_calls(calls=get_repository_dependency_ref_calls)
+    compile_sketches.install_from_repository.assert_has_calls(calls=install_from_repository_calls)
+
+
 @pytest.mark.parametrize(
     "dependency, expected_ref",
     [({compilesketches.CompileSketches.dependency_version_key: "1.2.3"}, "1.2.3"),