puppet-henchman 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c5783240c550c5400d7fa7af55509cd468626303
+  data.tar.gz: e5e7e5ba4faeb2322655e438729021b18f40426c
+SHA512:
+  metadata.gz: eca27b267728cdaf2e5a10a0cc1ae077b0c17ce34c3d3c7607989f3df7e659925ba26f878c322b3297a3c5dbf8df6b103047b9a7a14a472edd014375032b5320
+  data.tar.gz: cab03a8e0b7a34b6598703fca81465c2748091d76e7ff4ca077fdf96c18d7b9a37f45c67d5ff83e4df910e6bc25df8e0a3c11b1408750b4ad233b499ab86669d

data/lib/henchman/functions.rb

@@ -0,0 +1,19 @@
+require 'puppet/version'
+
+module Henchman
+  module Functions
+    def self.puppet_version
+      Puppet.version
+    end
+
+    def self.future_applicable?
+      tmp_ver = puppet_version
+      Gem::Version.new(tmp_ver) >= Gem::Version.new('3.2') &&
+        Gem::Version.new(tmp_ver) < Gem::Version.new('4')
+    end
+
+    def self.future?
+      ENV['FUTURE_PARSER'] == 'true' && future_applicable?
+    end
+  end
+end

data/lib/henchman/metadata.rb

@@ -0,0 +1,12 @@
+module Henchman
+  NAME = 'puppet-henchman'.freeze
+  VERSION = '0.1.0'.freeze
+
+  def self.name
+    NAME
+  end
+
+  def self.version
+    VERSION
+  end
+end

data/lib/henchman/rake.rb

@@ -0,0 +1,280 @@
+require 'henchman/functions'
+require 'rspec/core/rake_task'
+require 'kitchen'
+
+task default: :help
+
+def print_section(str)
+  puts "==> \e[0;34m#{str}\e[0m"
+end
+
+desc 'Display the list of available rake tasks'
+task :help do
+  system('rake -T')
+end
+
+exclude_paths = [
+  'pkg/**/*',
+  'vendor/**/*',
+  'spec/**/*',
+  'test/**/*'
+]
+
+# puppet-lint
+begin
+  require 'puppet-lint/tasks/puppet-lint'
+  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.ignore_paths = exclude_paths
+    config.disable_checks = %w(
+      80chars
+      class_parameter_defaults
+      class_inherits_from_params_class
+      documentation
+      single_quote_string_with_variables
+    )
+  end
+rescue LoadError
+  desc 'Not available, install puppet-lint gem'
+  task :lint do
+    warn('Skipping lint validation, puppet-lint gem missing')
+  end
+end
+
+Rake::Task[:lint].enhance ['lint:section']
+
+namespace :lint do
+  task :section do
+    print_section('Lint Validation')
+  end
+end
+
+# puppet-syntax
+begin
+  require 'puppet-syntax/tasks/puppet-syntax'
+  PuppetSyntax.future_parser = Henchman::Functions.future?
+  PuppetSyntax.exclude_paths ||= []
+  exclude_paths.each do |p|
+    unless PuppetSyntax.exclude_paths.include?(p)
+      PuppetSyntax.exclude_paths << p
+    end
+  end
+  PuppetSyntax.hieradata_paths = ['spec/fixtures/hieradata/test.yaml']
+  Rake::Task['syntax:manifests'].enhance ['syntax:section']
+  Rake::Task['syntax:templates'].enhance ['syntax:section']
+  Rake::Task['syntax:hiera:yaml'].enhance ['syntax:section']
+rescue LoadError
+  desc 'Not available, install puppet-syntax gem'
+  task :syntax do
+    warn('Skipping syntax validation, puppet-syntax gem missing')
+  end
+  Rake::Task[:syntax].enhance ['syntax:section']
+end
+
+namespace :syntax do
+  task :section do
+    title = 'Syntax Validation'
+    title << ' (with future parser)' if Henchman::Functions.future?
+    print_section(title)
+  end
+end
+
+# metadata-json-lint
+begin
+  require 'metadata_json_lint'
+  desc 'Validate metadata.json file'
+  task :metadata do
+    MetadataJsonLint.parse('metadata.json') if File.exist?('metadata.json')
+  end
+rescue LoadError
+  desc 'Not available, install metadata-json-lint gem'
+  task :metadata do
+    warn('Skipping metadata validation, metadata-json-lint gem missing')
+  end
+end
+
+Rake::Task[:metadata].enhance ['metadata:section']
+
+namespace :metadata do
+  task :section do
+    print_section('Metadata Validation')
+  end
+end
+
+def source_dir
+  Dir.pwd
+end
+
+def spec_dir
+  File.join(source_dir, 'spec')
+end
+
+def unit_dir
+  File.join(source_dir, 'test/unit')
+end
+
+def modules_dir
+  File.join(source_dir, 'test/fixtures/modules')
+end
+
+def manifests_dir
+  File.join(source_dir, 'test/fixtures/manifests')
+end
+
+def module_name
+  metadata_file = File.join(source_dir, 'metadata.json')
+  if File.exist?(metadata_file)
+    require 'json'
+    JSON.parse(File.read(metadata_file))['name'].split('-', 2).last
+  else
+    raise "Unable to find #{metadata_file}, cannot continue"
+  end
+end
+
+namespace :spec do
+  task :clean do
+    # clean out all modules
+    FileUtils.mkdir_p(modules_dir)
+    module_entries = Dir.entries(modules_dir)
+    module_entries.reject { |x| ['.', '..'].include?(x) }.each do |entry|
+      FileUtils.rm_rf(File.join(modules_dir, entry), secure: true)
+    end
+  end
+
+  task :prep do
+    FileUtils.mkdir_p(modules_dir)
+    # Install dependencies for module
+    system("librarian-puppet install --path #{modules_dir} --destructive")
+  end
+
+  namespace :unit do
+    task :prep do
+      # Setup spec symlink to test/unit for rspec happiness
+      FileUtils.rm_f(spec_dir) if File.symlink?(spec_dir)
+      if !File.exist?(spec_dir)
+        FileUtils.ln_sf(unit_dir, spec_dir)
+      else
+        raise("#{spec_dir} exists is not symlink, cannot continue")
+      end
+      # Setup self via symlink (librarian does not do this for us)
+      FileUtils.mkdir_p(modules_dir)
+      full_module_path = File.join(modules_dir, module_name)
+      FileUtils.rm_f(full_module_path) if File.symlink?(full_module_path)
+      if !File.exist?(full_module_path)
+        FileUtils.ln_sf(source_dir, full_module_path)
+      else
+        raise("#{full_module_path} exists and is not symlink, cannot continue")
+      end
+      # Setup manifests
+      FileUtils.mkdir_p(manifests_dir)
+      FileUtils.touch(File.join(manifests_dir, 'site.pp'))
+    end
+
+    task :clean do
+      # clean up spec_dir link to unit_dir
+      if File.symlink?(spec_dir)
+        FileUtils.rm_f(spec_dir)
+      elsif File.exist?(spec_dir)
+        raise("#{spec_dir} exists and is not symlink, cannot continue")
+      end
+      # Clear out self symlink, Kitchen does this for us
+      full_module_path = File.join(modules_dir, module_name)
+      if File.symlink?(full_module_path)
+        FileUtils.rm_f(full_module_path)
+      elsif File.exist?(full_module_path)
+        raise("#{full_module_path} exists and is not symlink, cannot continue")
+      end
+      # clean up manifests, if applicable
+      if File.zero?(File.join(manifests_dir, 'site.pp'))
+        FileUtils.rm_f(File.join(manifests_dir, 'site.pp'))
+      end
+    end
+
+    task :section do
+      title = 'Unit Tests'
+      title << " (Puppet #{Henchman::Functions.puppet_version}"
+      title << ' with future parser' if Henchman::Functions.future?
+      title << ')'
+      print_section(title)
+    end
+  end # namespace :unit
+
+  desc '' # Hide this task by default
+  RSpec::Core::RakeTask.new(:unit) do |t|
+    t.pattern = 'spec/{classes,defines,functions,hosts,types,unit}/**/*_spec.rb'
+  end
+
+  namespace :integration do
+    task :section do
+      print_section('Integration Tests')
+    end
+
+    task manual: ['spec:prep', 'spec:unit:clean']
+  end
+
+  task :integration, [:destroy] do |_t, args|
+    if args[:destroy]
+      case args[:destroy].downcase
+      when 'never', 'no'
+        destroy_opt = :never
+      when 'always', 'yes',
+        destroy_opt = :always
+      else
+        destroy_opt = :passing
+      end
+    else
+      destroy_opt = :passing
+    end
+    Kitchen.logger = Kitchen.default_file_logger
+    Kitchen::Config.new.instances.each do |i|
+      i.test(destroy_opt)
+    end
+  end
+end
+
+# Prerequisites for spec:unit task
+Rake::Task['spec:unit'].enhance [
+  'spec:unit:section',
+  'spec:prep',
+  'spec:unit:prep'
+]
+
+# Run after spec:unit task
+Rake::Task['spec:unit'].enhance do
+  Rake::Task['spec:unit:clean'].invoke
+end
+
+# Prerequisites for spec:integration task
+Rake::Task['spec:integration'].enhance [
+  'spec:integration:section',
+  'spec:prep',
+  'spec:unit:clean'
+]
+
+# Prerequisites for spec:clean
+Rake::Task['spec:clean'].enhance ['spec:unit:clean']
+
+# Alias for spec:unit
+desc 'Run unit tests'
+task unit: 'spec:unit'
+
+# Alias for spec:integration
+desc 'Run integration tests'
+task :integration, [:destroy] => 'spec:integration'
+
+namespace :integration do
+  # Alias for spec:integration:manual
+  desc 'Prepare for integration tests run manually'
+  task manual: 'spec:integration:manual'
+end
+
+# Alias for spec:clean
+desc 'Clean up after spec tests'
+task clean: 'spec:clean'
+
+# Alias for metadata, lint, syntax
+desc 'Run metadata, lint, and syntax tasks'
+task style: [:metadata, :lint, :syntax]

data/lib/henchman/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'rspec-puppet'
+
+spec_path     = File.expand_path(File.join(Dir.pwd, 'test'))
+fixture_path  = File.join(spec_path, 'fixtures')
+module_path   = File.join(fixture_path, 'modules')
+manifest_path = File.join(fixture_path, 'manifests')
+
+RSpec.configure do |c|
+  c.module_path       = module_path
+  c.manifest_dir      = manifest_path
+  c.parser            = 'future'        if ENV['FUTURE_PARSER'] == 'yes'
+  c.strict_variables  = true            if ENV['STRICT_VARIABLES'] == 'yes'
+  c.stringify_facts   = false           if ENV['STRINGIFY_FACTS'] == 'no'
+  c.trusted_node_data = true            if ENV['TRUSTED_NODE_DATA'] == 'yes'
+  c.ordering          = ENV['ORDERING'] if ENV['ORDERING']
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: puppet-henchman
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jordan Wesolowski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.37'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.37'
+- !ruby/object:Gem::Dependency
+  name: kitchen-puppet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: librarian-puppet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !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: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: test-kitchen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: Wrapper around Test Kitchen, rspec-puppet, and other tools
+email: jrwesolo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/henchman/functions.rb
+- lib/henchman/metadata.rb
+- lib/henchman/rake.rb
+- lib/henchman/spec_helper.rb
+homepage: https://github.com/jrwesolo/puppet-henchman
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Unit and Integration test helper for Puppet
+test_files: []