Sha256: 82aa20ffe5d388ba5713317a677a847206c4499215b99882426ef55b9aa3d9b1

Contents?: true

Size: 1.93 KB

Versions: 19

Compression:

Stored size: 1.93 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

19 entries across 19 versions & 1 rubygems

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