How to run Rails console in the test environment and load test_helper.rb?

Question

The background: I'm having some problems with Thoughtbot's "Factory Girl" gem, with is used to create objects to use in unit and other tests. I'd like to go to the console and run different Factory Girl calls to check out what's happening. For example, I'd like to go in there are do...

>> Factory(:user).inspect

I know that you can run the console in different environments...

$ script/console RAILS_ENV=test

But when I do that, Factory class is not available. It looks as though test_helper.rb is not getting loaded.

I tried various require calls including one with the absolute path to test_helper.rb but they fail similarly to this:

$ script/console RAILS_ENV=test
>> require '/Users/ethan/project/contactdb/test/test_helper.rb'
  Errno::ENOENT: No such file or directory - 
  /Users/ethan/project/contactdb/config/environments/RAILS_ENV=test.rb

Grr. Argh.

Consequently if you had placed the RAILS_ENV=test before script/console, it would have worked as you would expect. — Jared, Dec 01 '09 at 19:34

score 219 · Accepted Answer · edited Apr 25 '19 at 06:26

219

For Rails < 3.0

Run script/console --help. You'll notice that the syntax is script/console [environment], which in your case is script/console test.

I'm not sure if you have to require the test helper or if the test environment does that for you, but with that command you should at least be able to boot successfully into the test env.

As a sidenote: It is indeed kind of odd that the various binaries in script/ has different ways of setting the rails environment.

For Rails 3 and 4

Run rails c test. Prepend bundle exec if you need this for the current app environment.

For Rails 5 and 6

Run rails console -e test.

edited Apr 25 '19 at 06:26

localhostdotdev

1,795
16
21

answered Jun 26 '09 at 16:36

August Lilleaas

54,010
13
102
111

63

In rails 3, it's just `rails console [environment]` – Idris Mokhtarzada Dec 14 '10 at 20:00
26

It's a little inconsistent because to start the server you type `rails server -e test` – Jason Jan 20 '11 at 22:14
In Rails 5 this still works. And, you do need to load at least some parts of your environment -- in my case ```features/support/helpers.rb``` wasn't automagically loaded. Also, ```Rack::Test``` isn't loaded. – Derrell Durrett Nov 16 '16 at 00:08

score 62 · Answer 2 · answered Jul 08 '11 at 20:57

62

In Rails 3, just do rails console test or rails console production or rails console development (which is the default).

answered Jul 08 '11 at 20:57

sivabudh

31,807
63
162
228

score 14 · Answer 3 · answered Nov 03 '18 at 02:30

14

For Rails 5.2.0: "Passing the environment's name as a regular argument is deprecated and will be removed in the next Rails version. Please, use the -e option instead."

rails c -e test

answered Nov 03 '18 at 02:30

Tovi Newman

596
4
16

score 10 · Answer 4 · answered Jun 26 '09 at 18:24

10

script/console test

Should be all you need.

answered Jun 26 '09 at 18:24

David Smith

426
3
7

score 4 · Answer 5 · answered Sep 19 '16 at 07:45

4

You can specify the environment in which the console command should operate.

rails c [environment]

Examples

1) For Staging

rails c staging

2) For Production

rails c production

For source & detailed description: The Rails Command Line

answered Sep 19 '16 at 07:45

Aamir

16,329
10
59
65

score 3 · Answer 6 · answered Feb 09 '11 at 19:44

David Smith is correct, just do

script/console test

The help command will show why this works:

$ script/console -h
Usage: console [environment] [options]
    -s, --sandbox                    Rollback database modifications on exit.
        --irb=[irb]                  Invoke a different irb.
        --debugger                   Enable ruby-debugging for the console.

It's the [environment] bit.

score 2 · Answer 7 · answered May 19 '17 at 19:15

I share the asker's pain. There are really three separate questions here, some of which are addressed, some not:

How do you start the console in the test environment?

For recent Rails versions, bundle exec rails c test, or alternative syntaxes for that.
How do you ensure that test/test_helper.rb is loaded into that console session?

Something like require './test/test_helper' ought to do it.

For me, this returns true, indicating that it was not already loaded when I started the console. If that statement returns false, then you just wasted a few keystrokes, but you're still good to go.
Once test_helper is loaded, how do you call the methods defined in it?

In a typical test_helper, the custom methods are typically defined as instance methods of ActiveSupport::TestCase. So if you want to call one of them, you need an instance of that class. By trial and error, ActiveSupport::TestCase.new has one required parameter, so...pass it something.

If your test_helper has a method called create_user, you could invoke it this way: ActiveSupport::TestCase.new("no idea what this is for").create_user

Rather than trial or error - use the rails API guide to find what it needs http://api.rubyonrails.org/classes/ActiveSupport/TestCase.html ... it's probably test order which is `:random` by default — Mirv - Matt, May 30 '17 at 22:32
There's only those two class methods described for ActiveSupport::TestCase, so I'm unclear on what class/module it inherits its `initialize` method from. But it looks like the parameter it expects gets stored as `@NAME` on the created object. — Nick Davies, Jun 02 '17 at 14:25

score 1 · Answer 8 · answered Jun 26 '09 at 16:54

1

Make sure you installed the GEM and you added the following line either in your environment.rb or test.rb file.

config.gem "thoughtbot-factory_girl", :lib => "factory_girl", :source => "http://gems.github.com"

answered Jun 26 '09 at 16:54

Simone Carletti

173,507
49
363
364

score 0 · Answer 9 · answered Apr 14 '16 at 07:30

0

Test Env

rails console test # or just rails c test

Developement Env

rails console # or just rails c

answered Apr 14 '16 at 07:30

anyavacy

1,618
5
21
43

score 0 · Answer 10 · answered Apr 18 '19 at 11:07

Command to run rails console test environment is

rails c -e test

or

RAILS_ENV=test rails c

if you are facing problem something like

ActiveRecord::StatementInvalid:
   Mysql2::Error: Table 'DB_test.users' doesn't exist: SHOW FULL FIELDS FROM `users`

then you should first prepare your test DB by running

bundle exec rake db:test:prepare

How to run Rails console in the test environment and load test_helper.rb?

10 Answers10

Linked