simple_approvals-chefspec 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f09a4f70a83e0c647f63ec39b38ccdf7382271dc532eab8a41b93668d86efc0a
-  data.tar.gz: b692894f7d4abe9c4500e58dfa641d0b89a5aaab1804ee714d2900b219718ecc
+  metadata.gz: 7ef40fd0cffc3cb25f8ef0875753e6d12d4e08d080e3a25a6d61751cb99e0ff0
+  data.tar.gz: 8c7f4ce94242618aedb7be1b695fd54979f8f872c6bbf02e9e935e47a2f6a4fe
 SHA512:
-  metadata.gz: 8cdac16c42c407e1334ecae4d0e6209470807ddc7d2497cbad0d35a9cc238c19435125d15fd8b082ad624f324a286808a8d871d7fce32d8173805b6af1592858
-  data.tar.gz: 53b5c31907d0b1f2f6a81941aa96100e01cb49680cf2993e7e526bc33de7474c754c7e863f300209eae7fd2b26629d7f88bd19d918d0490257212407fac2a270
+  metadata.gz: aeb24ea9fa18e9bcb317f6ea66423461ad1dfb242c23d578cbae586f5326dbdc5130075a04f2c93b40f2cd2db16e9a79a2d000be026184f5b981458d90f85034
+  data.tar.gz: 7e6d5860e9c66ef4fe861a43ed3ff16506aff4d0326945eb26103200a3e172ed89a09241fe4a19acb89ff32b04665a3481702ed4b2f60380f9ed5f7acc51f3d3

data/README.md

@@ -1,4 +1,84 @@
-simple_approvals
-===============
+# simple_approvals/chefspec
 
-a simple ruby implementation of the ApprovalTests pattern
+a simple chefspec-based implementation of the ApprovalTests pattern
+
+## Usage
+
+1. Update your `Gemfile` to include:
+
+    ```ruby
+    gem 'simple_approvals-chefspec'
+    ```
+
+1. Update `spec_helper.rb` to include:
+
+    ```ruby
+    require 'simple_approvals/chefspec'
+    ```
+
+1. Add a single template approval like this:
+
+    ```ruby
+    describe 'my-cookbook::my-recipe' do
+      include ChefVault::TestFixtures.rspec_shared_context
+      context 'When all attributes are default, on CentOS 7.4.1708' do
+        let(:chef_run) do
+          # for a complete list of available platforms and versions see:
+          # https://github.com/customink/fauxhai/blob/master/PLATFORMS.md
+          runner = ChefSpec::ServerRunner.new(platform: 'centos', version: '7.4.1708') do |node, server|
+            node.override['my-cookbook']['attribute1'] = true
+          end
+          runner.converge(described_recipe)
+        end
+
+
+        it 'converges successfully' do
+          expect { chef_run }.to_not raise_error
+        end
+
+        verify_chef_template(
+          expected_path: '/path/to/rendered/template',
+          approved_path: 'local/path/to/approved/template/output' # e.g. test/fixtures/approvals/logfile.xml
+        )
+      end
+    end
+    ```
+
+1. Add multiple template approvals like this:
+
+    ```ruby
+    describe 'my-cookbook::my-recipe' do
+      include ChefVault::TestFixtures.rspec_shared_context
+      context 'When all attributes are default, on CentOS 7.4.1708' do
+        let(:chef_run) do
+          # for a complete list of available platforms and versions see:
+          # https://github.com/customink/fauxhai/blob/master/PLATFORMS.md
+          runner = ChefSpec::ServerRunner.new(platform: 'centos', version: '7.4.1708') do |node, server|
+            node.override['my-cookbook']['attribute1'] = true
+          end
+          runner.converge(described_recipe)
+        end
+
+
+        it 'converges successfully' do
+          expect { chef_run }.to_not raise_error
+        end
+
+        verify_chef_templates(
+          { expected_path: '/path/to/rendered/template1',
+            approved_path: 'local/path/to/approved/template/output1' # e.g. test/fixtures/approvals/logfile1.xml
+          },
+          { expected_path: '/path/to/rendered/template2',
+            approved_path: 'local/path/to/approved/template/output2' # e.g. test/fixtures/approvals/logfile2.xml
+          }
+        )
+      end
+    end
+    ```
+
+## Development
+
+1. make changes
+2. bump `VERSION`
+3. `gem build simple_approvals-chefspec.gemspec`
+4. `gem push simple_approvals-chefspec-1.0.0.gem`

data/lib/simple_approvals/chefspec/approvals.rb

@@ -1,6 +1,6 @@
 require 'rspec'
 require 'chefspec'
-require 'simple_approvals'
+require 'simple_approvals/rspec'
 
 module RSpec
   module Core

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple_approvals-chefspec
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - David Alpert