@seniorsistemas/exclusion-process-component 0.0.1-c049d10c-e93a-4d63-9c2a-b17bca40c324 → 0.6.0-44030ff3-2eeb-49f7-8927-0920cc01a805

package/senior-ci/common/sonar_helper.py

@@ -0,0 +1,203 @@
+"""Module of Sonar Scanner commands"""
+
+import sys
+from enum import Enum
+from pathlib import Path
+
+from colorama import Fore
+
+sys.path.append("./senior-ci")
+
+from . import (
+    ExitCode,
+    end_collapsible_section,
+    exec_command,
+    exec_command_and_return,
+    exit_message,
+    get_env_variable,
+    get_env_variable_required,
+    print_message,
+    start_collapsible_section,
+    unshallow_repo,
+)
+from .extensions import Extensions
+from .graphql_client import GraphqlClient
+
+
+class SonarScannerType(Enum):
+    FLUTTER = "FLUTTER"
+    MAVEN = "MAVEN"
+    SDL = "SDL"
+
+
+class SonarHelper(object):
+    def __init__(
+        self,
+        extensions: Extensions = Extensions(),
+        sonar_scanner_type: SonarScannerType = None,
+        skip_build=False,
+    ) -> None:
+        self.extensions = extensions
+        self.sonar_scanner_type = sonar_scanner_type
+        self.skip_build = skip_build
+        self.graphql_client = GraphqlClient()
+
+        self.ci_project_path_slug = get_env_variable_required("CI_PROJECT_PATH_SLUG")
+        self.ci_project_name = get_env_variable_required("CI_PROJECT_NAME")
+        self.ci_commit_branch = get_env_variable("CI_COMMIT_BRANCH")
+
+        self.sci_debug = get_env_variable("SCI_DEBUG")
+
+        self.sonar_url = get_env_variable("SONAR_HOST_URL")
+
+    def scanner_analyze(self):
+        self.extensions.before_sonar()
+
+        base_sonar_scanner = self._create_base_sonar_scanner()
+
+        section_id = start_collapsible_section(
+            "Iniciando a execução do Sonar", Fore.CYAN
+        )
+
+        command_result_sonar = exec_command_and_return(base_sonar_scanner)
+
+        if command_result_sonar.exit_code == ExitCode.ERROR:
+            print(" ")
+            exit_message(
+                "Analise do projeto realizado pelo SonarQube não foi finalizada com sucesso, "
+                "verifique nos logs acima as possíveis resoluções."
+            )
+
+        self._config()
+
+        print(" ")
+        print_message(
+            "Analise estática feita pelo sonar finalizada com sucesso.",
+            Fore.GREEN,
+        )
+        print(" ")
+
+        end_collapsible_section(section_id)
+
+        self.extensions.after_sonar()
+
+    def _create_base_sonar_scanner(self):
+        ci_project_url = get_env_variable_required("CI_PROJECT_URL")
+
+        unshallow_repo()
+
+        last_version_tag = exec_command_and_return(
+            "git describe --tags --abbrev=0"
+        ).output
+
+        if not last_version_tag.startswith("v"):
+            last_version_tag = self.ci_commit_branch
+
+        base_default = (
+            "-Dsonar.issuesReport.console.enable=true "
+            "-Dsonar.sourceEncoding=UTF-8 "
+            "-Dsonar.qualitygate.wait=true "
+            "-Dsonar.qualitygate.timeout=1800 "
+        )
+
+        if self.skip_build:
+            exec_command("cp senior-ci/common/default-files/pom.xml .")
+            base_default = (
+                f"{base_default} -Dsonar.exclusions=senior-ci -Dsonar.exclusions=*.xml"
+            )
+
+        if self.ci_commit_branch:
+            base_default = f"{base_default} -Dsonar.branch.name={self.ci_commit_branch}"
+
+        if self.sonar_scanner_type == SonarScannerType.FLUTTER:
+            base_default = (
+                f"{base_default} -Dsonar.dart.analysis.reportPath=analyzer-output.txt"
+            )
+
+        base_urls = (
+            f"-Dsonar.host.url={self.sonar_url} -Dsonar.links.scm={ci_project_url}"
+        )
+        base_ref = f"-Dsonar.projectKey={self.ci_project_path_slug} -Dsonar.projectName={self.ci_project_name}"
+        base_version = f"-Dsonar.projectVersion={last_version_tag}"
+
+        base_initial = "sonar-scanner"
+
+        if self.sonar_scanner_type in [SonarScannerType.MAVEN, SonarScannerType.SDL]:
+            maven_cli_opts = (
+                "--batch-mode --errors --update-snapshots "
+                "--fail-at-end --no-transfer-progress"
+            )
+            parallel = ""
+
+            no_parallel = get_env_variable("NO_PARALLEL")
+
+            if not no_parallel:
+                parallel = "-T 1C "
+
+            base_initial = (
+                f"mvn {maven_cli_opts} {parallel}"
+                "org.sonarsource.scanner.maven:sonar-maven-plugin:3.9.1.2184:sonar"
+            )
+
+            if self.sonar_scanner_type == SonarScannerType.SDL and not self.skip_build:
+
+                properties = self._load_properties("sdl.properties")
+
+                try:
+                    output = properties["generator.java.output"]
+                except KeyError:
+                    output = "java"
+
+                base_initial = (
+                    f"{base_initial} --projects !client,!server --file {output}"
+                )
+
+        if self.sci_debug:
+            base_initial = f"{base_initial} --show-version -X"
+
+        base_sonar_scanner = (
+            f"{base_initial} {base_default} {base_urls} {base_ref} {base_version}"
+        )
+
+        return base_sonar_scanner.rstrip()
+
+    def _config(self):
+        """Configure merge request decorators on sonar project"""
+
+        mutation = """
+            mutation ($gitlabId: Int!, $sonarKey: String!) {
+                configSonarProject(gitlabId: $gitlabId, sonarKey: $sonarKey) {
+                    success
+                    result
+                }
+            }
+        """
+
+        params = {
+            "gitlabId": int(get_env_variable_required("CI_PROJECT_ID")),
+            "sonarKey": self.ci_project_path_slug,
+        }
+
+        self.graphql_client.call(mutation, params)
+
+    @staticmethod
+    def _load_properties(filepath, sep="=", comment_char="#"):
+        """
+        Read the file passed as parameter as a properties file.
+        """
+        props = {}
+        path = Path(filepath)
+        if path.is_file():
+            with open(path, "rt", encoding="utf-8") as property_file:
+                for line in property_file:
+                    line_striped = line.strip()
+                    if line_striped and not line_striped.startswith(comment_char):
+                        key_value = line_striped.split(sep)
+                        key = key_value[0].strip()
+                        value = sep.join(key_value[1:]).strip().strip('"')
+                        props[key] = value
+            return props
+
+        exit_message(
+            "O projeto não é um projeto SDL, ele não possui o arquivo sdl.properties."
+        )

package/senior-ci/common/validations/buildable_project.py

@@ -0,0 +1,61 @@
+import os
+import sys
+
+project_absolute_path = os.getenv("CI_PROJECT_DIR")
+sys.path.append(f"{project_absolute_path}/senior-ci")
+
+from common import get_env_variable, get_env_variable_required, is_path_exist
+from common.graphql_client import GraphqlClient
+
+NEEDED_FILES = ["pom.xml", "package.json", "pubspec.yaml"]
+
+
+class BuildableProject(object):
+    def __init__(self) -> None:
+
+        self.client_graphql = GraphqlClient()
+
+    def skip_build(self):
+        if (
+            get_env_variable("CI_COMMIT_BRANCH") == "develop"
+            and not self._needed_file_exists()
+            and not self._develop_exists_on_sonar()
+        ):
+            return f"""
+                [CI] Skippando build porque nenhum dos seguintes arquivos foi encontrado: {', '.join(NEEDED_FILES)}
+            """
+        return False
+
+    @staticmethod
+    def _needed_file_exists():
+        for file in NEEDED_FILES:
+            if is_path_exist(file):
+                return True
+        return False
+
+    def _develop_exists_on_sonar(self):
+
+        query = """
+            query ($projectKey: String!, $branchName: String!) {
+                branchExistsOnSonar(projectKey: $projectKey, branchName: $branchName) {
+                    exists
+                }
+            }
+        """
+
+        params = {
+            "projectKey": get_env_variable_required("CI_PROJECT_PATH_SLUG"),
+            "branchName": "develop",
+        }
+
+        request = self.client_graphql.call(query, params)
+
+        return request["branchExistsOnSonar"]["exists"]
+
+
+sci_project_type = get_env_variable("SCI_PROJECT_TYPE")
+
+if sci_project_type not in ["FLUTTER_APP", "FLUTTER_LIB"]:
+    buildable_project = BuildableProject()
+    skip_build = buildable_project.skip_build()
+    print(skip_build)

package/senior-ci/common/validations/check_deprecated_primitives.py

@@ -0,0 +1,49 @@
+import sys
+from datetime import datetime
+
+sys.path.append("./senior-ci")
+
+from common import get_env_variable_required
+from common.graphql_client import GraphqlClient
+
+
+class CheckDeprecatedPrimitives:
+    def __init__(self, client_graphql: GraphqlClient = GraphqlClient()) -> None:
+        self.client_graphql = client_graphql
+
+    def check(self):
+        """Check for deprecated primitives on commit"""
+
+        query = """
+            query ($projectId: Int!, $commitSha: String!) {
+                checkForDeprecatedPrimitives(
+                    projectId: $projectId, commitSha: $commitSha
+                ) {
+                    success
+                    reason
+                    lastDeprecatedDate
+                }
+            }
+        """
+
+        params = {
+            "projectId": int(get_env_variable_required("CI_PROJECT_ID")),
+            "commitSha": get_env_variable_required("CI_COMMIT_SHA"),
+        }
+
+        result = self.client_graphql.call(query, params)
+
+        output = CheckDeprecatedPrimitivesOutput(result["checkForDeprecatedPrimitives"])
+
+        return output
+
+
+class CheckDeprecatedPrimitivesOutput:
+    def __init__(self, result: dict) -> None:
+        self.success = result["success"]
+        self.reason = result["reason"]
+
+        if result["lastDeprecatedDate"]:
+            self.last_deprecated_date = datetime.strptime(
+                result["lastDeprecatedDate"], "%Y-%m-%d"
+            )

package/senior-ci/common/validations/check_project_path.py

@@ -0,0 +1,40 @@
+import sys
+from datetime import datetime
+
+sys.path.append("./senior-ci")
+
+from common import get_env_variable_required
+from common.graphql_client import GraphqlClient
+
+
+class CheckProjectPath(object):
+    def __init__(self, client_graphql: GraphqlClient = GraphqlClient()) -> None:
+        self.client_graphql = client_graphql
+
+    def check(self):
+        """Check if project path and project name are the same."""
+
+        query = """
+            query ($projectId: Int!) {
+                checkProjectPath(projectId: $projectId) {
+                    success
+                    reason
+                }
+            }
+        """
+
+        params = {
+            "projectId": int(get_env_variable_required("CI_PROJECT_ID")),
+        }
+
+        result = self.client_graphql.call(query, params)
+
+        output = CheckProjectPathOutput(result["checkProjectPath"])
+
+        return output
+
+
+class CheckProjectPathOutput(object):
+    def __init__(self, result: dict) -> None:
+        self.success = result["success"]
+        self.reason = result["reason"]

package/senior-ci/common/validations/check_sonar_config_files.py

@@ -0,0 +1,41 @@
+import sys
+
+sys.path.append("./senior-ci")
+
+from common import get_env_variable_required
+from common.graphql_client import GraphqlClient
+
+
+class CheckConfigFiles(object):
+    def __init__(self, client_graphql: GraphqlClient = GraphqlClient()) -> None:
+        self.client_graphql = client_graphql
+
+    def check(self):
+        """Check if sonar and project files are configured accordingly"""
+
+        query = """
+            query ($projectId: Int!, $branch: String!, $projectType: ProjectTypeEnum!) {
+                checkConfigFiles(projectId: $projectId, branch: $branch, projectType: $projectType) {
+                    reason
+                    success
+                }
+            }
+        """
+
+        params = {
+            "projectId": int(get_env_variable_required("CI_PROJECT_ID")),
+            "branch": get_env_variable_required("CI_COMMIT_REF_NAME"),
+            "projectType": get_env_variable_required("SCI_PROJECT_TYPE"),
+        }
+
+        result = self.client_graphql.call(query, params)
+
+        output = CheckConfigFilesOutput(result["checkConfigFiles"])
+
+        return output
+
+
+class CheckConfigFilesOutput(object):
+    def __init__(self, result: dict) -> None:
+        self.success = result["success"]
+        self.reason = result["reason"]

package/senior-ci/common/validations/check_tags.py

@@ -0,0 +1,41 @@
+import sys
+
+sys.path.append("./senior-ci")
+
+from common import get_env_variable_required
+from common.graphql_client import GraphqlClient
+
+
+class CheckTags:
+    def __init__(self, client_graphql: GraphqlClient = GraphqlClient()) -> None:
+        self.client_graphql = client_graphql
+
+    def check(self):
+        """Check for tags on project"""
+
+        query = """
+            query ($projectId: Int!) {
+                checkForTags(
+                    projectId: $projectId
+                ) {
+                    success
+                    reason
+                }
+            }
+        """
+
+        params = {
+            "projectId": int(get_env_variable_required("CI_PROJECT_ID")),
+        }
+
+        result = self.client_graphql.call(query, params)
+
+        output = CheckTagsOutput(result["checkForTags"])
+
+        return output
+
+
+class CheckTagsOutput:
+    def __init__(self, result: dict) -> None:
+        self.success = result["success"]
+        self.reason = result["reason"]

package/senior-ci/common/validations/validate_changelog.py

@@ -0,0 +1,151 @@
+import sys
+from pathlib import Path
+from typing import List
+
+from colorama import Fore
+
+sys.path.append("./senior-ci")
+
+from common import (
+    convert_tag_to_semver,
+    end_collapsible_section,
+    exec_command,
+    exit_message,
+    get_env_variable_required,
+    print_message,
+    print_messages,
+    start_collapsible_section,
+    unshallow_repo,
+)
+
+
+class ValidateChangelog(object):
+    def __init__(self) -> None:
+        self.ci_commit_ref_name = get_env_variable_required("CI_COMMIT_REF_NAME")
+
+        self.changelog = self._get_last_changelog_block()
+
+    def validate(self):
+        skip_validate = False
+
+        section_id = start_collapsible_section(
+            "Validando padrões de branch e changelog", Fore.CYAN
+        )
+
+        if self.ci_commit_ref_name not in ["develop", "master"]:
+            if "/" not in self.ci_commit_ref_name:
+                exit_message("Nome de branch inválida.")
+
+            branch_type, issue_link = self.ci_commit_ref_name.split("/")
+
+            issue_link = issue_link.upper()
+
+            self._is_in_pattern(issue_link)
+
+            if branch_type in ["feature", "bugfix"]:
+                self._jira_issue_is_in_changelog(issue_link)
+
+                print_message(
+                    "Tudo certinho com o Changelog, bom trabalho <3", Fore.GREEN
+                )
+            else:
+                skip_validate = True
+        else:
+            skip_validate = True
+
+        if skip_validate:
+            print_messages(
+                [
+                    "A validação de issue no changelog é feita apenas em branches de feature e bugfix.",
+                    "Pulando rotina de verificação de issue no changelog.",
+                ],
+                Fore.YELLOW,
+            )
+
+        end_collapsible_section(section_id)
+
+    def _jira_issue_is_in_changelog(self, issue_link):
+        is_in = False
+
+        for line in self.changelog:
+            if line and issue_link in line:
+                is_in = True
+
+        if not is_in:
+            exit_message(
+                f"A tarefa informada no branch ({issue_link}) não consta no changelog para a próxima versão, "
+                "por favor insira ela para continuar."
+            )
+
+    def _is_in_pattern(self, issue_link):
+        is_in = False
+
+        for line in self.changelog:
+            if line and not line.startswith("###"):
+                description = line.replace("* ", "", 1)
+
+                if (
+                    description == "N/A."
+                    or description.startswith(f"[#{issue_link}]")
+                    or description.startswith(
+                        f"[{issue_link}](https://jira.senior.com.br/browse/{issue_link})"
+                    )
+                    or not issue_link in description
+                ):
+                    is_in = True
+                else:
+                    is_in = False
+                    break
+
+        if not is_in:
+            exit_message(
+                "Changelog está em desacordo com os padrões definidos pela arquitetura: "
+                "https://wiki.senior.com.br/pt-br/Plataforma/Plataforma/Versionamento#changelog"
+            )
+
+    def _get_last_changelog_block(self) -> List[str]:
+        last_changelog_block = []
+
+        path = Path("CHANGELOG.md")
+        if path.is_file():
+            should_collect_line = False
+
+            latest_tag = self._get_latest_tag()
+
+            with open(path, "r", encoding="utf-8") as changelog_file:
+                for line in changelog_file:
+                    line_striped = line.strip()
+
+                    if (
+                        line_striped
+                        and "### Quebras de compatibilidade" in line_striped
+                    ):
+                        should_collect_line = True
+                    elif latest_tag in line_striped:
+                        break
+
+                    if should_collect_line:
+                        last_changelog_block.append(line_striped)
+
+        else:
+            exit_message(f"Changelog não encontrado no path: {path}.")
+
+        return last_changelog_block
+
+    @staticmethod
+    def _get_latest_tag():
+        unshallow_repo()
+
+        latest_tag_cmd = exec_command(
+            "git describe --abbrev=0 --tags `git rev-list --tags --max-count=1`",
+            print_command=False,
+            print_output=False,
+        )
+
+        latest_tag = latest_tag_cmd.output.replace("\n", "")
+
+        return convert_tag_to_semver(latest_tag)
+
+
+validate_changelog = ValidateChangelog()
+validate_changelog.validate()