feat(spack_operation): implement setup_spack_env functionality

Following changes have been incorporated:

• SpackOperation.py: The handle_result and trust_gpg_key methods were specifically updated with tests and docstrings. Also modified the add_mirror method as per the changes.
• SpackOperationUseCache.py: Similar to SpackOperation.py, this file also got enhanced tests and docstrings, specifically for the setup_spack_env method. The focus is on setting up the environment for a user spack cache setup along with testing of the caching behavior and improving documentation.
• BuildCacheManager.py: This file saw improvements in its test suite and the addition of docstrings. The tests likely cover various cache operations, and the docstrings explain the purpose and usage of the cache management methods. The get_public_key_from_cache, download, _log_warning_if_needed, and other methods were updated with tests and docstrings.
• .gitlab-ci.yml: Changes likely include adding or modifying stages for running the new pytest tests and generating coverage reports.
• pyproject.toml: This file was modified to add testing dependencies required for the enhanced test suite. Specifically, pytest, pytest-mock, pytest-ordering, and coverage were added under the test extra. This change enables running the new tests and generating coverage reports.

The commands folder implements a command execution and management system, especially for Spack, using these key components and patterns:

• Command Definitions (Enum/Constants): command_enum.py likely defines an enumeration (or constants) representing different commands. This promotes type safety and avoids stringly-typed code.

• Command Sequence Builder: command_sequence_builder.py implements the Builder Pattern to construct CommandSequence objects (from command_sequence.py). This allows for flexible and readable creation of complex command sequences.

• Command Sequence: command_sequence.py represents a sequence of commands to be executed. It encapsulates the order and configuration of commands.

• Spack Command Factory: spack_command_sequence_factory.py uses the Factory Pattern to create Spack-specific CommandSequence objects. This centralizes the creation logic for different Spack commands and simplifies their usage. It likely uses command_sequence_builder.py internally.

• Generic Command Runner: A command_runner.py (implied, not explicitly mentioned in the diff) likely handles the actual execution of commands, possibly using subprocesses. This abstracts the execution details from the command sequence logic.

• Bash Command Executor: Executes a sequence of commands in a Bash shell, handling various potential errors and returning the output and error message (if any).

• Focus on Spack: The structure strongly suggests a focus on managing Spack environments and packages. The factory and command definitions likely reflect common Spack operations.

Patterns used:

• Enum/Constants Pattern: Used for defining distinct command types.
• Builder Pattern: Used for constructing command sequences.
• Factory Pattern: Used for creating Spack-specific command sequences.
• Command Pattern: A close variant of the Command Pattern for encapsulating command execution. Abstraction of shell commands along with an invoker (command_runner) been implemented

Parent artefact: https://tvb-projects.atlassian.net/browse/VT-70

dedal/tests/unit_tests/test_build_cache_manager.py

@@ -60,12 +60,16 @@ class TestBuildCacheManager:
         result = mock_build_cache_manager.get_public_key_from_cache(str(build_cache_dir))
 
         # Assert
+        # Cannot assure the order in which the OS returns the files,
+        # hence check if the result is in the expected list
         assert result in [str(build_cache_dir / "project0" / "_pgp" / "key0.pub"),
                           str(build_cache_dir / "project0" / "_pgp" / "key1.pub"),
                           str(build_cache_dir / "project1" / "_pgp" / "key0.pub")]
-        log = (expected_log_message, pgp_folders, pgp_folders[0]) if test_id == "more_than_one_gpg_folder" else (
-            expected_log_message, key_files, key_files[0])
-        mock_build_cache_manager._logger.warning.assert_called_once_with(*log)
+        assert mock_build_cache_manager._logger.warning.call_args[0][0] == expected_log_message
+        assert set(mock_build_cache_manager._logger.warning.call_args[0][1]) == set(
+            pgp_folders) if test_id == "more_than_one_gpg_folder" else set(key_files)
+        assert mock_build_cache_manager._logger.warning.call_args[0][
+                   2] in pgp_folders if test_id == "more_than_one_gpg_folder" else key_files
 
     @pytest.mark.parametrize("build_cache_dir, expected_log_message", [
         (None, 'Build cache directory does not exist!'),