train 1.4.29 → 1.4.31

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65be3294011740eca689d8b5de1273f14f37d5189eae2a29111a4d268701af3a
-  data.tar.gz: bceb7f68344642b8f010b3e1ed5882afa4f4587fd7ebd1459635c2ca8954c3c6
+  metadata.gz: 41dd0a819427f0fdb0394992ca48fd80d9d67dd45d7a6c666472f48cb79cacb0
+  data.tar.gz: 8c05af271415f0165a1a68b2495832ba89f84864dcb5c26e498fd48e2cc4d43f
 SHA512:
-  metadata.gz: 34e6e054bb02d891857461d62756f02f63b0f42491ed7768764c82a6f1b1c3ab9b8158878ac4a1ebf4d6482b4cec62be7de2168f2980c84f662725dca48d2490
-  data.tar.gz: 3104bcaf1ba5edf30ed53702248c0f52e02d50435812a5eb0b6158a7873f6e85f28109e680184f22c6f445fe319113a94ccb2e0ec362150cb8ac285d2805d3e9
+  metadata.gz: 55719a930b672cab82cfeb76aebf0fa26643a75de1c61d618f65236d291682786a786376679a61c5533940c34391cb10d400f85852cd07b1e8d01b29f682b3f4
+  data.tar.gz: ab0665695a28b1e86b21fb83d2093907bb7850870603bba2fd35efb21b1b37c7e101a39dd6b4814cfea8d518ac762931275a9f578dad60c577fefc504f4ec1c0

data/.rubocop.yml

@@ -28,6 +28,8 @@ Metrics/PerceivedComplexity:
   Max: 10
 Metrics/AbcSize:
   Max: 33
+Metrics/ModuleLength:
+  Enabled: false
 Style/PercentLiteralDelimiters:
   PreferredDelimiters:
     '%':  '{}'

data/CHANGELOG.md

@@ -1,28 +1,34 @@
-<!-- latest_release 1.4.29 -->
-## [v1.4.29](https://github.com/inspec/train/tree/v1.4.29) (2018-08-15)
+<!-- latest_release 1.4.31 -->
+## [v1.4.31](https://github.com/inspec/train/tree/v1.4.31) (2018-08-16)
 
 #### Merged Pull Requests
-- Add non_interactive support for SSH [#336](https://github.com/inspec/train/pull/336) ([marcparadise](https://github.com/marcparadise))
+- Enable using rubygems as plugins [#335](https://github.com/inspec/train/pull/335) ([clintoncwolfe](https://github.com/clintoncwolfe))
 <!-- latest_release -->
 
-<!-- release_rollup since=1.4.25 -->
-### Changes since 1.4.25 release
-
-#### Features & Enhancements
-- Pulls file credentials parsing out of Azure class [#324](https://github.com/inspec/train/pull/324) ([dmccown](https://github.com/dmccown)) <!-- 1.4.27 -->
+<!-- release_rollup since=1.4.29 -->
+### Changes since 1.4.29 release
 
 #### Merged Pull Requests
-- Add non_interactive support for SSH [#336](https://github.com/inspec/train/pull/336) ([marcparadise](https://github.com/marcparadise)) <!-- 1.4.29 -->
-- Require Ruby 2.0 and allow net-ssh 5.0 [#334](https://github.com/inspec/train/pull/334) ([tas50](https://github.com/tas50)) <!-- 1.4.28 -->
-- Modify checksum logic to use system binaries [#251](https://github.com/inspec/train/pull/251) ([jerryaldrichiii](https://github.com/jerryaldrichiii)) <!-- 1.4.26 -->
+- Enable using rubygems as plugins [#335](https://github.com/inspec/train/pull/335) ([clintoncwolfe](https://github.com/clintoncwolfe)) <!-- 1.4.31 -->
+- Fixes an issue where the credential file was nil [#337](https://github.com/inspec/train/pull/337) ([dmccown](https://github.com/dmccown)) <!-- 1.4.30 -->
 <!-- release_rollup -->
 
 <!-- latest_stable_release -->
+## [v1.4.29](https://github.com/inspec/train/tree/v1.4.29) (2018-08-15)
+
+#### Features & Enhancements
+- Pulls file credentials parsing out of Azure class [#324](https://github.com/inspec/train/pull/324) ([dmccown](https://github.com/dmccown))
+
+#### Merged Pull Requests
+- Modify checksum logic to use system binaries [#251](https://github.com/inspec/train/pull/251) ([jerryaldrichiii](https://github.com/jerryaldrichiii))
+- Require Ruby 2.0 and allow net-ssh 5.0 [#334](https://github.com/inspec/train/pull/334) ([tas50](https://github.com/tas50))
+- Add non_interactive support for SSH [#336](https://github.com/inspec/train/pull/336) ([marcparadise](https://github.com/marcparadise))
+<!-- latest_stable_release -->
+
 ## [v1.4.25](https://github.com/inspec/train/tree/v1.4.25) (2018-08-01)
 
 #### Merged Pull Requests
 - Remove not needed google-cloud dependency (see #328) and correct GCP … [#329](https://github.com/inspec/train/pull/329) ([skpaterson](https://github.com/skpaterson))
-<!-- latest_stable_release -->
 
 ## [v1.4.24](https://github.com/inspec/train/tree/v1.4.24) (2018-07-26)
 

data/Gemfile

@@ -19,6 +19,13 @@ group :test do
   gem 'rubocop', '~> 0.36.0'
   gem 'simplecov', '~> 0.10'
   gem 'concurrent-ruby', '~> 1.0'
+  gem 'pry-byebug'
+  gem 'm'
+  # This is not a true gem installation
+  # (Gem::Specification.find_by_path('train-gem-fixture') will return nil)
+  # but it's close enough to show the gempath handler can find a plugin
+  # See test/unit/
+  gem 'train-gem-fixture', path: 'test/fixtures/gempath/gems'
 end
 
 group :integration do

data/lib/train.rb

@@ -36,16 +36,29 @@ module Train
   #
   # @param [String] name of the plugin
   # @return [Train::Transport] the transport plugin
-  def self.load_transport(name)
-    res = Train::Plugins.registry[name.to_s]
-    return res unless res.nil?
-
-    # if the plugin wasnt loaded yet:
-    require 'train/transports/' + name.to_s
-    Train::Plugins.registry[name.to_s]
+  def self.load_transport(transport_name)
+    transport_name = transport_name.to_s
+    transport_class = Train::Plugins.registry[transport_name]
+    return transport_class unless transport_class.nil?
+
+    # Try to load the transport name from the core transports...
+    require 'train/transports/' + transport_name
+    return Train::Plugins.registry[transport_name]
   rescue LoadError => _
-    raise Train::UserError,
-          "Can't find train plugin #{name.inspect}. Please install it first."
+    begin
+      # If it's not in the core transports, try loading from a train plugin gem.
+      gem_name = 'train-' + transport_name
+      require gem_name
+      return Train::Plugins.registry[transport_name]
+      # rubocop: disable Lint/HandleExceptions
+    rescue LoadError => _
+      # rubocop: enable Lint/HandleExceptions
+      # Intentionally empty rescue - we're handling it below anyway
+    end
+
+    ex = Train::PluginLoadError.new("Can't find train plugin #{transport_name}. Please install it first.")
+    ex.transport_name = transport_name
+    raise ex
   end
 
   # Resolve target configuration in URI-scheme into

data/lib/train/errors.rb

@@ -23,6 +23,11 @@ module Train
   # errors.
   class UserError < Error; end
 
+  # We could not load a plugin, because of a user error
+  class PluginLoadError < UserError
+    attr_accessor :transport_name
+  end
+
   # Base exception class for all exceptions that are caused by incorrect use
   # of an API.
   class ClientError < Error; end

data/lib/train/platforms/detect/helpers/os_common.rb

@@ -5,7 +5,7 @@ require 'train/platforms/detect/helpers/os_windows'
 require 'rbconfig'
 
 module Train::Platforms::Detect::Helpers
-  module OSCommon # rubocop:disable Metrics/ModuleLength
+  module OSCommon
     include Train::Platforms::Detect::Helpers::Linux
     include Train::Platforms::Detect::Helpers::Windows
 

data/lib/train/plugins/base_connection.rb

@@ -77,7 +77,7 @@ class Train::Plugins::Transport
       false
     end
 
-    def direct_platform(name, platform_details = nil)
+    def force_platform!(name, platform_details = nil)
       plat = Train::Platforms.name(name)
       plat.backend = self
       plat.platform = platform_details unless platform_details.nil?
@@ -86,6 +86,8 @@ class Train::Plugins::Transport
       plat
     end
 
+    alias direct_platform force_platform!
+
     def family_hierarchy(plat)
       plat.families.each_with_object([]) do |(k, _v), memo|
         memo << k.name

data/lib/train/transports/aws.rb

@@ -39,7 +39,7 @@ module Train::Transports
       end
 
       def platform
-        direct_platform('aws', @platform_details)
+        force_platform!('aws', @platform_details)
       end
 
       def aws_client(klass)

data/lib/train/transports/azure.rb

@@ -51,7 +51,7 @@ module Train::Transports
       end
 
       def platform
-        direct_platform('azure', @platform_details)
+        force_platform!('azure', @platform_details)
       end
 
       def azure_client(klass = ::Azure::Resources::Profiles::Latest::Mgmt::Client)

data/lib/train/transports/gcp.rb

@@ -43,7 +43,7 @@ module Train::Transports
       end
 
       def platform
-        direct_platform('gcp', @platform_details)
+        force_platform!('gcp', @platform_details)
       end
 
       # Instantiate some named classes for ease of use

data/lib/train/transports/helpers/azure/file_credentials.rb

@@ -12,6 +12,7 @@ module Train::Transports
         DEFAULT_FILE = ::File.join(Dir.home, '.azure', 'credentials')
 
         def self.parse(subscription_id: nil, credentials_file: DEFAULT_FILE, **_)
+          credentials_file = DEFAULT_FILE if credentials_file.nil?
           return {} unless ::File.readable?(credentials_file)
           credentials     = IniFile.load(::File.expand_path(credentials_file))
           subscription_id = parser(subscription_id, ENV['AZURE_SUBSCRIPTION_NUMBER'], credentials).subscription_id

data/lib/train/transports/vmware.rb

@@ -74,7 +74,7 @@ module Train::Transports
       end
 
       def platform
-        direct_platform('vmware', @platform_details)
+        force_platform!('vmware', @platform_details)
       end
 
       def run_command_via_connection(cmd)

data/lib/train/version.rb

@@ -3,5 +3,5 @@
 # Author:: Dominik Richter (<dominik.richter@gmail.com>)
 
 module Train
-  VERSION = '1.4.29'.freeze
+  VERSION = '1.4.31'.freeze
 end

data/test/fixtures/gempath/gems/train-gem-fixture-0.1.0/README.md

@@ -0,0 +1 @@
+This is a very simple train transport plugin, laid out as though it were an installed gem.  It is not a good example to use for learning, nor a good base for starting your own plugin - it's intended for for use during the testing of Train.

data/test/fixtures/gempath/gems/train-gem-fixture-0.1.0/lib/train-gem-fixture.rb

@@ -0,0 +1,2 @@
+require 'train'
+require 'train-gem-fixture/transport'

data/test/fixtures/gempath/gems/train-gem-fixture-0.1.0/lib/train-gem-fixture/transport.rb

@@ -0,0 +1,7 @@
+module TrainTransports
+  class GemFixture < Train.plugin(1)
+    name 'gem-fixture'
+
+    # what else do we need to implement?
+  end
+end

data/test/fixtures/gempath/gems/train-gem-fixture-0.1.0/lib/train-gem-fixture/version.rb

@@ -0,0 +1,5 @@
+module TrainTransports
+  class GemFixture
+    VERSION = '0.1.0'
+  end
+end

data/test/fixtures/gempath/gems/train-gem-fixture-0.1.0/train-gem-fixture.gemspec

@@ -0,0 +1,34 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "train-gem-fixture"
+  spec.version       = '0.1.0'
+  spec.authors       = ["Inspec core engineering team"]
+  spec.email         = ["hello@chef.io"]
+
+  spec.summary       = %q{Test train plugin, packaged as a local gem}
+  spec.description   = %q{Test train plugin, packaged as a local gem}
+  spec.homepage      = "https://github.com/inspec/train"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = %w{
+    README.md
+    lib/train-gem-fixture.rb
+    lib/train-gem-fixture/version.rb
+    lib/train-gem-fixture/transport.rb
+  }
+  spec.executables   = []
+  spec.require_paths = ["lib"]
+
+  # No deps
+end

data/test/unit/platforms/detect/uuid_test.rb

@@ -36,7 +36,7 @@ describe 'uuid' do
     end
 
     mock.files = file_objects
-    mock.direct_platform(name, plat_options)
+    mock.force_platform!(name, plat_options)
   end
 
   it 'finds a linux uuid from chef entity_uuid' do

data/test/unit/plugins/connection_test.rb

@@ -44,7 +44,7 @@ describe 'v1 Connection Plugin' do
     end
 
     it 'provides direct platform' do
-      plat = connection.direct_platform('mac_os_x')
+      plat = connection.force_platform!('mac_os_x')
       plat.name.must_equal 'mac_os_x'
       plat.linux?.must_equal false
       plat.cloud?.must_equal false
@@ -54,7 +54,7 @@ describe 'v1 Connection Plugin' do
     end
 
     it 'provides api direct platform' do
-      plat = connection.direct_platform('aws')
+      plat = connection.force_platform!('aws')
       plat.name.must_equal 'aws'
       plat.linux?.must_equal false
       plat.cloud?.must_equal true
@@ -66,7 +66,7 @@ describe 'v1 Connection Plugin' do
       aws_version = Gem.loaded_specs['aws-sdk'].version
       aws_version = "aws-sdk-v#{aws_version}"
       details = { release: aws_version }
-      plat = connection.direct_platform('aws', details)
+      plat = connection.force_platform!('aws', details)
       plat.name.must_equal 'aws'
       plat.release.must_equal aws_version
       plat[:release].must_equal aws_version

data/test/unit/train_test.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 #
 # Author:: Dominik Richter (<dominik.richter@gmail.com>)
-require 'helper'
+require_relative 'helper'
 
 describe Train do
   before do
@@ -11,9 +11,10 @@ describe Train do
   describe '#create' do
     it 'raises an error if the plugin isnt found' do
       proc { Train.create('missing') }.must_raise Train::UserError
+      proc { Train.create('missing') }.must_raise Train::PluginLoadError
     end
 
-    it 'load a plugin if it isnt in the registry yet via symbol' do
+    it 'loads a core plugin if it isnt in the registry yet via symbol' do
       Kernel.stub :require, true do
         ex = Class.new(Train.plugin 1) { name 'existing' }
         train = Train.create(:existing)
@@ -21,18 +22,30 @@ describe Train do
       end
     end
 
-    it 'load a plugin if it isnt in the registry yet via string' do
+    it 'loads a core plugin if it isnt in the registry yet via string' do
       Kernel.stub :require, true do
         ex = Class.new(Train.plugin 1) { name 'existing' }
         train = Train.create('existing')
         train.class.must_equal ex
       end
     end
+
+    it 'loads a gem plugin if it isnt in the registry yet via string' do
+      # The 'train-gem-fixture' gem is located in test/fixtures/gempath/gems and is
+      # added to the gempath via Bundler. The key difference is that it isn't under
+      # lib/train/trainsports, and Train will need to pre-pend 'train-' to the
+      # transport name to get the gem name.
+      transport = Train.create('gem-fixture')
+      # Normally one would call transport.class.name, but that's been overridden to be a write-only DSL method
+      # So use to_s
+      transport.class.to_s.must_equal 'TrainTransports::GemFixture'
+    end
   end
 
   describe '#options' do
     it 'raises exception if a given transport plugin isnt found' do
       proc { Train.options('missing') }.must_raise Train::UserError
+      proc { Train.options('missing') }.must_raise Train::PluginLoadError
     end
 
     it 'provides empty options of a transport plugin' do

data/test/unit/transports/helpers/azure/file_credentials_test.rb

@@ -38,6 +38,14 @@ describe 'parse_credentials_file' do
 
   let(:options) { { credentials_file: cred_file_multiple_entries.path } }
 
+  it 'handles a nil file' do
+    options[:credentials_file] = nil
+
+    result = Train::Transports::Helpers::Azure::FileCredentials.parse(options)
+
+    assert_empty(result)
+  end
+
   it 'returns empty hash when no credentials file detected' do
     result = Train::Transports::Helpers::Azure::FileCredentials.parse({})
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: train
 version: !ruby/object:Gem::Version
-  version: 1.4.29
+  version: 1.4.31
 platform: ruby
 authors:
 - Dominik Richter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-15 00:00:00.000000000 Z
+date: 2018-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -265,6 +265,11 @@ files:
 - lib/train/transports/winrm.rb
 - lib/train/transports/winrm_connection.rb
 - lib/train/version.rb
+- test/fixtures/gempath/gems/train-gem-fixture-0.1.0/README.md
+- test/fixtures/gempath/gems/train-gem-fixture-0.1.0/lib/train-gem-fixture.rb
+- test/fixtures/gempath/gems/train-gem-fixture-0.1.0/lib/train-gem-fixture/transport.rb
+- test/fixtures/gempath/gems/train-gem-fixture-0.1.0/lib/train-gem-fixture/version.rb
+- test/fixtures/gempath/gems/train-gem-fixture-0.1.0/train-gem-fixture.gemspec
 - test/integration/.kitchen.yml
 - test/integration/Berksfile
 - test/integration/bootstrap.sh
@@ -360,6 +365,11 @@ signing_key:
 specification_version: 4
 summary: Transport interface to talk to different backends.
 test_files:
+- test/fixtures/gempath/gems/train-gem-fixture-0.1.0/README.md
+- test/fixtures/gempath/gems/train-gem-fixture-0.1.0/lib/train-gem-fixture.rb
+- test/fixtures/gempath/gems/train-gem-fixture-0.1.0/lib/train-gem-fixture/transport.rb
+- test/fixtures/gempath/gems/train-gem-fixture-0.1.0/lib/train-gem-fixture/version.rb
+- test/fixtures/gempath/gems/train-gem-fixture-0.1.0/train-gem-fixture.gemspec
 - test/integration/.kitchen.yml
 - test/integration/Berksfile
 - test/integration/bootstrap.sh