puppetbox 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 393f46fa2e8abcca2e2fd278c4c4732af09ba444
-  data.tar.gz: 7dc52e48c12005dff1122fa6f900064f86b8bf16
+  metadata.gz: 6e98bf1892a07fa686429fd852a495629ebfde34
+  data.tar.gz: 34175eff6de51aefee73c7e22af3168ba131311c
 SHA512:
-  metadata.gz: cb725f0228784ae8560c4f0de5a7bad886a1fa7a205c8c9185f9431240e8ffe3f98b5335d01c6bb3064b56d7200feddab0683bdfb7683ea673504a2a889e6938
-  data.tar.gz: 45bae316cd000af9dc4f5b4a7936bdd10c58d56037181b80305148e0afec2387aa8e53d262710a550d37ac7ce61ce0fc3eb4d3c717316207e2cf835446095ebd
+  metadata.gz: b556b35aecb7a91ef65c2a34b9ce4e3e10ee6ec5fdf4354ed9e0e09461af5f8970b91405fef116aac92b429238e9afed998b92d6f98fad3fac23cbe871b04fbc
+  data.tar.gz: ce27a46a8dc3629fc82b60db99627a94433f160b2427d096c82d94af3b4626d39b383ce967b676e0491ebf28242f7958bfd84f4884bbb9755afba05a22b7665d

data/lib/puppetbox/driver/vagrant.rb

@@ -8,7 +8,9 @@ module PuppetBox
     class Vagrant
       WORKING_DIR_VAGRANT   = "vagrant"
       PUPPET_CODE_MOUNT     = "/etc/puppetlabs/code/environments/production"
-      SPEC_ACCEPTANCE_MOUNT = "spec/acceptance:/acceptance"
+
+      # mount spec/accpetance into the same directory name inside the VM for simplicity
+      SPEC_ACCEPTANCE_MOUNT = "spec/acceptance:/spec/acceptance"
 
       def node_name
         @name
@@ -97,6 +99,33 @@ module PuppetBox
         self_test
       end
 
+      # Run a script on the VM by name.  We pass in the script name and are able
+      # to run because the ./spec/acceptance directory is mounted inside the VM
+      #
+      # We can figure out windows/linux scripts based on the filename too
+      def run_setup_script(script_file)
+
+        if script_file =~ /.ps1$/
+          # powershell - not supported yet
+          raise("Windows not supported yet https://github.com/GeoffWilliams/puppetbox/issues/3")
+        else
+          # force absolute path
+          script_file = "/#{script_file}"
+
+          @logger.info("Running setup script #{script_file} on #{@name}")
+          status_code, messages = @vm.run("sudo -i #{script_file}")
+          status = (status_code == 0)
+          if status
+            @logger.info("setup script #{script_file} executed successfully")
+          else
+            # our tests are fubar if any setup script failed
+            message = messages.join("\n")
+            raise("setup script #{script_file} failed on #{node_name}:  #{message}")
+          end
+        end
+        status
+      end
+
       def run_puppet_x2(puppet_class)
         # if you need to link a module into puppet's modulepath either do it
         # before running puppet (yet to be supported) or use the @config hash

data/lib/puppetbox/puppetbox.rb

@@ -7,7 +7,10 @@ require "puppetbox/report"
 module PuppetBox
   class PuppetBox
 
-    WORKING_DIR = File.join(Dir.home, '.puppetbox')
+    WORKING_DIR         = File.join(Dir.home, '.puppetbox')
+    ACCEPTANCE_TEST_DIR = "spec/acceptance"
+    ACCEPTANCE_DEFAULT  = "__ALL__"
+    SETUP_SCRIPT_GLOB   = "setup.*"
 
     def initialize(logger:nil, nodeset_file: nil, working_dir: nil)
       # The results of all tests on all driver instances
@@ -101,6 +104,57 @@ module PuppetBox
       @result_set.passed?
     end
 
+    # Sometimes you need to run a script before running a class, or just on
+    # particular host(s).  Check for the presence of a bash or powershell script
+    # and execute it on the system under test.  If there is an error fail all
+    # tests immediately since it means our test setup is invalid.
+    #
+    # Naming convention/example:
+    # └── SLES-12.1-64
+    #    ├── __ALL__
+    #    │   └── setup.sh
+    #    └── role__puppet__master
+    #        └── setup.sh
+    #
+    def setup_test(driver_instance, puppet_class)
+      script_filename_base = File.join(ACCEPTANCE_TEST_DIR, driver_instance.node_name)
+
+      # 1st choice - exact match on classname (with :: converted to __)
+      script_filename_class = File.join(
+        script_filename_base,
+        puppet_class.gsub(/::/,'__'),
+        SETUP_SCRIPT_GLOB
+      )
+      found = Dir.glob(script_filename_class)
+      if found.any?
+        script_target = found[0]
+      else
+        # 2nd choice - the __ALL__ directory
+        script_filename_default = File.join(
+          script_filename_base,
+          ACCEPTANCE_DEFAULT,
+          SETUP_SCRIPT_GLOB
+        )
+        found = Dir.glob(script_filename_default)
+        if found.any?
+          @logger.info(
+            "Using setup script from #{script_filename_default} on "\
+            "#{driver_instance.node_name} for #{puppet_class}, create "\
+            "#{script_filename_class} to override")
+          script_target = found[0]
+        else
+          script_target = false
+          @logger.info(
+            "No setup scripts found for #{driver_instance.node_name} and "\
+            "#{puppet_class} create #{script_filename_default} or "\
+            "#{script_filename_class} if required")
+        end
+      end
+      if script_target
+        driver_instance.run_setup_script(script_target)
+      end
+    end
+
     # Run puppet using `driver_instance` to execute
     def run_puppet(driver_instance, puppet_classes, logger:nil, reset_after_run:true)
       # use supplied logger in preference to the default puppetbox logger instance
@@ -118,6 +172,7 @@ module PuppetBox
               # per class on the self-test which we now know will succeed
               driver_instance.reset
             end
+            setup_test(driver_instance, puppet_class)
             logger.info("running test #{driver_instance.node_name} - #{puppet_class}")
             driver_instance.run_puppet_x2(puppet_class)
             @result_set.save(driver_instance.node_name, puppet_class, driver_instance.result)

data/lib/puppetbox/version.rb

@@ -1,3 +1,3 @@
 module PuppetBox
-  VERSION = "0.4.0"
+  VERSION = "0.4.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puppetbox
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Geoff Williams