control_spec_helper 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 85c0b9b72a42803e64e735178baa10091aa89782
+  data.tar.gz: 1414e84d2bb520b8310533b2f3fe2504c18d4127
+SHA512:
+  metadata.gz: b5ea6ca1108204d0e87dbf83bcf8bce8ffa07a9681904c67415092e2388745054191168e80397a4d28c8eb7ebaffc84e024065dcff2e923f54de806a97a8f7c4
+  data.tar.gz: deff607652448f633a89bb1fa03b0de77aac9ffe87482cf4aaf43ff8c96494e454d1922fc739118c8e4d79990ca8a5e0ecd9dd72ae493544b76ca12aed2b24fe

data/.gitignore

@@ -0,0 +1,3 @@
+Gemfile.lock
+pkg/
+.*.sw

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,16 @@
+Copyright (C) 2012 Puppet Labs Inc
+
+Puppet Labs can be contacted at: info@puppetlabs.com
+
+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.

data/README.md

@@ -0,0 +1,9 @@
+Note: this is still alpha code. Use at your own risk.
+
+Puppet Control Spec Helper is designed to complement the Puppet Labs Spec Helper, which is
+not intended for use with control repositories.
+
+Directions forthcoming - for now copy the ext/spec_helper_control.rb file into your site/role/spec directory inside your control repo
+and copy the Rakefile into your base directory.
+
+Most code by David Gwilliam <david.gwilliam@slalom.com> with assistance by Eric Shamow <eric.shamow@slalom.com>

data/Rakefile

@@ -0,0 +1,36 @@
+require 'rake'
+require 'rake/packagetask'
+require 'rubygems/package_task'
+require 'rspec/core/rake_task'
+
+task :default do
+    sh %{rake -T}
+end
+
+require 'fileutils'
+
+RSpec::Core::RakeTask.new(:spec)
+
+def version
+  require 'control_spec_helper/version'
+  ControlSpecHelper::Version::STRING
+end
+
+namespace :package do
+  desc "Create the gem"
+  task :gem do
+    spec = Gem::Specification.load("control_spec_helper.gemspec")
+    Dir.mkdir("pkg") rescue nil
+    if Gem::Version.new(`gem -v`) >= Gem::Version.new("2.0.0.a")
+      Gem::Package.build(spec)
+    else
+      Gem::Builder.new(spec).build
+    end
+    FileUtils.move("control_spec_helper-#{version}.gem", "pkg")
+  end
+end
+
+desc "Cleanup pkg directory"
+task :clean do
+  FileUtils.rm_rf("pkg")
+end

data/control_spec_helper.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+require "control_spec_helper/version"
+
+Gem::Specification.new do |s|
+  s.name        = "control_spec_helper"
+  s.version     = ControlSpecHelper::Version::STRING
+  s.authors     = ["Slalom Consulting"]
+  s.email       = ["eric.shamow@slalom.com"]
+  s.homepage    = "http://github.com/eshamow/control_spec_helper"
+  s.summary     = "Standard tasks and configuration for control repo spec tests"
+  s.description = "Contains rake tasks and a standard spec_helper for running spec tests on puppet control repo"
+  s.licenses    = 'Apache-2.0'
+
+  s.files       = `git ls-files`.split("\n")
+  s.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+
+  # Runtime dependencies, but also probably dependencies of requiring projects
+  s.add_runtime_dependency 'rake'
+  s.add_runtime_dependency 'rspec-puppet'
+  s.add_runtime_dependency 'puppet-lint'
+  s.add_runtime_dependency 'puppet-syntax'
+  s.add_runtime_dependency 'mocha'
+  s.add_development_dependency 'pry'
+end

data/ext/Rakefile.sample

@@ -0,0 +1,11 @@
+$:.unshift(File.join(File.dirname(__FILE__), 'lib'))
+
+require 'control_spec_helper/control_spec_helper'
+require 'control_spec_helper/rake_tasks'
+require 'puppet-lint/tasks/puppet-lint'
+
+include ControlSpecHelper
+
+# Uncomment one of the below to set alternate directories for basebranch or bastpath
+#basebranch='master'
+#basepath='spec'

data/ext/spec_helper_control.rb

@@ -0,0 +1,55 @@
+if ENV['serverspec']
+  require 'serverspec'
+
+  Specinfra.configuration.backend = :exec
+else
+  require 'beaker-rspec/spec_helper'
+  require 'beaker-rspec/helpers/serverspec'
+
+  UNSUPPORTED_PLATFORMS = %w(Suse windows AIX Solaris Debian)
+
+  RSpec.configure do |c|
+    # Project root
+    proj_root = File.expand_path(
+      File.join(File.dirname(__FILE__), '..', '..', '..'))
+
+    # Readable test descriptions
+    c.formatter = :documentation
+
+    # Configure all nodes in nodeset
+    c.before :suite do
+      # Install module and dependencies
+      hosts.each do |host|
+        role    = File.join(proj_root, 'dist', 'role')
+        profile = File.join(proj_root, 'dist', 'profile')
+
+        copy_module_to(host, source: role, module_name: 'role')
+        copy_module_to(host, source: profile, module_name: 'profile')
+        run_script_on host, File.join(proj_root, 'scripts', 'bootstrap.sh')
+        shell 'mkdir -p /controlrepo'
+        shell 'chown vagrant /controlrepo'
+        install_package(host, 'zlib-devel')
+        install_package(host, 'openssl-devel')
+        %x{scp -i ~/.vagrant.d/insecure_private_key -o StrictHostKeyChecking=no -r #{proj_root}  vagrant@#{host.connection.ip}:/}
+        #scp_to host, proj_root, '/controlrepo'
+        shell 'cd /controlrepo && gem install ./control_spec_helper-0.0.1.gem && bundle install && rake r10k'
+        shell 'mkdir -p /etc/facter/facts.d'
+        role = ENV['role'].sub(/^role::/, '')
+        shell "echo \"role=#{role}\" > /etc/facter/facts.d/role.txt"
+      end
+    end
+  end
+
+  shared_context 'beaker' do
+    describe 'running puppet code' do
+      it 'should apply cleanly' do
+        pp = <<-EOS
+          include "role::${::role}"
+        EOS
+
+        modulepath = '/controlrepo/dist:/controlrepo/modules'
+        apply_manifest(pp, :modulepath => modulepath, :catch_failures => true)
+      end
+    end
+  end
+end

data/lib/control_spec_helper/control_spec_helper.rb

@@ -0,0 +1,136 @@
+# rubocop:disable Style/DotPosition, Style/HashSyntax
+
+module ControlSpecHelper
+  attr_writer :basepath, :basebranch
+
+  def basepath
+    @basepath ||= 'site'
+  end
+
+  def basebranch
+    @basebranch ||= 'master'
+  end
+
+  def debug(msg)
+    puts "DEBUG: #{msg}" if ENV['debug']
+  end
+
+  def puppet_cmd
+    'puppet apply manifests/site.pp \
+      --modulepath $(echo `pwd`/modules:`pwd`/site) --hiera_config hiera.yaml'
+  end
+
+  def project_root
+    return @root if @root
+    @root = `git rev-parse --show-toplevel`.chomp
+    debug("project_root = #{@root}")
+    @root
+  end
+
+  def role_path
+    File.join(project_root, @basepath, 'role')
+  end
+
+  def profile_path
+    File.join(project_root, @basepath, 'profile')
+  end
+
+  def diff_from_base
+    `git diff #{@basebranch} --cached --diff-filter=ACMR --name-only`.split("\n")
+  end
+
+  def diff_roles
+    diff_from_base.
+      select { |file| file.match(%r{site/role/manifests}) }.
+      map { |path| class_from_path(path) }
+  end
+
+  def diff_profile
+    diff_from_base.
+      select { |file| file.match(%r{site/profile/manifests}) }.
+      map { |path| class_from_path(path) }
+  end
+
+  def class_from_path(path)
+    return nil unless path =~ /manifests.+\.pp$/
+
+    (path.sub(project_root + '/', '').
+      sub(/\.pp$/, '').
+      split('/') - %w(site manifests)).
+      join('::')
+  end
+
+  def roles_that_include(klass)
+    Dir.chdir(role_path) do
+      debug("cd to #{role_path}")
+      `git grep -l #{klass}`.split("\n").
+        map { |path| class_from_path(File.join(role_path, path)) }.
+        compact
+    end
+    debug "cd to #{Dir.pwd}"
+  end
+
+  # TODO: this could be much more accurate if we compiled catalogs for all roles
+  # and then parsed them for included Classes, but that is very complicated
+  def all_roles_with_changes
+    (diff_roles + diff_profile.map do |klass|
+      roles_that_include(klass)
+    end.flatten).uniq
+  end
+
+  def spec_from_class(klass)
+    test = if klass =~ /profile/
+             { :path => 'profile', :type => nil }
+           elsif klass =~ /role/
+             { :path => 'role', :type => 'acceptance' }
+           else
+             fail ArgumentError
+           end
+
+    path = [project_root, @basepath, test[:path], 'spec', test[:type]].compact
+    File.join(path << (klass.split('::') - [test[:path]])) + '_spec.rb'
+  end
+
+  def r10k
+    Dir.chdir(project_root) do
+      debug("cd to #{project_root}")
+      puts 'Installing modules with r10k'
+      `r10k puppetfile install`
+    end
+    debug "cd to #{Dir.pwd}"
+  end
+
+  def profile_fixtures
+    Dir.chdir(profile_path) do
+      debug("cd to #{profile_path}")
+      profile_ln = './spec/fixtures/modules/profile'
+
+      FileUtils.mkpath './spec/fixtures/modules/'
+      File.symlink(profile_path, profile_ln) unless File.exists?(profile_ln)
+
+      Dir.glob('../../modules/*').each do |folder|
+        next unless File.directory?(folder)
+        old_path = File.join(File.dirname(__FILE__), folder)
+        new_path = File.join("./spec/fixtures/modules/#{File.basename(folder)}")
+
+        File.symlink(old_path, new_path) unless File.symlink?(new_path)
+      end
+    end
+    debug "cd to #{Dir.pwd}"
+  end
+
+  def spec_clean
+    Dir.chdir(project_root) do
+      debug("cd to #{project_root}")
+      fixtures = File.join(profile_path, 'spec', 'fixtures', 'modules')
+      modules  = File.join(project_root, 'modules')
+
+      abort if fixtures == '' || !fixtures
+      abort if modules == '' || !modules
+
+      `rm -rf #{fixtures}/*`
+      `rm -rf #{modules}/*`
+    end
+    debug "cd to #{Dir.pwd}"
+  end
+end

data/lib/control_spec_helper/rake_tasks.rb

@@ -0,0 +1,158 @@
+# rubocop:disable Style/HashSyntax
+require 'rake'
+require 'rspec/core/rake_task'
+require 'puppet-lint/tasks/puppet-lint'
+require 'puppet-syntax/tasks/puppet-syntax'
+
+task :default => [:help]
+
+desc 'update repo from origin (destructive)'
+task :git do
+  puts 'Updating puppet-control repo'
+  `git fetch --all`
+  `git checkout --track origin/cloud`
+  `git reset --hard origin/cloud`
+end
+
+desc 'install all modules from the Puppetfile (idempotent)'
+task :r10k do
+  r10k
+end
+
+desc 'print the command used to run puppet'
+task :puppet_cmd do
+  puts puppet_cmd
+end
+
+desc 'run puppet apply (enforce mode)'
+task :apply => [:git, :r10k] do
+  puts "Running 'puppet apply'"
+  exec puppet_cmd
+end
+
+desc 'run puppet apply (no git)'
+task :apply_dev => :r10k do
+  puts "Running 'puppet apply'"
+  exec puppet_cmd
+end
+
+desc 'run puppet apply (noop)'
+task :apply_noop do
+  puts "Running 'puppet apply'"
+  exec "#{puppet_cmd} --noop"
+end
+
+desc 'run puppet apply (debug)'
+task :apply_debug do
+  puts "Running 'puppet apply'"
+  exec "#{puppet_cmd} --debug --trace"
+end
+
+desc 'run puppet apply (no r10k or git)'
+task :apply_standalone do
+  puts "Running 'puppet apply'"
+  exec "#{puppet_cmd} --debug --trace"
+end
+
+desc 'install or update pre-commit hook'
+task :hooks do
+  include FileUtils
+  puts 'Installing pre-commit hook'
+  hook = File.join(project_root, 'scripts', 'pre-commit')
+  dest = File.join(project_root, '.git', 'hooks', 'pre-commit')
+  FileUtils.cp hook, dest
+  FileUtils.chmod 'a+x', dest
+end
+
+desc 'install Vagrant plugins'
+task :vplugins do
+  exec 'vagrant plugin install vagrant-auto_network vagrant-hosts'
+end
+
+desc 'prep for spec tests'
+task :spec_prep do
+  r10k
+  profile_fixtures
+end
+
+desc 'run unit tests'
+task :spec do
+  Rake::Task['spec_prep'].invoke
+  Dir.chdir(profile_path) do
+    system 'bundle exec rake rspec'
+  end
+  Rake::Task['spec_clean'].invoke
+end
+
+desc 'clean up after unit tests'
+task :spec_clean do
+  spec_clean
+end
+
+desc 'Run acceptance tests for 1 or more roles'
+task :acceptance do
+  Rake::Task['spec_clean'].invoke
+
+  role = if ENV['role'] || ENV['roles']
+           (ENV['role'] || ENV['roles']).split(',')
+         elsif !diff_roles.empty?
+           diff_roles
+         else
+           puts 'no roles specified and no changes detected'
+           exit 0
+         end
+
+  puts "-- Acceptance tests for #{role.join(', ')} --"
+  paths = role.map do |klass|
+    if klass.match(/^role/)
+      spec_from_class(klass)
+    else
+      spec_from_class("role::#{klass}")
+    end
+  end.join(' ')
+  Dir.chdir(role_path) do
+    abort unless
+      system "bash -c 'bundle exec rspec --format documentation #{paths}'"
+  end
+end
+
+desc 'Run acceptance tests locally from SUT'
+task :serverspec do
+  Dir.chdir(role_path) do
+    if ENV['role']
+      role_spec = ENV['role']
+    else
+      role_spec = `facter role`.chomp.split('::').join('/')
+    end
+    ENV['serverspec'] = 'true'
+    system "rspec spec/acceptance/#{role_spec}_spec.rb"
+  end
+end
+
+# Override default puppet-lint choices
+# Must clear as it will not override the existing puppet-lint rake task since
+# we require to import for the PuppetLint::RakeTask
+Rake::Task[:lint].clear
+# Relative is not able to be set within the context of PuppetLint::RakeTask
+PuppetLint.configuration.relative = true
+PuppetLint::RakeTask.new(:lint) do |config|
+  config.fail_on_warnings = true
+  config.disable_checks = %w(
+    80chars
+    class_inherits_from_params_class
+    class_parameter_defaults
+    documentation
+  )
+  config.ignore_paths = %w(
+    tests/**/*.pp
+    vendor/**/*.pp
+    examples/**/*.pp
+    spec/**/*.pp
+    pkg/**/*.pp
+  )
+end
+
+desc 'Display the list of available rake tasks'
+task :help do
+  system('rake -T')
+end

data/lib/control_spec_helper/version.rb

@@ -0,0 +1,5 @@
+module ControlSpecHelper
+  module Version
+    STRING = '0.0.1'
+  end
+end

data/lib/control_spec_helper.rb

@@ -0,0 +1 @@
+require 'control_spec_helper/control_spec_helper'

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'rspec'
+require 'control_spec_helper'

data/spec/unit/control_spec_helper_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+class DummyClass
+  include ControlSpecHelper
+end
+
+describe 'control_spec_helper' do
+  before do
+    @dummy_class = DummyClass.new
+  end
+
+  it 'should have a default basepath' do
+    expect(@dummy_class.basepath).to eq('site')
+  end
+
+  it 'should allow you to set basepath' do
+    @dummy_class.basepath = 'dist'
+    expect(@dummy_class.basepath).to eq('dist')
+  end
+
+  it 'should print the puppet command' do
+    cmd = "puppet apply manifests/site.pp \\\n      --modulepath $(echo `pwd`/modules:`pwd`/site) --hiera_config hiera.yaml"
+    expect(@dummy_class.puppet_cmd).to eq(cmd)
+  end
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: control_spec_helper
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Slalom Consulting
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec-puppet
+  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: puppet-lint
+  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: puppet-syntax
+  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: mocha
+  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: pry
+  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: Contains rake tasks and a standard spec_helper for running spec tests
+  on puppet control repo
+email:
+- eric.shamow@slalom.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- control_spec_helper.gemspec
+- ext/Rakefile.sample
+- ext/spec_helper_control.rb
+- lib/control_spec_helper.rb
+- lib/control_spec_helper/control_spec_helper.rb
+- lib/control_spec_helper/rake_tasks.rb
+- lib/control_spec_helper/version.rb
+- spec/spec_helper.rb
+- spec/unit/control_spec_helper_spec.rb
+homepage: http://github.com/eshamow/control_spec_helper
+licenses:
+- Apache-2.0
+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.1
+signing_key: 
+specification_version: 4
+summary: Standard tasks and configuration for control repo spec tests
+test_files:
+- spec/spec_helper.rb
+- spec/unit/control_spec_helper_spec.rb