train 0.29.2 → 0.30.0

data/test/unit/plugins/connection_test.rb

@@ -10,20 +10,28 @@ describe 'v1 Connection Plugin' do
       connection.close # wont raise
     end
 
-    it 'provides a run_command method' do
-      proc { connection.run_command('') }.must_raise Train::ClientError
+    it 'raises an exception for run_command' do
+      proc { connection.run_command('') }.must_raise NotImplementedError
     end
 
-    it 'provides an os method' do
-      proc { connection.os }.must_raise Train::ClientError
+    it 'raises an exception for run_command_via_connection' do
+      proc { connection.send(:run_command_via_connection, '') }.must_raise NotImplementedError
     end
 
-    it 'provides a file method' do
-      proc { connection.file('') }.must_raise Train::ClientError
+    it 'raises an exception for os method' do
+      proc { connection.os }.must_raise NotImplementedError
     end
 
-    it 'provides a login command method' do
-      proc { connection.login_command }.must_raise Train::ClientError
+    it 'raises an exception for file method' do
+      proc { connection.file('') }.must_raise NotImplementedError
+    end
+
+    it 'raises an exception for file_via_connection method' do
+      proc { connection.send(:file_via_connection, '') }.must_raise NotImplementedError
+    end
+
+    it 'raises an exception for login command method' do
+      proc { connection.login_command }.must_raise NotImplementedError
     end
 
     it 'can wait until ready' do
@@ -40,5 +48,95 @@ describe 'v1 Connection Plugin' do
       cls.new({logger: l})
          .method(:logger).call.must_equal(l)
     end
+
+    describe 'create cache connection' do
+      it 'default connection cache settings' do
+        connection.cache_enabled?(:file).must_equal true
+        connection.cache_enabled?(:command).must_equal false
+      end
+    end
+
+    describe 'disable/enable caching' do
+      it 'disable file cache via connection' do
+        connection.disable_cache(:file)
+        connection.cache_enabled?(:file).must_equal false
+      end
+
+      it 'enable command cache via cache_connection' do
+        connection.enable_cache(:command)
+        connection.cache_enabled?(:command).must_equal true
+      end
+
+      it 'raises an exception for unknown cache type' do
+        proc { connection.enable_cache(:fake) }.must_raise Train::UnknownCacheType
+        proc { connection.disable_cache(:fake) }.must_raise Train::UnknownCacheType
+      end
+    end
+
+    describe 'cache enable check' do
+      it 'returns true when cache is enabled' do
+        cache_enabled = connection.instance_variable_get(:@cache_enabled)
+        cache_enabled[:test] = true
+        connection.cache_enabled?(:test).must_equal true
+      end
+
+      it 'returns false when cache is disabled' do
+        cache_enabled = connection.instance_variable_get(:@cache_enabled)
+        cache_enabled[:test] = false
+        connection.cache_enabled?(:test).must_equal false
+      end
+    end
+
+    describe 'clear cache' do
+      it 'clear file cache' do
+        cache = connection.instance_variable_get(:@cache)
+        cache[:file]['/tmp'] = 'test'
+        connection.send(:clear_cache, :file)
+        cache = connection.instance_variable_get(:@cache)
+        cache[:file].must_equal({})
+      end
+    end
+
+    describe 'load file' do
+      it 'with caching' do
+        connection.enable_cache(:file)
+        connection.expects(:file_via_connection).once.returns('test_file')
+        connection.file('/tmp/test').must_equal('test_file')
+        connection.file('/tmp/test').must_equal('test_file')
+        assert = { '/tmp/test' => 'test_file' }
+        cache = connection.instance_variable_get(:@cache)
+        cache[:file].must_equal(assert)
+      end
+
+      it 'without caching' do
+        connection.disable_cache(:file)
+        connection.expects(:file_via_connection).twice.returns('test_file')
+        connection.file('/tmp/test').must_equal('test_file')
+        connection.file('/tmp/test').must_equal('test_file')
+        cache = connection.instance_variable_get(:@cache)
+        cache[:file].must_equal({})
+      end
+    end
+
+    describe 'run command' do
+      it 'with caching' do
+        connection.enable_cache(:command)
+        connection.expects(:run_command_via_connection).once.returns('test_user')
+        connection.run_command('whoami').must_equal('test_user')
+        connection.run_command('whoami').must_equal('test_user')
+        assert = { 'whoami' => 'test_user' }
+        cache = connection.instance_variable_get(:@cache)
+        cache[:command].must_equal(assert)
+      end
+
+      it 'without caching' do
+        connection.disable_cache(:command)
+        connection.expects(:run_command_via_connection).twice.returns('test_user')
+        connection.run_command('whoami').must_equal('test_user')
+        connection.run_command('whoami').must_equal('test_user')
+        cache = connection.instance_variable_get(:@cache)
+        cache[:command].must_equal({})
+      end
+    end
   end
 end

data/test/unit/transports/local_test.rb

@@ -1,27 +1,22 @@
 # encoding: utf-8
-#
-# author: Dominik Richter
-# author: Christoph Hartmann
 
 require 'helper'
 require 'train/transports/local'
 
-# overwrite os detection to simplify mock tests, otherwise run_command tries to
-# determine the OS first and fails the tests
-class Train::Transports::Local::Connection
-  class OS < OSCommon
-    def initialize(backend)
-      super(backend, { family: 'train_mock_os' })
-    end
+class TransportHelper
+  attr_accessor :transport
 
-    def detect_family
-      # no op, we do not need to detect the os
-    end
+  def initialize
+    Train::Platforms::Detect::Specifications::OS.load
+    plat = Train::Platforms.name('mock').in_family('linux')
+    plat.add_platform_methods
+    Train::Platforms::Detect.stubs(:scan).returns(plat)
+    @transport = Train::Transports::Local.new
   end
 end
 
 describe 'local transport' do
-  let(:transport) { Train::Transports::Local.new }
+  let(:transport) { TransportHelper.new.transport }
   let(:connection) { transport.connection }
 
   it 'can be instantiated' do
@@ -33,7 +28,7 @@ describe 'local transport' do
   end
 
   it 'provides a uri' do
-    connection.uri.must_equal "local://"
+    connection.uri.must_equal 'local://'
   end
 
   it 'doesnt wait to be read' do
@@ -48,6 +43,16 @@ describe 'local transport' do
     connection.login_command.must_be_nil
   end
 
+  it 'provides a run_command_via_connection method' do
+    methods = connection.class.private_instance_methods(false)
+    methods.include?(:run_command_via_connection).must_equal true
+  end
+
+  it 'provides a file_via_connection method' do
+    methods = connection.class.private_instance_methods(false)
+    methods.include?(:file_via_connection).must_equal true
+  end
+
   describe 'when running a local command' do
     let(:cmd_runner) { Minitest::Mock.new }
 

data/test/unit/transports/mock_test.rb

@@ -19,6 +19,16 @@ describe 'mock transport' do
     connection.uri.must_equal 'mock://'
   end
 
+  it 'provides a run_command_via_connection method' do
+    methods = connection.class.private_instance_methods(false)
+    methods.include?(:run_command_via_connection).must_equal true
+  end
+
+  it 'provides a file_via_connection method' do
+    methods = connection.class.private_instance_methods(false)
+    methods.include?(:file_via_connection).must_equal true
+  end
+
   describe 'when running a mocked command' do
     let(:mock_cmd) {  }
 
@@ -71,15 +81,15 @@ describe 'mock transport' do
   end
 
   describe 'when accessing a mocked os' do
-    it 'has the default mock os faily set to unknown' do
-      connection.os[:family].must_equal 'unknown'
+    it 'has the default mock os faily set to mock' do
+      connection.os[:name].must_equal 'mock'
     end
 
     it 'sets the OS to the mocked value' do
-      connection.mock_os({ family: 'centos' })
+      connection.mock_os({ name: 'centos', family: 'redhat' })
       connection.os.linux?.must_equal true
       connection.os.redhat?.must_equal true
-      connection.os[:family].must_equal 'centos'
+      connection.os[:family].must_equal 'redhat'
     end
 
     it 'allows the setting of the name' do
@@ -112,8 +122,8 @@ describe 'mock transport' do
 
     it 'properly handles a nil value' do
       connection.mock_os(nil)
-      connection.os[:name].must_equal 'unknown'
-      connection.os[:family].must_equal 'unknown'
+      connection.os[:name].must_equal 'mock'
+      connection.os[:family].must_equal 'mock'
     end
   end
 

data/test/unit/transports/ssh_test.rb

@@ -1,23 +1,15 @@
 # encoding: utf-8
+
 require 'helper'
 require 'train/transports/ssh'
 
-# overwrite os detection to simplify mock tests, otherwise run_command tries to
-# determine the OS first and fails the tests
-class Train::Transports::SSH::Connection
-  class OS < OSCommon
-    def initialize(backend)
-      super(backend, { family: 'train_mock_os' })
-    end
-
-    def detect_family
-      # no op, we do not need to detect the os
-    end
-  end
-end
-
 describe 'ssh transport' do
-  let(:cls) { Train::Transports::SSH }
+  let(:cls) do
+      plat = Train::Platforms.name('mock').in_family('linux')
+      plat.add_platform_methods
+      Train::Platforms::Detect.stubs(:scan).returns(plat)
+      Train::Transports::SSH
+  end
   let(:conf) {{
     host: rand.to_s,
     password: rand.to_s,
@@ -66,6 +58,16 @@ describe 'ssh transport' do
     let(:ssh) { cls.new(conf) }
     let(:connection) { ssh.connection }
 
+    it 'provides a run_command_via_connection method' do
+      methods = connection.class.private_instance_methods(false)
+      methods.include?(:run_command_via_connection).must_equal true
+    end
+
+    it 'provides a file_via_connection method' do
+      methods = connection.class.private_instance_methods(false)
+      methods.include?(:file_via_connection).must_equal true
+    end
+
     it 'gets the connection' do
       connection.must_be_kind_of Train::Transports::SSH::Connection
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: train
 version: !ruby/object:Gem::Version
-  version: 0.29.2
+  version: 0.30.0
 platform: ruby
 authors:
 - Dominik Richter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-21 00:00:00.000000000 Z
+date: 2017-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -151,17 +151,7 @@ files:
 - lib/train/errors.rb
 - lib/train/extras.rb
 - lib/train/extras/command_wrapper.rb
-- lib/train/extras/linux_lsb.rb
-- lib/train/extras/os_common.rb
-- lib/train/extras/os_detect_arista_eos.rb
-- lib/train/extras/os_detect_darwin.rb
-- lib/train/extras/os_detect_esx.rb
-- lib/train/extras/os_detect_linux.rb
-- lib/train/extras/os_detect_openvms.rb
-- lib/train/extras/os_detect_unix.rb
-- lib/train/extras/os_detect_windows.rb
 - lib/train/extras/stat.rb
-- lib/train/extras/uname.rb
 - lib/train/file.rb
 - lib/train/file/local.rb
 - lib/train/file/local/unix.rb
@@ -173,12 +163,21 @@ files:
 - lib/train/file/remote/unix.rb
 - lib/train/file/remote/windows.rb
 - lib/train/options.rb
+- lib/train/platforms.rb
+- lib/train/platforms/common.rb
+- lib/train/platforms/detect.rb
+- lib/train/platforms/detect/helpers/os_common.rb
+- lib/train/platforms/detect/helpers/os_linux.rb
+- lib/train/platforms/detect/helpers/os_windows.rb
+- lib/train/platforms/detect/scanner.rb
+- lib/train/platforms/detect/specifications/os.rb
+- lib/train/platforms/family.rb
+- lib/train/platforms/platform.rb
 - lib/train/plugins.rb
 - lib/train/plugins/base_connection.rb
 - lib/train/plugins/transport.rb
 - lib/train/transports/docker.rb
 - lib/train/transports/local.rb
-- lib/train/transports/local_os.rb
 - lib/train/transports/mock.rb
 - lib/train/transports/ssh.rb
 - lib/train/transports/ssh_connection.rb
@@ -217,9 +216,6 @@ files:
 - test/integration/tests/path_symlink_test.rb
 - test/integration/tests/run_command_test.rb
 - test/unit/extras/command_wrapper_test.rb
-- test/unit/extras/os_common_test.rb
-- test/unit/extras/os_detect_linux_test.rb
-- test/unit/extras/os_detect_windows_test.rb
 - test/unit/extras/stat_test.rb
 - test/unit/file/local/unix_test.rb
 - test/unit/file/local/windows_test.rb
@@ -229,6 +225,14 @@ files:
 - test/unit/file/remote_test.rb
 - test/unit/file_test.rb
 - test/unit/helper.rb
+- test/unit/platforms/detect/os_common_test.rb
+- test/unit/platforms/detect/os_linux_test.rb
+- test/unit/platforms/detect/os_windows_test.rb
+- test/unit/platforms/detect/scanner_test.rb
+- test/unit/platforms/family_test.rb
+- test/unit/platforms/os_detect_test.rb
+- test/unit/platforms/platform_test.rb
+- test/unit/platforms/platforms_test.rb
 - test/unit/plugins/connection_test.rb
 - test/unit/plugins/transport_test.rb
 - test/unit/plugins_test.rb
@@ -297,9 +301,6 @@ test_files:
 - test/integration/tests/path_symlink_test.rb
 - test/integration/tests/run_command_test.rb
 - test/unit/extras/command_wrapper_test.rb
-- test/unit/extras/os_common_test.rb
-- test/unit/extras/os_detect_linux_test.rb
-- test/unit/extras/os_detect_windows_test.rb
 - test/unit/extras/stat_test.rb
 - test/unit/file/local/unix_test.rb
 - test/unit/file/local/windows_test.rb
@@ -309,6 +310,14 @@ test_files:
 - test/unit/file/remote_test.rb
 - test/unit/file_test.rb
 - test/unit/helper.rb
+- test/unit/platforms/detect/os_common_test.rb
+- test/unit/platforms/detect/os_linux_test.rb
+- test/unit/platforms/detect/os_windows_test.rb
+- test/unit/platforms/detect/scanner_test.rb
+- test/unit/platforms/family_test.rb
+- test/unit/platforms/os_detect_test.rb
+- test/unit/platforms/platform_test.rb
+- test/unit/platforms/platforms_test.rb
 - test/unit/plugins/connection_test.rb
 - test/unit/plugins/transport_test.rb
 - test/unit/plugins_test.rb

data/lib/train/extras/linux_lsb.rb

@@ -1,60 +0,0 @@
-# encoding: utf-8
-# author: Dominik Richter
-# author: Christoph Hartmann
-#
-# This is heavily based on:
-#
-#   OHAI https://github.com/chef/ohai
-#   by Adam Jacob, Chef Software Inc
-#
-
-module Train::Extras
-  module LinuxLSB
-    def lsb_config(content)
-      {
-        id:       content[/^DISTRIB_ID=["']?(.+?)["']?$/, 1],
-        release:  content[/^DISTRIB_RELEASE=["']?(.+?)["']?$/, 1],
-        codename: content[/^DISTRIB_CODENAME=["']?(.+?)["']?$/, 1],
-      }
-    end
-
-    def lsb_release
-      raw = @backend.run_command('lsb_release -a').stdout
-      {
-        id:       raw[/^Distributor ID:\s+(.+)$/, 1],
-        release:  raw[/^Release:\s+(.+)$/, 1],
-        codename: raw[/^Codename:\s+(.+)$/, 1],
-      }
-    end
-
-    def lsb
-      return @lsb if defined?(@lsb)
-      @lsb = {}
-      if !(raw = get_config('/etc/lsb-release')).nil?
-        @lsb = lsb_config(raw)
-      elsif unix_file?('/usr/bin/lsb_release')
-        @lsb = lsb_release
-      end
-      @lsb
-    end
-
-    def detect_linux_via_lsb
-      return false if lsb[:id].nil?
-      id = lsb[:id].downcase
-      case id
-      when /redhat/
-        @platform[:family] = 'redhat'
-      when /amazon/
-        @platform[:family] = 'amazon'
-      when /scientificsl/
-        @platform[:family] = 'scientific'
-      when /xenserver/
-        @platform[:family] = 'xenserver'
-      else
-        @platform[:family] = id
-      end
-      @platform[:release] = lsb[:release]
-      true
-    end
-  end
-end