cartage-remote 2.1 → 2.2.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 57c1a21e0b093fd54009b0a6982bbbadf74eb7fc
-  data.tar.gz: e2a2a4200d1782839088ef0db9b0231c15839534
+SHA256:
+  metadata.gz: d8f8ebfcf0efff293cc6ab32a208d40e6c296e6453e396af0fd19a9f5bd2f1c5
+  data.tar.gz: 5c88daf9f76d3fb4ae8ad9c98fe33ea1e559c2bf0bee44e749b43428ce695ed1
 SHA512:
-  metadata.gz: b82aace89ab4cdee5af0a14efde94ce6304e3619d8ddf16df6a439c0e850bee7fd12ddf7b0c93b78fa2c62ffafae72ab4d433bd3915b9ea2c879bd46c21425b8
-  data.tar.gz: c6b01886a05159ad378711135c7601f37120ac871959023176f5f9bbe991d64f44ae1b8969bb04553cd9100be32b16e649e97cddc737d46abc21d2b73e37e994
+  metadata.gz: ec0e4445eb3dc157067af58f0179ba35771d05cf366618ef8913d1f77384934d3026526ab851afda0b5bc26d9ec98adc347c8e4c6287bb81b9484c08977fbf15
+  data.tar.gz: 6d0a9317618d908cbcaf1e28eab9b5b72bce6a753af980611954e37ec7ec03bc49f48253e32de4effeb2763cc9d8a70153602bbd95fd13f4752a2e7ca700a592

data/History.md

@@ -1,7 +1,24 @@
+=== 2.2 / 2018-04-03
+
+*   1 major enhancement:
+
+    *    Turn on SSH Agent Forwarding by default and provide an option to
+         disable it.
+
+*   1 major bugfix:
+
+    *    Remove dependency on 'fog' in favour of 'fog-core'. This reduces the
+         number of packages accidentally included because I wanted to use the
+         convenience of Fog::SSH over raw Net::SSH.
+
+*   Test fixes:
+
+    *    Add more configuration checks and fix subtly broken tests.
+
 === 2.1 / 2016-06-07
 
-*   Fix an issue discovered with connection when host keys are not set but
-    are overriding globally defined host keys or key data. Added
+*   Fix an issue discovered with connection when host keys are not set but are
+    overriding globally defined host keys or key data. Added
     Cartage::Remote::Host tests to ensure that this does not regress.
 
 === 2.0 / 2016-05-31

data/Licence.md

@@ -2,7 +2,7 @@
 
 This software is available under an MIT-style licence.
 
-*   Copyright 2015–2016 Kinetic Cafe
+*   Copyright 2015–2018 Kinetic Cafe
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

data/README.rdoc

@@ -33,13 +33,14 @@ configuration file.
             user: build
             address: build-machine
             port: 22
+            forward_agent: true # the default
           alternate: alternate@build-machine:2222
 
 == Install
 
 Add cartage-remote to your Gemfile:
 
-    gem 'cartage-remote', '~> 2.0'
+    gem 'cartage-remote', '~> 2.2'
 
 Or manually install:
 

data/Rakefile

@@ -24,8 +24,8 @@ spec = Hoe.spec 'cartage-remote' do
 
   extra_deps << ['cartage', '~> 2.0']
   extra_deps << ['micromachine', '~> 2.0']
-  extra_deps << ['fog', '~> 1.27']
-  extra_deps << ['net-ssh', '~> 3.0']
+  extra_deps << ['fog-core', '~> 2.1']
+  extra_deps << ['net-ssh', '~> 4.0']
   extra_deps << ['net-scp', '~> 1.2']
 
   extra_dev_deps << ['rake', '>= 10.0']
@@ -36,11 +36,7 @@ spec = Hoe.spec 'cartage-remote' do
   extra_dev_deps << ['hoe-travis', '~> 1.2']
   extra_dev_deps << ['minitest', '~> 5.4']
   extra_dev_deps << ['minitest-autotest', '~> 1.0']
-  extra_dev_deps << ['minitest-bisect', '~> 1.2']
-  extra_dev_deps << ['minitest-bonus-assertions', '~> 2.0']
-  extra_dev_deps << ['minitest-focus', '~> 1.1']
   extra_dev_deps << ['minitest-moar', '~> 0.0']
-  extra_dev_deps << ['minitest-pretty_diff', '~> 0.1']
   extra_dev_deps << ['simplecov', '~> 0.7']
 end
 

data/lib/cartage/plugins/remote.rb

@@ -182,7 +182,7 @@ class Cartage
   #         bundle exec cartage --config-file %{config_file} pack &&
   #         bundle exec cartage --config-file %{config_file} s3 put
   class Remote < Cartage::Plugin
-    VERSION = '2.1' #:nodoc:
+    VERSION = '2.2.beta1' #:nodoc:
 
     # Build on the remote server.
     def build
@@ -215,10 +215,20 @@ class Cartage
 
     # Check that the configuration is correct. If +require_host+ is present, an
     # exception will be thrown if a host is required and not present.
-    def check_config(require_host: false)
-      hosts = cartage.config(for_plugin: :remote).hosts
-      verify_hosts(hosts)
-      fail "No host #{name} present" if require_host && !hosts.dig(name)
+    #
+    # The optional +notify+ block parameter is used primarily for testing.
+    def check_config(require_host: false, &notify)
+      config = cartage.config(for_plugin: :remote)
+
+      puts "#{__method__}: verify_hosts(#{config.hosts.inspect})"
+      verify_hosts(config.hosts, &notify)
+
+      if require_host
+        name = config.host || 'default'
+        fail "No host #{name} present" unless config.hosts.dig(name)
+      end
+
+      true
     end
 
     private
@@ -434,23 +444,29 @@ Remote error in stage #{stage.state}:
       path.to_s.sub(%r{\A~/}, '')
     end
 
-    def verify_hosts(hosts)
+    def verify_hosts(hosts, &notify)
       fail ArgumentError, 'No hosts present' if hosts.nil? || hosts.to_h.empty?
 
       hosts.each_pair do |name, host|
-        verify_host(name, host)
+        puts "#{__method__}: verify_host(#{name.inspect}, #{host.inspect})"
+        verify_host(name, host, &notify)
       end
     end
 
     def verify_host(name, host, &notify)
       notify ||= ->(message) { warn message }
 
-      case host
-      when OpenStruct
-        host.dig(:address) || host.dig(:host)
-      when String
-        Cartage::Remote::Host::HOST_RE.match(host)[:address]
-      end || notify.("Host #{name} invalid: No host address present")
+      address =
+        case host
+        when OpenStruct
+          host.dig(:address) || host.dig(:host)
+        when String
+          Cartage::Remote::Host::HOST_RE.match(host)[:address]
+        end
+
+      puts "#{__method__}: address=#{address.inspect}"
+
+      notify.("Host #{name} invalid: No host address present") unless address
     end
 
     def verify_host!(name, host)

data/lib/cartage/remote/host.rb

@@ -9,6 +9,8 @@ class Cartage::Remote::Host
   attr_reader :address
   # The port of the SSH connection to the remote host.
   attr_reader :port
+  # Whether agent forwarding should be turned on or not. Defaults to +true+.
+  attr_reader :forward_agent
 
   # The (optional) build script defined as part of this host.
   attr_reader :build
@@ -44,6 +46,7 @@ class Cartage::Remote::Host
       @user = host.user
       @address = host.address || host.host
       @port = host.port
+      @forward_agent = host.to_h.fetch(:forward_agent, true)
 
       if host.keys.kind_of?(OpenStruct)
         @key_data = host.keys.to_h.values
@@ -65,6 +68,7 @@ class Cartage::Remote::Host
       @user = Regexp.last_match[:user]
       @address = Regexp.last_match[:address]
       @port = Regexp.last_match[:port]
+      @forward_agent = true
     end
 
     if address.nil? || address.empty?
@@ -79,22 +83,26 @@ class Cartage::Remote::Host
   # Configure the Fog::SSH and Fog::SCP connections using the provided
   # ssh_config.
   def configure_ssh(ssh_config)
-    require 'fog'
+    require 'fog/core'
 
-    if @key_data
-      ssh_config[:key_data] = @key_data
+    if key_data
+      ssh_config[:key_data] = key_data
       ssh_config[:keys] = nil
-    elsif @keys
+    elsif keys
       ssh_config[:key_data] = nil
-      ssh_config[:keys] = @keys
+      ssh_config[:keys] = keys
     end
 
-    options = { paranoid: true, port: port }.
+    ssh_options = { paranoid: true, port: port, forward_agent: !!forward_agent }.
       merge(ssh_config).
       delete_if { |_, v| v.nil? || (v.respond_to?(:empty?) && v.empty?) }
 
-    @ssh = Fog::SSH.new(address, user, options)
-    @scp = Fog::SCP.new(address, user, options)
+    scp_options = { paranoid: true, port: port }.
+      merge(ssh_config).
+      delete_if { |_, v| v.nil? || (v.respond_to?(:empty?) && v.empty?) }
+
+    @ssh = Fog::SSH.new(address, user, ssh_options)
+    @scp = Fog::SCP.new(address, user, scp_options)
   end
 
   # This Host, formatted nicely.
@@ -107,7 +115,10 @@ class Cartage::Remote::Host
     {
       user: user,
       address: address,
-      port: port
+      port: port,
+      forward_agent: forward_agent
     }.delete_if { |_, v| v.nil? || (v.respond_to?(:empty?) && v.empty?) }
   end
+
+  alias to_h to_hash
 end

data/test/minitest_config.rb

@@ -2,14 +2,10 @@
 
 gem 'minitest'
 require 'minitest/autorun'
-require 'minitest/pretty_diff'
-require 'minitest/focus'
 require 'minitest/moar'
-require 'minitest/bisect'
-require 'minitest-bonus-assertions'
 
 require 'cartage/minitest'
 require 'cartage/plugins/remote'
-require 'fog'
+require 'fog/core'
 
 Fog.mock!

data/test/test_cartage_remote.rb

@@ -6,12 +6,13 @@ describe 'Cartage::Remote' do
   let(:string_host) {
     'suser@saddress:sport'
   }
+
   let(:hash_host) {
     {
       user: 'huser',
       address: 'haddress',
-      host: 'hhost',
-      port: 'hport'
+      port: 'hport',
+      forward_agent: true
     }
   }
 
@@ -22,6 +23,7 @@ describe 'Cartage::Remote' do
       }
     }
   }
+
   let(:config_hash) {
     {
       root_path: '/a/b/c',
@@ -32,42 +34,34 @@ describe 'Cartage::Remote' do
       }
     }
   }
+
   let(:config) { Cartage::Config.new(config_hash) }
   let(:cartage) { Cartage.new(config) }
   let(:subject) { cartage.remote }
+  let(:hashify) { config.method(:hashify) }
 
-  def self.it_verifies_configuration(focus: false, &block)
-    self.focus if focus
-    it 'fails if there is no host with the given name' do
-      remote_config[:host] = 'foo'
-      ex = assert_raises RuntimeError do
-        instance_exec(&block)
-      end
-      assert_equal 'No host foo present', ex.message
+  it 'fails if there is no host with the given name' do
+    remote_config[:host] = 'foo'
+    ex = assert_raises RuntimeError do
+      cartage.remote.check_config(require_host: true)
     end
+    assert_equal 'No host foo present', ex.message
+  end
 
-    self.focus if focus
-    it 'fails if there are no hosts present' do
-      remote_config[:hosts] = {}
+  it 'fails if there are no hosts present' do
+    remote_config[:hosts] = {}
 
-      ex = assert_raises ArgumentError do
-        instance_exec(&block)
-      end
-      assert_equal 'No hosts present', ex.message
+    ex = assert_raises ArgumentError do
+      cartage.remote.check_config(require_host: true)
     end
+    assert_equal 'No hosts present', ex.message
+  end
 
-    self.focus if focus
-    it 'warns if a host is missing some configuration' do
-      remote_config[:hosts][:foo] = {}
-
-      error = <<-EOS
-Host foo invalid: No host address present
-      EOS
-
-      assert_output nil, error do
-        instance_exec(&block)
-      end
-    end
+  it 'warns if a host is missing some configuration' do
+    remote_config[:hosts][:foo] = {}
+    messages = []
+    cartage.remote.check_config(require_host: true, &->message { messages << message })
+    assert_equal ['Host foo invalid: No host address present'], messages
   end
 
   describe '#resolve_plugin_config!' do
@@ -92,11 +86,26 @@ Host foo invalid: No host address present
     end
 
     it 'converts the implicit default into explicit' do
-      remote_config.delete(:hosts)
+      expected = hashify.(remote_config.delete(:hosts))
       remote_config[:server] = hash_host
 
-      assert_equal remote_config[:hosts], cartage.config(for_plugin: :remote).
-        dig(:hosts).to_hash
+      actual = hashify.(cartage.config(for_plugin: :remote).dig(:hosts))
+
+      assert_equal expected, actual
+    end
+
+    it 'sets forward_agent to true if missing' do
+      expected = hashify.(remote_config.dig(:hosts, :default))
+      remote_config.dig(:hosts, :default).delete(:forward_agent)
+      actual = hashify.(cartage.config(for_plugin: :remote).dig(:hosts, :default))
+      assert_equal expected, actual
+    end
+
+    it 'keeps forward_agent as false if specified' do
+      hash_host[:forward_agent] = false
+      expected = hashify.(remote_config.dig(:hosts, :default))
+      actual = hashify.(cartage.config(for_plugin: :remote).dig(:hosts, :default))
+      assert_equal expected, actual
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cartage-remote
 version: !ruby/object:Gem::Version
-  version: '2.1'
+  version: 2.2.beta1
 platform: ruby
 authors:
 - Austin Ziegler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-07 00:00:00.000000000 Z
+date: 2018-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cartage
@@ -39,33 +39,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: fog
+  name: fog-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.27'
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.27'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: net-ssh
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: net-scp
   requirement: !ruby/object:Gem::Requirement
@@ -86,42 +86,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.9'
+        version: '5.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.9'
+        version: '5.11'
 - !ruby/object:Gem::Dependency
-  name: rdoc
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '4.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: hoe-doofus
   requirement: !ruby/object:Gem::Requirement
@@ -192,48 +192,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: minitest-bisect
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
-- !ruby/object:Gem::Dependency
-  name: minitest-bonus-assertions
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: minitest-focus
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: minitest-moar
   requirement: !ruby/object:Gem::Requirement
@@ -248,20 +206,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.0'
-- !ruby/object:Gem::Dependency
-  name: minitest-pretty_diff
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -282,14 +226,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.15'
+        version: '3.17'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.15'
+        version: '3.17'
 description: |-
   cartage-remote is a plug-in for {cartage}[https://github.com/KineticCafe/cartage]
   to build a package on a remote machine with cartage.
@@ -337,12 +281,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.4
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: cartage-remote is a plug-in for {cartage}[https://github.com/KineticCafe/cartage]