jimdo-rspec-puppet-helpers 0.0.3 → 0.0.4

data/.rspec

@@ -0,0 +1 @@
+--format documentation --color

data/Gemfile

@@ -1,4 +1,6 @@
 source 'https://rubygems.org'
 
+gem "puppet", "~>2.7"
+
 # Specify your gem's dependencies in jimdo-rspec-puppet-helpers.gemspec
 gemspec

data/Gemfile.lock

@@ -1,14 +1,28 @@
 PATH
   remote: .
   specs:
-    jimdo-rspec-puppet-helpers (0.0.3)
+    jimdo-rspec-puppet-helpers (0.0.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    diff-lcs (1.2.4)
+    facter (1.7.3)
+    puppet (2.7.23)
+      facter (~> 1.5)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.5)
+    rspec-expectations (2.14.2)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.3)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   jimdo-rspec-puppet-helpers!
+  puppet (~> 2.7)
+  rspec

data/README.md

@@ -1,6 +1,27 @@
 # jimdo-rspec-puppet-helpers
 
-TODO: Write a gem description
+This gem adds a single rspec helper method to puppet-rspec in order to test the contents of a `file`
+which has no `content` param, but a `source` param.
+
+It looks up the path (e. g. `puppet:///modules/sample/test.ini`) like puppet would do and compares its content to
+a given regular expression.
+
+This is especially useful if you have a legacy codebase which excessively abuses `File->src`: E. g. you can do safe refactorings like this:
+
+ 1. Write tests for existing files with this helper
+ 
+        it 'should be able to upload 100 files in one HTTP POST' do
+          should puppet_file_contains('/etc/php5/php.ini', /^max_uploads = 100\n$/m)
+        end
+
+ 2. Refactor: Make thie `File` a template and replace `source` with `content`
+ 3. Adjust test:
+
+        should contain_file('/etc/php5/php.ini').with({
+          :content => /^max_uploads = 100\n$/m
+        })
+
+ 4. Use a module like inifile in order to get rid of the regular expression hell and in order to have real DESCRIPTIVE cfg mgmt.
 
 ## Installation
 
@@ -16,9 +37,10 @@ Or install it yourself as:
 
     $ gem install jimdo-rspec-puppet-helpers
 
-## Usage
+## Testing
 
-TODO: Write usage instructions here
+    $ bundle install
+    $ bundle exec rake spec
 
 ## Contributing
 

data/Rakefile

@@ -1,2 +1,5 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)

data/jimdo-rspec-puppet-helpers.gemspec

@@ -1,15 +1,30 @@
 # -*- encoding: utf-8 -*-
-Gem::Specification.new do |gem|
-  gem.authors       = ["Daniel Bonkowski", "Ingo Oeser", "Soenke Ruempler"]
-  gem.email         = ["infrateam@jimdo.com" ]
-  gem.description   = %q{rspec-puppet helpers}
-  gem.summary       = %q{rspec-puppet helpers}
-  gem.homepage      = ""
-
-  gem.files         = `git ls-files`.split($\)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.name          = "jimdo-rspec-puppet-helpers"
-  gem.require_paths = ["lib"]
-  gem.version       = '0.0.3'
+
+Gem::Specification.new do |s|
+  s.name = %q{jimdo-rspec-puppet-helpers}
+  s.version = "0.0.4"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Daniel Bonkowski", "Ingo Oeser", "Soenke Ruempler", "Ilya Margolin"]
+  s.date = %q{2014-04-03}
+  s.description = %q{rspec-puppet helpers}
+  s.email = ["infrateam@jimdo.com"]
+  s.files = [".gitignore", ".rspec", "Gemfile", "Gemfile.lock", "LICENSE", "README.md", "Rakefile", "jimdo-rspec-puppet-helpers.gemspec", "lib/jimdo-rspec-puppet-helpers.rb", "spec/puppet_file_contains_spec.rb", "spec/spec_helper.rb"]
+  s.homepage = %q{}
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{rspec-puppet helpers}
+  s.test_files = ["spec/puppet_file_contains_spec.rb", "spec/spec_helper.rb"]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 0"])
+  end
 end

data/lib/jimdo-rspec-puppet-helpers.rb

@@ -1,50 +1,40 @@
 require 'rspec'
+require 'puppet'
+require 'puppet/file_serving'
+require 'puppet/file_serving/metadata'
 
 RSpec::Matchers.define :puppet_file_contains do |file, expected|
   match do |actual|
-    files = actual.resource('file', file).to_hash[:source].map do |catalog_file|
-      catalog_file.gsub(/^puppet:\/\//, '')
+    @message = nil
+    resource = actual.resource('file', file)
+    if not resource then
+      @message = "expected 'File[#{file}]' in catalog, not found!"
+      next
+    end
+    source_attr = resource.to_hash[:source]
+    if not source_attr then
+      @message = "expected source attribute on #{resource}, found: #{resource.to_hash.keys.sort.join(",")}"
+      next
     end
-    found_file = nil
-    files.each do |catalog_file|
-      sliced_path = catalog_file.split('/')
-      module_path = sliced_path[1..2]
-      relative_path_in_puppet_files = sliced_path.slice(3..sliced_path.length)
 
-      # check whether we have rspec fixtures
-      if File.directory?("./spec/fixtures") then
-        path = File.expand_path(
-          File.join(
-            'spec/fixtures',
-            module_path,
-            'files',
-            relative_path_in_puppet_files
-           )
-        );
-      # else use files in puppet source tree
-      else
-        path = File.expand_path(
-          File.join(
-            module_path,
-            'files',
-            relative_path_in_puppet_files
-           )
-        );
-      end
-      if File.file?(path) then
-        found_file = path
-        break
-      end
+    file_data = nil
+    source_attr.each do |source|
+      file_data = Puppet::FileServing::Metadata.indirection.find(source)
+      break if file_data
     end
 
-    if !found_file then
-      false
+    if !file_data then
+      @message = "no files specified in 'source' exist"
+      next
     else
+      found_file = file_data.path
+
+      @message = "expected that #{file}(source=#{found_file}) matches #{expected}"
       expected.match(IO.read(found_file)) != nil
     end
   end
 
   failure_message_for_should do |actual|
-    "expected that it matches #{expected}"
+    @message
   end
 end

data/spec/puppet_file_contains_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+
+describe 'puppet_file_contains' do
+  context "resource not found" do
+    subject {
+      catalog = double()
+      resource = double()
+      catalog.stub(:resource) { nil }
+      catalog
+    }
+    it "will raise ExpectationNotMetError with 'expected File[/path/file] in catalog, not found!'" do
+      expect {
+        should puppet_file_contains('/path/file', %r'regex')
+      }.to raise_error(RSpec::Expectations::ExpectationNotMetError, %r(expected 'File\[/path/file\]' in catalog, not found!))
+    end
+  end
+
+  context "resource does not contain 'source' key" do
+    subject {
+      catalog = double()
+      resource = double()
+      catalog.stub(:resource) { resource }
+      resource.stub(:to_hash) { { :some_attribute => 1, :some_other_attribute => 2} }
+      catalog
+    }
+    it "will raise ExpectationNotMetError with 'expected source attribute'" do
+      expect {
+        should puppet_file_contains('/path/file', %r'regex')
+      }.to raise_error(RSpec::Expectations::ExpectationNotMetError, /expected source attribute on .*, found: some_attribute,some_other_attribute/)
+    end
+  end
+
+  context "resource is found, source is present" do
+    subject {
+      catalog = double()
+      resource = double()
+      catalog.stub(:resource) { resource }
+      resource.stub(:to_hash) { { :source => ['puppet:///modules/modulex/path1', 'puppet:///modules/modulex/path2'] } }
+      catalog
+    }
+
+    context "no files found" do
+      it "will raise ExpectationNotMetError with 'expected source attribute'" do
+        Puppet::FileServing::Metadata.indirection.stub(:find) {
+          nil
+        }
+        expect {
+          should puppet_file_contains('/path/file', %r'regex')
+        }.to raise_error(RSpec::Expectations::ExpectationNotMetError, /no files specified in 'source' exist/)
+      end
+    end
+
+    context "some file is found, but does not match regex" do
+      it "will raise ExpectationNotMetError with 'expected source attribute'" do
+        Puppet::FileServing::Metadata.indirection.stub(:find) {
+          double(:path => '/some/path/to/file')
+        }
+        IO.stub(:read).with('/some/path/to/file') { 'something else' }
+        expect {
+          should puppet_file_contains('/path/file', %r'regex')
+        }.to raise_error(RSpec::Expectations::ExpectationNotMetError, /^#{Regexp.quote("expected that /path/file(source=/some/path/to/file) matches")}/)
+      end
+    end
+
+    context "some file is found and matches regex" do
+      it "will raise ExpectationNotMetError with 'expected source attribute'" do
+        Puppet::FileServing::Metadata.indirection.stub(:find) {
+          double(:path => '/some/path/to/file')
+        }
+        IO.stub(:read).with('/some/path/to/file') { 'I do match a regex' }
+        should puppet_file_contains('/path/file', %r'regex')
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'lib/jimdo-rspec-puppet-helpers.rb'

metadata

@@ -1,26 +1,52 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: jimdo-rspec-puppet-helpers
-version: !ruby/object:Gem::Version
-  version: 0.0.3
+version: !ruby/object:Gem::Version 
+  hash: 23
   prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 4
+  version: 0.0.4
 platform: ruby
-authors:
+authors: 
 - Daniel Bonkowski
 - Ingo Oeser
 - Soenke Ruempler
+- Ilya Margolin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-29 00:00:00.000000000 Z
-dependencies: []
+
+date: 2014-04-03 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
 description: rspec-puppet helpers
-email:
+email: 
 - infrateam@jimdo.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
+- .rspec
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -28,28 +54,42 @@ files:
 - Rakefile
 - jimdo-rspec-puppet-helpers.gemspec
 - lib/jimdo-rspec-puppet-helpers.rb
-homepage: ''
+- spec/puppet_file_contains_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: ""
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: rspec-puppet helpers
-test_files: []
+test_files: 
+- spec/puppet_file_contains_spec.rb
+- spec/spec_helper.rb