test-kitchen-pc 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c9ff538b8800da1e38047406e03e606dc577c2d6
+  data.tar.gz: a5bd147e05844d207393cabb7d33c8f670483711
+SHA512:
+  metadata.gz: 7e4c198879ae3f8c261699ad157320e6271aaee7c96f0baf51f6ad681517763fa9c114509093e2dd77b3e5250694cba84ff3e7b9c1b816b89dad989cff585fa3
+  data.tar.gz: 82341434cf0d5cfd0afc1aef317ac13adab44e71a8da504706448c5df4968701ceb0e46743f8cd4e05a9d1216ad96804e7b66c5cfa73109b133f2a377bf0835e

data/.gitignore

@@ -0,0 +1,57 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Lockfiles
+Berksfile.lock
+Gemfile.lock
+
+# Kitchen testing files
+.kitchen/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.kitchen.ci.yml

@@ -0,0 +1,11 @@
+---
+parent: ./.kitchen.parent.yml
+
+# Configure to run on the CI machine (e.g. - Travis CI)
+driver:
+  name: proxy
+  host: localhost
+  reset_command: "exit 0"
+  port: <%= ENV["machine_port"] %>
+  username: <%= ENV["machine_user"] %>
+  password: <%= ENV["machine_pass"] %>

data/.kitchen.parent.yml

@@ -0,0 +1,17 @@
+---
+driver:
+  name: SHOULD_BE_OVERRIDDEN
+
+provisioner:
+  name: chef_zero
+
+platforms:
+  - name: ubuntu-14.04
+
+verifier:
+  name: inspec
+
+suites:
+  - name: default
+    run_list:
+      - recipe[test_cookbook::default]

data/.kitchen.yml

@@ -0,0 +1,6 @@
+---
+parent: ./.kitchen.parent.yml
+
+# Configure to run on the CI machine (e.g. - Travis CI)
+driver:
+  name: docker

data/.pryrc

@@ -0,0 +1,27 @@
+# vim: set ft=ruby:
+
+require 'rb-fsevent'
+
+# Create a reload function that reloads all files in lib
+def reload!
+  Object.send(:remove_const, :Kitchenw)
+  path = File.expand_path("../", __FILE__)
+  Dir.glob("#{path}/**/*.rb") { |f| load f }
+end
+
+# Watch for changes and fire off the reload function
+def watcher
+  fsevent = FSEvent.new
+  fsevent.watch Dir.pwd do |directories|
+    reload!
+  end
+  fsevent.run
+end
+
+# Load the current directory into the Ruby lib search path,
+# then pull in our module
+$LOAD_PATH.unshift("#{File.dirname(__FILE__)}/lib")
+#require("kitchenw.rb")
+
+# Kick off the monitoring thread
+Thread.start { watcher }

data/.travis.yml

@@ -0,0 +1,38 @@
+language: ruby
+
+rvm:
+  - 2.3.4
+
+env:
+  - global:
+    - machine_user=travis
+    - machine_pass=travis
+    - machine_port=22
+
+dist: precise
+sudo: required
+
+before_install:
+  - sudo usermod -p `openssl passwd -1 'travis'` travis
+  - gem --version
+
+bundler_args: --without guard integration
+
+script:
+  - bundle install --with integration
+  - export KITCHEN_YAML=.kitchen.ci.yml
+  - bundle exec kitchen-pc verify ubuntu
+
+branches:
+  only:
+  - master
+  - /v\d+\.\d+[a-z]/
+
+deploy:
+  provider: rubygems
+  api_key:
+    secure: B50sWvo60Ok+dfOcg7RGdeD2Eg7qLRU7XiVr050WIAWdOVY5UTjaRfKAEpC6UYq9d88Ab4dE+7EwgoObwEpcfMw4Aukcu0vlsz6fvyVO7lRtIfnZ9h5hYY5b1Q1kV6IUkcr5dwYZmrZiX2lLg2FW7S/y5DkELFiZA5RA/wKworB/eGvXfR4R7LhRZQpUywJ5hAFO8TLmK/CJehhtmuwqqFvKErU2Uwmu8DcAjhLvaTbmbVpVWxWVRraf0Y3ecBqvck81irgZKD63HmT2bRtQJmA7wvxhl1KCE2pxSnxuyLRoAOklfeTOYnLGblAEYPas8DefLE2V34DRy3tg+iWXsHaFwylnRMjYD6oDaK8TWJfmkdkIyC5T0yi/+PRibbCm012eYYK1nEjOOKV3kQ48gmfJgeKRZHSel11Oosm4ws/4jxODrj4NM1AWKo7eT/gmtUUQ0gGZlSRrGCZQvzvlrJLBOSobuIhGeam5OWey7pCDeEmJRixplsat1t3KketDwnxaGu2oqkneaUxfZFivllAGxgih3Ct887vv9eH755FnJmQArDQorMrIEXKn3fg0AUoiCxJar9zJtmuwDkd03YHZaSdib8sDQutLTiMlcoRh08/QBKfuhdkqj/RToE7z8GINYrW3HrZUarBFSRB/6xRVDNa29lBaLEfEBjblKoc=
+  gem: test-kitchen-pc
+  on:
+    tags: true
+    repo: rusnyder/test-kitchen-pc

data/Berksfile

@@ -0,0 +1,3 @@
+source "https://supermarket.chef.io"
+
+cookbook "test_cookbook", path: "./test/cookbooks/test_cookbook"

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+gemspec
+
+group :integration do
+  gem "berkshelf"
+  gem "kitchen-inspec"
+  gem "kitchen-docker"
+end

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Russell Snyder
+
+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,148 @@
+# Test Kitchen Parent Child
+
+[![Gem Version](https://badge.fury.io/rb/test-kitchen-pc.svg)](http://badge.fury.io/rb/test-kitchen-pc)
+[![Build Status](https://travis-ci.org/rusnyder/test-kitchen-pc.svg?branch=master)](https://travis-ci.org/rusnyder/test-kitchen-pc)
+
+Test Kitchen Parent-Child is a thin wrapper around Test Kitchen that adds
+support for inheritance in the .kitchen.yml configuration files for multi-role
+projects.
+
+## What is this for?
+
+While Test Kitchen is a phenomenal tool for testing a suite of infrastructure
+code, it doesn't lend itself quite as well to testing many related suites that
+are contained in the same project.
+
+I'm coming at this from the Ansible world where I've got a single project that
+houses all of my "roles" (machine profiles), and Test Kitchen is great for
+testing each individual role.  The main pain point comes when these roles all
+use the same set of test configurations, and it would be great to share configs
+instead of duplicating them across dozens of roles.
+
+Here's a sample directory structure of the type of project that this extension
+was written to help test:
+
+```
+ansible-project/
+├── roles/
+│   ├── ssh-role/
+│   |   ├── .kitchen.yml
+│   |   └── ...
+│   ├── java-service-role/
+│   |   ├── .kitchen.yml
+│   |   └── ...
+│   └── nginx-webserver-role/
+│       ├── .kitchen.yml
+│       └── ...
+└── site.yml
+```
+
+This project aims at reducing the duplication between the `.kitchen.yml` files
+and improving the maintainability of more complex infrastructure projects.
+
+## Getting Started
+
+Being only a simple extension to Test Kitchen, you should start with the
+guides there.  See the [Test Kitchen README][kitchen-readme] to get started
+and to get your tests running without this extension.
+
+[kitchen-readme]: https://github.com/test-kitchen/test-kitchen
+
+## Usage
+
+This can be run in all the same ways as Test Kitchen, just using the command
+`kitchen-pc` instead of `kitchen`.
+
+If you're using RubyGem to manage your gems:
+
+```bash
+# Install the gem by name
+gem install test-kitchen-pc
+
+# Run kitchen-pc the same way you run kitchen
+kitchen-pc converge default-centos-6
+```
+
+Optionally, you can use [Bundler](http://bundler.io/) to manage the gem by
+adding `gem "test-kitchen-pc"` to your `Gemfile`, then:
+
+```bash
+# Install the deps from the Gemspec
+bundle install
+
+# Run kitchen-pc the same way you run kitchen
+bundle exec kitchen-pc converge default-centos-6
+```
+
+## Configuration
+
+To support inheritance, this extensions adds support for the top-level
+`parent` paremeter in any of the `.kitchen.yml` files that Test Kitchen
+is configured to read normally.
+
+Let's say you have a project `.kitchen.yml` that defines a set of pretty
+generic settings for testing:
+
+**`.kitchen.parent.yml`**
+
+```yaml
+---
+driver:
+  name: docker
+
+provisioner:
+  name: ansible_playbook
+  ansible_inventory: test/integration/inventory/hosts
+  roles_path: ../
+
+platforms:
+  - name: centos-6
+  - name: centos-7
+
+suites:
+  - name: default
+```
+
+The majority of this configuration will be the same across all of the
+infrastructure modules that you're testing.  Using this extension, you
+can export all common configuration to a shared file, and then source
+the shared configuration using the `parent` parameter, then inline any
+customizations you may need to make.
+
+For example, say we wanted to export the above as common configuration,
+but then have a role that needs to define some host aliases in the
+Docker driver:
+
+**`roles/sample-role/.kitchen.yml`**
+
+```yaml
+---
+parent: ../../.kitchen.parent.yml
+
+driver:
+  name: docker
+  run_options:
+    add-host:
+      - "sample-host:127.0.0.1"
+```
+
+This will result in the `roles/sample-role/.kitchen.yml` config being merged
+into the `.kitchen.parent.yml` file, with the former overriding and properties
+that are specified in both.
+
+
+## Development
+
+If you'd like to contribute, feel free to open a PR.  To run the tests prior
+to submitting the PR, just clone the project and run the integration tests:
+
+```
+# Install deps
+bundle install
+
+# Run integration tests
+bundle exec kitchen-pc test
+```
+
+
+

data/bin/kitchen-pc

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+# -*- encoding: utf-8 -*-
+
+# Trap interrupts to quit cleanly. See
+# https://twitter.com/mitchellh/status/283014103189053442
+Signal.trap("INT") { exit 1 }
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), %w{.. lib})
+require "rubygems"
+require "kitchen/pc/cli"
+require "kitchen/errors"
+
+Kitchen.with_friendly_errors { Kitchen::PC::CLI.start }

data/lib/kitchen/pc/cli.rb

@@ -0,0 +1,90 @@
+require "kitchen"
+require "kitchen/cli"
+require "kitchen/config"
+require "kitchen/loader/yaml"
+require "tempfile"
+require "yaml"
+
+module Kitchen
+  module PC
+    class CLI < Kitchen::CLI
+      # Intercept the CLI call and merge project and parent configs
+      # before firing off the proper CLI intialization
+      def initialize(*args)
+        # Read the configs as provided
+        loader = Kitchen::Loader::YAML.new(
+          project_config: ENV["KITCHEN_YAML"],
+          local_config: ENV["KITCHEN_LOCAL_YAML"],
+          global_config: ENV["KITCHEN_GLOBAL_YAML"]
+        )
+        # For any configs that have parents, merge in the parents
+        # and write out to a temporary file, then set the associated
+        # environment variable for Test Kitchen to use that file
+        tmp_files = []
+        configs = [
+          { :path_fn => :config_file, :yaml_fn => :yaml, :env_var => 'KITCHEN_YAML' },
+          { :path_fn => :local_config_file, :yaml_fn => :local_yaml, :env_var => 'KITCHEN_LOCAL_YAML' },
+          { :path_fn => :global_config_file, :yaml_fn => :global_yaml, :env_var => 'KITCHEN_GLOBAL_YAML' },
+        ].each do |params|
+          config_path = loader.send params[:path_fn]
+          config = loader.send params[:yaml_fn]
+          if config.key?('parent')
+            merged_file = self.class.merge_parent(config)
+            ENV[params[:env_var]] = merged_file
+            tmp_files.push(merged_file)
+          else
+            ENV[params[:env_var]] = config_path
+          end
+        end
+
+        # Cleanup the temp config files on exit
+        at_exit do
+          begin
+            File.unlink(*tmp_files)
+          rescue
+            # ignore cleanup errors
+          end
+        end
+
+        # Finally delegate to super
+        super
+      end
+
+      def self.merge_parent(config)
+        # If the config doesn't have a parent, except
+        if !config.key?('parent')
+          raise "Bad Programmer! merge_parent called on a config without a parent: #{config.to_s}"
+        end
+        # Create a temp file to write the merged config
+        file = Tempfile.new(['test-kitchen-config', '.yml'])
+        begin
+          parent = parse_config(File.expand_path(config['parent']))
+          merged = merge_configs(parent, config)
+          merged.delete('parent')
+          file.write merged.to_yaml
+        rescue
+          file.unlink # Only unlink here if an error occurred,
+                      #  otherwise we'll leave that up to the caller
+                      #  to unlink eonce finished processing the file
+          raise       # Re-raise the original exception
+        ensure
+          file.close
+        end
+        return file.path
+      end
+
+      def self.parse_config(config_path)
+        str = Kitchen::Loader::YAML.new.send(:yaml_string, config_path)
+        Kitchen::Loader::YAML.new.send(:parse_yaml_string, str, config_path)
+      end
+
+      def self.merge_configs(parent, child)
+        normalize(parent).rmerge(normalize(child))
+      end
+
+      def self.normalize(obj)
+        Kitchen::Loader::YAML.new.send(:normalize, obj)
+      end
+    end
+  end
+end

data/lib/kitchen/pc/version.rb

@@ -0,0 +1,7 @@
+# -*- encoding: utf-8 -*-
+
+module Kitchen
+  module PC
+    VERSION = "0.1.0".freeze
+  end
+end

data/test-kitchen-pc.gemspec

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "kitchen/pc/version"
+require "English"
+
+Gem::Specification.new do |gem|
+  gem.name          = 'test-kitchen-pc'
+  gem.version       = Kitchen::PC::VERSION
+  gem.license       = 'MIT'
+  gem.authors       = ['Russell Snyder']
+  gem.email         = ['ru.snyder@gmail.com']
+  gem.summary       = 'Test Kitchen Parent-Child adds config inheritance to '\
+                      'Test Kitchen .kitchen.yml files'
+  gem.description   = 'Test Kitchen Parent-Child is a thin wrapper around ' \
+                      'Test Kitchen that adds support for inheritance in the ' \
+                      '.kitchen.yml configuration files for multi-role projects.'
+  gem.homepage      = 'https://github.com/rusnyder/test-kitchen-pc'
+
+  gem.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  gem.executables   = %w{kitchen-pc}
+  #gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.required_ruby_version = ">= 2.3"
+
+  gem.add_dependency 'test-kitchen', '>= 1.0.0'
+
+  # General test/build gems
+  gem.add_development_dependency 'bundler'
+  gem.add_development_dependency 'rake'
+
+  # Integration testing gems
+  gem.add_development_dependency 'kitchen-inspec', '~> 0.14'
+end

data/test/cookbooks/test_cookbook/metadata.rb

@@ -0,0 +1,6 @@
+name "test_cookbook"
+maintainer "Maintainer"
+maintainer_email "Maintainer@example.com"
+license "MIT"
+description "Used for testing test-kitchen-pc"
+version "0.1.0"

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

@@ -0,0 +1 @@
+directory "/tk_test_directory"

data/test/integration/default/inspec/default_spec.rb

@@ -0,0 +1,3 @@
+describe directory("/tk_test_directory") do
+  it { should exist }
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: test-kitchen-pc
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Russell Snyder
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: test-kitchen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  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: kitchen-inspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+description: Test Kitchen Parent-Child is a thin wrapper around Test Kitchen that
+  adds support for inheritance in the .kitchen.yml configuration files for multi-role
+  projects.
+email:
+- ru.snyder@gmail.com
+executables:
+- kitchen-pc
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".kitchen.ci.yml"
+- ".kitchen.parent.yml"
+- ".kitchen.yml"
+- ".pryrc"
+- ".travis.yml"
+- Berksfile
+- Gemfile
+- LICENSE
+- README.md
+- bin/kitchen-pc
+- lib/kitchen/pc/cli.rb
+- lib/kitchen/pc/version.rb
+- test-kitchen-pc.gemspec
+- test/cookbooks/test_cookbook/metadata.rb
+- test/cookbooks/test_cookbook/recipes/default.rb
+- test/integration/default/inspec/default_spec.rb
+homepage: https://github.com/rusnyder/test-kitchen-pc
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Test Kitchen Parent-Child adds config inheritance to Test Kitchen .kitchen.yml
+  files
+test_files: []