Make engine configuration fixture for integration tests

This will make writing tests easier and avoid code duplication.

Author: per1234

test/conftest.py

@@ -29,6 +29,46 @@
 import json
 
 
+@pytest.fixture
+def configuration(working_dir):
+    """Create a libraries-repository-engine configuration file and return an object containing its data and path."""
+    working_dir_path = pathlib.Path(working_dir)
+
+    # This is based on the `Librariesv2` production job's config.
+    data = {
+        "BaseDownloadUrl": "https://downloads.arduino.cc/libraries/",
+        "LibrariesFolder": working_dir_path.joinpath("libraries").as_posix(),
+        "LogsFolder": working_dir_path.joinpath("ci-logs", "libraries", "logs").as_posix(),
+        "LibrariesDB": working_dir_path.joinpath("db.json").as_posix(),
+        "LibrariesIndex": working_dir_path.joinpath("libraries", "library_index.json").as_posix(),
+        "GitClonesFolder": working_dir_path.joinpath("gitclones").as_posix(),
+        # I was unable to get clamdscan working in the GitHub Actions runner, but the tests should pass with this set to
+        # False when run on a machine with ClamAV installed.
+        "DoNotRunClamav": True,
+        # Arduino Lint should be installed under PATH
+        "ArduinoLintPath": "",
+    }
+
+    # Generate configuration file
+    path = working_dir_path.joinpath("config.json")
+    with path.open("w", encoding="utf-8") as configuration_file:
+        json.dump(obj=data, fp=configuration_file, indent=2)
+
+    class Object:
+        """Container for libraries-repository-engine configuration data.
+
+        Keyword arguments:
+        data -- dictionary of configuration data
+        path -- path of the configuration file
+        """
+
+        def __init__(self, data, path):
+            self.data = data
+            self.path = path
+
+    return Object(data=data, path=path)
+
+
 @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.

test/test_sync.py

@@ -31,30 +31,11 @@
 size_comparison_tolerance = 0.03  # Maximum allowed archive size difference ratio
 
 
-def test_sync(run_command, working_dir):
-    working_dir_path = pathlib.Path(working_dir)
-    configuration = {
-        "BaseDownloadUrl": "http://www.example.com/libraries/",
-        "LibrariesFolder": working_dir_path.joinpath("libraries").as_posix(),
-        "LogsFolder": working_dir_path.joinpath("logs").as_posix(),
-        "LibrariesDB": working_dir_path.joinpath("libraries_db.json").as_posix(),
-        "LibrariesIndex": working_dir_path.joinpath("libraries", "library_index.json").as_posix(),
-        "GitClonesFolder": working_dir_path.joinpath("gitclones").as_posix(),
-        # I was unable to get clamdscan working in the GitHub Actions runner, but the tests should pass with this set to
-        # False when run on a machine with ClamAV installed.
-        "DoNotRunClamav": True,
-        # Arduino Lint should be installed under PATH
-        "ArduinoLintPath": "",
-    }
-
-    # Generate configuration file
-    with working_dir_path.joinpath("config.json").open("w", encoding="utf-8") as configuration_file:
-        json.dump(obj=configuration, fp=configuration_file, indent=2)
-
+def test_sync(configuration, run_command):
     libraries_repository_engine_command = [
         "sync",
         "--config-file",
-        working_dir_path.joinpath("config.json"),
+        configuration.path,
         test_data_path.joinpath("test_sync", "repos.txt"),
     ]
 
@@ -63,38 +44,38 @@ def test_sync(run_command, working_dir):
     assert result.ok
 
     # Test fresh output
-    check_libraries(configuration=configuration)
+    check_libraries(configuration=configuration.data)
     check_logs(
-        configuration=configuration,
+        configuration=configuration.data,
         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,
+        configuration=configuration.data,
         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)
-    check_index(configuration=configuration)
+    check_db(configuration=configuration.data)
+    check_index(configuration=configuration.data)
 
     # Run the engine again
     result = run_command(cmd=libraries_repository_engine_command)
     assert result.ok
 
     # Test the updated output
-    check_libraries(configuration=configuration)
+    check_libraries(configuration=configuration.data)
     check_logs(
-        configuration=configuration,
+        configuration=configuration.data,
         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,
+        configuration=configuration.data,
         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)
-    check_index(configuration=configuration)
+    check_db(configuration=configuration.data)
+    check_index(configuration=configuration.data)
 
 
 def check_libraries(configuration):
@@ -276,28 +257,11 @@ def check_index(configuration):
 
 
 # The engine's Git code struggles to get a clean checkout of releases under some circumstances.
-def test_clean_checkout(run_command, working_dir):
-    working_dir_path = pathlib.Path(working_dir)
-    configuration = {
-        "BaseDownloadUrl": "http://www.example.com/libraries/",
-        "LibrariesFolder": working_dir_path.joinpath("libraries").as_posix(),
-        "LogsFolder": working_dir_path.joinpath("logs").as_posix(),
-        "LibrariesDB": working_dir_path.joinpath("libraries_db.json").as_posix(),
-        "LibrariesIndex": working_dir_path.joinpath("libraries", "library_index.json").as_posix(),
-        "GitClonesFolder": working_dir_path.joinpath("gitclones").as_posix(),
-        "DoNotRunClamav": True,
-        # Arduino Lint should be installed under PATH
-        "ArduinoLintPath": "",
-    }
-
-    # Generate configuration file
-    with working_dir_path.joinpath("config.json").open("w", encoding="utf-8") as configuration_file:
-        json.dump(obj=configuration, fp=configuration_file, indent=2)
-
+def test_clean_checkout(configuration, run_command):
     libraries_repository_engine_command = [
         "sync",
         "--config-file",
-        working_dir_path.joinpath("config.json"),
+        configuration.path,
         test_data_path.joinpath("test_clean_checkout", "repos.txt"),
     ]
 
@@ -306,7 +270,7 @@ def test_clean_checkout(run_command, working_dir):
     assert result.ok
 
     # Load generated index
-    with pathlib.Path(configuration["LibrariesIndex"]).open(mode="r", encoding="utf-8") as library_index_file:
+    with pathlib.Path(configuration.data["LibrariesIndex"]).open(mode="r", encoding="utf-8") as library_index_file:
         library_index = json.load(fp=library_index_file)
 
     for release in library_index["libraries"]: