Project: RSpec Core 2.3

Publisher: RSpec

tag option

Use the --tag (or -t) option to filter the examples to be run by tag.

The tag can be a simple name or a name:value pair. In the first case,
examples with :name => true will be filtered. In the second case, examples
with :name => value will be filtered, where value is always a string.
In both cases, name is converted to a symbol.

Tags can also be used to exclude examples by adding a ~ before the tag.
For example ~tag will exclude all examples marked with :tag => true and
~tag:value will exclude all examples marked with :tag => value.

To be compatible with the Cucumber syntax, tags can optionally start with
a @, that will be ignored.

Background

Given

a file named "tagged_spec.rb" with:

describe "group with tagged specs" do
  it "example I'm working now", :focus => true do; end
  it "special example", :type => 'special' do; end
  it "slow example", :skip => true do; end
  it "ordinary example", :speed => 'slow' do; end
  it "untagged example" do; end
end

Scenarios

filter examples with non-existent tag
filter examples with a simple tag
filter examples with a simple tag and @
filter examples with a name:value tag
filter examples with a name:value tag and @
exclude examples with a simple tag
exclude examples with a simple tag and @
exclude examples with a name:value tag
exclude examples with a name:value tag and @

filter examples with non-existent tag

When: I run "rspec . --tag mytag"
And: the output should contain "0 examples, 0 failures"

filter examples with a simple tag

When: I run "rspec . --tag focus"
Then: the output should contain "Run filtered using {:focus=>true}"
And: the output should contain "1 example, 0 failures"

filter examples with a simple tag and @

When: I run "rspec . --tag @focus"
Then: the output should contain "Run filtered using {:focus=>true}"
Then: the output should contain "1 example, 0 failures"

filter examples with a name:value tag

When

I run "rspec . --tag type:special"

Then

the output should contain:

Run filtered using {:type=>"special"}

And

the output should contain "1 example, 0 failures"

filter examples with a name:value tag and @

When

I run "rspec . --tag @type:special"

Then

the output should contain:

Run filtered using {:type=>"special"}

And

the output should contain "1 example, 0 failures"

exclude examples with a simple tag

When: I run "rspec . --tag ~skip"
Then: the output should contain "4 examples, 0 failures"

exclude examples with a simple tag and @

When: I run "rspec . --tag [email protected]"
Then: the output should contain "4 examples, 0 failures"

exclude examples with a name:value tag

When: I run "rspec . --tag ~speed:slow"
Then: the output should contain "4 examples, 0 failures"

exclude examples with a name:value tag and @

When: I run "rspec . --tag [email protected]:slow"
Then: the output should contain "4 examples, 0 failures"

Last published almost 5 years ago by dchelimsky.

tag option

RSpec Core settings