onceover 3.0.0

data/lib/onceover/testconfig.rb

@@ -0,0 +1,233 @@
+require 'onceover/class'
+require 'onceover/node'
+require 'onceover/group'
+require 'onceover/test'
+require 'onceover/logger'
+require 'onceover/controlrepo'
+require 'git'
+include Onceover::Logger
+
+class Onceover
+  class TestConfig
+    require 'yaml'
+
+    attr_accessor :classes
+    attr_accessor :nodes
+    attr_accessor :node_groups
+    attr_accessor :class_groups
+    attr_accessor :spec_tests
+    attr_accessor :acceptance_tests
+    attr_accessor :environment
+    attr_accessor :opts
+    attr_accessor :filter_tags
+    attr_accessor :filter_classes
+    attr_accessor :filter_nodes
+    attr_accessor :mock_functions
+
+    def initialize(file,opts = {})
+      begin
+        config = YAML.load(File.read(file))
+      rescue Errno::ENOENT
+        raise "Could not find #{file}"
+      rescue Psych::SyntaxError
+        raise "Could not #{file}, check that it is valid YAML and that the encoding is correct"
+      end
+
+      @classes          = []
+      @nodes            = []
+      @node_groups      = []
+      @class_groups     = []
+      @spec_tests       = []
+      @acceptance_tests = []
+      @opts             = opts
+      @mock_functions   = config['functions']
+
+      # Add the 'all_classes' and 'all_nodes' default groups
+      @node_groups << Onceover::Group.new('all_nodes',@nodes)
+      @class_groups << Onceover::Group.new('all_classes',@classes)
+
+      config['classes'].each { |clarse| @classes << Onceover::Class.new(clarse) } unless config['classes'] == nil
+      config['nodes'].each { |node| @nodes << Onceover::Node.new(node) } unless config['nodes'] == nil
+      config['node_groups'].each { |name, members| @node_groups << Onceover::Group.new(name, members) } unless config['node_groups'] == nil
+      config['class_groups'].each { |name, members| @class_groups << Onceover::Group.new(name, members) } unless config['class_groups'] == nil
+
+      @filter_tags      = opts[:tags] ? [opts[:tags].split(',')].flatten : nil
+      @filter_classes   = opts[:classes] ? [opts[:classes].split(',')].flatten.map {|x| Onceover::Class.find(x)} : nil
+      @filter_nodes     = opts[:nodes] ? [opts[:nodes].split(',')].flatten.map {|x| Onceover::Node.find(x)} : nil
+
+      config['test_matrix'].each do |test_hash|
+        test_hash.each do |machines, settings|
+          if settings['tests'] == 'spec'
+            @spec_tests << Onceover::Test.new(machines,settings['classes'],settings)
+          elsif settings['tests'] == 'acceptance'
+            @acceptance_tests << Onceover::Test.new(machines,settings['classes'],settings)
+          elsif settings['tests'] == 'all_tests'
+            tst = Onceover::Test.new(machines,settings['classes'],settings)
+            @spec_tests << tst
+            @acceptance_tests << tst
+          end
+        end
+      end
+    end
+
+    def self.find_list(thing)
+      # Takes a string and finds an object or list of objects to match, will
+      # take nodes, classes or groups
+
+      # We want to supress warnings for this bit
+      old_level = logger.level
+      logger.level = :error
+      if Onceover::Group.find(thing)
+        logger.level = old_level
+        return Onceover::Group.find(thing).members
+      elsif Onceover::Class.find(thing)
+        logger.level = old_level
+        return [Onceover::Class.find(thing)]
+      elsif Onceover::Node.find(thing)
+        logger.level = old_level
+        return [Onceover::Node.find(thing)]
+      else
+        logger.level = old_level
+        raise "Could not find #{thing} in list of classes, nodes or groups"
+      end
+    end
+
+    def verify_spec_test(controlrepo,test)
+      test.nodes.each do |node|
+        unless controlrepo.facts_files.any? { |file| file =~ /\/#{node.name}\.json/ }
+          raise "Could not find factset for node: #{node.name}"
+        end
+      end
+    end
+
+    def verify_acceptance_test(controlrepo,test)
+      require 'yaml'
+      nodeset = YAML.load_file(controlrepo.nodeset_file)
+      test.nodes.each do |node|
+        unless nodeset['HOSTS'].has_key?(node.name)
+          raise "Could not find nodeset for node: #{node.name}"
+        end
+      end
+    end
+
+    def pre_condition
+      # Read all the pre_conditions and return the string
+      spec_dir = Onceover::Controlrepo.new.spec_dir
+      puppetcode = []
+      Dir["#{spec_dir}/pre_conditions/*.pp"].each do |condition_file|
+        logger.debug "Reading pre_conditions from #{condition_file}"
+        puppetcode << File.read(condition_file)
+      end
+      return nil if puppetcode.count == 0
+      puppetcode.join("\n")
+    end
+
+    def r10k_deploy_local(repo = Onceover::Controlrepo.new)
+      require 'onceover/controlrepo'
+      require 'pathname'
+      if repo.tempdir == nil
+        repo.tempdir = Dir.mktmpdir('r10k')
+      else
+        logger.debug "Creating #{repo.tempdir}"
+        FileUtils.mkdir_p(repo.tempdir)
+      end
+
+      # We need to do the copy to a tempdir then move the tempdir to the
+      # destination, just in case we get a recursive copy
+      # TODO: Improve this to save I/O
+      logger.debug "Creating temp dir as a staging directory for copying the controlrepo to #{repo.tempdir}"
+      temp_controlrepo = Dir.mktmpdir('controlrepo')
+      FileUtils.cp_r(Dir["#{repo.root}/*"], "#{temp_controlrepo}")
+      FileUtils.mkdir_p("#{repo.tempdir}/#{repo.environmentpath}/production")
+      FileUtils.mv(Dir["#{temp_controlrepo}/*"], "#{repo.tempdir}/#{repo.environmentpath}/production",:force => true)
+      FileUtils.rm_rf(temp_controlrepo)
+
+      # Pull the trigger! If it's not already been pulled
+      if repo.tempdir
+        if File.directory?(repo.tempdir)
+          # TODO: Change this to call out to r10k directly to do this
+          # Probably something like:
+          # R10K::Settings.global_settings.evaluate(with_overrides)
+          # R10K::Action::Deploy::Environment
+          Dir.chdir("#{repo.tempdir}/#{repo.environmentpath}/production") do
+            logger.debug "Runing r10k puppetfile install --verbose from #{repo.tempdir}/#{repo.environmentpath}/production"
+            system("r10k puppetfile install --verbose --color")
+          end
+        else
+          raise "#{repo.tempdir} is not a directory"
+        end
+      end
+
+      # Return repo.tempdir for use
+      repo.tempdir
+    end
+
+    def write_spec_test(location, test)
+      # Use an ERB template to write a spec test
+      File.write("#{location}/#{test.to_s}_spec.rb",Onceover::Controlrepo.evaluate_template('test_spec.rb.erb',binding))
+    end
+
+    def write_acceptance_tests(location, tests)
+      File.write("#{location}/acceptance_spec.rb",Onceover::Controlrepo.evaluate_template('acceptance_test_spec.rb.erb',binding))
+    end
+
+    def write_spec_helper_acceptance(location, repo)
+      File.write("#{location}/spec_helper_acceptance.rb",Onceover::Controlrepo.evaluate_template('spec_helper_acceptance.rb.erb',binding))
+    end
+
+    def write_rakefile(location, pattern)
+      File.write("#{location}/Rakefile",Onceover::Controlrepo.evaluate_template('Rakefile.erb',binding))
+    end
+
+    def write_spec_helper(location, repo)
+      environmentpath = "#{repo.tempdir}/#{repo.environmentpath}"
+      modulepath = repo.config['modulepath']
+      modulepath.delete("$basemodulepath")
+      modulepath.map! do |path|
+        "#{environmentpath}/production/#{path}"
+      end
+      modulepath = modulepath.join(":")
+      repo.temp_modulepath = modulepath
+
+      # Use an ERB template to write a spec test
+      File.write("#{location}/spec_helper.rb",Onceover::Controlrepo.evaluate_template('spec_helper.rb.erb',binding))
+    end
+
+    def create_fixtures_symlinks(repo)
+      logger.debug "Creating fixtures symlinks"
+      FileUtils.rm_rf("#{repo.tempdir}/spec/fixtures/modules")
+      FileUtils.mkdir_p("#{repo.tempdir}/spec/fixtures/modules")
+      repo.temp_modulepath.split(':').each do |path|
+        Dir["#{path}/*"].each do |mod|
+          modulename = File.basename(mod)
+          logger.debug "Symlinking #{mod} to #{repo.tempdir}/spec/fixtures/modules/#{modulename}"
+          FileUtils.ln_s(mod, "#{repo.tempdir}/spec/fixtures/modules/#{modulename}")
+        end
+      end
+    end
+
+    def run_filters(tests)
+      # All of this needs to be applied AFTER deduplication but BEFORE writing
+      filters = {
+        'tags'    => @filter_tags,
+        'classes' => @filter_classes,
+        'nodes'   => @filter_nodes
+      }
+      filters.each do |method,filter_list|
+        if filter_list
+          # Remove tests that do not have matching tags
+          tests.keep_if do |test|
+            filter_list.any? do |filter|
+              if test.send(method)
+                test.send(method).include?(filter)
+              else
+                false
+              end
+            end
+          end
+        end
+      end
+      tests
+    end
+  end
+end

data/templates/.fixtures.yml.erb

@@ -0,0 +1,24 @@
+---
+fixtures:
+<% if symlinks.any? then -%>
+  symlinks:
+<% symlinks.each do |link| -%>
+    <%= link['name'] %>: <%= link['dir'] %>
+<% end -%>
+<% end -%>
+<% if repositories.any? then -%>
+  repositories:
+<% repositories.each do |repo| -%>
+    <%= repo['name'] %>:
+      repo: <%= repo['repo'] %>
+      ref: <%= repo['ref'] %>
+<% end -%>
+<% end -%>
+<% if forge_modules.any? then -%>
+  forge_modules:
+<% forge_modules.each do |mod| -%>
+    <%= mod['name'] %>:
+      repo: <%= mod['repo'] %>
+      ref: <%= mod['ref'] %>
+<% end -%>
+<% end -%>

data/templates/Rakefile.erb

@@ -0,0 +1,6 @@
+require 'puppetlabs_spec_helper/rake_tasks'
+
+desc "Run acceptance tests"
+RSpec::Core::RakeTask.new(:acceptance) do |t|
+  t.pattern = 'spec/acceptance'
+end

data/templates/acceptance_test_spec.rb.erb

@@ -0,0 +1,66 @@
+require 'spec_helper_acceptance'
+
+describe "Acceptance Testing" do
+  before :each do |test|
+    Onceover::Beaker.match_indentation(test,logger)
+  end
+<% tests.each do |test| -%>
+<% test.nodes.each do |node| -%>
+<% test.classes.each do |cls| -%>
+  describe "<%= cls.name %> on <%= node.name %>" do
+    after :all do
+      $host.down!
+    end
+
+    describe "provisioning <%= node.name %>" do
+      it "should be able to provision using Beaker" do
+        expect {
+          $host = Onceover::Beaker.host_create(:'<%= node.name %>',OPTIONS)
+        }.not_to raise_exception
+      end
+    end
+
+    describe "copying code to <%= node.name %>" do
+      it "should copy the code successfully" do
+        expect {
+          scp_to $host, 'etc', '/'
+        }.not_to raise_exception
+      end
+    end
+<% test.test_config['runs_before_idempotency'].times do %>
+    describe "running puppet" do
+      it "should run with no errors" do
+        expect {
+          manifest = <<CODE
+$controlrepo_accpetance = true
+
+<%= pre_condition %>
+
+include <%= cls.name %>
+CODE
+          apply_manifest_on($host,manifest,{:catch_failures => true})
+        }.not_to raise_exception
+      end
+    end
+<% end -%>
+<% if test.test_config['check_idempotency'] then %>
+    describe "checking for idempotency" do
+      it "should run with no changes" do
+        expect {
+          manifest = <<CODE
+$controlrepo_accpetance = true
+
+<%= pre_condition %>
+
+include <%= cls.name %>
+CODE
+          apply_manifest_on($host,manifest,{:catch_changes => true})
+        }.not_to raise_exception
+      end
+    end
+<% end -%>
+  end
+<% end -%>
+<% end -%>
+<% end -%>
+end

data/templates/controlrepo.yaml.erb

@@ -0,0 +1,38 @@
+# Classes to be tested
+classes:
+<% repo.roles.each do |role| -%>
+  - <%= role %>
+<% end -%>
+
+# Nodes to tests classes on, this refers to a 'factset' or 'nodeset'
+# depending on weather you are running 'spec' or 'acceptance' tests
+nodes:
+<% repo.facts_files.each do |file| -%>
+  - <%= File.basename(file,'.json') %>
+<% end -%>
+
+# You can group classes here to save typing
+class_groups:
+
+# You can group nodes here to save typing
+# We have created a 'non_windows_nodes' group because we can't
+# give you Windows vagrant boxes to test with because licensing,
+# we can give you fact sets though so go crazy with spec testing!
+node_groups:
+  windows_nodes:
+<% repo.facts_files.each do |file| -%>
+<% if File.basename(file,'.json') =~ /Windows/i -%>
+    - <%= File.basename(file,'.json') %>
+<% end -%>
+<% end -%>
+  non_windows_nodes:
+    include: 'all_nodes'
+    exclude: 'windows_nodes'
+
+test_matrix:
+  - all_nodes:
+      classes: 'all_classes'
+      tests: 'spec'
+  - non_windows_nodes: 
+      classes: 'all_classes'
+      tests: 'acceptance'

data/templates/factsets_README.md.erb

@@ -0,0 +1,7 @@
+# Factsets
+
+This directory is where we put any custom factsets that we want to use. They can be generated by running `puppet facts` on the target system.
+
+**Hot tip:** If you already have factsets in here when you run `onceover init` they will be picked up and added to the config file Automatically
+
+More info: https://github.com/dylanratcliffe/onceover#factsets

data/templates/nodeset.yaml.erb

@@ -0,0 +1,12 @@
+HOSTS:
+<% hosts_hash.each do |name, info| -%>
+<% if info[:comment_out] then prefix = '#' end-%>
+  <%= prefix %><%= name %>:
+  <%= prefix %>  roles:
+  <%= prefix %>    - agent
+  <%= prefix %>  type: aio
+  <%= prefix %>  platform: <%= info[:platform] %>
+  <%= prefix %>  box: <%= info[:boxname] %>
+  <%= prefix %>  box_url: <%= info[:url] %>
+  <%= prefix %>  hypervisor: vagrant_virtualbox
+<% end -%>

data/templates/pre_conditions_README.md.erb

@@ -0,0 +1,24 @@
+# Pre Conditions
+
+This folder should contain any \*.pp files that you want to be included in every test.
+
+A common use of this is defining resources that may not exist in the catalog when you are running tests. For example, if we are using a resource that tries to restart the `pe-puppetserver` service, unless it is compiled on a Puppet Maser the `pe-puppetserver` service will not exist and the catalog will fail to compile. To get around this we can create a .pp file and define the resource like so:
+
+``` puppet
+# We are not going to actually have this service anywhere on our servers but
+# our code needs to refresh it. This is to trick puppet into doing nothing
+service { 'pe-puppetserver':
+  ensure     => 'running',
+  enable     => false,
+  hasrestart => false, # Force Puppet to use start and stop to restart
+  start      => 'echo "Start"', # This will always exit 0
+  stop       => 'echo "Stop"', # This will also always exit 0
+  hasstatus  => false, # Force puppet to use our command for status
+  status     => 'echo "Status"', # This will always exit 0 and therefore Puppet will think the service is running
+  provider   => 'base',
+}
+```
+
+This will mean that the `pe-puppetserver` service is in the catalog for spec testing and will even allow you to try to restart it during acceptance tests without the service actually being present.
+
+More info: https://github.com/dylanratcliffe/onceover#using-workarounds

data/templates/spec_helper.rb.erb

@@ -0,0 +1,16 @@
+require 'puppetlabs_spec_helper/module_spec_helper'
+require 'rspec-puppet-utils'
+require 'rspec_junit_formatter'
+
+RSpec.configure do |c|
+  c.parser = 'future'
+  c.formatter = 'documentation'
+
+  # Also add JUnit output in case people want to use that
+  c.add_formatter('RSpecJUnitFormatter','<%= repo.tempdir %>/spec.xml')
+
+  c.environmentpath = '<%= environmentpath %>'
+  c.module_path = '<%= modulepath %>'
+  c.hiera_config = '<%= environmentpath %>/production/hiera.yaml'
+  c.manifest = '<%= repo.temp_manifest %>'
+end

data/templates/spec_helper_acceptance.rb.erb

@@ -0,0 +1 @@
+require 'onceover/beaker/spec_helper'

data/templates/test_spec.rb.erb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+<% test.classes.each do |cls| -%>
+describe "<%= cls.name %>" do
+
+<% if @mock_functions -%>
+<% @mock_functions.each do |function,params| -%>
+<% if params['type'] == 'statement' -%>
+MockFunction.new('<%= function %>', {:type => :statement})
+<% else -%>
+let!(:<%= function %>) { MockFunction.new('<%= function %>') { |f|
+    f.stubbed.returns(<%= params['returns'] %>)
+  }
+}
+<% end -%>
+
+<% end -%>
+<% end -%>
+<% test.nodes.each do |node| -%>
+  context "using fact set <%= node.name %>" do
+    let(:facts) { <%= node.fact_set %> }
+<% if pre_condition -%>
+    let(:pre_condition) {
+      pp = <<END
+<%= pre_condition.chomp %>
+END
+    }
+<% end -%>
+    it { should compile }
+  end
+<% end -%>
+end
+
+<% end -%>