Unable to access inclusion_filter using RSpec.configuration.

[kandadaboggu]

I am trying to access the inclusion filters from a before(:suite) hook. Even though the value is passed in the command line I do not get any value when I try to access the filter.

RSpec.configure do |config|
  config.before :suite, type: :feature do
    if config.inclusion_filter[:use_ff]
      register_selenium
    else
      register_poltergeist
    end
  end
end

In the code above, the register_selenium section is never called even when I pass the tag.
For a good measure I tried to add few log statements before accessing the filter

puts config.inclusion_filter.empty? # returns true
puts config.inclusion_filter.description # returns {}

The filters are recognized by rspec as I see their names logged in the console:

Run options: include {:focus=>true, :use_ff=>true}

I am using version 3.1.4 of rspec-core

[JonRowe]

I can't replicate this, I tried this:

RSpec.configure do |config|
  config.before :suite, type: :feature do
    puts "Suite Filtered"
    puts config.inclusion_filter.inspect
    if config.inclusion_filter[:type]
      puts "Let's go! #{config.inclusion_filter[:type]} #{config.inclusion_filter[:type] == "feature"}"
    end
    puts "Fin"
  end
end

RSpec.describe do
  it "a spec", type: :feature do
    true
  end
end

$ rspec spec/inclusion_filter_demo_spec.rb --tag type:feature
Run options: include {:type=>"feature"}
Suite Filtered
#<RSpec::Core::InclusionRules:0x00000103401178 @rules={:type=>"feature"}, @opposite=#<RSpec::Core::ExclusionRules:0x000001034011f0 @rules={}, @opposite=#<RSpec::Core::InclusionRules:0x00000103401178 ...>>>
Let's go! feature true
Fin
  a spec

Finished in 0.00043 seconds (files took 0.06472 seconds to load)
1 example, 0 failures

Can you provide a reproducible example in a gist?

[kandadaboggu]

Here is a repository https://github.com/kandadaboggu/rspec_test that shows the problem.

run with tag name

$ rspec --tag use_ff
Run options: include {:focus=>true, :use_ff=>true}

All examples were filtered out; ignoring {:focus=>true, :use_ff=>true}

--- before suite - begin
Inclusion filter values: {}
Using Webkit
--- before suite - end
.

Finished in 0.00139 seconds
1 example, 0 failures

run with tag name and value

$ rspec --tag use_ff:true
Run options: include {:focus=>true, :use_ff=>true}

All examples were filtered out; ignoring {:focus=>true, :use_ff=>true}

--- before suite - begin
Inclusion filter values: {}
Using Webkit
--- before suite - end
.

Finished in 0.0013 seconds
1 example, 0 failures

Observations

• Inclusion filter hash is empty in the before suite callback

[JonRowe]

Hmm I can replicate this now, the problem isn't limited to before suite either, it affects before example hooks too.

[kandadaboggu]

The console shows correct values for inclusion filters.

All examples were filtered out; ignoring {:focus=>true, :use_ff=>true}

By the time the control reaches the before blocks the value is reset.

[myronmarston]

The clearing of the inclusion filters is intentional, since you have configured run_all_when_everything_filtered. If you had an example with :use_ff metadata it would not clear it. Alternately, if you don't want it to clear the inclusion filters, don't set run_all_when_everything_filtered.

When there are no matching examples and run_all_when_everything_filtered is set, you've configured RSpec to ignore the filters, so it would be inconsistent for RSpec to retain the provided inclusion_filters since they are not actually in effect.