Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/wojtekmach/minitest-metadata

Annotate tests with key/value metadata
https://github.com/wojtekmach/minitest-metadata

Last synced: about 2 months ago
JSON representation

Annotate tests with key/value metadata

Host: GitHub
URL: https://github.com/wojtekmach/minitest-metadata
Owner: wojtekmach
Archived: true
Created: 2012-03-18T21:33:08.000Z (over 12 years ago)
Default Branch: master
Last Pushed: 2016-02-24T22:49:22.000Z (over 8 years ago)
Last Synced: 2024-07-24T21:12:03.859Z (2 months ago)
Language: Ruby
Homepage: https://github.com/wojtekmach/minitest-metadata
Size: 38.1 KB
Stars: 36
Watchers: 5
Forks: 12
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md

Awesome Lists containing this project

README

minitest-metadata
=================

[![Build Status](https://secure.travis-ci.org/wojtekmach/minitest-metadata.png?branch=master)](http://travis-ci.org/wojtekmach/minitest-metadata)

- **Source code:**
- **API reference:**

## Description

minitest-metadata allows you to set metadata (key-value) for your test cases so that
before and after hooks can use them.

You can use it to:

* change environments (prepare drivers, mocks etc)
* mark tests as slow, fast or (God forbid) order dependant

## Example

```ruby
require 'minitest/autorun'
require 'minitest-metadata'

describe 'thing' do
it 'does stuff', vcr: true do
puts metadata[:vcr] # => true
end
end
```

## Example with capybara

Suppose you want to tag some of your Capybara acceptance tests to
use JavaScript driver

```ruby
class AcceptanceTest < MiniTest::Spec
include Capybara::DSL

before do
if metadata[:js] == true
Capybara.current_driver = Capybara.javascript_driver
end
end

after do
Capybara.current_driver = Capybara.default_driver
end
end

class UsersAcceptanceTest < AcceptanceTest
it "basic pagination" do
visit "/users"
assert page.has_content?("Current page: 1")

click_link "Next page"

assert page.has_content?("Current page: 2")
end

it "keyboard shortcuts pagination", :js => true do
visit "/users"
assert page.has_content?("Current page: 1")

press_key "n"

assert page.has_content?("Current page: 2")
end
end
```

As in RSpec, [more compact syntax](https://www.relishapp.com/rspec/rspec-core/docs/metadata/user-defined-metadata#less-verbose-metadata) can be used:

```ruby
it "keyboard shortcuts pagination", :slow, :wip, :driver => :poltergeist
```

## Note about speed

minitest-metadata adds some overhead so you might want to limit it to only
acceptance specs. If that's the case do this:

```ruby
# Gemfile

group :test do
gem 'minitest-metadata', :require => false
end

# test/acceptance_test_helper.rb
require 'minitest/metadata'

class AcceptanceTest < MiniTest::Spec
include MiniTest::Metadata
end
```

## Requirements

- minitest

## Instalation

```
gem install minitest-metadata
```

or put in a Gemfile:

```ruby
gem 'minitest-metadata'
```

## License

(The MIT License)

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.