Rspec, SQLite3와 Fixture를 이용한 Rails API 테스트

1
2
3
4
5
6
# Gemfile
group :test do
    gem 'sqlite3'
    gem 'rspec-rails'
    gem 'oj' #to load JSON response
end

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
ActiveRecord::Schema.define(version: xxxxxxxx) do
  create_table "comments", force: :cascade do |t|
    t.integer  "post_id",      limit: 4
    t.integer  "user_id",      limit: 4
    t.string   "title",        limit: 255
    t.text     "comment_body", limit: 65535
    t.datetime "created_at",                 null: false
    t.datetime "updated_at",                 null: false
  end
  create_table "posts", force: :cascade do |t|
    t.integer  "user_id",    limit: 4
    t.string   "title",      limit: 255
    t.text     "post_body",  limit: 65535
    t.integer  "rank",       limit: 4
    t.datetime "created_at",               null: false
    t.datetime "updated_at",               null: false
  end
  create_table "users", force: :cascade do |t|
    t.string   "first_name", limit: 255
    t.string   "last_name",  limit: 255
    t.string   "nick_name",  limit: 255
    t.datetime "created_at",             null: false
    t.datetime "updated_at",             null: false
  end
end

1
2
3
4
5
6
7
#database.yml
test:
  adapter: sqlite3
  encoding: utf8
  pool: 5
  timeout: 5000
  database: db/test.sqlite3

1
2
3
4
5
6
7
8
9
# spec/fixtures/posts.yml
post:
  id: 1
  user_id: 1
  title: "Nice Spring"
  post_body: "Spring is nice and warm"
  rank: 1
  created_at: "2015-12-17 03:10:15"
  updated_at: "2016-05-03 11:01:50"

1
2
3
4
5
6
7
#spec_helper.rb
RSpec.configure do |config|
  silence_stream STDOUT do
    load "#{Rails.root}/db/schema.rb"
  end
  ....
end

1
2
3
4
5
6
7
# rails_helper.rb
require 'spec_helper'
...
RSpec.configure do |config|
  config.fixture_path = "#{::Rails.root}/spec/fixtures"
  ...
end

1
2
3
4
5
6
# rake routes 
        api_posts GET    /api/posts(.:format)             api/posts#index {:format=>:json}
   api_user_posts GET    /api/posts/:user_id(.:format)    api/posts#get_user_posts {:format=>:json}
        api_users GET    /api/users(.:format)             api/users#index {:format=>:json}
     api_comments GET    /api/comments(.:format)          api/comments#index {:format=>:json}
api_post_comments GET    /api/comments/:post_id(.:format) api/comments#get_post_comments {:format=>:json}

1
2
3
4
5
6
# rails_helper.rb
RSpec.configure do |config|
  config.fixture_path = "#{::Rails.root}/spec/fixtures"
  config.render_views = true
  ...
end

1
2
3
4
5
6
7
8
9
10
11
12
13
14
# spec/controllers/api/posts_controller_spec.rb
require 'rails_helper'
describe Api::PostsController, :type => :controller do
    fixtures :all
    describe 'GET #index' do
        it 'returns all posts ' do
            get :index, format: :json
            results = Oj.load(response.body, symbol_keys: true)
            expect(results[:status]).to eq(0)
            expect(results[:posts].length).to eq(2)
            expect(results[:posts][0][:title]).to eq('Nice Spring')
        end
    end
end

1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
    status: 0,
    posts: [
        {
            id: 1,
            user_id: 1,
            title: "Nice Spring",
            post_body: "Spring is nice and warm",
            rank: 1,
            created_at: "2015-12-17 03:10:15",
            updated_at: "2016-05-03 11:01:50"
        }
    ]
}

물론 현실에서의 API와 테스트는 훨씬더 복잡하고 생각해야 할 문제들이 많이 있기에 이 글에서 소개 한것 처럼 간단하게 끝이 나지는 않을것입니다. 그럼에도 이글을 쓰는 목적은 누군가 테스트 환경을 구축하고 첫번째 스텝을 밟아 좀 더 견고한 API를 만들기 위해 노력하고,  그로인해 개발자들이 API를 구현하게 될때 테스트를 먼저 생각하는 것이 당연한 일이 되고, Continuous Integration과 100% test coverage 는 언제나 뗄래야 뗄 수 없는 관계라고 인식하는 개발 사이클을 경험했으면 하는 바램입니다.