taste_tester 0.0.15 → 0.0.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ba0813aa4a09d92549bb1555bef69e883a49b4ef292b9a2d7cc14dca77bce0e
-  data.tar.gz: 4a51383665bad129bba1e5e4d2e1d9df991eb021700ce6dc9ab1098fa8089ad5
+  metadata.gz: 945fe28beeb0251fc2b6236c833e77b8b0f6e7b2242c9f7d4882bd4fcf270506
+  data.tar.gz: 1001f712736d466b1fe1db53332d7668ebebf028d62a8566c2923ee88db2f0d4
 SHA512:
-  metadata.gz: 612005359c48c5cee20cb95e4c8880a087f1638887de099e0cd15dd99757b54a3e404643241289286c7d33ff9f29ed25dcd64d9bcefcefc2a9b36dfe97fbb6f0
-  data.tar.gz: 99fae7d5975e0a9c05d1ca0e68c18c03a237eb4e4b17c8e870b16d71e8a434717a01d81dc0aad2b15b35ee1fbc292c3dad230c29ab92f362059f2d5285808de7
+  metadata.gz: ccf12a4962ae584ff10f2b0b7782a48d2e9e04f320a0b592895b3ec545a2921372ccd4e5e9b8994435791fbe281fe9d9043881b2f780f6aadd60ec64613e910f
+  data.tar.gz: 5b8f422febc1b1f8d2bee6a408aaff95a1dbd41011ad267c4637180a53214219fc44d725543160866ea8947bacd5eec68e002d6afc87352f7fa721fed05157ea

data/bin/taste-tester

@@ -39,6 +39,15 @@ module TasteTester
     exit(1)
   end
 
+  # Do an initial read of the config file if it's in the default place, so
+  # that if people override chef_client_command the help message is correct.
+  if File.exists?(File.expand_path(TasteTester::Config.config_file))
+    TasteTester::Config.from_file(
+      File.expand_path(TasteTester::Config.config_file),
+    )
+  end
+
+  cmd = TasteTester::Config.chef_client_command
   description = <<-ENDOFDESCRIPTION
 Welcome to taste-tester!
 
@@ -48,18 +57,17 @@ TLDR; Most common usage is:
   vi cookbooks/...              # Make your changes and commit locally
   taste-tester test -s [host]   # Put host in test mode
   ssh root@[host]               # Log on host
-    # Run chef and watch it break
+  #{format('%-28s', "  #{cmd}")}  # Run chef and watch it break
   vi cookbooks/...              # Fix your cookbooks
   taste-tester upload           # Upload the diff
   ssh root@[host]               # Log on host
-    # Run chef and watch it succeed
+  #{format('%-28s', "  #{cmd}")}  # Run chef and watch it succeed
   <#{verify}>
   taste-tester untest -s [host] # Put host back in production
                                 #   (optional - will revert itself after 1 hour)
 
 And you're done!
-Note: There may be site specific changes, e.g. instead of chef-client you may
-use a wrapper. See local documentation for details.
+Note: There may be site specific testing instructions, see local documentation for details.
 
 MODES:
   test
@@ -100,6 +108,11 @@ MODES:
   status
     Print out the state of the world.
 
+  run
+    Run #{cmd} on the machine specified by '-s' over SSH and print the output.
+    NOTE!! This is #{'NOT'.red} a sufficient test, you must log onto the remote
+    machine and verify the changes you are trying to make are actually present.
+
   stop
     You probably don't want this. It will shutdown the chef-zero server on
     your localhost.
@@ -429,6 +442,8 @@ MODES:
       TasteTester::Commands.test
     when :untest
       TasteTester::Commands.untest
+    when :run
+      TasteTester::Commands.runchef
     when :upload
       TasteTester::Commands.upload
     when :impact

data/lib/taste_tester/commands.rb

@@ -149,6 +149,19 @@ module TasteTester
       end
     end
 
+    def self.runchef
+      hosts = TasteTester::Config.servers
+      unless hosts
+        logger.warn('You must provide a hostname')
+        exit(1)
+      end
+      server = TasteTester::Server.new
+      hosts.each do |hostname|
+        host = TasteTester::Host.new(hostname, server)
+        host.runchef
+      end
+    end
+
     def self.keeptesting
       hosts = TasteTester::Config.servers
       unless hosts

data/lib/taste_tester/config.rb

@@ -45,6 +45,7 @@ module TasteTester
     knife_config "#{ENV['HOME']}/.chef/knife-#{ENV['USER']}-taste-tester.rb"
     checksum_dir "#{ENV['HOME']}/.chef/checksums"
     skip_repo_checks false
+    chef_client_command 'chef-client'
     testing_time 3600
     chef_port_range [5000, 5500]
     tunnel_port 4001

data/lib/taste_tester/host.rb

@@ -44,6 +44,24 @@ module TasteTester
       end
     end
 
+    def runchef
+      logger.warn("Running '#{TasteTester::Config.chef_client_command}' " +
+                  "on #{@name}")
+      transport = get_transport
+      transport << TasteTester::Config.chef_client_command
+
+      io = IO.new(1)
+      status, = transport.run(io)
+      logger.warn("Finished #{TasteTester::Config.chef_client_command}" +
+                  " on #{@name} with status #{status}")
+      if status.zero?
+        msg = "#{TasteTester::Config.chef_client_command} was successful" +
+              ' - please log to the host and confirm all the intended' +
+              ' changes were made'
+        logger.error msg.upcase
+      end
+    end
+
     def get_transport
       case TasteTester::Config.transport
       when 'locallink'

data/lib/taste_tester/server.rb

@@ -16,7 +16,6 @@
 
 require 'fileutils'
 require 'socket'
-require 'timeout'
 
 require 'between_meals/util'
 require 'taste_tester/config'

data/lib/taste_tester/ssh.rb

@@ -34,48 +34,54 @@ module TasteTester
 
     alias << add
 
-    def run
-      exec(cmd, logger)
+    def run(stream = nil)
+      exec(cmd, logger, stream)
     end
 
-    def run!
-      exec!(cmd, logger)
+    def run!(stream = nil)
+      exec!(cmd, logger, stream)
     rescue StandardError => e
       logger.error(e.message)
       error!
     end
 
     def error!
-      error = <<-ERRORMESSAGE
+      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}
+
+    #{ssh_base_cmd} -v #{TasteTester::Config.user}@#{@host}
+
 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
-      error.lines.each { |x| logger.error x.strip }
+      logger.error(error)
       fail TasteTester::Exceptions::SshError
     end
 
     private
 
+    def ssh_base_cmd
+      jumps = TasteTester::Config.jumps ? "-J #{TasteTester::Config.jumps}" : ''
+      "#{TasteTester::Config.ssh_command} #{jumps}"
+    end
+
     def cmd
       @cmds.each do |cmd|
         logger.info("Will run: '#{cmd}' on #{@host}")
       end
       cmds = @cmds.join(' && ')
-      jumps = TasteTester::Config.jumps ? "-J #{TasteTester::Config.jumps}" : ''
-      cmd = "#{TasteTester::Config.ssh_command} #{jumps} " +
-            '-T -o BatchMode=yes ' +
+      cmd = "#{ssh_base_cmd} -T -o BatchMode=yes " +
             "-o ConnectTimeout=#{TasteTester::Config.ssh_connect_timeout} " +
             "#{TasteTester::Config.user}@#{@host} "
+      cc = Base64.encode64(cmds).delete("\n")
+      cmd += "\"echo '#{cc}' | base64 --decode"
       if TasteTester::Config.user != 'root'
-        cc = Base64.encode64(cmds).delete("\n")
-        cmd += "\"echo '#{cc}' | base64 --decode | sudo bash -x\""
+        cmd += ' | sudo bash -x"'
       else
-        cmd += "\'#{cmds}\'"
+        cmd += ' | bash -x"'
       end
       cmd
     end

data/lib/taste_tester/tunnel.rb

@@ -25,12 +25,6 @@ module TasteTester
     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
@@ -43,13 +37,99 @@ module TasteTester
     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}"
+
+      # 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)
+      cmds = <<~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} && \
+      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
       # As great as it would be to have ExitOnForwardFailure=yes,
       # we had multiple cases of tunnels dying
       # if -f and ExitOnForwardFailure are used together.
@@ -61,14 +141,17 @@ module TasteTester
             "-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} " +
+            '-o ServerAliveInterval=10 -o ServerAliveCountMax=6 ' +
             "-f -R #{@port}:localhost:#{@server.port} "
+      cc = Base64.encode64(cmds).delete("\n")
+
+      # always base64 encode the command so we don't have to deal with quoting
+      cmd += "#{TasteTester::Config.user}@#{@host} \"echo '#{cc}' | base64" +
+             ' --decode'
       if TasteTester::Config.user != 'root'
-        cc = Base64.encode64(cmds).delete("\n")
-        cmd += "#{TasteTester::Config.user}@#{@host} \"echo '#{cc}' | base64" +
-               ' --decode | sudo bash -x"'
+        cmd += ' | sudo bash -x"'
       else
-        cmd += "root@#{@host} '#{cmds}'"
+        cmd += ' | bash -x"'
       end
       cmd
     end
@@ -79,11 +162,8 @@ 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 '
-      end
       cmd = "( [ -s #{TasteTester::Config.timestamp_file} ]" +
-            " && #{sudo}kill -9 -- " +
+            ' && kill -9 -- ' +
             "-\$(cat #{TasteTester::Config.timestamp_file}) 2>/dev/null; " +
             ' true )'
       ssh << cmd

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: taste_tester
 version: !ruby/object:Gem::Version
-  version: 0.0.15
+  version: 0.0.16
 platform: ruby
 authors:
 - Phil Dibowitz
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-19 00:00:00.000000000 Z
+date: 2020-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: between_meals
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.6
+        version: 0.0.10
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.6
+        version: 0.0.10
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -166,7 +166,7 @@ files:
 - scripts/taste-untester
 homepage: https://github.com/facebook/taste-tester
 licenses:
-- Apache
+- Apache-2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []