Added a golang plugin (#21)

Author: acabarbaye

continuous_delivery_scripts/plugins/GOLAND.MD

@@ -0,0 +1,12 @@
+# Golang plugin
+
+This plugin is used for golang projects when `PROGRAMMING_LANGUAGE` is set to `golang`.
+
+In order to work, `go > 1.16` is required.
+
+## Release
+The plugin leverages [goreleaser](https://goreleaser.com/) to package and release projects.
+Therefore, a `.goreleaser.yml` file must be present in the go source directory i.e. where the mod file lies.
+
+## Documentation
+The plugin uses [golds](https://github.com/go101/golds) to generate the code reference documentation.

continuous_delivery_scripts/plugins/NOOP.MD

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

continuous_delivery_scripts/plugins/PYTHON.MD

@@ -0,0 +1,14 @@
+# Python plugin
+
+This plugin is used for python projects when `PROGRAMMING_LANGUAGE` is set to `python`.
+
+## Release
+The plugin uses `wheel` to package the project before releasing it. 
+
+The plugin uses twine to release packages to PYPI.
+For that purpose, two environment variables need to be set:
+- `TWINE_USERNAME`: the username of the PYPI account
+- `TWINE_PASSWORD`: the password of the PYPI account
+
+## Documentation
+The plugin uses [pdoc](https://pdoc3.github.io/pdoc/) to generate the code reference documentation

continuous_delivery_scripts/plugins/docker.py

@@ -19,13 +19,13 @@ def get_related_language(self) -> str:
         """Gets the related language."""
         return get_language_from_file_name(__file__)
 
-    def package_software(self) -> None:
+    def package_software(self, version: str) -> None:
         """Todo build docker image."""
-        super().package_software()
+        super().package_software(version)
 
-    def release_package_to_repository(self) -> None:
+    def release_package_to_repository(self, version: str) -> None:
         """Todo push image to repository e.g. ecr, artifactory."""
-        super().release_package_to_repository()
+        super().release_package_to_repository(version)
 
     def check_credentials(self) -> None:
         """Checks any credentials."""

continuous_delivery_scripts/plugins/golang.py

@@ -4,13 +4,80 @@
 #
 """Plugin for Golang projects."""
 import logging
+import os
 from pathlib import Path
-from typing import Optional
+from typing import Optional, List
+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
 
 logger = logging.getLogger(__name__)
 
+SRC_DIR = configuration.get_value(ConfigurationVariable.SOURCE_DIR)
+ENVVAR_GORELEASER_GIT_TOKEN = "GITHUB_TOKEN"
+ENVVAR_GORELEASER_CUSTOMISED_TAG = "GORELEASER_CURRENT_TAG"
+
+
+def _generate_golds_command_list(output_directory: Path, module: str) -> List[str]:
+    return ["golds", "-gen", "-wdpkgs-listing=promoted", f"-dir={str(output_directory)}", "-nouses", f"{module}"]
+
+
+def _generate_goreleaser_release_command_list(changelog: Path) -> List[str]:
+    return [
+        "goreleaser",
+        "release",
+        "--rm-dist",
+        "--release-notes",
+        f"{str(changelog)}",
+    ]
+
+
+def _generate_goreleaser_check_command_list() -> List[str]:
+    return [
+        "goreleaser",
+        "check",
+    ]
+
+
+def _install_golds_command_list() -> List[str]:
+    return ["go", "install", "go101.org/golds@latest"]
+
+
+def _install_goreleaser_command_list() -> List[str]:
+    return ["go", "install", "github.com/goreleaser/goreleaser@latest"]
+
+
+def _call_golds(output_directory: Path, module: str) -> None:
+    """Calls Golds for generating the docs."""
+    logger.info("Installing Golds if missing.")
+    check_call(_install_golds_command_list())
+    logger.info("Creating Golds documentation.")
+    check_call(_generate_golds_command_list(output_directory, module), cwd=SRC_DIR)
+
+
+def _call_goreleaser_check(version: str) -> None:
+    """Calls go releaser check to verify configuration."""
+    logger.info("Installing GoReleaser if missing.")
+    check_call(_install_goreleaser_command_list())
+    logger.info("Checking GoReleaser configuration.")
+    env = os.environ
+    env[ENVVAR_GORELEASER_CUSTOMISED_TAG] = version
+    env[ENVVAR_GORELEASER_GIT_TOKEN] = configuration.get_value(ConfigurationVariable.GIT_TOKEN)
+    check_call(_generate_goreleaser_check_command_list(), cwd=SRC_DIR)
+
+
+def _call_goreleaser_release(version: str) -> None:
+    """Calls go releaser release to upload packages."""
+    logger.info("Installing GoReleaser if missing.")
+    check_call(_install_goreleaser_command_list())
+    logger.info("Release package.")
+    changelogPath = configuration.get_value(ConfigurationVariable.CHANGELOG_FILE_PATH)
+    env = os.environ
+    env[ENVVAR_GORELEASER_CUSTOMISED_TAG] = version
+    env[ENVVAR_GORELEASER_GIT_TOKEN] = configuration.get_value(ConfigurationVariable.GIT_TOKEN)
+    check_call(_generate_goreleaser_release_command_list(changelogPath), cwd=SRC_DIR, env=env)
+
 
 class Go(BaseLanguage):
     """Specific actions for a Golang project."""
@@ -19,22 +86,30 @@ def get_related_language(self) -> str:
         """Gets the related language."""
         return get_language_from_file_name(__file__)
 
-    def package_software(self) -> None:
+    def get_version_tag(self, version: str):
+        """Gets tag based on version."""
+        cleansed_version = version.strip().lstrip("v")
+        return f"v{cleansed_version}"
+
+    def package_software(self, version: str) -> None:
         """No operation."""
-        super().package_software()
+        super().package_software(version)
+        _call_goreleaser_check(version)
 
-    def release_package_to_repository(self) -> None:
+    def release_package_to_repository(self, version: str) -> None:
         """No operation."""
-        super().release_package_to_repository()
+        super().release_package_to_repository(version)
+        _call_goreleaser_release(version)
 
     def check_credentials(self) -> None:
         """Checks any credentials."""
         super().check_credentials()
+        configuration.get_value(ConfigurationVariable.GIT_TOKEN)
 
     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)
-        # TODO
+        _call_golds(output_directory, "./...")
 
     def can_add_licence_headers(self) -> bool:
         """States that licence headers can be added."""

continuous_delivery_scripts/plugins/noop.py

@@ -20,13 +20,13 @@ def get_related_language(self) -> str:
         """Gets the related language."""
         return get_language_from_file_name(__file__)
 
-    def package_software(self) -> None:
+    def package_software(self, version: str) -> None:
         """No Op."""
-        super().package_software()
+        super().package_software(version)
 
-    def release_package_to_repository(self) -> None:
+    def release_package_to_repository(self, version: str) -> None:
         """No Op."""
-        super().release_package_to_repository()
+        super().release_package_to_repository(version)
 
     def check_credentials(self) -> None:
         """No Op."""

continuous_delivery_scripts/plugins/python.py

@@ -134,14 +134,14 @@ def get_related_language(self) -> str:
         """Gets related language."""
         return get_language_from_file_name(__file__)
 
-    def package_software(self) -> None:
+    def package_software(self, version: str) -> None:
         """Packages the software into a wheel."""
-        super().package_software()
+        super().package_software(version)
         _create_wheel()
 
-    def release_package_to_repository(self) -> None:
+    def release_package_to_repository(self, version: str) -> None:
         """Releases to PyPI."""
-        super().release_package_to_repository()
+        super().release_package_to_repository(version)
         _release_to_pypi()
 
     def check_credentials(self) -> None:

continuous_delivery_scripts/tag_and_release.py

@@ -91,7 +91,7 @@ def _update_repository(mode: CommitType, is_new_version: bool, version: str, cur
             _commit_release_changes(git, version, commit_message)
         if is_new_version:
             logger.info("Tagging commit")
-            git.create_tag(version, message=f"release {version}")
+            git.create_tag(get_language_specifics().get_version_tag(version), message=f"release {version}")
             git.force_push_tag()
 
 

continuous_delivery_scripts/utils/configuration.py

@@ -22,38 +22,70 @@ class ConfigurationVariable(enum.Enum):
     """Project's configuration variables."""
 
     PROJECT_ROOT = 1
+    """Relative path to the root of the project from pyproject.toml."""
     PROJECT_CONFIG = 2
+    """Relative path to the file comprising project's configuration."""
     NEWS_DIR = 3
+    """Relative path to the directory comprising news files."""
     VERSION_FILE_PATH = 4
+    """Relative path to the file comprising project's version."""
     CHANGELOG_FILE_PATH = 5
+    """Relative path to the changelog file."""
     MODULE_TO_DOCUMENT = 6
+    """Name of the module to generate documentation for."""
     DOCUMENTATION_DEFAULT_OUTPUT_PATH = 7
     DOCUMENTATION_PRODUCTION_OUTPUT_PATH = 8
+    """Relative path to the folder where documentation will be generated."""
     GIT_TOKEN = 9
+    """GIT token allowing committing back to the repository."""
     BETA_BRANCH = 10
+    """Name of beta/QA branch."""
     MASTER_BRANCH = 11
+    """Name of the main/production branch."""
     RELEASE_BRANCH_PATTERN = 12
+    """Pattern of release branches."""
     REMOTE_ALIAS = 13
+    """Git's remote alias."""
     LOGGER_FORMAT = 14
+    """Tools' logger format."""
     BOT_USERNAME = 15
+    """Username of the Git bot account."""
     BOT_EMAIL = 16
+    """Email of the Git bot account."""
     ORGANISATION = 17
+    """Name of the organisation managing the project."""
     ORGANISATION_EMAIL = 18
+    """Email of the organisation managing the project."""
     AWS_BUCKET = 19
+    """AWS bucket to use if needed."""
     PROJECT_NAME = 21
+    """Name of the project."""
     PROJECT_UUID = 22
+    """UUID of the project to use in SPDX reports."""
     PACKAGE_NAME = 23
+    """Name of the package."""
     SOURCE_DIR = 24
+    """Relative path to the source of the project."""
     IGNORE_REPOSITORY_TEST_UPLOAD = 25
+    """States whether to release package to a test registry (e.g. pypi test) test before release."""
     FILE_LICENCE_IDENTIFIER = 26
+    """SPDX identifier for the project's licence."""
     COPYRIGHT_START_DATE = 27
+    """Project's copyright start year."""
     ACCEPTED_THIRD_PARTY_LICENCES = 28
+    """List of accepted 3rd party licences for dependencies."""
     PACKAGES_WITH_CHECKED_LICENCE = 29
+    """List of dependencies whose licence was manually checked."""
     PROGRAMMING_LANGUAGE = 30
+    """Project's programming language."""
     AUTOGENERATE_NEWS_FILE_ON_DEPENDENCY_UPDATE = 31
+    """States whether news file should be generated on dependency updates."""
     DEPENDENCY_UPDATE_BRANCH_PATTERN = 32
+    """Pattern of branches comprising dependency updates (e.g. dependabot)."""
     DEPENDENCY_UPDATE_NEWS_MESSAGE = 33
+    """Pattern of the news message for dependency update."""
     DEPENDENCY_UPDATE_NEWS_TYPE = 34
+    """News file type for dependency update."""
 
     @staticmethod
     def choices() -> List[str]:

continuous_delivery_scripts/utils/language_specifics_base.py

@@ -49,6 +49,10 @@ def get_related_language(self) -> str:
         """Gets the name of the corresponding language."""
         pass
 
+    def get_version_tag(self, version: str) -> str:
+        """Generates a tag based on the version string."""
+        return version
+
     def generate_source_licence_header_template(self) -> str:
         """Generates the template of the licence header which is put at the top of source files."""
         return _generate_generic_licence_header_template()
@@ -68,15 +72,15 @@ def generate_code_documentation(self, output_directory: Path, module_to_document
         pass
 
     @abstractmethod
-    def package_software(self) -> None:
+    def package_software(self, version: str) -> None:
         """Package the software so that it can get released."""
-        logger.info("Generating a release package")
+        logger.info(f"Generating a release package [{version}]")
         pass
 
     @abstractmethod
-    def release_package_to_repository(self) -> None:
+    def release_package_to_repository(self, version: str) -> None:
         """Release the package to the official software repository."""
-        logger.info("Uploading the package")
+        logger.info(f"Uploading the package [{version}]")
         pass
 
     @abstractmethod