taste_tester 0.0.14 → 0.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dbe88f9386cbb7c68b721ea057a30881dd98ba374a0e84528e43da739eb88d31
-  data.tar.gz: 642d43ce2aa006331680178e0ab15afba8d88323ab89d2e1cb0321f74c663b07
+  metadata.gz: 7ba0813aa4a09d92549bb1555bef69e883a49b4ef292b9a2d7cc14dca77bce0e
+  data.tar.gz: 4a51383665bad129bba1e5e4d2e1d9df991eb021700ce6dc9ab1098fa8089ad5
 SHA512:
-  metadata.gz: 3a256a6d7e67b346aad620a1782032394f68848ef9c085c24854b4d70ffdd718b64d4970c479b7080aba11b468423905759d0ae8f92d305aa38fe654187745b7
-  data.tar.gz: '048097e573d03b748a08d09438820d9ee144c90d0fb43e0375fbd91e1354215d7c82d8a0b39f97452b0752ab8dc79fe5b5863c9108727ba87fc2810271f27ee8'
+  metadata.gz: 612005359c48c5cee20cb95e4c8880a087f1638887de099e0cd15dd99757b54a3e404643241289286c7d33ff9f29ed25dcd64d9bcefcefc2a9b36dfe97fbb6f0
+  data.tar.gz: 99fae7d5975e0a9c05d1ca0e68c18c03a237eb4e4b17c8e870b16d71e8a434717a01d81dc0aad2b15b35ee1fbc292c3dad230c29ab92f362059f2d5285808de7

data/README.md

@@ -25,6 +25,7 @@ Typical usage is:
 
 ```text
 vi cookbooks/...             # Make your changes and commit locally
+taste-tester impact          # Check where your changes are used
 taste-tester test -s [host]  # Put host in Taste Tester mode
 ssh root@[host]              # Log in to host
   # Run chef and watch it break
@@ -62,6 +63,7 @@ you want to test on, i.e. SSH public/private keys, SSH certificates, Kerberos
 * Colorize
 * BetweenMeals
 * Minitar
+* Chef
 
 ## Automatic Untesting
 
@@ -91,7 +93,8 @@ All command-line options are available in the config file:
 * plugin_path (string, no default)
 * repo (string, default: `#{ENV['HOME']}/ops`)
 * testing_time (int, default: `3600`)
-* chef_client_command (strng, default: `chef-client`)
+* chef_client_command (string, default: `chef-client`)
+* json (bool, default: `false`)
 * skip_repo_checks (bool, default: `false`)
 * skip_pre_upload_hook (bool, default: `false`)
 * skip_post_upload_hook (bool, default: `false`)
@@ -112,7 +115,12 @@ The following options are also available:
 * checksum_dir - The checksum directory to put in knife.conf for users. Default:
   `#{ENV['HOME']}/.chef/checksums`
 * bundle - use a single tar.gz file for transporting cookbooks, roles and
-  databags to clients. Experimental.
+  databags to clients. Experimental. Value is tri-state:
+  * `false` - server uses knife upload, client uses `chef_server`
+  * `:compatible` - make server support both methods, client uses tar.gz
+  * `true` - server only creates tar.gz, client uses tar.gz
+  Default: false
+* impact - analyze local changes to determine which hosts/roles to test.
   Default: false
 
 
@@ -156,6 +164,23 @@ Stuff to do after putting all hosts in test mode.
 
 Additional checks you want to do on the repo as sanity checks.
 
+* self.find_impact(changes)
+
+Custom implementation of impact analysis. Uses `knife deps` by default. May
+return any data structure, provided one or both of `self.post_impact` or
+`self.print_impact` are defined.
+
+* self.post_impact(basic_impact)
+
+Stuff to do after preliminary impact analysis. May be used to extend the
+information generated by `self.find_impact`, reformat the data structure, etc.
+
+* self.print_impact(final_impact)
+
+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**
 
 This is an example `/etc/taste-tester-plugin.rb` to add a user-defined string
@@ -170,7 +195,7 @@ Hooks.class_eval do
   end
 end
 ```
-Be sure to pass this plugin file with `-p` on the command line or set it as 
+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.
 
 ## License

data/bin/taste-tester

@@ -39,15 +39,6 @@ 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!
 
@@ -57,16 +48,18 @@ 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
-  #{format('%-28s', "  #{cmd}")}  # Run chef and watch it break
+    # Run chef and watch it break
   vi cookbooks/...              # Fix your cookbooks
   taste-tester upload           # Upload the diff
   ssh root@[host]               # Log on host
-  #{format('%-28s', "  #{cmd}")}  # Run chef and watch it succeed
+    # 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! See the above wiki page for more details.
+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.
 
 MODES:
   test
@@ -107,11 +100,6 @@ 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.
@@ -305,6 +293,17 @@ MODES:
       options[:roles] = roles
     end
 
+    opts.on(
+      '-J', '--jumps JUMP',
+      'Uses ssh\'s `ProxyJump` support to ssh across bastion/jump hosts. ' +
+      'This is particularly useful in tunnel mode to test machines that ' +
+      'your workstatation doesn\'t have direct access to. The format is ' +
+      'the same as `ssh -J`: a comma-separated list of hosts to forward ' +
+      'through.'
+    ) do |jumps|
+      options[:jumps] = jumps
+    end
+
     opts.on('--really', 'Really do link-only. DANGEROUS!') do |r|
       options[:really] = r
     end
@@ -430,8 +429,6 @@ 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/client.rb

@@ -20,6 +20,8 @@ require 'taste_tester/logging'
 require 'between_meals/repo'
 require 'between_meals/knife'
 require 'between_meals/changeset'
+require 'chef/log'
+require 'chef/cookbook/chefignore'
 
 module TasteTester
   # Client side upload functionality
@@ -130,6 +132,7 @@ module TasteTester
     def populate(stream, writer, path, destination)
       full_path = File.join(File.join(TasteTester::Config.repo, path))
       return unless File.directory?(full_path)
+      chefignores = Chef::Cookbook::Chefignore.new(full_path)
       # everything is relative to the repo dir. chdir makes handling all the
       # paths within this simpler
       Dir.chdir(full_path) do
@@ -141,7 +144,17 @@ module TasteTester
           # 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.
-          name = File.join(destination, p[2..-1])
+          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.
@@ -206,11 +219,12 @@ module TasteTester
     end
 
     def full
+      logger.warn('Doing full upload')
       if TasteTester::Config.bundle
         bundle_upload
-        return
+        # only leave early if true (strictly bundle mode only)
+        return if TasteTester::Config.bundle == true
       end
-      logger.warn('Doing full upload')
       @knife.cookbook_upload_all
       @knife.role_upload_all
       @knife.databag_upload_all
@@ -220,7 +234,7 @@ module TasteTester
       if TasteTester::Config.bundle
         logger.info('No partial support for bundle mode, doing full upload')
         bundle_upload
-        return
+        return if TasteTester::Config.bundle == true
       end
       logger.info('Doing differential upload from ' +
                    @server.latest_uploaded_ref)

data/lib/taste_tester/commands.rb

@@ -149,19 +149,6 @@ 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.run
-      end
-    end
-
     def self.keeptesting
       hosts = TasteTester::Config.servers
       unless hosts
@@ -226,16 +213,17 @@ module TasteTester
 
       changes = _find_changeset(repo)
 
-      # Use Knife (or custom logic) to check the dependencies of each role
-      # against the list of changes. `impacted_roles` will contian the set
-      # of roles with direct or indirect (dependency) modifications.
-      impacted_roles = TasteTester::Hooks.impact_find_roles(changes)
-      impacted_roles ||= _find_roles(changes)
+      # Perform preliminary impact analysis. By default, use Knife to find
+      # the roles dependent on modified cookbooks. Custom logic may provide
+      # additional information by defining the find_impact plugin method.
+      basic_impact = TasteTester::Hooks.find_impact(changes)
+      basic_impact ||= _find_roles(changes)
 
       # Do any post processing required on the list of impacted roles, such
-      # as looking up hostnames associated with each role.
-      final_impact = TasteTester::Hooks.post_impact(impacted_roles)
-      final_impact ||= impacted_roles
+      # as looking up hostnames associated with each role. By default, pass
+      # the preliminary results through unmodified.
+      final_impact = TasteTester::Hooks.post_impact(basic_impact)
+      final_impact ||= basic_impact
 
       # Print the calculated impact. If a print hook is defined that
       # returns true, then the default print function is skipped.
@@ -283,7 +271,7 @@ module TasteTester
       if TasteTester::Config.relative_cookbook_dirs.length > 1
         logger.error('Knife deps does not support multiple cookbook paths.')
         logger.error('Please flatten the cookbooks into a single directory' +
-                     ' or override the impact_find_roles function.')
+                     ' or define the find_impact method in a local plugin.')
         exit(1)
       end
 
@@ -292,7 +280,9 @@ module TasteTester
       databags = Set.new(changes.databags)
 
       if cookbooks.empty? && roles.empty?
-        logger.warn('No cookbooks or roles have been modified.')
+        unless TasteTester::Config.json
+          logger.warn('No cookbooks or roles have been modified.')
+        end
         return Set.new
       end
 

data/lib/taste_tester/config.rb

@@ -45,7 +45,6 @@ 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
@@ -62,6 +61,7 @@ module TasteTester
     transport 'ssh'
     no_repo false
     json false
+    jumps nil
 
     # 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

@@ -51,21 +51,21 @@ module TasteTester
     # Find the set of roles dependent on the changed files.
     # If returning something other than a set of roles, post_impact and/or
     # print_impact should be specified to handle the output.
-    def self.impact_find_roles(_changes); end
+    def self.find_impact(_changes); end
 
     # Do stuff after we find impacted roles
-    # This should return a Set object with the final impact. To return more
-    # complex data, you must also provide a print_impact function which returns
-    # true to override the default output.
+    # This should return a JSON serializable object with the final impact
+    # assessment. You will probably also want to define a print_impact method
+    # which returns true to override the default output logic.
     def self.post_impact(_impacted_roles); end
 
-    # Customized the printed output of impact
+    # Customize the printed output of impact
     # If this method returns true, the default output will not be printed.
     def self.print_impact(_final_impact); end
 
     def self.get(file)
       path = File.expand_path(file)
-      logger.warn("Loading plugin at #{path}")
+      logger.warn("Loading plugin at #{path}") unless TasteTester::Config.json
       unless File.exists?(path)
         logger.error('Plugin file not found')
         exit(1)

data/lib/taste_tester/host.rb

@@ -44,38 +44,6 @@ module TasteTester
       end
     end
 
-    def runchef
-      logger.warn("Running '#{TasteTester::Config.chef_client_command}' " +
-                  "on #{@name}")
-      cmd = "#{TasteTester::Config.ssh_command} " +
-            "#{TasteTester::Config.user}@#{@name} "
-      if TasteTester::Config.user != 'root'
-        cc = Base64.encode64(cmds).delete("\n")
-        cmd += "\"echo '#{cc}' | base64 --decode | sudo bash -x\""
-      else
-        cmd += "\"#{cmds}\""
-      end
-      status = IO.popen(
-        cmd,
-      ) do |io|
-        # rubocop:disable AssignmentInCondition
-        while line = io.gets
-          puts line.chomp!
-        end
-        # rubocop:enable AssignmentInCondition
-        io.close
-        $CHILD_STATUS.to_i
-      end
-      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'
@@ -125,15 +93,14 @@ module TasteTester
       # we work out if we won or lost a race with another user.
       transport << we_testing
 
-      transport.run
+      status, output = transport.run
 
-      case transport.status
+      case status
       when 0
         # no problem, keep going.
         nil
       when 42
-        fail TasteTester::Exceptions::AlreadyTestingError,
-             transport.output.chomp
+        fail TasteTester::Exceptions::AlreadyTestingError, output.chomp
       else
         transport.error!
       end

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

@@ -65,10 +65,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
@@ -175,7 +175,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

@@ -22,8 +22,6 @@ module TasteTester
     include TasteTester::Logging
     include BetweenMeals::Util
 
-    attr_reader :output, :status
-
     def initialize(host, tunnel = false)
       @host = host
       @tunnel = tunnel
@@ -37,11 +35,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!
@@ -53,7 +51,9 @@ 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
+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 }
       fail TasteTester::Exceptions::SshError
@@ -66,7 +66,8 @@ and come back once that works
         logger.info("Will run: '#{cmd}' on #{@host}")
       end
       cmds = @cmds.join(' && ')
-      cmd = "#{TasteTester::Config.ssh_command} " +
+      jumps = TasteTester::Config.jumps ? "-J #{TasteTester::Config.jumps}" : ''
+      cmd = "#{TasteTester::Config.ssh_command} #{jumps} " +
             '-T -o BatchMode=yes ' +
             "-o ConnectTimeout=#{TasteTester::Config.ssh_connect_timeout} " +
             "#{TasteTester::Config.user}@#{@host} "

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)

data/lib/taste_tester/tunnel.rb

@@ -36,7 +36,7 @@ module TasteTester
     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)
@@ -56,7 +56,8 @@ module TasteTester
       # 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} " +
+      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 ' +

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: taste_tester
 version: !ruby/object:Gem::Version
-  version: 0.0.14
+  version: 0.0.15
 platform: ruby
 authors:
 - Phil Dibowitz
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-02 00:00:00.000000000 Z
+date: 2019-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: between_meals
@@ -67,6 +67,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: chef
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '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