はじめに
RailsとNuxt3でtodoリストの作り方を
初めから丁寧に説明したいと思います。
使用pcはmacを想定しています。
完成した構成図は以下の通りです。
また、githubレポジトリはこちらです。
各シリーズは以下の通りです。
RailsとNuxt3でtodoリストを作ろう[REST-API/Terraform/Fargate]〜その１、Rails基本設定編
RailsとNuxt3でtodoリストを作ろう[REST-API/Terraform/Fargate]〜その２、Rails API編
RailsとNuxt3でtodoリストを作ろう[REST-API/Terraform/Fargate]〜その３、Nuxt.js編
RailsとNuxt3でtodoリストを作ろう[REST-API/Terraform/Fargate]〜その４、TerraformECS前編
RailsとNuxt3でtodoリストを作ろう[REST-API/Terraform/Fargate]〜その５、TerraformECS後編
RailsとNuxt3でtodoリストを作ろう[REST-API/Terraform/Fargate]〜その６、Blue/Greenデプロイ前編
RailsとNuxt3でtodoリストを作ろう[REST-API/Terraform/Fargate]〜その７、Blue/Greenデプロイ後編
Railsを環境構築してみよう。
ここら辺参考にしてます。
Dockerをbuildしてみる。
dockerhubから最新のrubyのバージョンを調べてDockerfileに書きましょう。
Dockerfileは本番用と練習用で分ける予定ですが、最初なのでDockerfileのままで書きます。
.
├── apserver
│ └── Dockerfile
├── docker-compose.yml
g++とmakeとgitはrailsをinstallする時に必要。
ないと、エラーが出ます。
FROM ruby:3.1.3-slim-buster
WORKDIR /usr/src
RUN apt-get update \
&& apt-get install -y --no-install-recommends \
g++=4:8.3.0-1 make=4.2.1-1.2 \
libmariadb-dev=1:10.3.38-0+deb10u1 \
git=1:2.20.1-2+deb10u8 \
&& apt-get -y clean \
&& rm -rf /var/lib/apt/lists/*
Docker-compose.ymlのttyを設定しておくと、コンテナを起動し続けてくれます。
volumesは永続化と言って、コンテナ内のディレクトリーをホストPC内に写し操作することができます。
version: "3"
services:
apserver:
build: ./apserver
container_name: "ruby"
tty: true
volumes:
- ./apserver:/usr/src/myapp
ports:
- "8080:8080"
docker compose upをすると、一番最初はdocker buildも一緒にやってくれます。
docker compose upで仮想環境を立ち上げてみましょう。
では、実行してみましょう。
docker compose up
Railsのインストール
以下のコマンドを打ち、コンテナ内に入って見ましょう。
apserverはDocker-compose.ymlに記載してあるサービス名です。
docker compose exec apserver bash
gem install rails -v 7.0.4.2
appはアプリケーション名です。好きな名前に変えてok。
rails new app --api -f
cd app
rails s -b 0.0.0.0
にアクセスしてみましょう。
jsonを受け取ろう。
以下のコマンドで自動でコントローラが作られます。
rails g controller index
Rails.application.routes.draw do
root "index#index"
end
class IndexController < ApplicationController
def index
render json: { status: 'SUCCESS', message: 'hello world!!!' }
end
end
<!DOCTYPE html>
<html>
<head>
</head>
<body>
<h1>hi</h1>
</body>
</html>
にアクセスしてみましょう。
Rspecでテストを実施してみよう
まずはインストール
sed -i -e '$ a gem "rspec-rails", "~> 6.0.1"' ./Gemfile
bundle install
テストを生成します。
rails g rspec:request index
require 'rails_helper'
RSpec.describe "Indices", type: :request do
describe "GET /" do
it "works! (now write some real specs)" do
get '/'
expect(response).to have_http_status(200)
end
end
end
テストを実行してみよう。
bundle exec rspec
Github actionsでテストを実行してみよう
Dockerfileをテストが実行できるように書き換えます。
ENVはfargateでdb接続するために書いています。
FROM ruby:3.1.3-slim-buster
WORKDIR /usr/src
ENV HOST dbserver
ENV DBNAME todoproject
ENV USERNAME rubyMySql1
ENV PASSWORD rubyMySql1
RUN apt-get update \
&& apt-get install -y --no-install-recommends \
g++=4:8.3.0-1 make=4.2.1-1.2 \
libmariadb-dev=1:10.3.38-0+deb10u1 \
mariadb-client=1:10.3.38-0+deb10u1 \
git=1:2.20.1-2+deb10u8 \
&& apt-get -y clean \
&& rm -rf /var/lib/apt/lists/*
COPY . .
WORKDIR /usr/src/app
RUN bundle install
GitHubActionsでテストを実行するために以下のファイルを作ります。
name: "Test and deploy the application"
on:
push:
branches: ["main"]
paths:
- apserver/**
- .github/workflows/**
workflow_dispatch:
defaults:
run:
shell: bash
jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Build the Docker image
run: docker compose up -d
- name: unit test
run: |
docker compose exec apserver bundle exec rspec
- name: Docker Down
run: docker compose down
GitHubに移動し
成功すると以下の画面になります。
データベースに接続してみよう
docker-compose.ymlにmysqlを追加してみよう
FROM mysql:8.0.32-debian
RUN apt-get update \
&& apt-get install -y locales \
&& sed -i -E 's/# (ja_JP.UTF-8)/\1/' /etc/locale.gen \
&& locale-gen \
&& update-locale LANG=ja_JP.UTF-8 \
&& apt-get clean \
&& rm -rf /var/lib/apt/lists/*
ENV LC_ALL ja_JP.UTF-8
dbserver:
build: ./dbserver
container_name: mysql
restart: always
environment:
MYSQL_ROOT_PASSWORD: root
MYSQL_DATABASE: todoproject
MYSQL_USER: rubyMySql1
MYSQL_PASSWORD: rubyMySql1
TZ: 'Asia/Tokyo'
command: mysqld
volumes:
- ./dbserver/conf/my.cnf:/etc/mysql/conf.d/my.cnf
ports:
- 3306:3306
[mysqld]
character-set-server = utf8mb4
collation-server = utf8mb4_unicode_ci
# mysql8.xからデフォルト認証プラグインの設定が必要
default-authentication-plugin = mysql_native_password
[mysql]
default-character-set = utf8mb4
[client]
default-character-set = utf8mb4
クライアントツールを使いmysqlの接続を確認しよう
railsからdb接続しよう
sed -i -e '$ a gem "mysql2", "~> 0.5.5"' ./Gemfile
bundle install
コンテナの中に入り接続を確認してみましょう。
rails dbconsole
