Rails 5 testing presentation given at Conferencia Rails

Transcript

1. ¡hola! !
2. Secrets of Testing Rails 5 apps
3. Prathamesh Sonpatki @_cha1tanya
5. Pune, India
6. Pune, India
7. Rails issues team
9. ⚠
10. I don’t have stickers
11. Stickers
12. Do you have stickers?
13. T-Shirts are fine too
14. This talk is not about RSpec
15. It is about default Rails test suite
16. Secrets of Testing Rails 5 apps
17. Delete tests
18. Delete tests
19. Secrets of Testing Rails 5 apps
20. Running tests
21. rake test Rails 4
22. Rerun snippets ❌ Run tests by line ❌ Fail fast ❌ Rails 4
23. Rerun snippets ❌ Run tests by line ❌ Fail fast ❌ Coloured output ❌ Rails 4
24. Running tests without batteries
27. Let’s make runing tests in Rails great again
28. https://github.com/rails/rails/pull/18596
29. Test Runner
30. bin/rails test Rails 5
31. $ bin/rails t -h minitest options: -h, --help Display this help. -s, --seed SEED Sets random seed. Also via env. Eg: SEED=n rake -v, --verbose Verbose. Show progress processing files. -n, --name PATTERN Filter run on /regexp/ or string. Known extensions: rails, pride Usage: bin/rails test [options] [files or directories] You can run a single test by appending a line number to a filename: bin/rails test test/models/user_test.rb:27 You can run multiple files and directories at the same time: bin/rails test test/controllers test/integration/login_test.rb By default test failures and errors are reported inline during a run. Rails options: -e, --environment ENV Run tests in the ENV environment -b, --backtrace Show the complete backtrace -d, --defer-output Output test failures and errors after the test run -f, --fail-fast Abort test run on first failure or error -c, --[no-]color Enable color in the output Rails 5
32. $ bin/rails t -h minitest options: -h, --help Display this help. -s, --seed SEED Sets random seed. Also via env. Eg: SEED=n rake -v, --verbose Verbose. Show progress processing files. -n, --name PATTERN Filter run on /regexp/ or string. Known extensions: rails, pride Usage: bin/rails test [options] [files or directories] You can run a single test by appending a line number to a filename: bin/rails test test/models/user_test.rb:27 You can run multiple files and directories at the same time: bin/rails test test/controllers test/integration/login_test.rb By default test failures and errors are reported inline during a run. Rails options: -e, --environment ENV Run tests in the ENV environment -b, --backtrace Show the complete backtrace -d, --defer-output Output test failures and errors after the test run -f, --fail-fast Abort test run on first failure or error -c, --[no-]color Enable color in the output Rails 5
33. $ bin/rails t -h minitest options: -h, --help Display this help. -s, --seed SEED Sets random seed. Also via env. Eg: SEED=n rake -v, --verbose Verbose. Show progress processing files. -n, --name PATTERN Filter run on /regexp/ or string. Known extensions: rails, pride Usage: bin/rails test [options] [files or directories] You can run a single test by appending a line number to a filename: bin/rails test test/models/user_test.rb:27 You can run multiple files and directories at the same time: bin/rails test test/controllers test/integration/login_test.rb By default test failures and errors are reported inline during a run. Rails options: -e, --environment ENV Run tests in the ENV environment -b, --backtrace Show the complete backtrace -d, --defer-output Output test failures and errors after the test run -f, --fail-fast Abort test run on first failure or error -c, --[no-]color Enable color in the output Rails 5
34. Powered by Minitest 5
35. Inspirations
36. RSpec mintiest-reporters maxitest m and others &
37. Writing tests
38. Unit tests Functional tests Integration tests
39. Unit tests Functional tests Integration tests
40. Controller tests
41. What do we test in a controller test
42. request —> response
43. request —> response
44. class ArticlesControllerTest < ActionController::TestCase test "should create article" do assert_difference('Article.count') do post :create, article: { title: @article.title } end assert_redirected_to article_path(assigns(:article)) end end Rails 4
45. class ArticlesControllerTest < ActionController::TestCase test "should create article" do assert_difference('Article.count') do post :create, article: { title: @article.title } end assert_redirected_to article_path(assigns(:article)) end end Rails 4
46. class ArticlesControllerTest < ActionController::TestCase test "should create article" do assert_difference('Article.count') do c end assert_redirected_to article_path(assigns(:article)) end end Rails 4
47. class ArticlesControllerTest < ActionController::TestCase test "should create article" do assert_difference('Article.count') do post :create, article: { title: @article.title } end assert_redirected_to article_path(assigns(:article)) end end Rails 4
48. request —> state
49. Controller tests are easy
50. Controller tests are easy to write
51. Integration tests
52. class ArticlesIntegrationTest < ActionDispatch::IntegrationTest test "should create article" do assert_difference('Article.count') do post articles_url, params: { article: { title: @article.title } } end assert_redirected_to article_path(Article.last) end end
53. class ArticlesIntegrationTest < ActionDispatch::IntegrationTest test "should create article" do assert_difference('Article.count') do post articles_url, params: { article: { title: @article.title } } end assert_redirected_to article_path(Article.last) end end
54. Almost same as controller tests
55. # Functional controller test post :create, article: { title: @article.title } # Integration test post articles_url, params: {article: { title: @article.title }} Rails 4
56. # Functional controller test post :create, article: { title: @article.title } # Integration test post articles_url, params: {article: { title: @article.title }} Rails 4
57. # Functional controller test post :create, article: { title: @article.title } # Integration test post articles_url, params: {article: { title: @article.title }} Rails 4
58. Close to Real World
60. https://github.com/eileencodes/ integration_performance_test
61. Integration controller tests are default in Rails 5
62. require 'test_helper' class UsersControllerTest < ActionDispatch::IntegrationTest setup do @user = users(:one) end test "should get index" do get users_url assert_response :success end ………… end Rails 5
63. Functional controller tests are soft deprecated
64. Old functional style tests will continue to work for now*****
65. Might be extracted in a separate gem in 5.1
66. 1. Prefer ActionDispatch::IntegrationTest for new Rails 5 apps. 2. Leave functional controller tests alone for upgraded Rails 4 apps.
67. Implications
68. class ArticlesControllerTest < ActionController::TestCase setup do john = users(:john) session[:user_id] = john.id end end Rails 4
69. class ArticlesControllerTest < ActionController::TestCase setup do john = users(:john) session[:user_id] = john.id end end Rails 4
71. class ArticlesControllerTest < ActionDispatch::IntegrationTest setup do john = users(:john) session[:user_id] = john.id end end NoMethodError: undefined method `session' for nil:NilClass Rails 5
72. class ArticlesControllerTest < ActionDispatch::IntegrationTest setup do john = users(:john) post login_url, params: { email: john.email, password: john.password } end Rails 5
73. class ArticlesControllerTest < ActionDispatch::IntegrationTest def sign_in_as(user) post login_url, params: { email: user.email, password: user.password } end setup do john = users(:john) sign_in_as john end test ‘john can access ..’ Rails 5
74. class ArticlesControllerTest < ActionController::TestCase test ‘index’ do @request.headers["HTTP_REFERER"] = “http://example.com" get :index end end Rails 4
75. class ArticlesControllerTest < ActionDispatch::IntegrationTest test ‘index’ do @request.headers["HTTP_REFERER"] = “http://example.com" get posts_url end end # NoMethodError: undefined method `headers' for nil:NilClass Rails 5
76. class ArticlesControllerTest < ActionDispatch::IntegrationTest test ‘index’ do get posts_url, headers: { “HTTP_REFERER” => ”example.com” } end end Rails 5
77. Black Box
78. What not to test in integration style controller tests?
79. Don’t test controller internals
80. test "repos" do get :index assert_response :success, 'successfully renders index’ assert_not_nil assigns(:repos), 'assigns to repos' assert_template :index, 'render index template' end Rails 4
81. test "repos" do get :index assert_response :success, 'successfully renders index’ assert_not_nil assigns(:repos), 'assigns to repos' assert_template :index, 'render index template' end Rails 4
82. Testing the Controller-View interface
83. test "repos" do get :index assert_response :success, 'successfully renders index’ assert_select ".repo-item-title", text: 'issue_triage_sandbox' end Rails 5
84. test "repos" do get :index assert_response :success, 'successfully renders index’ assert_select ".repo-item-title", text: 'issue_triage_sandbox' end #=> Repo.first.name = ‘issue_triage_sandbox’ Rails 5
85. gem ‘rails-dom-testing’
86. End to end testing
87. Controller - View interface
88. Just an implementation detail
89. Deprecated in Rails 5 assert_template assigns
90. BUT
91. Testing controller isolated from views is needed**
92. gem ‘rails-controller-testing’
93. HTTP Request test helpers
94. class ProductsControllerTest < ActionController::TestCase def test_create post :create, product: { name: "FIFA" } assert_response :success end end Rails 4
95. Positional arguments Rails 4
96. 1. An optional hash of request parameters 2. An optional hash of session variables 3. An optional hash of flash values
97. 1. An optional hash of request parameters 2. An optional hash of session variables 3. An optional hash of flash values
98. class ProductsControllerTest < ActionController::TestCase def test_create post :create, { product: { name: "FIFA" } }, { user_id: User.first.id } assert_response :success end end Rails 4
99. class ProductsControllerTest < ActionController::TestCase def test_create post :create, { product: { name: "FIFA" } }, { user_id: User.first.id }, { notice: ‘I don’t know what I am doing’ } assert_response :success end end Rails 4
100. class ProductsControllerTest < ActionController::TestCase def test_create post :create, nil, { user_id: User.first.id }, { notice: ‘I don’t know what I am doing’ } assert_response :success end end Rails 4
101. class ProductsControllerTest < ActionController::TestCase def test_create post :create, nil, nil, { notice: ‘I don’t know what I am doing’ } assert_response :success end end Rails 4
102. Rails 4
104. Ruby 2.2.2+
105. Keyword arguments
106. class ProductsControllerTest < ActionController::TestCase def test_create post :create, product: { name: "FIFA" } assert_response :success end end Warning, passing keyword arguments is required. Rails 5
107. class ProductsControllerTest < ActionController::TestCase def test_create post :create, params: { product: { name: "FIFA" } } assert_response :success end end Rails 5
108. ActionController::TestCase #=> params flash session xhr Rails 5
109. ActionDispatch::IntegrationTest #=> params env headers xhr Rails 5
110. Implications
111. One of the pain points of upgrading to Rails 5
112. Change all existing tests to get rid of warning
113. Missing docs for ActionController TestCase
114. Rewriting positional args as keyword args
115. class ProductsControllerTest < ActionController::TestCase def test_create post :create, session: { name: "FIFA" } assert_response :success end end Rails 4
116. class ProductsControllerTest < ActionController::TestCase def test_create post :create, session: { name: "FIFA" } assert_response :success end end session is interpreted as session not as params. Rails 5
117. Minor incompatibilities
118. class ProductsControllerTest < ActionController::TestCase def test_update raw_string = "{title:\"sample\"}" patch :update, raw_string, id: 42 assert_response :success end end Rails 4
119. class ProductsControllerTest < ActionController::TestCase def test_update raw_string = "{title:\"sample\"}" patch :update, raw_string, id: 42 assert_response :success end end # No route matches {:action=>"update", :controller=>"posts"} Rails 5
120. class ProductsControllerTest < ActionController::TestCase def test_update raw_string = "{title:\"sample\"}" request.env['RAW_POST_DATA'] = raw_string patch :update, id: 42 assert_response :success end end # Works Rails 5
121. gem ‘rails/rails’, branch: ‘5-0-stable’
122. Testing API requests
123. JSON or XML requests
124. require 'test_helper' class ApiTest < ActionDispatch::IntegrationTest test 'creates articles' do assert_difference -> { Article.count } do post articles_path, params: { article: { title: 'Ahoy!' } } end end end
125. require 'test_helper' class ApiTest < ActionDispatch::IntegrationTest test 'creates articles' do assert_difference -> { Article.count } do post articles_path(format: :json), params: { article: { title: 'Ahoy!' } }.to_json, headers: { 'Content-Type' => 'application/json' } end end end Rails 4
126. require 'test_helper' class ApiTest < ActionDispatch::IntegrationTest test 'creates articles' do assert_difference -> { Article.count } do post articles_path(format: :json), params: { article: { title: 'Ahoy!' } }.to_json, headers: { 'Content-Type' => 'application/json' } end end end Rails 4
127. Request Encoding
128. require 'test_helper' class ApiTest < ActionDispatch::IntegrationTest test 'creates articles' do assert_difference -> { Article.count } do post articles_path, params: { article: { title: 'Ahoy!' } }, as: :json end end end Rails 5
129. require 'test_helper' class ApiTest < ActionDispatch::IntegrationTest test 'creates articles' do assert_difference -> { Article.count } do post articles_path, params: { article: { title: 'Ahoy!' } }, as: :json end end end Rails 5
130. require 'test_helper' class ApiTest < ActionDispatch::IntegrationTest test 'creates articles' do assert_difference -> { Article.count } do post articles_path, params: { article: { title: 'Ahoy!' } }, as: :json end assert_equal({ 'id' => Article.last.id, 'title' => 'Ahoy!' }, parse_json(response.body)) end end Rails 4
131. require 'test_helper' class ApiTest < ActionDispatch::IntegrationTest test 'creates articles' do assert_difference -> { Article.count } do post articles_path, params: { article: { title: 'Ahoy!' } }, as: :json end assert_equal({ 'id' => Article.last.id, 'title' => 'Ahoy!' }, response.parsed_body) end end Rails 5
132. require 'test_helper' class ApiTest < ActionDispatch::IntegrationTest test 'creates articles' do assert_difference -> { Article.count } do post articles_path, params: { article: { title: 'Ahoy!' } }, as: :json end assert_equal({ 'id' => Article.last.id, 'title' => 'Ahoy!' }, response.parsed_body) end end Rails 5
133. Welcome to the Future
134. Selenium + Capybara on Rails
136. Testing Rails 5 apps
137. Test Runner
138. End to end testing
139. Much more than this
140. Testing guide guides.rubyonrails .org/testing.html
141. Rails 5 Blog Series blog.bigbinary.com /categories/Rails-5
142. This Week in Rails rails-weekly. ongoodbits.com
143. gracias! @_cha1tanya csonpatki@gmail.com