Add registry validator integration tests

On every push and pull request that affects relevant files, run the integration tests of the registry data file validator.

.github/workflows/assets/validate-registry/tests/__init__.py

@@ -0,0 +1,13 @@
+# Source:
+# https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/test-python/__init__.py
+# Copyright 2021 ARDUINO SA (http://www.arduino.cc/)
+#
+# This software is released under the GNU General Public License version 3,
+# The terms of this license can be found at:
+# https: // www.gnu.org/licenses/gpl-3.0.en.html
+#
+# You can be released from the requirements of the above licenses by purchasing
+# a commercial license. Buying such a license is mandatory if you want to
+# modify or otherwise use the software for commercial activities involving the
+# Arduino software without disclosing the source code of your own applications.
+# To purchase a commercial license, send an email to license@arduino.cc.

.github/workflows/assets/validate-registry/tests/pytest.ini

@@ -0,0 +1,10 @@
+# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/test-python/pytest.ini
+[pytest]
+filterwarnings =
+    error
+    ignore::DeprecationWarning
+    ignore::ResourceWarning
+
+# --capture=no - disable per-test capture
+# --tb=long sets the length of the traceback in case of failures
+addopts = --capture=no --tb=long --verbose

.github/workflows/assets/validate-registry/tests/test_all.py

@@ -0,0 +1,94 @@
+# Source:
+# https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/test-integration/test_all.py
+# Copyright 2021 ARDUINO SA (http://www.arduino.cc/)
+#
+# This software is released under the GNU General Public License version 3,
+# The terms of this license can be found at:
+# https: // www.gnu.org/licenses/gpl-3.0.en.html
+#
+# You can be released from the requirements of the above licenses by purchasing
+# a commercial license. Buying such a license is mandatory if you want to
+# modify or otherwise use the software for commercial activities involving the
+# Arduino software without disclosing the source code of your own applications.
+# To purchase a commercial license, send an email to license@arduino.cc.
+import os
+import pathlib
+import platform
+import shutil
+import typing
+
+import invoke.context
+import pytest
+
+test_data_path = pathlib.Path(__file__).resolve().parent.joinpath("testdata")
+
+
+@pytest.mark.parametrize(
+    "test_file, success_assertion",
+    [
+        ("", False),
+        ("nonexistent.txt", False),
+        ("invalid-data-format.txt", False),
+        ("invalid-url-format.txt", False),
+        ("duplicate-url.txt", False),
+        ("valid.txt", True),
+    ],
+)
+def test_all(run_command, test_file, success_assertion):
+    result = run_command(cmd=[test_data_path.joinpath(test_file)])
+    assert result.ok == success_assertion
+
+
+@pytest.fixture(scope="function")
+def run_command(pytestconfig, working_dir) -> typing.Callable[..., invoke.runners.Result]:
+    """Provide a wrapper around invoke's `run` API so that every test will work in the same temporary folder.
+
+    Useful reference:
+        http://docs.pyinvoke.org/en/1.4/api/runners.html#invoke.runners.Result
+    """
+
+    executable_path = pathlib.Path(pytestconfig.rootdir).parent / "validate-registry"
+
+    def _run(
+        cmd: list,
+        custom_working_dir: typing.Optional[str] = None,
+        custom_env: typing.Optional[dict] = None,
+    ) -> invoke.runners.Result:
+        if cmd is None:
+            cmd = []
+        if not custom_working_dir:
+            custom_working_dir = working_dir
+        quoted_cmd = []
+        for token in cmd:
+            quoted_cmd.append(f'"{token}"')
+        cli_full_line = '"{}" {}'.format(executable_path, " ".join(quoted_cmd))
+        run_context = invoke.context.Context()
+        # It might happen that we need to change directories between drives on Windows,
+        # in that case the "/d" flag must be used otherwise directory wouldn't change
+        cd_command = "cd"
+        if platform.system() == "Windows":
+            cd_command += " /d"
+        # Context.cd() is not used since it doesn't work correctly on Windows.
+        # It escapes spaces in the path using "\ " but it doesn't always work,
+        # wrapping the path in quotation marks is the safest approach
+        with run_context.prefix(f'{cd_command} "{custom_working_dir}"'):
+            return run_context.run(
+                command=cli_full_line,
+                echo=False,
+                hide=True,
+                warn=True,
+                env=custom_env,
+                encoding="utf-8",
+            )
+
+    return _run
+
+
+@pytest.fixture(scope="function")
+def working_dir(tmpdir_factory) -> str:
+    """Create a temporary folder for the test to run in. It will be created before running each test and deleted at the
+    end. This way all the tests work in isolation.
+    """
+    work_dir = tmpdir_factory.mktemp(basename="IntegrationTestWorkingDir")
+    yield os.path.realpath(work_dir)
+    shutil.rmtree(work_dir, ignore_errors=True)

.github/workflows/assets/validate-registry/tests/testdata/duplicate-url.txt

@@ -0,0 +1,4 @@
+https://github.com/arduino-libraries/Scheduler.git|Arduino|Scheduler
+https://github.com/arduino-libraries/SD.git|Partner|SD
+https://github.com/arduino-libraries/Servo.git|Recommended|Servo
+https://github.com/arduino-libraries/SD.git|Contributed|Foo

.github/workflows/assets/validate-registry/tests/testdata/invalid-data-format.txt

@@ -0,0 +1,3 @@
+https://github.com/arduino-libraries/Scheduler.git|Arduino|Scheduler
+https://github.com/arduino-libraries/SD.git|Partner;SD
+https://github.com/arduino-libraries/Servo.git|Recommended|Servo

.github/workflows/assets/validate-registry/tests/testdata/invalid-url-format.txt

@@ -0,0 +1,3 @@
+https://github.com/arduino-libraries/Scheduler.git|Arduino|Scheduler
+https://github.com/arduino-libraries/SD|Partner|SD
+https://github.com/arduino-libraries/Servo.git|Recommended|Servo

.github/workflows/assets/validate-registry/tests/testdata/valid.txt

@@ -0,0 +1,3 @@
+https://github.com/arduino-libraries/Scheduler.git|Arduino|Scheduler
+https://github.com/arduino-libraries/SD.git|Partner|SD
+https://github.com/arduino-libraries/Servo.git|Recommended|Servo

.github/workflows/test-go-integration-task.yml

@@ -0,0 +1,63 @@
+# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/test-go-integration-task.md
+name: Test Integration
+
+env:
+  # See: https://github.com/actions/setup-go/tree/v2#readme
+  GO_VERSION: "1.14"
+  # See: https://github.com/actions/setup-python/tree/v2#available-versions-of-python
+  PYTHON_VERSION: "3.9"
+
+# See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows
+on:
+  push:
+    paths:
+      - ".github/workflows/test-go-integration-task.ya?ml"
+      - "Taskfile.ya?ml"
+      - "**.go"
+      - "**/go.mod"
+      - "**/go.sum"
+      - "poetry.lock"
+      - "pyproject.toml"
+      - ".github/workflows/assets/validate-registry/tests/**"
+  pull_request:
+    paths:
+      - ".github/workflows/test-go-integration-task.ya?ml"
+      - "Taskfile.ya?ml"
+      - "**.go"
+      - "**/go.mod"
+      - "**/go.sum"
+      - "poetry.lock"
+      - "pyproject.toml"
+      - ".github/workflows/assets/validate-registry/tests/**"
+  workflow_dispatch:
+  repository_dispatch:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      - name: Install Go
+        uses: actions/setup-go@v2
+        with:
+          go-version: ${{ env.GO_VERSION }}
+
+      - name: Install Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+
+      - name: Install Poetry
+        run: pip install poetry
+
+      - name: Install Taskfile
+        uses: arduino/setup-task@v1
+        with:
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+          version: 3.x
+
+      - name: Run integration tests
+        run: task go:test-integration