https://github.com/stas/rspec-rake

RSpec support for testing Rake tasks
https://github.com/stas/rspec-rake

Last synced: about 1 month ago
JSON representation

RSpec support for testing Rake tasks

• Host: GitHub
• URL: https://github.com/stas/rspec-rake
• Owner: stas
• License: mit
• Created: 2014-02-02T15:52:42.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2017-07-23T16:15:12.000Z (over 7 years ago)
• Last Synced: 2024-05-02T00:07:43.951Z (9 months ago)
• Language: Ruby
• Homepage: http://ampersate.com/on-testing-rake-files
• Size: 12.7 KB
• Stars: 9
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# RSpec Rake Support

[![Build Status](https://travis-ci.org/stas/rspec-rake.png?branch=master)](https://travis-ci.org/stas/rspec-rake)

You can test you Rake files like you test your Rails app.

This gem adds an example group and configures RSpec so we can write tests for our Rake tasks easily.

## Installation

Add this line to your application's Gemfile:

    gem 'rspec-rake'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install rspec-rake

## Usage

Require `rspec/rake` in your `spec_helper.rb`

```ruby

require 'rspec/rake'

```

And start writing tests in your `spec/tasks` directory.

Normally `RSpec::Rake` will detect a **task** test and will try loading it from your `lib/tasks/*.rake` directory.

You can manually specify the rake file location and file name by using metadata:

```ruby

describe 'task:subtask', :rakefile => 'my_task' do

  # Spot the :rakefile metadata value

  # This will tell `RSpec::Test` to load `lib/tasks/my_task.rake`

  it 'does something' do

    task.invoke

  end

end

```

As you can see the subject of the test is the task with the name from example description.

You can also refer to the subject as `task`.

```ruby

describe 'task:subtask', :rakefile => 'my_task', :tasks_path => 'lib/capistrano/tasks' do

  # Same with the :tasks_path metadata value

  # This will tell `RSpec::Test` to load `lib/capistrano/task/my_task.rake`

end

```

Check [rails-dummy](https://github.com/Courseware/rails-dummy) tests for more examples.

### Limitations

Due to how `Rake::Application#rake_require` works, only files with `.rake` extension can be tests.

## Plagiarism alert

My tentative to provide RSpec support for testing Rake tasks in a convenient and idiomatic way is not new.

Previously [Thoughtbot](http://robots.thoughtbot.com/test-rake-tasks-like-a-boss) and [Tyler Hunt](http://devoh.com/blog/2010/11/testing-rake-tasks-with-rspec) wrote about this.

Although I picked a different approach to handle the same problem, it is pretty much the same solution. All I did is tried to put it all together and provide it the way you see it now.

## Contributing

1. Fork it ( http://github.com/stas/rspec-rake/fork )

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Add some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create new Pull Request