🐛 Fixed plugin loader (#61)

<!--
Copyright (C) 2020-2022 Arm Limited or its affiliates and Contributors.
All rights reserved.
SPDX-License-Identifier: Apache-2.0
-->
### Description

- Fixed plugin loader
- Added a basic plugin
- redefined the NoOp plugin



### Test Coverage

<!--
Please put an `x` in the correct box e.g. `[x]` to indicate the testing
coverage of this change.
-->

- [x]  This change is covered by existing or additional automated tests.
- [ ] Manual testing has been performed (and evidence provided) as
automated testing was not feasible.
- [ ] Additional tests are not required for this change (e.g.
documentation update).

Author: acabarbaye

.secrets.baseline

@@ -107,7 +107,7 @@
         "filename": "continuous_delivery_scripts/plugins/python.py",
         "hashed_secret": "a5c8a5463c338b832f4afbe616ae77b4ecbfadc0",
         "is_verified": false,
-        "line_number": 27
+        "line_number": 26
       }
     ],
     "continuous_delivery_scripts/utils/git_helpers.py": [
@@ -425,5 +425,5 @@
       }
     ]
   },
-  "generated_at": "2022-12-21T20:50:40Z"
+  "generated_at": "2022-12-22T00:31:43Z"
 }

continuous_delivery_scripts/language_specifics.py

@@ -5,7 +5,7 @@
 """Language plugins Loader."""
 
 import logging
-from typing import Optional, Dict, cast
+from typing import Optional, Dict, cast, Set, Type
 
 from continuous_delivery_scripts.utils.configuration import configuration, ConfigurationVariable
 from continuous_delivery_scripts.utils.language_specifics_base import BaseLanguage
@@ -16,24 +16,48 @@
 logger = logging.getLogger(__name__)
 
 
-def _all_language_plugins() -> Dict[str, BaseLanguage]:
-    """Get all language plugins which inherit from BaseLanguage (with the exception of other base class).
+def _retrieve_all_subclasses(subclass: Type[BaseLanguage]) -> Set[Type[BaseLanguage]]:
+    subclasses = set()
+    if not subclass:
+        return subclasses
+    if subclass != BaseLanguage:
+        subclasses.add(subclass)
+    for s in subclass.__subclasses__():
+        subclasses.update(_retrieve_all_subclasses(s))
+    return subclasses
 
-    :return: A list of classes containing language plugins
+
+def all_language_plugins() -> Dict[str, BaseLanguage]:
+    """Fetches all language plugins which inherit from BaseLanguage.
+
+    Returns:
+         A list of classes containing language plugins
+    """
+    all_plugins = _retrieve_all_subclasses(BaseLanguage)
+    return {la.get_related_language().lower().strip(): la for la in [lang() for lang in all_plugins]}  # type: ignore
+
+
+def fetch_project_language_plugin(all_plugins: Dict[str, BaseLanguage], language: str) -> BaseLanguage:
+    """Fetches a language CD flow.
+
+    Arguments:
+        all_plugins: all the plugins at disposal
+        language: the language to select
+
+    Returns:
+         A language plugin corresponding to the language requested
     """
-    all_plugins = BaseLanguage.__subclasses__()
-    return {
-        la.get_related_language().lower().strip(): la
-        for la in [lang() for lang in all_plugins if lang != BaseLanguage]  # type: ignore
-    }
+    return cast(BaseLanguage, all_plugins.get(_sanitise_program_language(language)))
 
 
-def _sanitise_program_language() -> str:
-    return str(configuration.get_value(ConfigurationVariable.PROGRAMMING_LANGUAGE)).lower().strip()
+def _sanitise_program_language(language: str) -> str:
+    return language.lower().strip()
 
 
 def _fetch_project_language_specifics() -> BaseLanguage:
-    return cast(BaseLanguage, _all_language_plugins().get(_sanitise_program_language()))
+    return fetch_project_language_plugin(
+        all_language_plugins(), str(configuration.get_value(ConfigurationVariable.PROGRAMMING_LANGUAGE))
+    )
 
 
 class PluginLoader:

continuous_delivery_scripts/plugins/BASIC.MD

@@ -0,0 +1,9 @@
+# Basic plugin
+
+This plugin is used for simple git projects when `PROGRAMMING_LANGUAGE` is set to `basic`.
+
+## Release
+Only basic git operations (tagging, version incrementation, changelog commit) are performed
+
+## Documentation
+N/A

continuous_delivery_scripts/plugins/__init__.py

@@ -4,10 +4,11 @@
 #
 """Language specific actions."""
 import glob
-import os
+from pathlib import Path
 
 all_plugin_files = [
-    os.path.splitext(os.path.basename(filename))[0]
-    for filename in glob.glob(os.path.join(os.path.dirname(__file__), "*.py"))
+    Path(filename).stem
+    for filename in glob.glob(str(Path(__file__).parent.joinpath("*.py")))
+    if not filename.endswith("__init__.py")
 ]
 __all__ = all_plugin_files

continuous_delivery_scripts/plugins/basic.py

@@ -0,0 +1,50 @@
+#
+# Copyright (C) 2020-2022 Arm Limited or its affiliates and Contributors. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+#
+"""Basic plugin."""
+import logging
+from pathlib import Path
+from typing import Optional
+
+from continuous_delivery_scripts.spdx_report.spdx_project import SpdxProject
+from continuous_delivery_scripts.utils.definitions import CommitType
+from continuous_delivery_scripts.utils.language_specifics_base import BaseLanguage, get_language_from_file_name
+
+logger = logging.getLogger(__name__)
+
+
+class Basic(BaseLanguage):
+    """Specific actions for a Basic project."""
+
+    def get_related_language(self) -> str:
+        """Gets the related language."""
+        return get_language_from_file_name(__file__)
+
+    def package_software(self, mode: CommitType, version: str) -> None:
+        """Basic."""
+        super().package_software(mode, version)
+
+    def release_package_to_repository(self, mode: CommitType, version: str) -> None:
+        """Basic."""
+        super().release_package_to_repository(mode, version)
+
+    def check_credentials(self) -> None:
+        """Basic."""
+        super().check_credentials()
+
+    def generate_code_documentation(self, output_directory: Path, module_to_document: str) -> None:
+        """Basic."""
+        super().generate_code_documentation(output_directory, module_to_document)
+
+    def can_add_licence_headers(self) -> bool:
+        """Basic."""
+        return False
+
+    def can_get_project_metadata(self) -> bool:
+        """States whether project metadata can be retrieved."""
+        return False
+
+    def get_current_spdx_project(self) -> Optional[SpdxProject]:
+        """Basic."""
+        return None

continuous_delivery_scripts/plugins/ci.py

@@ -5,12 +5,11 @@
 """Plugin for CI projects."""
 import logging
 from pathlib import Path
-from typing import Optional, Dict
+from typing import Optional
 
 from continuous_delivery_scripts.spdx_report.spdx_project import SpdxProject
 from continuous_delivery_scripts.utils.configuration import configuration, ConfigurationVariable
 from continuous_delivery_scripts.utils.definitions import CommitType
-from continuous_delivery_scripts.utils.git_helpers import GitWrapper
 from continuous_delivery_scripts.utils.language_specifics_base import BaseLanguage, get_language_from_file_name
 
 logger = logging.getLogger(__name__)
@@ -25,8 +24,7 @@ def package_software(self, mode: CommitType, version: str) -> None:
 
     def generate_code_documentation(self, output_directory: Path, module_to_document: str) -> None:
         """Generates the code documentation."""
-        super().generate_code_documentation(output_directory, module_to_document)
-        # Nothing to do
+        pass
 
     def get_related_language(self) -> str:
         """Gets the related language."""
@@ -62,7 +60,3 @@ def get_current_spdx_project(self) -> Optional[SpdxProject]:
     def should_clean_before_packaging(self) -> bool:
         """States whether the repository must be cleaned before packaging happens."""
         return True
-
-    def tag_release(self, git: GitWrapper, version: str, shortcuts: Dict[str, bool]) -> None:
-        """Tags release commit."""
-        super().tag_release(git, version, shortcuts)

continuous_delivery_scripts/plugins/docker.py

@@ -6,9 +6,10 @@
 import logging
 from pathlib import Path
 from typing import Optional
-from continuous_delivery_scripts.utils.language_specifics_base import BaseLanguage, get_language_from_file_name
-from continuous_delivery_scripts.utils.definitions import CommitType
+
 from continuous_delivery_scripts.spdx_report.spdx_project import SpdxProject
+from continuous_delivery_scripts.utils.definitions import CommitType
+from continuous_delivery_scripts.utils.language_specifics_base import BaseLanguage, get_language_from_file_name
 
 logger = logging.getLogger(__name__)
 

continuous_delivery_scripts/plugins/golang.py

@@ -6,13 +6,14 @@
 import logging
 import os
 from pathlib import Path
-from typing import Optional, List, Dict
 from subprocess import check_call
-from continuous_delivery_scripts.utils.language_specifics_base import BaseLanguage, get_language_from_file_name
+from typing import Optional, List, Dict
+
 from continuous_delivery_scripts.spdx_report.spdx_project import SpdxProject
 from continuous_delivery_scripts.utils.configuration import configuration, ConfigurationVariable
 from continuous_delivery_scripts.utils.definitions import CommitType
 from continuous_delivery_scripts.utils.git_helpers import LocalProjectRepository, GitWrapper
+from continuous_delivery_scripts.utils.language_specifics_base import BaseLanguage, get_language_from_file_name
 
 logger = logging.getLogger(__name__)
 

continuous_delivery_scripts/plugins/noop.py

@@ -5,11 +5,12 @@
 """No Operation plugin."""
 import logging
 from pathlib import Path
+from typing import Optional, Dict
 
 from continuous_delivery_scripts.spdx_report.spdx_project import SpdxProject
 from continuous_delivery_scripts.utils.definitions import CommitType
+from continuous_delivery_scripts.utils.git_helpers import GitWrapper
 from continuous_delivery_scripts.utils.language_specifics_base import BaseLanguage, get_language_from_file_name
-from typing import Optional
 
 logger = logging.getLogger(__name__)
 
@@ -23,19 +24,19 @@ def get_related_language(self) -> str:
 
     def package_software(self, mode: CommitType, version: str) -> None:
         """No Op."""
-        super().package_software(mode, version)
+        pass
 
     def release_package_to_repository(self, mode: CommitType, version: str) -> None:
         """No Op."""
-        super().release_package_to_repository(mode, version)
+        pass
 
     def check_credentials(self) -> None:
         """No Op."""
-        super().check_credentials()
+        pass
 
     def generate_code_documentation(self, output_directory: Path, module_to_document: str) -> None:
         """No Op."""
-        super().generate_code_documentation(output_directory, module_to_document)
+        pass
 
     def can_add_licence_headers(self) -> bool:
         """No Op."""
@@ -49,3 +50,7 @@ def can_get_project_metadata(self) -> bool:
     def get_current_spdx_project(self) -> Optional[SpdxProject]:
         """No Op."""
         return None
+
+    def tag_release(self, git: GitWrapper, version: str, shortcuts: Dict[str, bool]) -> None:
+        """Tags release commit."""
+        pass

continuous_delivery_scripts/plugins/python.py

@@ -5,18 +5,17 @@
 """Plugin for Python projects."""
 import logging
 import shutil
-
 import sys
 from pathlib import Path
+from subprocess import check_call
 from typing import List, Optional
 
-from subprocess import check_call
-from continuous_delivery_scripts.utils.language_specifics_base import BaseLanguage, get_language_from_file_name
 from continuous_delivery_scripts.spdx_report.spdx_project import SpdxProject
 from continuous_delivery_scripts.utils.configuration import configuration, ConfigurationVariable
 from continuous_delivery_scripts.utils.definitions import CommitType
 from continuous_delivery_scripts.utils.filesystem_helpers import TemporaryDirectory
 from continuous_delivery_scripts.utils.filesystem_helpers import cd
+from continuous_delivery_scripts.utils.language_specifics_base import BaseLanguage, get_language_from_file_name
 from continuous_delivery_scripts.utils.logging import log_exception
 from continuous_delivery_scripts.utils.python.package_helpers import (
     CurrentPythonProjectMetadataFetcher,