Class: Kitchen::Platform

Inherits:

Object

• Object
• Kitchen::Platform

Defined in:

lib/kitchen/platform.rb

Overview

A target operating system environment in which convergence integration will take place. This may represent a specific operating system, version, and machine architecture.

Author:

• Fletcher Nichol fnichol@nichol.ca

Instance Attribute Summary

• #name ⇒ String readonly

  Logical name of this platform.

Instance Method Summary

• #initialize(options = {}) ⇒ Platform constructor

  Constructs a new platform.

Constructor Details

#initialize(options = {}) ⇒ Platform

Constructs a new platform.

Parameters:

• options (Hash) (defaults to: {}) —

  configuration for a new platform

Options Hash (options):

• :name (String) —

  logical name of this platform (Required)

# File 'lib/kitchen/platform.rb', line 36

def initialize(options = {})
  @name = options.fetch(:name) do
    raise ClientError, "Platform#new requires option :name"
  end
end

Instance Attribute Details

#name ⇒ String (readonly)

Returns logical name of this platform.

Returns:

• (String) —

  logical name of this platform

# File 'lib/kitchen/platform.rb', line 29

def name
  @name
end