taste_tester 0.0.16 → 0.0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 945fe28beeb0251fc2b6236c833e77b8b0f6e7b2242c9f7d4882bd4fcf270506
-  data.tar.gz: 1001f712736d466b1fe1db53332d7668ebebf028d62a8566c2923ee88db2f0d4
+  metadata.gz: 01cc261c810b1efa71e7eba767be42c7292a2e7ebfa1f0ad2a81cb0aab465504
+  data.tar.gz: 2891b4d9a14b03183b24dc2fd3baada23b3a86e0ba741eb2ff43ed4e9bb15ef0
 SHA512:
-  metadata.gz: ccf12a4962ae584ff10f2b0b7782a48d2e9e04f320a0b592895b3ec545a2921372ccd4e5e9b8994435791fbe281fe9d9043881b2f780f6aadd60ec64613e910f
-  data.tar.gz: 5b8f422febc1b1f8d2bee6a408aaff95a1dbd41011ad267c4637180a53214219fc44d725543160866ea8947bacd5eec68e002d6afc87352f7fa721fed05157ea
+  metadata.gz: aa9dee7d09f5a0ffd03c63d2bd96cabde536b498fb8f4efeab8fbfd564ecb21166954200f8d62702833b3c7977aba0b979e920e93d047a27e9ea4d5538d88dbf
+  data.tar.gz: 593d8b054ff209d1c5ed116d90a00bca9bb2a64a3d8e2c576e068e91321d286a3e2b30347179d22dafc09ca4525c70c2d49351e8b838fa3c8063ed5a006a89e4

data/README.md

@@ -1,7 +1,6 @@
 # Taste Tester
 
-[![TravisCI](https://travis-ci.org/facebook/taste-tester.svg)](http://travis-ci.org/facebook/taste-tester)
-[![CircleCI](https://circleci.com/gh/facebook/taste-tester.svg?style=svg)](https://circleci.com/gh/facebook/taste-tester)
+![Continuous Integration](https://github.com/facebook/taste-tester/workflows/Continuous%20Integration/badge.svg?event=push)
 
 ## Intro
 Ohai!
@@ -106,7 +105,7 @@ The following options are also available:
 * base_dir - The directory in the repo under which to find chef configs.
   Default: `chef`
 * cookbook_dirs - An array of cookbook directories relative to base_dir.
-  Default: `['cookbooks']
+  Default: `['cookbooks']`
 * role_dir - A directory of roles, relative to base_dir. Default: `roles`
 * databag_dir - A directory of databags, relative to base_dir.
   Default: `databags`
@@ -123,7 +122,6 @@ The following options are also available:
 * impact - analyze local changes to determine which hosts/roles to test.
   Default: false
 
-
 ## Plugin
 
 The plugin should be a ruby file which defines several class methods. It is
@@ -181,10 +179,11 @@ Custom output of calculated impact, useful if defining either of the other
 impact hooks. Must return a truthy value to prevent the default output from
 printing.
 
-**Plugin example**
+## Plugin example
 
 This is an example `/etc/taste-tester-plugin.rb` to add a user-defined string
 to `client-taste-tester.rb` on the remote system:
+
 ```
 Hooks.class_eval do
   def self.test_remote_client_rb_extra_code(_hostname)
@@ -195,6 +194,7 @@ Hooks.class_eval do
   end
 end
 ```
+
 Be sure to pass this plugin file with `-p` on the command line or set it as
 `plugin_path` in your `taste-tester-config.rb` file.
 

data/bin/taste-tester

@@ -41,7 +41,7 @@ module TasteTester
 
   # 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))
+  if File.exist?(File.expand_path(TasteTester::Config.config_file))
     TasteTester::Config.from_file(
       File.expand_path(TasteTester::Config.config_file),
     )
@@ -136,7 +136,6 @@ MODES:
   end
 
   options = { :config_file => TasteTester::Config.config_file }
-  # rubocop:disable Metrics/BlockLength
   parser = OptionParser.new do |opts|
     opts.banner = description
 
@@ -144,7 +143,7 @@ MODES:
     opts.separator 'Global options:'.upcase
 
     opts.on('-c', '--config FILE', 'Config file') do |file|
-      unless File.exists?(File.expand_path(file))
+      unless File.exist?(File.expand_path(file))
         logger.error("Sorry, cannot find #{file}")
         exit(1)
       end
@@ -161,7 +160,7 @@ MODES:
     end
 
     opts.on('-p', '--plugin-path FILE', String, 'Plugin file') do |file|
-      unless File.exists?(File.expand_path(file))
+      unless File.exist?(File.expand_path(file))
         logger.error("Sorry, cannot find #{file}")
         exit(1)
       end
@@ -245,6 +244,7 @@ MODES:
       'Until when should the host remain in testing.' +
       ' Anything parsable is ok, such as "5/18 4:35" or "16/9/13".'
     ) do |time|
+      # can make this an implicit rescue after we drop ruby 2.4
       begin
         options[:testing_until] = Time.parse(time)
       rescue StandardError
@@ -368,6 +368,15 @@ MODES:
       options[:json] = true
     end
 
+    opts.on(
+      '-w', '--windows-target',
+      'The target is a Windows machine. You will likely want to override ' +
+      '`test_timestamp` and `chef_config_path`, but *not* `config_file`. ' +
+      'Requires the target be running PowerShell >= 5.1 as the default shell.'
+    ) do
+      options[:windows_target] = true
+    end
+
     opts.separator ''
     opts.separator 'Control local hook behavior with these options:'
 
@@ -401,7 +410,6 @@ MODES:
       options[:skip_post_test_hook] = true
     end
   end
-  # rubocop:enable Metrics/BlockLength
 
   if mode == 'help'
     puts parser
@@ -410,7 +418,7 @@ MODES:
 
   parser.parse!
 
-  if File.exists?(File.expand_path(options[:config_file]))
+  if File.exist?(File.expand_path(options[:config_file]))
     TasteTester::Config.from_file(File.expand_path(options[:config_file]))
   end
   TasteTester::Config.merge!(options)
@@ -419,7 +427,7 @@ MODES:
 
   if TasteTester::Config.plugin_path
     path = File.expand_path(TasteTester::Config.plugin_path)
-    unless File.exists?(path)
+    unless File.exist?(path)
       logger.error("Plugin not found (#{path})")
       exit(1)
     end
@@ -459,5 +467,7 @@ MODES:
 end
 
 if $PROGRAM_NAME == __FILE__
-  include TasteTester
+  module TasteTester
+    include TasteTester
+  end
 end

data/lib/taste_tester/client.rb

@@ -136,53 +136,48 @@ module TasteTester
       # everything is relative to the repo dir. chdir makes handling all the
       # paths within this simpler
       Dir.chdir(full_path) do
-        Find.find('.') do |p|
-          # ignore current directory. The File.directory? would also skip it,
-          # but we need to do it early because the string is too short for the
-          # next statement.
-          next if p == '.'
-          # paths are enumerated as relative to the input path '.', so we get
-          # './dir/file'. Stripping off the first two characters gives us a
-          # a cleaner 'dir/file' path.
-          relative_name = p[2..-1]
-          # some exclusions are rooted relative to cookbooks which are one
-          # level below the directory included here. Strip off the first part
-          # of the path. e.g. `fb_cookbook/spec/foo.rb` would be `spec/foo.rb`
-          # which matches `spec/*`.
-          relative_name_minus_first = relative_name.split(
-            File::SEPARATOR,
-          )[1..-1].join(File::SEPARATOR)
-          next if chefignores.ignored?(relative_name) ||
-            chefignores.ignored?(relative_name_minus_first)
-          name = File.join(destination, relative_name)
-          if File.directory?(p)
-            # skip it. This also handles symlinks to directories which aren't
-            # useful either.
-          elsif File.symlink?(p)
-            # tar handling of filenames > 100 characters gets complex. We'd use
-            # split_name from Minitar, but it's a private method. It's
-            # reasonable to assume that all symlink names in the bundle are
-            # less than 100 characters long. Long term, the version of minitar
-            # in chefdk should be upgraded.
-            fail 'Add support for long symlink paths' if name.size > 100
-            # The version of Minitar included in chefdk does not support
-            # symlinks directly. Therefore we use direct writes to the
-            # underlying stream to reproduce the symlinks
-            symlink = {
-              :name => name,
-              :mode => 0644,
-              :typeflag => '2',
-              :size => 0,
-              :linkname => File.readlink(p),
-              :prefix => '',
-            }
-            stream.write(Minitar::PosixHeader.new(symlink))
-          else
-            File.open(p, 'rb') do |r|
-              writer.add_file_simple(
-                name, :mode => 0644, :size => File.size(r)
-              ) do |d, _opts|
-                IO.copy_stream(r, d)
+        look_at = ['']
+        while (prefix = look_at.pop)
+          Dir.glob(File.join("#{prefix}**", '*'), File::FNM_DOTMATCH) do |p|
+            minus_first = p.split(
+              File::SEPARATOR,
+            )[1..-1].join(File::SEPARATOR)
+            next if chefignores.ignored?(p) ||
+              chefignores.ignored?(minus_first)
+            name = File.join(destination, p)
+            if File.directory?(p)
+              # we don't store directories in the tar, but we do want to follow
+              # top level symlinked directories as they are used to share
+              # cookbooks between codebases.
+              if minus_first == '' && File.symlink?(p)
+                look_at.push("#{p}#{File::SEPARATOR}")
+              end
+            elsif File.symlink?(p)
+              # tar handling of filenames > 100 characters gets complex. We'd
+              # use split_name from Minitar, but it's a private method. It's
+              # reasonable to assume that all symlink names in the bundle are
+              # less than 100 characters long. Long term, the version of minitar
+              # in chefdk should be upgraded.
+              fail 'Add support for long symlink paths' if name.size > 100
+              # The version of Minitar included in chefdk does not support
+              # symlinks directly. Therefore we use direct writes to the
+              # underlying stream to reproduce the symlinks
+              symlink = {
+                :name => name,
+                :mode => 0644,
+                :typeflag => '2',
+                :size => 0,
+                :linkname => File.readlink(p),
+                :prefix => '',
+              }
+              stream.write(Minitar::PosixHeader.new(symlink))
+            else
+              File.open(p, 'rb') do |r|
+                writer.add_file_simple(
+                  name, :mode => 0644, :size => File.size(r)
+                ) do |d, _opts|
+                  IO.copy_stream(r, d)
+                end
               end
             end
           end

data/lib/taste_tester/config.rb

@@ -63,6 +63,7 @@ module TasteTester
     no_repo false
     json false
     jumps nil
+    windows_target false
 
     # Start/End refs for calculating changes in the repo.
     #  - start_ref should be the "master" commit of the repository

data/lib/taste_tester/hooks.rb

@@ -66,7 +66,7 @@ module TasteTester
     def self.get(file)
       path = File.expand_path(file)
       logger.warn("Loading plugin at #{path}") unless TasteTester::Config.json
-      unless File.exists?(path)
+      unless File.exist?(path)
         logger.error('Plugin file not found')
         exit(1)
       end

data/lib/taste_tester/host.rb

@@ -92,20 +92,11 @@ module TasteTester
       # see if someone else is taste-testing
       transport << we_testing
 
-      transport << 'logger -t taste-tester Moving server into taste-tester' +
-        " for #{@user}"
-      transport << touchcmd
-      # shell redirection is also racy, so make a temporary file first
-      transport << "tmpconf=$(mktemp #{TasteTester::Config.chef_config_path}/" +
-        "#{TASTE_TESTER_CONFIG}.TMPXXXXXX)"
-      transport << "/bin/echo -n \"#{serialized_config}\" | base64 --decode" +
-        ' > "${tmpconf}"'
-      # then rename it to replace any existing file
-      transport << 'mv -f "${tmpconf}" ' +
-        "#{TasteTester::Config.chef_config_path}/#{TASTE_TESTER_CONFIG}"
-      transport << "( ln -vsf #{TasteTester::Config.chef_config_path}" +
-        "/#{TASTE_TESTER_CONFIG} #{TasteTester::Config.chef_config_path}/" +
-        "#{TasteTester::Config.chef_config}; true )"
+      if TasteTester::Config.windows_target
+        add_windows_test_cmds(transport, serialized_config)
+      else
+        add_sane_os_test_cmds(transport, serialized_config)
+      end
 
       # look again to see if someone else is taste-testing. This is where
       # we work out if we won or lost a race with another user.
@@ -142,18 +133,10 @@ module TasteTester
       if TasteTester::Config.use_ssh_tunnels
         TasteTester::Tunnel.kill(@name)
       end
-      config_prod = TasteTester::Config.chef_config.split('.').join('-prod.')
-      [
-        "ln -vsf #{TasteTester::Config.chef_config_path}/#{config_prod} " +
-          "#{TasteTester::Config.chef_config_path}/" +
-          TasteTester::Config.chef_config,
-        "ln -vsf #{TasteTester::Config.chef_config_path}/client-prod.pem " +
-          "#{TasteTester::Config.chef_config_path}/client.pem",
-        "rm -vf #{TasteTester::Config.chef_config_path}/#{TASTE_TESTER_CONFIG}",
-        "rm -vf #{TasteTester::Config.timestamp_file}",
-        'logger -t taste-tester Returning server to production',
-      ].each do |cmd|
-        transport << cmd
+      if TasteTester::Config.windows_target
+        add_windows_untest_cmds(transport)
+      else
+        add_sane_os_untest_cmds(transport)
       end
       transport.run!
     end
@@ -168,15 +151,31 @@ module TasteTester
       #    short circuits the test verb
       # This is written as a squiggly heredoc so the indentation of the awk is
       # preserved. Later we remove the newlines to make it a bit easier to read.
-      shellcode = <<~ENDOFSHELLCODE
-        awk "\\$0 ~ /^#{USER_PREAMBLE}/{
-          if (\\$NF != \\"#{@user}\\"){
-            print \\$NF;
-            exit 42
+      if TasteTester::Config.windows_target
+        shellcode = <<~ENDOFSHELLCODE
+          Get-Content #{config_file} | ForEach-Object {
+            if (\$_ -match "#{USER_PREAMBLE}" ) {
+              $user = \$_.Split()[-1]
+              if (\$user -ne "#{@user}") {
+                echo \$user
+                exit 42
+              }
+            }
           }
-        }" #{config_file}
-      ENDOFSHELLCODE
-      shellcode.delete("\n")
+        ENDOFSHELLCODE
+        shellcode.chomp
+      else
+        shellcode = <<~ENDOFSHELLCODE
+          awk "\\$0 ~ /^#{USER_PREAMBLE}/{
+            if (\\$NF != \\"#{@user}\\"){
+              print \\$NF;
+              exit 42
+            }
+          }" #{config_file}
+        ENDOFSHELLCODE
+        shellcode.delete("\n")
+      end
+      shellcode
     end
 
     def keeptesting
@@ -195,15 +194,140 @@ module TasteTester
 
     private
 
+    # Sources must be 'registered' with the Eventlog, so check if we have
+    # registered and register if necessary
+    def create_eventlog_if_needed_cmd
+      get_src = 'Get-EventLog -LogName Application -source taste-tester 2>$null'
+      mk_src = 'New-EventLog -source "taste-tester" -LogName Application'
+      "if (-Not (#{get_src})) { #{mk_src} }"
+    end
+
+    # Remote testing commands for most OSes...
+    def add_sane_os_test_cmds(transport, serialized_config)
+      transport << 'logger -t taste-tester Moving server into taste-tester' +
+        " for #{@user}"
+      transport << touchcmd
+      # shell redirection is also racy, so make a temporary file first
+      transport << "tmpconf=$(mktemp #{TasteTester::Config.chef_config_path}/" +
+        "#{TASTE_TESTER_CONFIG}.TMPXXXXXX)"
+      transport << "/bin/echo -n \"#{serialized_config}\" | base64 --decode" +
+        ' > "${tmpconf}"'
+      # then rename it to replace any existing file
+      transport << 'mv -f "${tmpconf}" ' +
+        "#{TasteTester::Config.chef_config_path}/#{TASTE_TESTER_CONFIG}"
+      transport << "( ln -vsf #{TasteTester::Config.chef_config_path}" +
+        "/#{TASTE_TESTER_CONFIG} #{TasteTester::Config.chef_config_path}/" +
+        "#{TasteTester::Config.chef_config}; true )"
+    end
+
+    # Remote testing commands for Windows
+    def add_windows_test_cmds(transport, serialized_config)
+      # This is the closest equivalent to 'bash -x' - but if we put it on
+      # by default the way we do with linux it badly breaks our output. So only
+      # set it if we're in debug
+      #
+      # This isn't the most optimal place for this. It should be in ssh_util
+      # and we should jam this into the beggining of the cmds list we get,
+      # but this is early enough and good enough for now and we can think about
+      # that when we refactor tunnel.sh, ssh.sh and ssh_util.sh into one sane
+      # class.
+      if logger.level == Logger::DEBUG
+        transport << 'Set-PSDebug -trace 1'
+      end
+
+      ttconfig =
+        "#{TasteTester::Config.chef_config_path}/#{TASTE_TESTER_CONFIG}"
+      realconfig = "#{TasteTester::Config.chef_config_path}/" +
+        TasteTester::Config.chef_config
+      [
+        create_eventlog_if_needed_cmd,
+        'Write-EventLog -LogName "Application" -Source "taste-tester" ' +
+          '-EventID 1 -EntryType Information ' +
+          "-Message \"Moving server into taste-tester for #{@user}\"",
+        touchcmd,
+        "$b64 = \"#{serialized_config}\"",
+        "$ttconfig = \"#{ttconfig}\"",
+        "$realconfig = \"#{realconfig}\"",
+
+        '$tmp64 = (New-TemporaryFile).name',
+        '$tmp = (New-TemporaryFile).name',
+
+        '$b64 | Out-File -Encoding ASCII $tmp64 -Force',
+
+        # Remove our tmp file before we write to it or certutil crashes...
+        'if (Test-Path $tmp) { rm $tmp }',
+        'certutil -decode $tmp64 $tmp',
+        'mv $tmp $ttconfig -Force',
+
+        'New-Item -ItemType SymbolicLink -Value $ttconfig $realconfig -Force',
+      ].each do |cmd|
+        transport << cmd
+      end
+    end
+
     def touchcmd
-      touch = Base64.encode64(
-        "if [ 'Darwin' = $(uname) ]; then touch -t \"$(date -r " +
-        "#{TasteTester::Config.testing_end_time.to_i} +'%Y%m%d%H%M.%S')\" " +
-        "#{TasteTester::Config.timestamp_file}; else touch --date \"$(date " +
-        "-d @#{TasteTester::Config.testing_end_time.to_i} +'%Y-%m-%d %T')\" " +
-        "#{TasteTester::Config.timestamp_file}; fi",
-      ).delete("\n")
-      "/bin/echo -n '#{touch}' | base64 --decode | bash"
+      if TasteTester::Config.windows_target
+        # There's no good touch equivalent in Windows. You can force
+        # creation of a new file, but that'll nuke it's contents, which if we're
+        # 'keeptesting'ing, then we'll loose the contents (PID and such).
+        # We can set the timestamp with Get-Item.creationtime, but it must exist
+        # if we're not gonna crash. So do both.
+        [
+          "$ts = \"#{TasteTester::Config.timestamp_file}\"",
+          'if (-Not (Test-Path $ts)) { New-Item -ItemType file $ts }',
+          '(Get-Item "$ts").LastWriteTime=("' +
+            "#{TasteTester::Config.testing_end_time}\")",
+        ].join(';')
+      else
+        touch = Base64.encode64(
+          "if [ 'Darwin' = $(uname) ]; then touch -t \"$(date -r " +
+          "#{TasteTester::Config.testing_end_time.to_i} +'%Y%m%d%H%M.%S')\" " +
+          "#{TasteTester::Config.timestamp_file}; else touch --date \"$(date " +
+          "-d @#{TasteTester::Config.testing_end_time.to_i} +'%Y-%m-%d %T')\"" +
+          " #{TasteTester::Config.timestamp_file}; fi",
+        ).delete("\n")
+        "/bin/echo -n '#{touch}' | base64 --decode | bash"
+      end
+    end
+
+    # Remote untesting commands for Windows
+    def add_windows_untest_cmds(transport)
+      config_prod = TasteTester::Config.chef_config.split('.').join('-prod.')
+      [
+        'New-Item -ItemType SymbolicLink -Force -Value ' +
+          "#{TasteTester::Config.chef_config_path}/#{config_prod} " +
+          "#{TasteTester::Config.chef_config_path}/" +
+          TasteTester::Config.chef_config,
+        'New-Item -ItemType SymbolicLink -Force -Value ' +
+          "#{TasteTester::Config.chef_config_path}/client-prod.pem " +
+          "#{TasteTester::Config.chef_config_path}/client.pem",
+        'rm -Force ' +
+          "#{TasteTester::Config.chef_config_path}/#{TASTE_TESTER_CONFIG}",
+        "rm -Force #{TasteTester::Config.timestamp_file}",
+        create_eventlog_if_needed_cmd,
+        'Write-EventLog -LogName "Application" -Source "taste-tester" ' +
+          '-EventID 4 -EntryType Information -Message "Returning server ' +
+          'to production"',
+      ].each do |cmd|
+        transport << cmd
+      end
+    end
+
+    # Remote untesting commands for most OSes...
+    def add_sane_os_untest_cmds(transport)
+      config_prod = TasteTester::Config.chef_config.split('.').join('-prod.')
+      [
+        "ln -vsf #{TasteTester::Config.chef_config_path}/#{config_prod} " +
+          "#{TasteTester::Config.chef_config_path}/" +
+          TasteTester::Config.chef_config,
+        "ln -vsf #{TasteTester::Config.chef_config_path}/client-prod.pem " +
+          "#{TasteTester::Config.chef_config_path}/client.pem",
+        "rm -vf #{TasteTester::Config.chef_config_path}/#{TASTE_TESTER_CONFIG}",
+        "rm -vf #{TasteTester::Config.timestamp_file}",
+        'logger -t taste-tester Returning server to production',
+      ].each do |cmd|
+        transport << cmd
+      end
     end
 
     def config
@@ -295,7 +419,7 @@ module TasteTester
           chef_repo_path taste_tester_dest
         ENDOFSCRIPT
       end
-      return ttconfig
+      ttconfig
     end
   end
 end

data/lib/taste_tester/server.rb

@@ -161,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,

data/lib/taste_tester/ssh.rb

@@ -15,12 +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
+    include TasteTester::SSH::Util
 
     def initialize(host, tunnel = false)
       @host = host
@@ -45,45 +47,13 @@ module TasteTester
       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
-
-    #{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
-      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(' && ')
-      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'
-        cmd += ' | sudo bash -x"'
-      else
-        cmd += ' | bash -x"'
-      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

@@ -119,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,11 +14,16 @@
 # 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
 
@@ -33,18 +38,100 @@ module TasteTester
       exec!(cmd, logger)
     rescue StandardError => e
       logger.error "Failed bringing up ssh tunnel: #{e}"
-      exit(1)
+      error!
     end
 
     def cmd
-      @ts = TasteTester::Config.testing_end_time.strftime('%y%m%d%H%M.%S')
+      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 = "#{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)
+      ssh = TasteTester::SSH.new(name)
+      # Since commands are &&'d together, and we're using &&, we need to
+      # 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.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
+      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 (1 -eq 1) {
+        if (-Not (Test-Path $ts)) {
+          # if we are here, we know we've created our source
+          Write-EventLog -LogName "Application" -Source "taste-tester" `
+            -EventID 5 -EntryType Information `
+            -Message "Ending tunnel: timestamp file disappeared"
+        }
+        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)
-      cmds = <<~EOS
+      <<~EOS
       log() {
         [ -e /usr/bin/logger ] || return
         logger -t taste-tester "$*"
@@ -111,6 +198,7 @@ module TasteTester
       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
@@ -130,44 +218,6 @@ module TasteTester
         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.
-      # 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.
-      jumps = TasteTester::Config.jumps ? "-J #{TasteTester::Config.jumps}" : ''
-      cmd = "#{TasteTester::Config.ssh_command} #{jumps} " +
-            "-o ConnectTimeout=#{TasteTester::Config.ssh_connect_timeout} " +
-            '-T -o BatchMode=yes ' +
-            '-o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no ' +
-            '-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'
-        cmd += ' | sudo bash -x"'
-      else
-        cmd += ' | bash -x"'
-      end
-      cmd
-    end
-
-    def self.kill(name)
-      ssh = TasteTester::SSH.new(name)
-      # Since commands are &&'d together, and we're using &&, we need to
-      # 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.
-      cmd = "( [ -s #{TasteTester::Config.timestamp_file} ]" +
-            ' && kill -9 -- ' +
-            "-\$(cat #{TasteTester::Config.timestamp_file}) 2>/dev/null; " +
-            ' true )'
-      ssh << cmd
-      ssh.run!
     end
   end
 end

data/scripts/taste-untester

@@ -14,19 +14,19 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-CONFIG_PATH='/etc/chef'
-CONFIG_NAME='client'
-
-CONFIG_FILE="${CONFIG_FILE:-/etc/taste-untester-config}"
-if [ -e "$CONFIG_FILE" ]; then
-  source "$COFNIG_FILE"
-fi
-
+# default configs
 CONFLINK='/etc/chef/client.rb'
 PRODCONF='/etc/chef/client-prod.rb'
 CERTLINK='/etc/chef/client.pem'
 PRODCERT='/etc/chef/client-prod.pem'
 STAMPFILE='/etc/chef/test_timestamp'
+
+# let the config file overwrite them
+CONFIG_FILE="${CONFIG_FILE:-/etc/taste-untester-config}"
+if [ -e "$CONFIG_FILE" ]; then
+  source "$CONFIG_FILE"
+fi
+
 MYSELF=$0
 DRYRUN=0
 DEBUG=0

data/scripts/taste-untester.ps1

@@ -0,0 +1,85 @@
+# Copyright 2020-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.
+
+[CmdletBinding()]
+param(
+  [switch]$dryrun
+)
+
+# keep these as *forward* slashes
+$CONFLINK = 'C:/chef/client.rb'
+$PRODCONF = 'C:/chef/client-prod.rb'
+$CERTLINK = 'C:/chef/client.pem'
+$PRODCERT = 'C:/chef/client-prod.pem'
+$STAMPFILE = 'C:/chef/test_timestamp'
+$MYSELF = $0
+
+function log($msg) {
+  Write-EventLog -LogName "Application" -Source "taste-tester" `
+    -EventID 2 -EntryType Warning -Message $msg
+}
+
+function set_server_to_prod {
+  if (Test-Path $STAMPFILE) {
+    $content = Get-Content $STAMPFILE
+    if ($content -ne $null) {
+      kill $content -Force 2>$null
+    }
+  }
+  rm -Force $CONFLINK
+  New-Item -ItemType symboliclink -Force -Value $PRODCONF $CONFLINK
+  if (Test-Path $STAMPFILE) {
+    rm -Force $STAMPFILE
+  }
+  log "Reverted to production Chef."
+}
+
+function check_server {
+  # this is the only way to check if something is a symlink, apparently
+  if (-Not ((get-item $CONFLINK).Attributes.ToString() -match "ReparsePoint")) {
+    Write-Verbose "$CONFLINK is not a link..."
+    return
+  }
+  $current_config = (Get-Item $CONFLINK).target
+  if ($current_config -eq $PRODCONF) {
+    if (Test-Path $STAMPFILE) {
+      rm -Force $STAMPFILE
+    }
+    return
+  }
+
+  $revert = $false
+  if (-Not (Test-Path $STAMPFILE)) {
+    $revert = $true
+  } else {
+    $now = [int][double]::Parse(
+      $(Get-Date -date (Get-Date).ToUniversalTime()-uformat %s)
+    )
+    $stamp_time = Get-Date -Date `
+      (Get-Item $STAMPFILE).LastWriteTime.ToUniversalTime() -UFormat %s
+    Write-Verbose "$now vs $stamp_time"
+    if ($now -gt $stamp_time) {
+      $revert = $true
+    }
+  }
+  if ($revert) {
+    if ($dryrun) {
+      echo "DRYRUN: Would return server to prod"
+    } else {
+      set_server_to_prod
+    }
+  }
+}
+
+check_server

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: taste_tester
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  version: 0.0.17
 platform: ruby
 authors:
 - Phil Dibowitz
 - Marcin Sawicki
 autorequire: 
-bindir: bin
+bindir:
+- bin
 cert_chain: []
-date: 2020-05-22 00:00:00.000000000 Z
+date: 2020-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: between_meals
@@ -17,30 +18,16 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.10
+        version: 0.0.11
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.10
+        version: 0.0.11
 - !ruby/object:Gem::Dependency
-  name: json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.0.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.0.0
-- !ruby/object:Gem::Dependency
-  name: mixlib-config
+  name: chef
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -68,47 +55,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: chef
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: chef-zero
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: knife-solo
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: minitar
   requirement: !ruby/object:Gem::Requirement
@@ -124,19 +83,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.6.1
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: mixlib-config
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.49.1
-  type: :development
+        version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.49.1
+        version: '0'
 description: Utility for testing Chef changes using chef-zero
 email: 
 executables:
@@ -160,10 +119,12 @@ files:
 - lib/taste_tester/noop.rb
 - lib/taste_tester/server.rb
 - lib/taste_tester/ssh.rb
+- lib/taste_tester/ssh_util.rb
 - lib/taste_tester/state.rb
 - lib/taste_tester/tunnel.rb
 - lib/taste_tester/windows.rb
 - scripts/taste-untester
+- scripts/taste-untester.ps1
 homepage: https://github.com/facebook/taste-tester
 licenses:
 - Apache-2.0
@@ -183,8 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Taste Tester