[Rails] postgresqlでdatabase.ymlにTest環境の設定を試したらエンコードエラーになった話

どうも、フリーランスエンジニアのウェブ系ウシジマくんです。Railsで開発をする際に、database.ymlにそれぞれの環境に応じた設定をしているかと思います。

かくいう私も、とあるプロジェクトでテストフレームワークであるRSpecを用いてtest環境を構築していたのですが、エンコードのエラーで少しハマってしまいました。

エラー自体は割とすぐに解消したのですが、それは英語のstackoverflowを参照したから。

同じようなエラーでハマっている方の役に立てればと思い、今回記事にすることにしました。

対象となる読者
エラーが出た背景
エラーを解消するには？
なんでこのエラーが起こるの？
ちょっとしたつぶやき

対象となる読者

Ruby on Railsを使ってなんらかの開発を行なっている人。

想定されるスキル感としては、ProgateとRailsチュートリアルを一通りこなした方です。

また、Railsに使用するデータベースにPostgreSQLを使用していることも前提条件となります。

エラーが出た背景

現在私が参画しているプロジェクトでは、スキルの初心者レベルの方がAWS cloud9、中級者はVagrantという開発環境です。

私自身はVagrant上にCentOS7で開発していたのですが、どうも初級者の方がcloud9で僕が作ったブランチをpullしてテスト用DBを作成しようとbin/rails db:migrate RAILS_ENV=testを実行すると、次のようなエラーがでるみたいなんですよね。

PG::InvalidParameterValue: ERROR: new encoding (UTF8) is incompatible with the encoding of the template database (SQL_ASCII)
HINT: Use the same encoding as in the template database, or use template0 as template.
: CREATE DATABASE "celebrity_test" ENCODING = 'unicode'
Couldn't create database for {"adapter"=&gt;"postgresql", "encoding"=&gt;"unicode", "pool"=&gt;5, "username"=&gt;nil, "password"=&gt;nil, "host"=&gt;"0.0.0.0", "database"=&gt;"celebrity_test"}
rails aborted!

エラーの内容をめちゃくちゃ意訳すると、次のような感じ。

パソコンくん

UTF8はDBのテンプレエンコーディングのSQL_ASCIIと互換性がないから無効な値だよ。エラーを解消したかったらtemplate0を使うかこれまでのテンプレートデータベースと同じエンコーディングにしてね。

エラーを解消するには？

結論から言えば、解消するにはエラーがヒントをくれているとおり、database.ymlを次のように記述すればOKです。

test:
&lt;&lt;: *default
template: template0
encoding: utf-8
database: freelance_test

参考までにdatabase.yml全体の記述も書いておきますね。

default: &default
  adapter: postgresql
  encoding: unicode
  pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
  username: <%= ENV['USERNAME'] %>
  password: <%= ENV['PASSWORD'] %>
  host:     <%= ENV['IP'] %>

development:
  <<: *default
  database: freelance_development
  template: template0

production:
  <<: *default
  database: freelance_development
  username: postgres
  password:

test:
  <<: *default
  template: template0
  encoding: utf-8
  database: freelance_test