sshkit 0.0.14 → 0.0.15

data/CHANGELOG.md

@@ -3,6 +3,20 @@
 This file is written in reverse chronological order, newer releases will
 appear at the top.
 
+## 0.0.15
+
+ * `Command` now takes a `verbosity` option. This defaults to `Logger::INFO`
+   and can be set to any of the Ruby logger level constants. You can also set
+   it to the symbol `:debug` (and friends) which will be expanded into the correct
+   constants.
+
+   The log verbosity level is set to Logger::INFO by default, and can be
+   overridden by setting `SSHKit.config.output_verbosity = Logger::{...}`,
+   pick a level that works for you.
+
+   By default `test()` and `capture()` calls are surpressed, and not printed
+   by the pretty logger as of this version.
+
 ## 0.0.14
 
  * Umasks can now be set on `Command` instances. It can be set globally with

data/README.md

@@ -173,6 +173,16 @@ on it's implementation it will almost certainly override the implementation of
 `write()` (alias `<<()`) and query the objects it receives to determine what
 should be printed.
 
+## Verbosity
+
+By default calls to `capture()` and `test()` are not logged, they are used
+*so* frequently by backend tasks to check environmental settings that it
+produces a large amount of noise. They are tagged with a verbosity option on
+the `Command` instances of `Logger::DEBUG`. The default configuration for
+output verbosity is avaialble to override with `SSHKit.config.output_verbosity=`,
+and defaults to `Logger::INFO`.
+
+At present the `Logger::WARN`, `ERROR` and `FATAL` are not used.
 
 ## Known Issues
 

data/lib/sshkit/backends/netssh.rb

@@ -16,7 +16,10 @@ module SSHKit
       end
 
       def test(*args)
-        options = args.extract_options!.merge(raise_on_non_zero_exit: false)
+        options = args.extract_options!.merge(
+          raise_on_non_zero_exit: false,
+          verbosity: Logger::DEBUG
+        )
         _execute(*[*args, options]).success?
       end
 
@@ -30,7 +33,8 @@ module SSHKit
       end
 
       def capture(*args)
-        _execute(*args).stdout.strip
+        options = args.extract_options!.merge(verbosity: Logger::DEBUG)
+        _execute(*[*args, options]).success?
       end
 
       def configure

data/lib/sshkit/command.rb

@@ -121,7 +121,18 @@ module SSHKit
       options[:host]
     end
 
-    def to_s
+    def verbosity
+      if vb = options[:verbosity]
+        case vb.class.name
+        when 'Symbol' then return Logger.const_get(vb.to_s.upcase)
+        when 'Fixnum' then return vb
+        end
+      else
+        Logger::INFO
+      end
+    end
+
+    def to_s(expanded=false)
       return command.to_s if command.match /\s/
       String.new.tap do |cs|
         if options[:in]

data/lib/sshkit/configuration.rb

@@ -2,7 +2,7 @@ module SSHKit
 
   class Configuration
 
-    attr_accessor :umask
+    attr_accessor :umask, :output_verbosity
     attr_writer :output, :backend, :default_env, :command_map
 
     def output
@@ -17,6 +17,10 @@ module SSHKit
       @backend ||= SSHKit::Backend::Netssh
     end
 
+    def output_verbosity
+      @output_verbosity ||= Logger::INFO
+    end
+
     def format=(format)
       formatter = SSHKit::Formatter.const_get(format.capitalize)
       self.output = formatter.new($stdout)

data/lib/sshkit/formatters/pretty.rb

@@ -8,22 +8,29 @@ module SSHKit
 
       def write(obj)
         if obj.is_a? SSHKit::Command
+
+          return if obj.verbosity < SSHKit.config.output_verbosity
+
           unless obj.started?
             original_output << "[#{c.green(obj.uuid)}] Running #{c.yellow(c.bold(String(obj)))} on #{c.yellow(obj.host.to_s)}\n"
           end
+
           if obj.complete? && !obj.stdout.empty?
             obj.stdout.lines.each do |line|
               original_output << c.green("\t" + line)
             end
           end
+
           if obj.complete? && !obj.stderr.empty?
             obj.stderr.lines.each do |line|
               original_output << c.red("\t" + line)
             end
           end
+
           if obj.finished?
             original_output << "[#{c.green(obj.uuid)}] Finished in #{sprintf('%5.3f seconds', obj.runtime)} command #{c.bold { obj.failure? ? c.red('failed') : c.green('successful') }}.\n"
           end
+
         else
           original_output << c.black(c.on_yellow("Output formatter doesn't know how to handle #{obj.inspect}\n"))
         end

data/lib/sshkit/version.rb

@@ -1,3 +1,3 @@
 module SSHKit
-  VERSION = "0.0.14"
+  VERSION = "0.0.15"
 end

data/test/unit/backends/test_printer.rb

@@ -37,7 +37,7 @@ module SSHKit
           cd /opt/sites/example.com && /usr/bin/env ls -l /some/directory
           if test ! -d /opt/sites/example.com/tmp; then echo "Directory does not exist '/opt/sites/example.com/tmp'" 1>&2; false; fi
           if ! sudo su root -c whoami > /dev/null; then echo "You cannot switch to user 'root' using sudo, please check the sudoers file" 1>&2; false; fi
-          cd /opt/sites/example.com/tmp && ( RAILS_ENV=production sudo su root -c /usr/bin/env touch restart.txt )
+          cd /opt/sites/example.com/tmp && ( RAILS_ENV=production sudo su root -c \"/usr/bin/env touch restart.txt\" )
         EOEXPECTED
       end
 

data/test/unit/test_command.rb

@@ -120,6 +120,18 @@ module SSHKit
       assert_equal "cd /var && ( A=b sudo su bob -c \"umask 007 && /usr/bin/env touch somefile\" )", String(c)
     end
 
+    def test_verbosity_defaults_to_logger_info
+      assert_equal Logger::INFO, Command.new(:ls).verbosity
+    end
+
+    def test_overriding_verbosity_level_with_a_constant
+      assert_equal Logger::DEBUG, Command.new(:ls, verbosity: Logger::DEBUG).verbosity
+    end
+
+    def test_overriding_verbosity_level_with_a_symbol
+      assert_equal Logger::DEBUG, Command.new(:ls, verbosity: :debug).verbosity
+    end
+
     def test_complete?
       c = Command.new(:whoami, raise_on_non_zero_exit: false)
       refute c.complete?

data/test/unit/test_configuration.rb

@@ -21,6 +21,12 @@ module SSHKit
       assert_equal '007', SSHKit.config.umask
     end
 
+    def test_output_verbosity
+      assert_equal Logger::INFO, SSHKit.config.output_verbosity
+      assert SSHKit.config.output_verbosity = Logger::DEBUG
+      assert_equal Logger::DEBUG, SSHKit.config.output_verbosity
+    end
+
     def test_default_env
       assert SSHKit.config.default_env
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sshkit
 version: !ruby/object:Gem::Version
-  version: 0.0.14
+  version: 0.0.15
   prerelease: 
 platform: ruby
 authors: