sshkit 1.11.5 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ecbcaab38ec3846d9404e17a66d3f7b194934e5f
-  data.tar.gz: 89adc14d1a4c2b827b9f059aacad981930e9f11d
+  metadata.gz: 2075a49a2e5d52e26409761fffbb3da8dd6bc46d
+  data.tar.gz: d9579584daf0ac0f3d2170fa4dc0c2bc57d3ac55
 SHA512:
-  metadata.gz: 390afcddc35aebf0a039b31fbe467a0c4d0d964ccb280fea07ac4780c9cd699ddfc474c596c398543335c679e9e5b63554cc76654c61e0c34e83cf18ab427265
-  data.tar.gz: f2925bc0750c885668a01462ce43ea3335e4fcd55f7ef369e8a777d0acac2a1c689e9db6da6ba35e99c947ffb3793ad29d09da2958465d879773f98c3252900f
+  metadata.gz: 4a84ef1bf0b996cf4a3ecb0d855f8d7b872c1d0bc31f46804908b3f51f31cb1f2af0ff7d39e7bc498f8a7aecf05576116bff008b8955b853b6e39c3fcb6f71bf
+  data.tar.gz: b2e42bf3216b4fdfbdd531329a09e9534775b71eb15dd2853319dca4ac358623b494474f179f136034beee435fd424f03b13d64fe6eb64dd283da39fcd6ae3f8

data/.travis.yml

@@ -4,8 +4,9 @@ rvm:
   - 2.2.4
   - 2.1.8
   - 2.0.0
-include:
-  # Run Danger only once, on 2.3.3
-  - rvm: 2.3.3
-    before_script: bundle exec danger
-script: "rake test:units lint"
+matrix:
+  include:
+    # Run Danger only once, on 2.3.3
+    - rvm: 2.3.3
+      script: bundle exec danger
+script: bundle exec rake test:units lint

data/CHANGELOG.md

@@ -7,6 +7,16 @@ appear at the top.
 
   * Your contribution here!
 
+## [1.12.0][] (2017-02-10)
+
+### Breaking changes
+
+  * None
+
+### New features
+
+  * Add `SSHKit.config.default_runner_config` option that allows overriding default runner configs.
+
 ## [1.11.5][] (2016-12-16)
 
 ### Bug fixes
@@ -662,7 +672,8 @@ version `0.0.5`.
 
 First release.
 
-[Unreleased]: https://github.com/capistrano/sshkit/compare/v1.11.5...HEAD
+[Unreleased]: https://github.com/capistrano/sshkit/compare/v1.12.0...HEAD
+[1.12.0]: https://github.com/capistrano/sshkit/compare/v1.11.5...v1.12.0
 [1.11.5]: https://github.com/capistrano/sshkit/compare/v1.11.4...v1.11.5
 [1.11.4]: https://github.com/capistrano/sshkit/compare/v1.11.3...v1.11.4
 [1.11.3]: https://github.com/capistrano/sshkit/compare/v1.11.2...v1.11.3

data/Dangerfile

@@ -45,7 +45,7 @@ end
 # Did you remove the CHANGELOG's "Your contribution here!" line?
 # ------------------------------------------------------------------------------
 if has_changelog_changes
-  unless IO.read("CHANGELOG.md") =~ /^\* Your contribution here/i
+  unless IO.read("CHANGELOG.md") =~ /^\s*\* Your contribution here/i
     fail(
       "Please put the `* Your contribution here!` line back into CHANGELOG.md.",
       :sticky => false

data/README.md

@@ -136,6 +136,26 @@ it too hard.
 Sequential runs were intended to be used for rolling restarts, amongst other
 similar use-cases.
 
+The default runner can be set with the `SSHKit.config.default_runner` option.  For
+example:
+ ```ruby
+SSHKit.config.default_runner = :parallel
+SSHKit.config.default_runner = :sequence
+SSHKit.config.default_runner = :groups
+SSHKit.config.default_runner = MyRunner # A custom runner
+```
+
+If more control over the default runner is needed, the `SSHKit.config.default_runner_config`
+can be set.
+```ruby
+# Set the runner and then the config for the runner
+SSHKit.config.default_runner = :sequence
+SSHKit.config.default_runner_config = { wait: 5 }
+
+# Or just set everything once
+SSHKit.config.default_runner_config = { in: :sequence, wait: 5 }
+```
+
 ## Synchronisation
 
 The `on()` block is the unit of synchronisation, one `on()` block will wait

data/lib/sshkit/configuration.rb

@@ -29,6 +29,16 @@ module SSHKit
       @default_runner ||= :parallel
     end
 
+    def default_runner_config
+      @default_runner_config ||= { in: default_runner }
+    end
+
+    def default_runner_config=(config_hash)
+      config = config_hash.dup
+      SSHKit.config.default_runner = config.delete(:in) if config[:in]
+      @default_runner_config = config.merge(in: SSHKit.config.default_runner)
+    end
+
     def backend
       @backend ||= SSHKit::Backend::Netssh
     end

data/lib/sshkit/coordinator.rb

@@ -27,7 +27,7 @@ module SSHKit
     private
 
     def default_options
-      { in: SSHKit.config.default_runner }
+      SSHKit.config.default_runner_config
     end
 
     def resolve_hosts

data/lib/sshkit/version.rb

@@ -1,3 +1,3 @@
 module SSHKit
-  VERSION = "1.11.5".freeze
+  VERSION = "1.12.0".freeze
 end

data/sshkit.gemspec

@@ -23,6 +23,7 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency('danger')
   gem.add_development_dependency('minitest', '>= 5.0.0')
   gem.add_development_dependency('minitest-reporters')
+  gem.add_development_dependency('rainbow', '~> 2.1.0')
   gem.add_development_dependency('rake')
   gem.add_development_dependency('rubocop')
   gem.add_development_dependency('mocha')

data/test/unit/backends/test_connection_pool.rb

@@ -50,8 +50,8 @@ module SSHKit
       end
 
       def test_connections_are_reused_if_checked_in
-        conn1 = pool.with(connect, "conn") {}
-        conn2 = pool.with(connect, "conn") {}
+        conn1 = pool.with(connect, "conn") { |c| c }
+        conn2 = pool.with(connect, "conn") { |c| c }
 
         assert_equal conn1, conn2
       end

data/test/unit/test_command.rb

@@ -218,7 +218,7 @@ module SSHKit
 
     def test_setting_exit_status
       c = Command.new(:whoami, raise_on_non_zero_exit: false)
-      assert_equal nil, c.exit_status
+      assert_nil c.exit_status
       assert c.exit_status = 1
       assert_equal 1, c.exit_status
     end

data/test/unit/test_configuration.rb

@@ -57,6 +57,19 @@ module SSHKit
       assert_equal :sequence, SSHKit.config.default_runner
     end
 
+    def test_default_runner_config
+      config_hash = { wait: 5 }
+      config_hash_with_runner = { in: :groups, limit: 5 }
+      default_hash = { in: SSHKit.config.default_runner }
+
+      assert_equal default_hash, SSHKit.config.default_runner_config
+      SSHKit.config.default_runner_config = config_hash
+      assert_equal default_hash.merge(config_hash), SSHKit.config.default_runner_config
+      SSHKit.config.default_runner_config = config_hash_with_runner
+      assert_equal config_hash_with_runner, SSHKit.config.default_runner_config
+      assert_equal config_hash_with_runner[:in], SSHKit.config.default_runner
+    end
+
     def test_backend
       assert_equal SSHKit::Backend::Netssh, SSHKit.config.backend
       assert SSHKit.config.backend = SSHKit::Backend::Printer

data/test/unit/test_coordinator.rb

@@ -82,6 +82,32 @@ module SSHKit
       end
     end
 
+    def test_the_connection_manager_can_run_things_with_custom_runner_configs
+      begin
+        $original_runner = SSHKit.config.default_runner
+        SSHKit.config.default_runner = :groups
+        $original_runner_config = SSHKit.config.default_runner_config
+        SSHKit.config.default_runner_config = { limit: 2, wait: 5 }
+
+        Coordinator.new(
+          %w{
+            1.example.com
+            2.example.com
+            3.example.com
+            4.example.com
+          }
+        ).each(&echo_time)
+        assert_equal 4, actual_execution_times.length
+        assert_within_10_ms(actual_execution_times[0..1])
+        assert_within_10_ms(actual_execution_times[2..3])
+        assert_at_least_5_sec_apart(actual_execution_times[0], actual_execution_times[2])
+        assert_at_least_5_sec_apart(actual_execution_times[1], actual_execution_times[3])
+      ensure
+        SSHKit.config.default_runner = $original_runner
+        SSHKit.config.default_runner_config = $original_runner_config
+      end
+    end
+
     def test_the_connection_manager_can_run_things_in_sequence_with_wait
       start = Time.now
       Coordinator.new(%w{1.example.com 2.example.com}).each in: :sequence, wait: 10, &echo_time
@@ -114,6 +140,10 @@ module SSHKit
       assert_operator(last_time - first_time, :>, 1.0)
     end
 
+    def assert_at_least_5_sec_apart(first_time, last_time)
+      assert_operator(last_time - first_time, :>, 5.0)
+    end
+
     def assert_within_10_ms(array)
       assert_in_delta(*array, 0.01) # 10 msec
     end

data/test/unit/test_host.rb

@@ -75,7 +75,7 @@ module SSHKit
 
     def test_arbitrary_host_properties
       h = Host.new('example.com')
-      assert_equal nil, h.properties.roles
+      assert_nil h.properties.roles
       assert h.properties.roles = [:web, :app]
       assert_equal [:web, :app], h.properties.roles
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sshkit
 version: !ruby/object:Gem::Version
-  version: 1.11.5
+  version: 1.12.0
 platform: ruby
 authors:
 - Lee Hambley
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-17 00:00:00.000000000 Z
+date: 2017-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh
@@ -81,6 +81,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -234,7 +248,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: SSHKit makes it easy to write structured, testable SSH commands in Ruby