puppetbox 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6e98bf1892a07fa686429fd852a495629ebfde34
-  data.tar.gz: 34175eff6de51aefee73c7e22af3168ba131311c
+  metadata.gz: bd53bc360e5558df6c0eb16ffce3ab13b0d21e48
+  data.tar.gz: 120393a564d129bf93a89bc35d378c6ec830dd04
 SHA512:
-  metadata.gz: b556b35aecb7a91ef65c2a34b9ce4e3e10ee6ec5fdf4354ed9e0e09461af5f8970b91405fef116aac92b429238e9afed998b92d6f98fad3fac23cbe871b04fbc
-  data.tar.gz: ce27a46a8dc3629fc82b60db99627a94433f160b2427d096c82d94af3b4626d39b383ce967b676e0491ebf28242f7958bfd84f4884bbb9755afba05a22b7665d
+  metadata.gz: dd0bcf8e48b6c0451de2aec7c73b4d4e0acba8418c3ad0945cbd7af20efec1c5fa9f51006a15929c2dd979728dec9c0040038400019b42690143da2831122310
+  data.tar.gz: 7fe318dc03b0a0e61c78509ebc014af8d8869cfc19bd858521295ad1dee8f026c44a2d5c31b16b584e6fb51e40a775db8abdb62f173ed82eaba77b71d5632e02

data/lib/puppetbox/driver/vagrant.rb

@@ -9,8 +9,11 @@ module PuppetBox
       WORKING_DIR_VAGRANT   = "vagrant"
       PUPPET_CODE_MOUNT     = "/etc/puppetlabs/code/environments/production"
 
-      # mount spec/accpetance into the same directory name inside the VM for simplicity
-      SPEC_ACCEPTANCE_MOUNT = "spec/acceptance:/spec/acceptance"
+      # mount spec/ into the same directory name inside the VM for simplicity -
+      # now we can easility access fixtures, tests, etc
+      SPEC_ACCEPTANCE_MOUNT = "spec:/spec"
+
+      PUPPET_TESTCASE_DIR   = "/testcase"
 
       def node_name
         @name
@@ -18,15 +21,17 @@ module PuppetBox
 
       def initialize(name, codedir, config, keep_vm:false, working_dir:nil, logger: nil)
 
-        @name         = name
-        @keep_vm      = keep_vm
-        @working_dir  = File.join((working_dir || PuppetBox::WORKING_DIR), WORKING_DIR_VAGRANT)
-        @config       = config
-        @result       = Result.new
-        @logger       = Logger.new(logger).logger
+        @name           = name
+        @keep_vm        = keep_vm
+        @working_dir    = working_dir || PuppetBox::WORKING_DIR
+        @vagrant_vm_dir = File.join(@working_dir, WORKING_DIR_VAGRANT)
+        @testcase_dir   = File.join(@working_dir, PUPPET_TESTCASE_DIR)
+        @config         = config
+        @result         = Result.new
+        @logger         = Logger.new(logger).logger
 
         # setup the instance
-        @vom = Vagrantomatic::Vagrantomatic.new(vagrant_vm_dir:@working_dir, logger:@logger)
+        @vom = Vagrantomatic::Vagrantomatic.new(vagrant_vm_dir:@vagrant_vm_dir, logger:@logger)
         @logger.debug("creating instance metadata for #{@name}")
         @vm = @vom.instance(@name, config:@config)
 
@@ -36,6 +41,10 @@ module PuppetBox
         # ./spec/acceptance directory
         @vm.add_shared_folder(SPEC_ACCEPTANCE_MOUNT)
 
+        # mount the temporary testcase files (smoketests - the generated files
+        # holding 'include apache', etc)
+        @vm.add_shared_folder("#{@testcase_dir}:#{PUPPET_TESTCASE_DIR}")
+
         @logger.debug "instance #{name} initialised"
       end
 
@@ -52,9 +61,9 @@ module PuppetBox
       #   2: The run succeeded, and some resources were changed.
       #   4: The run succeeded, and some resources failed.
       #   6: The run succeeded, and included both changes and failures.
-      def run_puppet(puppet_class)
+      def run_puppet(puppet_file)
         status_code, messages = @vm.run(
-          "sudo -i puppet apply --detailed-exitcodes -e 'include #{puppet_class}'"
+          "sudo -i puppet apply --detailed-exitcodes #{puppet_file}"
         )
         @result.save(status_code, messages)
         @result.passed?
@@ -64,6 +73,8 @@ module PuppetBox
       def open()
         # make sure working dir exists...
         FileUtils.mkdir_p(@working_dir)
+        FileUtils.mkdir_p(@vagrant_vm_dir)
+        FileUtils.mkdir_p(@testcase_dir)
         @vm.save
 
         @logger.debug("Instance saved and ready for starting")
@@ -73,13 +84,17 @@ module PuppetBox
       # Close a connection to a box (eg stop a vm, probaly doesn't need to do
       # anything on SSH...)
       def close()
-        if ! @keep_vm
+        if @keep_vm
+          vagrant_cmd = "cd #{@vm.vm_instance_dir} && vagrant ssh"
+          @logger.info("VM #{@name} left running on user request, `#{vagrant_cmd}` to access - be sure to clean up your VMs!")
+        else
           @logger.info("Closing #{@name}")
           @vm.purge
         end
       end
 
       def reset()
+        @result = Result.new
         @vm.reset
       end
 
@@ -126,16 +141,20 @@ module PuppetBox
         status
       end
 
-      def run_puppet_x2(puppet_class)
+      def run_puppet_x2(puppet_file)
         # 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
         # for vagrant to mount what you need as a shared folder
-        if run_puppet(puppet_class)
+        if run_puppet(puppet_file)
           # Only do the second run if the first run passes
-          run_puppet(puppet_class)
+          run_puppet(puppet_file)
         end
       end
 
+      # noop
+      def sync_testcase(node_name, test_name)
+      end
+
     end
   end
 

data/lib/puppetbox/puppet.rb

@@ -0,0 +1,12 @@
+module PuppetBox
+  module Puppet
+    def self.include_class(class_name, pre:nil)
+      if pre
+        # apply a prerequisite and make sure there is a trailing newline.  this
+        # will be eval'ed directly so make sure there are no mad characters
+        pre = "#{pre}\n"
+      end
+      "#{pre}include #{class_name}"
+    end
+  end
+end

data/lib/puppetbox/puppetbox.rb

@@ -3,6 +3,8 @@ require "puppetbox/logger"
 require "puppetbox/nodeset"
 require "puppetbox/driver/vagrant"
 require "puppetbox/report"
+require "puppetbox/puppet"
+require "puppetbox/util"
 
 module PuppetBox
   class PuppetBox
@@ -12,7 +14,14 @@ module PuppetBox
     ACCEPTANCE_DEFAULT  = "__ALL__"
     SETUP_SCRIPT_GLOB   = "setup.*"
 
-    def initialize(logger:nil, nodeset_file: nil, working_dir: nil)
+    # we write testcases (smoketests) to this directory in our working dir...
+    PUPPET_TESTCASE_TEMPDIR = "testcase"
+
+    # ...and they appear on the system under test at this directory (like a
+    # wormhole) - the driver class is responsible for making this happen
+    PUPPET_TESTCASE_DIR   = "/testcase"
+
+    def initialize(logger:nil, nodeset_file: nil, working_dir: nil, keep_test_system:false)
       # The results of all tests on all driver instances
       @result_set = ResultSet.new
 
@@ -28,19 +37,24 @@ module PuppetBox
       @nodeset = NodeSet.new(nodeset_file)
 
       @working_dir = working_dir || WORKING_DIR
+      @puppet_test_tempdir = File.join(@working_dir, PUPPET_TESTCASE_TEMPDIR)
+
+      @keep_test_system = keep_test_system
     end
 
 
     # Enqueue a test into the `testsuite` for
-    def enqueue_test(node_name, run_from, puppet_class)
+    def enqueue_test_class(node_name, run_from, puppet_class, pre:nil)
       instantiate_driver(node_name, run_from)
-      @testsuite[node_name]["classes"] << puppet_class
-
+      # eg @testsuite['centos']['apache']='include apache'
+      test_name=puppet_class
+      @testsuite[node_name]["tests"][test_name] = Puppet::include_class(puppet_class, pre:pre)
     end
 
     def run_testsuite
       @testsuite.each { |id, tests|
-        run_puppet(tests["instance"], tests["classes"], logger:@logger, reset_after_run:true)
+        # tests for each node
+        run_puppet(tests["instance"], tests["tests"], logger:@logger, reset_after_run:true)
       }
     end
 
@@ -75,6 +89,7 @@ module PuppetBox
             # "#{repo.tempdir}/etc/puppetlabs/code/environments/production",
             logger: @logger,
             working_dir: @working_dir,
+            keep_vm: @keep_test_system
           )
 
           # immediately validate the configuration to allow us to fail-fast
@@ -85,7 +100,7 @@ module PuppetBox
 
         @testsuite[node_name] = {
           "instance" => di,
-          "classes"  => [],
+          "tests"  => {},
         }
       end
     end
@@ -155,32 +170,42 @@ module PuppetBox
       end
     end
 
-    # Run puppet using `driver_instance` to execute
-    def run_puppet(driver_instance, puppet_classes, logger:nil, reset_after_run:true)
+
+    # Run puppet using `driver_instance` to execute `puppet_codes`
+    # @param puppet_test Hash of test names <-> puppet code, eg {"apache"=>"include apache","nginx"=>"include nginx"}}
+    def run_puppet(driver_instance, puppet_tests, logger:nil, reset_after_run:true)
       # use supplied logger in preference to the default puppetbox logger instance
       logger = logger || @logger
-      logger.debug("#{driver_instance.node_name} running test for #{puppet_classes}")
-      puppet_classes = Array(puppet_classes)
+      logger.debug("#{driver_instance.node_name} running #{puppet_tests.size} tests")
 
       if driver_instance.open
         logger.debug("#{driver_instance.node_name} started")
         if driver_instance.self_test
           logger.debug("#{driver_instance.node_name} self_test OK, running puppet")
-          puppet_classes.each { |puppet_class|
+          puppet_tests.each { |test_name, puppet_code|
             if @result_set.class_size(driver_instance.node_name) > 0 and reset_after_run
               # purge and reboot the vm - this will save approximately 1 second
               # 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)
+            setup_test(driver_instance, test_name)
+            logger.info("running test #{driver_instance.node_name} - #{test_name}")
+
+            # write out the local test file
+            relative_puppet_file = commit_testcase(
+              puppet_tests, driver_instance.node_name, test_name
+            )
+            driver_instance.sync_testcase(driver_instance.node_name, test_name)
+
+            puppet_file_remote = File.join(PUPPET_TESTCASE_DIR, relative_puppet_file)
+            driver_instance.run_puppet_x2(puppet_file_remote)
+            @logger.debug("Saved result #{driver_instance.node_name} #{test_name} #{driver_instance.result.passed?}")
+            @result_set.save(driver_instance.node_name, test_name, driver_instance.result)
 
             Report::log_test_result_or_errors(
               @logger,
               driver_instance.node_name,
-              puppet_class,
+              test_name,
               driver_instance.result,
             )
           }
@@ -195,5 +220,19 @@ module PuppetBox
       driver_instance.close
     end
 
+    #
+    #@param testcases Pass in directly the testcases we are working against, to
+    #   handle situations where `run_puppet()` was called directly
+    def commit_testcase(testcases, node_name, test_name)
+      puppet_code = testcases[test_name]
+      relative_filename = Util.test_file_name(node_name, test_name)
+      filename = File.join(@puppet_test_tempdir, relative_filename)
+      FileUtils.mkdir_p(File.dirname(filename))
+      File.write(filename, puppet_code)
+      @logger.debug("Saved testcase #{filename}: #{puppet_code.slice(0,50)}...(ellipsed)")
+
+      relative_filename
+    end
+
   end
 end

data/lib/puppetbox/util.rb

@@ -0,0 +1,13 @@
+module PuppetBox
+  module Util
+
+
+    # return the filename that a testcase for a particular test should live in
+    # eg node_name=centos7, test_name=role::base should be in centos7/role__base.pp
+    def self.test_file_name(node_name, test_name)
+      test_name_safe = test_name.gsub(/::/,'__')
+      File.join(node_name, "#{test_name_safe}.pp")
+    end
+
+  end
+end

data/lib/puppetbox/version.rb

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

data/puppetbox.gemspec

@@ -23,6 +23,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
 
-  spec.add_dependency "vagrantomatic", "0.3.2"
+  spec.add_dependency "vagrantomatic", "0.3.3"
   spec.add_dependency "colorize"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppetbox
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Geoff Williams
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-16 00:00:00.000000000 Z
+date: 2017-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.3.2
+        version: 0.3.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.3.2
+        version: 0.3.3
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
@@ -101,10 +101,12 @@ files:
 - lib/puppetbox/driver/vagrant.rb
 - lib/puppetbox/logger.rb
 - lib/puppetbox/nodeset.rb
+- lib/puppetbox/puppet.rb
 - lib/puppetbox/puppetbox.rb
 - lib/puppetbox/report.rb
 - lib/puppetbox/result.rb
 - lib/puppetbox/result_set.rb
+- lib/puppetbox/util.rb
 - lib/puppetbox/version.rb
 - puppetbox.gemspec
 homepage: https://github.com/GeoffWilliams/puppetbox