Run Ruby on Rails RSpec tests with GitHub Actions

When I tried to run the RSpec test of Ruby on Rails with GitHub Actions, it was quite difficult, so I will write it down.

What is GitHub Actions?

It is a serverless execution environment that runs on GitHub. By describing the settings in the file in the repository, it is a mechanism that can trigger various operations on GitHub and execute arbitrary actions. You can use it for free if it is a public repository.

This time, I will make it a CI for Rails by executing RSpec in association with the creation of Pull Request.


It seems good to upload a Docker image that can run Rails to Docker Hub, pull Docker and run the test.


It can be easily handled even if it is different from the OS.

Create a Docker image and upload it to Docker Hub


It's a basic environment. If you have the required library, please add it.


FROM ubuntu:16.04

SHELL ["/bin/bash", "-c"]

ENV DEBIAN_FRONTEND="noninteractive"
ENV PATH=/root/.rbenv/bin:/root/.rbenv/shims:$PATH


COPY Gemfile .
COPY Gemfile.lock .

RUN set -x \
  && apt update \
  && apt install -y \
    build-essential \
    curl \
    git \
    libssl-dev \
    libreadline-dev \
    libmysqlclient-dev \
    mysql-client \
    mysql-server \
    tzdata \
    zlib1g-dev \
  # Install rbenv and ruby
  && git clone ~/.rbenv \
  && git clone ~/.rbenv/plugins/ruby-build \
  && CONFIGURE_OPTS='--disable-install-rdoc' /root/.rbenv/bin/rbenv install ${RUBY_VERSION} -s \
  && /root/.rbenv/bin/rbenv global ${RUBY_VERSION} \
  # Install bundler
  && echo 'gem: --no-rdoc --no-ri' > /root/.gemrc \
  && /root/.rbenv/shims/gem install bundler -v ${BUNDLER_VERSION} \
  # bundle install
  && /root/.rbenv/shims/bundle config set without development \
  && /root/.rbenv/shims/bundle install \
  # delete unused file
  && rm -rf /var/lib/apt/lists/* \
  && rm Gemfile Gemfile.lock

If you write multiple RUNs and overlap Docker layers, an error will occur at runtime around MySQL, so build the entire environment with one command.

Build Docker

docker build -t utyosu/build-rails:latest . -f tools/ci/Dockerfile

Upload Docker image

You will need a Docker Hub account. Registering the Docker Hub repository for the first time seems to be helpful.

docker push utyosu/build-rails:latest

Set triggers for GitHub Actions

Create a file for GitHub Action in your project's repository.


name: build

#Trigger a Pull Request
on: [pull_request]

    #Based on the latest version of Ubuntu
    runs-on: ubuntu-latest

    #Pull the image from Docker Hub
      image: utyosu/build-rails:latest

    #Check out this branch
    - uses: actions/[email protected]

    # sh
    - name: run test
      run: . tools/ci/

Test script

Describe what you want to test. If this script fails, the build will fail.



#Since no process is started, start MySQL first
service mysql start

#Create a MySQL user and grant permissions
mysql -e 'create user "user_name";'
mysql -e 'grant all on *.* to "user_name";'

export RAILS_ENV=test
bundle config set without development

#Install Gem.
#From nothing
bundle install

#Check if Capistrano is running
#(I check it just in case because it may not work due to version mismatch)
bundle exec cap -T

#Static analysis with Rubocop
bundle exec rubocop

#Create a database defined in rails
bundle exec rails db:create

#Database schema creation with ridgepole
#For those who are not using ridgepole, bundle exec rails db instead:schema:Run load
bundle exec ridgepole -c config/database.yml --apply -f db/schema -E test

#Run RSpec
bundle exec rspec

Actually try

When I make a Pull Request, it says Some checks haven't completed yet.


You can check the progress of CI by clicking Details.


After a short wait, you will see the console output.


It will be completed after a while.


When you return to the Pull Request, ʻAll checks have passed` is displayed, indicating that the test passed without any problems.



Since the GitHub standard Ruby execution environment is prepared, I tried it based on it at first. However, installing Rails and Gem takes more than 30 minutes, so I thought it was not suitable for CI in a light project. If you pull the image from DockerHub and execute it, I found that the test execution can be started in about 40 seconds, so I use this method.


There seems to be a way to prepare MySQL in another container and exchange between containers, but the mechanism was too difficult to realize. I wish I could do it well in the Rails environment.

Recommended Posts

Run Ruby on Rails RSpec tests with GitHub Actions
[Ruby on Rails] View test with RSpec
[Ruby on Rails] Controller test with RSpec
[Ruby on Rails] Model test with RSpec
Introducing Rspec with Ruby on Rails x Docker
Understand code coverage with Rspec, the Ruby on Rails test framework
Notes on using FCM with Ruby on Rails
[Ruby on Rails] Until the introduction of RSpec
Publish the app made with ruby on rails
Introducing Rspec, a Ruby on Rails test framework
[Rails] Procedure for linking databases with Ruby On Rails
Determine the current page with Ruby on Rails
[Ruby on Rails] Upload multiple images with refile
I made a portfolio with Ruby On Rails
Test run on rails
Ruby on Rails Elementary
Ruby on Rails basics
[Rails] Test with RSpec
Try actions on GitHub [actions]
Ruby On Rails Association
[Ruby on Rails] Delete s3 images with Active Strage
Make failed rspec tests visible on github check annotations
Run RSpec, Brakeman, Rubocop, Rails Best Practices with overcommit
Solve the N + 1 problem with Ruby on Rails: acts-as-taggable-on
Created RSS / Atom format sitemap with Ruby on Rails
Use Coveralls with GitHub Actions in a Ruby repository
Ruby on rails learning record -2020.10.03
Portfolio creation Ruby on Rails
Ruby on rails learning record -2020.10.04
[Ruby on Rails] Debug (binding.pry)
Ruby on rails learning record -2020.10.05
Ruby on rails learning record -2020.10.09
Ruby on Rails config configuration
Ruby on Rails basic learning ①
[Ruby on Rails] about has_secure_password
Ruby on rails learning record-2020.10.07 ②
Run Rails whenever with docker
Commentary on partial! --Ruby on Rails
Ruby on rails learning record-2020.10.07 ①
Cancel Ruby on Rails migration
Ruby on rails learning record -2020.10.06
Ruby on Rails validation summary
Ruby on Rails Basic Memorandum
I tried installing Ruby on Rails related plugin with vim-plug
[Ruby on Rails] Add a column with a foreign key constraint
[Ruby on Rails] Implement login function by add_token_to_users with API
[Apple login] Sign in with Apple implementation procedure (Ruby on Rails)
Install Ruby on MSYS2 with pacman
Ruby on Rails Overview (Beginner Summary)
[Ruby on Rails] Read try (: [],: key)
[Ruby on Rails] yarn install --check-files
Ruby on Rails variable, constant summary
Installing Ruby + Rails on Ubuntu 18.04 (rbenv)
[Ruby on Rails] Introduced paging function
I want to add a browsing function with ruby on rails
Ruby on Rails development environment construction with Docker + VSCode (Remote Container)
Basic knowledge of Ruby on Rails
Progate Ruby on Rails5 Looking Back
How to use Ruby on Rails
[Ruby on Rails] Add / Remove Columns
Programming with ruby (on the way)