Sha256: c17c954b2f67a14dde2edbf895aefd283183a9cf21efe12243d8c7eb9c389bbd

Contents?: true

Size: 1.92 KB

Versions: 28

Compression:

Stored size: 1.92 KB

Contents

# -*- encoding: utf-8 -*-
#
# Author:: Fletcher Nichol (<fnichol@nichol.ca>)
#
# Copyright (C) 2012, Fletcher Nichol
#
# 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 driver is responsible for carrying out the lifecycle activities of an
  # instance, such as creating and destroying an instance.
  #
  # @author Fletcher Nichol <fnichol@nichol.ca>
  module Driver

    # Default driver plugin to use
    DEFAULT_PLUGIN = "dummy".freeze

    # Returns an instance of a driver given a plugin type string.
    #
    # @param plugin [String] a driver plugin type, which will be constantized
    # @param config [Hash] a configuration hash to initialize the driver
    # @return [Driver::Base] a driver instance
    # @raise [ClientError] if a driver instance could not be created
    # @raise [UserError] if the driver's dependencies could not be met
    def self.for_plugin(plugin, config)
      first_load = require("kitchen/driver/#{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 UserError
      raise
    rescue LoadError, NameError
      raise ClientError,
        "Could not load the '#{plugin}' driver from the load path." \
          " Please ensure that your driver is installed as a gem or included" \
          " in your Gemfile if using Bundler."
    end
  end
end

Version data entries

28 entries across 28 versions & 1 rubygems

Version Path
test-kitchen-1.14.1 lib/kitchen/driver.rb
test-kitchen-1.14.0 lib/kitchen/driver.rb
test-kitchen-1.13.2 lib/kitchen/driver.rb
test-kitchen-1.13.1 lib/kitchen/driver.rb
test-kitchen-1.13.0 lib/kitchen/driver.rb
test-kitchen-1.12.0 lib/kitchen/driver.rb
test-kitchen-1.11.1 lib/kitchen/driver.rb
test-kitchen-1.11.0 lib/kitchen/driver.rb
test-kitchen-1.10.2 lib/kitchen/driver.rb
test-kitchen-1.10.2.dev lib/kitchen/driver.rb
test-kitchen-1.10.0 lib/kitchen/driver.rb
test-kitchen-1.9.2 lib/kitchen/driver.rb
test-kitchen-1.9.1 lib/kitchen/driver.rb
test-kitchen-1.9.0 lib/kitchen/driver.rb
test-kitchen-1.8.0 lib/kitchen/driver.rb
test-kitchen-1.7.3 lib/kitchen/driver.rb
test-kitchen-1.7.2 lib/kitchen/driver.rb
test-kitchen-1.7.1 lib/kitchen/driver.rb
test-kitchen-1.7.1.dev lib/kitchen/driver.rb
test-kitchen-1.6.0 lib/kitchen/driver.rb