月: 2020年12月

RailsにRSpecを導入して、Cloud BuildでCI/CDパイプラインを構築するところまでをまとめています。 RailsにRSpecを導入する まずはRailsにRSpecを導入します。 実際にローカル環境でRSpecによるテストができるところまでの手順をまとめています。 「rspec-rails」、「factory_bot_rails」、「rails-controller-testing」のインストール Gemfileを以下の3つのGemを追加しbundle installします。 ・Gemfile [crayon-671774c0a1ab4047825685/] RSpecに必要なファイルを生成する 以下のコマンドでRSpecに必要なファイルを生成します。 [crayon-671774c0a1ab6619524993/] 成功すると以下の3つのファイルが生成されていることが確認できます。 [crayon-671774c0a1ab7664582212/] RSpec実行に必要な設定をする Factory Botの設定をrails_helper.rbに追加します。 ・spec/rails_helper.rb [crayon-671774c0a1ab8074162809/] Rails.loggerのログを出力するには以下を追加します。 [crayon-671774c0a1ab9600619188/] rspec用のテストファイルを作成するために、application.rbに以下を追加します。 ・application.rb [crayon-671774c0a1aba189399513/] .rspecに以下を追加するとテストの実行結果が見やすくなります。 ・.rspec [crayon-671774c0a1abb524944552/] テストを作成する factoriesやcontrollerを用意し、テストを作成していきます。 今回はテスト作成の過程は省略します。詳しくは以下の記事などを参考にしてください。 https://qiita.com/k-penguin-sato/items/defdb828bd54729272ad 例として本のデータを取得するAPIの本コントローラのshowメソッドに対してテストを行います。 ・spec/factories/books.rb [crayon-671774c0a1abc220706499/] ・spec/controllers/books_controller_spec.rb [crayon-671774c0a1abd696266643/] ローカルでテストが実行できるか確認します。 [crayon-671774c0a1abe617306239/] 正常にテストが成功すると以下のようなログが出力されます。 [crayon-671774c0a1abf763021139/] Cloud BuildでRSpecを組み込む ローカルでのRSpecによるテストが確認できたら、Cloud BuildにRSpecを組み込んでCI/CDパイプラインを構築していきます。 Dockerfileの作成 Rubyの公式イメージを元に作成しています。 テストする際のDBの接続先はMariaDBを使用します。 ・Dockerfile [crayon-671774c0a1ac0327719058/] テスト用のDB設定 database.ymlに以下のようにテスト用のDBを設定します。 ・database.yml [crayon-671774c0a1ac1470415639/] テスト実行用のシェルスクリプト作成 Cloud Buildで実行するシェルスクリプトを作成します。 MariaDBを起動して、DBを作成しテストを実行できる環境を整えます。その後、テストを実行します。 ・rspec.sh [crayon-671774c0a1ac2474280220/] Dockerイメージを作成し、RSpecのテストを行いGAEにデプロイする cloudbuild-staging.yamlのスクリプトでDockerイメージの作成、RSpecのテスト、GAEのステージング環境にデプロイを行います。いわゆるCI/CDパイプラインを構築して、実行しています。 Gitでプッシュするとcloudbuild.yamlのスクリプトが自動で実行されるようにしています。 Cloud BuildとGitの連携方法に関してはここでは省略しています。 ・cloudbuild-staging.yaml [crayon-671774c0a1ac7294759367/] Cloud BuildでRSpecによる自動テストの動作確認 テスト失敗時 テスト失敗した際の挙動を確認します。 テストが失敗するとCloud Buildのステップが停止し、デプロイされることはありません。 テスト成功時 テスト成功時の挙動を確認します。 テストが成功すると、そのままGAEへのデプロイが始まり、無事完了しました。 参考 https://qiita.com/ryouzi/items/de7336e6175530723b30 https://qiita.com/enta0701/items/34e896792f5533a8275c