How do I write a helper for an integration test in Rails?

Question

How do I write an integration test helper that is used amongst several integration tests? I've tried the following with the following errors. I'm considering making a base class and extending that, but I don't understand how 'test_helper' is working! I can't put the helper methods in test_helper because they use special integration helpers like post_with_redirect.

LS

$ ls test/integration
integration_helper_test.rb  post_integration_test.rb  user_flows_test.rb

Code, integration_helper_test.rb

class IntegrationHelperTest < ActionDispatch::IntegrationTest

  def login(user)
    ...

Code, post_integration_test.rb

require 'test_helper'
require 'integration_helper_test'
# require 'integration/integration_helper_test'

class PostIntegrationTest < ActionDispatch::IntegrationTest
  # include IntegrationHelperTest

Error

$ rake
rake aborted!
cannot load such file -- integration_helper_test
C:/Users/Chloe/workspace/SeenIt/test/integration/post_integration_test.rb:2:in `<top (required)>'
Tasks: TOP => test:run => test:integration

Code, post_integration_test.rb

require 'test_helper'
# require 'integration_helper_test'
require 'integration/integration_helper_test'

class PostIntegrationTest < ActionDispatch::IntegrationTest

Error

  1) Error:
PostIntegrationTest#test_should_create_post:
NoMethodError: undefined method `login' for #<PostIntegrationTest:0x3da81d0>
    test/integration/post_integration_test.rb:20:in `block in <class:PostIntegrationTest>'

Code, post_integration_test.rb

require 'test_helper'
# require 'integration_helper_test'
#require 'integration/integration_helper_test'

class PostIntegrationTest < ActionDispatch::IntegrationTest
  include IntegrationHelperTest

Error

$ rake
rake aborted!
wrong argument type Class (expected Module)
C:/Users/Chloe/workspace/SeenIt/test/integration/post_integration_test.rb:6:in `include'
C:/Users/Chloe/workspace/SeenIt/test/integration/post_integration_test.rb:6:in `<class:PostIntegrationTest>'
C:/Users/Chloe/workspace/SeenIt/test/integration/post_integration_test.rb:5:in `<top (required)>'
Tasks: TOP => test:run => test:integration

test_helper.rb

ENV["RAILS_ENV"] ||= "test"
require File.expand_path('../../config/environment', __FILE__)
require 'rails/test_help'

class ActiveSupport::TestCase
  ActiveRecord::Migration.check_pending!

Community · Accepted Answer · 2017-05-23 10:34:15Z

5

name_helper_test.rb files are not for common code, these are for the testcases for your helpers.

According to Rails Testing Guide file that ends at _test.rb are for test cases, you should write tests in that file, because rake task detects from _test.rb that is file id for tests. So if you want to add some common code, test_helper.rb is there for you. You can even define your own files for helpers methods, for further guide about common test code read A Guide for Writing Maintainable Rails Tests.

Note: Questions in the comments of above answers is that you write your code in test_helper.rb outside of a class and due to use of require all methods are available in other files, because they all require test_helper.rb.

edited May 23, 2017 at 10:34

CommunityBot

11 silver badge

answered May 9, 2014 at 11:29

Malik Shahzad

6,9893 gold badges39 silver badges50 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

Bart · Accepted Answer · 2016-10-26 00:09:35Z

4

Pick one:

module IntegrationHelperTest 
  # ...
end

require 'test_helper'
require 'integration/integration_helper_test'
class PostIntegrationTest < ActionDispatch::IntegrationTest
  include IntegrationHelperTest
  # ...
end

or

class IntegrationHelperTest < ActionDispatch::IntegrationTest
  # ...
end

require 'test_helper'
require 'integration/integration_helper_test'
class PostIntegrationTest < IntegrationHelperTest
  # ..
end

edited Oct 26, 2016 at 0:09

answered Dec 26, 2013 at 2:18

Bart

2,66623 silver badges32 bronze badges

3 Comments

Chloe Over a year ago

Wow module IntegrationHelper worked! But why does test_helper.rb work when it's a class ActiveSupport::TestCase? Any helper method in there is magically available in the integration tests.

Bart Over a year ago

Not sure I get it. You can only include/extend modules and only inherit from classes.

Chloe Over a year ago

It's automatically generated test/test_helper.rb. When you put a method in there, it is automatically available to all tests.

Collectives™ on Stack Overflow

How do I write a helper for an integration test in Rails?

LS

Code, integration_helper_test.rb

Code, post_integration_test.rb

Error

Code, post_integration_test.rb

Error

Code, post_integration_test.rb

Error

test_helper.rb

2 Answers 2

Comments

3 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

LS

Code, integration_helper_test.rb

Code, post_integration_test.rb

Error

Code, post_integration_test.rb

Error

Code, post_integration_test.rb

Error

test_helper.rb

2 Answers 2

Comments

3 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related