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

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

@@ -0,0 +1,320 @@
+"""Validate the Custom Issues of a project"""
+
+import sys
+from datetime import datetime, timedelta
+from typing import List
+
+from colorama import Fore
+
+sys.path.append("./senior-ci")
+
+from common import (
+    end_collapsible_section,
+    exit_message,
+    get_env_variable,
+    get_env_variable_required,
+    print_message,
+    start_collapsible_section,
+)
+from common.graphql_client import GraphqlClient
+from common.validations.check_deprecated_primitives import CheckDeprecatedPrimitives
+from common.validations.check_project_path import CheckProjectPath
+from common.validations.check_sonar_config_files import CheckConfigFiles
+from common.validations.check_tags import CheckTags
+
+
+class CustomIssue:
+    """Entity of a Custom Issue"""
+
+    rule: str
+    must_be_fixed_until: datetime
+    description: str
+    notification_text: str
+
+    def __init__(self, client_graphql: GraphqlClient = GraphqlClient()) -> None:
+        self.client_graphql = client_graphql
+
+    def create(self):
+        """Create a CustomIssue for project"""
+
+        query = """
+            mutation ($projectId: Int!, $customIssue: CustomIssueInput!) {
+                createCustomCiIssue(
+                    customIssueInfo: $customIssue
+                    gitlabInfo:{
+                        projectId: $projectId
+                    }
+                ) {
+                    success
+                    message
+                }
+            }
+        """
+
+        params = {
+            "projectId": int(get_env_variable_required("CI_PROJECT_ID")),
+            "customIssue": self.convert_to_json(),
+        }
+
+        self.client_graphql.call(query, params)
+
+    def convert_from_json(self, payload):
+        """Convert a payload to this class"""
+
+        self.rule = payload["rule"]
+        self.must_be_fixed_until = payload["mustBeFixedUntil"]
+
+        if self.must_be_fixed_until:
+            self.must_be_fixed_until = datetime.strptime(
+                self.must_be_fixed_until, "%Y-%m-%dT%H:%M:%S"
+            )
+
+        self.description = payload["description"]
+        self.notification_text = payload["notificationText"]
+
+        return self
+
+    def convert_to_json(self):
+        """Convert this class to a json"""
+
+        return {
+            "rule": self.rule,
+            "mustBeFixedUntil": self.must_be_fixed_until.strftime("%Y-%m-%dT%H:%M:%S"),
+            "description": self.description,
+            "notificationText": self.notification_text,
+        }
+
+
+class ProjectIssuesStatus:
+    """Entity of a Project Issues Status"""
+
+    should_break_job: bool
+    issues: List[CustomIssue]
+
+    def __init__(self, client_graphql: GraphqlClient = GraphqlClient()) -> None:
+        self.client_graphql = client_graphql
+        self._get_project_issue_status()
+
+    def show_status(self):
+        """Print the status of a job and/or project"""
+
+        print_message("Validando existência de alguma pendência no projeto.")
+        print(" ")
+
+        if self.issues:
+            section_id = start_collapsible_section(
+                "Existem algumas pendências a serem resolvidas, segue relação:",
+            )
+
+            for issue in self._get_required_issues():
+                must_be_fixed_until = issue.must_be_fixed_until
+                description = issue.description
+
+                date_to_fix_message = None
+
+                if must_be_fixed_until:
+                    date_to_fix = issue.must_be_fixed_until.strftime("%d/%m/%Y")
+
+                    date_to_fix_message = (
+                        f"Data de corte para quebrar o job: {date_to_fix}"
+                    )
+
+                print_message(
+                    f"{description} {date_to_fix_message if date_to_fix_message else ''}",
+                    Fore.RED if self.should_break_job else Fore.LIGHTYELLOW_EX,
+                )
+
+            if self.should_break_job:
+                exit_message(
+                    "O job foi impedido de continuar devido as pendências acima. :x"
+                )
+
+            print(" ")
+
+            print_message(
+                "Nenhuma das pendências acima quebrará este job, porém é importante ajustá-las antes que se tornem impeditivas ;)",
+                Fore.YELLOW,
+            )
+
+            end_collapsible_section(section_id)
+        else:
+            print_message("Nenhuma pendência encontrada, parabéns!", Fore.GREEN)
+
+        print(" ")
+
+    def _get_required_issues(self):
+        self.issues.sort(
+            key=lambda issue: issue.must_be_fixed_until
+            if issue.must_be_fixed_until
+            else datetime.now()
+        )
+
+        required_issues = self.issues
+
+        if self.should_break_job:
+            required_issues = list(
+                filter(lambda issue: issue.must_be_fixed_until is None, self.issues)
+            )
+
+            if not required_issues:
+                required_issues = list(
+                    filter(
+                        lambda issue: issue.must_be_fixed_until < datetime.now(),
+                        self.issues,
+                    )
+                )
+
+        return required_issues
+
+    def _get_project_issue_status(self):
+        query = """
+            query ($projectId: Int!, $jobStage: String, $commitSha: String) {
+                projectIssuesStatus(
+                    projectId: $projectId,
+                    jobStage: $jobStage,
+                    commitSha: $commitSha
+                ) {
+                    shouldBreakJob
+                    issues {
+                        rule
+                        mustBeFixedUntil
+                        description
+                        notificationText
+                    }
+                }
+            }
+        """
+
+        params = {
+            "projectId": int(get_env_variable_required("CI_PROJECT_ID")),
+            "jobStage": get_env_variable_required("CI_JOB_STAGE"),
+            "commitSha": get_env_variable_required("CI_COMMIT_SHA"),
+        }
+
+        result = self.client_graphql.call(query, params)
+
+        project_issues_status_result = result["projectIssuesStatus"]
+
+        self.convert_from_json(project_issues_status_result)
+
+    def convert_from_json(self, payload):
+        """Convert a payload to this class"""
+
+        self.should_break_job = payload["shouldBreakJob"]
+        self.issues = list(
+            map(
+                lambda issueResult: CustomIssue().convert_from_json(issueResult),
+                payload["issues"],
+            )
+        )
+
+        return self
+
+
+sci_project_type = get_env_variable("SCI_PROJECT_TYPE")
+
+skip_check_deprecated_primitives = get_env_variable("SKIP_CHECK_DEPRECATED_PRIMITIVES")
+
+graphql_client = GraphqlClient()
+
+if not skip_check_deprecated_primitives:
+    check_tags = CheckDeprecatedPrimitives(graphql_client)
+    result_check = check_tags.check()
+
+    if not result_check.success:
+        custom_issues = CustomIssue(graphql_client)
+        custom_issues.rule = "HAS_DEPRECATED_PRIMITIVES"
+        custom_issues.description = "Foi encontrado primitivas deprecadas no projeto."
+        custom_issues.notification_text = result_check.reason
+
+        today = datetime.today()
+        next_two_week = today + timedelta(days=15)
+
+        must_be_fixed_until = result_check.last_deprecated_date
+
+        if must_be_fixed_until < today or must_be_fixed_until < next_two_week:
+            must_be_fixed_until = today + timedelta(days=60)
+
+        custom_issues.must_be_fixed_until = must_be_fixed_until
+
+        custom_issues.create()
+
+skip_check_tags = get_env_variable("SKIP_CHECK_TAGS")
+
+if not skip_check_tags and sci_project_type not in ["ANGULAR_GENERATED"]:
+    check_tags = CheckTags(graphql_client)
+    result_check = check_tags.check()
+
+    if not result_check.success:
+        custom_issues = CustomIssue(graphql_client)
+        custom_issues.rule = "MISSING_SONAR_TAGS"
+        custom_issues.description = "Não foram encontradas tags do sonar no projeto."
+        custom_issues.notification_text = result_check.reason
+
+        today = datetime.today()
+        next_week = today + timedelta(days=7)
+
+        custom_issues.must_be_fixed_until = next_week
+
+        custom_issues.create()
+
+skip_check_project_path = get_env_variable("SKIP_CHECK_PROJECT_PATH")
+
+if not skip_check_project_path:
+
+    check_project_path = CheckProjectPath(graphql_client)
+
+    result_check = check_project_path.check()
+
+    if not result_check.success:
+        custom_issues = CustomIssue(graphql_client)
+        custom_issues.rule = "PROJECT_PATH_AND_NAME_ARE_NOT_THE_SAME"
+        custom_issues.description = (
+            "O path do projeto e o nome do projeto são diferentes."
+        )
+        custom_issues.notification_text = result_check.reason
+
+        today = datetime.today()
+        tomorrow = today + timedelta(days=1)
+
+        custom_issues.must_be_fixed_until = tomorrow
+
+        custom_issues.create()
+
+skip_check_config_files = get_env_variable("SKIP_CHECK_CONFIG_FILES")
+
+if not skip_check_config_files and sci_project_type in [
+    "APP_BASE",
+    "ANGULAR_SENIORX",
+    "ANGULAR_APP",
+    "ANGULAR_LIB",
+    "FLUTTER_APP",
+    "FLUTTER_LIB",
+]:
+
+    check_sonar_config_files = CheckConfigFiles(graphql_client)
+
+    result = check_sonar_config_files.check()
+
+    if not result.success:
+        custom_issues = CustomIssue(graphql_client)
+        custom_issues.rule = "SONARQUBE_OR_PROJECT_CONFIG_ARE_WRONG"
+        custom_issues.description = (
+            "Os arquivos de configuração do Sonar ou do Projeto não estão alinhados. "
+            "Ao corrigir esse problema, pode ocorrer uma queda no coverage. "
+            "Qualquer dúvida entre em contato com o time de DevOps."
+        )
+        custom_issues.notification_text = result.reason
+
+        today = datetime.today()
+        next_week = today + timedelta(days=7)
+
+        custom_issues.must_be_fixed_until = next_week
+
+        custom_issues.create()
+
+skip_issue_validate = get_env_variable("SKIP_ISSUE_VALIDATE")
+
+if not skip_issue_validate:
+    project_issues_status = ProjectIssuesStatus(graphql_client)
+    project_issues_status.show_status()

package/senior-ci/docker/build.sh

@@ -0,0 +1,18 @@
+#!/bin/bash
+
+set -e # Exit at first error
+
+echo "[CI] buildando a imagem $SVC_IMAGE."
+if [ -n "$TARGET" ]; then
+    docker build --target $TARGET --network host -t seniorsa/$SVC_IMAGE .
+else
+    docker build --network host -t $HUB_USER/$SVC_IMAGE .
+fi
+
+CI_COMMIT_TAG="${CI_COMMIT_TAG//-/.}"
+CI_COMMIT_TAG="${CI_COMMIT_TAG:1}"
+VERSION="${CI_COMMIT_TAG:-$CI_COMMIT_REF_SLUG-SNAPSHOT}"
+
+if [ -z "$SKIP_IMAGE_SCAN" ]; then
+    trivy --clear-cache --severity HIGH,CRITICAL seniorsa/$SVC_IMAGE
+fi

package/senior-ci/docker/config-host.sh

@@ -0,0 +1,29 @@
+#!/bin/bash
+
+if [ "$EUID" -ne 0 ]
+  then echo "Esse script deve ser executado como root! Tente novamente utilizando sudo."
+  exit 1
+fi
+
+echo "[CI] Iniciando a configuração da execução remota do docker"
+echo "[CI] Criando o diretório /etc/systemd/system/docker.service.d"
+mkdir -p /etc/systemd/system/docker.service.d
+
+echo "[CI] Realizando a criação do arquivo options.conf"
+rm -f /etc/systemd/system/docker.service.d/options.conf
+touch /etc/systemd/system/docker.service.d/options.conf
+
+cat <<EOF > /etc/systemd/system/docker.service.d/options.conf
+[Service]
+ExecStart=
+ExecStart=/usr/bin/dockerd -H unix:// -H tcp://0.0.0.0:2375
+EOF
+echo "[CI] Arquivo options.conf configurado com sucesso!"
+
+echo "[CI] Reiniciando o systemctl"
+systemctl daemon-reload
+
+echo "[CI] Reiniciando o docker"
+systemctl restart docker
+
+echo "[CI] Host configurado com sucesso para receber deploys via Docker! Para mais informações consulte https://git.senior.com.br/engenharia/senior-ci/wikis/home"

package/senior-ci/docker/deploy-service.sh

@@ -0,0 +1,79 @@
+#!/bin/bash
+
+set -e # Exit at first error
+
+# Import docker helpers
+. senior-ci/common/docker-helpers.sh
+
+echo ""
+
+if [ -e .senior-ci-extensions.sh ]; then
+    echo "[CI] Carregando arquivo de extensões - .senior-ci-extensions.sh"
+    . .senior-ci-extensions.sh
+else
+    echo "[CI] Arquivo de extensões não encontrado (.senior-ci-extensions.sh). Continuando execução padrão do CI."
+fi
+
+call_extension() {
+    if [ -n "$(type -t $1)" ] && [ "$(type -t $1)" = function ]; then
+        echo "[CI] Disparando hook $1 do .senior-ci-extensions.sh"
+        $1
+    fi
+};
+
+
+call_extension "before_deploy"
+
+DOCKER_HOST="tcp://$SVC_DEPLOY_TARGET:2375"
+
+CI_COMMIT_TAG="${CI_COMMIT_TAG//-/.}"
+CI_COMMIT_TAG="${CI_COMMIT_TAG:1}"
+VERSION="${CI_COMMIT_TAG:-$CI_COMMIT_REF_SLUG-SNAPSHOT}"
+
+if [ "$SVC_NAME" == "" ]; then
+  SVC_NAME=$SVC_IMAGE
+fi
+
+if [ "$SVC_TIMEZONE" == "" ]; then
+  SVC_TIMEZONE="-e TZ=America/Sao_Paulo"
+fi
+
+echo ""
+echo "[CI] Realizando o deploy do serviço $SVC_IMAGE:$VERSION no host $SVC_DEPLOY_TARGET"
+echo ""
+echo "[CI] O serviço $SVC_NAME($SVC_IMAGE:$VERSION) vai se conectar ao RabbitMQ do ambiente $CI_ENVIRONMENT_URL"
+echo ""
+
+docker_login
+
+echo "[CI] Baixando imagem seniorsa/$SVC_IMAGE:$VERSION"
+docker -H $DOCKER_HOST pull seniorsa/$SVC_IMAGE:$VERSION
+
+echo ""
+
+docker -H $DOCKER_HOST rm -f $SVC_NAME
+
+echo "[CI] Subindo container $SVC_NAME($SVC_IMAGE:$VERSION)"
+echo ""
+docker -H $DOCKER_HOST run -d --name=$SVC_NAME \
+  -e JAVA_OPTS="$SVC_JAVA_OPTS" \
+  $SVC_TIMEZONE \
+  -e BROKER_HOST=$CI_ENVIRONMENT_URL \
+  $SVC_ENVIRONMENT \
+  --log-opt max-size=5m --log-opt max-file=1 \
+  $MEMORY_LIMIT \
+  --restart=unless-stopped \
+  $VOLUME_MAPPING \
+  seniorsa/$SVC_IMAGE:$VERSION
+
+if [ -n "$SLACK_HOOK" ]; then
+  echo "[CI] Enviando notificação no Slack"
+  echo ""
+  DEPLOY_USERNAME="${GITLAB_USER_EMAIL%@senior.com.br}"
+  curl -s -X POST "$SLACK_HOOK" -H 'Content-Type: application/json' -d '{ "text": "O usuário `'$DEPLOY_USERNAME'` realizou um deploy do serviço `'$SVC_IMAGE:$VERSION'` com o nome `'$SVC_NAME'` no host `'$SVC_DEPLOY_TARGET'`."}'
+fi
+
+call_extension "after_deploy"
+
+echo ""
+echo "[CI] Deploy realizado com sucesso!"

package/senior-ci/docker/push.sh

@@ -0,0 +1,22 @@
+#!/bin/bash
+
+set -e # Exit at first error
+
+
+if [ -z "$HUB_USER" ]; then
+    HUB_USER="seniorsa"
+fi
+
+# Import docker helpers
+. senior-ci/common/docker-helpers.sh
+
+. senior-ci/docker/build.sh
+
+docker_login
+
+docker tag $HUB_USER/$SVC_IMAGE $HUB_USER/$SVC_IMAGE:$VERSION
+
+create_dockerhub_repo
+
+echo "[CI] fazendo push da imagem $HUB_USER/$SVC_IMAGE e versão $VERSION para o docker hub"
+docker push $HUB_USER/$SVC_IMAGE:$VERSION

package/senior-ci/frontend/npm/bibliotecas/ci.sh

@@ -0,0 +1,149 @@
+#!/bin/bash
+
+echo "----------------------------------------------------------------------------------"
+echo "[CI] Variáveis:"
+echo "[CI] - SCI_VERSION_TAG_FRONTEND=$SCI_VERSION_TAG_FRONTEND"
+echo "[CI] - CANNED_ACL=$CANNED_ACL"
+echo "[CI] - CDN_PATH=$CDN_PATH"
+echo "[CI] - SOURCE_FOLDER_NPM=$SOURCE_FOLDER_NPM"
+echo "----------------------------------------------------------------------------------"
+
+set -e # Exit at first error
+
+# Import release helpers
+. senior-ci/common/release-helpers.sh
+
+# Import notification helpers
+. senior-ci/common/notification-helpers.sh
+
+# Senior CI Extensions
+. senior-ci/common/senior-ci-extensions-helpers.sh
+
+# Import npm struture helpers
+. senior-ci/common/npm-helper.sh
+
+
+HELP_MESSAGE="Caso tenha qualquer dúvida sobre o processo, consulte nossa Wiki - https://git.senior.com.br/engenharia/senior-ci/wikis/home"
+
+prepareVersionSnapshot() {
+    if [[ $VERSION = *"-SNAPSHOT"* ]]; then
+        UUID_VERSION=$(get_attribute "version\":")-$(uuidgen)
+        npm --no-git-tag-version version $UUID_VERSION
+        TAG_NPM="--tag $VERSION"
+    fi
+}
+
+
+packing() {
+
+    echo "[CI] Iniciando processo de publicação do projeto."
+
+    if [ "$CDN_PATH" ]; then
+      : "${CANNED_ACL:?CANNED_ACL não configurado no cluster.}"
+
+      npm --version
+      echo "[CI] Publicando a versão $VERSION no bucket S3 do CDN - $CDN_PATH/$VERSION"
+      aws s3 cp dist s3://$CDN_PATH/$VERSION --recursive --acl $CANNED_ACL
+    fi
+
+    : "${NPM_TOKEN:?Configure a variável NPM_TOKEN nas settings do seu projeto no GitLab. $HELP_MESSAGE}"
+    echo "//registry.npmjs.org/:_authToken=$NPM_TOKEN" > .npmrc
+
+    echo "[CI] Publicando o pacote no NPM Registry - //registry.npmjs.org"
+    if [ "$NPM_TOKEN" ]; then
+        npm config set registry https://registry.npmjs.org/
+    fi
+
+    npm publish $SOURCE_FOLDER_NPM --access public $TAG_NPM
+}
+
+getopts "bsrpx" op;
+case "$op" in
+
+  b) echo "[CI] Executando compilação e validação de formatação do código"
+      python3 senior-ci/common/validations/validate_issues.py
+
+      call_extension "before_build"
+      npm run build
+      npm run lint --if-present
+      call_extension "after_build"
+      ;;
+
+  s)  echo "[CI] Realizando release: SNAPSHOT"
+      call_extension "before_release_snapshot"
+      VERSION="$2-SNAPSHOT"
+      prepareVersionSnapshot
+      npm run build
+      packing
+      call_extension "after_release_snapshot"
+      ;;
+
+  r)  echo "[CI] Realizando release: $2"
+      python3 senior-ci/common/validations/validate_issues.py
+
+      unshallow_repo
+
+      get_next_version $2
+
+      create_release_branch
+
+      call_extension "before_release"
+
+      npm version --no-git-tag-version "$VERSION"
+      [[ -f bower.json ]] && sed -i -E "s/(\"version\":[[:space:]]*\").+(\")/\1${VERSION}\2/g" bower.json
+
+      call_extension "before_change_changelog"
+
+      update_changelog
+
+      call_extension "after_change_changelog"
+
+      create_release_tag
+
+      call_extension "after_release"
+
+      echo "[CI] Criação da release versão $VERSION realizado com sucesso. Execute o job 'package' para publicar esta versão no CDN e NPM Registry."
+
+      notify_release_teams_channel
+     ;;
+
+  p)  echo "[CI] Publicação da versão"
+
+      call_extension "before_packaging"
+
+      VERSION=$(git describe --exact-match --tags | grep "^v[0-9]\{1,\}-[0-9]\{1,\}-[0-9]\{1,\}$" | sed "s/-\([[:digit:]]\)/\.\1/g" | sed 's/^\s*.//g')
+      if [ -z "${VERSION}" ]; then
+        VERSION=$(get_attribute "version\":")
+      fi
+
+      npm run build
+      packing
+
+      USER_DEPLOY_MAIL="${GITLAB_USER_EMAIL%@senior.com.br}"
+      DEPLOY_TEAMS_MESSAGE="O usuário $USER_DEPLOY_MAIL liberou a versão <$CI_PROJECT_URL/blob/$CI_COMMIT_REF_NAME/CHANGELOG.md#anchor-$VERSION_WITHOUT_DOTS|$VERSION> do projeto $CI_PROJECT_NAME."
+
+      call_extension "after_packaging"
+
+      notify_text_teams_channel "$DEPLOY_TEAMS_MESSAGE"
+
+      echo "[CI] Versão $VERSION publicada com sucesso!"
+      ;;
+
+  x)  echo "[CI] Realizando validação de testes e análise no SonarQube"
+      call_extension "before_build"
+
+      SKIP_BUILD=$(python3 senior-ci/common/validations/buildable_project.py)
+      echo $SKIP_BUILD | sed 's@False@@g'
+
+      if [ "$SKIP_BUILD" = "False" ]; then
+
+        npm test
+      
+      fi
+
+      call_extension "after_build"
+
+      python3 senior-ci/ci/sonar_scanner.py -s $SKIP_BUILD
+      ;;
+
+esac