chef-vault-testfixtures 0.3.0.20150417141427 → 0.4.0.20150424123749

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 061b4ef41c4e3bc41a4fa2e4ba49e09b79f83e9b
-  data.tar.gz: db49f7226f5d2684e3c0203853d86e0fa200e880
+  metadata.gz: 1cab73c11ad8e6ff474d55781924adac92429b55
+  data.tar.gz: 6706ff2bd9cc0a310b8c39b366fbb1b8baf9872f
 SHA512:
-  metadata.gz: 14b2a13313dc979b9053c3d079e9b48d00c1800709899aa052922eb3ec2ed9de886d91bea740291e4329d75f5a4a5ff423466eb719ee685ff4b5f159e3871a4a
-  data.tar.gz: 7a575c3ea9cfd60c8c3661e0c2f0d67843da3956b908ae55a22d59e8ebaf166223832f7b5a430bc29abbaee2a7ed03432619aa6b26dad8b5e50102e957b22eb8
+  metadata.gz: 98b1322d292df41c7d124c39c7042075cc2322b98059f2820466210c97d6ed2ced8e544014cd56040992bbc3d5bade1af3f37261ecddfcb6fae011ab1f848b46
+  data.tar.gz: 0fea9ed27ed577f828cee69cb2c290334fc43bb2712d6c0cb09f807e81f684289651ce081886e5eb08b4eed092a29c8a935f8239568b90c8bcb84f6aedcdf98a

data/History.md

@@ -1,5 +1,9 @@
 # Changelog for chef-vault-testfixtures
 
+## 0.4.0
+
+* add stubs for Chef::DataBagItem.load and Chef::DataBag.load for compatibility with code that probes the data bag to determine if it is a vault (e.g. chef-vault cookbook ~> 1.3)
+
 ## 0.3.0
 
 * completely re-work to use JSON data bag files in test/integration for compatibility with the fallback mechanism in the chef-vault cookbook

data/README.md

@@ -71,6 +71,18 @@ The recipe that the example tests:
 The helper will call `ChefVault::Item.load`, which will be stubbed using
 the data bag from the test/integration/data_bags directory.
 
+## VAULT PROBING
+
+Some recipes and helpers attempt to determine if a data bag is a vault
+by checking the raw data bag item to see if one of the values contains
+encrypted data, then checking for the existence of the `_keys` data bag
+item to go along with the normal item.  The [sensu cookbook](https://github.com/sensu/sensu-chef/blob/35ee3aa6fa4ad578cdf751fe6822e3d2b3890d94/libraries/sensu_helpers.rb#L39-55) is a good example
+of this:
+
+The helper also stubs these methods, so that the probe mechanism should
+consider the data bag to be a vault and call ChefVault::Item.load, which
+is stubbed as described above.
+
 ## DEPENDENCIES
 
 It may seem strange that chef isn't a runtime dependency of this gem.

data/chef-vault-testfixtures.gemspec

@@ -1,14 +1,14 @@
 # -*- encoding: utf-8 -*-
-# stub: chef-vault-testfixtures 0.3.0.20150417141427 ruby lib
+# stub: chef-vault-testfixtures 0.4.0.20150424123749 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "chef-vault-testfixtures"
-  s.version = "0.3.0.20150417141427"
+  s.version = "0.4.0.20150424123749"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["James FitzGibbon"]
-  s.date = "2015-04-17"
+  s.date = "2015-04-24"
   s.description = "chef-vault-testfixtures provides an RSpec shared context that\nstubs access to chef-vault encrypted data bags using the same\nfallback mechanism as the `chef_vault_item` helper from the\n[chef-vault cookbook](https://supermarket.chef.io/cookbooks/chef-vault)"
   s.email = ["james.i.fitzgibbon@nordstrom.com"]
   s.extra_rdoc_files = ["History.md", "Manifest.txt", "README.md"]

data/lib/chef-vault/test_fixtures.rb

@@ -8,7 +8,7 @@ require 'chef-vault'
 class ChefVault
   # dynamic RSpec contexts for cookbooks that use chef-vault
   class TestFixtures
-    VERSION = '0.3.0'
+    VERSION = '0.4.0'
 
     # dynamically creates a memoized RSpec shared context
     # that when included into an example group will stub
@@ -44,21 +44,50 @@ class ChefVault
 
             def stub_vault_item(vault, item, json)
               content = JSON.parse(json)
+              db = make_fakedatabag(vault, item)
+              dbi = make_fakedatabagitem(vault, item)
               vi = make_fakevault(vault, item)
+
               # stub lookup of each of the vault item keys
               content.each do |k, v|
                 next if 'id' == k
+                dbi[k] = { 'encrypted_data' => '...' }
                 allow(vi).to receive(:[]).with(k).and_return(v)
               end
-              # stub chef-vault to return the fake vault item, via
-              # both symbol and string forms of the data bag name
+
+              # stub ChefVault and Chef::DataBag to return the doubles
+              # via both symbol and string forms of the data bag name
               [vault, vault.to_sym].each do |dbname|
                 allow(ChefVault::Item).to(
                   receive(:load)
                   .with(dbname, item)
                   .and_return(vi)
                 )
+                allow(Chef::DataBagItem).to(
+                  receive(:load)
+                  .with(dbname, item)
+                  .and_return(dbi)
+                )
+                allow(Chef::DataBag).to(
+                  receive(:load)
+                  .with(dbname)
+                  .and_return(db)
+                )
+              end
+            end
+
+            def make_fakedatabagitem(_, _)
+              {}
+            end
+
+            def make_fakedatabag(vault, item)
+              db = double "databag #{vault}"
+              %w(key? has_key?).each do |pred|
+                allow(db).to(receive(pred.to_sym)
+                             .with("#{item}_keys")
+                             .and_return(true))
               end
+              db
             end
 
             def make_fakevault(vault, item)

data/spec/lib/chef-vault/test_fixtures_spec.rb

@@ -36,7 +36,7 @@ RSpec.describe ChefVault::TestFixtures do
     end
   end
 
-  describe 'Stub a Vault' do
+  describe 'stub ChefVault::Item.load' do
     it 'should stub the foo/bar vault item' do
       baz = ChefVault::Item.load('foo', 'bar')['baz']
       expect(baz).to eq(2)
@@ -79,4 +79,21 @@ RSpec.describe ChefVault::TestFixtures do
       item.save
     end
   end
+
+  describe 'stub Chef::DataBagItem.load' do
+    it 'should present the foo/bar data bag item as encrypted' do
+      dbi = Chef::DataBagItem.load('foo', 'bar')
+      encrypted = dbi.detect do |_, v|\
+        v.is_a?(Hash) && v.key?('encrypted_data')
+      end
+      expect(encrypted).to be_truthy
+    end
+  end
+
+  describe 'stub Chef::DataBag.load' do
+    it 'should fake the foo/bar_keys data bag item' do
+      db = Chef::DataBag.load('foo')
+      expect(db.key?('bar_keys')).to be_truthy
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chef-vault-testfixtures
 version: !ruby/object:Gem::Version
-  version: 0.3.0.20150417141427
+  version: 0.4.0.20150424123749
 platform: ruby
 authors:
 - James FitzGibbon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-17 00:00:00.000000000 Z
+date: 2015-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec