はじめよう

言語ガイド: Ruby

このガイドでは、CircleCI で Ruby on Rails アプリケーションをビルドする方法について説明します。

概要

お急ぎの場合は、後述の設定ファイルの例をプロジェクトのルート ディレクトリにある .circleci/config.yml に貼り付け、ビルドを開始してください。

CircleCI は、以下のページで Ruby on Rails サンプル プロジェクトを提供しています。

このプロジェクトには、コメント付きの CircleCI 設定ファイル .circleci/config.yml が含まれます。

このアプリケーションでは、最新の安定した Rails バージョン 5.1 (rspec-rails)、RspecJunitFormatter、および PostgreSQL データベースを使用しています。

このアプリケーションのビルドには、ビルド済み CircleCI Docker イメージの 1 つを使用しています。

CircleCI のビルド済み Docker イメージ

CircleCI のビルド済みイメージを使用することを検討してください。このイメージには、CI 環境で役立つツールがプリインストールされています。 Docker Hub (https://hub.docker.com/r/circleci/ruby/) から必要な Ruby バージョンを選択できます。

セカンダリ「サービス」コンテナとして使用するデータベース イメージも Docker Hub の circleci ディレクトリで提供されています。

設定ファイルの例

version: 2 # CircleCI 2.0 を使用します
jobs: # 一連のステップ
  build: # ワークフローを使用しない実行では、エントリポイントとして `build` ジョブが必要です
    parallelism: 3 # このジョブのインスタンスを 3 つ並列実行します
    docker: # Docker でステップを実行します
      - image: circleci/ruby:2.4.2-jessie-node # このイメージをすべての `steps` が実行されるプライマリ コンテナとして使用します
        environment: # プライマリ コンテナの環境変数
          BUNDLE_JOBS: 3
          BUNDLE_RETRY: 3
          BUNDLE_PATH: vendor/bundle
          PGHOST: 127.0.0.1
          PGUSER: circleci-demo-ruby
          RAILS_ENV: test
      - image: circleci/postgres:9.5-alpine # データベース イメージ
        environment: # データベースの環境変数
          POSTGRES_USER: circleci-demo-ruby
          POSTGRES_DB: rails_blog
          POSTGRES_PASSWORD: ""
    steps: # 実行可能コマンドの集合
      - checkout # ソース コードを作業ディレクトリにチェックアウトする特別なステップ

      # Bundler のバージョンを指定します

      - run:
          name: Bundler の指定
          command: bundle -v

      # バンドル キャッシュを復元します
      # 依存関係キャッシュについては https://circleci.com/ja/docs/2.0/caching/ をお読みください

      - restore_cache:
          keys:
            - rails-demo-bundle-v2-{{ checksum "Gemfile.lock" }}
            - rails-demo-bundle-v2-

      - run: # Ruby の依存関係をインストールします
          name: バンドル インストール
          command: bundle check --path vendor/bundle || bundle install --deployment

      # Ruby の依存関係のバンドル キャッシュを保存します

      - save_cache:
          key: rails-demo-bundle-v2-{{ checksum "Gemfile.lock" }}
          paths:
            - vendor/bundle

      # アプリケーションで Webpacker または Yarn を他の何らかの方法で使用する場合にのみ必要です

      - restore_cache:
          keys:
            - rails-demo-yarn-{{ checksum "yarn.lock" }}
            - rails-demo-yarn-

      - run:
          name: Yarn のインストール
          command: yarn install --cache-folder ~/.cache/yarn

      # Yarn または Webpacker のキャッシュを保存します

      - save_cache:
          key: rails-demo-yarn-{{ checksum "yarn.lock" }}
          paths:
            - ~/.cache/yarn

      - run:
          name: DB の待機
          command: dockerize -wait tcp://localhost:5432 -timeout 1m

      - run:
          name: データベースのセットアップ
          command: bin/rails db:schema:load --trace

      - run:
          name: RSpec の並列実行
          command: |
            bundle exec rspec --profile 10 \
                              --format RspecJunitFormatter \
                              --out test_results/rspec.xml \
                              --format progress \
                              $(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)

      # タイミング解析のテスト結果を保存します

      - store_test_results: # テスト サマリー (https://circleci.com/ja/docs/2.0/collect-test-data/) に表示するテスト結果をアップロードします
          path: test_results
      # デプロイの構成例については https://circleci.com/ja/docs/2.0/deployment-integrations/ を参照してください

Ruby on Rails のデモ プロジェクトのビルド

CircleCI を初めて使用する際は、プロジェクトをご自身でビルドしてみることをお勧めします。 以下に、ユーザー自身のアカウントを使用してデモ プロジェクトをビルドする方法を示します。

  1. お使いのアカウントに、GitHub 上のプロジェクトをフォークします。
  2. CircleCI で ［Add Projects (プロジェクトの追加)] ページにアクセスし、フォークしたプロジェクトの横にある [Build Project (プロジェクトのビルド)] ボタンをクリックします。
  3. 変更を加えるには、.circleci/config.yml ファイルを編集してコミットします。 コミットを GitHub にプッシュすると、CircleCI がそのプロジェクトをビルドしてテストします。

設定ファイルの詳細

config.yml は必ず version キーから始めます。 このキーは、互換性を損なう変更に関する警告を表示するために使用します。

version: 2

次に、jobs キーを追加します。 1 つひとつのジョブが、ビルド、テスト、デプロイのプロセス内の各段階を表します。 このサンプル アプリケーションには 1 つの build ジョブのみが必要なので、他のすべてのオプションはこのキーの下にネストします。

各ジョブには、working_directory を指定するオプションがあります。 このサンプルの設定ファイルでは、ホーム ディレクトリにあるプロジェクトから作業ディレクトリの名前が付けられています。

version: 2
jobs:
  build:
    parallelism: 3
    working_directory: ~/circleci-demo-ruby-rails

他のディレクトリを指定しない限り、以降の job ではこのパスがデフォルトの作業ディレクトリとなります。

working_directory の直下の docker キーで、コンテナ イメージを指定できます。

    docker:
      - image: circleci/ruby:2.4.2-jessie-node  # 言語イメージ
        environment:
          BUNDLE_JOBS: 3
          BUNDLE_RETRY: 3
          BUNDLE_PATH: vendor/bundle
          PGHOST: 127.0.0.1
          PGUSER: circleci-demo-ruby
          RAILS_ENV: test
      - image: circleci/postgres:9.5-alpine  # サービス イメージ
        environment:
          POSTGRES_USER: circleci-demo-ruby
          POSTGRES_DB: rails_blog
          POSTGRES_PASSWORD: ""

この例では、以下の 2 つの CircleCI コンビニエンス イメージが使用されています。

  • Debian Jessie 上で実行され、Ruby 2.4.2 と Node.js をインストールする言語イメージ

  • Alpine Linux 上で実行され、PostgreSQL 9.5 をインストールするサービス イメージ

次に、テスト目的でアプリケーション コンテナをデータベースに接続するための環境変数がいくつか追加されています。 BUNDLE_* 環境変数は、適切にキャッシュを実行し、Bundler で依存関係をインストールする際のパフォーマンスと信頼性を向上させるために設定されます。

最後に build ジョブ内にいくつかの steps を追加します。

CircleCI がコードベースで動作するように、最初に checkout を置きます。

steps:
  - checkout

このステップは、プロジェクト コードを作業ディレクトリにチェックアウトするように CircleCI に指示します。

その後、CircleCI はキャッシュをプル ダウンします (存在する場合)。 初回実行時、または Gemfile.lock を変更した場合、これは実行されません。 さらに bundle install コマンドが実行され、プロジェクトの依存関係がプル ダウンされます。 通常、このタスクは必要時に自動的に実行されるため、これを直接呼び出すことはありません。ただし、このタスクを直接呼び出すことで、save_cache ステップを使用して依存関係を保存し、次回の処理を高速化することができます。 bundle install に --deployment フラグを使用すると、システムの場所ではなく ./vendor/bundle にインストールできます。

steps:
  # ...

  # バンドル キャッシュを復元します

  - restore_cache:
      keys:
        - rails-demo-bundle-v2-{{ checksum "Gemfile.lock" }}
        - rails-demo-bundle-v2-

  - run:
      name: バンドル インストール
      command: bundle check --path vendor/bundle || bundle install --deployment

  # バンドル キャッシュを保存します

  - save_cache:
      key: rails-demo-bundle-v2-{{ checksum "Gemfile.lock" }}
      paths:
        - vendor/bundle

JavaScript の依存関係用に Webpack または Yarn を使用する場合は、設定ファイルに以下の行も追加する必要があります。

steps:
  # ...

  # アプリケーションで Webpacker または Yarn を他の何らかの方法で使用する場合にのみ必要です

  - restore_cache:
      keys:
        - rails-demo-yarn-{{ checksum "yarn.lock" }}
        - rails-demo-yarn-

  - run:
      name: Yarn のインストール
      command: yarn install --cache-folder ~/.cache/yarn

  # Yarn または Webpacker のキャッシュを保存します

  - save_cache:
      key: rails-demo-yarn-{{ checksum "yarn.lock" }}
      paths:
        - ~/.cache/yarn

次のセクションでは、テスト データベースを設定します。 ここでは、dockerize ユーティリティを使用して、データベース サービスが使用可能になるまでプライマリ コンテナのメイン処理の開始を遅らせています。

steps:
  # ...

  # データベースをセットアップします

  - run:
      name: DB の待機
      command: dockerize -wait tcp://localhost:5432 -timeout 1m

  - run:
      name: データベースのセットアップ
      command: bin/rails db:schema:load --trace

その後 bundle exec rspec によって実際のテストが並列実行されます。

テストが正常に終了したら、store_test_results を使用してテスト結果を保存します。このため、ビルドの失敗は、CircleCI アプリケーションのテスト サマリー セクションにすぐに表示されます。これが Gemfile に RspecJunitFormatter を追加することのメリットです。

そこから、これを目的の継続的デプロイ スキームに結び付けることができます。

steps:
  # ...

  # RSpec を並列実行します

  - run: |
      bundle exec rspec --profile 10 \
                        --format RspecJunitFormatter \
                        --out test_results/rspec.xml \
                        --format progress \
                        $(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)

  # タイミング解析のテスト結果を保存します

  - store_test_results:
      path: test_results

RSpec テスト スイートには、以下の 2 つのフォーマッタが指定されています。

  • RspecJunitFormatter: JUnit スタイル テストの結果を出力する
  • progress: 実行中のビルド出力を表示する

--profile オプションは、各実行の最も遅い例を報告します。

circleci tests glob コマンドと circleci tests split コマンドの詳細については、CircleCI CLI による並列処理に関するドキュメントを参照してください。

関連項目

デプロイ ターゲットの構成例については、「デプロイの構成」を参照してください。

このアプリケーションは Ruby on Rails Web アプリケーションの最もシンプルな構成例であり、実際のプロジェクトはこれよりも複雑です。このため、独自のプロジェクトを構成する際は、以下のサイトのさらに詳細な実際のアプリの例が参考になります。