minitest-rails

Minitest integration for Rails 4.1+

Build
Status

Install

gem install minitest-rails

This installs the following gems:

minitest

Configure

Create a new rails app without Test::Unit:

rails new MyApp --skip-test-unit

Add minitest-rails to the Gemfile:

gem "minitest-rails"

If you are running Rails 4.0 or earlier, be sure to specify a 1.x release in the Gemfile:

gem "minitest-rails", "~> 1.0"

Next run the installation generator with the following:

rails generate minitest:install

This will add the test_helper.rb file to the test directory.

Usage

This project aims to enable Minitest within the Rails TestCase classes. Your test will continue to inherit from ActiveSupport::TestCase, which will now support the spec DSL. You can generate test files with the standard model, controller, resource, and other generators:

rails generate model User

And you can specify generating the tests using the Minitest::Spec DSL on any of the generators by providing the --spec option:

rails generate model User --spec

And you can specify not generating the fixture for a model by providing the --skip-fixture option:

rails generate model User --skip-fixture

You can also set these as defaults by adding the following to the config/application.rb file:

config.generators do |g|
  g.test_framework :minitest, spec: true, fixture: false
end

To run your tests, minitest-rails provides multiple rake tasks by default, for a complete list, simply run rake -T.

You can also add any directories under test/ and minitest-rails will automatically create the associated rake task for it. So let say you add a test/api/ directory, rake minitest:api will automagically be available.

If you want to automatically run rake minitest:api when you call rake minitest, add this line to a new .rake file under lib/tasks/:

Minitest::Rails::Testing.default_tasks << 'api'

Using Rails 4.0 or earlier

For information on running Rails 3.0 through 4.0, see the README for the 1.x branch: github.com/blowmage/minitest-rails/tree/1.x#readme

Capybara

You can use Capybara for feature tests by adding minitest-rails-capybara as a dependency. See the README for more information: github.com/blowmage/minitest-rails-capybara

RSpec Compatibility

RSpec and Minitest's spec DSL are incompatible and both cannot be loaded at the same time. If your tests using the spec DSL are not running it is likely the RSpec DSL is also loaded. Check the dependencies and make sure RSpec is only loaded when running the specs.

If you need to use some RSpec features with minitest-rails require only the needed gems. e.g. To use RSpec mocks with minitest-rails require the “rspec-mocks” gem only, and not the main “rspec” gem which activates the RSpec DSL.

Get Involved

Join the mailing list to get help or offer suggestions.

groups.google.com/group/minitest-rails

License

Copyright © 2014 Mike Moore

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.