train-core 1.4.4

data/Gemfile

@@ -0,0 +1,36 @@
+# 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'
+  gem 'rack', '< 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'
+end
+
+group :integration do
+  gem 'berkshelf', '~> 4.3'
+  gem 'test-kitchen', '~> 1.11'
+  gem 'kitchen-vagrant'
+end
+
+group :tools do
+  gem 'pry', '~> 0.10'
+  gem 'rb-readline'
+  gem 'license_finder'
+  gem 'github_changelog_generator', '~> 1'
+end

data/LICENSE

@@ -0,0 +1,201 @@
+                              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/README.md

@@ -0,0 +1,197 @@
+# Train - Transport Interface
+
+[![Build Status](https://travis-ci.org/chef/train.svg?branch=master)](https://travis-ci.org/chef/train)
+[![Build Status Master](https://ci.appveyor.com/api/projects/status/github/chef/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
+
+# 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')
+```
+
+## 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 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/lib/train.rb

@@ -0,0 +1,158 @@
+# encoding: utf-8
+#
+# Author:: Dominik Richter (<dominik.richter@gmail.com>)
+
+require 'train/version'
+require 'train/options'
+require 'train/plugins'
+require 'train/errors'
+require 'train/platforms'
+require 'uri'
+
+module Train
+  # Create a new transport instance, with the plugin indicated by the
+  # given name.
+  #
+  # @param [String] name of the plugin
+  # @param [Array] *args list of arguments for the plugin
+  # @return [Transport] instance of the new transport or nil
+  def self.create(name, *args)
+    cls = load_transport(name)
+    cls.new(*args) unless cls.nil?
+  end
+
+  # Retrieve the configuration options of a transport plugin.
+  #
+  # @param [String] name of the plugin
+  # @return [Hash] map of default options
+  def self.options(name)
+    cls = load_transport(name)
+    cls.default_options unless cls.nil?
+  end
+
+  # Load the transport plugin indicated by name. If the plugin is not
+  # yet found in the plugin registry, it will be attempted to load from
+  # `train/transports/plugin_name`.
+  #
+  # @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]
+  rescue LoadError => _
+    raise Train::UserError,
+          "Can't find train plugin #{name.inspect}. Please install it first."
+  end
+
+  # Resolve target configuration in URI-scheme into
+  # all respective fields and merge with existing configuration.
+  # e.g. ssh://bob@remote  =>  backend: ssh, user: bob, host: remote
+  def self.target_config(config = nil) # rubocop:disable Metrics/AbcSize
+    conf = config.nil? ? {} : config.dup
+    conf = symbolize_keys(conf)
+
+    group_keys_and_keyfiles(conf)
+
+    return conf if conf[:target].to_s.empty?
+
+    # split up the target's host/scheme configuration
+    uri = parse_uri(conf[:target].to_s)
+    unless uri.host.nil? and uri.scheme.nil?
+      conf[:backend]  ||= uri.scheme
+      conf[:host]     ||= uri.hostname
+      conf[:port]     ||= uri.port
+      conf[:user]     ||= uri.user
+      conf[:password] ||= uri.password
+      conf[:path]     ||= uri.path
+    end
+
+    # ensure path is nil, if its empty; e.g. required to reset defaults for winrm
+    conf[:path] = nil if !conf[:path].nil? && conf[:path].to_s.empty?
+
+    # return the updated config
+    conf
+  end
+
+  # Takes a map of key-value pairs and turns all keys into symbols. For this
+  # to work, only keys are supported that can be turned into symbols.
+  # Example: { 'a' => 123 }  ==>  { a: 123 }
+  #
+  # @param map [Hash]
+  # @return [Hash] new map with all keys being symbols
+  def self.symbolize_keys(map)
+    map.each_with_object({}) do |(k, v), acc|
+      acc[k.to_sym] = v
+      acc
+    end
+  end
+  private_class_method :symbolize_keys
+
+  # Parse a URI. Supports empty URI's with paths, e.g. `mock://`
+  #
+  # @param string [string] URI string, e.g. `schema://domain.com`
+  # @return [URI::Generic] parsed URI object
+  def self.parse_uri(string)
+    URI.parse(string)
+  rescue URI::InvalidURIError => e
+    # A use-case we want to catch is parsing empty URIs with a schema
+    # e.g. mock://. To do this, we match it manually and fake the hostname
+    case string
+    when %r{^([a-z]+)://$}
+      string += 'dummy'
+    when /^([a-z]+):$/
+      string += '//dummy'
+    else
+      raise Train::UserError, e
+    end
+
+    u = URI.parse(string)
+    u.host = nil
+    u
+  end
+  private_class_method :parse_uri
+
+  def self.validate_backend(conf, default = :local)
+    return default if conf.nil?
+    res = conf[:backend]
+
+    if (res.nil? || res == 'localhost') && conf[:sudo]
+      fail Train::UserError, 'Sudo is only valid when running against a remote host. '\
+        'To run this locally with elevated privileges, run the command with `sudo ...`.'
+    end
+
+    return res if !res.nil?
+
+    if !conf[:target].nil?
+      fail Train::UserError, 'Cannot determine backend from target '\
+           "configuration #{conf[:target].inspect}. Valid example: ssh://192.168.0.1."
+    end
+
+    if !conf[:host].nil?
+      fail Train::UserError, 'Host configured, but no backend was provided. Please '\
+           'specify how you want to connect. Valid example: ssh://192.168.0.1.'
+    end
+
+    conf[:backend] = default
+  end
+
+  def self.group_keys_and_keyfiles(conf)
+    # in case the user specified a key-file, register it that way
+    # we will clear the list of keys and put keys and key_files separately
+    keys_mixed = conf[:keys]
+    return if keys_mixed.nil?
+
+    conf[:key_files] = []
+    conf[:keys] = []
+    keys_mixed.each do |key|
+      if !key.nil? and File.file?(key)
+        conf[:key_files].push(key)
+      else
+        conf[:keys].push(key)
+      end
+    end
+  end
+end