kitchen-chef-extended-attributes 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 044844b384d0ef8f6ef26d3dede410b5c372cf61
+  data.tar.gz: 1edbfdb07ab360e3e8c1817481d16acd31453939
+SHA512:
+  metadata.gz: 4c643d69486c6f0d428070b534cdf55a73e50e0ae200129504d82052d221edc09e47a978812b22885c5aac8ebddf107e07d867d53491d5be2bbb607ed8003642
+  data.tar.gz: 6c3bedb4628a8bfb1f810865c2406e060b48b027edea02c528f9cae3eee66fa63f037b252394e9cdd060dd7cfcee13a4c060b9b613c17e2de4d89c07311b30e9

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# kitchen-chef-extended-attributes
+
+## v0.1.0 (unreleased)
+
+Initial release of extension - provides overwrite and merge of JSON files

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Jeremy Olliver
+
+MIT LICENSE
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,54 @@
+# kitchen-chef-extended-attributes
+
+[![Circle CI](https://circleci.com/gh/jeremyolliver/kitchen-chef-extended-attributes.svg?style=shield)](https://circleci.com/gh/jeremyolliver/kitchen-chef-extended-attributes)
+[![Code Climate](https://codeclimate.com/github/jeremyolliver/kitchen-chef-extended-attributes/badges/gpa.svg)](https://codeclimate.com/github/jeremyolliver/kitchen-chef-extended-attributes)
+
+## Use Case
+
+If you use chef-solo for your main workflow, then you will have dna.json files defining the attributes and run_list etc for each of your roles. This test-kitchen extension allows you to use test-kitchen as your main entry point for a chef repo level test-kitchen setup - loading the pre-existing dna.json for your nodes so that your .kitchen.yml doesn't drift from the actual setup. Additionally adding extra run list items or attributes within the .kitchen.yml file will override the json file for example adding test handler cookbooks or vagrant user sudo permissions.
+
+## Example
+
+Given a chef repository layout similar to
+
+    chef_repo
+    |-- .kitchen.yml
+    |-- Berksfile
+    |-- Berksfile.lock
+    |-- roles
+    |   |-- app.rb
+    |   `-- db.rb
+    `-- nodes
+        |-- app.json
+        `-- db.json
+
+Use the provisioner `chef_extended_attributes` in your .kitchen.yml and ensure `nodes_path` is set appropriately
+
+    # .kitchen.yml
+    ---
+    driver:
+      name: vagrant
+
+    provisioner:
+      name: chef_extended_attributes
+      merge_attributes: true # the default
+      role_path: 'roles'
+      nodes_path: 'nodes'
+
+    platforms:
+      - name: ubuntu-14.04
+        attributes:
+          authorization:
+            sudo:
+              users: ['vagrant']
+
+    # Suites will have node data loaded from nodes_path (nodes/<SUITENAME>.json)
+    suites:
+      - name: app
+        run_list:
+          - "recipe[minitest-handler]" # this is merged with the run_list definition in nodes
+        attributes:
+          mysql:
+            password: test-password
+
+This will result in `kitchen converge app-ubuntu-1404` running in chef-solo mode with a dna.json generated that uses the json file with the same name as the suite (e.g. nodes/app.json) your defined nodes/*.json files (where the suite name - e.g. `app`, and merges the overriden attributes given in the test kitchen definition.

data/lib/kitchen-chef-extended-attributes.rb

@@ -0,0 +1 @@
+require 'kitchen/provisioner/chef_extended_attributes'

data/lib/kitchen/provisioner/chef_extended_attributes.rb

@@ -0,0 +1,73 @@
+require 'kitchen/provisioner/chef_solo'
+require 'json'
+
+module Kitchen
+  module Provisioner
+
+    # Define a new test-kitchen provisioner, based on the chef-solo provisioner
+    # with an additional load step to insert our pre-defined / generated
+    # dna.json file before the chef run begins
+    class ChefExtendedAttributes < Kitchen::Provisioner::ChefSolo
+
+      default_config :merge_attributes, true
+
+      # At the time of this hook being run, `sandbox_path` has been created,
+      # populated, but not yet copied across to the destination environment
+      def create_sandbox
+        super
+        debug('hooking create_sandbox')
+        backup_original_dna_json
+        if config[:merge_attributes]
+          prepare_merged_json
+        else
+          prepare_overridden_json
+        end
+        debug('finished hooks')
+      end
+
+      private
+
+      def prepare_merged_json
+        info("merging #{instance.suite.name}.json and kitchen attributes")
+
+        custom_json = JSON.parse(File.read(source_file))
+        merged_json = custom_json.merge(config[:attributes])
+        merged_json['run_list'] ||= []
+        merged_json['run_list'] += (config[:run_list] || [])
+
+        File.open(destination_file, "wb") do |file|
+          file.write(merged_json.to_json)
+        end
+        debug('merged dna.json written')
+      end
+
+      def prepare_overridden_json
+        info("copying #{instance.suite.name}.json to dna.json")
+
+        `cp -f #{source_file} #{destination_file}`
+      end
+
+      def backup_original_dna_json
+        `cp #{sandbox_path}/dna.json #{sandbox_path}/original-dna.json`
+      end
+
+      def source_file
+        "#{config[:nodes_path]}/#{instance.suite.name}.json"
+      end
+
+      def destination_file
+        File.join(sandbox_path, 'dna.json')
+      end
+
+      def info(msg)
+        super("chef_solo_with_attributes: #{msg}")
+      end
+
+      def debug(msg)
+        super("chef_solo_with_attributes: #{msg}")
+      end
+
+    end
+
+  end
+end

data/test/cookbooks/extended_attributes_test/files/default/test/default_test.rb

@@ -0,0 +1,11 @@
+require 'minitest/spec'
+
+describe_recipe 'extended_attributes_test::default' do
+  it 'should include attributes from the dna' do
+    file('/tmp/kitchen/dna.json').must_match 'valuefromdna'
+  end
+
+  it 'should include attributes from kitchen.yml' do
+    file('/tmp/kitchen/dna.json').must_match 'valuefromkitchen'
+  end
+end

data/test/cookbooks/extended_attributes_test/files/default/test/kitchenmerged_test.rb

@@ -0,0 +1,13 @@
+require 'minitest/spec'
+
+describe_recipe 'extended_attributes_test::kitchenmerged' do
+  it 'should give higher precendence to attributes in kitchen.yml' do
+    merged_json_data = JSON.parse(File.read('/tmp/kitchen/dna.json'))
+    merged_json_data['valuefromdna'].must_equal 'overridden'
+  end
+
+  it 'should include run_list items from dna JSON file' do
+    node.run_list.must_include('recipe[git]')
+    package('git').must_be_installed
+  end
+end

data/test/cookbooks/extended_attributes_test/files/default/test/kitchenoverride_test.rb

@@ -0,0 +1,11 @@
+require 'minitest/spec'
+
+describe_recipe 'extended_attributes_test::kitchenoverride' do
+  it 'should not contain attributes from kitchen.yml' do
+    file('/tmp/kitchen/dna.json').must_not_match 'shouldnevershowup'
+  end
+
+  it 'should include attributes from dna JSON file' do
+    file('/tmp/kitchen/dna.json').must_match 'valuefromdna'
+  end
+end

data/test/cookbooks/extended_attributes_test/metadata.rb

@@ -0,0 +1,5 @@
+name 'extended_attributes_test'
+version '0.1.0'
+
+depends 'git' # A dummy cookbook to include
+depends 'minitest-handler'

data/test/cookbooks/extended_attributes_test/recipes/default.rb

@@ -0,0 +1 @@
+include_recipe 'minitest-handler'

data/test/cookbooks/extended_attributes_test/recipes/kitchenmerged.rb

@@ -0,0 +1 @@
+include_recipe 'minitest-handler'

data/test/cookbooks/extended_attributes_test/recipes/kitchenoverride.rb

@@ -0,0 +1 @@
+include_recipe 'minitest-handler'

data/test/nodes/default.json

@@ -0,0 +1,3 @@
+{
+  "valuefromdna": "default"
+}

data/test/nodes/kitchenmerged.json

@@ -0,0 +1,6 @@
+{
+  "valuefromdna": "default",
+  "run_list": [
+    "recipe[git]"
+  ]
+}

data/test/nodes/kitchenoverride.json

@@ -0,0 +1,3 @@
+{
+  "valuefromdna": "default"
+}

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: kitchen-chef-extended-attributes
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jeremy Olliver
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: test-kitchen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: kitchen-docker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: berkshelf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |-
+  Plugin for test-kitchen that extends the chef_solo provisioner with
+                       chef_extended_attributes to use pre-existing dna.json files, and
+                       optionally, to merge those with attributes in .kitchen.yml
+email:
+- jeremy.olliver@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/kitchen/provisioner/chef_extended_attributes.rb
+- lib/kitchen-chef-extended-attributes.rb
+- LICENSE.txt
+- README.md
+- CHANGELOG.md
+- test/cookbooks/extended_attributes_test/files/default/test/default_test.rb
+- test/cookbooks/extended_attributes_test/files/default/test/kitchenmerged_test.rb
+- test/cookbooks/extended_attributes_test/files/default/test/kitchenoverride_test.rb
+- test/cookbooks/extended_attributes_test/metadata.rb
+- test/cookbooks/extended_attributes_test/recipes/default.rb
+- test/cookbooks/extended_attributes_test/recipes/kitchenmerged.rb
+- test/cookbooks/extended_attributes_test/recipes/kitchenoverride.rb
+- test/nodes/default.json
+- test/nodes/kitchenmerged.json
+- test/nodes/kitchenoverride.json
+homepage: https://github.com/jeremyolliver/kitchen-chef-extended-attributes
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: test-kitchen chef-solo integrated with dna.json files from your repo
+test_files:
+- test/cookbooks/extended_attributes_test/files/default/test/default_test.rb
+- test/cookbooks/extended_attributes_test/files/default/test/kitchenmerged_test.rb
+- test/cookbooks/extended_attributes_test/files/default/test/kitchenoverride_test.rb
+- test/cookbooks/extended_attributes_test/metadata.rb
+- test/cookbooks/extended_attributes_test/recipes/default.rb
+- test/cookbooks/extended_attributes_test/recipes/kitchenmerged.rb
+- test/cookbooks/extended_attributes_test/recipes/kitchenoverride.rb
+- test/nodes/default.json
+- test/nodes/kitchenmerged.json
+- test/nodes/kitchenoverride.json