{"id":29177778,"url":"https://github.com/totvs/pipeline-ci-protheus","last_synced_at":"2025-07-01T18:08:03.051Z","repository":{"id":201041779,"uuid":"699896596","full_name":"totvs/pipeline-ci-protheus","owner":"totvs","description":null,"archived":false,"fork":false,"pushed_at":"2023-10-20T17:08:59.000Z","size":22769,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":8,"default_branch":"main","last_synced_at":"2024-04-14T07:47:29.019Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/totvs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2023-10-03T14:53:08.000Z","updated_at":"2024-02-27T12:24:33.000Z","dependencies_parsed_at":null,"dependency_job_id":"6be7421f-8385-4bc4-805d-ccacdd4021ff","html_url":"https://github.com/totvs/pipeline-ci-protheus","commit_stats":null,"previous_names":["totvs/pipeline-ci-protheus"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/totvs/pipeline-ci-protheus","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/totvs%2Fpipeline-ci-protheus","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/totvs%2Fpipeline-ci-protheus/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/totvs%2Fpipeline-ci-protheus/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/totvs%2Fpipeline-ci-protheus/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/totvs","download_url":"https://codeload.github.com/totvs/pipeline-ci-protheus/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/totvs%2Fpipeline-ci-protheus/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263013730,"owners_count":23399814,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-07-01T18:08:02.477Z","updated_at":"2025-07-01T18:08:03.035Z","avatar_url":"https://github.com/totvs.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# pipeline-ci-protheus\n\nRepositório com o exemplo de CI apresentado na palestra: **Linha Protheus - Utilizando CodeAnalysis em seu processo de integração contínua** no evento Spin-off Code no Code do dia do Profissional de TI (19/10/2023).\n\nPara baixá-lo, faça um clone deste repositório em seu ambiente local: `git clone https://github.com/totvs/pipeline-ci-protheus.git`.\n\nCaso deseje fazer uma execução totalmente local, considere as instruções deste repositório: https://github.com/totvs/protheus-ci-universo\n\nDúvidas podem ser encaminhadas via issue neste repositório. Sugestões via Pull Requests.\n\n## Pipeline (etapas)\n\nEsta pipeline de exemplo consiste em 4 etapas (veja aba Actions deste repositório):\n\n```\npush\n ├── 1. Code Analysis -\u003e Realiza a execução da análise de qualidade de código;\n ├── 2. Build -\u003e Compila os fontes e gera o RPO Custom;\n ├── 3. TIR -\u003e Baixa o RPO custom e realiza os testes usando o TIR sem interface;\n └── 4. Patch Gen -\u003e Gera um patch com os fontes Protheus do repositório.\n```\n\nEsta pipeline foi configurada para executar sequencialmente, cada uma etapa depende que a anterior tenha sido executada com sucesso.\n\nA definição está no arquivo `.github/workflows/pipeline.yml`, onde cada etapa é um job do GitHub Actions que executa alguns scripts para realizar a tarefa da etapa em questão.\n\n### Solução para execução do ambiente local\n\nO job do TIR tem uma característica diferente dos outros, pois ele não executa nos agents/runners do GitHub, e sim num agent hospedado na infraestrutura interna da TOTVS, para ter comunicação com um ambiente Protheus sendo executado em Docker (esta é uma das diversas possibilidades).\n\nA nossa solução foi criar uma imagem Docker contendo o agent dos runners do GitHub ([veja aqui documentação sobre isso](https://docs.github.com/pt/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners)), herdando a imagem base do TIR (https://hub.docker.com/r/totvsengpro/tir).\n\nEssa imagem compartilha a mesma rede e o volume do RPO do ambiente em Docker (`/share/protheus/apo/`), permitindo que a imagem TIR+Agent faça a troca a quente do RPO, e permita a execução do TIR.\n\nPara tratar os erros e falhas dos scripts de testes do TIR, é necessário que o script da suíte tenha um tratamento para quebrar em caso de falhas. Para isso adicione a seguinte instrução no final da suíte:\n\n```python\nrunner = unittest.TextTestRunner(verbosity=2)\nresult = runner.run(suite)\n\nif len(result.errors) \u003e 0 or len(result.failures) \u003e 0:\n    print(\"custom exit\")\n    exit(1)\n```\n\n### Visão aba Actions\n\nNa imagem abaixo é possível ver uma execução com sucesso da pipeline, onde foram executadas as 4 etapas e gerado os artefatos (custom rpo e patch) para aplicação no ambiente.\n\n![image](https://github.com/totvs/pipeline-ci-protheus/assets/10109480/722bb3c0-5f83-4ead-8c85-86fb76ded58e)\n\n*imagem anexada pois a retenção máxima do GitHub Actions é de 90 dias.\n  \n## Ambiente Protheus com Docker\n\nSe deseja subir o ambiente Protheus via Docker deste exemplo, siga os seguinte passos:\n\n1. Rode o seguinte script: `cd pipeline-ci-protheus \u0026\u0026 bash ci/scripts/up_env.sh`;\n2. Baixe os seguintes artefatos: includes, rpo default e o dicionário;\n3. Adicione na **[pasta protheus](#estrutura-de-pastas)** os artefatos baixados em suas respectivas subpastas;\n4. Configure-o (ip/porta webapp) nas configs do TIR (`tir/config.json`),\n\n## Scripts do CI\n\nEstes são os scripts externos desta pipeline CI de exemplo:\n\n1. `up_env.sh`: Sobe a stack ambiente Protheus local em Docker;\n2. `down_env.sh`: Remove a stack do ambiente Protheus;\n4. `list-files.sh`: Lista os arquivos de código Protheus do repositório para geração do patch;\n\nObs.: Caso um dos scripts retorne erro, a pipeline irá \"quebrar\", não continuando a realização dos próximos.\n\n## Estrutura de pastas\n\nEste projeto contém a seguinte estrutura de pastas e seus respectivos propósitos:\n\n```\n.\n├── .github\n│    └── workflows\n│         └── pipeline.yml (pipeline GitHub Actions)\n├── analyser               (arquivos do analisador estático)\n│    ├── config.json       (arquivo de configuração do analisador)\n│    └── output            (saída da execução da análise)\n├── ci\n│    ├── scripts           (scripts externos da pipeline)\n│    └── docker            (arquivos para execução do ambiente Protheus local)\n├── protheus               (arquivos para execução local do Protheus e AppServer command line via Docker)\n│    ├── apo               (volume dos RPOs do ambiente Protheus)\n│    ├── includes          (volume dos includes da compilação)\n│    └── systemload        (volume dos arquivos de dicionário)\n├── src                    (códigos-fonte)\n└── tir                    (suítes de testes e configuração para execução do TIR)\n```\n\n## Documentações relacionadas\n\n- [Code Analysis via Docker](https://hub.docker.com/r/totvsengpro/advpl-tlpp-code-analyzer)\n- [Protheus via Docker](https://docker-Protheus.engpro.totvs.com.br)\n- [AppServer command line](https://tdn.totvs.com/pages/viewpage.action?pageId=6064914)\n- [Sonar Rules](https://sonar-rules.engpro.totvs.com.br/menu/rules)\n- [Git](https://git-scm.com)\n- [Docker](https://docs.docker.com)\n- [CodeAnalysis](https://codeanalysis.totvs.com.br)\n- [TIR](https://github.com/totvs/tir)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftotvs%2Fpipeline-ci-protheus","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftotvs%2Fpipeline-ci-protheus","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftotvs%2Fpipeline-ci-protheus/lists"}