Logo: Relish

  1. Sign in

Project: RSpec Core 2.2

Publisher: RSpec

inclusion filters

You can restrict which examples are run by declaring an inclusion filter. The
most common use case is to focus on a subset of examples as you're focused on
a particular problem.

Background
Given
a file named "spec/spec_helper.rb" with: 
RSpec.configure do |c|
  # filter_run is short-form alias for filter_run_including
  c.filter_run :focus => true
end
Scenarios
  1. focus on an example
  2. focus on a group
  3. before/after(:all) hooks in unmatched example group are not run
focus on an example
Given
a file named "spec/sample_spec.rb" with: 
require "spec_helper"

describe "something" do
  it "does one thing" do
  end

  it "does another thing", :focus => true do
  end
end
When
I run "rspec spec/sample_spec.rb --format doc"
Then
the output should contain "does another thing"
And
the output should not contain "does one thing"
focus on a group
Given
a file named "spec/sample_spec.rb" with: 
require "spec_helper"

describe "group 1", :focus => true do
  it "group 1 example 1" do
  end

  it "group 1 example 2" do
  end
end

describe "group 2" do
  it "group 2 example 1" do
  end
end
When
I run "rspec spec/sample_spec.rb --format doc"
Then
the output should contain "group 1 example 1"
And
the output should contain "group 1 example 2"
And
the output should not contain "group 2 example 1"
before/after(:all) hooks in unmatched example group are not run
Given
a file named "spec/before_after_all_inclusion_filter_spec.rb" with: 
require "spec_helper"

describe "group 1", :focus => true do
  before(:all) { puts "before all in focused group" }
  after(:all)  { puts "after all in focused group"  }

  it "group 1 example" do
  end
end

describe "group 2" do
  before(:all) { puts "before all in unfocused group" }
  after(:all)  { puts "after all in unfocused group"  }

  context "context 1" do
    it "group 2 context 1 example 1" do
    end
  end
end
When
I run "rspec ./spec/before_after_all_inclusion_filter_spec.rb"
Then
the output should contain "before all in focused group"
And
the output should contain "after all in focused group"
And
the output should not contain "before all in unfocused group"
And
the output should not contain "after all in unfocused group"

Last published over 4 years ago by dchelimsky.