train 1.5.11 → 1.6.3

data/Gemfile

@@ -1,41 +0,0 @@
-# encoding: utf-8
-source 'https://rubygems.org'
-gemspec name: 'train'
-
-# pin dependency for Ruby 1.9.3 since bundler is not
-# detecting that net-ssh 3 does not work with 1.9.3
-if Gem::Version.new(RUBY_VERSION) <= Gem::Version.new('1.9.3')
-  gem 'net-ssh', '~> 2.9'
-end
-
-if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.2.2')
-  gem 'json', '< 2.0'
-end
-
-group :test do
-  gem 'bundler', '~> 1.11'
-  gem 'minitest', '~> 5.8'
-  gem 'rake', '~> 10'
-  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-test-fixture', path: 'test/fixtures/plugins/train-test-fixture'
-end
-
-group :integration do
-  gem 'berkshelf', '~> 5.2'
-  gem 'test-kitchen', '~> 1.11'
-  gem 'kitchen-vagrant'
-end
-
-group :tools do
-  gem 'pry', '~> 0.10'
-  gem 'rb-readline'
-  gem 'license_finder'
-end

data/README.md

@@ -1,212 +0,0 @@
-# Train - Transport Interface
-
-[![Build Status](https://travis-ci.org/inspec/train.svg?branch=master)](https://travis-ci.org/inspec/train)
-[![Build Status Master](https://ci.appveyor.com/api/projects/status/github/inspec/train?branch=master&svg=true&passingText=master%20-%20Ok&pendingText=master%20-%20Pending&failingText=master%20-%20Failing)](https://ci.appveyor.com/project/Chef/train/branch/master)
-[![Gem Version](https://badge.fury.io/rb/train.svg)](https://badge.fury.io/rb/train)
-
-Train lets you talk to your local or remote operating systems and APIs with a unified interface.
-
-It allows you to:
-
-* execute commands via `run_command`
-* interact with files via `file`
-* identify the target operating system via `os`
-* authenticate to API-based services and treat them like a platform
-
-Train supports:
-
-* Local execution
-* SSH
-* WinRM
-* Docker
-* Mock (for testing and debugging)
-* AWS as an API
-* Azure as an API
-* VMware via PowerCLI
-
-# Examples
-
-## Setup
-
-**Local**
-
-```ruby
-require 'train'
-train = Train.create('local')
-```
-
-**SSH**
-
-```ruby
-require 'train'
-train = Train.create('ssh',
-  host: '1.2.3.4', port: 22, user: 'root', key_files: '/vagrant')
-```
-
-If you don't specify the `key_files` and `password` options, SSH agent authentication will be attempted. For example:
-
-```ruby
-require 'train'
-train = Train.create('ssh', host: '1.2.3.4', port: 22, user: 'root')
-```
-
-**WinRM**
-
-```ruby
-require 'train'
-train = Train.create('winrm',
-  host: '1.2.3.4', user: 'Administrator', password: '...', ssl: true, self_signed: true)
-```
-
-**Docker**
-
-```ruby
-require 'train'
-train = Train.create('docker', host: 'container_id...')
-```
-
-**AWS**
-
-To use AWS API authentication, setup an AWS client profile to store the Access Key ID and Secret Access Key.
-
-```ruby
-require 'train'
-train = Train.create('aws', region: 'us-east-2', profile: 'my-profile')
-```
-
-You may also use the standard AWS CLI environment variables, `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY` and `AWS_REGION`.
-```ruby
-require 'train'
-train = Train.create('aws')
-```
-
-**VMware**
-
-```ruby
-require 'train'
-Train.create('vmware', viserver: '10.0.0.10', user: 'demouser', password: 'securepassword')
-```
-
-You may also use environment variables by setting `VISERVER`, `VISERVER__USERNAME`, and `VISERVER_PASSWORD`
-
-```ruby
-require 'train'
-Train.create('vmware')
-```
-
-## Configuration
-
-To get a list of available options for a plugin:
-
-```ruby
-puts Train.options('ssh')
-```
-This will provide all configuration options:
-
-```ruby
-{
-  :host     => { :required => true},
-  :port     => { :default  => 22, :required => true},
-  :user     => { :default  => "root", :required => true},
-  :keys     => { :default  => nil},
-  :password => { :default  => nil},
-  ...
-```
-
-## Usage
-
-```ruby
-# start or reuse a connection
-conn = train.connection
-
-# run a command on Linux/Unix/Mac
-puts conn.run_command('whoami').stdout
-
-# get OS info
-puts conn.os[:family]
-puts conn.os[:release]
-
-# access files
-puts conn.file('/proc/version').content
-
-# access specific API client functionality
-ec2_client = train.connection.aws_client(Aws::EC2::Client)
-puts ec2_client.describe_instances
-
-# close the connection
-conn.close
-```
-
-# Testing
-
-We perform `unit`, `integration` and `windows` tests.
-
-* `unit` tests ensure the intended behaviour of the implementation
-* `integration` tests run against VMs and docker containers
-* `windows` tests that run on appveyor for windows integration tests
-
-## Mac/Linux
-
-```
-bundle exec ruby -W -Ilib:test/unit test/unit/extras/stat_test.rb
-```
-
-## Windows
-
-```
-# run windows tests
-bundle exec rake test:windows
-
-# run single tests
-bundle exec ruby -I .\test\windows\ .\test\windows\local_test.rb
-```
-
-
-# Kudos and Contributors
-
-Train is heavily based on the work of:
-
-* [test-kitchen](https://github.com/test-kitchen/test-kitchen)
-
-    by [Fletcher Nichol](fnichol@nichol.ca)
-    and [a great community of contributors](https://github.com/test-kitchen/test-kitchen/graphs/contributors)
-
-* [ohai](https://github.com/chef/ohai)
-
-    by Adam Jacob, Chef Software Inc.
-    and [a great community of contributors](https://github.com/chef/ohai/graphs/contributors)
-
-
-We also want to thank [halo](https://github.com/halo) who did a great contribution by handing over the `train` gem name.
-
-## Contributing
-
-1. Fork it
-1. Create your feature branch (git checkout -b my-new-feature)
-1. Commit your changes (git commit -am 'Add some feature')
-1. Push to the branch (git push origin my-new-feature)
-1. Create new Pull Request
-
-## License
-
-| **Author:**          | Dominik Richter (<drichter@chef.io>)
-
-| **Author:**          | Christoph Hartmann (<chartmann@chef.io>)
-
-| **Copyright:**       | Copyright (c) 2015-2018 Chef Software Inc.
-
-| **Copyright:**       | Copyright (c) 2015 Vulcano Security GmbH.
-
-| **License:**         | Apache License, Version 2.0
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License. 

data/Rakefile

@@ -1,73 +0,0 @@
-#!/usr/bin/env rake
-# encoding: utf-8
-
-require 'bundler'
-require 'bundler/gem_helper'
-require 'rake/testtask'
-require 'rubocop/rake_task'
-
-Bundler::GemHelper.install_tasks name: 'train'
-
-# Rubocop
-desc 'Run Rubocop lint checks'
-task :rubocop do
-  RuboCop::RakeTask.new
-end
-
-# lint the project
-desc 'Run robocop linter'
-task lint: [:rubocop]
-
-# run tests
-task default: [:test, :lint]
-
-Rake::TestTask.new do |t|
-  t.libs << 'test/unit'
-  t.pattern = 'test/unit/**/*_test.rb'
-  t.warning = true
-  t.verbose = true
-  t.ruby_opts = ['--dev'] if defined?(JRUBY_VERSION)
-end
-
-namespace :test do
-  task :docker do
-    path = File.join(File.dirname(__FILE__), 'test', 'integration')
-    sh('sh', '-c', "cd #{path} && ruby -I ../../lib docker_test.rb tests/*")
-  end
-
-  task :windows do
-    Dir.glob('test/windows/*_test.rb').all? do |file|
-      sh(Gem.ruby, '-w', '-I .\test\windows', file)
-    end or fail 'Failures'
-  end
-
-  task :vm do
-    concurrency = ENV['CONCURRENCY'] || 4
-    path = File.join(File.dirname(__FILE__), 'test', 'integration')
-    sh('sh', '-c', "cd #{path} && kitchen test -c #{concurrency}")
-  end
-
-  # Target required:
-  #   rake "test:ssh[user@server]"
-  #   sh -c cd /home/foobarbam/src/gems/train/test/integration \
-  #     && target=user@server ruby -I ../../lib test_ssh.rb tests/*
-  #   ...
-  # Turn debug logging back on:
-  #   debug=1 rake "test:ssh[user@server]"
-  # Use a different ssh key:
-  #   key_files=/home/foobarbam/.ssh/id_rsa2 rake "test:ssh[user@server]"
-  # Run with a specific test:
-  #   test=path_block_device_test.rb rake "test:ssh[user@server]"
-  task :ssh, [:target] do |t, args|
-    path = File.join(File.dirname(__FILE__), 'test', 'integration')
-    key_files = ENV['key_files'] || File.join(ENV['HOME'], '.ssh', 'id_rsa')
-
-    sh_cmd    =  "cd #{path} && target=#{args[:target]} key_files=#{key_files}"
-
-    sh_cmd += " debug=#{ENV['debug']}" if ENV['debug']
-    sh_cmd += ' ruby -I ../../lib test_ssh.rb tests/'
-    sh_cmd += ENV['test'] || '*'
-
-    sh('sh', '-c', sh_cmd)
-  end
-end

data/test/fixtures/plugins/train-test-fixture/LICENSE

@@ -1,201 +0,0 @@
-                              Apache License
-                        Version 2.0, January 2004
-                     http://www.apache.org/licenses/
-
-TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-1. Definitions.
-
-   "License" shall mean the terms and conditions for use, reproduction,
-   and distribution as defined by Sections 1 through 9 of this document.
-
-   "Licensor" shall mean the copyright owner or entity authorized by
-   the copyright owner that is granting the License.
-
-   "Legal Entity" shall mean the union of the acting entity and all
-   other entities that control, are controlled by, or are under common
-   control with that entity. For the purposes of this definition,
-   "control" means (i) the power, direct or indirect, to cause the
-   direction or management of such entity, whether by contract or
-   otherwise, or (ii) ownership of fifty percent (50%) or more of the
-   outstanding shares, or (iii) beneficial ownership of such entity.
-
-   "You" (or "Your") shall mean an individual or Legal Entity
-   exercising permissions granted by this License.
-
-   "Source" form shall mean the preferred form for making modifications,
-   including but not limited to software source code, documentation
-   source, and configuration files.
-
-   "Object" form shall mean any form resulting from mechanical
-   transformation or translation of a Source form, including but
-   not limited to compiled object code, generated documentation,
-   and conversions to other media types.
-
-   "Work" shall mean the work of authorship, whether in Source or
-   Object form, made available under the License, as indicated by a
-   copyright notice that is included in or attached to the work
-   (an example is provided in the Appendix below).
-
-   "Derivative Works" shall mean any work, whether in Source or Object
-   form, that is based on (or derived from) the Work and for which the
-   editorial revisions, annotations, elaborations, or other modifications
-   represent, as a whole, an original work of authorship. For the purposes
-   of this License, Derivative Works shall not include works that remain
-   separable from, or merely link (or bind by name) to the interfaces of,
-   the Work and Derivative Works thereof.
-
-   "Contribution" shall mean any work of authorship, including
-   the original version of the Work and any modifications or additions
-   to that Work or Derivative Works thereof, that is intentionally
-   submitted to Licensor for inclusion in the Work by the copyright owner
-   or by an individual or Legal Entity authorized to submit on behalf of
-   the copyright owner. For the purposes of this definition, "submitted"
-   means any form of electronic, verbal, or written communication sent
-   to the Licensor or its representatives, including but not limited to
-   communication on electronic mailing lists, source code control systems,
-   and issue tracking systems that are managed by, or on behalf of, the
-   Licensor for the purpose of discussing and improving the Work, but
-   excluding communication that is conspicuously marked or otherwise
-   designated in writing by the copyright owner as "Not a Contribution."
-
-   "Contributor" shall mean Licensor and any individual or Legal Entity
-   on behalf of whom a Contribution has been received by Licensor and
-   subsequently incorporated within the Work.
-
-2. Grant of Copyright License. Subject to the terms and conditions of
-   this License, each Contributor hereby grants to You a perpetual,
-   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-   copyright license to reproduce, prepare Derivative Works of,
-   publicly display, publicly perform, sublicense, and distribute the
-   Work and such Derivative Works in Source or Object form.
-
-3. Grant of Patent License. Subject to the terms and conditions of
-   this License, each Contributor hereby grants to You a perpetual,
-   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-   (except as stated in this section) patent license to make, have made,
-   use, offer to sell, sell, import, and otherwise transfer the Work,
-   where such license applies only to those patent claims licensable
-   by such Contributor that are necessarily infringed by their
-   Contribution(s) alone or by combination of their Contribution(s)
-   with the Work to which such Contribution(s) was submitted. If You
-   institute patent litigation against any entity (including a
-   cross-claim or counterclaim in a lawsuit) alleging that the Work
-   or a Contribution incorporated within the Work constitutes direct
-   or contributory patent infringement, then any patent licenses
-   granted to You under this License for that Work shall terminate
-   as of the date such litigation is filed.
-
-4. Redistribution. You may reproduce and distribute copies of the
-   Work or Derivative Works thereof in any medium, with or without
-   modifications, and in Source or Object form, provided that You
-   meet the following conditions:
-
-   (a) You must give any other recipients of the Work or
-       Derivative Works a copy of this License; and
-
-   (b) You must cause any modified files to carry prominent notices
-       stating that You changed the files; and
-
-   (c) You must retain, in the Source form of any Derivative Works
-       that You distribute, all copyright, patent, trademark, and
-       attribution notices from the Source form of the Work,
-       excluding those notices that do not pertain to any part of
-       the Derivative Works; and
-
-   (d) If the Work includes a "NOTICE" text file as part of its
-       distribution, then any Derivative Works that You distribute must
-       include a readable copy of the attribution notices contained
-       within such NOTICE file, excluding those notices that do not
-       pertain to any part of the Derivative Works, in at least one
-       of the following places: within a NOTICE text file distributed
-       as part of the Derivative Works; within the Source form or
-       documentation, if provided along with the Derivative Works; or,
-       within a display generated by the Derivative Works, if and
-       wherever such third-party notices normally appear. The contents
-       of the NOTICE file are for informational purposes only and
-       do not modify the License. You may add Your own attribution
-       notices within Derivative Works that You distribute, alongside
-       or as an addendum to the NOTICE text from the Work, provided
-       that such additional attribution notices cannot be construed
-       as modifying the License.
-
-   You may add Your own copyright statement to Your modifications and
-   may provide additional or different license terms and conditions
-   for use, reproduction, or distribution of Your modifications, or
-   for any such Derivative Works as a whole, provided Your use,
-   reproduction, and distribution of the Work otherwise complies with
-   the conditions stated in this License.
-
-5. Submission of Contributions. Unless You explicitly state otherwise,
-   any Contribution intentionally submitted for inclusion in the Work
-   by You to the Licensor shall be under the terms and conditions of
-   this License, without any additional terms or conditions.
-   Notwithstanding the above, nothing herein shall supersede or modify
-   the terms of any separate license agreement you may have executed
-   with Licensor regarding such Contributions.
-
-6. Trademarks. This License does not grant permission to use the trade
-   names, trademarks, service marks, or product names of the Licensor,
-   except as required for reasonable and customary use in describing the
-   origin of the Work and reproducing the content of the NOTICE file.
-
-7. Disclaimer of Warranty. Unless required by applicable law or
-   agreed to in writing, Licensor provides the Work (and each
-   Contributor provides its Contributions) on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-   implied, including, without limitation, any warranties or conditions
-   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-   PARTICULAR PURPOSE. You are solely responsible for determining the
-   appropriateness of using or redistributing the Work and assume any
-   risks associated with Your exercise of permissions under this License.
-
-8. Limitation of Liability. In no event and under no legal theory,
-   whether in tort (including negligence), contract, or otherwise,
-   unless required by applicable law (such as deliberate and grossly
-   negligent acts) or agreed to in writing, shall any Contributor be
-   liable to You for damages, including any direct, indirect, special,
-   incidental, or consequential damages of any character arising as a
-   result of this License or out of the use or inability to use the
-   Work (including but not limited to damages for loss of goodwill,
-   work stoppage, computer failure or malfunction, or any and all
-   other commercial damages or losses), even if such Contributor
-   has been advised of the possibility of such damages.
-
-9. Accepting Warranty or Additional Liability. While redistributing
-   the Work or Derivative Works thereof, You may choose to offer,
-   and charge a fee for, acceptance of support, warranty, indemnity,
-   or other liability obligations and/or rights consistent with this
-   License. However, in accepting such obligations, You may act only
-   on Your own behalf and on Your sole responsibility, not on behalf
-   of any other Contributor, and only if You agree to indemnify,
-   defend, and hold each Contributor harmless for any liability
-   incurred by, or claims asserted against, such Contributor by reason
-   of your accepting any such warranty or additional liability.
-
-END OF TERMS AND CONDITIONS
-
-APPENDIX: How to apply the Apache License to your work.
-
-   To apply the Apache License to your work, attach the following
-   boilerplate notice, with the fields enclosed by brackets "[]"
-   replaced with your own identifying information. (Don't include
-   the brackets!)  The text should be enclosed in the appropriate
-   comment syntax for the file format. We also recommend that a
-   file or class name and description of purpose be included on the
-   same "printed page" as the copyright notice for easier
-   identification within third-party archives.
-
-Copyright [yyyy] [name of copyright owner]
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.

data/test/fixtures/plugins/train-test-fixture/README.md

@@ -1,5 +0,0 @@
-This is a very simple train transport plugin. It provided fixed responses to file.content and command.stdout/stderr/exit_status.
-
-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.
-
-For good examples of plugin development, see train/examples/plugin.

data/test/fixtures/plugins/train-test-fixture/lib/train-test-fixture/connection.rb

@@ -1,35 +0,0 @@
-require 'train-test-fixture/platform'
-require 'train/transports/local'
-
-module TrainPlugins
-  module TestFixture
-    class Connection < Train::Plugins::Transport::BaseConnection
-      include TrainPlugins::TestFixture::Platform
-
-      def initialize(options)
-        super(options)
-      end
-
-      private
-
-      def run_command_via_connection(cmd)
-        Train::Transports::Local::CommandResult.new(
-          'Mock Command Result stdout',
-          'Mock Command Result stderr',
-          17
-        )
-      end
-
-      def file_via_connection(path, *args)
-        MockFile.new(self, path)
-      end
-
-      class MockFile < Train::File
-        def content
-          # Remarkably, the content is always the same.
-          'Lorem Ipsum'
-        end
-      end
-    end
-  end
-end

data/test/fixtures/plugins/train-test-fixture/lib/train-test-fixture/platform.rb

@@ -1,18 +0,0 @@
-require 'train-test-fixture/version'
-
-module TrainPlugins
-  module TestFixture
-    module Platform
-      def platform
-        # Build this platform's family declarations.
-        # You'll need at least unix and windows to make the file() resource work.
-        Train::Platforms.name('test-fixture').in_family('unix')
-        Train::Platforms.name('test-fixture').in_family('windows')
-        force_platform!('test-fixture',
-          release: TrainPlugins::TestFixture::VERSION,
-          arch: 'mock',
-        )
-      end
-    end
-  end
-end

data/test/fixtures/plugins/train-test-fixture/lib/train-test-fixture/transport.rb

@@ -1,14 +0,0 @@
-require 'train-test-fixture/connection'
-
-module TrainPlugins
-  module TestFixture
-    class Transport < Train.plugin(1)
-      name 'test-fixture'
-
-      def connection(_ = nil)
-        @connection ||= TrainPlugins::TestFixture::Connection.new(@options)
-      end
-
-    end
-  end
-end

data/test/fixtures/plugins/train-test-fixture/lib/train-test-fixture/version.rb

@@ -1,5 +0,0 @@
-module TrainPlugins
-  module TestFixture
-    VERSION = '0.1.0'
-  end
-end

data/test/fixtures/plugins/train-test-fixture/lib/train-test-fixture.rb

@@ -1,4 +0,0 @@
-lib = File.expand_path("../../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-
-require 'train-test-fixture/transport'

data/test/fixtures/plugins/train-test-fixture/train-test-fixture.gemspec

@@ -1,35 +0,0 @@
-
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-
-Gem::Specification.new do |spec|
-  spec.name          = "train-test-fixture"
-  spec.version       = '0.1.0'
-  spec.authors       = ["Inspec core engineering team"]
-  spec.email         = ["hello@chef.io"]
-  spec.license       = 'Apache-2.0'
-
-  spec.summary       = %q{Test train plugin. Not intended for use as an example.}
-  spec.description   = <<-EOD
-    Train plugin used in testing Train's plugin loader and InSpec's plugin manager.
-    This plugin does things that a normal plugin should not.  Do not use it as an
-    example or as a starting point for plugin of your own.  For that, please see
-    https://github.com/inspec/train/tree/master/examples/plugins
-  EOD
-  spec.homepage      = "https://github.com/inspec/train"
-
-  spec.files         = %w{
-    README.md
-    LICENSE
-    lib/train-test-fixture.rb
-    lib/train-test-fixture/version.rb
-    lib/train-test-fixture/transport.rb
-    lib/train-test-fixture/connection.rb
-    lib/train-test-fixture/platform.rb
-    train-test-fixture.gemspec
-  }
-  spec.executables   = []
-  spec.require_paths = ["lib"]
-
-  # No deps
-end