RailsアプリをテストするためのDockerコンテナを設定する

すべてのセットアップの準備ができたので、モデル内に簡単なメソッドを記述して、メソッドをテストしましょう。

# calculation.rb

class Calculation < ApplicationRecord

  def self.sum(x, y)
    result = x + y
    Calculation.create(x: x, y: y, result: result)
    result
  end

end

このsumメソッドは、数値を加算するだけでなく、データベースに数値を保存します。したがって、このメソッドをテストするには、データベースインスタンスが実行されている必要があります。

データベースに接続する必要があるため、このテストは統合テストになります。

ミニテストを使用してテストを作成します。これはRailsのデフォルトです。

# calculation_test.rb

require 'test_helper'

class CalculationTest < ActiveSupport::TestCase
  test "should sum and save the data" do
    result = Calculation.sum(1, 2)
    c = Calculation.last
    assert result, 3
    assert c.result, result
  end
end

テストを実行します：

docker-compose exec web rails test

上記のテストでは、sumメソッドが値を加算してデータベースに値を保存しているかどうかをテストしています。 Docker Composeを使用すると、データベースに接続する非常に簡単な方法があります。

ここでは、メソッドはデータベースに依存しています。依存関係は、データベースだけでなく、RESTAPIを提供するサードパーティのサービスでもかまいません。それでは、sumを提供するサードパーティのサービスを使用してみましょう。 メソッド。独自に作成する代わりに使用できます。

# calculation.rb

class Calculation < ApplicationRecord

  def self.sum(x, y)
    # The hostname should be the same as it is specified in the docker-compose file
    url = 'https://sumservice:4010/sum'

    uri = URI(url)
    params = { :x => x, :y => y }
    uri.query = URI.encode_www_form(params)
    res = Net::HTTP.get_response(uri)
    throw "Error"  unless res.is_a?(Net::HTTPSuccess)
    result = res.body.to_i
    Calculation.create(x: x, y: y, result: result)
    result
  end

end

依存関係としてデータベースに対して行ったのと同様のことをRESTAPIに対して行うことができます。これらが有効なエンドポイントであることを確認する必要がありますが、テスト中に実際のサービスに電話をかけたくありません。この場合、モック/スタブテストを作成できますが、そうすると、これらのテストは統合テストにはなりません。テストが可能な限り現実的であることを確認したいと思います。この目的のために、コンテナで実行するモックAPIエンドポイントを作成し、モックコンテナAPIサービスを呼び出して、結果を返すことができます。

最初にテストを変更しましょう：

# calculation_test.rb

require 'test_helper'

class CalculationTest < ActiveSupport::TestCase
  test "should sum and save the data" do
    result = Calculation.sum(1, 2)
    c = Calculation.last
    #  we don't need this assetion as we are deligation this responsibility to external service:
    # assert result, 3 // Not needed
    assert c.result, result
  end
end

ここでは、sumAPIによって提供された結果がデータベースに適切に保存されているかどうかのみをテストするようにテストケースを変更しました。合計の実際の値が正しいかどうかをテストする必要はありません。これは外部サービスによって処理されるため、信頼できます。

モックサーバーを生成するには、openAPIを使用します。簡単なSwagger定義を作成しましょう：

ルートディレクトリに新しいフォルダを作成し、mockという名前を付けます 。フォルダ内に、ファイル名api.yamlを作成します

# api.yaml
swagger: "2.0"
info:
  description: "This is a sum api provider"
  version: "1.0.0"
  title: "API Provider"
host: "https://mock-service.com/"
basePath: "/api"
schemes:
  - "https"
  - "http"
paths:
  /sum:
    get:
      produces:
        - "application/json"
      parameters:
        - name: "x"
          in: "query"
          description: "x value"
          required: true
          type: "integer"
        - name: "y"
          in: "query"
          description: "y value"
          required: true
          type: "integer"
      responses:
        "200":
          description: "successful operation"
          schema:
            type: "integer"
            example: 3

仕様に基づいてこのサーバーを実行するには、任意のモックサービスプロバイダーを使用できます。プリズムというツールを使用します。 docker-composeファイルに追加できるdockerイメージが利用可能です：

version: "3.0"
services:
  db:
    image: postgres
    environment:
      POSTGRES_USER: calculator
      POSTGRES_PASSWORD: password
      POSTGRES_DB: calculator_test
  web:
    build: .
    ports:
      - "3000:3000"
    depends_on:
      - db
      - sumservice
    environment:
      CALCULATOR_DATABASE_PASSWORD: password
  sumservice:
    image: stoplight/prism:4
    command: mock -h 0.0.0.0 "/tmp/api.yaml"
    volumes:
      - ./mock:/tmp/
    ports:
      - 4010:4010
    init: true

それでは、テストを実行して、期待どおりに機能するかどうかを確認しましょう。

> docker-compose exec web rails test

Finished in 0.337710s, 2.9611 runs/s, 5.9222 assertions/s.
1 runs, 2 assertions, 0 failures, 0 errors, 0 skips

うん！これでテストが実行されました。このメソッドは、sumサービスのDockerイメージに接続して合計を取得し、Postgresに接続してデータを保存します。すべての依存関係はDockerComposeによって管理されるため、以前にインストールされた依存関係について心配する必要はありません。このテストを任意のマシンに移動すると、依存関係のインストールは必要ありません。マシンに必要なのはDockerだけです。

アプリケーションがRedisやMemcachedなどの他の依存関係に依存している場合、これらはdockerhubにあります。必要に応じて、これらのイメージをDockerComposeファイルに追加できます。

> \l
                                        List of databases
       Name        |   Owner    | Encoding |  Collate   |   Ctype    |     Access privileges
-------------------+------------+----------+------------+------------+---------------------------
 calculator_test   | calculator | UTF8     | en_US.utf8 | en_US.utf8 |
 calculator_test-0 | calculator | UTF8     | en_US.utf8 | en_US.utf8 |
 calculator_test-1 | calculator | UTF8     | en_US.utf8 | en_US.utf8 |
 calculator_test-2 | calculator | UTF8     | en_US.utf8 | en_US.utf8 |
 calculator_test-3 | calculator | UTF8     | en_US.utf8 | en_US.utf8 |

.PHONY: test
up:
  docker-compose up
down:
  docker-compose down
test:
  docker-compose exec web rails test

> make up

> make test

version: "3.0"
services:
  db:
    image: postgres
    environment:
      POSTGRES_USER: calculator
      POSTGRES_PASSWORD: password
      POSTGRES_DB: calculator_test
  web:
    build: .
    volumes:
      - .:/calculator # Volume mounted
    ports:
      - "3000:3000"
    depends_on:
      - db
      - sumservice
    environment:
      CALCULATOR_DATABASE_PASSWORD: password
  sumservice:
    image: stoplight/prism:4
    command: mock -h 0.0.0.0 "/tmp/api.yaml"
    volumes:
      - ./mock:/tmp/
    ports:
      - 4010:4010
    init: true

# controllers/calculation_controller.rb
class CalculationController < ApplicationController
  def index
    result = Calculation.sum(params[:x], params[:y])
    render json: {result: result}
  end
end

# routes.rb

Rails.application.routes.draw do
  # For details on the DSL available within this file, see https://guides.rubyonrails.org/routing.html
  root "calculation#index"
end

.git*
log/*
README.md
node_modules

FROM ruby:2.7
RUN curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | apt-key add -
RUN echo "deb https://dl.yarnpkg.com/debian/ stable main" | tee /etc/apt/sources.list.d/yarn.list
RUN apt-get update -qq && apt-get install -y nodejs yarn
RUN mkdir /calculator
WORKDIR /calculator
COPY Gemfile /calculator/Gemfile
COPY Gemfile.lock /calculator/Gemfile.lock
RUN bundle install
COPY package.json /calculator/package.json
COPY yarn.lock /calculator/yarn.lock
RUN yarn install --check-files
COPY . /calculator
EXPOSE 3000
ENTRYPOINT ./entrypoint.sh
CMD ["rails", "server", "-b", "0.0.0.0"]

#!/bin/bash
set -e

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

# Exec the container's main process (CMD command in rails file)
exec "$@"

chmod +x entrypoint.sh