CircleCI

Konfigurace pro Ruby na adrese Rails projektů není složitý a dokumentace přesně popisuje jednotlivé prvky souboru config.yml. Chtěl bych se však zaměřit na nástroje circleci, které se používají k pomoci nás zachovat kód čistotu a zajištění správné praxe.

RUBOCOP

Je pravděpodobné, že RuboCope není třeba představovat, nicméně pro ty, kteří jej neznají, se jedná o statický analyzátor a formátor kódu jazyka Ruby. Pokud již používáte rubocop ve svém projekt, stačí do konfiguračního souboru přidat CircleCI:

 běh:
    jméno: Rubocop
    příkaz: bundle exec rubocop

ESLINT

ESLint je nástroj pro identifikaci a hlášení vzorů nalezených v jazyce ECMAScript, resp. JavaScript kódu, aby byl kód konzistentnější a aby se předešlo chybám.

běh:
    název: Eslint
    příkaz: npm run eslint

RSPEC

V RSpecu jsou testy nejen skripty, které ověřují kód aplikace, ale také podrobné vysvětlení toho, jak by se aplikace měla chovat, vyjádřené jednoduchou angličtinou:

běh:
    jméno: RSpec
    command: |
      mkdir /tmp/test-results
      TEST_FILES="$(circleci tests glob "spec/_spec.rb" |
        circleci tests split --split-by=timings)"
      bundle exec rspec
        --format progress
        --format RspecJunitFormatter
        --out /tmp/test-results/rspec.xml
        --format progress
        $TEST_FILES

- store_test_results:
    cesta: /tmp/test-results

V případě RSpec uložíme výsledek testu do předem vytvořeného katalogu /tmp/test-results v souboru rspec.xml a poté pomocí příkazu ukládattestvýsledky ukládáme daný katalog. Nyní nám karta Insights umožní přístup k informacím, jako je medián času kompilace, čas poslední kompilace nebo úspěšnost. Více informací o kartě Insights si můžete přečíst zde. Pokud chceme soubor rspec.xml uložit jako "artefakt", musíme přidat příkaz store_artifacts v našem konfiguračním souboru.

 store_artifacts:
    cesta: /tmp/test-results

BRAKEMAN

Brakeman je nástroj statické analýzy, který kontroluje Ruby on Rails aplikací z hlediska bezpečnostních zranitelností. Ve výchozím nastavení vrátí Brakeman nenulový výstupní kód, pokud jsou zjištěna bezpečnostní varování nebo dojde k chybám při skenování. Proto jsme se zaměřili pouze na kritické chyby a varování jsme vypnuli.

běh:
    název: Brakeman
    příkaz: bundle exec brakeman --no-exit-on-warn

Pokud chceme výsledek skenování ukládat stejným způsobem jako RSpec, bude naše konfigurace vypadat takto a na kartě Artefakty budeme mít přístup k našemu souboru.

 běh:
    název: Brakeman
    příkaz: |
      mkdir /tmp/brakeman
      bundle exec brakeman --no-exit-on-warn -o /tmp/brakeman/output.json

- store_artifacts:
    cesta: /tmp/brakeman

RUBYCRITIC

RubyCritic je drahokam, který využívá drahokamy pro statickou analýzu, jako jsou Reek, Flay a Flog, a poskytuje zprávu o kvalitě vašeho kódu. Zpráva obsahuje hodnocení A / B / C / D / F, každý soubor v našem projektu, který chceme nechat zkontrolovat, a přesná místa, která je třeba zlepšit, a dokumentaci ke každému upozornění (např: TooManyMethods). Tento nástroj funguje jako poradce v projektu. Na základě obdržené zprávy závisí konečné rozhodnutí, zda je náš kód skutečně třeba opravit, na vývojáři. V naší konfiguraci circleci je přiřazena samostatná úloha, která je zodpovědná za přípravu reportu a odeslání speciálního komentáře s výsledkem na github.

Základní konfigurace programu rubycritic se neliší od předchozích.

 běh:
    jméno: Rubycritic
    příkaz: bundle exec rubycritic ./app -p /tmp/rubycritic -f json -f html --no-browser

- store_artifacts:
    cesta: /tmp/rubycritic

Standardně projdeme balíček s informacemi o tom, který adresář chceme skenovat ./app, na které místo chceme uložit výsledek -p /tmp/rubycritic (rubycritic automaticky vytvoří adresář, do kterého uložíme naši zprávu), v jakém formátu -f json a volbu -no- browser. Použijeme také gem circleci-coverage_reporter, který po skenování vloží na github do našeho pull requestu komentář s odkazem na zprávu a procentuálním hodnocením skenovaných souborů.

Aby výše uvedený gem správně fungoval společně s circleci, musíme jej přidat do našeho projektu a vygenerovat dva klíče (jeden z nich je circleci, druhý je github).

Standardní instalace:

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

 běh:
    jméno: Spustit Rubycritic
    příkaz: bundle exec rubycritic ./app -p /tmp/rubycritic -f json -f html --no-browser

 store_artifacts:
    cesta: /tmp/rubycritic

 run:
    name: Rubycritic notification
    příkaz: bundle exec rake circleci:report_coverage

Nyní musíme vygenerovat dva klíče:

COVERAGE_REPORTER_CIRCLECI_TOKEN

Sekce "nastavení" našeho projektu. Po výběru možnosti "Vytvořit token" změňte rozsah na "vše" a vyplňte štítek tokenu. Token k API bude vygenerován po kliknutí na tlačítko

COVERAGE_REPORTER_VCS_TOKEN

Rozsah klíče k repozitáři

Po vygenerování klíčů je musíme přidat do proměnných prostředí v položce Nastavení:

Vzorová konfigurace:

pracovních míst:
  stavět:
    docker:
      - image: circleci/ruby:2.5.1-node-browsers
      prostředí:
        BUNDLER_VERSION: 2.0.1
        BUNDLE_PATH: /bundle
        BUNDLE_JOBS: 4
        RAILS_ENV: test
    - image: circleci/postgres:10.1-alpine
      
        POSTGRES_USER: postgres
        POSTGRES_DB: example_test
        POSTGRES_PASSWORD: example
    - image: circleci/redis:4.0.8-alpine
    working_directory: ~/insights
    environment: (prostředí), v němž se nachází:
        TZ: Europe/Warsaw
    Kroky:
      - Pokračování: checkout
      - spustit:
          název: Nainstalovat bundler verze 2.0.1
          příkaz: gem install bundler -v 2.0.1
      - restore_cache:
          klíče:
            - v1-ruby-dependencies-(( checksum "Gemfile.lock" ))
            - v1-ruby-dependencies-
      - run:
          název: Bundle Install
          příkaz: bundle check || bundle install
      - save_cache:
          klíč: v1-ruby-dependencies-(( kontrolní součet "Gemfile.lock" ))
          paths:
            - vendor/bundle
      - restore_cache:
          klíče:
            - v1-npm-dependencies-(( checksum "package.json" ))
            - v1-npm-dependencies-
      - run:
          název: Npm Install
          příkaz: npm install
      - save_cache:
          klíč: v1-npm-dependencies-(( kontrolní součet "package.json" ))
          paths:
            - ~/insights/node_modules
      - spustit:
        name: Nastavení databáze
        command: |
          bundle exec rake db:create
          bundle exec rake db:schema:load
      - run:
          name: Rubocop
          příkaz: bundle exec rubocop
      - run:
          název: Eslint
          příkaz: npm run eslint
      - run:
          název: RSpec
          příkaz: |
            mkdir /tmp/test-results
            TEST_FILES="$(circleci tests glob "spec/_spec.rb" |
              circleci tests split --split-by=timings)"
            bundle exec rspec
              --format progress
              --format RspecJunitFormatter
              --out /tmp/test-results/rspec.xml
              --format progress
              $TEST_FILES
      - spustit:
          name: Brakeman
          příkaz: bundle exec brakeman --no-exit-on-warn
      - store_test_results:
          cesta: /tmp/test-results
  rubycritic:
    docker:
      - 2.5.1-node-browsers: image: circleci/ruby:2.5.1-node-browsers
        prostředí:
          BUNDLER_VERSION: 2.0.1
          BUNDLE_PATH: /bundle
          BUNDLE_JOBS: 4
          RAILS_ENV: test
          CIRCLE_ARTIFACTS: /tmp
    working_directory: ~/insights
    steps:
      - checkout
      - spustit:
          název: Nainstalovat bundler verze 2.0.1
          příkaz: gem install bundler -v 2.0.1
      - restore_cache:
          klíče:
            - v1-rubycritic-dependencies-(( checksum "Gemfile.lock" ))
            - v1-rubycritic-dependencies-
      - run:
          název: Bundle Install
          příkaz: bundle check || bundle install
      - save_cache:
          klíč: v1-rubycritic-dependencies-(( checksum "Gemfile.lock" ))
          paths:
            - vendor/bundle
      - run:
          name: Run Rubycritic
          příkaz: bundle exec rubycritic ./app -p /tmp/rubycritic -f json -f html --no-browser
      - store_artifacts:
          cesta: /tmp/rubycritic
      - run:
          name: Rubycritic notification
          příkaz: bundle exec rake circleci:report_coverage

pracovní postupy:
  verze: 2
  build_and_rubycritic:
    úlohy:
      - build
      - rubycritic:
          vyžaduje:
            - build

Zdroje:

• Seznam dostupných obrazů dockeru pro CircleCi

  • Obrazy aplikace Docker

• CircleCi

  • Konfigurace CircleCi

    • Vzorová konfigurace
    • Shromažďování testovacích dat
    • Používání aplikace Insights
    • Ukládání artefaktů sestavení

• Použité drahokamy nebo nástroje

  • RuboCop

    • ESlint
    • RSpec
    • Brzdař
    • RubyCtritic
    • Zpráva o pokrytí okruhu

Přečtěte si více:

• Osvědčené postupy společnosti Codest pro tvorbu softwaru: projektová dokumentace
• Jak napsat dobrý a kvalitní kód?
• Princip "otevřeno-uzavřeno". Musím ho někdy použít?