Move sync command integration tests to a dedicated file

Previously, the tool's command line interface was only ever intended to provide the "sync" functionality so a single
"all" integration test file was reasonable. Now that additional distinct command line functionality is planned, it will
be better to separate the integration tests into multiple files to make it easier for the developer to navigate the code.

Author: per1234

.prettierignore

@@ -1,3 +1,3 @@
 # See: https://prettier.io/docs/en/ignore.html#ignoring-files-prettierignore
 
-/test/testdata/test_all/golden/logs/
+/test/testdata/test_sync/golden/logs/

test/conftest.py

@@ -0,0 +1,83 @@
+# 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 program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+#
+# 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 pytest
+import pathlib
+import platform
+import typing
+import invoke.context
+import json
+
+
+@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 / "libraries-repository-engine"
+
+    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="TestWorkingDir")
+    yield str(work_dir)

test/test_all.py renamed to test/test_sync.py

@@ -1,5 +1,3 @@
-# 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 program is free software: you can redistribute it and/or modify
@@ -27,18 +25,13 @@
 import hashlib
 import json
 import pathlib
-import platform
-import typing
 import math
 
-import invoke.context
-import pytest
-
 test_data_path = pathlib.Path(__file__).resolve().parent.joinpath("testdata")
 size_comparison_tolerance = 0.03  # Maximum allowed archive size difference ratio
 
 
-def test_all(run_command, working_dir):
+def test_sync(run_command, working_dir):
     working_dir_path = pathlib.Path(working_dir)
     configuration = {
         "BaseDownloadUrl": "http://www.example.com/libraries/",
@@ -62,7 +55,7 @@ def test_all(run_command, working_dir):
         "sync",
         "--config-file",
         working_dir_path.joinpath("config.json"),
-        test_data_path.joinpath("test_all", "repos.txt"),
+        test_data_path.joinpath("test_sync", "repos.txt"),
     ]
 
     # Run the engine
@@ -73,12 +66,12 @@ def test_all(run_command, working_dir):
     check_libraries(configuration=configuration)
     check_logs(
         configuration=configuration,
-        golden_logs_parent_path=test_data_path.joinpath("test_all", "golden", "logs", "generate"),
+        golden_logs_parent_path=test_data_path.joinpath("test_sync", "golden", "logs", "generate"),
         logs_subpath=pathlib.Path("github.com", "arduino-libraries", "ArduinoCloudThing", "index.html"),
     )
     check_logs(
         configuration=configuration,
-        golden_logs_parent_path=test_data_path.joinpath("test_all", "golden", "logs", "generate"),
+        golden_logs_parent_path=test_data_path.joinpath("test_sync", "golden", "logs", "generate"),
         logs_subpath=pathlib.Path("github.com", "arduino-libraries", "SpacebrewYun", "index.html"),
     )
     check_db(configuration=configuration)
@@ -92,12 +85,12 @@ def test_all(run_command, working_dir):
     check_libraries(configuration=configuration)
     check_logs(
         configuration=configuration,
-        golden_logs_parent_path=test_data_path.joinpath("test_all", "golden", "logs", "update"),
+        golden_logs_parent_path=test_data_path.joinpath("test_sync", "golden", "logs", "update"),
         logs_subpath=pathlib.Path("github.com", "arduino-libraries", "ArduinoCloudThing", "index.html"),
     )
     check_logs(
         configuration=configuration,
-        golden_logs_parent_path=test_data_path.joinpath("test_all", "golden", "logs", "update"),
+        golden_logs_parent_path=test_data_path.joinpath("test_sync", "golden", "logs", "update"),
         logs_subpath=pathlib.Path("github.com", "arduino-libraries", "SpacebrewYun", "index.html"),
     )
     check_db(configuration=configuration)
@@ -190,7 +183,7 @@ def check_db(configuration):
         release["Log"] = "\n".join([line.rstrip() for line in release["Log"].splitlines()])
 
     # Load golden db
-    golden_db_template = test_data_path.joinpath("test_all", "golden", "db.json").read_text(encoding="utf-8")
+    golden_db_template = test_data_path.joinpath("test_sync", "golden", "db.json").read_text(encoding="utf-8")
     # Fill in mutable content
     golden_db_string = string.Template(template=golden_db_template).substitute(
         base_download_url=configuration["BaseDownloadUrl"],
@@ -248,7 +241,7 @@ def check_index(configuration):
         release["checksum"] = checksum_placeholder
 
     # Load golden index
-    golden_library_index_template = test_data_path.joinpath("test_all", "golden", "library_index.json").read_text(
+    golden_library_index_template = test_data_path.joinpath("test_sync", "golden", "library_index.json").read_text(
         encoding="utf-8"
     )
     # Fill in mutable content
@@ -319,57 +312,3 @@ def test_clean_checkout(run_command, working_dir):
     for release in library_index["libraries"]:
         # ssd1306@1.0.0 contains a .exe and so should fail validation.
         assert not (release["name"] == "ssd1306" and release["version"] == "1.0.0")
-
-
-@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 / "libraries-repository-engine"
-
-    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="TestWorkingDir")
-    yield str(work_dir)