Melhores práticas de CI/CD

Os benefícios do CI/CD são bem conhecidos, mas como extrair o máximo desses processos de DevOps?

A integração, a entrega e a implantação contínuas otimizam o processo de build, teste e liberação do código. Esses processos podem ajudar você a entregar um produto funcionando nas mãos dos seus usuários mais rapidamente do que através de métodos tradicionais. Bem executado, um pipeline automatizado de build ajuda você e a sua equipe a entregarem de forma mais rápida e consistente software que funcione e a obterem feedback imediato das suas últimas alterações.

Vamos explorar as melhores práticas de integração e entrega contínuas que você deve pensar em aplicar ao seu pipeline.

Neste artigo:

Faça commit cedo e com frequência

Garantir que todo o seu código-fonte e todos os seus arquivos de configuração, scripts e dependências estejam armazenados no sistema de controle de versões é uma primeira etapa essencial na implementação da integração contínua.

Porém, não basta apenas um sistema de controle de versões — o modo de usá-lo faz diferença. O objetivo da integração contínua é facilitar a implementação de alterações feitas por vários colaboradores. A chave desta abordagem é fazer commits das suas alterações no código e compartilhá-las com mais frequência.

É assim que funciona:

  • Cada commit aciona um conjunto de testes automatizados, fornecendo feedback rápido sobre as suas alterações, para resolver rapidamente quaisquer bugs. Quanto mais frequentes forem os seus commits, mais regularmente você receberá esse feedback.
  • O compartilhamento frequente das alterações com a sua equipe garante que todos efetuem suas builds sobre uma mesma base, ajudando na colaboração e reduzindo o risco de conflitos de merge ao integrar alterações extensas e complexas.
  • Sua estratégia de branching determina para onde você faz o push das suas alterações — para o seu branch principal, um branch específico para recursos ou um reservado para desenvolvimento.
  • Como diretriz, tenha o objetivo de que todos na sua equipe façam commit das suas alterações e as compartilhem pelo menos uma vez por dia.

Superação dos obstáculos iniciais

Inicialmente, commits frequentes podem parecer incômodos, muitas vezes devido ao medo do escrutínio ou de ter mais tarefas do que seria possível realizar em um dia. É essencial criar dentro da equipe uma cultura de colaboração, não de julgamento. Ao implementar alterações nas práticas de trabalho, é útil discutir como a equipe trabalha em conjunto. Dividir tarefas em pedaços menores e mais administráveis pode ajudar as pessoas a adotarem essas práticas.

Mantenha os builds sempre verdes

Se você mantiver uma base de código constantemente apta para ser implantada, obterá o máximo das suas práticas de CI/CD. Esta abordagem aumenta a eficiência, ao corrigir bugs assim que aparecerem, e permite que você libere rapidamente uma correção se algo der errado na produção.

Embora testes automatizados e etapas de pipeline forneçam feedback imediato sobre se o seu código pode ser liberado, esta melhor prática se concentra em como você responde a qualquer problema revelado por esses procedimentos.

Resolva problemas em colaboração

A equipe deve assumir responsabilidade coletiva pelas builds, priorizando correções rápidas quando ocorrerem falhas. Em vez de culpar o último desenvolvedor que fez alterações, os membros da equipe devem colaborar para resolver os problemas, estimulando uma cultura construtiva que melhora o fluxo de trabalho de CI/CD e permite melhorias contínuas, especialmente sob pressão.

Evite falhas triviais

Para reduzir o risco de as builds falharem por causa de erros simples, como erros de sintaxe ou falta de dependências, os membros da equipe devem fazer builds e executar os testes iniciais localmente antes de compartilharem suas alterações. Todos devem usar os mesmos scripts que o sistema de CI/CD, para evitar a duplicação de esforços.

Use um único build de cada vez

Um erro comum é criar uma nova build para cada etapa do seu pipeline de CI/CD. Refazer a build para ambientes diferentes introduz o risco de inconsistências e significa que você não pode confiar que o código tenha passado em todos os testes anteriores.

Em vez disso, promova o mesmo artefato de build a cada etapa do pipeline de build e, por fim, libere-o para produção.

Mantenha builds independentes do sistema

Garanta que as suas builds permaneçam independentes do sistema, invocando variáveis, parâmetros de autenticação, arquivos de configuração ou scripts através do script de implantação, em vez de incorporá-los diretamente à build.

Versione e armazene os artefatos de build de forma centralizada

Trate os artefatos de build como produtos do seu código-fonte. Versione-os e armazene-os em um repositório central de artefatos como o Nexus, em vez de no seu sistema de controle de código-fonte.

Automatize a implantação

Use o seu servidor de CI para automatizar a implantação do mesmo artefato de build em cada ambiente de teste. À medida que o artefato passar por cada etapa, aumentará a confiabilidade dele para a sua equipe.

Otimize seus testes

Embora o CI/CD seja fortemente baseado em testes automatizados para garantir a qualidade do software, isso não significa que você deva testar todas as eventualidades.

É essencial atingir um equilíbrio entre a cobertura dos testes e o desempenho. Se os testes demorarem demais para produzirem resultados, há o risco de as pessoas procurarem motivos e maneiras de contornar ou acelerar o processo.

Adote a cobertura dos testes em camadas

Estruture a cobertura dos testes automatizados em camadas, começando com os testes de unidade e prosseguindo com os testes de integração ou de componentes.

Priorize o feedback rápido

Execute primeiro os testes que são completados mais rapidamente, para obter feedback o mais cedo possível. Tipicamente, os testes de unidade são os de execução mais rápida.

Considere executar testes em paralelo

Considere dividir os testes em lotes e executá-los em paralelo, para obter resultados ainda mais rápidos.

Calma com os testes mais longos

Introduza os testes de execução mais longa apenas depois que o código tiver passado nos testes mais rápidos e você tiver confiança na build.

Limite a dependência do controle manual de qualidade

Considerando o tempo e a disponibilidade da equipe necessários para o controle manual de qualidade, é melhor realizar essa fase só depois que todos os testes automatizados tiverem sido concluídos com sucesso.

Concentre-se nos testes de mais alto nível

Não use testes mais demorados para verificar todas as eventualidades. Priorize uma cobertura mais ampla com testes de mais baixo nível e concentre os testes de mais alto nível em áreas de maior risco, específicas do seu produto e de seus usuários.

Limpe seus ambientes

Manter ambientes de pré-produção sendo executados por um tempo muito longo pode fazer as configurações desses testes divergirem das iniciais e umas das outras. Esse desvio das configurações pode levar a resultados inconsistentes nos testes, prejudicando o seu processo de CI/CD.

Renovar os seus ambientes de teste e preparação entre as execuções do pipeline é uma melhor prática na qual vale a pena investir.

Use containers ou máquinas virtuais

Hospede os seus ambientes de teste em containers ou máquinas virtuais, para ter atualizações rápidas.

Faça uma abordagem de "infraestrutura como código"

Crie scripts para o processo de criar e desfazer ambientes. Então, você poderá automatizar essas etapas no seu servidor de CI/CD.

Pense na escalabilidade

Colocar a criação de ambientes em scripts facilita escalar o seu processo de CI/CD e executar vários pipelines ao mesmo tempo.

Evite ambientes estáticos

Se você optar por usar ambientes estáticos, precisará manter cada um deles para evitar o desvio de configurações. Isso pode retardar o processo de controle de qualidade e atrasar as liberações.

Garanta a segurança do seu pipeline

Um pipeline de CI/CD dá acesso ao seu código e às credenciais usadas para implantá-lo em produção, tornando-o um alvo preferencial de ataques. Portanto, é vital que você aplique as melhores práticas de segurança no seu processo de CI/CD.

  • Acesso ao controle de versões: Proteja o acesso aos seus repositórios de controle de versões e obrigue os seus colaboradores a usarem autenticação de vários fatores. Se você permitir que terceiros contribuam com alterações, tenha um procedimento de revisão das alterações deles antes de acionar uma build.
  • Gerenciamento de credenciais: Credenciais e chaves de API costumam ser necessárias para acessar serviços e ambientes no pipeline de CI/CD. Nunca armazene credenciais no código-fonte. Em vez disso, use um armazenamento secreto dedicado e assegure-se de que as credenciais não vazem para logs ou artefatos de build.
  • Verificação de dependências: Verifique a existência de vulnerabilidades conhecidas nas dependências de terceiros, como parte das suas verificações de integração contínua.
  • Comunicações seguras: Garanta que as comunicações entre o seu servidor de CI e as máquinas de build sejam seguras e mantenha todas as máquinas atualizadas com os últimos patches.
  • Princípio do menor privilégio: Aplique o princípio do menor privilégio em todo o seu pipeline. Isso dificulta que atacantes "saltem entre ilhas" se uma conta for comprometida.
  • Gerenciamento de alterações: Implemente o gerenciamento de alterações na configuração do seu pipeline, fazendo que todas as alterações sejam revisadas antes de serem aplicadas.

Não saia dos seus processos

Depois de investir na sua estratégia de CI/CD e criar um pipeline confiável que lhe dá confiança nas suas implantações, você não irá querer arruinar todo esse esforço permitindo que as pessoas contornem o processo.

É comum que as pessoas queiram contornar o processo de CI/CD para fazerem alterações pequenas ou urgentes, mas é importante não ceder, por vários motivos:

  • Pular etapas automatizadas de controle de qualidade pode introduzir bugs que, de outra forma, seriam detectados.
  • Problemas liberados para produção são mais difíceis de reproduzir e depurar sem uma build disponível para os testes.
  • Pode ser mais demorado diagnosticar e corrigir problemas de liberações "urgentes" que passar pelo processo normal automatizado.

Quando alguém pedir para contornar o processo, tire um momento para explicar os benefícios de um pipeline de CI/CD. Também vale a pena perguntar se alguma parte do seu processo atual pode ser melhorada.

Monitore e meça sua pipeline

Parte do processo de criar um pipeline consiste em implementar o monitoramento do ambiente de produção (ou seja, do produto).

A melhor prática é criar uma forma análoga de monitoramento para o próprio pipeline de CI/CD.

Analise as métricas de CI/CD

Use as métricas coletadas pela sua ferramenta de CI/CD para identificar problemas em potencial e áreas que podem melhorar.

Monitore a frequência das builds

Compare o número de builds acionadas por semana, dia ou hora, para compreender os padrões de uso da infraestrutura dos seus pipelines. Esse monitoramento ajuda a determinar se você precisa escalar e a identificar os horários de pico de carga.

Acompanhe a rapidez da implantação

Acompanhe a rapidez das implantações ao longo do tempo, para identificar tendências e avaliar quando investir em otimizações de desempenho.

Derive insights de testes automatizados

Use as estatísticas dos testes automatizados para identificar áreas que poderiam se beneficiar da paralelização.

Revise os resultados do controle de qualidade

Identifique os resultados de controle de qualidade que costumam ser ignorados, para ver onde você poderia otimizar a cobertura dos seus testes.

Faça com que seja um esforço de equipe

Criar um fluxo de trabalho bem-sucedido em CI/CD depende também da equipe e da cultura da empresa, não só dos processos e ferramentas que você usa.

Integração, entrega e implantação contínuas são processos essenciais de DevOps. Elas visam eliminar o isolamento tradicional entre desenvolvedores, técnicos em qualidade e as operações, encorajando a colaboração entre essas áreas. Há vários benefícios em adotar essas melhores práticas de DevOps.

Maior visibilidade e colaboração

Os membros da equipe ganham uma visão completa de todo o fluxo de trabalho e a oportunidade de colaborarem e se beneficiarem de diferentes áreas de conhecimento.

Responsabilidade compartilhada

Compartilhar a responsabilidade pela manutenção do pipeline evita que qualquer pessoa isolada possa se tornar um ponto único de falha.

Empoderamento e contribuição

Encorajar o compartilhamento da responsabilidade pela entrega do software dá a todos os membros da sua equipe o poder de contribuírem, seja corrigindo builds, automatizando tarefas ou melhorando processos.

Promoção de uma cultura de confiança

Promover uma cultura de confiança, na qual os membros da equipe podem experimentar e compartilhar ideias, beneficia a sua empresa e melhora o software que vocês entregam.

Quando as coisas dão errado, você pode usar essa oportunidade para aprender e tornar as suas práticas de CI/CD mais robustas e eficazes.

Por que seguir as melhores práticas em CI/CD?

Há vários benefícios em seguir as melhores práticas para integração, entrega e implantação contínuas.

Entrega acelerada

A automatização das tarefas de build, teste e implantação acelera o processo de liberação de versões, permitindo que você entregue atualizações do software mais rapidamente. O CI/CD automatizado é essencial para reduzir o tempo até a chegada ao mercado e entregar rapidamente novos recursos aos usuários.

Feedback regular

A implantação mais frequente de alterações pode permitir que você obtenha feedback regular dos usuários. Você pode usar esses insights para ajudar a refinar os planos e ajustar as estratégias.

Qualidade de código melhorada

Processos automatizados de controle de qualidade detectam bugs mais cedo no ciclo de desenvolvimento, levando a resoluções mais rápidas e contribuindo para criar um ciclo de mais qualidade do código e software mais robusto.

Maior satisfação dos usuários

As verificações automatizadas garantem que cada alteração seja verificada de forma consistente, minimizando o risco de bugs chegarem à produção. Como resultado, os usuários têm uma experiência mais tranquila e é muito menos provável que haja períodos de indisponibilidade.

Mais tempo para ser criativo

Autmatizar as etapas repetitivas de build, teste e implantação do software libera tempo para os membros da equipe se concentrarem em tarefas criativas, como o desenvolvimento de novos recursos, a criação de projetos inovadores ou a melhoria das práticas gerais de DevOps.

Como executar uma estratégia de implementação de CI/CD

Implementar a integração, entrega e/ou implantação contínua pode parecer uma tarefa assustadora. Uma estratégia bem-sucedida de CI/CD envolve vários elementos-chave e requer que se construa uma sólida cultura de DevOps ao longo do tempo.

Defina objetivos claros

Assim como nos projetos de desenvolvimento de software, é essencial definir objetivos e comunicá-los à sua equipe.

Quer você pretenda ter uma cadência de versões semanais com entrega contínua a um ambiente de pré-produção ou uma implantação contínua com rápidas atualizações para os usuários, é fundamental definir objetivos claros.

Trabalhe com partes administráveis

Depois de definir os objetivos, divida as etapas necessárias para atingi-los em partes administráveis. Uma implementação incremental do seu pipeline significa que você pode desfrutar dos benefícios do processo de CI/CD desde o início.

Comece com a CI

Para a maioria das equipes, o ponto de partida é a integração contínua. A CI envolve tarefas como controle de versões, estratégias de branching, adicionar ou expandir a cobertura dos testes automatizados e começar a automatizar as builds e testes. O uso de um servidor de CI ajudará você a coordenar essas atividades, organizar os resultados e implementar a lógica de automatização das etapas sucessivas de build e testes.

Prossiga para a CD

Depois de estabelecer um fluxo automatizado de CI, você pode prosseguir para a entrega ou implantação contínua.

Automatizar a criação de ambientes poupa tempo no longo prazo e torna o seu pipeline mais confiável e robusto. Então, você poderá usar esses ambientes para executar mais testes automatizados e manuais.

Analise os dados

Durante a implementação e depois de estabelecer uma estratégia de CI/CD, vale a pena analisar os dados das suas ferramentas de CI/CD e discuti-los com os membros da equipe, para identificar oportunidades de refinar o seu processo. Essa abordagem iterativa garante um aperfeiçoamento contínuo e maximiza os benefícios do processo de CI/CD para a sua equipe e a sua empresa.

Resumo

Adotar estas melhores práticas de DevOps ajudará você a extrair o máximo do seu processo de integração, entrega e implantação contínuas:

  • Faça commits frequentes do código. Isso facilita a integração das alterações e significa que você obterá feedback regular sobre o seu trabalho a partir de builds e testes automatizados.
  • Dê prioridade a que as suas builds passem em todos os testes. Manter a sua base de código em um estado pronto para implantação melhora a qualidade do código e garante que você possa resolver problemas urgentes na produção.
  • Faça a build apenas uma vez. Promover o mesmo artefato de build por ambientes sucessivos lhe dá a confiança de que o seu código passou em todas as etapas de testes.
  • Otimize os testes automatizados. Até mesmo testes automatizados demoram algum tempo para serem executados. Execute primeiro aqueles que derem um feedback mais rápido.
  • Renove os ambientes depois de cada execução do pipeline. Isso evita o desvio das configurações e garante que você possa confiar nos resultados de cada etapa de CI/CD.
  • Garanta a segurança do seu pipeline. Pipelines de CI/CD têm acesso ao seu código-fonte e ao ambiente de produção. Portanto, podem ser alvos lucrativos para os hackers. Implementar segurança é vital em CI/CD.
  • Não saia dos seus processos. Pode parecer tentador contornar o seu pipeline de CI/CD quando uma alteração for trivial ou urgente, mas isso costuma sair mais caro no longo prazo.
  • Monitore e meça sua pipeline. A análise dos dados do seu pipeline pode ajudar você a torná-lo mais robusto e eficiente.
  • Faça com que o processo seja um esforço de equipe. Manter o pipeline nunca deve ser tarefa de uma única pessoa. Adotar uma mentalidade de DevOps oferece diversos benefícios.

Como o TeamCity pode ajudar

O TeamCity é uma plataforma de automação de CI/CD que foi projetada para ajudar você a criar e escalar os seus pipelines de CI/CD. Não importa o seu nível atual de automação de builds e testes, é simples e direto começar a usar o TeamCity.

Integrações extensas com todos os principais sistemas de controle de versões, suporte a frameworks populares de build e teste e uma interface de usuário intuitiva, baseada na Web, significam que você pode criar o seu primeiro pipeline em poucos minutos. O suporte total à "configuração como código" permite que você gere todas as definições do seu pipeline a partir da interface de usuário e as armazene no controle de versões.

O projeto do TeamCity é altamente escalável e de alto desempenho, e garante um rápido feedback dos testes automatizados, ao passo que as integrações com IDEs e plataformas de mensagem de primeira linha fornecem notificações onde quer que você esteja trabalhando. Amplos recursos de segurança ajudam a manter o seu código-fonte e os seus pipelines a salvo de ataques.

À medida que o seu processo for amadurecendo, você pode aproveitar os relatórios de cobertura de testes incorporados ao TeamCity, a identificação de testes instáveis e estatísticas de agentes de build para continuar otimizando os seus processos de CI/CD.