puppet-ci-testing 0.11.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 60a555bfc11e077ffc1a8f8f4baee3c22f350e70
+  data.tar.gz: e65edadaf0ca0b8bb538c196902d6e31b52cfd5d
+SHA512:
+  metadata.gz: 52f0cd8ff310dc0fb4de9c64aef6b1da62dee02b90a38fd7ee26bf4815d4391a194a92cdea5fbfd01e9f315a8719969c20c9ce46f432663aeebececa5b9974d5
+  data.tar.gz: f55079f2a88fc62fed7a01a510bbab6774eb50da39c1241b4306769693c8dfd51d9bf2f506c5220b7c06a80bcee3ed3093af1a7b67ddb11e4d6b42f8ab7d724f

data/bin/check_file_syntax

@@ -0,0 +1,113 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'fileutils'
+require 'colorize'
+
+require 'check_file_syntax'
+require 'simple_junit'
+
+
+
+def repo_directory
+  `git rev-parse --show-toplevel`.chomp
+end
+
+
+def changed_files
+  `git diff --cached --name-only --diff-filter=ACM`.split("\n")
+end
+
+
+
+options = { :excludes        => [],
+            :directory       => '.',
+            :junit           => nil,
+            :display_stdout  => true,
+            :git_hook        => false,
+          }
+OptionParser.new do |opts|
+  opts.banner = <<-EOH
+Usage: #{File.basename $0} [options] [working dir]
+
+Check the syntax of the following file types from the specified working
+directory. If the working directory is not specified, then the current
+working directory is used.
+
+Supported file types: #{(CheckFileSyntax::ALL_CHECKS.each {|t| t.to_s}).join(', ')}
+
+Options:
+EOH
+
+  opts.on('--no-color', '-C', 'Disable text color') do
+    String.disable_colorization
+  end
+
+  opts.on('--exclude DIR', '-x', 'Exclude directory from any syntax checks') do |dir|
+    options[:excludes] << dir
+  end
+
+  opts.on('--junit DIR', '-j', 'Generate JUnit reports and deposit in DIR') do |dir|
+    options[:junit] = dir
+  end
+
+  opts.on('--no-output', '-n', 'Squelch the results on stdout (default to display)') do
+    options[:display_stdout] = false
+  end
+
+  opts.on('--git-hook', '-g', 'Execute as a Git pre-commit hook') do
+    options[:git_hook] = true
+  end
+end.parse!
+
+# check for an optional directory to
+if ARGV.count == 1
+  options[:directory] = ARGV[0]
+end
+
+test_collection = SimpleJUnit::TestSuiteCollection.instance
+test_suite = test_collection.create_testsuite('Syntax Checks')
+
+if options[:git_hook]
+  deny_commit = false
+  changed_files.each do |changed|
+    CheckFileSyntax::check_file_syntax(changed) do |path, status, errors|
+      if status == :failed
+        deny_commit = true
+      end
+      CheckFileSyntax::show_status(path, status, errors)
+    end
+  end
+  exit(1) if deny_commit
+else
+  CheckFileSyntax.search_all_files_for_errors(options[:directory], options[:excludes]) do |path, status, output|
+    unless status.nil?
+      tc = test_suite.create_testcase('File syntax', path)
+      case status
+      when :passed
+        tc.passed(output: output)
+      when :failed
+        tc.failed(type: 'syntax_error', output: '', error: output)
+      when :skipped
+        tc.skipped
+      end
+    end
+  end
+end
+
+if options[:junit]
+  unless Dir.exists? options[:junit]
+    FileUtils.mkdir_p options[:junit]
+    FileUtils.chmod 0755, options[:junit]
+  end
+  File.open("#{options[:junit]}/check_file_syntax-#{$$}.xml", 'w') do |fh|
+    fh.write test_collection.to_s
+  end
+end
+
+if options[:display_stdout]
+  test_suite.testcases.each do |tc|
+    CheckFileSyntax.show_status(tc.description, tc.status, tc.errors)
+  end
+end
+

data/bin/puppet_unittest_workflow

@@ -0,0 +1,253 @@
+#!/usr/bin/env  ruby
+
+require 'optparse'
+require 'ostruct'
+require 'yaml'
+
+require 'rake'
+require 'rspec/core/rake_task'
+require 'puppetlabs_spec_helper/rake_tasks'
+require 'puppet-lint/tasks/puppet-lint'
+
+require 'puppet-lint'
+
+require 'check_file_syntax'
+
+
+PUPPET_DIRS = ['files', 'lib', 'manifest', 'spec', 'templates', 'tests',
+               '.git_hooks']
+
+
+def process_syntax_checks(opts)
+  # collect all the current directories
+  dirs = Dir.entries('.').select {|item| File.directory? item and item !~ /^\.{1,2}$/}
+
+  # calculate what will be excluded and what will be checked
+  exclude_dirs = opts.syntax_exclude_dirs || dirs - (dirs - PUPPET_DIRS)
+  checked_dirs = (dirs - PUPPET_DIRS) - exclude_dirs
+
+  puts <<-EOM
+========================================================================
+========================================================================
+
+  Performaning syntax checks
+
+    File types:  #{opts.syntax_checks.map {|i| i.to_s}.join(', ')}
+    Directories: #{checked_dirs.join(', ')}
+
+************************************************************************
+
+EOM
+
+  num = CheckFileSyntax.search_all_files_for_errors('.', excludes=exclude_dirs,
+                                          checks=opts.syntax_checks)
+
+  if num > 0
+    puts <<-EOM
+
+************************************************************************
+
+  Failed syntax checks: #{num}
+
+            THESE CHECKS MUST PASS TO COMPLETE BUILD.
+
+************************************************************************
+
+EOM
+    return false
+  end
+  return true
+end
+
+
+def process_lint_parsing(opts)
+
+  all_checks = PuppetLint.configuration.checks.map {|chk| chk.to_s}
+  enables = opts.lint_enable || all_checks
+  disables = all_checks - enables
+
+  puts <<-EOM
+
+========================================================================
+========================================================================
+
+  Performaning lint parsing
+
+    Enabled lint options:
+          #{enables.join("\n          ")}
+
+************************************************************************
+
+EOM
+
+  # configure the rake task to disable specific checks
+  if not disables.empty?
+    Rake::Task['lint'].clear
+    PuppetLint::RakeTask.new :lint do |config|
+      config.ignore_paths = ['spec/**/*.pp', 'vendor/**/*.pp']
+      config.log_format = '%{path}:%{linenumber}:%{check}:%{KIND}:%{message}'
+      config.fail_on_warnings = false
+      config.disable_checks = disables
+    end
+  end
+
+  begin
+    Rake.application['lint'].invoke
+  rescue SystemExit => e
+    puts <<-EOM
+
+************************************************************************
+
+                            BUILD HAD FAILED
+
+             Correct the above Puppet LINT errors to correct
+
+************************************************************************
+
+EOM
+    return false
+  end
+  return true
+end
+
+
+def process_rspec_tests(opts)
+
+  puts <<-EOM
+
+========================================================================
+========================================================================
+
+  Performaning RSpec unit testing
+
+************************************************************************
+
+EOM
+
+  if opts.rspec_clean_sources
+    # execute rake spec_clean
+    puts "***"
+    puts "***   Cleaning spec fixtures"
+    puts "***"
+    Rake.application['spec_clean'].invoke
+  end
+
+  RSpec::Core::RakeTask.new(:spec) do |task|
+    task.rspec_opts = %w[--format RspecJunitFormatter --out test-reports/rspec.xml]
+    task.pattern = 'spec/{classes,defines,unit,functions,hosts,integration}/**/*_spec.rb'
+  end
+  Rake.application['spec'].invoke
+end
+
+
+
+
+if ENV['PUPPET_CI_CONF']
+  CONF_FILE = ENV['PUPPET_CI_CONF']
+else
+  CONF_FILE = File.expand_path('../../etc/puppet_unittest_workflow.yaml', $0)
+end
+
+# Set script defaults
+options = OpenStruct.new
+options.syntax_run = true
+options.syntax_checks = CheckFileSyntax::ALL_CHECKS
+options.syntax_exclude_dirs = []
+options.lint_run = true
+options.lint_enable = []
+options.rspec_run = true
+options.rspec_clean_sources = false
+
+
+# read in config file and set options
+defaults = YAML.load_file(CONF_FILE)
+defaults.keys.each do |test|
+  opts = defaults[test]
+
+  if test == 'syntax'
+    options.syntax_run = opts['run'] if opts.has_key? 'run'
+    options.syntax_checks = opts['checks'] if opts.has_key? 'checks'
+    options.syntax_exclude_dirs = opts['exclude_dirs'] if opts.has_key? 'exclude_dirs'
+  end
+
+  if test == 'lint'
+    options.lint_run = opts['run'] if opts.has_key? 'run'
+    options.lint_enable = opts['enable'] if opts.has_key? 'enable'
+  end
+
+  if test == 'rspec'
+    options.rspec_run = opts['run'] if opts.has_key? 'run'
+    options.rspec_clean_sources = opts['clean_sources'] if opts.has_key? 'clean_sources'
+  end
+
+end
+
+
+# process the command line options and override prev set settings
+OptionParser.new do |opts|
+  opts.on('--[no-]lint', "Enable/disable lint parsing (Default: #{options[:lint]})") do |val|
+    options.lint_run = val
+  end
+
+  opts.on('--disable-syntax-check [TYPE]', 'Disable syntax check for TYPE') do |val|
+    if val.nil? or val =~ /all/i
+      options.syntax_run = false
+    else
+      options.syntax_checks.select! {|type| type != val.to_sym}
+    end
+  end
+
+  opts.on('--enable-syntax-check [TYPE]', 'Enable syntax checks for TYPE') do |val|
+    if val.nil?
+      options.syntax_checks = CheckFileSyntax::ALL_CHECKS
+    else
+      if not options.syntax_checks.include? val.to_sym
+        options.syntax_checks << val.to_sym
+      end
+    end
+  end
+
+  opts.on('--clean-sources', 'Clean out dependent sources and start from scratch') do
+    options.rspec_clean_sources = true
+  end
+
+
+  opts.on('--disable-rspec', 'Disable rspec unittests') do
+    options.rspec_run = false
+  end
+
+
+  opts.separator <<-EOH
+
+Config file: #{CONF_FILE}
+Config file location can be specified by setting $PUPPET_CI_CONF
+
+Default syntax checks: #{options.syntax_checks.map {|i| i.to_s}.join ', '}
+
+Using the keyword 'all' will allow all syntax checks to be enabled or
+disabled. Order of enable/disable switches are important. Using a
+disable switch at the end of options will turn off all syntax checks
+even if there are enable syntax check switches on the command line.
+EOH
+
+end.parse!
+
+
+if options.syntax_run
+  unless process_syntax_checks(options)
+    exit(1)
+  end
+end
+
+
+if options.lint_run
+  unless process_lint_parsing(options)
+    exit(2)
+  end
+end
+
+
+if options.rspec_run
+  process_rspec_tests(options)
+end
+

data/etc/puppet_unittest_workflow.yaml

@@ -0,0 +1,61 @@
+---
+# Configuration for syntax checks
+  syntax:
+    run: true
+# checks determines which syntax checkers to use
+#    checks:
+#      - ruby
+#      - erb
+#
+# exclude_dirs is a list of subdirectories to exclude from syntax checks
+    exclude_dirs:
+      - automation
+      - bin
+      - .git
+      - vendor
+      - spec
+#
+# Configuration for lint parsing
+  lint:
+    run: true
+# enable turns on lint parsing options. They are puppet-lint options
+# with '--no-' and '-check' removed from the option. Not specifying
+# enable will cause all options to be turned on.
+    enable:
+      - right_to_left_relationship
+#      - autoloader_layout
+      - names_containing_dash
+      - class_inherits_from_params_class
+      - parameter_order
+      - inherits_across_namespaces
+      - nested_classes_or_defines
+#      - variable_scope
+      - slash_comments
+      - star_comments
+      - selector_inside_resource
+      - case_without_default
+      - documentation
+#      - double_quoted_strings
+      - only_variable_string
+      - variables_not_enclosed
+      - single_quote_string_with_variables
+      - quoted_booleans
+      - puppet_url_without_modules
+      - variable_contains_dash
+      - hard_tabs
+      - trailing_whitespace
+#      - 80chars
+      - 2sp_soft_tabs
+      - arrow_alignment
+      - unquoted_resource_title
+      - ensure_first_param
+      - duplicate_params
+      - unquoted_file_mode
+      - file_mode
+      - ensure_not_symlink_target
+      - unquoted_node_name
+#
+# Configuration for RSpec unit testing
+  rspec:
+    run: true
+    clean_sources: true

data/lib/check_file_syntax.rb

@@ -0,0 +1,184 @@
+require 'colorize'
+require 'json'
+require 'yaml'
+require 'find'
+
+
+module CheckFileSyntax
+
+  ALL_CHECKS = [:puppet, :ruby, :python, :perl, :bash, :erb, :yaml, :json]
+
+  module_function
+  def type_of_file(path, interpreter, extensions)
+    # check extensions first
+    [extensions].flatten.each {|ext| return true if path.end_with? ext }
+
+    # check only if really a file and is not 0 byte
+    if File.file?(path) and File.size?(path)
+      # Look for a she-bang line and check for interpreter
+      shebang = File.open(path).first
+      if shebang and shebang.start_with? '#!/' and shebang.include? interpreter.to_s
+        return true
+      end
+    end
+    return false
+  end
+
+  # define a bunch of convenience functions
+  def puppet_file?(path)
+    type_of_file(path, :puppet, '.pp')
+  end
+
+  def erb_file?(path)
+    type_of_file(path, :erb, '.erb')
+  end
+
+  def python_file?(path)
+    type_of_file(path, :python, '.py')
+  end
+
+  def ruby_file?(path)
+    type_of_file(path, :ruby, '.rb')
+  end
+
+  def perl_file?(path)
+    type_of_file(path, :perl, ['.pl', '.pm'])
+  end
+
+  def bash_file?(path)
+    type_of_file(path, :bash, ['.sh', '.bash', '.zsh', '.ksh'])
+  end
+
+  def json_file?(path)
+    type_of_file(path, :json, '.json')
+  end
+
+  def yaml_file?(path)
+    type_of_file(path, '---', ['.yaml', '.yml'])
+  end
+
+
+  module_function
+  def show_status (name, success, errors)
+    # Untested files return a nil success
+    unless success.nil?
+      if success == :passed
+        puts '   OK   '.colorize(:green) + "  #{name}".colorize(:cyan)
+      else
+        puts '  FAIL  '.colorize(:light_yellow).swap + "  #{name}".colorize(:cyan)
+        puts errors
+      end
+    end
+  end
+
+
+  module_function
+  def search_all_files_for_errors(directory, excludes=[], checks=ALL_CHECKS, &block)
+    error_count = 0
+    Find.find(directory) do |path|
+      # prune the directory tree if we found a directory that should be excluded
+      if File.directory? path
+        if not (excludes.select { |d| path.end_with? d }).empty?
+          Find.prune
+        else
+          # we don't do any thing with dirs, so go to next item
+          next
+        end
+      end
+
+      # TODO Need to look at checks to determine if we should do this
+      check_file_syntax(path) do |path, status, errors|
+        if status == :failed
+          error_count += 1
+        end
+
+        if block_given?
+          yield path, status, errors
+        else
+          show_status(path, status, errors)
+        end
+      end
+    end
+    return error_count
+  end
+
+
+  module_function
+  def check_file_syntax(path, &block)
+    errors = ''
+    status = nil
+
+    if puppet_file? path
+      if system('which puppet >/dev/null')
+        errors = `puppet parser validate #{path} 2>&1`
+        status = $?.success? ? :passed : :failed
+      else
+        puts 'Consider installing puppet so that syntax can be checked.'.colorize(:yellow)
+        status = :skipped
+      end
+    end
+
+    if erb_file? path
+      errors = `cat #{path} | erb -x -T - | ruby -c 2>&1`
+      status = $?.success? ? :passed : :failed
+    end
+
+    if python_file? path
+      if system('which python >/dev/null')
+        errors = `python -m py_compile #{path} 2>&1`
+        status = $?.success? ? :passed : :failed
+      else
+        puts 'Consider installing python so that syntax can be checked.'.colorize(:yellow)
+        status = :skipped
+      end
+    end
+
+    if ruby_file? path
+      errors = `ruby -c #{path} 2>&1`
+      status = $?.success? ? :passed : :failed
+    end
+
+    if perl_file? path
+      if system('which perl >/dev/null')
+        errors = `perl -c #{path} 2>&1`
+        status = $?.success? ? :passed : :failed
+      else
+        puts 'Consider installing perl so that syntax can be checked.'.colorize(:yellow)
+        status = :skipped
+      end
+    end
+
+    if bash_file? path
+      errors = `bash -n #{path} 2>&1`.to_i
+      status = $?.success? ? :passed : :failed
+    end
+
+
+    if json_file? path
+      begin
+        JSON.parse(File.read(path))
+        status = :passed
+      rescue Exception => e
+        errors = e.message
+        status = :failed
+      end
+    end
+
+    if yaml_file? path
+      begin
+        YAML.parse(File.read(path))
+        status = :passed
+      rescue Exception => e
+        errors = e.message
+        status = :failed
+      end
+    end
+
+    if block_given?
+      yield path, status, errors
+    else
+      show_status(path, status, errors)
+      error_count += 1 if status == :failed
+    end
+  end
+end