【Rails7】RailsアプリケーションのDocker化 + GitHubActionsでCIを設定する

はじめに

Railsのみのアプリケーションを作成したけど、その後のDockerにマウントさせる方法とGitHubActionsによるCI設定がわからない、、、という人向けにハンズオン形式で流れをまとめてみました。

Railsアプリケーションの開発環境

• Ruby 3.2.2
• Ruby on Rails 7.0.8
• PostgreSQL
• esbuild(バンドラー)

Railsアプリケーションの作成

rails new mount_docker -j esbuild -d postgresql

cd mount_docker

Dockerの設定

作業ディレクトリ直下にDockerfileを作成します。

touch Dockerfile

FROM ruby:3.2.2

RUN apt-get update -qq && apt-get install -y nodejs postgresql-client
RUN mkdir /app
WORKDIR /app

COPY Gemfile /app/Gemfile
COPY Gemfile.lock /app/Gemfile.lock

RUN bundle install
COPY . /app

COPY entrypoint.sh /usr/bin/

RUN chmod +x /usr/bin/entrypoint.sh

ENTRYPOINT ["entrypoint.sh"]

EXPOSE 3000

CMD ["rails", "server", "-b", "0.0.0.0"]

サーバー起動時の対策として、entrypoint.shを同じく作業ディレクトリ直下に作成します。

touch entrypoint.sh

#!/bin/bash
set -e

# Remove a potentially pre-existing server.pid for Rails.
rm -f /myapp/tmp/pids/server.pid

# Then exec the container's main process (what's set as CMD in the Dockerfile).
exec "$@"

次にdocker-compose.ymlを作成します。

touch docker-compose.yml

version: '3'
services:
  db:
    image: postgres
    volumes:
      - postgresql-data:/var/lib/postgresql/data
    environment:
      POSTGRES_USER: ${DATABASE_USERNAME}
      POSTGRES_PASSWORD: ${DATABASE_PASSWORD}
    ports:
      - '5433:5433'
  web:
    build: .

    command: bash -c "rm -f tmp/pids/server.pid && bundle exec rails s -p 8000 -b '0.0.0.0'"
    volumes:
      - .:/app
    ports:
      - '8000:8000'

    depends_on:
      - db
volumes:
  postgresql-data:
    driver: local

環境変数の秘匿化とdatabase.ymlの設定

Gemfile

group :development, :test do
  gem 'dotenv-rails'
end

.env

touch .env

.env

DATABASE_USERNAME=xxxxxxxx
DATABASE_PASSWORD=xxxxxxxx

database.yml

default: &default
  adapter: postgresql
  encoding: unicode
  host: db
  username: <%= ENV['DATABASE_USERNAME'] %>
  password: <%= ENV['DATABASE_PASSWORD'] %>
  pool: 5

development:
  <<: *default
  database: app_development

test:
  <<: *default
  database: app_test
  
# 本番の設定は適宜変更してください。

Docker起動とサーバーの立ち上げ

docker-compose build

docker-compose up -d

docker-compose exec web bash

rails db:create

localhost:8000でブラウザ表示を確認

GitHubActionsによるRspec・RubocopのCI設定

作業ディレクトリ直下にCI用のファイルを作成します。

mkdir -p .github/workflows && touch .github/workflows/ci.yml

.github/workflows/ci.yml

name: Continuous Integration

on:
  push:

jobs:
  rspec:
    runs-on: ubuntu-latest
    defaults:
      run:
        working-directory: .
    services:
      postgres:
        image: postgres:13
        ports:
          - 5432:5432
        env:
          POSTGRES_USER: postgres
          POSTGRES_PASSWORD: postgres
          POSTGRES_DB: test

    steps:
      - name: Checkout code
        uses: actions/checkout@v2

      - name: Set up Ruby
        uses: ruby/setup-ruby@v1
        with:
          ruby-version: 3.2.2
          bundler-cache: true

      - name: Cache node modules
        uses: actions/cache@v3
        with:
          path: node_modules
          key: ${{ runner.os }}-node-${{ hashFiles('**/yarn.lock') }}
          restore-keys: |
            ${{ runner.os }}-node-

      - name: Bundler and gem install
        run: |
          gem install bundler
          bundle install

      - name: Database create and migrate
        run: |
          cp config/database.yml.ci config/database.yml
          bundle exec rails db:create RAILS_ENV=test
          bundle exec rails db:migrate RAILS_ENV=test

      - name: Run rspec
        run: bundle exec rspec

  rubocop:
    runs-on: ubuntu-latest
    defaults:
      run:
        working-directory: .
    steps:
      - name: Checkout code
        uses: actions/checkout@v3

      - name: Set up Ruby
        uses: ruby/setup-ruby@v1
        with:
          ruby-version: 3.2.2
          bundler-cache: true

      - name: Bundler and gem install
        run: |
          gem install bundler
          bundle install

      - name: Run rubocop
        run: bundle exec rubocop

CI用のymlファイルを作成しておきます。

touch config/database.yml.ci

config/database.yml.ci

test:
  adapter: postgresql
  encoding: unicode
  database: test
  username: postgres
  password: postgres
  host: localhost
  port: 5432

Gemのインストール

group :development, :test do
  gem 'rspec-rails'
  gem 'rubocop'
end

bundle install

RSpec用のファイルを作成します。

rails g rspec:install

念の為コマンドを確認します。

root@dd6579770655:/app# rspec
No examples found.


Finished in 0.0006 seconds (files took 0.13951 seconds to load)
0 examples, 0 failures

Rubocopですが、テストを通すためにいくつかのケースを除外しておきます。
この辺りは適宜変更してください。

touch .rubocop.yml

.rubocop.yml

Style/Documentation:
  Enabled: false

Metrics/CyclomaticComplexity:
  Enabled: false

Metrics/MethodLength:
  Enabled: false

Metrics/PerceivedComplexity:
  Enabled: false

Layout/LineLength:
  Max: 200

Metrics/BlockLength:
  Enabled: false

Rubocopを実行します。

rubocop -A

Inspecting 33 files
.................................

33 files inspected, no offenses detected

再度ビルドします。

docker-compose build

GitHub上にリポジトリを作成し、Pushすると、これがトリガーとなりCIが実行されます。

画像のようにActionsタブでCIがパスされたことを確認できます。
もしCIが通らないのであれば、適宜修正してください。

まとめ

DockerとGitHubActionsで効率的に開発していきましょう！