pdqtest 1.9.9beta8 → 1.9.9beta9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 318a1841d2bcfda00c332734315ddf1278163cd50f3ce406463e400dad95bbb2
-  data.tar.gz: 1502c06caeea59ac008f102a14d4691e2ca0c9c4387dfc83fe0236d897e0fb6f
+  metadata.gz: 438426faf365d5ee59ac7b075dec4bef83048a08e4d231bf9e069f8b70374194
+  data.tar.gz: b8d07f4d78e6e4f4721fcbe6a9e34e7e5ca51bd59e11c4f55fd1765b548b571f
 SHA512:
-  metadata.gz: e33f2c4d47f585819125cd74c0dbad0e38798c800df5aad2c1524c83d0687d86edfec2999cdb21db8fd6ad6e810f3b4fb56d13b30c84c064416c5a9091dc42b7
-  data.tar.gz: 9d8ba622a7c9b62e0b5946a444f2e3b1d1b34d76e82b857afb28439cb8a2c823a6c426ea41a51defddd3fdc650c5c9ef2409b2553375462b96c74eb5228d1349
+  metadata.gz: 66d94c1d45b76ab56e30dc7ab1aa26b0f32727f12232b04b83b308d65cc25328bae044ca1e4941c927b08d9680b6d91a335bed6e8213306aff073ff7ba66e811
+  data.tar.gz: cd0acb639f47015da1c6d23e1431ac512a07585c429fbf8ad5a9336d23f90f72a45808921337c584b938f924f917b46523f6438f4129624b1822f08c906afc98

data/README.md

@@ -32,6 +32,7 @@ PDQTest 2.0 new features:
 * [PDK Support](doc/pdk.md)
 * [Windows support](doc/windows.md)
 * [PDQTest 1.x -> 2.x Upgrade guide](doc/upgrade_1_2.md)
+* [Inplace execution](https://github.com/declarativesystems/pdqtest/issues/34)
 
 ## PDQTest Manual
 1. [Installation](doc/installation.md)

data/exe/pdqtest

@@ -76,6 +76,20 @@ Escort::App.create do |app|
       :type     => :boolean,
       :default  => false,
     )
+
+    opts.opt(:inplace,
+       'Run puppet in place on *THIS* system -- WARNING! this is likely to destroy your computer',
+       :long     => '--inplace',
+       :type     => :boolean,
+       :default  => false,
+     )
+
+    opts.opt(:inplace_enable,
+       'Enable inplace mode to make changes (safety/debugging switch)',
+       :long     => '--inplace-enable',
+       :type     => :boolean,
+       :default  => false,
+    )
   end
 
   app.command :all do |command|
@@ -85,9 +99,12 @@ Escort::App.create do |app|
 
       $logger.level = :debug if options[:global][:options][:debug]
 
+
       PDQTest::Emoji.disable(options[:global][:options][:disable_emoji])
       PDQTest::Puppet.skip_second_run(options[:global][:options][:skip_idempotency])
 
+      PDQTest::Inplace.set_enable options[:global][:options][:inplace_enable]
+      PDQTest::Instance.set_inplace options[:global][:options][:inplace]
       PDQTest::Instance.set_privileged(options[:global][:options][:privileged])
       PDQTest::Instance.set_keep_container(options[:global][:options][:keep_container])
       PDQTest::Instance.set_docker_image(options[:global][:options][:image_name])
@@ -112,6 +129,8 @@ Escort::App.create do |app|
       PDQTest::Emoji.disable(options[:global][:options][:disable_emoji])
       PDQTest::Puppet.skip_second_run(options[:global][:options][:skip_idempotency])
 
+      PDQTest::Inplace.set_enable options[:global][:options][:inplace_enable]
+      PDQTest::Instance.set_inplace options[:global][:options][:inplace]
       PDQTest::Instance.set_privileged(options[:global][:options][:privileged])
       PDQTest::Instance.set_keep_container(options[:global][:options][:keep_container])
       PDQTest::Instance.set_docker_image(options[:global][:options][:image_name])
@@ -143,6 +162,9 @@ Escort::App.create do |app|
 
       PDQTest::Emoji.disable(options[:global][:options][:disable_emoji])
       PDQTest::Puppet.skip_second_run(options[:global][:options][:skip_idempotency])
+
+      PDQTest::Inplace.set_enable options[:global][:options][:inplace_enable]
+      PDQTest::Instance.set_inplace options[:global][:options][:inplace]
       PDQTest::Instance.set_privileged(options[:global][:options][:privileged])
       PDQTest::Instance.set_docker_image(options[:global][:options][:image_name])
       PDQTest::Instance.set_keep_container(options[:global][:options][:keep_container])

data/lib/pdqtest/docker.rb

@@ -1,12 +1,13 @@
 require 'pdqtest/util'
 require 'pdqtest/puppet'
+require 'pdqtest/execution'
 
 module PDQTest
   module Docker
     OUT = 0
     ERR = 1
     STATUS = 2
-    REAL_CMD = 3
+
     IMAGES = {
      :DEFAULT => 'declarativesystems/pdqtest-centos:2018-09-15-0',
      :UBUNTU  => 'declarativesystems/pdqtest-ubuntu:2018-09-15-0',
@@ -43,6 +44,7 @@ module PDQTest
 
     # convenience lookup for container testcase dir since its used all over the
     # place
+    # fixme! - belongs somewhere else now...
     def self.test_dir
       CONTAINER_PATHS[Util.host_platform][:testcase]
     end
@@ -67,38 +69,16 @@ module PDQTest
       volumes
     end
 
+    def self._exec_real(container, real_c)
+      $logger.debug("exec_real: running docker command: #{real_c}")
+      _res = container.exec(real_c, tty: true)
 
-    def self.exec(container, cmd)
-      status = 0
-      res = []
-
-      res[OUT]=[]
-      res[ERR]=[]
-      res[STATUS]=0
-      res[REAL_CMD]=[]
-
-      Array(cmd).each do |c|
-        real_c = Util.wrap_cmd(c)
-        res[REAL_CMD] << real_c
-        $logger.debug "Executing: #{real_c}"
-        _res = container.exec(real_c, tty: true)
-
-        if c =~ /robocopy/
-          # robocopy exit codes break the status check we do later on - we have
-          # to manually 'fix' them here
-          if _res[STATUS] < 4
-            _res[STATUS] = 0
-          end
-        end
-        res[STATUS] += _res[STATUS]
-        res[OUT]    += _res[OUT]
-        res[ERR]    += _res[ERR]
-
-        # non zero status from something thats not puppet apply is probably an error
-        if _res[STATUS] != 0 && !(c =~ /pupet apply|bats/)
-          $logger.warn "non-zero exit status: #{_res[STATUS]} from #{real_c}: #{_res[OUT]} #{_res[ERR]}"
-        end
-      end
+      # docker returns an array of stuff - convert to hash with labels
+      res = {
+          :OUT => _res[OUT],
+          :ERR => _res[ERR],
+          :STATUS => _res[STATUS],
+      }
 
       res
     end
@@ -218,45 +198,5 @@ module PDQTest
       container.delete(:force => true)
     end
 
-    def self.exec_status(res, puppet=false)
-      if puppet
-        # 0 == ok, no changes
-        # 2 == ok, changes made
-        allowable_values = [0,2]
-      else
-        allowable_values = [0]
-      end
-      status = allowable_values.include?(res[STATUS])
-    end
-
-    def self.exec_out(res)
-      res[OUT]
-    end
-
-    def self.exec_err(res)
-      res[ERR]
-    end
-
-    def self.log_out(res)
-      exec_out(res).each { |l|
-        # Output comes back as an array and needs to be iterated or we lose our
-        # ansi formatting
-        $logger.info l.chomp
-      }
-    end
-
-    def self.log_all(res)
-      log_err(res)
-      log_out(res)
-    end
-
-    def self.log_err(res)
-      exec_err(res).each { |l|
-        # Output comes back as an array and needs to be iterated or we lose our
-        # ansi formatting
-        $logger.error l.chomp
-      }
-    end
-
   end
 end

data/lib/pdqtest/execution.rb

@@ -0,0 +1,82 @@
+require 'pdqtest/puppet'
+module PDQTest
+  module Execution
+
+    def self.exec_out(res)
+      res[:OUT]
+    end
+
+    def self.exec_err(res)
+      res[:ERR]
+    end
+
+    def self.log_out(res)
+      exec_out(res).each { |l|
+        # Output comes back as an array and needs to be iterated or we lose our
+        # ansi formatting
+        $logger.info l.chomp
+      }
+    end
+
+    def self.log_all(res)
+      log_err(res)
+      log_out(res)
+    end
+
+    def self.log_err(res)
+      exec_err(res).each { |l|
+        # Output comes back as an array and needs to be iterated or we lose our
+        # ansi formatting
+        $logger.error l.chomp
+      }
+    end
+
+    def self.exec(cc, container, cmd)
+      status = 0
+      res = {}
+
+      res[:OUT]=[]
+      res[:ERR]=[]
+      res[:STATUS]=0
+      res[:REAL_CMD]=[]
+
+      Array(cmd).each do |c|
+        real_c = Util.wrap_cmd(c)
+        res[:REAL_CMD] << real_c
+        $logger.debug "Executing: #{real_c}"
+        _res = cc._exec_real(container, real_c)
+
+        if c =~ /robocopy/
+          # robocopy exit codes break the status check we do later on - we have
+          # to manually 'fix' them here
+          if _res[:STATUS] < 4
+            _res[:STATUS] = 0
+          end
+        end
+        res[:STATUS] += _res[:STATUS]
+        res[:OUT]    += _res[:OUT]
+        res[:ERR]    += _res[:ERR]
+
+        # non zero status from something thats not puppet apply is probably an error
+        if _res[:STATUS] != 0 && !(c =~ /pupet apply|bats/)
+          $logger.warn "non-zero exit status: #{_res[:STATUS]} from #{real_c}: #{_res[:OUT]} #{_res[:ERR]}"
+        end
+      end
+
+      res
+    end
+
+    # convert exit code (integer) to boolean: true == good; false == bad
+    def self.exec_status(res, puppet=false)
+      if puppet
+        # 0 == ok, no changes
+        # 2 == ok, changes made
+        allowable_values = [0,2]
+      else
+        allowable_values = [0]
+      end
+      status = allowable_values.include?(res[:STATUS])
+    end
+
+  end
+end

data/lib/pdqtest/inplace.rb

@@ -0,0 +1,58 @@
+require 'pdqtest/puppet'
+require 'open3'
+module PDQTest
+  module Inplace
+    INPLACE_IMAGE = "__INPLACE__"
+    @@enable = false
+
+    def self.set_enable(enable)
+      if enable
+        $logger.warn <<~END
+          PDQTest run with --inplace --inplace-enable will run Puppet on 
+          *this* computer! 
+  
+          You have 5 seconds to abort, press ctrl+c now
+        END
+        sleep(5)
+      end
+      @@enable = enable
+    end
+
+    def self._exec_real(container, real_c)
+      res = {}
+
+      res[:OUT]    = []
+      res[:ERR]    = []
+      res[:STATUS] = 0
+      $logger.debug("exec_real: running inplace command: #{real_c}")
+      if @@enable
+        # must splat to avoid "wrong first argument"
+        Open3.popen3(*real_c) do |stdin, stdout, stderr, wait_thr|
+          res[:OUT] = stdout.read.split("\n")
+          res[:ERR] = stderr.read.split("\n")
+          # Process::Status object returned from `.value`
+          res[:STATUS] = wait_thr.value.exitstatus
+        end
+      else
+        $logger.info "didn't run command, reason: DISABLED"
+      end
+      $logger.debug("...result: #{res[:STATUS]}")
+
+      res
+    end
+
+    def self.id
+      INPLACE_IMAGE
+    end
+
+    def self.new_container(image_name, privileged)
+      FileUtils.rm_f Docker.test_dir if Dir.exist? Docker.test_dir
+
+      FileUtils.cp_r(File.join(Dir.pwd, "."), Docker.test_dir)
+    end
+
+    def self.cleanup_container(container)
+      FileUtils.rm_f Docker.test_dir
+    end
+  end
+end

data/lib/pdqtest/instance.rb

@@ -1,6 +1,7 @@
 require 'docker-api'
 require 'pdqtest/puppet'
 require 'pdqtest/docker'
+require 'pdqtest/inplace'
 require 'escort'
 
 module PDQTest
@@ -9,6 +10,7 @@ module PDQTest
     @@active_container = nil
     @@image_name = false
     @@privileged = false
+    @@inplace = false
 
     def self.get_active_container
       @@active_container
@@ -39,6 +41,37 @@ module PDQTest
       @@privileged
     end
 
+    def self.set_inplace(inplace)
+      @@inplace = inplace
+    end
+
+    def self.get_inplace()
+      @@inplace
+    end
+
+
+    def self.get_acceptance_test_images
+      test_platforms = @@image_name || PDQTest::Docker.acceptance_test_images
+      filtered_test_platforms = test_platforms.reject do |image_name|
+        reject = false
+        if Util.is_windows
+          if image_name !~ /windows/
+            $logger.info "Skipping test image #{image_name} (requires Linux)"
+            reject = true
+          end
+        else
+          if image_name =~ /windows/
+            $logger.info "Skipping test image #{image_name} (requires Windows)"
+            reject = true
+          end
+        end
+
+        reject
+      end
+
+      filtered_test_platforms
+    end
+
     def self.run(example=nil)
       # needed to prevent timeouts from container.exec()
       Excon.defaults[:write_timeout] = 10000
@@ -48,38 +81,29 @@ module PDQTest
       # remove reference to any previous test container
       @@active_container = nil
 
-      if PDQTest::Puppet::find_examples().empty?
+      if PDQTest::Puppet.find_examples.empty?
         $logger.info "No acceptance tests found, annotate examples with #{PDQTest::Puppet.setting(:magic_marker)} to make some"
       else
-        # process each supported OS
-        test_platforms = @@image_name || Docker::acceptance_test_images
-        $logger.info "Acceptance test on #{test_platforms}..."
-        test_platforms.reject { |image_name|
-          reject = false
-          if Util.is_windows
-            if image_name !~ /windows/
-              $logger.info "Skipping test image #{image_name} (requires Linux)"
-              reject = true
-            end
-          else
-            if image_name =~ /windows/
-              $logger.info "Skipping test image #{image_name} (requires Windows)"
-              reject = true
-            end
-          end
-
-          reject
-        }.each { |image_name|
+        # process each supported OS and figure out what controller container to use
+        if @@inplace
+          test_platforms = [PDQTest::Inplace::INPLACE_IMAGE]
+          cc = PDQTest::Inplace
+        else
+          test_platforms = get_acceptance_test_images
+          cc = PDQTest::Docker
+        end
+
+        test_platforms.each { |image_name|
           $logger.info "--- start test with #{image_name} ---"
-          @@active_container = PDQTest::Docker::new_container(image_name, @@privileged)
+          @@active_container = cc.new_container(image_name, @@privileged)
           $logger.info "alive, running tests"
-          status &= PDQTest::Puppet.run(@@active_container, example)
+          status &= PDQTest::Puppet.run(cc, @@active_container, example)
 
-          if @@keep_container
+          if @@keep_container && ! @@inplace
             $logger.info "finished build, container #{@@active_container.id} left on system"
             $logger.info "  docker exec -ti #{@@active_container.id} #{Util.shell} "
           else
-            PDQTest::Docker.cleanup_container(@@active_container)
+            cc.cleanup_container(@@active_container)
             @@active_container = nil
           end
 
@@ -97,7 +121,9 @@ module PDQTest
       $logger.info "Opening a shell in #{image_name}"
       @@active_container = PDQTest::Docker::new_container(image_name, @@privileged)
 
-      PDQTest::Docker.exec(@@active_container, PDQTest::Puppet.setup)
+      # Shell is always executed with docker - if you want a new shell for
+      # in-place, your already in it ;-)
+      PDQTest::Execution.exec(PDQTest::Docker, @@active_container, PDQTest::Puppet.setup)
 
       # In theory I should be able to get something like the code below to
       # redirect all input streams and give a makeshift interactive shell, howeve

data/lib/pdqtest/puppet.rb

@@ -260,13 +260,13 @@ module PDQTest
       t.gsub(EXAMPLES_DIR + '/','').gsub('.pp','')
     end
 
-    def self.xats_test(container, example, suffix)
+    def self.xats_test(cc, container, example, suffix)
       testcase = Util.joinp(XATS_TESTS, test_basename(example) + suffix)
       if File.exists?(testcase)
         $logger.info "*** #{setting(:name)} test **** #{setting(:test_cmd)} #{testcase}"
-        res = PDQTest::Docker.exec(container, "cd #{Docker.test_dir} ; #{setting(:test_cmd)} #{testcase}")
-        status = PDQTest::Docker.exec_status(res)
-        PDQTest::Docker.log_out(res)
+        res = PDQTest::Execution.exec(cc, container, "cd #{Docker.test_dir} ; #{setting(:test_cmd)} #{testcase}")
+        status = PDQTest::Execution.exec_status(res)
+        PDQTest::Execution.log_all(res)
         @@bats_executed << testcase
       else
         $logger.info "no #{suffix} tests for #{example} (should be at #{testcase})"
@@ -276,19 +276,20 @@ module PDQTest
       status
     end
 
-    def self.setup_test(container, example)
+    def self.setup_test(cc, container, example)
       setup_script = Util.joinp(XATS_TESTS, test_basename(example)) + setting(:setup_suffix)
       if File.exists?(setup_script)
         script = File.read(setup_script)
         $logger.debug "setup script: \n #{script}"
         if script.strip.empty?
           $logger.info "skipping empty setup script at #{setup_script}"
+          status = true
         else
           $logger.info "Setting up test for #{example}"
 
-          res = PDQTest::Docker.exec(container, script)
-          status = PDQTest::Docker.exec_status(res)
-          PDQTest::Docker.log_out(res)
+          res = PDQTest::Execution.exec(cc, container, script)
+          status = PDQTest::Execution.exec_status(res)
+          PDQTest::Execution.log_all(res)
         end
         @@setup_executed << setup_script
       else
@@ -299,42 +300,42 @@ module PDQTest
       status
     end
 
-    def self.run_example(container, example)
+    def self.run_example(cc, container, example)
       $logger.info "testing #{example}"
       status = false
 
-      if setup_test(container, example)
+      if setup_test(cc, container, example)
 
         # see if we should run a bats test before running puppet
-        if xats_test(container, example, setting(:before_suffix))
+        if xats_test(cc, container, example, setting(:before_suffix))
 
           # run puppet apply - 1st run
-          res = PDQTest::Docker.exec(container, puppet_apply(example))
-          PDQTest::Docker.log_out(res)
-          if PDQTest::Docker.exec_status(res, true) # allow 2 as exit status
+          res = PDQTest::Execution.exec(cc, container, puppet_apply(example))
+          PDQTest::Execution.log_out(res)
+          if PDQTest::Execution.exec_status(res, true) # allow 2 as exit status
 
             if @@skip_second_run
               $logger.info "Skipping idempotency check as you requested..."
 
               # check the system right now since puppet ran OK once
-              status = xats_test(container, example, setting(:after_suffix))
+              status = xats_test(cc, container, example, setting(:after_suffix))
             else
               # run puppet apply - 2nd run (check for idempotencey/no more changes)
-              res = PDQTest::Docker.exec(container, puppet_apply(example))
-              PDQTest::Docker.log_out(res)
+              res = PDQTest::Execution.exec(cc, container, puppet_apply(example))
+              PDQTest::Execution.log_out(res)
 
               # run the bats test if nothing failed yet
-              if PDQTest::Docker.exec_status(res) # only allow 0 as exit status
-                status = xats_test(container, example, setting(:after_suffix))
+              if PDQTest::Execution.exec_status(res) # only allow 0 as exit status
+                status = xats_test(cc, container, example, setting(:after_suffix))
               else
                 $logger.error "Not idempotent: #{example}"
               end
             end
           else
-            $logger.error "First puppet run of #{example} failed (status: #{res[Docker::STATUS]})"
+            $logger.error "First puppet run of #{example} failed (status: #{res[:STATUS]})"
           end
         else
-          $logger.error "#{setting(:name)} tests to run before #{example} failed (status: #{res[Docker::STATUS]})"
+          $logger.error "#{setting(:name)} tests to run before #{example} failed"
         end
       else
         $logger.error "Setup script for #{example} failed (see previous error)"
@@ -343,7 +344,7 @@ module PDQTest
       status
     end
 
-    def self.run(container, example=nil)
+    def self.run(cc, container, example=nil)
       # we must always have ./spec/fixtures/modules because we need to create a
       # symlink back to the main module inside here...
       # (spec/fixtures/modules/foo -> /testcase)
@@ -357,14 +358,14 @@ module PDQTest
       status = true
       $logger.info "...running container setup"
       setup_start = Time.now
-      res = PDQTest::Docker.exec(container, setup)
+      res = PDQTest::Execution.exec(cc, container, setup)
       setup_end = Time.now
-      status &= PDQTest::Docker.exec_status(res)
+      status &= PDQTest::Execution.exec_status(res)
       if Util.is_windows
         # write a script to allow user to update modules
         $logger.info "wasted #{((setup_end - setup_start))} seconds of your life on windows tax"
         File.open("refresh.ps1", 'w') do |file|
-          res[Docker::REAL_CMD].each do |c|
+          res[:REAL_CMD].each do |c|
             file.puts("#{c[0]} #{c[1]} \"#{c[2]}\"")
           end
         end
@@ -376,14 +377,14 @@ module PDQTest
       if status
           $logger.info "...run tests"
           if example
-            status &= run_example(container, example)
+            status &= run_example(cc, container, example)
             if ! status
               $logger.error "Example #{example} failed!"
             end
           else
             find_examples.each { |e|
               if status
-                status &= run_example(container, e)
+                status &= run_example(cc, container, e)
                 if ! status
                   $logger.error "Example #{e} failed! - skipping rest of tests"
                 end
@@ -391,8 +392,8 @@ module PDQTest
             }
           end
       else
-        PDQTest::Docker.log_all(res)
-        $logger.error "Error running puppet setup, see previous error, command was: #{res[Docker::REAL_CMD]}"
+        PDQTest::Execution.log_all(res)
+        $logger.error "Error running puppet setup, see previous error, command was: #{res[:REAL_CMD]}"
       end
 
       PDQTest::Emoji.partial_status(status, 'Puppet')

data/lib/pdqtest/upgrade.rb

@@ -20,7 +20,7 @@ module PDQTest
           'added' => false,
       },
       'puppet' => {
-          'line' => "gem 'puppet', '5.5.3'",
+          'line' => "gem 'puppet', '5.5.6'",
           'added' => false,
       },
       'puppet-lint' => {

data/lib/pdqtest/version.rb

@@ -1,3 +1,3 @@
 module PDQTest
-  VERSION = "1.9.9beta8"
+  VERSION = "1.9.9beta9"
 end

data/res/skeleton/bitbucket-pipelines.yml

@@ -18,7 +18,7 @@ pipelines:
           - apt install -y pdk
           - sh .ci_custom.sh
           - make pdqtestbundle
-          - make logical
+          - cd .pdqtest && bundle exec pdqtest --inplace --inplace enable all
 
 definitions:
   caches:

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pdqtest
 version: !ruby/object:Gem::Version
-  version: 1.9.9beta8
+  version: 1.9.9beta9
 platform: ruby
 authors:
 - Geoff Williams
@@ -211,7 +211,9 @@ files:
 - lib/pdqtest/core.rb
 - lib/pdqtest/docker.rb
 - lib/pdqtest/emoji.rb
+- lib/pdqtest/execution.rb
 - lib/pdqtest/fastcheck.rb
+- lib/pdqtest/inplace.rb
 - lib/pdqtest/instance.rb
 - lib/pdqtest/logger.rb
 - lib/pdqtest/pdk.rb