kitchen-transport-train 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 133f962428df05c64cdd391b97494d38e8e63bef96ef3ee4df43927f66809516
+  data.tar.gz: 9071b6c0b96470fc32638422f3c2658e7a5dfe63c387269fd176fbf5717d3f7f
+SHA512:
+  metadata.gz: 361d12c68100e3ffc4ca93cba6d8ae1ea9cc4a56aa77c09ae85bd8708dbe7bc8a05dabc0edf3785aa553ea22379c27c38c8c37397adba60c22446882e0e558d1
+  data.tar.gz: 84f44ff085c7784525da0b3b2a46d54d5672aca6607190698141874c3c21b1e664ef7ab7f9e5152122687968041b96b6aeaf0329d31e78bfec47d7c9e6e03dc4

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## Version 0.1.0
+
+- Initial version

data/README.md

@@ -0,0 +1,53 @@
+# kitchen-transport-train
+
+## Summary
+
+Kitchen transport to use any Train backend, which makes Test Kitchen much more modular with regards to target machines.
+
+As Train OS Transports were inspired from Kitchen, they provide an almost identical API. This transport is basically an adapter to use Test Kitchen with all OS-style Train transports.
+
+In contrast to normal Kitchen transports, this does not support the `kitchen login` command as Train is inherently non-interactive. An error will be displayed if you try to use this command.
+
+## Examples
+
+Legacy configurations for easy SSH/WinRM connections are supported. This transport will automaticially detect Unix (`ssh` backend) and Windows (`winrm` backend) systems.
+
+```yaml
+---
+transport:
+  name: train
+  backend: ssh # optional
+  ssh_key: ~/.ssh/testkitchen
+```
+
+```yaml
+---
+transport:
+  name: train
+  backend: winrm # optional
+```
+
+Train-oriented configuration can optionally specify the `backend` transport and then add the transport-specific configuration values:
+
+```yaml
+---
+transport:
+  name: train
+  backend: ssh
+
+  # Use the selected Train transport options here 1:1
+  key_files: '...'
+  compression: true
+  ...
+```
+
+## Link to Train transport options
+
+Options `user`, `host` and `password` (for kitchen-ec2 and Windows instances) are set automatically.
+
+- [AWS Session Manager Transport](https://github.com/tecracer-chef/train-awsssm/blob/master/lib/train-awsssm/transport.rb#L8-L14)
+- Docker Transport: no additional options
+- [Serial/USB Transport](https://github.com/tecracer-chef/train-serial/blob/master/lib/train-serial/transport.rb#L8-L22)
+- [SSH Transport](https://github.com/inspec/train/blob/0b9fd4556745d767c9dac2a83d5323e6b7025872/lib/train/transports/ssh.rb#L45-L74)
+- [Telnet Transport](https://github.com/tecracer-chef/train-telnet/blob/master/lib/train-telnet/transport.rb#L8-L20)
+- [WinRM Transport](https://github.com/inspec/train-winrm/blob/980190e44571787c7b60614257bd6dc2bd8a337d/lib/train-winrm/transport.rb#L52-L76)

data/lib/kitchen-transport-train/version.rb

@@ -0,0 +1,3 @@
+module KitchenTransportTrain
+  VERSION = "0.1.0".freeze
+end

data/lib/kitchen/transport/train.rb

@@ -0,0 +1,103 @@
+require_relative "../../kitchen-transport-train/version"
+
+require "forwardable" unless defined?(Forwardable)
+require "kitchen/errors" unless defined?(Kitchen::UserError)
+require "kitchen/transport/base" unless defined?(Kitchen::Transport::Base)
+require "train" unless defined?(Train)
+
+module Kitchen
+  module Transport
+    class ConnectionFailed < TransportFailed; end
+
+    class Train < Kitchen::Transport::Base
+
+      kitchen_transport_api_version 1
+
+      plugin_version KitchenTransportTrain::VERSION
+
+      def connection(state, &block)
+        options = connection_options(config.to_hash.merge(state))
+        options = adjust_options(options)
+
+        Kitchen::Transport::Train::Connection.new(options, &block)
+      end
+
+      class Connection < Kitchen::Transport::Base::Connection
+        # Forward everything to the Train connection, where adapters are not needed
+        extend Forwardable
+        def_delegators :@connection, :close, :upload, :download, :wait_until_ready
+
+        attr_reader :logger
+
+        def initialize(options = {})
+          @options = options
+          @logger = Kitchen.logger
+
+          @backend = ::Train.create(options[:backend], options)
+          @connection = @backend.connection
+
+          yield self if block_given?
+        end
+
+        def execute(command)
+          return if command.nil?
+
+          logger.debug("[Train/#{options[:backend]}] Execute (#{command})")
+
+          command_result = @connection.run_command(command)
+
+          if command_result.exit_status == 0
+            logger.info(command_result.stdout)
+          else
+            logger.error(command_result.stderr)
+
+            raise Transport::ConnectionFailed.new(
+              "Train/#{options[:backend]} exited (#{command_result.exit_status}) for command: [#{command}]",
+              command_result.exit_status
+            )
+          end
+        end
+
+        def login_command
+          raise ::Kitchen::UserError, "Interactive shells are not possible with the Train transport"
+        end
+      end
+
+      private
+
+      # Builds the hash of options needed by the Connection object on construction.
+      #
+      # @param data [Hash] merged configuration and mutable state data
+      # @return [Hash] hash of connection options
+      # @api private
+      def connection_options(data)
+        # `windows_os?` comes from Kitchen::Configurable, which is included in the Kitchen base transport
+        defaults = {
+          backend: windows_os? ? "winrm" : "ssh",
+        }
+
+        overrides = {
+          instance_name: instance.name,
+          kitchen_root: Dir.pwd,
+
+          # Kitchen to Train parameter conversion
+          host: data[:hostname],
+          user: data[:username],
+        }
+
+        defaults.merge(data).merge(overrides)
+      end
+
+      # Map Kitchen parameters to their Train equivalents for compatibility.
+      def adjust_options(data)
+        if data[:backend] == "ssh"
+          data[:key_files] = data[:ssh_key]
+          data.delete(:ssh_key)
+        end
+
+        data
+      end
+    end
+  end
+end
+

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: kitchen-transport-train
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Thomas Heinen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: train
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.5'
+description: Use the Train transport ecosystem for all your Kitchen needs
+email:
+- theinen@tecracer.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- README.md
+- lib/kitchen-transport-train/version.rb
+- lib/kitchen/transport/train.rb
+homepage: https://github.com/tecracer-chef/kitchen-transport-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: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Kitchen transport for any Train backend
+test_files: []