taste_tester 0.0.12 → 0.0.17

data/lib/taste_tester/locallink.rb

@@ -22,8 +22,6 @@ module TasteTester
     include TasteTester::Logging
     include BetweenMeals::Util
 
-    attr_reader :output
-
     def initialize
       @host = 'localhost'
       @cmds = []
@@ -36,14 +34,18 @@ module TasteTester
     alias << add
 
     def run
-      @status, @output = exec(cmd, logger)
+      exec(cmd, logger)
     end
 
     def run!
-      @status, @output = exec!(cmd, logger)
-    rescue => e
+      exec!(cmd, logger)
+    rescue StandardError => e
       logger.error(e.message)
-      raise TasteTester::Exceptions::LocalLinkError
+      error!
+    end
+
+    def error!
+      fail TasteTester::Exceptions::LocalLinkError
     end
 
     private

data/lib/taste_tester/logging.rb

@@ -14,7 +14,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# rubocop:disable ClassVars, UnusedMethodArgument, UnusedBlockArgument
+# rubocop:disable ClassVars
 require 'logger'
 
 module TasteTester
@@ -35,8 +35,8 @@ module TasteTester
       @logger ||= Logger.new(STDOUT)
     end
 
-    def self.formatterproc=(p)
-      @@formatter_proc = p
+    def self.formatterproc=(process)
+      @@formatter_proc = process
     end
 
     def self.use_log_formatter=(use_log_formatter)
@@ -49,16 +49,17 @@ module TasteTester
 
     def formatter
       return @@formatter_proc if @@formatter_proc
+
       if @@use_log_formatter
-        proc do |severity, datetime, progname, msg|
+        proc do |severity, datetime, _progname, msg|
           if severity == 'ERROR'
             msg = msg.red
           end
           "[#{datetime.strftime('%Y-%m-%dT%H:%M:%S%:z')}] #{severity}: #{msg}\n"
         end
       else
-        proc do |severity, datetime, progname, msg|
-          msg.to_s.prepend("#{severity}: ") unless severity == 'WARN'
+        proc do |severity, _datetime, _progname, msg|
+          msg.dup.to_s.prepend("#{severity}: ") unless severity == 'WARN'
           if severity == 'ERROR'
             msg = msg.to_s.red
           end
@@ -68,3 +69,4 @@ module TasteTester
     end
   end
 end
+# rubocop:enable ClassVars

data/lib/taste_tester/noop.rb

@@ -0,0 +1,69 @@
+# vim: syntax=ruby:expandtab:shiftwidth=2:softtabstop=2:tabstop=2
+
+# Copyright 2013-present Facebook
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'taste_tester/exceptions'
+
+module TasteTester
+  # Wrapper for running commands on local system
+  class NoOp
+    include TasteTester::Logging
+    include BetweenMeals::Util
+
+    def initialize
+      print_noop_warning
+      @host = 'localhost'
+      @user = ENV['USER']
+      @cmds = []
+    end
+
+    def print_noop_warning
+      # This needs to be a Class var as this class is initialized more
+      # than once in a given tt run and we only want to warn once.
+      # rubocop:disable Style/ClassVars
+      @@printedwarning ||= logger.warn(
+        'No-op plugin active, no remote commands will be run!',
+      )
+      # rubocop:enable Style/ClassVars
+    end
+
+    def add(string)
+      @cmds << string
+    end
+
+    alias << add
+
+    def run
+      run!
+    end
+
+    def run!
+      cmd
+      [0, "# TasteTester by #{@user}"]
+    end
+
+    def error!
+      # never fails, but interface requires a definition
+    end
+
+    private
+
+    def cmd
+      @cmds.each do |cmd|
+        logger.info("No-op, faking run of: '#{cmd}' on #{@host}")
+      end
+    end
+  end
+end

data/lib/taste_tester/server.rb

@@ -16,7 +16,6 @@
 
 require 'fileutils'
 require 'socket'
-require 'timeout'
 
 require 'between_meals/util'
 require 'taste_tester/config'
@@ -30,22 +29,27 @@ module TasteTester
     include TasteTester::Logging
     extend ::BetweenMeals::Util
 
-    attr_accessor :user, :host
+    attr_accessor :user, :host, :bundle_dir
 
     def initialize
       @state = TasteTester::State.new
       @ref_file = TasteTester::Config.ref_file
       ref_dir = File.dirname(File.expand_path(@ref_file))
-      @log_file = "#{ref_dir}/chef-zero.log"
+      @log_file = File.join(ref_dir, 'chef-zero.log')
+      @fsroot = File.join(ref_dir, 'root')
       @zero_path = TasteTester::Config.chef_zero_path
       unless File.directory?(ref_dir)
         begin
           FileUtils.mkpath(ref_dir)
-        rescue => e
+        rescue StandardError => e
           logger.warn("Chef temp dir #{ref_dir} missing and can't be created")
           logger.warn(e)
         end
       end
+      if TasteTester::Config.bundle
+        @bundle_dir = File.join(@fsroot, 'organizations/chef/file_store')
+        FileUtils.mkpath(@bundle_dir)
+      end
 
       @user = ENV['USER']
 
@@ -53,19 +57,20 @@ module TasteTester
       # determines if we listen only on localhost or not
       @need_restart = @state.ssl != TasteTester::Config.use_ssl ||
                       @state.logging != TasteTester::Config.chef_zero_logging ||
-                      @state.ssh != TasteTester::Config.use_ssh_tunnels
+                      @state.ssh != TasteTester::Config.use_ssh_tunnels ||
+                      @state.bundle != TasteTester::Config.bundle
 
       # If we are using SSH tunneling listen on localhost, otherwise listen
       # on all addresses - both v4 and v6. Note that on localhost, ::1 is
       # v6-only, so we default to 127.0.0.1 instead.
       if TasteTester::Config.use_ssh_tunnels
-        @addr = '127.0.0.1'
+        @addrs = ['127.0.0.1']
         @host = 'localhost'
       else
-        @addr = '::'
+        @addrs = ['::', '0.0.0.0']
         begin
           @host = TasteTester::Config.my_hostname || Socket.gethostname
-        rescue
+        rescue StandardError
           logger.error('Unable to find fqdn')
           exit 1
         end
@@ -121,10 +126,20 @@ module TasteTester
       @state.ref = ref
     end
 
+    def last_upload_time
+      @state.last_upload_time
+    end
+
+    def last_upload_time=(time)
+      @state.last_upload_time = time
+    end
+
     def self.running?
       if TasteTester::State.port
-        return port_open?(TasteTester::State.port)
+        return chef_zero_running?(TasteTester::State.port,
+                                  TasteTester::Config.use_ssl)
       end
+
       false
     end
 
@@ -140,29 +155,33 @@ module TasteTester
         :role_dir => TasteTester::Config.roles,
         :cookbook_dirs => TasteTester::Config.cookbooks,
         :checksum_dir => TasteTester::Config.checksum_dir,
+        :config => TasteTester::Config.knife_config,
       )
       knife.write_user_config
     end
 
     def start_chef_zero
-      File.unlink(@log_file) if File.exists?(@log_file)
+      File.unlink(@log_file) if File.exist?(@log_file)
       @state.update({
                       :port => TasteTester::Config.chef_port,
                       :ssl => TasteTester::Config.use_ssl,
                       :ssh => TasteTester::Config.use_ssh_tunnels,
                       :logging => TasteTester::Config.chef_zero_logging,
+                      :bundle => TasteTester::Config.bundle,
                     })
       logger.info("Starting chef-zero of port #{@state.port}")
       if windows?
         extend ::TasteTester::Windows
         start_win_chef_zero_server
       else
-        cmd = "#{chef_zero_path} --host #{@addr} --port #{@state.port} -d"
+        hostarg = @addrs.map { |addr| "--host #{addr}" }.join(' ')
+        cmd = +"#{chef_zero_path} #{hostarg} --port #{@state.port} -d"
         if TasteTester::Config.chef_zero_logging
           cmd << " --log-file #{@log_file}" +
             ' --log-level debug'
         end
         cmd << ' --ssl' if TasteTester::Config.use_ssl
+        cmd << " --file-store #{@fsroot}" if TasteTester::Config.bundle
         Mixlib::ShellOut.new(cmd).run_command.error!
       end
     end

data/lib/taste_tester/ssh.rb

@@ -15,18 +15,17 @@
 # limitations under the License.
 
 require 'taste_tester/exceptions'
+require 'taste_tester/ssh_util'
 
 module TasteTester
   # Thin ssh wrapper
   class SSH
     include TasteTester::Logging
     include BetweenMeals::Util
+    include TasteTester::SSH::Util
 
-    attr_reader :output
-
-    def initialize(host, timeout = 5, tunnel = false)
+    def initialize(host, tunnel = false)
       @host = host
-      @timeout = timeout
       @tunnel = tunnel
       @cmds = []
     end
@@ -37,25 +36,15 @@ module TasteTester
 
     alias << add
 
-    def run
-      @status, @output = exec(cmd, logger)
+    def run(stream = nil)
+      exec(cmd, logger, stream)
     end
 
-    def run!
-      @status, @output = exec!(cmd, logger)
-    rescue => e
-      # rubocop:disable LineLength
-      error = <<-MSG
-SSH returned error while connecting to #{TasteTester::Config.user}@#{@host}
-The host might be broken or your SSH access is not working properly
-Try doing
-  #{TasteTester::Config.ssh_command} -v #{TasteTester::Config.user}@#{@host}
-and come back once that works
-MSG
-      # rubocop:enable LineLength
-      error.lines.each { |x| logger.error x.strip }
+    def run!(stream = nil)
+      exec!(cmd, logger, stream)
+    rescue StandardError => e
       logger.error(e.message)
-      raise TasteTester::Exceptions::SshError
+      error!
     end
 
     private
@@ -64,17 +53,7 @@ MSG
       @cmds.each do |cmd|
         logger.info("Will run: '#{cmd}' on #{@host}")
       end
-      cmds = @cmds.join(' && ')
-      cmd = "#{TasteTester::Config.ssh_command} " +
-            "-T -o BatchMode=yes -o ConnectTimeout=#{@timeout} " +
-            "#{TasteTester::Config.user}@#{@host} "
-      if TasteTester::Config.user != 'root'
-        cc = Base64.encode64(cmds).delete("\n")
-        cmd += "\"echo '#{cc}' | base64 --decode | sudo bash -x\""
-      else
-        cmd += "\'#{cmds}\'"
-      end
-      cmd
+      build_ssh_cmd(ssh_base_cmd, @cmds)
     end
   end
 end

data/lib/taste_tester/ssh_util.rb

@@ -0,0 +1,127 @@
+module TasteTester
+  class SSH
+    module Util
+      def ssh_base_cmd
+        jumps = TasteTester::Config.jumps ?
+          "-J #{TasteTester::Config.jumps}" : ''
+        "#{TasteTester::Config.ssh_command} #{jumps} -T -o BatchMode=yes " +
+          '-o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no ' +
+          "-o ConnectTimeout=#{TasteTester::Config.ssh_connect_timeout} " +
+          "#{TasteTester::Config.user}@#{@host} "
+      end
+
+      def error!
+        error = <<~ERRORMESSAGE
+  SSH returned error while connecting to #{TasteTester::Config.user}@#{@host}
+  The host might be broken or your SSH access is not working properly
+  Try doing
+
+      #{ssh_base_cmd} -v
+
+  to see if ssh connection is good.
+  If ssh works, add '-v' key to taste-tester to see the list of commands it's
+  trying to execute, and try to run them manually on destination host
+        ERRORMESSAGE
+        logger.error(error)
+        fail TasteTester::Exceptions::SshError
+      end
+
+      def build_ssh_cmd(ssh, command_list)
+        if TasteTester::Config.windows_target
+          # Powershell has no `&&`. So originally we looked into joining the
+          # various commands with `; if ($LASTEXITCODE -ne 0) { exit 42 }; `
+          # except that it turns out lots of Powershell commands don't set
+          # $LASTEXITCODE and so that crashes a lot.
+          #
+          # There is an `-and`, but it only works if you group things together
+          # with `()`, but that loses any output.
+          #
+          # Technically in the latest preview of Powershell 7, `&&` exists, but
+          # we cannot rely on this.
+          #
+          # So here we are. Thanks Windows Team.
+          #
+          # Anyway, what we *really* care about is that we exit if we_testing()
+          # errors out, and on Windows, we can do that straight from the
+          # powershell we generate there (we're not forking off awk), so the
+          # `&&` isn't as critical. It's still a bummer that we continue on
+          # if one of the commands fails, but... Well, it's Windows,
+          # whatchyagonnado?
+
+          cmds = command_list.join(' ; ')
+        else
+          cmds = command_list.join(' && ')
+        end
+        cmd = ssh
+        cc = Base64.encode64(cmds).delete("\n")
+        if TasteTester::Config.windows_target
+
+          # This is pretty horrible, but because there's no way I can find to
+          # take base64 as stdin and output text, we end up having to do use
+          # these PS functions. But they're going to pass through *both* bash
+          # *and* powershell, so in order to preserve the quotes, it gets
+          # pretty ugly.
+          #
+          # The tldr here is that in shell you can't escape quotes you're
+          # using to quote something. So if you use single quotes, there's no
+          # way to escape a single quote inside, and same with double-quotes.
+          # As such we switch between quote-styles as necessary. As long as the
+          # strings are back-to-back, shell handles this well. To make this
+          # clear, imagine you want to echo this:
+          #    '"'"
+          # Exactly like that. You would quote the first single quotes in double
+          # quotes: "'"
+          # Then the double quotes in single quotes: '"'
+          # Now repeat twice and you get: echo "'"'"'"'"'"'
+          # And that works reliably.
+          #
+          # We're doing the same thing here. What we want on the other side of
+          # the ssh is:
+          #  [Text.Encoding]::Utf8.GetString([Convert]::FromBase64String('...'))
+          #
+          # But for this to work right the command we pass to SSH has to be in
+          # single quotes too. For simplicity lets call those two functions
+          # above GetString() and Base64(). So we'll start with:
+          #    ssh host 'GetString(Base64('
+          # We've closed that string, now we add the single quote we want there,
+          # as well as the stuff inside of those double quotes, so we'll add:
+          #    '#{cc}'))
+          # but that must be in double quotes since we're using single quotes.
+          # Put that together:
+          #    ssh host 'GetString(Base64('"'#{cc}'))"
+          #             ^-----------------^^---------^
+          #              string 1           string2
+          # No we're doing with needing single quotes inside of our string, go
+          # back to using single-quotes so no variables get interpolated. We now
+          # add: ' | powershell.exe -c -; exit $LASTEXITCODE'
+          #   ssh host 'GetString(Base64('"'#{cc}'))"' | powershell.exe ...'
+          #            ^-----------------^^---------^^---------------------^
+          #
+          # More than you ever wanted to know about shell. You're welcome.
+          #
+          # But now we have to put it inside of a ruby string, :)
+
+          # just for readability, put these crazy function names inside of
+          # variables
+          fun1 = '[Text.Encoding]::Utf8.GetString'
+          fun2 = '[Convert]::FromBase64String'
+          cmd += "'#{fun1}(#{fun2}('\"'#{cc}'))\"' | "
+          #       ^----------------^ ^----------^^---
+          #        single-q           double-q    single-q
+          #        string 1           string2     string3
+          cmd += 'powershell.exe -c -; exit $LASTEXITCODE\''
+          #       ----------------------------------------^
+          #       continued string3
+        else
+          cmd += "\"echo '#{cc}' | base64 --decode"
+          if TasteTester::Config.user != 'root'
+            cmd += ' | sudo bash -x"'
+          else
+            cmd += ' | bash -x"'
+          end
+        end
+        cmd
+      end
+    end
+  end
+end