train 0.12.1

data/test/unit/transports/mock_test.rb

@@ -0,0 +1,87 @@
+# encoding: utf-8
+require 'helper'
+require 'train/transports/mock'
+require 'digest/sha2'
+
+describe 'mock transport' do
+  let(:transport) { Train::Transports::Mock.new(verbose: true) }
+  let(:connection) { transport.connection }
+
+  it 'can be instantiated' do
+    transport.wont_be_nil
+  end
+
+  it 'can create a connection' do
+    connection.wont_be_nil
+  end
+
+  describe 'when running a mocked command' do
+    let(:mock_cmd) {  }
+
+    it 'has a simple mock command creator' do
+      out = rand
+      cls = Train::Transports::Mock::Connection::Command
+      res = cls.new(out, '', 0)
+      connection.mock_command('test', out).must_equal res
+    end
+
+    it 'handles nil commands' do
+      connection.run_command(nil).stdout.must_equal('')
+    end
+
+    it 'can mock up nil commands' do
+      out = rand
+      connection.mock_command('', rand) # don't pull this result! always mock the input
+      connection.mock_command(nil, out) # pull this result
+      connection.run_command(nil).stdout.must_equal(out)
+    end
+
+    it 'gets results for stdout' do
+      out = rand
+      cmd = rand
+      connection.mock_command(cmd, out)
+      connection.run_command(cmd).stdout.must_equal(out)
+    end
+
+    it 'gets results for stderr' do
+      err = rand
+      cmd = rand
+      connection.mock_command(cmd, nil, err)
+      connection.run_command(cmd).stderr.must_equal(err)
+    end
+
+    it 'gets results for exit_status' do
+      code = rand
+      cmd = rand
+      connection.mock_command(cmd, nil, nil, code)
+      connection.run_command(cmd).exit_status.must_equal(code)
+    end
+
+    it 'can mock a command via its SHA2 sum' do
+      out = rand.to_s
+      cmd = rand.to_s
+      shacmd = Digest::SHA256.hexdigest cmd
+      connection.mock_command(shacmd, out)
+      connection.run_command(cmd).stdout.must_equal(out)
+    end
+  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'
+    end
+
+    it 'sets the OS to the mocked value' do
+      connection.mock_os({ family: 'centos' })
+      connection.os.linux?.must_equal true
+      connection.os.redhat?.must_equal true
+      connection.os[:family].must_equal 'centos'
+    end
+  end
+
+  describe 'when accessing a mocked file' do
+    it 'gets results for content' do
+
+    end
+  end
+end

data/test/unit/transports/ssh_test.rb

@@ -0,0 +1,109 @@
+# 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(:conf) {{
+    host: rand.to_s,
+    password: rand.to_s,
+    key_files: rand.to_s,
+  }}
+
+  describe 'default options' do
+    let(:ssh) { cls.new({ host: 'dummy' }) }
+
+    it 'can be instantiated (with valid config)' do
+      ssh.wont_be_nil
+    end
+
+    it 'configures the host' do
+      ssh.options[:host].must_equal 'dummy'
+    end
+
+    it 'has default port' do
+      ssh.options[:port].must_equal 22
+    end
+
+    it 'has default user' do
+      ssh.options[:user].must_equal 'root'
+    end
+  end
+
+  describe 'opening a connection' do
+    let(:ssh) { cls.new(conf) }
+    let(:connection) { ssh.connection }
+
+    it 'gets the connection' do
+      connection.must_be_kind_of Train::Transports::SSH::Connection
+    end
+
+    it 'must respond to wait_until_ready' do
+      connection.must_respond_to :wait_until_ready
+    end
+
+    it 'can be closed' do
+      connection.close.must_be_nil
+    end
+
+    it 'has a login command == ssh' do
+      connection.login_command.command.must_equal 'ssh'
+    end
+
+    it 'has login command arguments' do
+      connection.login_command.arguments.must_equal([
+        "-o", "UserKnownHostsFile=/dev/null",
+        "-o", "StrictHostKeyChecking=no",
+        "-o", "IdentitiesOnly=yes",
+        "-o", "LogLevel=VERBOSE",
+        "-o", "ForwardAgent=no",
+        "-i", conf[:key_files],
+        "-p", "22",
+        "root@#{conf[:host]}",
+      ])
+    end
+  end
+
+  describe 'failed configuration' do
+    it 'works with a minimum valid config' do
+      cls.new(conf).connection
+    end
+
+    it 'doesnt like host == nil' do
+      conf.delete(:host)
+      proc { cls.new(conf).connection }.must_raise Train::ClientError
+    end
+
+    it 'reverts to root on user == nil' do
+      conf[:user] = nil
+      cls.new(conf).connection.method(:options).call[:user] == 'root'
+    end
+
+    it 'doesnt like key and password == nil' do
+      conf.delete(:password)
+      conf.delete(:key_files)
+      proc { cls.new(conf).connection }.must_raise Train::ClientError
+    end
+
+    it 'wont connect if its not possible' do
+      conf[:host] = 'localhost'
+      conf[:port] = 1
+      conn = cls.new(conf).connection
+      proc { conn.run_command('uname') }.must_raise Train::Transports::SSHFailed
+    end
+  end
+end

data/test/unit/version_test.rb

@@ -0,0 +1,8 @@
+# encoding: utf-8
+require 'helper'
+
+describe Train do
+  it 'defines a version' do
+    Train::VERSION.must_be_instance_of String
+  end
+end

data/test/windows/local_test.rb

@@ -0,0 +1,46 @@
+# encoding: utf-8
+# author: Christoph Hartmann
+# author: Dominik Richter
+
+require 'minitest/autorun'
+require 'minitest/spec'
+require 'mocha/setup'
+require 'train'
+
+describe 'windows local command' do
+  let(:conn) {
+    # get final config
+    target_config = Train.target_config({})
+    # initialize train
+    backend = Train.create('local', target_config)
+
+    # start or reuse a connection
+    conn = backend.connection
+    conn
+  }
+
+  it 'verify os' do
+    os = conn.os
+    os[:name].must_equal 'Windows Server 2012 R2 Datacenter'
+    os[:family].must_equal "windows"
+    os[:release].must_equal '6.3.9600'
+    os[:arch].must_equal '64-bit'
+  end
+
+  it 'run echo test' do
+    cmd = conn.run_command('Write-Output "test"')
+    cmd.stdout.must_equal "test\r\n"
+    cmd.stderr.must_equal ''
+  end
+
+  it 'use powershell piping' do
+    cmd = conn.run_command("New-Object -Type PSObject | Add-Member -MemberType NoteProperty -Name A -Value (Write-Output 'PropertyA') -PassThru | Add-Member -MemberType NoteProperty -Name B -Value (Write-Output 'PropertyB') -PassThru | ConvertTo-Json")
+    cmd.stdout.must_equal "{\r\n    \"A\":  \"PropertyA\",\r\n    \"B\":  \"PropertyB\"\r\n}\r\n"
+    cmd.stderr.must_equal ''
+  end
+
+  after do
+    # close the connection
+    conn.close
+  end
+end

data/test/windows/winrm_test.rb

@@ -0,0 +1,52 @@
+# encoding: utf-8
+# author: Christoph Hartmann
+# author: Dominik Richter
+
+require 'minitest/autorun'
+require 'minitest/spec'
+require 'mocha/setup'
+require 'train'
+
+describe 'windows local command' do
+  let(:conn) {
+    # get final config
+    target_config = Train.target_config({
+      target: ENV['train_target'],
+      password: ENV['winrm_pass'],
+      ssl: ENV['train_ssl'],
+      self_signed: true,
+    })
+
+    # initialize train
+    backend = Train.create('winrm', target_config)
+
+    # start or reuse a connection
+    conn = backend.connection
+    conn
+  }
+
+  it 'verify os' do
+    os = conn.os
+    os[:name].must_equal 'Windows Server 2012 R2 Datacenter'
+    os[:family].must_equal 'windows'
+    os[:release].must_equal '6.3.9600'
+    os[:arch].must_equal '64-bit'
+  end
+
+  it 'run echo test' do
+    cmd = conn.run_command('Write-Output "test"')
+    cmd.stdout.must_equal "test\r\n"
+    cmd.stderr.must_equal ''
+  end
+
+  it 'use powershell piping' do
+    cmd = conn.run_command("New-Object -Type PSObject | Add-Member -MemberType NoteProperty -Name A -Value (Write-Output 'PropertyA') -PassThru | Add-Member -MemberType NoteProperty -Name B -Value (Write-Output 'PropertyB') -PassThru | ConvertTo-Json")
+    cmd.stdout.must_equal "{\r\n    \"A\":  \"PropertyA\",\r\n    \"B\":  \"PropertyB\"\r\n}\r\n"
+    cmd.stderr.must_equal ''
+  end
+
+  after do
+    # close the connection
+    conn.close
+  end
+end

data/train.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'train/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'train'
+  spec.version       = Train::VERSION
+  spec.authors       = ['Dominik Richter']
+  spec.email         = ['dominik.richter@gmail.com']
+  spec.summary       = 'Transport interface to talk to different backends.'
+  spec.description   = 'Transport interface to talk to different backends.'
+  spec.homepage      = 'https://github.com/chef/train/'
+  spec.license       = 'Apache-2.0'
+
+  spec.files = %w{
+    train.gemspec README.md Rakefile LICENSE Gemfile CHANGELOG.md .rubocop.yml
+  } + Dir.glob(
+    '{lib,test}/**/*', File::FNM_DOTMATCH
+  ).reject { |f| File.directory?(f) }
+
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'json', '~> 1.8'
+  # chef-client < 12.4.1 require mixlib-shellout-2.0.1
+  spec.add_dependency 'mixlib-shellout', '~> 2.0'
+  # net-ssh 3.x drops Ruby 1.9 support, so this constraint could be raised when
+  # 1.9 support is no longer needed here or for Inspec
+  spec.add_dependency 'net-ssh', '>= 2.9', '< 4.0'
+  spec.add_dependency 'net-scp', '~> 1.2'
+  spec.add_dependency 'winrm', '~> 1.6'
+  spec.add_dependency 'winrm-fs', '~> 0.3'
+  spec.add_dependency 'docker-api', '~> 1.26'
+
+  spec.add_development_dependency 'mocha', '~> 1.1'
+end

metadata

@@ -0,0 +1,295 @@
+--- !ruby/object:Gem::Specification
+name: train
+version: !ruby/object:Gem::Version
+  version: 0.12.1
+platform: ruby
+authors:
+- Dominik Richter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: mixlib-shellout
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: net-ssh
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: net-scp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: winrm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: winrm-fs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: docker-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.26'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.26'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  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'
+description: Transport interface to talk to different backends.
+email:
+- dominik.richter@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/train.rb
+- lib/train/errors.rb
+- lib/train/extras.rb
+- lib/train/extras/command_wrapper.rb
+- lib/train/extras/file_aix.rb
+- lib/train/extras/file_common.rb
+- lib/train/extras/file_linux.rb
+- lib/train/extras/file_unix.rb
+- lib/train/extras/file_windows.rb
+- lib/train/extras/linux_lsb.rb
+- lib/train/extras/os_common.rb
+- lib/train/extras/os_detect_darwin.rb
+- lib/train/extras/os_detect_linux.rb
+- lib/train/extras/os_detect_unix.rb
+- lib/train/extras/os_detect_windows.rb
+- lib/train/extras/stat.rb
+- lib/train/options.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_file.rb
+- lib/train/transports/local_os.rb
+- lib/train/transports/mock.rb
+- lib/train/transports/ssh.rb
+- lib/train/transports/ssh_connection.rb
+- lib/train/transports/winrm.rb
+- lib/train/transports/winrm_connection.rb
+- lib/train/version.rb
+- test/integration/.kitchen.yml
+- test/integration/Berksfile
+- test/integration/bootstrap.sh
+- test/integration/chefignore
+- test/integration/cookbooks/test/metadata.rb
+- test/integration/cookbooks/test/recipes/default.rb
+- test/integration/cookbooks/test/recipes/prep_files.rb
+- test/integration/docker_run.rb
+- test/integration/docker_test.rb
+- test/integration/docker_test_container.rb
+- test/integration/helper.rb
+- test/integration/sudo/customcommand.rb
+- test/integration/sudo/nopasswd.rb
+- test/integration/sudo/passwd.rb
+- test/integration/sudo/reqtty.rb
+- test/integration/sudo/run_as.rb
+- test/integration/test-travis-1.yaml
+- test/integration/test-travis-2.yaml
+- test/integration/test_local.rb
+- test/integration/test_ssh.rb
+- test/integration/tests/path_block_device_test.rb
+- test/integration/tests/path_character_device_test.rb
+- test/integration/tests/path_file_test.rb
+- test/integration/tests/path_folder_test.rb
+- test/integration/tests/path_missing_test.rb
+- test/integration/tests/path_pipe_test.rb
+- test/integration/tests/path_symlink_test.rb
+- test/integration/tests/run_command_test.rb
+- test/unit/extras/command_wrapper_test.rb
+- test/unit/extras/file_common_test.rb
+- test/unit/extras/linux_file_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/extras/windows_file_test.rb
+- test/unit/helper.rb
+- test/unit/plugins/connection_test.rb
+- test/unit/plugins/transport_test.rb
+- test/unit/plugins_test.rb
+- test/unit/train_test.rb
+- test/unit/transports/local_file_test.rb
+- test/unit/transports/local_test.rb
+- test/unit/transports/mock_test.rb
+- test/unit/transports/ssh_test.rb
+- test/unit/version_test.rb
+- test/windows/local_test.rb
+- test/windows/winrm_test.rb
+- train.gemspec
+homepage: https://github.com/chef/train/
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Transport interface to talk to different backends.
+test_files:
+- test/integration/.kitchen.yml
+- test/integration/Berksfile
+- test/integration/bootstrap.sh
+- test/integration/chefignore
+- test/integration/cookbooks/test/metadata.rb
+- test/integration/cookbooks/test/recipes/default.rb
+- test/integration/cookbooks/test/recipes/prep_files.rb
+- test/integration/docker_run.rb
+- test/integration/docker_test.rb
+- test/integration/docker_test_container.rb
+- test/integration/helper.rb
+- test/integration/sudo/customcommand.rb
+- test/integration/sudo/nopasswd.rb
+- test/integration/sudo/passwd.rb
+- test/integration/sudo/reqtty.rb
+- test/integration/sudo/run_as.rb
+- test/integration/test-travis-1.yaml
+- test/integration/test-travis-2.yaml
+- test/integration/test_local.rb
+- test/integration/test_ssh.rb
+- test/integration/tests/path_block_device_test.rb
+- test/integration/tests/path_character_device_test.rb
+- test/integration/tests/path_file_test.rb
+- test/integration/tests/path_folder_test.rb
+- test/integration/tests/path_missing_test.rb
+- test/integration/tests/path_pipe_test.rb
+- test/integration/tests/path_symlink_test.rb
+- test/integration/tests/run_command_test.rb
+- test/unit/extras/command_wrapper_test.rb
+- test/unit/extras/file_common_test.rb
+- test/unit/extras/linux_file_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/extras/windows_file_test.rb
+- test/unit/helper.rb
+- test/unit/plugins/connection_test.rb
+- test/unit/plugins/transport_test.rb
+- test/unit/plugins_test.rb
+- test/unit/train_test.rb
+- test/unit/transports/local_file_test.rb
+- test/unit/transports/local_test.rb
+- test/unit/transports/mock_test.rb
+- test/unit/transports/ssh_test.rb
+- test/unit/version_test.rb
+- test/windows/local_test.rb
+- test/windows/winrm_test.rb