poise-boiler 1.0.0

data/lib/poise_boiler/kitchen.rb

@@ -0,0 +1,96 @@
+#
+# Copyright 2015, Noah Kantrowitz
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'kitchen'
+require 'kitchen-sync'
+
+
+module PoiseBoiler
+  # Helpers for Test-Kitchen and .kitchen.yml configuration.
+  #
+  # @since 1.0.0
+  module Kitchen
+    extend self
+    # Shorthand names for kitchen platforms.
+    #
+    # @see PoiseBoiler::Kitchen.kitchen
+    PLATFORM_ALIASES = {
+      'ubuntu' => %w{ubuntu-12.04 ubuntu-14.04},
+      'rhel' => %w{centos-6 centos-7},
+      'centos' => %w{rhel},
+      'linux' => %w{ubuntu rhel},
+    }
+
+    # Return a YAML string suitable for inclusion in a .kitchen.yml config. This
+    # will include the standard Poise/Halite boilerplate and some default values.
+    #
+    # @param platforms [String, Array<String>] Name(s) of platforms to use by default.
+    # @see PoiseBoiler::Kitchen::PLATFORM_ALIASES
+    # @example .kitchen.yml
+    #   #<% require 'poise_boiler' %>
+    #   <%= PoiseBoiler.kitchen %>
+    def kitchen(platforms: 'ubuntu-14.04')
+      # SPEC_BLOCK_CI is used to force non-locking behavior inside tests.
+      chef_version = ENV['CHEF_VERSION'] || if ENV['SPEC_BLOCK_CI'] != 'true'
+        # If there isn't a specific override, lock TK to use the same version of Chef as the Gemfile.
+        require 'chef/version'
+        Chef::VERSION
+      end
+      {
+        'chef_versions' => %w{12},
+        'driver' => {
+          'name' => (ENV['TRAVIS'] == 'true' ? 'dummy' : 'vagrant'),
+          'require_chef_omnibus' => chef_version || true,
+          'provision_command' => [
+            # Run some installs at provision so they are cached in the image.
+            # Install Chef (with the correct verison).
+            "curl -L https://chef.io/chef/install.sh | bash -s --" + (chef_version ? " -v #{chef_version}" : '' ),
+            # Install some kitchen-related gems. Normally installed during the verify step but that is idempotent.
+            "env GEM_HOME=/tmp/verifier/gems GEM_PATH=/tmp/verifier/gems GEM_CACHE=/tmp/verifier/gems/cache /opt/chef/embedded/bin/gem install thor busser busser-serverspec serverspec bundler",
+            # Fix directory permissions.
+            "chown -R kitchen /tmp/verifier",
+          ],
+        },
+        'platforms' => expand_kitchen_platforms(platforms).map {|p| {'name' => p, 'run_list' => platform_run_list(p)} },
+      }.to_yaml.gsub(/---[ \n]/, '')
+    end
+
+    private
+
+    # Expand aliases from PLATFORM_ALIASES.
+    def expand_kitchen_platforms(platforms)
+      platforms = Array(platforms)
+      last_platforms = []
+      while platforms != last_platforms
+        last_platforms = platforms
+        platforms = platforms.map {|p| PLATFORM_ALIASES[p] || p}.flatten.uniq
+      end
+      platforms
+    end
+
+    # Return the platform-level run list for a given platform.
+    #
+    # @param platform [String] Platform name.
+    # @return [Array<String>]
+    def platform_run_list(platform)
+      if platform.start_with?('debian') || platform.start_with?('ubuntu')
+        %w{apt}
+      else
+        []
+      end
+    end
+  end
+end

data/lib/poise_boiler/rake.rb

@@ -0,0 +1,18 @@
+#
+# Copyright 2015, Noah Kantrowitz
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'poise_boiler/helpers/rake'
+::PoiseBoiler::Helpers::Rake.install

data/lib/poise_boiler/rakefile.rb

@@ -0,0 +1,18 @@
+#
+# Copyright 2015, Noah Kantrowitz
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+# This is just an alias for rake.rb
+require 'poise_boiler/rake'

data/lib/poise_boiler/spec_helper.rb

@@ -0,0 +1,18 @@
+#
+# Copyright 2015, Noah Kantrowitz
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'poise_boiler/helpers/spec_helper'
+::PoiseBoiler::Helpers::SpecHelper.install

data/lib/poise_boiler/version.rb

@@ -0,0 +1,20 @@
+#
+# Copyright 2015, Noah Kantrowitz
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+
+module PoiseBoiler
+  VERSION = '1.0.0'
+end

data/poise-boiler.gemspec

@@ -0,0 +1,69 @@
+#
+# Copyright 2015, Noah Kantrowitz
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'poise_boiler/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'poise-boiler'
+  spec.version = PoiseBoiler::VERSION
+  spec.authors = ['Noah Kantrowitz']
+  spec.email = %w{noah@coderanger.net}
+  spec.description = 'Boilerplate-reduction helpers for Poise/Halite-style gemss.'
+  spec.summary = spec.description
+  spec.homepage = 'https://github.com/poise/poise-boiler'
+  spec.license = 'Apache 2.0'
+  spec.metadata['halite_ignore'] = 'true'
+
+  spec.files = `git ls-files`.split($/)
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = %w{lib}
+
+  # Development gems
+  spec.add_dependency 'addressable', '~> 2.3'
+  spec.add_dependency 'rake', '~> 10.4'
+  spec.add_dependency 'travis', '~> 1.7'
+  spec.add_dependency 'yard', '~> 0.8'
+  spec.add_dependency 'yard-classmethods', '~> 1.0'
+  spec.add_dependency 'halite', '~> 1.0' # This is a circular dependency
+  spec.add_dependency 'mixlib-shellout', '>= 1.4', '< 3.0' # Chef 11 means shellout 1.4 :-(
+  spec.add_dependency 'pry' # Travis depends on old-ass pry, see https://github.com/travis-ci/travis.rb/issues/245
+
+  # Test gems
+  spec.add_dependency 'rspec', '~> 3.2'
+  spec.add_dependency 'rspec-its', '~> 1.2'
+  spec.add_dependency 'chefspec', '~> 4.2'
+  spec.add_dependency 'fuubar', '~> 2.0'
+  spec.add_dependency 'simplecov', '~> 0.9'
+  spec.add_dependency 'foodcritic', '~> 4.0'
+
+  # Integration gems
+  spec.add_dependency 'test-kitchen', '~> 1.3'
+  spec.add_dependency 'kitchen-vagrant'
+  spec.add_dependency 'vagrant-wrapper'
+  spec.add_dependency 'kitchen-docker'
+  spec.add_dependency 'kitchen-sync'
+  spec.add_dependency 'berkshelf', '~> 3.2'
+
+  # Travis gems
+  spec.add_dependency 'codeclimate-test-reporter', '~> 0.4'
+  spec.add_dependency 'codecov', '~> 0.0', '>= 0.0.2'
+
+  # Development dependencies (yo dawg)
+  spec.add_development_dependency 'rspec-command', '~> 1.0'
+end

data/spec/helpers/badge_spec.rb

@@ -0,0 +1,100 @@
+#
+# Copyright 2015, Noah Kantrowitz
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'spec_helper'
+
+describe PoiseBoiler::Helpers::Rake::Badges do
+  describe '#detect_github' do
+    let(:instance) { described_class.new(gem_name: '', base: '') }
+    subject { instance.send(:detect_github) }
+
+    context 'with normal data' do
+      before do
+        expect(instance).to receive(:git_shell_out).with(%w{name-rev --name-only HEAD}).and_return('master')
+        expect(instance).to receive(:git_shell_out).with(%w{config --get branch.master.remote}).and_return('origin')
+        expect(instance).to receive(:git_shell_out).with(%w{ls-remote --get-url origin}).and_return('git@github.com:poise/example.git')
+      end
+      it { is_expected.to eq 'poise/example' }
+    end # /context with normal data
+
+    context 'with no default remote' do
+      before do
+        expect(instance).to receive(:git_shell_out).with(%w{name-rev --name-only HEAD}).and_return('master')
+        expect(instance).to receive(:git_shell_out).with(%w{config --get branch.master.remote}).and_return('')
+        expect(instance).to receive(:git_shell_out).with(%w{ls-remote --get-url origin}).and_return('git@github.com:poise/example.git')
+      end
+      it { is_expected.to eq 'poise/example' }
+    end # /context with no default remote
+
+    context 'with an HTTP remote' do
+      before do
+        expect(instance).to receive(:git_shell_out).with(%w{name-rev --name-only HEAD}).and_return('master')
+        expect(instance).to receive(:git_shell_out).with(%w{config --get branch.master.remote}).and_return('')
+        expect(instance).to receive(:git_shell_out).with(%w{ls-remote --get-url origin}).and_return('https://github.com/poise/example.git')
+      end
+      it { is_expected.to eq 'poise/example' }
+    end # /context with an HTTP remote
+  end # /describe #detect_github
+
+  describe 'integration' do
+    rakefile "require 'poise_boiler/rakefile'"
+    rake_task 'badges'
+    before do
+      command(%w{git init})
+      command(%w{git remote add origin git@github.com:poise/example.git})
+    end
+
+    context 'non-cookbook' do
+      file 'example.gemspec', <<-EOH
+Gem::Specification.new do |s|
+  s.name = 'example'
+  s.version = '1.0.0'
+end
+EOH
+      its(:stdout) { is_expected.to eq <<-EOH }
+[![Build Status](https://img.shields.io/travis/poise/example.svg)](https://travis-ci.org/poise/example)
+[![Gem Version](https://img.shields.io/gem/v/example.svg)](https://rubygems.org/gems/example)
+[![Code Climate](https://img.shields.io/codeclimate/github/poise/example.svg)](https://codeclimate.com/github/poise/example)
+[![Coverage](https://img.shields.io/codecov/c/github/poise/example.svg)](https://codecov.io/github/poise/example)
+[![Gemnasium](https://img.shields.io/gemnasium/poise/example.svg)](https://gemnasium.com/poise/example)
+[![License](https://img.shields.io/badge/license-Apache_2-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
+EOH
+      its(:stderr) { is_expected.to eq '' }
+      its(:exitstatus) { is_expected.to eq 0 }
+    end # /context non-cookbook
+
+    context 'cookbook' do
+      file 'example.gemspec', <<-EOH
+Gem::Specification.new do |s|
+  s.name = 'example'
+  s.version = '1.0.0'
+  s.add_dependency 'halite'
+end
+EOH
+      its(:stdout) { is_expected.to eq <<-EOH }
+[![Build Status](https://img.shields.io/travis/poise/example.svg)](https://travis-ci.org/poise/example)
+[![Gem Version](https://img.shields.io/gem/v/example.svg)](https://rubygems.org/gems/example)
+[![Cookbook Version](https://img.shields.io/cookbook/v/example.svg)](https://supermarket.chef.io/cookbooks/example)
+[![Code Climate](https://img.shields.io/codeclimate/github/poise/example.svg)](https://codeclimate.com/github/poise/example)
+[![Coverage](https://img.shields.io/codecov/c/github/poise/example.svg)](https://codecov.io/github/poise/example)
+[![Gemnasium](https://img.shields.io/gemnasium/poise/example.svg)](https://gemnasium.com/poise/example)
+[![License](https://img.shields.io/badge/license-Apache_2-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
+EOH
+      its(:stderr) { is_expected.to eq '' }
+      its(:exitstatus) { is_expected.to eq 0 }
+    end # /context cookbook
+  end # /describe integration
+end

data/spec/helpers/travis_spec.rb

@@ -0,0 +1,50 @@
+#
+# Copyright 2015, Noah Kantrowitz
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'spec_helper'
+
+describe PoiseBoiler::Helpers::Rake::Travis do
+  rakefile "require 'poise_boiler/rakefile'"
+  rake_task 'travis'
+  file 'example.gemspec', <<-EOH
+Gem::Specification.new do |s|
+  s.name = 'example'
+  s.version = '1.0.0'
+end
+EOH
+  file '.kitchen.yml', <<-EOH
+suites: []
+EOH
+  file 'README.md'
+
+  context 'no secure vars' do
+    environment TRAVIS_SECURE_ENV_VARS: nil
+
+    its(:stdout) { is_expected.to include 'Running task spec' }
+    its(:stdout) { is_expected.to include 'Running task chef:foodcritic' }
+    its(:stdout) { is_expected.to_not include 'Running task travis:integration' }
+    its(:exitstatus) { is_expected.to eq 0 }
+  end # /context no secure vars
+
+  context 'secure vars' do
+    environment TRAVIS_SECURE_ENV_VARS: '1'
+
+    its(:stdout) { is_expected.to include 'Running task spec' }
+    its(:stdout) { is_expected.to include 'Running task chef:foodcritic' }
+    its(:stdout) { is_expected.to include 'Running task travis:integration' }
+    its(:exitstatus) { is_expected.to eq 0 }
+  end # /context secure vars
+end

data/spec/kitchen_spec.rb

@@ -0,0 +1,92 @@
+#
+# Copyright 2015, Noah Kantrowitz
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'spec_helper'
+require 'chef/version'
+
+describe 'poise_boiler/kitchen' do
+    environment SPEC_BLOCK_CI: true
+    file '.kitchen.yml', <<-EOH
+---
+#<% require 'poise_boiler' %>
+<%= PoiseBoiler.kitchen %>
+
+suites:
+- name: default
+EOH
+
+  context 'with defaults' do
+    context 'kitchen list' do
+      command 'kitchen list'
+      its(:stdout) { is_expected.to match(/default-ubuntu-1404\s+(Vagrant|Dummy)\s+ChefSolo\s+(Busser\s+Ssh\s+)?<Not Created>/) }
+    end # /context kitchen list
+
+    context 'kitchen diagnose' do
+      command 'kitchen diagnose'
+      its(:stdout) { is_expected.to match(%r{- curl -L https://chef.io/chef/install.sh | bash -s --$}) }
+      its(:stdout) { is_expected.to include('/opt/chef/embedded/bin/gem install thor busser busser-serverspec serverspec') }
+      its(:stdout) { is_expected.to include('require_chef_omnibus: true') }
+    end # /context kitchen diagnose
+  end # /context with defaults
+
+  context 'with a platform alias' do
+    file '.kitchen.yml', <<-EOH
+---
+#<% require 'poise_boiler' %>
+<%= PoiseBoiler.kitchen(platforms: 'linux') %>
+
+suites:
+- name: default
+EOH
+    command 'kitchen list'
+    its(:stdout) { is_expected.to match(/default-ubuntu-1404\s+(Vagrant|Dummy)\s+ChefSolo\s+(Busser\s+Ssh\s+)?<Not Created>/) }
+    its(:stdout) { is_expected.to match(/default-ubuntu-1204\s+(Vagrant|Dummy)\s+ChefSolo\s+(Busser\s+Ssh\s+)?<Not Created>/) }
+    its(:stdout) { is_expected.to match(/default-centos-6\s+(Vagrant|Dummy)\s+ChefSolo\s+(Busser\s+Ssh\s+)?<Not Created>/) }
+    its(:stdout) { is_expected.to match(/default-centos-7\s+(Vagrant|Dummy)\s+ChefSolo\s+(Busser\s+Ssh\s+)?<Not Created>/) }
+  end # /context with a platform alias
+
+  context 'with $CHEF_VERSION set' do
+    command 'kitchen diagnose'
+    environment CHEF_VERSION: 12
+    its(:stdout) { is_expected.to match(%r{- curl -L https://chef.io/chef/install.sh | bash -s -- -v 12$}) }
+    its(:stdout) { is_expected.to include("require_chef_omnibus: '12'") }
+  end # /context with $CHEF_VERSION set
+
+  context 'with $CI set' do
+    command 'kitchen diagnose'
+    environment CI: true, SPEC_BLOCK_CI: false
+    its(:stdout) { is_expected.to match(%r{- curl -L https://chef.io/chef/install.sh | bash -s -- -v #{Chef::VERSION}$}) }
+    its(:stdout) { is_expected.to include("require_chef_omnibus: #{Chef::VERSION}") }
+  end # /context with $CI set
+
+  context 'with a platform override' do
+    file '.kitchen.yml', <<-EOH
+---
+#<% require 'poise_boiler' %>
+<%= PoiseBoiler.kitchen %>
+
+platforms:
+- name: gentoo
+- name: arch
+
+suites:
+- name: default
+EOH
+    command 'kitchen list'
+    its(:stdout) { is_expected.to match(/default-gentoo\s+(Vagrant|Dummy)\s+ChefSolo\s+(Busser\s+Ssh\s+)?<Not Created>/) }
+    its(:stdout) { is_expected.to match(/default-arch\s+(Vagrant|Dummy)\s+ChefSolo\s+(Busser\s+Ssh\s+)?<Not Created>/) }
+  end # /context with a platform override
+end