Class: Chef::Platform

Inherits:

Object

• Object
• Chef::Platform

Extended by:

Mixin::ParamsValidate

Defined in:

lib/chef/platform.rb,
lib/chef/platform/rebooter.rb,
lib/chef/platform/query_helpers.rb,
lib/chef/platform/service_helpers.rb,
lib/chef/platform/provider_mapping.rb,
lib/chef/platform/provider_priority_map.rb

Defined Under Namespace

Modules: Rebooter Classes: ProviderPriorityMap, ServiceHelpers

Class Attribute Summary

• .platforms ⇒ Object

Class Method Summary

• .find(name, version) ⇒ Object
• .find_platform_and_version(node) ⇒ Object
• .find_provider(platform, version, resource_type) ⇒ Object
• .find_provider_for_node(node, resource_type) ⇒ Object
• .provider_for_node(node, resource_type) ⇒ Object
• .provider_for_resource(resource, action = :nothing) ⇒ Object
• .set(args) ⇒ Object
• .supports_dsc?(node) ⇒ Boolean
• .windows? ⇒ Boolean
• .windows_server_2003? ⇒ Boolean

Methods included from Mixin::ParamsValidate

lazy, set_or_return, validate

Class Attribute Details

.platforms ⇒ Object

# File 'lib/chef/platform/provider_mapping.rb', line 36

def platforms
  @platforms ||= begin
    require 'chef/providers'

    {
      :mac_os_x => {
        :default => {
          :package => Chef::Provider::Package::Homebrew,
          :user => Chef::Provider::User::Dscl,
          :group => Chef::Provider::Group::Dscl
        }
      },
      :mac_os_x_server => {
        :default => {
          :package => Chef::Provider::Package::Homebrew,
          :user => Chef::Provider::User::Dscl,
          :group => Chef::Provider::Group::Dscl
        }
      },
      :freebsd => {
        :default => {
          :group   => Chef::Provider::Group::Pw,
          :user    => Chef::Provider::User::Pw,
          :cron    => Chef::Provider::Cron
        }
      },
      :ubuntu   => {
        :default => {
          :package => Chef::Provider::Package::Apt,
          :service => Chef::Provider::Service::Debian,
          :cron => Chef::Provider::Cron,
          :mdadm => Chef::Provider::Mdadm
        },
        ">= 11.10" => {
          :ifconfig => Chef::Provider::Ifconfig::Debian
        }
        # Chef::Provider::Service::Upstart is a candidate to be used in
        # ubuntu versions >= 13.10 but it currently requires all the
        # services to have an entry under /etc/init. We need to update it
        # to use the service ctl apis in order to migrate to using it on
        # ubuntu >= 13.10.
      },
      :gcel   => {
        :default => {
          :package => Chef::Provider::Package::Apt,
          :service => Chef::Provider::Service::Debian,
          :cron => Chef::Provider::Cron,
          :mdadm => Chef::Provider::Mdadm
        }
      },
      :linaro   => {
        :default => {
          :package => Chef::Provider::Package::Apt,
          :service => Chef::Provider::Service::Debian,
          :cron => Chef::Provider::Cron,
          :mdadm => Chef::Provider::Mdadm
        }
      },
      :raspbian   => {
        :default => {
          :package => Chef::Provider::Package::Apt,
          :service => Chef::Provider::Service::Debian,
          :cron => Chef::Provider::Cron,
          :mdadm => Chef::Provider::Mdadm
        }
      },
      :linuxmint   => {
        :default => {
          :package => Chef::Provider::Package::Apt,
          :service => Chef::Provider::Service::Upstart,
          :cron => Chef::Provider::Cron,
          :mdadm => Chef::Provider::Mdadm
        }
      },
      :debian => {
        :default => {
          :package => Chef::Provider::Package::Apt,
          :service => Chef::Provider::Service::Debian,
          :cron => Chef::Provider::Cron,
          :mdadm => Chef::Provider::Mdadm
        },
        ">= 6.0" => {
          :service => Chef::Provider::Service::Insserv
        },
        ">= 7.0" => {
          :ifconfig => Chef::Provider::Ifconfig::Debian
        }
      },
      :xenserver   => {
        :default => {
          :service => Chef::Provider::Service::Redhat,
          :cron => Chef::Provider::Cron,
          :package => Chef::Provider::Package::Yum,
          :mdadm => Chef::Provider::Mdadm
        }
      },
      :xcp   => {
        :default => {
          :service => Chef::Provider::Service::Redhat,
          :cron => Chef::Provider::Cron,
          :package => Chef::Provider::Package::Yum,
          :mdadm => Chef::Provider::Mdadm
        }
      },
      :centos   => {
        :default => {
          :service => Chef::Provider::Service::Systemd,
          :cron => Chef::Provider::Cron,
          :package => Chef::Provider::Package::Yum,
          :mdadm => Chef::Provider::Mdadm,
          :ifconfig => Chef::Provider::Ifconfig::Redhat
        },
        "< 7" => {
          :service => Chef::Provider::Service::Redhat
        }
      },
      :amazon   => {
        :default => {
          :service => Chef::Provider::Service::Redhat,
          :cron => Chef::Provider::Cron,
          :package => Chef::Provider::Package::Yum,
          :mdadm => Chef::Provider::Mdadm
        }
      },
      :scientific => {
        :default => {
          :service => Chef::Provider::Service::Systemd,
          :cron => Chef::Provider::Cron,
          :package => Chef::Provider::Package::Yum,
          :mdadm => Chef::Provider::Mdadm
        },
        "< 7" => {
          :service => Chef::Provider::Service::Redhat
        }
      },
      :fedora   => {
        :default => {
          :service => Chef::Provider::Service::Systemd,
          :cron => Chef::Provider::Cron,
          :package => Chef::Provider::Package::Yum,
          :mdadm => Chef::Provider::Mdadm,
          :ifconfig => Chef::Provider::Ifconfig::Redhat
        },
        "< 15" => {
          :service => Chef::Provider::Service::Redhat
        }
      },
      :opensuse     => {
        :default => {
          :service => Chef::Provider::Service::Redhat,
          :cron => Chef::Provider::Cron,
          :package => Chef::Provider::Package::Zypper,
          :group => Chef::Provider::Group::Suse
        },
        # Only OpenSuSE 12.3+ should use the Usermod group provider:
        ">= 12.3" => {
          :group => Chef::Provider::Group::Usermod
        }
      },
      :suse     => {
        :default => {
          :service => Chef::Provider::Service::Systemd,
          :cron => Chef::Provider::Cron,
          :package => Chef::Provider::Package::Zypper,
          :group => Chef::Provider::Group::Gpasswd
        },
        "< 12.0" => {
          :group => Chef::Provider::Group::Suse,
          :service => Chef::Provider::Service::Redhat
        }
      },
      :oracle  => {
        :default => {
          :service => Chef::Provider::Service::Systemd,
          :cron => Chef::Provider::Cron,
          :package => Chef::Provider::Package::Yum,
          :mdadm => Chef::Provider::Mdadm
        },
        "< 7" => {
          :service => Chef::Provider::Service::Redhat
        }
      },
      :redhat   => {
        :default => {
          :service => Chef::Provider::Service::Systemd,
          :cron => Chef::Provider::Cron,
          :package => Chef::Provider::Package::Yum,
          :mdadm => Chef::Provider::Mdadm,
          :ifconfig => Chef::Provider::Ifconfig::Redhat
        },
        "< 7" => {
          :service => Chef::Provider::Service::Redhat
        }
      },
      :ibm_powerkvm   => {
        :default => {
          :service => Chef::Provider::Service::Redhat,
          :cron => Chef::Provider::Cron,
          :package => Chef::Provider::Package::Yum,
          :mdadm => Chef::Provider::Mdadm,
          :ifconfig => Chef::Provider::Ifconfig::Redhat
        }
      },
      :cloudlinux   => {
        :default => {
          :service => Chef::Provider::Service::Redhat,
          :cron => Chef::Provider::Cron,
          :package => Chef::Provider::Package::Yum,
          :mdadm => Chef::Provider::Mdadm,
          :ifconfig => Chef::Provider::Ifconfig::Redhat
        }
      },
      :parallels   => {
          :default => {
              :service => Chef::Provider::Service::Redhat,
              :cron => Chef::Provider::Cron,
              :package => Chef::Provider::Package::Yum,
              :mdadm => Chef::Provider::Mdadm,
              :ifconfig => Chef::Provider::Ifconfig::Redhat
          }
      },
      :gentoo   => {
        :default => {
          :package => Chef::Provider::Package::Portage,
          :service => Chef::Provider::Service::Gentoo,
          :cron => Chef::Provider::Cron,
          :mdadm => Chef::Provider::Mdadm
        }
      },
      :arch   => {
        :default => {
          :package => Chef::Provider::Package::Pacman,
          :service => Chef::Provider::Service::Systemd,
          :cron => Chef::Provider::Cron,
          :mdadm => Chef::Provider::Mdadm
        }
      },
      :mswin => {
        :default => {
          :env =>  Chef::Provider::Env::Windows,
          :user => Chef::Provider::User::Windows,
          :group => Chef::Provider::Group::Windows,
          :mount => Chef::Provider::Mount::Windows,
          :batch => Chef::Provider::Batch,
          :powershell_script => Chef::Provider::PowershellScript
        }
      },
      :mingw32 => {
        :default => {
          :env =>  Chef::Provider::Env::Windows,
          :user => Chef::Provider::User::Windows,
          :group => Chef::Provider::Group::Windows,
          :mount => Chef::Provider::Mount::Windows,
          :batch => Chef::Provider::Batch,
          :powershell_script => Chef::Provider::PowershellScript
        }
      },
      :windows => {
        :default => {
          :env =>  Chef::Provider::Env::Windows,
          :user => Chef::Provider::User::Windows,
          :group => Chef::Provider::Group::Windows,
          :mount => Chef::Provider::Mount::Windows,
          :batch => Chef::Provider::Batch,
          :powershell_script => Chef::Provider::PowershellScript
        }
      },
      :solaris  => {},
      :openindiana => {
        :default => {
          :mount => Chef::Provider::Mount::Solaris,
          :package => Chef::Provider::Package::Ips,
          :cron => Chef::Provider::Cron::Solaris,
          :group => Chef::Provider::Group::Usermod
        }
      },
      :opensolaris => {
        :default => {
          :mount => Chef::Provider::Mount::Solaris,
          :package => Chef::Provider::Package::Ips,
          :cron => Chef::Provider::Cron::Solaris,
          :group => Chef::Provider::Group::Usermod
        }
      },
      :nexentacore => {
        :default => {
          :mount => Chef::Provider::Mount::Solaris,
          :package => Chef::Provider::Package::Solaris,
          :cron => Chef::Provider::Cron::Solaris,
          :group => Chef::Provider::Group::Usermod
        }
      },
      :omnios => {
        :default => {
          :mount => Chef::Provider::Mount::Solaris,
          :package => Chef::Provider::Package::Ips,
          :cron => Chef::Provider::Cron::Solaris,
          :group => Chef::Provider::Group::Usermod,
          :user => Chef::Provider::User::Solaris,
        }
      },
      :solaris2 => {
        :default => {
          :mount => Chef::Provider::Mount::Solaris,
          :package => Chef::Provider::Package::Ips,
          :cron => Chef::Provider::Cron::Solaris,
          :group => Chef::Provider::Group::Usermod,
          :user => Chef::Provider::User::Solaris,
        },
        "< 5.11" => {
          :mount => Chef::Provider::Mount::Solaris,
          :package => Chef::Provider::Package::Solaris,
          :cron => Chef::Provider::Cron::Solaris,
          :group => Chef::Provider::Group::Usermod,
          :user => Chef::Provider::User::Solaris,
        }
      },
      :smartos => {
        :default => {
          :mount => Chef::Provider::Mount::Solaris,
          :package => Chef::Provider::Package::SmartOS,
          :cron => Chef::Provider::Cron::Solaris,
          :group => Chef::Provider::Group::Usermod
        }
      },
      :netbsd => {
        :default => {
          :group => Chef::Provider::Group::Groupmod
        }
      },
      :openbsd => {
        :default => {
          :group => Chef::Provider::Group::Usermod
        }
      },
      :hpux => {
        :default => {
          :group => Chef::Provider::Group::Usermod
        }
      },
      :aix => {
        :default => {
          :group => Chef::Provider::Group::Aix,
          :mount => Chef::Provider::Mount::Aix,
          :ifconfig => Chef::Provider::Ifconfig::Aix,
          :cron => Chef::Provider::Cron::Aix,
          :package => Chef::Provider::Package::Aix,
          :user => Chef::Provider::User::Aix,
          :service => Chef::Provider::Service::Aix
        }
      },
      :exherbo => {
        :default => {
          :package => Chef::Provider::Package::Paludis,
          :service => Chef::Provider::Service::Systemd,
          :cron => Chef::Provider::Cron,
          :mdadm => Chef::Provider::Mdadm
        }
      },
      :default => {
        :mount => Chef::Provider::Mount::Mount,
        :user => Chef::Provider::User::Useradd,
        :group => Chef::Provider::Group::Gpasswd,
        :ifconfig => Chef::Provider::Ifconfig,
      }
    }
  end
end

Class Method Details

.find(name, version) ⇒ Object

# File 'lib/chef/platform/provider_mapping.rb', line 407

def find(name, version)
  provider_map = platforms[:default].clone

  name_sym = name
  if name.kind_of?(String)
    name.downcase!
    name.gsub!(/\s/, "_")
    name_sym = name.to_sym
  end

  if platforms.has_key?(name_sym)
    platform_versions = platforms[name_sym].select {|k, v| k != :default }
    if platforms[name_sym].has_key?(:default)
      provider_map.merge!(platforms[name_sym][:default])
    end
    platform_versions.each do |platform_version, provider|
      begin
        version_constraint = Chef::VersionConstraint::Platform.new(platform_version)
        if version_constraint.include?(version)
          Chef::Log.debug("Platform #{name.to_s} version #{version} found")
          provider_map.merge!(provider)
        end
      rescue Chef::Exceptions::InvalidPlatformVersion
        Chef::Log.debug("Chef::Version::Comparable does not know how to parse the platform version: #{version}")
      end
    end
  else
    Chef::Log.debug("Platform #{name} not found, using all defaults. (Unsupported platform?)")
  end
  provider_map
end

.find_platform_and_version(node) ⇒ Object

Raises:

• (ArgumentError)

# File 'lib/chef/platform/provider_mapping.rb', line 439

def find_platform_and_version(node)
  platform = nil
  version = nil

  if node[:platform]
    platform = node[:platform]
  elsif node.attribute?("os")
    platform = node[:os]
  end

  raise ArgumentError, "Cannot find a platform for #{node}" unless platform

  if node[:platform_version]
    version = node[:platform_version]
  elsif node[:os_version]
    version = node[:os_version]
  elsif node[:os_release]
    version = node[:os_release]
  end

  raise ArgumentError, "Cannot find a version for #{node}" unless version

  return platform, version
end

.find_provider(platform, version, resource_type) ⇒ Object

Raises:

• (ArgumentError)

# File 'lib/chef/platform/provider_mapping.rb', line 547

def find_provider(platform, version, resource_type)
  provider_klass = explicit_provider(platform, version, resource_type) ||
                   platform_provider(platform, version, resource_type) ||
                   resource_matching_provider(platform, version, resource_type)

  raise ArgumentError, "Cannot find a provider for #{resource_type} on #{platform} version #{version}" if provider_klass.nil?

  provider_klass
end

.find_provider_for_node(node, resource_type) ⇒ Object

# File 'lib/chef/platform/provider_mapping.rb', line 477

def find_provider_for_node(node, resource_type)
  platform, version = find_platform_and_version(node)
  find_provider(platform, version, resource_type)
end

.provider_for_node(node, resource_type) ⇒ Object

Raises:

• (NotImplementedError)

# File 'lib/chef/platform/provider_mapping.rb', line 472

def provider_for_node(node, resource_type)
  raise NotImplementedError, "#{self.class.name} no longer supports #provider_for_node"
  find_provider_for_node(node, resource_type).new(node, resource_type)
end

.provider_for_resource(resource, action = :nothing) ⇒ Object

Raises:

• (ArgumentError)

# File 'lib/chef/platform/provider_mapping.rb', line 464

def provider_for_resource(resource, action=:nothing)
  node = resource.run_context && resource.run_context.node
  raise ArgumentError, "Cannot find the provider for a resource with no run context set" unless node
  provider = find_provider_for_node(node, resource).new(resource, resource.run_context)
  provider.action = action
  provider
end

.set(args) ⇒ Object

# File 'lib/chef/platform/provider_mapping.rb', line 482

def set(args)
  validate(
    args,
    {
      :platform => {
        :kind_of => Symbol,
        :required => false,
      },
      :version => {
        :kind_of => String,
        :required => false,
      },
      :resource => {
        :kind_of => Symbol,
      },
      :provider => {
        :kind_of => [ String, Symbol, Class ],
      }
    }
  )
  if args.has_key?(:platform)
    if args.has_key?(:version)
      if platforms.has_key?(args[:platform])
        if platforms[args[:platform]].has_key?(args[:version])
          platforms[args[:platform]][args[:version]][args[:resource].to_sym] = args[:provider]
        else
          platforms[args[:platform]][args[:version]] = {
            args[:resource].to_sym => args[:provider]
          }
        end
      else
        platforms[args[:platform]] = {
          args[:version] => {
            args[:resource].to_sym => args[:provider]
          }
        }
      end
    else
      if platforms.has_key?(args[:platform])
        if platforms[args[:platform]].has_key?(:default)
          platforms[args[:platform]][:default][args[:resource].to_sym] = args[:provider]
        elsif args[:platform] == :default
          platforms[:default][args[:resource].to_sym] = args[:provider]
        else
          platforms[args[:platform]] = { :default => { args[:resource].to_sym => args[:provider] } }
        end
      else
        platforms[args[:platform]] = {
          :default => {
            args[:resource].to_sym => args[:provider]
          }
        }
      end
    end
  else
    if platforms.has_key?(:default)
      platforms[:default][args[:resource].to_sym] = args[:provider]
    else
      platforms[:default] = {
        args[:resource].to_sym => args[:provider]
      }
    end
  end
end

.supports_dsc?(node) ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/chef/platform/query_helpers.rb', line 49

def supports_dsc?(node)
  node[:languages] && node[:languages][:powershell] &&
    node[:languages][:powershell][:version].to_i >= 4
end

.windows? ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/chef/platform/query_helpers.rb', line 23

def windows?
  if RUBY_PLATFORM =~ /mswin|mingw|windows/
    true
  else
    false
  end
end

.windows_server_2003? ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/chef/platform/query_helpers.rb', line 31

def windows_server_2003?
  return false unless windows?
  require 'wmi-lite/wmi'

  # CHEF-4888: Work around ruby #2618, expected to be fixed in Ruby 2.1.0
  # https://github.com/ruby/ruby/commit/588504b20f5cc880ad51827b93e571e32446e5db
  # https://github.com/ruby/ruby/commit/27ed294c7134c0de582007af3c915a635a6506cd
  WIN32OLE.ole_initialize

  wmi = WmiLite::Wmi.new
  host = wmi.first_of('Win32_OperatingSystem')
  is_server_2003 = (host['version'] && host['version'].start_with?("5.2"))

  WIN32OLE.ole_uninitialize

  is_server_2003
end