simple_approvals-chefspec 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e4d417ea8ccd1d5e97bcae8b064a93ed956750d3
-  data.tar.gz: 2872719e87dffba61ec1feea62e8aeb30aeb2728
+SHA256:
+  metadata.gz: f09a4f70a83e0c647f63ec39b38ccdf7382271dc532eab8a41b93668d86efc0a
+  data.tar.gz: b692894f7d4abe9c4500e58dfa641d0b89a5aaab1804ee714d2900b219718ecc
 SHA512:
-  metadata.gz: 84a7c512cbe4c1826345fd62b25a501a4611e1f4a8562f55706a2368c711a2d5f8f52292fcca45bc72a61c2c92fed8f4dc8eca6d7667b6a88dc746482e23aca8
-  data.tar.gz: edd6cae4289d79cf3c5738d785cc9284eee8bec79f81ff946454a7bf244997782e698e547686fdc7c190955de891a85e59393d18a011ec18c3b5899c749dd99c
+  metadata.gz: 8cdac16c42c407e1334ecae4d0e6209470807ddc7d2497cbad0d35a9cc238c19435125d15fd8b082ad624f324a286808a8d871d7fce32d8173805b6af1592858
+  data.tar.gz: 53b5c31907d0b1f2f6a81941aa96100e01cb49680cf2993e7e526bc33de7474c754c7e863f300209eae7fd2b26629d7f88bd19d918d0490257212407fac2a270

data/lib/simple_approvals/chefspec/approvals.rb

@@ -0,0 +1,99 @@
+require 'rspec'
+require 'chefspec'
+require 'simple_approvals'
+
+module RSpec
+  module Core
+    # open up ExampleGroup to add template approval helpers
+    class ExampleGroup
+      class << self
+        # This defines a batch of approval expectations which will be executed
+        # for each template, because each template can fail for multiple reasons:
+        # - not being defined in a recipe (or being defined with a different path)
+        # - not rendering in the cookbook (i.e. file does not exist where expected)
+        # - rendering with unexpected content
+        shared_examples_for 'an approved chef template' do |file|
+          describe file[:expected_path] do
+            if file[:template]
+              it 'defines the template resource' do
+                expect(chef_run).to create_template(file[:expected_path])
+              end
+            end
+
+            it 'renders the expected file' do
+              expect(chef_run).to render_file(file[:expected_path])
+            end
+
+            it 'renders the expected file with the expected content' do
+              verifier = Approvals.chef_template_verifier_for(file[:expected_path], file[:approved_path], scrubber: file[:scrubber], keep_received_file: file[:keep_received_file])
+              expect(chef_run).to render_file(file[:expected_path]).with_content(verifier)
+            end
+          end
+        end
+
+        # verify one template:
+        #
+        #    verify_chef_template(expected_path: '', approved path: '')
+        #
+        def verify_chef_template(**file)
+          file[:template] = true
+          file[:scrubber] = ->(rendered_content) { yield rendered_content } if block_given?
+          verify_chef_file(**file)
+        end
+
+        def verify_chef_file(**file)
+          file[:scrubber] = ->(rendered_content) { yield rendered_content } if block_given?
+          include_examples 'an approved chef template', file
+        end
+
+        # verify a set of templates:
+        #
+        #     verify_chef_templates(
+        #        { expected_path: '',
+        #          approved path: ''
+        #        },
+        #        { expected_path: ''
+        #          approved path: ''
+        #        }
+        #     )
+        #
+        # note: this requires that rubocop is configued like this:
+        #
+        #     BracesAroundHashParameters:
+        #         EnforcedStyle: context_dependent
+        #
+        # which is taken care of in the shared lib/.chef-rubocop.yml
+        #
+        def verify_chef_templates(*specs)
+          specs.each do |file|
+            file[:scrubber] = ->(rendered_content) { yield rendered_content } if block_given?
+            file[:template] = true
+            verify_chef_file(file)
+          end
+        end
+
+        def verify_chef_files(*specs)
+          specs.each do |file|
+            file[:scrubber] = ->(rendered_content) { yield rendered_content } if block_given?
+            verify_chef_file(file)
+          end
+        end
+      end
+    end
+  end
+end
+
+# open SimpleApprovals::Approvals and add a ChefSpec-specific helper
+class Approvals
+  class << self
+    def chef_template_verifier_for(expected_path, approved_path, **options)
+      options[:message_override] = %(expected Chef run to render "#{expected_path}" matching "#{approved_path}")
+
+      proc do |rendered_content|
+        rendered_content = yield(rendered_content) if block_given?
+        rendered_content = options[:scrubber].call(rendered_content) if options[:scrubber]
+        verify(rendered_content, approved_path, **options)
+      end
+    end
+  end
+end

data/lib/simple_approvals/chefspec.rb

@@ -0,0 +1 @@
+require 'simple_approvals/chefspec/approvals'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_approvals-chefspec
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - David Alpert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-18 00:00:00.000000000 Z
+date: 2019-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -145,6 +145,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - README.md
+- lib/simple_approvals/chefspec.rb
+- lib/simple_approvals/chefspec/approvals.rb
 homepage: https://github.com/davidalpert/simple_approvals-chefspec/
 licenses: []
 metadata: {}
@@ -164,7 +166,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.9
 signing_key: 
 specification_version: 4
 summary: ''