puppetlabs-onceover 5.0.3

data/spec/fixtures/controlrepos/vendored/spec/vendored_modules/sshkeys_core-puppet_agent-8.6.0.json

@@ -0,0 +1 @@
+[{"name":"v2.5.0"}]

data/spec/fixtures/controlrepos/vendored/spec/vendored_modules/yumrepo_core-puppet_agent-7.30.0.json

@@ -0,0 +1 @@
+[{"name":"v1.2.0"}]

data/spec/fixtures/controlrepos/vendored/spec/vendored_modules/yumrepo_core-puppet_agent-8.6.0.json

@@ -0,0 +1 @@
+[{"name":"v2.1.0"}]

data/spec/fixtures/controlrepos/vendored/spec/vendored_modules/zfs_core-puppet_agent-7.30.0.json

@@ -0,0 +1 @@
+[{"name":"v1.5.0"}]

data/spec/fixtures/controlrepos/vendored/spec/vendored_modules/zfs_core-puppet_agent-8.6.0.json

@@ -0,0 +1 @@
+[{"name":"v1.5.0"}]

data/spec/fixtures/controlrepos/vendored/spec/vendored_modules/zone_core-puppet_agent-7.30.0.json

@@ -0,0 +1 @@
+[{"name":"v1.2.0"}]

data/spec/fixtures/controlrepos/vendored/spec/vendored_modules/zone_core-puppet_agent-8.6.0.json

@@ -0,0 +1 @@
+[{"name":"v1.2.0"}]

data/spec/fixtures/controlrepos/windows/Gemfile

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

data/spec/fixtures/controlrepos/windows/Puppetfile

@@ -0,0 +1,8 @@
+forge "http://forge.puppetlabs.com"
+
+mod 'puppetlabs-acl', '3.2.1'
+mod 'puppetlabs-chocolatey', '5.2.0'
+mod 'puppetlabs-stdlib', '6.5.0'
+mod 'puppetlabs-powershell', '4.1.0'
+mod 'puppetlabs-pwshlib', '0.6.3'
+mod 'puppetlabs-registry', '3.2.0'

data/spec/fixtures/controlrepos/windows/environment.conf

@@ -0,0 +1 @@
+modulepath = site-modules:modules:$basemodulepath

data/spec/fixtures/controlrepos/windows/site/role/manifests/groups.pp

@@ -0,0 +1,8 @@
+# Class: role::groups
+#
+#
+class role::groups {
+  group {'Administrators':
+    members => ['foo'],
+  }
+}

data/spec/fixtures/controlrepos/windows/site/role/manifests/users.pp

@@ -0,0 +1,9 @@
+# Class: role::users
+#
+#
+class role::users {
+  user { 'dylan':
+    ensure => 'present',
+    groups => ['Administrators'],
+  }
+}

data/spec/fixtures/controlrepos/windows/site-modules/role/manifests/acl.pp

@@ -0,0 +1,12 @@
+class role::acl {
+  # ACL often causes failures such as this:
+  # https://github.com/rodjek/rspec-puppet/issues/665
+  #
+  # Onceover should handle this out of the box
+  acl { 'L:\\SQLBackup':
+    inherit_parent_permissions => false,
+    permissions                => [
+      { 'identity' => 'foo', 'rights' => ['read'] }
+    ],
+  }
+}

data/spec/fixtures/controlrepos/windows/site-modules/role/manifests/choco.pp

@@ -0,0 +1,9 @@
+# Choco
+class role::choco {
+  include ::chocolatey
+
+  package { 'winzip':
+    ensure   => 'present',
+    provider => 'chocolatey',
+  }
+}

data/spec/fixtures/controlrepos/windows/site-modules/role/manifests/groups.pp

@@ -0,0 +1,8 @@
+# Class: role::groups
+#
+#
+class role::groups {
+  group {'Administrators':
+    members => ['foo'],
+  }
+}

data/spec/fixtures/controlrepos/windows/site-modules/role/manifests/users.pp

@@ -0,0 +1,9 @@
+# Class: role::users
+#
+#
+class role::users {
+  user { 'dylan':
+    ensure => 'present',
+    groups => ['Administrators'],
+  }
+}

data/spec/fixtures/controlrepos/windows/spec/onceover.yaml

@@ -0,0 +1,24 @@
+# Classes to be tested
+classes:
+  - /role::/
+
+# Nodes to tests classes on, this refers to a 'factset' or 'nodeset'
+# depending on whether you are running 'spec' or 'acceptance' tests
+nodes:
+  - Windows_Server-2012r2-64
+  - windows-10-64
+  - Windows_Server-2008r2-64
+
+# 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:
+
+test_matrix:
+  - all_nodes:
+      classes: "all_classes"
+      tests: "spec"

data/spec/puppetlabs-onceover/controlrepo_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+require 'puppetlabs-onceover/controlrepo'
+
+describe "PuppetlabsOnceover::Controlrepo" do
+  context "in a barebones controlrepo" do
+    before do
+      @repo = PuppetlabsOnceover::Controlrepo.new(
+        {
+          path: 'spec/fixtures/controlrepos/minimal'
+        }
+      )
+    end
+
+    context "without hiera.yaml" do
+      it { expect(@repo.hiera_config_file_relative_path).to be_nil }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require "rspec"
+
+RSpec.configure do |config|
+  config.raise_errors_for_deprecations!
+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/Gemfile.erb

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

data/templates/Rakefile.erb

@@ -0,0 +1 @@
+require 'puppetlabs-onceover/rake_tasks'

data/templates/acceptance_test_spec.rb.erb

@@ -0,0 +1,66 @@
+require 'spec_helper_acceptance'
+
+describe "Acceptance Testing" do
+  before :each do |test|
+    PuppetlabsOnceover::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 = PuppetlabsOnceover::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 whether 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/error_summary.yaml.erb

@@ -0,0 +1,17 @@
+<%= bold(name) %>: <%= red('failed') %>
+  errors:
+<% errors.each do |error| -%>
+    <%= red(error[:text]) %>
+<% if error[:file] -%>
+      file: <%= bold(error[:file]) %>
+<% end -%>
+<% if error[:line] -%>
+      line: <%= bold(error[:line]) %>
+<% end -%>
+<% if error[:column] -%>
+      column: <%= bold(error[:column]) %>
+<% end -%>
+<% if error[:factsets] -%>
+      factsets: <%= bold(error[:factsets].join(', ')) %>
+<% end -%>
+<% end -%>

data/templates/factsets_README.md.erb

@@ -0,0 +1,10 @@
+# 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.
+
+If you are using Trusted Facts or Trusted External Data see: <https://github.com/voxpupuli/onceover#factsets>
+
+**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/voxpupuli/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/voxpupuli/onceover#using-workarounds

data/templates/spec_helper.rb.erb

@@ -0,0 +1,35 @@
+RSpec.configure do |c|
+  c.mock_with :rspec
+end
+
+require 'rspec_junit_formatter'
+require 'puppetlabs-onceover/rspec/formatters'
+
+RSpec.configure do |c|
+  # Create onceover settings to be accessed by formatters
+  c.add_setting :onceover_tempdir
+  c.add_setting :onceover_root
+  c.add_setting :onceover_environmentpath
+
+  c.onceover_tempdir         = <%= repo.tempdir.inspect %>
+  c.onceover_root            = <%= repo.root.inspect %>
+  c.onceover_environmentpath = <%= repo.environmentpath.inspect %>
+
+  # Also add JUnit output in case people want to use that
+  c.add_formatter('RSpecJUnitFormatter','<%= repo.tempdir %>/spec.xml')
+
+<% @formatters.each do |fm| -%>
+  c.formatter             = '<%= fm %>'
+<% end -%>
+  c.environmentpath       = '<%= environmentpath %>'
+  c.module_path           = '<%= modulepath %>'
+<% if repo.hiera_config_file_relative_path %>
+  c.hiera_config          = '<%= environmentpath %>/production/<%= repo.hiera_config_file_relative_path %>'
+<% end -%>
+  c.manifest              = '<%= repo.temp_manifest %>'
+  ENV['STRICT_VARIABLES'] = '<%= self.strict_variables %>'
+<% if ENV['SHOW_PUPPET_OUTPUT'] and ENV['SHOW_PUPPET_OUTPUT'].downcase == 'true' %>
+  Puppet::Util::Log.level = :debug
+  Puppet::Util::Log.newdestination(:console)
+<% end -%>
+end

data/templates/spec_helper_acceptance.rb.erb

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

data/templates/test_spec.rb.erb

@@ -0,0 +1,150 @@
+require 'spec_helper'
+
+<% test.classes.each do |cls| -%>
+describe "<%= cls.name %>"<%= test.tags.map { |tag| ",#{tag}: true "}.join %> do
+
+<% test.nodes.each do |node| -%>
+  context "using fact set <%= node.name %>" do
+    node_facts = <%= node.fact_set %>
+    let(:facts) { node_facts }
+<% if node.trusted_set -%>
+    trusted_facts = <%= node.trusted_set %>
+    let(:trusted_facts) { trusted_facts }
+  <% if node.trusted_set['certname'] -%>
+    let(:node) { "<%= node.trusted_set['certname'] %>" }
+  <% end -%>
+<% end -%>
+<% if node.trusted_external_set -%>
+    trusted_external_data = <%= node.trusted_external_set %>
+    let(:trusted_external_data) { trusted_external_data }
+<% end -%>
+<% if @before_conditions -%>
+    before :each do
+<% @before_conditions.each do |function| -%>
+      <%= function %>
+<% end -%>
+    end
+<% end -%>
+
+<% if @mock_functions -%>
+    # Create a from_json function so that we can parse the output of json for mocked functions
+    before :each do
+      Puppet::Parser::Functions.newfunction(:from_json, :type => :rvalue) { |args|
+          require 'multi_json'
+          MultiJson.load(args[0])
+        }
+    end
+<% end -%>
+
+<% unless opts[:no_workarounds] -%>
+    before :each do
+      # Curtrently there is some code within Puppet that will try to execute
+      # commands when compiling a catalog even though it shouldn't. One example is
+      # the groups attribute of the user resource on AIX. If we are running on
+      # Windows but pretending to be UNIX this will definitely fail so we need to
+      # mock it (or vice versa)
+      # Details:
+      # https://github.com/puppetlabs/puppet/blob/master/lib/puppet/util/execution.rb#L191
+      expected_null_file = Puppet::Util::Platform.windows? ? 'NUL' : '/dev/null'
+      unless File.exist? expected_null_file
+        allow(Puppet::Util::Execution).to receive(:execute).and_raise(Puppet::ExecutionFailure.new("Onceover caused this"))
+      end
+
+      # The windows ACL module causes issues when compiled on other platforms
+      # These are detailed in the following ticket:
+      #   https://github.com/rodjek/rspec-puppet/issues/665
+      #
+      # The below should work around this common issue
+      if Puppet::Type.type(:acl)
+        allow_any_instance_of(Puppet::Type.type(:acl).provider(:windows)).to receive(:validate)
+        allow_any_instance_of(Puppet::Type.type(:acl).provider(:windows)).to receive(:respond_to?).with(:get_account_name).and_return(false)
+        allow_any_instance_of(Puppet::Type.type(:acl).provider(:windows)).to receive(:respond_to?).with(:get_group_name).and_return(false)
+        allow_any_instance_of(Puppet::Type.type(:acl).provider(:windows)).to receive(:respond_to?).with(:validate).and_return(true)
+      end
+
+      # The windows_adsi provider also has an issue where the contructor takes
+      # a different number of arguments depending on whether the ADSI
+      # underlying connectivity exists. This causes the following error:
+      #
+      #      wrong number of arguments (given 1, expected 0)
+      #
+      # This fixes that if we aren't using Windows
+      begin
+        # Test to see if this works without modification
+        require 'puppet/util/windows'
+        require 'puppet/util/windows/adsi'
+        Puppet::Util::Windows::ADSI.computer_name
+      rescue LoadError, StandardError
+        # Declare an entire mocked module because for some reason we can't load it unless we are on Windows
+        module Puppet::Util::Windows
+          module ADSI
+            class ADSIObject; end
+            class User < ADSIObject; end
+            class UserProfile; end
+            class Group < ADSIObject; end
+          end
+          module File; end
+          module Registry
+          end
+          module SID
+            class Principal; end
+          end
+          class EventLog; end
+        end
+
+        # Mock commonly used things
+        allow(Puppet::Util::Windows::SID).to receive(:name_to_sid).and_return('S-1-5-32-544')
+        allow(Puppet::Util::Windows::SID).to receive(:name_to_principal).and_return(nil)
+        
+        allow_any_instance_of(Puppet::Util::Windows::ADSI::User).to receive(:initialize)
+        allow_any_instance_of(Puppet::Util::Windows::ADSI::User).to receive(:groups).and_return([])
+        allow_any_instance_of(Puppet::Util::Windows::ADSI::User).to receive(:name_sid_hash).and_return({})
+
+        # Group instance methods
+        allow_any_instance_of(Puppet::Util::Windows::ADSI::Group).to receive(:members).and_return([])
+        allow_any_instance_of(Puppet::Util::Windows::ADSI::Group).to receive(:members_sids).and_return([])
+        
+        # Class methods
+        allow(Puppet::Util::Windows::ADSI::Group).to receive(:name_sid_hash).and_return({})
+      end
+    end
+<% end -%>
+
+<% if @after_conditions -%>
+    after :each do
+<% @after_conditions.each do |function| -%>
+      <%= function %>
+<% end -%>
+    end
+<% end -%>
+    let(:pre_condition) {
+      pp = <%= '<<' %>-'END'
+$onceover_class = '<%= cls.name %>'
+$onceover_node  = '<%= node.name %>'
+
+# Begin user-specified pre_condition
+<%= (pre_condition || "").chomp %>
+# End user-specified pre_condition
+
+<% if @mock_functions -%>
+<% require 'multi_json' -%>
+# Mocking functions
+<% @mock_functions.each do |function,params| -%>
+<% if params['returns'].is_a? String -%>
+<%   json = params['returns'].dump[1..-2].to_json -%>
+<% else -%>
+<%   json = params['returns'].to_json -%>
+<% end -%>
+function <%= function %> (*$args) { from_json('<%= json %>') }
+<% end -%>
+<% end -%>
+
+END
+    }
+
+    it { should compile }
+  end
+<% end -%>
+end
+
+<% end -%>

data/templates/testconfig_Rakefile.erb

@@ -0,0 +1,47 @@
+require 'rspec/core/rake_task'
+require 'parallel_tests/cli'
+
+desc "Run acceptance tests"
+RSpec::Core::RakeTask.new(:acceptance) do |t|
+  t.pattern = 'spec/acceptance'
+end
+
+# https://github.com/puppetlabs/puppetlabs_spec_helper/blob/main/lib/puppetlabs_spec_helper/rake_tasks.rb#L48
+pattern = 'spec/{aliases,classes,defines,functions,hosts,integration,plans,tasks,type_aliases,types,unit}/**/*_spec.rb'
+
+# https://github.com/puppetlabs/puppetlabs_spec_helper/blob/main/lib/puppetlabs_spec_helper/rake_tasks.rb#L50-L72
+RSpec::Core::RakeTask.new('spec:standalone') do |t, args|
+  t.rspec_opts = []
+  t.rspec_opts << ENV['CI_SPEC_OPTIONS'] unless ENV['CI_SPEC_OPTIONS'].nil?
+  if ENV['CI_NODE_TOTAL'] && ENV['CI_NODE_INDEX']
+    ci_total = ENV['CI_NODE_TOTAL'].to_i
+    ci_index = ENV['CI_NODE_INDEX'].to_i
+    raise "CI_NODE_INDEX must be between 1-#{ci_total}" unless ci_index >= 1 && ci_index <= ci_total
+
+    files = Rake::FileList[pattern].to_a
+    per_node = (files.size / ci_total.to_f).ceil
+    t.pattern = if args.extras.nil? || args.extras.empty?
+                  files.each_slice(per_node).to_a[ci_index - 1] || files.first
+                else
+                  args.extras.join(',')
+                end
+  else
+    t.pattern = if args.extras.nil? || args.extras.empty?
+                  pattern
+                else
+                  args.extras.join(',')
+                end
+  end
+end
+
+desc 'Run spec tests in parallel'
+task :parallel_spec do |_t, args|
+  file_list = Rake::FileList[pattern].to_a
+  if file_list.empty?
+    warn 'No files for parallel_spec to run against'
+  else
+    ci_opts = ENV['CI_SPEC_OPTIONS'].to_s.strip.split
+    cli_args = ['--type', 'rspec', '--', '--format', 'progress'] + ci_opts + ['--'] + file_list
+    ParallelTests::CLI.new.run(cli_args)
+  end
+end