Sha256: c5ff716ec828e7474695c9f88b7622f19dd2a49b447312800766c7c239940430

Contents?: true

Size: 1.86 KB

Versions: 19

Compression:

Stored size: 1.86 KB

Contents

# -*- encoding: utf-8 -*-
#
# Author:: Salim Afiune (<salim@afiunemaya.com.mx>)
#
# Copyright (C) 2014, Salim Afiune
#
# 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.

require "thor/util"

module Kitchen
  # A transport is responsible for the communication with an instance,
  # that is remote comands and other actions such as file transfer,
  # login, etc.
  #
  # @author Salim Afiune <salim@afiunemaya.com.mx>
  module Transport
    # Default transport to use
    DEFAULT_PLUGIN = "ssh".freeze

    # Returns an instance of a transport given a plugin type string.
    #
    # @param plugin [String] a transport plugin type, to be constantized
    # @param config [Hash] a configuration hash to initialize the transport
    # @return [Transport::Base] a transport instance
    # @raise [ClientError] if a transport instance could not be created
    def self.for_plugin(plugin, config)
      first_load = require("kitchen/transport/#{plugin}")

      str_const = Thor::Util.camel_case(plugin)
      klass = const_get(str_const)
      object = klass.new(config)
      object.verify_dependencies if first_load
      object
    rescue LoadError, NameError
      raise ClientError,
            "Could not load the '#{plugin}' transport from the load path." \
              " Please ensure that your transport is installed as a gem or" \
              " included in your Gemfile if using Bundler."
    end
  end
end

Version data entries

19 entries across 19 versions & 1 rubygems

Version Path
test-kitchen-1.23.5 lib/kitchen/transport.rb
test-kitchen-1.23.4 lib/kitchen/transport.rb
test-kitchen-1.23.3 lib/kitchen/transport.rb
test-kitchen-1.23.2 lib/kitchen/transport.rb
test-kitchen-1.22.1 lib/kitchen/transport.rb
test-kitchen-1.23.0 lib/kitchen/transport.rb
test-kitchen-1.22.0 lib/kitchen/transport.rb
test-kitchen-1.21.2 lib/kitchen/transport.rb
test-kitchen-1.21.1 lib/kitchen/transport.rb
test-kitchen-1.21.0 lib/kitchen/transport.rb
test-kitchen-1.20.0 lib/kitchen/transport.rb
test-kitchen-1.19.2 lib/kitchen/transport.rb
test-kitchen-1.19.1 lib/kitchen/transport.rb
test-kitchen-1.19.0 lib/kitchen/transport.rb
test-kitchen-1.18.0 lib/kitchen/transport.rb
test-kitchen-1.17.0 lib/kitchen/transport.rb
test-kitchen-1.16.0 lib/kitchen/transport.rb
test-kitchen-1.15.0 lib/kitchen/transport.rb
test-kitchen-1.14.2 lib/kitchen/transport.rb