taste_tester 0.0.14 → 0.0.19

data/lib/taste_tester/locallink.rb

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

data/lib/taste_tester/noop.rb

@@ -22,8 +22,6 @@ module TasteTester
     include TasteTester::Logging
     include BetweenMeals::Util
 
-    attr_reader :output, :status
-
     def initialize
       print_noop_warning
       @host = 'localhost'
@@ -48,7 +46,7 @@ module TasteTester
     alias << add
 
     def run
-      @status, @output = run!
+      run!
     end
 
     def run!

data/lib/taste_tester/server.rb

@@ -16,7 +16,6 @@
 
 require 'fileutils'
 require 'socket'
-require 'timeout'
 
 require 'between_meals/util'
 require 'taste_tester/config'
@@ -65,10 +64,10 @@ module TasteTester
       # 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 StandardError
@@ -162,7 +161,7 @@ module TasteTester
     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,
@@ -175,7 +174,8 @@ module TasteTester
         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'

data/lib/taste_tester/ssh.rb

@@ -15,14 +15,14 @@
 # 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
-
-    attr_reader :output, :status
+    include TasteTester::SSH::Util
 
     def initialize(host, tunnel = false)
       @host = host
@@ -36,47 +36,24 @@ 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)
+    def run!(stream = nil)
+      exec!(cmd, logger, stream)
     rescue StandardError => e
       logger.error(e.message)
       error!
     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
-  #{TasteTester::Config.ssh_command} -v #{TasteTester::Config.user}@#{@host}
-and come back once that works
-      ERRORMESSAGE
-      error.lines.each { |x| logger.error x.strip }
-      fail TasteTester::Exceptions::SshError
-    end
-
     private
 
     def cmd
       @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=#{TasteTester::Config.ssh_connect_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

data/lib/taste_tester/state.rb

@@ -91,7 +91,10 @@ module TasteTester
     end
 
     def bundle
-      TasteTester::State.read(:bundle)
+      val = TasteTester::State.read(:bundle)
+      # promote value to symbol to match config value.
+      return :compatible if val == 'compatible'
+      val
     end
 
     def bundle=(bundle)
@@ -116,7 +119,7 @@ module TasteTester
 
     def real_wipe
       if TasteTester::Config.ref_file &&
-         File.exists?(TasteTester::Config.ref_file)
+         File.exist?(TasteTester::Config.ref_file)
         File.delete(TasteTester::Config.ref_file)
       end
     end

data/lib/taste_tester/tunnel.rb

@@ -14,62 +14,49 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require 'taste_tester/logging'
+require 'between_meals/util'
+require 'taste_tester/ssh_util'
+
 module TasteTester
   # Thin ssh tunnel wrapper
   class Tunnel
     include TasteTester::Logging
     include BetweenMeals::Util
+    include TasteTester::SSH::Util
 
     attr_reader :port
 
     def initialize(host, server)
       @host = host
       @server = server
-      if TasteTester::Config.testing_until
-        @delta_secs = TasteTester::Config.testing_until.strftime('%s').to_i -
-                      Time.now.strftime('%s').to_i
-      else
-        @delta_secs = TasteTester::Config.testing_time
-      end
     end
 
     def run
       @port = TasteTester::Config.tunnel_port
       logger.info("Setting up tunnel on port #{@port}")
-      @status, @output = exec!(cmd, logger)
+      exec!(cmd, logger)
     rescue StandardError => e
       logger.error "Failed bringing up ssh tunnel: #{e}"
-      exit(1)
+      error!
     end
 
     def cmd
-      @max_ping = @delta_secs / 10
-      pid = '$$'
-      @ts = TasteTester::Config.testing_end_time.strftime('%y%m%d%H%M.%S')
-      cmds = "ps -o pgid= -p $(ps -o ppid= -p #{pid}) | sed \"s| ||g\" " +
-             " > #{TasteTester::Config.timestamp_file} &&" +
-             " touch -t #{@ts} #{TasteTester::Config.timestamp_file} &&" +
-             " sleep #{@delta_secs}"
+      if TasteTester::Config.windows_target
+        cmds = windows_tunnel_cmd
+      else
+        cmds = sane_os_tunnel_cmd
+      end
+
       # As great as it would be to have ExitOnForwardFailure=yes,
       # we had multiple cases of tunnels dying
       # if -f and ExitOnForwardFailure are used together.
       # In most cases the first request from chef was "breaking" the tunnel,
       # in a way that port was still open, but subsequent requests were hanging.
       # This is reproducible and should be looked into.
-      cmd = "#{TasteTester::Config.ssh_command} " +
-            "-o ConnectTimeout=#{TasteTester::Config.ssh_connect_timeout} " +
-            '-T -o BatchMode=yes ' +
-            '-o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no ' +
-            "-o ServerAliveInterval=10 -o ServerAliveCountMax=#{@max_ping} " +
-            "-f -R #{@port}:localhost:#{@server.port} "
-      if TasteTester::Config.user != 'root'
-        cc = Base64.encode64(cmds).delete("\n")
-        cmd += "#{TasteTester::Config.user}@#{@host} \"echo '#{cc}' | base64" +
-               ' --decode | sudo bash -x"'
-      else
-        cmd += "root@#{@host} '#{cmds}'"
-      end
-      cmd
+      cmd = "#{ssh_base_cmd} -o ServerAliveInterval=10 " +
+        "-o ServerAliveCountMax=6 -f -R #{@port}:localhost:#{@server.port} "
+      build_ssh_cmd(cmd, [cmds])
     end
 
     def self.kill(name)
@@ -78,15 +65,165 @@ module TasteTester
       # surround this in paryns, and make sure as a whole it evaluates
       # to true so it doesn't mess up other things... even though this is
       # the only thing we're currently executing in this SSH.
-      if TasteTester::Config.user != 'root'
-        sudo = 'sudo '
+      if TasteTester::Config.windows_target
+        cmd = <<~EOPS
+          if (Test-Path "#{TasteTester::Config.timestamp_file}") {
+            $x = cat "#{TasteTester::Config.timestamp_file}"
+            if ($x -ne $null) {
+              kill -Force $x 2>$null
+            }
+          }
+          $LASTEXITCODE = 0
+        EOPS
+      else
+        cmd = "( [ -s #{TasteTester::Config.timestamp_file} ]" +
+              ' && kill -9 -- ' +
+              "-\$(cat #{TasteTester::Config.timestamp_file}) 2>/dev/null; " +
+              ' true )'
       end
-      cmd = "( [ -s #{TasteTester::Config.timestamp_file} ]" +
-            " && #{sudo}kill -9 -- " +
-            "-\$(cat #{TasteTester::Config.timestamp_file}) 2>/dev/null; " +
-            ' true )'
       ssh << cmd
       ssh.run!
     end
+
+    private
+
+    def windows_tunnel_cmd
+      # We are powershell. If you walk up you get:
+      #   ppid - ssh
+      #   pppid - ssh
+      #   ppppid - ssh
+      #   pppppid - services
+      #
+      # Unlike in Linux you don't need to walk up the tree, however. In fact,
+      # killing pppid or ppid didn't actually terminate the session. Only
+      # killing our actual powershell instance did.
+      #
+      # Moreover, it doesn't seem like re-parenting works the same way. So
+      # this is pretty simple.
+      #
+      # For the record, if you want to play with this, you do so with:
+      #   (gwmi win32_process | ? processid -eq $PID).parentprocessid
+      #
+      # Also note that backtick is a line-continuation marker in powershell.
+      <<~EOS
+      $ts = "#{TasteTester::Config.timestamp_file}"
+      echo $PID | Out-File -Encoding ASCII "$ts"
+      # TODO: pull this from Host.touchcmd
+      (Get-Item "$ts").LastWriteTime=("#{TasteTester::Config.testing_end_time}")
+
+      while ($true) {
+        if (-Not (Test-Path $ts)) {
+          # if we are here, we know we've created our source
+          $splat = @{
+            LogName = "Application"
+            Source = "taste-tester"
+            EventID = 5
+            EntryType = "Information"
+            Message = "Ending tunnel: timestamp file disappeared"
+          }
+          Write-EventLog @splat
+          break
+        }
+        sleep 60
+      }
+      done
+      EOS
+    end
+
+    def sane_os_tunnel_cmd
+      @ts = TasteTester::Config.testing_end_time.strftime('%y%m%d%H%M.%S')
+      # Tie the life of our SSH tunnel with the life of timestamp file.
+      # taste-testing can be renewed, so we'll wait until:
+      # 1. the timestamp file is entirely gone
+      # 2. our parent sshd process dies
+      # 3. new taste-tester instance is running (file contains different PGID)
+      <<~EOS
+      log() {
+        [ -e /usr/bin/logger ] || return
+        logger -t taste-tester "$*"
+      }
+      # sets $current_pgid
+      # This is important, this should just be called ald let it set the
+      # variable. Do NOT call in a subshell like foo=$(get_current_pgid)
+      # as then you end up even further down the list of children
+      get_current_pgid() {
+
+        # if TT user is non-root, then it breaks down like this:
+        #   we are 'bash'
+        #   our parent is 'sudo'
+        #   our parent's parent is 'bash "echo ..." | sudo bash -x'
+        #   our parent's parent's parent is ssh
+        #   - we want the progress-group ID of *that*
+        #
+        # EXCEPT... sometimes sudo forks itself one more time so it's
+        #   we are 'bash'
+        #   our parent is 'sudo'
+        #   our parent's parent 'sudo'
+        #   our parent's parent's parent is 'bash "echo ..." | sudo bash -x'
+        #   our parent's parent's parent's parent is ssh
+        #   - we want the progress-group ID of *that*
+        #
+        # BUT if the TT user is root, no sudo at all...
+        #   we are 'bash'
+        #   our parent is 'bash "echo ..." | bash -c
+        #   our parent's parent is ssh
+        #   - we want the progress-group ID of *that*
+        #
+        # We can make all sorts of assumptions, but the most reliable way
+        # to do this that's always correct is to is simply to walk parents until
+        # we hit something with SSH in the name. Start with PPID and go from
+        # there.
+        #
+        # There's a few commented out 'log's here that are too verbose
+        # for operation (since this function runs every minute)  but are useful
+        # for debugging.
+
+        relevant_pid=''
+        current_pid=$PPID
+        while true; do
+          name=$(ps -o command= -p $current_pid)
+          if [[ "$name" =~ sshd ]]; then
+            # Uncomment the following for debugging...
+            #log "$current_pid is ssh, that's us!"
+            relevant_pid=$current_pid
+            break
+          fi
+          # Uncomment the following for debugging...
+          #log "$current_pid is $name, finding parent..."
+          current_pid=$(ps -o ppid= -p $current_pid)
+        done
+        if [ -z "$relevant_pid" ];then
+          log "Cannot determine relevant PGID"
+          exit 42
+        fi
+        current_pgid="$(ps -o pgid= -p $relevant_pid | sed "s| ||g")"
+        # Uncomment the following for debugging...
+        #log "PGID of ssh ($relevant_pid) is $current_pgid"
+      }
+      get_current_pgid
+      SSH_PGID=$current_pgid
+
+      echo $SSH_PGID > #{TasteTester::Config.timestamp_file} && \
+      # TODO: pull this from Host.touchcmd
+      touch -t #{@ts} #{TasteTester::Config.timestamp_file} && \
+      while true; do
+        if ! [ -f "#{TasteTester::Config.timestamp_file}" ]; then
+          log "Ending tunnel: timestamp file disappeared"
+          break
+        fi
+        current_pid="$(cat #{TasteTester::Config.timestamp_file})"
+        if ! [ "$current_pid" = "$SSH_PGID" ]; then
+          log "Ending tunnel: timestamp PGID changed"
+          break
+        fi
+        get_current_pgid
+        if ! [ "$current_pgid" = "$SSH_PGID" ]; then
+          log "Ending tunnel: timestamp PGID isn't ours"
+          break
+        fi
+        sleep 60
+      done
+      EOS
+    end
   end
 end