onceover 3.17.0 → 3.17.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68843ce722d5b55114b8497d3cfa6044d062e1623d4580d12a0171d6e6f835f2
-  data.tar.gz: 1cbd81319ab148ecb755218149c674a144de07abf533d8ea569a305b0f23e8f7
+  metadata.gz: e6886259693e386c10aaebdd590be798363b38e823e4d7eb266d4f32f303cf2a
+  data.tar.gz: afdcc34051329c3a584803af4164f42aef9d2ac22e37bf14a35546f5ed8f45e3
 SHA512:
-  metadata.gz: a9a9acaee5e37f28ae398e5ed191ef879b8dcaed21f8483b0712bfb126ee18514caa517f4feb3984d6136ed9b35fe27c2e8577d5de0ab91a86bc8c95b3506399
-  data.tar.gz: 941c9fc0533641f3f74a5daa1806ebd9e72116ff5ed01d10b5dce7641990f573e07b14072a8d4693da4ac086695830f196a5a6d4a757b5843aae8ecfe7bd7ecc
+  metadata.gz: 6f5b35dfa27bf5b8e6477ffcd3ea985935698d0562cc55ab679e80c501ce15ecb17deb47c81dc276e4bc8634662be7354b0578a122f3258f6f5cb8f00a43dcb5
+  data.tar.gz: 68c7771cfadc3ef7d9e43569e06e4ce40288a07db464eeaffc4c67b95558dab7b3c76f4e88dcb62ef82f02baf3e8ac13bc17cb988ead6164d96a05e43ef25ebd

data/README.md

@@ -4,7 +4,7 @@
 
 Onceover is a tool to automatically run basic tests on an entire Puppet controlrepo. It includes automatic parsing of the `Puppetfile`, `environment.conf` and others in order to stop silly mistakes ever reaching your Puppet Master!
 
-**🍺🥳 New in v3.16.0: Multi-threaded module downloads!! See [r10k config](#r10k-config) to enable**
+**🍺🥳 New in v3.17.1: Heaps more Windows fixes! Windows code is now more likely to compile on Non-Windows.**
 
 ## Table of Contents
 

data/features/step_definitions/common.rb

@@ -37,6 +37,17 @@ When(/^I run onceover command "([^"]*)" with class "([^"]*)"$/)  do |command, cl
   @cmd.run
 end
 
+# The below can be used to skip tests if they only work on one os
+When(/^test osfamily is "(\w*)"$/) do |osfamily|
+  require 'facter'
+  pending unless Facter.value(:os)['family'] == osfamily
+end
+
+When(/^test osfamily is not "(\w*)"$/) do |osfamily|
+  require 'facter'
+  pending if Facter.value(:os)['family'] == osfamily
+end
+
 Then(/^I see help for commands: "([^"]*)"$/) do |commands|
   # Get chunk of output between COMMANDS and OPTION, there should be help section
   commands_help = @cmd.output[/COMMANDS(.*)OPTIONS/m, 1]

data/features/windows.feature

@@ -0,0 +1,30 @@
+@windows
+Feature: Run onceover with windows 
+  Onceover should allow to run rspec and acceptance test for all profvile and role classes
+  or for any part of them. Use should set if he wants to see only summary of tests or full
+  log info.
+
+  Background:
+    Given onceover executable
+
+  Scenario: Run with common Windows code
+    Given control repo "windows"
+    When I run onceover command "run spec" with class "role::users"
+    Then I should not see any errors
+
+  Scenario: Run with common Windows code without workarounds
+    Given existing control repo "windows"
+    When I run onceover command "run spec --no_workarounds" with class "role::users"
+    And test osfamily is not "windows"
+    Then Onceover should exit 1
+
+  Scenario: Compiling a windows role with groups that is valid should compile
+    Given control repo "windows"
+    When I run onceover command "run spec" with class "role::groups"
+    Then I should not see any errors
+  
+  Scenario: Compiling a windows role with users that is valid should compile
+    Given control repo "windows"
+    When I run onceover command "run spec" with class "role::users"
+    Then I should not see any errors
+  

data/lib/onceover/cli/run.rb

@@ -42,6 +42,7 @@ This includes deploying using r10k and running all custom tests.
 
             optional :p, :parallel, 'Runs spec tests in parallel. This increases speed at the cost of poorly formatted logs and irrelevant junit output.'
             optional nil, :format, 'Which RSpec formatter to use, valid options are: documentation, progress, FailureCollector, OnceoverFormatter. You also specify this multiple times', multiple: true, default: :defaults
+            optional nil, :no_workarounds, 'Disables workarounds that have been added for convenience to get around common RSPec issues such as https://github.com/rodjek/rspec-puppet/issues/665'
 
             run do |opts, args, cmd|
               repo = Onceover::Controlrepo.new(opts)

data/lib/onceover/runner.rb

@@ -87,10 +87,11 @@ class Onceover
         #`bin/rake spec_standalone`
         if @config.opts[:parallel]
           logger.debug "Running #{@command_prefix}rake parallel_spec from #{@repo.tempdir}"
-          result = Backticks::Runner.new(interactive:true).run(@command_prefix.strip.split, 'rake', 'parallel_spec').join
+          result = run_command(@command_prefix.strip.split, 'rake', 'parallel_spec')
         else
+          require 'io/console'
           logger.debug "Running #{@command_prefix}rake spec_standalone from #{@repo.tempdir}"
-          result = Backticks::Runner.new(interactive:true).run(@command_prefix.strip.split, 'rake', 'spec_standalone').join
+          result = run_command(@command_prefix.strip.split, 'rake', 'spec_standalone')
         end
 
         # Reset env to previous state if we modified it
@@ -117,11 +118,20 @@ class Onceover
         #`bundle install --binstubs`
         #`bin/rake spec_standalone`
         logger.debug "Running #{@command_prefix}rake acceptance from #{@repo.tempdir}"
-        result = Backticks::Runner.new(interactive:true).run(@command_prefix.strip.split, 'rake', 'acceptance').join
+        result = run_command(@command_prefix.strip.split, 'rake', 'acceptance')
       end
 
       # Finally exit and preserve the exit code
       exit result.status.exitstatus
     end
+
+    def run_command(*args)
+      begin
+        STDERR.raw! if STDERR.isatty
+        result = Backticks::Runner.new(interactive: true).run(args.flatten).join
+      ensure
+        STDERR.cooked! if STDERR.isatty
+      end
+    end
   end
 end

data/lib/onceover/testconfig.rb

@@ -47,7 +47,7 @@ class Onceover
       @acceptance_tests  = []
       @opts              = opts
       @mock_functions    = config['functions']
-      @before_conditions = config['before']
+      @before_conditions = config['before'] || []
       @after_conditions  = config['after']
       @strict_variables  = opts[:strict_variables] ? 'yes' : 'no'
       

data/onceover.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "onceover"
-  s.version     = "3.17.0"
+  s.version     = "3.17.1"
   s.authors     = ["Dylan Ratcliffe"]
   s.email       = ["dylan.ratcliffe@puppet.com"]
   s.homepage    = "https://github.com/dylanratcliffe/onceover"

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,3 @@
+forge "http://forge.puppetlabs.com"
+
+mod 'puppetlabs-acl', '3.1.1'

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

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

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/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/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/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/templates/test_spec.rb.erb

@@ -29,6 +29,7 @@ describe "<%= cls.name %>" do
     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
@@ -41,7 +42,66 @@ describe "<%= cls.name %>" do
       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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: onceover
 version: !ruby/object:Gem::Version
-  version: 3.17.0
+  version: 3.17.1
 platform: ruby
 authors:
 - Dylan Ratcliffe
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-04 00:00:00.000000000 Z
+date: 2020-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backticks
@@ -310,7 +310,6 @@ files:
 - features/formatting.feature
 - features/help.feature
 - features/init.feature
-- features/run.feature
 - features/show.feature
 - features/step_definitions/cache.rb
 - features/step_definitions/common.rb
@@ -321,6 +320,8 @@ files:
 - features/support/command_helper.rb
 - features/support/controlrepo_helper.rb
 - features/support/env.rb
+- features/windows.feature
+- features/zzz_run.feature
 - lib/onceover/beaker.rb
 - lib/onceover/beaker/spec_helper.rb
 - lib/onceover/class.rb
@@ -389,6 +390,15 @@ files:
 - spec/fixtures/controlrepos/function_mocking/site/role/manifests/test_new_functions.pp
 - spec/fixtures/controlrepos/function_mocking/spec/onceover.yaml
 - spec/fixtures/controlrepos/minimal/environment.conf
+- spec/fixtures/controlrepos/windows/Gemfile
+- spec/fixtures/controlrepos/windows/Puppetfile
+- spec/fixtures/controlrepos/windows/environment.conf
+- spec/fixtures/controlrepos/windows/site-modules/role/manifests/acl.pp
+- spec/fixtures/controlrepos/windows/site-modules/role/manifests/groups.pp
+- spec/fixtures/controlrepos/windows/site-modules/role/manifests/users.pp
+- spec/fixtures/controlrepos/windows/site/role/manifests/groups.pp
+- spec/fixtures/controlrepos/windows/site/role/manifests/users.pp
+- spec/fixtures/controlrepos/windows/spec/onceover.yaml
 - spec/onceover/controlrepo_spec.rb
 - spec/spec_helper.rb
 - templates/.fixtures.yml.erb
@@ -408,7 +418,7 @@ homepage: https://github.com/dylanratcliffe/onceover
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -423,8 +433,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.7.6.2
+signing_key:
 specification_version: 4
 summary: Testing tools for Puppet controlrepos
 test_files: []