CircleCI

Konfiguracja dla projektów Ruby on Rails nie jest skomplikowana, a dokumentacja dokładnie opisuje każdy element config.yml. Chciałbym jednak skupić się na narzędziach circleci, które są używane, aby pomóc nam utrzymać konfigurację. kod czystość i zapewnienie dobrych praktyk.

RUBOCOP

Prawdopodobnie RuboCope nie wymaga przedstawiania, jednak dla tych, którzy nie są z nim zaznajomieni, jest to statyczny analizator i formater kodu Ruby. Jeśli już używasz rubocop w swoim projektWystarczy dodać CircleCI do pliku konfiguracyjnego:

 run:
    nazwa: Rubocop
    polecenie: bundle exec rubocop

ESLINT

ESLint jest narzędziem do identyfikowania i raportowania wzorców znalezionych w ECMAScript lub JavaScript aby kod był bardziej spójny i aby uniknąć błędów.

run:
    nazwa: Eslint
    polecenie: npm run eslint

RSPEC

W RSpec testy to nie tylko skrypty weryfikujące kod aplikacji, ale także szczegółowe wyjaśnienia, jak aplikacja powinna się zachowywać, wyrażone w prostym języku angielskim:

run:
    name: RSpec
    polecenie: |
      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:
    path: /tmp/test-results

W przypadku RSpec zapisujemy wynik testu we wcześniej utworzonym katalogu /tmp/test-results w pliku rspec.xml, a następnie za pomocą funkcji skleptestwyniki przechowujemy dany katalog. Teraz zakładka Insights da nam dostęp do takich informacji jak mediana czasu kompilacji, czas ostatniej kompilacji czy współczynnik sukcesu. Możesz przeczytać więcej o zakładce Insights tutaj. Jeśli chcemy przechowywać plik rspec.xml jako "artefakt", musimy dodać atrybut store_artifacts w naszym pliku konfiguracyjnym.

 store_artifacts:
    path: /tmp/test-results

BRAKEMAN

Brakeman to narzędzie do analizy statycznej, które sprawdza aplikacje Ruby on Rails pod kątem luk w zabezpieczeniach. Domyślnie Brakeman zwraca niezerowy kod wyjścia w przypadku wykrycia ostrzeżeń dotyczących bezpieczeństwa lub napotkania błędów skanowania. Dlatego skupiliśmy się tylko na krytycznych błędach, a ostrzeżenia zostały wyłączone.

bieg:
    nazwa: Brakeman
    polecenie: bundle exec brakeman --no-exit-on-warn

Jeśli chcemy również przechowywać wynik skanowania w taki sam sposób jak RSpec, nasza konfiguracja będzie wyglądać następująco, a dostęp do naszego pliku będziemy mieli w zakładce Artifacts.

 bieg:
    nazwa: Brakeman
    polecenie: |
      mkdir /tmp/brakeman
      bundle exec brakeman --no-exit-on-warn -o /tmp/brakeman/output.json

- store_artifacts:
    path: /tmp/brakeman

RUBYCRITIC

RubyCritic to gem, który używa gemów do analizy statycznej, takich jak Reek, Flay i Flog, aby dostarczyć raport o jakości kodu. Raport zawiera ocenę A / B / C / D / F, każdy plik w naszym projekcie, który chcemy przeskanować i dokładne miejsca, które wymagają poprawy, a także dokumentację z każdym alertem (np: TooManyMethods). Narzędzie to pełni rolę konsultanta w projekcie. Na podstawie otrzymanego raportu ostateczna decyzja o tym, czy nasz kod faktycznie wymaga poprawek, zależy od dewelopera. W naszej konfiguracji circleci przypisany jest osobny job odpowiedzialny za przygotowanie raportu i wysłanie specjalnego komentarza z wynikiem na githuba.

Podstawowa konfiguracja rubycritic nie różni się od poprzednich.

 run:
    name: Rubycritic
    polecenie: bundle exec rubycritic ./app -p /tmp/rubycritic -f json -f html --no-browser

- store_artifacts:
    path: /tmp/rubycritic

Standardowo uruchamiamy bundle z informacją, który katalog chcemy przeskanować ./app, w którym miejscu chcemy zapisać wynik -p /tmp/rubycritic (rubycritic automatycznie tworzy katalog, w którym będziemy przechowywać nasz raport), w jakim formacie -f json i opcja -no- browser. Używamy również gema circleci-coverage_reporter, który po skanowaniu umieszcza komentarz na githubie w naszym pull request z linkiem do raportu i procentową oceną przeskanowanych plików.

Aby powyższy gem działał poprawnie razem z circleci, musimy dodać go do naszego projektu i wygenerować dwa klucze (jeden z nich to circleci, drugi to github).

Instalacja standardowa:

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

 run:
    name: Run Rubycritic
    polecenie: bundle exec rubycritic ./app -p /tmp/rubycritic -f json -f html --no-browser

 store_artifacts:
    path: /tmp/rubycritic

 run:
    name: Rubycritic notification
    polecenie: bundle exec rake circleci:report_coverage

Teraz musimy wygenerować dwa klucze:

COVERAGE_REPORTER_CIRCLECI_TOKEN

Sekcja "ustawienia" naszego projektu. Po wybraniu "Create Token" zmieniamy zakres na "all" i wypełniamy etykietę tokena. Token do API zostanie wygenerowany po kliknięciu

COVERAGE_REPORTER_VCS_TOKEN

Zakres klucza do repozytorium

Po wygenerowaniu kluczy, musimy dodać je do naszych zmiennych środowiskowych w Ustawienia:

Przykładowa konfiguracja:

praca:
  build:
    docker:
      - image: circleci/ruby:2.5.1-node-browsers
      środowisko:
        BUNDLER_VERSION: 2.0.1
        BUNDLE_PATH: /bundle
        BUNDLE_JOBS: 4
        RAILS_ENV: test
    - image: circleci/postgres:10.1-alpine
      environment:
        POSTGRES_USER: postgres
        POSTGRES_DB: example_test
        POSTGRES_PASSWORD: example
    - image: circleci/redis:4.0.8-alpine
    working_directory: ~/insights
    środowisko:
        TZ: Europa/Warszawa
    kroki:
      - checkout
      - run:
          nazwa: Zainstaluj bundler w wersji 2.0.1
          polecenie: gem install bundler -v 2.0.1
      - restore_cache:
          keys:
            - v1-ruby-dependencies-(( suma kontrolna "Gemfile.lock" ))
            - v1-ruby-dependencies-
      - run:
          nazwa: Bundle Install
          polecenie: bundle check || bundle install
      - save_cache:
          key: v1-ruby-dependencies-(( checksum "Gemfile.lock" ))
          paths:
            - vendor/bundle
      - restore_cache:
          keys:
            - v1-npm-dependencies-(( checksum "package.json" ))
            - v1-npm-dependencies-
      - run:
          nazwa: Npm Install
          polecenie: npm install
      - save_cache:
          key: v1-npm-dependencies-(( checksum "package.json" ))
          paths:
            - ~/insights/node_modules
      - run:
        nazwa: Konfiguracja bazy danych
        polecenie: |
          bundle exec rake db:create
          bundle exec rake db:schema:load
      - run:
          name: Rubocop
          polecenie: bundle exec rubocop
      - run:
          name: Eslint
          polecenie: npm run eslint
      - run:
          name: RSpec
          polecenie: |
            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
      - run:
          name: Brakeman
          polecenie: bundle exec brakeman --no-exit-on-warn
      - store_test_results:
          path: /tmp/test-results
  rubycritic:
    docker:
      - image: circleci/ruby:2.5.1-node-browsers
        środowisko:
          BUNDLER_VERSION: 2.0.1
          BUNDLE_PATH: /bundle
          BUNDLE_JOBS: 4
          RAILS_ENV: test
          CIRCLE_ARTIFACTS: /tmp
    working_directory: ~/insights
    kroki:
      - checkout
      - run:
          nazwa: Zainstaluj bundler w wersji 2.0.1
          polecenie: gem install bundler -v 2.0.1
      - restore_cache:
          keys:
            - v1-rubycritic-dependencies-(( suma kontrolna "Gemfile.lock" ))
            - v1-rubycritic-dependencies-
      - run:
          nazwa: Bundle Install
          polecenie: bundle check || bundle install
      - save_cache:
          key: v1-rubycritic-dependencies-(( suma kontrolna "Gemfile.lock" ))
          paths:
            - vendor/bundle
      - run:
          name: Run Rubycritic
          polecenie: bundle exec rubycritic ./app -p /tmp/rubycritic -f json -f html --no-browser
      - store_artifacts:
          path: /tmp/rubycritic
      - run:
          name: Rubycritic notification
          polecenie: bundle exec rake circleci:report_coverage

przepływy pracy:
  wersja: 2
  build_and_rubycritic:
    jobs:
      - build
      - rubycritic:
          wymaga:
            - build

Źródła:

• Lista dostępnych obrazów docker dla CircleCi

  • Obrazy Docker

• CircleCi

  • Konfiguracja CircleCi

    • Przykładowa konfiguracja
    • Zbieranie danych testowych
    • Korzystanie z funkcji Insights
    • Przechowywanie artefaktów kompilacji

• Używane klejnoty lub narzędzia

  • RuboCop

    • ESlint
    • RSpec
    • Brakeman
    • RubyCtritic
    • Raport o zasięgu okręgu

Czytaj więcej:

• Dobre praktyki Codest dotyczące tworzenia oprogramowania: dokumentacja projektu
• Jak napisać dobry i jakościowy kod?
• Zasada otwarte-zamknięte. Czy kiedykolwiek będę musiał jej użyć?