cartage-remote 2.0 → 2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6b8d946cbacde570be1b25b925b1b4b0c008d5bc
-  data.tar.gz: 16e8bb54b6c41dc3b35e5a8e16fab73851174d35
+  metadata.gz: 57c1a21e0b093fd54009b0a6982bbbadf74eb7fc
+  data.tar.gz: e2a2a4200d1782839088ef0db9b0231c15839534
 SHA512:
-  metadata.gz: bad5bf5d951038b96b9efe9fe15d23afb4104cb16a968db4861c5c91575acff6ac694f1f98f57f2f26bd46dab000bfd49f417d9f6cbf95ba04ece0ab28967009
-  data.tar.gz: a1e6453360a058539cd96ce834c67625abe5cce2a424bf19004f3fb065b1ba4a1f67ed1c2f55e0690df6ab56ad14a1f37a8cbc0c357ab109282876c1ec342b9a
+  metadata.gz: b82aace89ab4cdee5af0a14efde94ce6304e3619d8ddf16df6a439c0e850bee7fd12ddf7b0c93b78fa2c62ffafae72ab4d433bd3915b9ea2c879bd46c21425b8
+  data.tar.gz: c6b01886a05159ad378711135c7601f37120ac871959023176f5f9bbe991d64f44ae1b8969bb04553cd9100be32b16e649e97cddc737d46abc21d2b73e37e994

data/History.md

@@ -1,4 +1,10 @@
-=== 2.0 / 2016-03-DD
+=== 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
+    Cartage::Remote::Host tests to ensure that this does not regress.
+
+=== 2.0 / 2016-05-31
 
 *   Rewrote for compatibility with cartage 2.0.
 

data/Manifest.txt

@@ -9,3 +9,4 @@ lib/cartage/plugins/remote.rb
 lib/cartage/remote/host.rb
 test/minitest_config.rb
 test/test_cartage_remote.rb
+test/test_cartage_remote_host.rb

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.0' #:nodoc:
+    VERSION = '2.1' #:nodoc:
 
     # Build on the remote server.
     def build
@@ -377,7 +377,7 @@ cd #{paths.build_path} && git checkout #{cartage.release_hashref}
       else
         @keys = Array(config.keys || '~/.ssh/*id_[rd]sa').flat_map { |key|
           Pathname.glob(Pathname(key).expand_path)
-        }
+        }.uniq
       end
 
       @build_root = Pathname(config.build_root || '~')

data/lib/cartage/remote/host.rb

@@ -17,6 +17,12 @@ class Cartage::Remote::Host
   # The (optional) postbuild script defined as part of this host.
   attr_reader :postbuild
 
+  # The (optional) array of SSH private key filenames defined as part of this
+  # host.
+  attr_reader :keys
+  # The (optional) array of SSH private keys defined as part of this host.
+  attr_reader :key_data
+
   # The Fog::SSH instance for this server. Must run #configure_ssh before
   # using.
   attr_reader :ssh
@@ -41,11 +47,17 @@ class Cartage::Remote::Host
 
       if host.keys.kind_of?(OpenStruct)
         @key_data = host.keys.to_h.values
-      else
+      elsif host.keys
         @keys = Array(host.keys).flat_map { |key|
           Pathname.glob(Pathname(key).expand_path)
-        }
+        }.uniq
       end
+
+      # If key_data or keys are empty, properly empty them so that they are
+      # handled improperly.
+      @key_data = nil if @key_data && @key_data.empty?
+      @keys = nil if @keys && @keys.empty?
+
       @build = host.build
       @prebuild = host.prebuild
       @postbuild = host.postbuild

data/test/minitest_config.rb

@@ -9,3 +9,7 @@ require 'minitest/bisect'
 require 'minitest-bonus-assertions'
 
 require 'cartage/minitest'
+require 'cartage/plugins/remote'
+require 'fog'
+
+Fog.mock!

data/test/test_cartage_remote_host.rb

@@ -0,0 +1,172 @@
+# frozen_string_literal: true
+
+require 'minitest_config'
+
+describe 'Cartage::Remote::Host' do
+  let(:string_host) {
+    'suser@saddress:sport'
+  }
+  let(:hash_host) {
+    {
+      user: 'huser',
+      address: 'haddress',
+      host: 'hhost',
+      port: 'hport'
+    }
+  }
+
+  let(:remote_config) {
+    {
+      hosts: {
+        default: hash_host
+      }
+    }
+  }
+  let(:config_hash) {
+    {
+      root_path: '/a/b/c',
+      name: 'test',
+      timestamp: 'value',
+      plugins: {
+        remote: remote_config
+      }
+    }
+  }
+  let(:config) { Cartage::Config.new(config_hash) }
+  let(:host) { Cartage::Remote::Host.new(config.plugins.remote.hosts.default) }
+  let(:ssh) { host.ssh }
+
+  describe '#initialize' do
+    it 'parses a string host correctly' do
+      host = Cartage::Remote::Host.new(string_host)
+      assert_equal 'suser', host.user
+      assert_equal 'saddress', host.address
+      assert_equal 'sport', host.port
+      assert_nil host.build
+      assert_nil host.prebuild
+      assert_nil host.postbuild
+      assert_nil host.keys
+      assert_nil host.key_data
+    end
+
+    describe 'with a config/OpenStruct host' do
+      it 'parses correctly' do
+        assert_equal 'huser', host.user
+        assert_equal 'haddress', host.address
+        assert_equal 'hport', host.port
+        assert_nil host.build
+        assert_nil host.prebuild
+        assert_nil host.postbuild
+        assert_nil host.keys
+        assert_nil host.key_data
+      end
+
+      it 'parses host script overrides correctly' do
+        hash_host.update(
+          build: 'hbuild',
+          prebuild: 'hprebuild',
+          postbuild: 'hpostbuild'
+        )
+
+        assert_equal 'hbuild', host.build
+        assert_equal 'hprebuild', host.prebuild
+        assert_equal 'hpostbuild', host.postbuild
+      end
+
+      it 'parses host keys overrides correctly' do
+        hash_host.update(keys: '~/.ssh/id_rsa')
+
+        stub Pathname, :glob, %w(/home/user/.ssh/id_rsa) do
+          assert_equal %w(/home/user/.ssh/id_rsa), host.keys
+          assert_nil host.key_data
+        end
+      end
+
+      it 'parses host keys overrides correctly (removing duplicates)' do
+        hash_host.update(keys: %w(~/.ssh/id_rsa) * 2)
+
+        stub Pathname, :glob, %w(/home/user/.ssh/id_rsa) do
+          assert_equal %w(/home/user/.ssh/id_rsa), host.keys
+          assert_nil host.key_data
+        end
+      end
+
+      it 'parses empty host keys overrides correctly (back to nil)' do
+        hash_host.update(keys: [])
+
+        stub Pathname, :glob, %w(/home/user/.ssh/id_rsa) do
+          assert_nil host.keys
+          assert_nil host.key_data
+        end
+      end
+
+      it 'parses host key_data overrides correctly' do
+        hash_host.update(
+          keys: {
+            custom: 'Host ASCII-Armored Private Key'
+          }
+        )
+
+        assert_nil host.keys
+        assert_equal [ 'Host ASCII-Armored Private Key' ], host.key_data
+      end
+
+      it 'parses empty host key_data overrides correctly (back to nil)' do
+        hash_host.update(keys: {})
+
+        assert_nil host.keys
+        assert_nil host.key_data
+      end
+    end
+  end
+
+  describe '#configure_ssh' do
+    def assert_ssh_value(expected, name)
+      assert_equal expected, ssh.instance_variable_get(:"@#{name}")
+    end
+
+    def assert_ssh_option(expected, name)
+      assert_equal expected, ssh.instance_variable_get(:@options)[name]
+    end
+
+    it 'configures SSH properly' do
+      host.configure_ssh({})
+      assert_ssh_value 'haddress', :address
+      assert_ssh_value 'huser', :username
+      assert_ssh_option 'hport', :port
+      assert_ssh_option true, :paranoid
+    end
+
+    it 'uses the provided key_data if there is no host override' do
+      host.configure_ssh(key_data: [ 'Global ASCII-Armored Private Key' ])
+      assert_ssh_option [ 'Global ASCII-Armored Private Key' ], :key_data
+    end
+
+    it 'uses the provided keys if there is no host override' do
+      host.configure_ssh(keys: %w(path/to/a/key/file))
+      assert_ssh_option %w(path/to/a/key/file), :keys
+    end
+
+    it 'uses the host keys if present' do
+      hash_host.update(keys: '~/.ssh/id_rsa')
+
+      stub Pathname, :glob, %w(/home/user/.ssh/id_rsa) do
+        host.configure_ssh(keys: [ 'path/to/a/key/file' ])
+      end
+
+      assert_ssh_option %w(/home/user/.ssh/id_rsa), :keys
+    end
+
+    it 'uses the provided keys if host keys is empty' do
+      hash_host.update(keys: [])
+      host.configure_ssh(keys: %w(path/to/a/key/file))
+      assert_ssh_option %w(path/to/a/key/file), :keys
+    end
+
+    it 'uses the provided key_data if host key_data is empty' do
+      hash_host.update(keys: {})
+      host.configure_ssh(key_data: [ 'Global ASCII-Armored Private Key' ])
+      assert_ssh_option [ 'Global ASCII-Armored Private Key' ], :key_data
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cartage-remote
 version: !ruby/object:Gem::Version
-  version: '2.0'
+  version: '2.1'
 platform: ruby
 authors:
 - Austin Ziegler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-31 00:00:00.000000000 Z
+date: 2016-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cartage
@@ -319,6 +319,7 @@ files:
 - lib/cartage/remote/host.rb
 - test/minitest_config.rb
 - test/test_cartage_remote.rb
+- test/test_cartage_remote_host.rb
 homepage: https://github.com/KineticCafe/cartage-remote/
 licenses:
 - MIT