sshkit 1.17.0 → 1.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc70293f2ae9b1fd7a0adf61cac4ff329fa54e4c7461570eec898560777fc006
-  data.tar.gz: b707f414b46ca07e1b6b9f0db26f5512d1a1a654922292d959d56f7d2bb9be39
+  metadata.gz: bebf3a96075e905b11a3f52b5e75064e49f5d710c375ae2c39c7bbd93b7d76bd
+  data.tar.gz: e8d9ab9ec716df400ce730ebc82c74a32c23c83e0edc52b778e74a5cba8055ee
 SHA512:
-  metadata.gz: b127c917a1bd92af92ede9cf7710c75c82504159b4432bd0ec483a8cae1aed2dc269c1e58bfd5fd7f2f384f3ed6115db5e9dacbcab7eedf5bae42597afaec585
-  data.tar.gz: cefe7b628ec52664d2753bc09787ef1aae4cbbea93774afce828397bb18d77afbd78622c3ec84f3d90bf6b609af2b6be56c5bb03e6d35c6f48c9a2e9a3d81a9b
+  metadata.gz: e91cf1cbcff6c0dfaef0f2a05a6843f5312f8091b6b55fbc24022cc4e688c29fce690ac09d3b6cb33a9e8c42ba6bcb1441479f5fdf40d111f862ff55bb3b9122
+  data.tar.gz: 3e50dc789ef3dff1ecd3041f89c332bc5883157c9ab2f007148e0c025f47f3a2941bab046661f45dcaa5f4880493674d34ff142df660f19a7eaf82b0c9e5da41

data/CHANGELOG.md

@@ -7,6 +7,10 @@ appear at the top.
 
   * Your contribution here!
 
+## [1.18.0][] (2018-10-21)
+
+  * [#435](https://github.com/capistrano/sshkit/pull/435): Consistent verbosity configuration #capture and #test methods - [@NikolayRys](https://github.com/NikolayRys)
+
 ## [1.17.0][] (2018-07-07)
 
   * [#430](https://github.com/capistrano/sshkit/pull/430): [Feature] Command Argument STDOUT/capistrano.log Hiding - [@NorseGaud](https://github.com/NorseGaud)
@@ -746,7 +750,8 @@ version `0.0.5`.
 
 First release.
 
-[Unreleased]: https://github.com/capistrano/sshkit/compare/v1.17.0...HEAD
+[Unreleased]: https://github.com/capistrano/sshkit/compare/v1.18.0...HEAD
+[1.18.0]: https://github.com/capistrano/sshkit/compare/v1.17.0...v1.18.0
 [1.17.0]: https://github.com/capistrano/sshkit/compare/v1.16.1...v1.17.0
 [1.16.1]: https://github.com/capistrano/sshkit/compare/v1.16.0...v1.16.1
 [1.16.0]: https://github.com/capistrano/sshkit/compare/v1.15.1...v1.16.0

data/README.md

@@ -445,13 +445,13 @@ SSHKit.config.output = SSHKit::Formatter::SimpleText.new(File.open('log/deploy.l
 
 #### Output & Log Redaction
 
-If necessary, redact() can be used on a section of your execute arguments to hide it from both STDOUT and the capistrano.log. It supports the majority of data types.
+If necessary, `redact` can be used on a section of your `execute` arguments to hide it from both STDOUT and the capistrano.log. It supports the majority of data types.
 
 ```ruby
 # Example from capistrano-postgresql gem
 execute(:psql, fetch(:pg_system_db), '-c', %Q{"CREATE USER \\"#{fetch(:pg_username)}\\" PASSWORD}, redact("'#{fetch(:pg_password)}'"), %Q{;"})
 ```
-Once wrapped, sshkit logging will replace the actual pg_password with a [REDACTED] value:
+Once wrapped, sshkit logging will replace the actual pg_password with a [REDACTED] value. The created database user will have the value from `fetch(:pg_password)`.
 
 ```
 # STDOUT
@@ -467,7 +467,13 @@ DEBUG [529b623c] CREATE ROLE
 
 ```
 
-Yet, the created database user will have the value from `fetch(:pg_password)`.
+Certain commands will require that no spaces exist between a string and what you want hidden. Because SSHKIT will include a whitespace between each argument of `execute`, this can be dealt with by wrapping both in redact:
+
+```ruby
+# lib/capistrano/tasks/systemd.rake
+execute :sudo, :echo, redact("CONTENT_WEB_TOOLS_PASS='#{ENV['CONTENT_WEB_TOOLS_PASS']}'"), ">> /etc/systemd/system/#{fetch(:application)}_sidekiq.service.d/EnvironmentFile", '"'
+
+```
 
 #### Output Colors
 
@@ -514,6 +520,8 @@ 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 available to override with `SSHKit.config.output_verbosity=`,
 and defaults to `Logger::INFO`.
+Another way to is to provide a hash containing `{verbosity: Logger::INFO}` as
+a last parameter for the method call.
 
 At present the `Logger::WARN`, `ERROR` and `FATAL` are not used.
 

data/lib/sshkit/backends/abstract.rb

@@ -55,7 +55,7 @@ module SSHKit
       end
 
       def test(*args)
-        options = args.extract_options!.merge(raise_on_non_zero_exit: false, verbosity: Logger::DEBUG)
+        options = { verbosity: Logger::DEBUG, raise_on_non_zero_exit: false }.merge(args.extract_options!)
         create_command_and_execute(args, options).success?
       end
 

data/lib/sshkit/version.rb

@@ -1,3 +1,3 @@
 module SSHKit
-  VERSION = "1.17.0".freeze
+  VERSION = "1.18.0".freeze
 end

data/test/unit/backends/test_abstract.rb

@@ -40,7 +40,7 @@ module SSHKit
         )
       end
 
-      def test_test_method_creates_and_executes_command_with_false_raise_on_non_zero_exit
+      def test_test_creates_and_executes_command_with_false_raise_on_non_zero_exit
         backend = ExampleBackend.new do
           test '[ -d /some/file ]'
         end
@@ -51,6 +51,14 @@ module SSHKit
         assert_equal false, backend.executed_command.options[:raise_on_non_zero_exit], 'raise_on_non_zero_exit option'
       end
 
+      def test_test_allows_to_override_verbosity
+        backend = ExampleBackend.new do
+          test 'echo output', {verbosity: Logger::INFO}
+        end
+        backend.run
+        assert_equal(backend.executed_command.options[:verbosity], Logger::INFO)
+      end
+
       def test_capture_creates_and_executes_command_and_returns_stripped_output
         output = nil
         backend = ExampleBackend.new do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sshkit
 version: !ruby/object:Gem::Version
-  version: 1.17.0
+  version: 1.18.0
 platform: ruby
 authors:
 - Lee Hambley
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-08 00:00:00.000000000 Z
+date: 2018-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh