(FM-8355) Add spec_helper_acceptance

[florindragos]

This way, we just need to require 'litmus_spec_helper_acceptance' in the spec_helper_acceptance of every module

[codecov-io]

Codecov Report

Merging #210 into master will decrease coverage by 0.11%.
The diff coverage is 0%.

@@            Coverage Diff             @@
##           master     #210      +/-   ##
==========================================
- Coverage   59.73%   59.62%   -0.12%     
==========================================
  Files           6        6              
  Lines         534      535       +1     
==========================================
  Hits          319      319              
- Misses        215      216       +1

Impacted Files	Coverage Δ
lib/puppet_litmus.rb	0% <0%> (ø)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f3803c9...1b17df0. Read the comment docs.

[ekohl]

Related issue: #48

[scotje]

If you wrap all of this in a module function (e.g.PuppetLitmus.configure!) then you could write some unit tests around its behavior. Further, you could make the method take an options hash or yield a configuration object to a block to allow for more explicit customization, even if the defaults continue to look up things from the ENV and node config files.

Usage in spec_helper_acceptance.rb then looks like:

require 'puppet_litmus'
PuppetLitmus.configure!

or even:

begin
  require 'puppet_litmus'
  PuppetLitmus.configure!
rescue LoadError
  puts 'Unable to load Litmus, did you add it to your Gemfile?'
end

[florindragos]

If you wrap all of this in a module function (e.g.PuppetLitmus.configure!) then you could write some unit tests around its behavior. Further, you could make the method take an options hash or yield a configuration object to a block to allow for more explicit customization, even if the defaults continue to look up things from the ENV and node config files.

Usage in spec_helper_acceptance.rb then looks like:

require 'puppet_litmus'
PuppetLitmus.configure!

or even:

begin
  require 'puppet_litmus'
  PuppetLitmus.configure!
rescue LoadError
  puts 'Unable to load Litmus, did you add it to your Gemfile?'
end

We would still need to do include PuppetLitmus to have all the helper methods available for the specs unless there is some ruby magic to include a module by calling one of its instance methods.

[florindragos]

Updated code works with

require 'puppet_litmus'

include PuppetLitmus
PuppetLitmus.configure!

[ekohl]

Looks like there's a merge conflict so a rebase is needed.

[ekohl]

Looking at https://github.com/puppetlabs/puppetlabs_spec_helper/blob/master/lib/puppetlabs_spec_helper/puppetlabs_spec_helper.rb you can use RSpec.configure and call .extend or .include. That looks like a much cleaner solution.

[ekohl]

With the last upgrade the include PuppetLitmus is no longer needed, correct?

[florindragos]

With the last upgrade the include PuppetLitmus is no longer needed, correct?

yep, just tested

require 'puppet_litmus'
PuppetLitmus.configure!

[ekohl]

Thanks! I think this is a much cleaner way.

Currently the wiki documents how to integrate but I wonder if this is now simple enough to just include in README.md. https://github.com/puppetlabs/puppetlabs_spec_helper#usage is IMHO a great example to get started quickly and saves a click. IMHO README.md is also better because it's in the repo and thus versioned.