Add Regexp support to with_* matchers and improve error messages

[jeffmccune]

Without this patch it is difficult to match portions of long strings
which are attribute values of resource parameters. For example, the
content parameter of a file resource with a multi-line template.

This patch makes it easier to match portions of the parameter's value by
passing a Regexp instance to the with_ catch all matcher.

The use case looks like:

describe 'with lsbmajdistrelease available' do
  let(:facts) { @facter_facts.merge({'lsbmajdistrelease' => '6'}) }
  it { should_not contain_file('puppetenterprise.repo').with_content(missing_content) }
  it { should contain_package 'pe-ruby-devel' }
  it do
    should contain_file('puppetenterprise.repo').with_content(/baseurl=http/)
    should contain_file('puppetenterprise.repo').with_content(/pe_base/)
    should contain_file('puppetenterprise.repo').with_content(/pe_updates/)
    should contain_file('puppetenterprise.repo').with_content(/pe_extras/)
  end
end

This feature allows the same parameter to be matched multiple times using
multiple different regular expressions.

This patch also improves the error message by presenting the actual value in
the catalog when it does not match the expectation. This change applies to
both String and Regexp expectation matches.

The error output now looks like:

1) pe_devel on redhat el6 os families with lsbmajdistrelease available
   Failure/Error: should contain_file('puppetenterprise.repo').with_content(/JEFF MCCUNE/)
     expected that the catalogue would contain File[puppetenterprise.repo] with content \
     matching `/JEFF MCCUNE/` but its value of `"# KERMIT FROG\n"` does not

Spec tests have been added to exercise the handling of Regexp instances.

[jeffmccune]

@rodjek I should mention I tested this change on both 2.6.7 and 2.7.x and it appears to work fine. I was a bit concerned about the switch to resource.to_hash, but I think it's fine in 2.6 and beyond.

Cheers,
-Jeff

[jeffmccune]

@rodjek Ping?

[bodepd]

The code looks fine (and works!)

I have also verified that it works in combination with #18

Just one small comment which in my opinion should not block merging this code:

The wording could be a little better in the case where there are multiple failures:

2. keystone when specifying class parameters
   Failure/Error: ) end
   expected that the catalogue would contain File[/etc/keystone] with group set to "keystones" but it is set to "keystone" in the catalogue, mode matching /^\d{3}$/ but its value of "0755" does not

I am not quite sure what the reviewed by process is for a pull request. Should I a mend a reviewed by message to the commit and repush?

[jeffmccune]

On Dec 29, 2011, at 2:41 PM, Dan Bode wrote:

The code looks fine (and works!)

I have also verified that it works in combination with #18

Just one small comment which in my opinion should not block merging this code:

The wording could be a little better in the case where there are multiple failures:

2. keystone when specifying class parameters
   Failure/Error: ) end
   expected that the catalogue would contain File[/etc/keystone] with group set to "keystones" but it is set to "keystone" in the catalogue, mode matching /^\d{3}$/ but its value of "0755" does not

Yeah, I struggled with how to word that failure message well for the arbitrary cases it needs to handle.

What part of the message is jumping out at you?

I take it the run-on sentence around the comma in "...in the catalogue, mode matching…" ?

I am not quite sure what the reviewed by process is for a pull request. Should I a mend a reviewed by message to the commit and repush?

I'll amend my own commit to make it easy since you can't push to my fork. Really all that's required is "this looks good, you can add a reviewed-by: line for me"

-Jeff

[jeffmccune]

@bodepd I amended the commit. What do you think about this:

expected that the catalogue would contain File[/etc/keystone] with group set to `"keystones"` but it is set to `"keystone"` in the catalogue, and parameter mode matching `/^\d{3}$/` but its value of `"0755"` does not

I inserted "and parameter" into the join of the errors.

[bodepd]

Reviewed-By: Dan Bode dan@puppetlabs.com