CírculoCI

A configuração para Rubi sobre Carris projectos não é complicado, e o documentação descreve com exatidão cada elemento do config.yml. No entanto, eu gostaria de focar nas ferramentas circleci que são usadas para ajudar nós manter o código limpar e garantir boas práticas.

RUBOCOP

É provável que o RuboCope não precise de introdução, no entanto, para aqueles que não estão familiarizados com ele, é um analisador e formatador de código Ruby estático. Se você já usa rubocop no seu projetobasta adicionar CircleCI ao ficheiro de configuração:

 correr:
    nome: Rubocop
    comando: bundle exec rubocop

ESLINT

O ESLint é uma ferramenta para identificar e comunicar padrões encontrados no ECMAScript ou no JavaScript para tornar o código mais coerente e evitar erros.

correr:
    nome: Eslint
    comando: npm run eslint

RSPEC

No RSpec, os testes não são apenas scripts que verificam o código da aplicação, são também explicações detalhadas de como a aplicação se deve comportar, expressas em inglês simples:

correr:
    nome: RSpec
    comando: |
      mkdir /tmp/test-results
      TEST_FILES="$(circleci tests glob "spec/_spec.rb" |
        circleci tests split --split-by=timings)"
      bundle exec rspec
        --formato progresso
        --formato RspecJunitFormatter
        --out /tmp/test-results/rspec.xml
        --formato progresso
        $TEST_FILES

- armazenar_resultados_do_teste:
    path: /tmp/test-results

No caso do RSpec, salvamos o resultado do teste em um catálogo criado anteriormente /tmp/test-results no arquivo rspec.xml e, em seguida, usando o lojatesteresultados armazenamos um determinado catálogo. Agora, o separador Informações dá-nos acesso a informações como o tempo médio de compilação, a hora da última compilação ou a taxa de sucesso. Pode ler mais sobre o separador Informações aqui. Se quisermos armazenar o ficheiro rspec.xml como um "artefacto", temos de adicionar a opção armazenar_artifactos no nosso ficheiro de configuração.

 armazenar_artifactos:
    path: /tmp/test-results

BRAKEMAN

O Brakeman é uma ferramenta de análise estática que verifica Ruby on Rails aplicações para vulnerabilidades de segurança. Por padrão, o Brakeman retornará um código de saída diferente de zero se forem detectados avisos de segurança ou se forem encontrados erros de verificação. Por isso, concentramo-nos apenas nos erros críticos e os avisos foram desactivados.

correr:
    nome: Brakeman
    comando: bundle exec brakeman --no-exit-on-warn

Se também quisermos armazenar o resultado da verificação da mesma forma que o RSpec, a nossa configuração será semelhante a esta e teremos acesso ao nosso ficheiro no separador Artefactos.

 correr:
    nome: Brakeman
    comando: |
      mkdir /tmp/brakeman
      bundle exec brakeman --no-exit-on-warn -o /tmp/brakeman/output.json

- store_artifacts:
    path: /tmp/brakeman

RUBYCRITIC

RubyCritic é uma gem que usa gems para análise estática, como Reek, Flay e Flog, para fornecer um relatório sobre a qualidade do seu código. O relatório contém uma classificação A / B / C / D / F, todos os ficheiros do nosso projeto que queremos que sejam analisados e os locais exactos que precisam de ser melhorados, e documentação com cada alerta (ex: DemasiadosMétodos). Esta ferramenta funciona como um consultor no projeto. Com base no relatório recebido, a decisão final sobre se o nosso código precisa efetivamente de ser corrigido depende do programador. Na nossa configuração do circleci, é atribuído um trabalho separado que é responsável pela preparação do relatório e pelo envio de um comentário especial com o resultado no github.

A configuração básica do rubycritic não é diferente das anteriores.

 correr:
    nome: Rubycritic
    comando: bundle exec rubycritic ./app -p /tmp/rubycritic -f json -f html --no-browser

- store_artifacts:
    path: /tmp/rubycritic

Como padrão, percorremos o pacote com informações sobre qual diretório queremos escanear ./app, em que lugar queremos salvar o resultado -p /tmp/rubycritic (o rubycritic cria automaticamente um diretório no qual armazenaremos nosso relatório), em que formato -f json e a opção -no- browser. Também usamos a gem circleci-coverage_reporterque, após a verificação, coloca um comentário no github no nosso pull request com um link para o relatório e uma classificação percentual dos ficheiros verificados.

Para que a gem acima funcione corretamente em conjunto com circleci, temos de a adicionar ao nosso projeto e gerar duas chaves (uma delas é circleci, a segunda é github).

Instalação standard:

• Ficheiro Gemfile
  gem 'circleci-coverage_reporter'
• Rakefile
  require 'circleci/coverage_reporter/rake_task' if ENV['CIRCLECI']
• .config.yml

 correr:
    nome: Executar o Rubycritic
    comando: bundle exec rubycritic ./app -p /tmp/rubycritic -f json -f html --no-browser

 store_artifacts:
    path: /tmp/rubycritic

 executar:
    name: Rubycritic notification
    comando: bundle exec rake circleci:report_coverage

Agora temos de gerar duas chaves:

COVERAGE_REPORTER_CIRCLECI_TOKEN

Secção "definições" do nosso projeto. Depois de selecionar "Create Token", altere o âmbito para "all" e preencha a etiqueta do Token. O token para a API será gerado depois de clicar em

COVERAGE_REPORTER_VCS_TOKEN

Âmbito da chave para o repositório

Depois de gerar as chaves, temos de as adicionar às nossas variáveis de ambiente em Definições:

Exemplo de configuração:

trabalhos:
  construir:
    doca:
      - imagem: circleci/ruby:2.5.1-node-browsers
      ambiente:
        BUNDLER_VERSION: 2.0.1
        BUNDLE_PATH: /bundle
        BUNDLE_JOBS: 4
        RAILS_ENV: teste
    - imagem: circleci/postgres:10.1-alpine
      ambiente:
        POSTGRES_USER: postgres
        POSTGRES_DB: exemplo_teste
        POSTGRES_PASSWORD: exemplo
    - imagem: circleci/redis:4.0.8-alpine
    working_directory: ~/insights
    ambiente:
        TZ: Europa/Warsóvia
    passos:
      - checkout
      - executar:
          nome: Instalar o bundler versão 2.0.1
          comando: gem install bundler -v 2.0.1
      - restore_cache:
          chaves:
            - v1-ruby-dependencies-(( checksum "Gemfile.lock" ))
            - v1-ruby-dependencies-
      - executar:
          nome: Bundle Install
          comando: bundle check || bundle install
      - save_cache:
          key: v1-ruby-dependencies-(( checksum "Gemfile.lock" ))
          caminhos:
            - vendor/bundle
      - restaurar_cache:
          chaves:
            - v1-npm-dependencies-(( checksum "package.json" ))
            - v1-npm-dependencies-
      - executar:
          nome: Npm Install
          comando: npm install
      - save_cache:
          key: v1-npm-dependencies-(( checksum "package.json" ))
          paths:
            - ~/insights/node_modules
      - executar:
        nome: Database setup
        comando: |
          bundle exec rake db:create
          bundle exec rake db:schema:load
      - executar:
          nome: Rubocop
          comando: bundle exec rubocop
      - executar:
          nome: Eslint
          comando: npm run eslint
      - executar:
          nome: RSpec
          comando: |
            mkdir /tmp/test-results
            TEST_FILES="$(circleci tests glob "spec/_spec.rb" |
              circleci tests split --split-by=timings)"
            bundle exec rspec
              --formato progresso
              --formato RspecJunitFormatter
              --out /tmp/test-results/rspec.xml
              --formato progresso
              $TEST_FILES
      - executar:
          nome: Brakeman
          comando: bundle exec brakeman --no-exit-on-warn
      - store_test_results:
          path: /tmp/test-results
  rubycritic:
    docker:
      - imagem: circleci/ruby:2.5.1-node-browsers
        ambiente:
          BUNDLER_VERSION: 2.0.1
          BUNDLE_PATH: /bundle
          BUNDLE_JOBS: 4
          RAILS_ENV: test
          CIRCLE_ARTIFACTS: /tmp
    working_directory: ~/insights
    passos:
      - checkout
      - executar:
          nome: Instalar bundler versão 2.0.1
          comando: gem install bundler -v 2.0.1
      - restore_cache:
          keys:
            - v1-rubycritic-dependencies-(( checksum "Gemfile.lock" ))
            - v1-rubycritic-dependencies-
      - executar:
          nome: Bundle Install
          comando: bundle check || bundle install
      - save_cache:
          key: v1-rubycritic-dependencies-(( checksum "Gemfile.lock" ))
          caminhos:
            - vendor/bundle
      - run:
          name: Executar Rubycritic
          comando: bundle exec rubycritic ./app -p /tmp/rubycritic -f json -f html --no-browser
      - store_artifacts:
          path: /tmp/rubycritic
      - executar:
          name: Rubycritic notification
          comando: bundle exec rake circleci:report_coverage

fluxos de trabalho:
  versão: 2
  build_and_rubycritic:
    trabalhos:
      - construir
      - rubycritic:
          requer:
            - construir

Fontes:

• Lista de imagens docker disponíveis para o CircleCi

  • Imagens Docker

• CírculoCi

  • Configuração CircleCi

    • Exemplo de configuração
    • Recolher dados de teste
    • Utilizar o Insights
    • Armazenamento de artefactos de construção

• Gemas ou ferramentas usadas

  • RuboCop

    • ESlint
    • RSpec
    • Guarda-freio
    • RubyCtritic
    • Relatório de cobertura do círculo

Ler mais:

• Boas práticas da Codest para a construção de software: documentação do projeto
• Como escrever um código bom e de qualidade?
• Princípio aberto-fechado. Alguma vez terei de o usar?