puppet-retrospec 0.11.0 → 0.12.0

data/spec/fixtures/providers/bmcuser/ipmitool.rb

@@ -0,0 +1,140 @@
+Puppet::Type.type(:bmcuser).provide(:ipmitool) do
+  desc "Provides ipmitool support for the bmc type"
+
+  commands :ipmitoolcmd => 'ipmitool'
+  # if the open ipmi driver does not exist we can perform any of these configurations
+  # check to see that openipmi driver is loaded and ipmi device exists
+  confine :bmc_device_present => [:true, true]
+
+  mk_resource_methods
+
+  CHANNEL_LOOKUP = {
+      'Dell Inc.'         => '1',
+      'FUJITSU'           => '2',
+      'FUJITSU SIEMENS'   => '2',
+      'HP'                => '2',
+      'Intel Corporation' => '3',
+  }
+  PRIV = {
+      :ADMINISTRATOR => 4,
+      :ADMIN => 4,
+      :USER => 2,
+      :CALLBACK => 1,
+      :OPERATOR => 3,
+      :NOACCESS => 15,
+  }
+
+  def initialize(value={})
+    super(value)
+    @property_flush = {}
+  end
+
+  def create
+    set_username resource[:username]
+    set_userpass resource[:userpass]
+    set_privlevel PRIV[resource[:privlevel]]
+    set_enable id # finds an unused id
+  end
+
+  # get the user id supplied by the resource or find out the current user id
+  # if a user id cannot be found, try and create a new user id by looking for empty slots
+  def id
+   @id ||= @property_hash[:id] || user_id(resource[:username])
+  end
+
+  def destroy
+    set_username '(Empty User)'
+    set_privlevel PRIV[:NOACCESS]
+    set_disable id
+  end
+
+  def exists?
+    @property_hash[:ensure] == :present
+  end
+
+  def set_username(value)
+    ipmitoolcmd([ "user", "set", "name", id, value] )
+  end
+
+  def set_userpass(value)
+    ipmitoolcmd([ "user", "set", "password", id, value ])
+
+  end
+
+  def set_privlevel(value)
+    ipmitoolcmd([ "user", "priv", id, value, channel ])
+
+  end
+
+  def set_enable(value)
+    ipmitoolcmd([ "user", "enable", value ])
+  end
+
+  def set_disable(value)
+    ipmitoolcmd([ "user", "disable", value ])
+  end
+
+  def users
+    unless @users
+      userdata = ipmitoolcmd([ "user", "list", CHANNEL_LOOKUP.fetch(Facter.value(:manufacturer), '1')])
+      @users = []
+      userdata.lines.each do | line|
+        # skip the header
+        next if line.match(/^ID/)
+        id, name, callin, linkauth, enabled, priv = line.chomp.split(' ', 6)
+        # create the resource
+        users << {:name => name, :username => name, :id => id, :enabled => enabled,
+                  :callin => callin, :linkauth => linkauth , :privlevel => priv, :userpass => '**Not*Available****' }
+      end
+    end
+    @users
+  end
+
+  def new_user_id
+    begin
+      user = users.find {|user| user[:name] =~ /Empty/i } || users.find {|user| !user[:enabled] }
+      user[:id]
+    rescue
+      fail('Cannot allocate a user id, all ipmi users are taken already')
+    end
+  end
+
+  def user_id(user)
+    if ! found_user = users.find {|u| u[:name] == user }
+      new_user_id
+    else
+      found_user[:id]
+    end
+  end
+
+  def self.instances
+    userdata = ipmitoolcmd([ "user", "list", CHANNEL_LOOKUP.fetch(Facter.value(:manufacturer), '1')])
+    users = []
+    userdata.lines.each do | line|
+      # skip the header
+      next if line.match(/^ID/)
+      next if line.match(/Empty/i)
+      id, name, callin, linkauth, enabled, priv = line.chomp.split(' ', 6)
+      # create the resource
+      users << new(:name => name, :username => name, :id => id, :ensure => :present,
+                   :privlevel => priv, :userpass => '**Hidden**' )
+    end
+    users
+  end
+
+  def self.prefetch(resources)
+    users = instances
+    if users
+      resources.keys.each do | name|
+        if provider = users.find{|user| user.username == name }
+          resources[name].provider = provider
+        end
+      end
+    end
+  end
+
+  def channel
+    CHANNEL_LOOKUP.fetch(Facter.value(:manufacturer), '1')
+  end
+end
+

data/spec/fixtures/types/bmc.rb

@@ -0,0 +1,102 @@
+Puppet::Type.newtype(:bmc) do
+  @doc = "Manage BMC devices"
+
+  ensurable do
+    newvalue(:present) do
+      provider.install
+    end
+
+    newvalue(:absent) do
+      provider.remove
+    end
+  end
+
+  newparam(:name, :namevar=>true) do
+    desc "The name of the bmc device."
+  end
+
+  # This is just a simple verification to valid ip related sources
+  def validaddr?(source)
+    valid = /^([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])){3}$/.match("#{source}")
+    ! valid.nil?
+
+  end
+  #
+  #  defaultto do
+  #
+  #    provider = resource[:provider].downcase
+  #    if provider =~ /freeipmi|impitool/
+  #      # check to see that openipmi driver is loaded and ipmi device exists
+  #      opendriver = File.exists?('/dev/ipmi0') || File.exists?('/dev/ipmi/0') || File.exists?('/dev/ipmidev/0')
+  #      if not opendriver
+  #        raise ArgumentError , "The openipmi driver cannot be found, is openipmi installed and loaded correctly?"
+  #      end
+  #      :ipmitool
+  #    elsif provider == "oem"
+  #      case $manufacturer.downcase!
+  #        when "hp", "hewlett packard"
+  #        # check if hp's ilo driver is installed
+  #        if not File.exists?('/dev/hpilo/dXccbN')
+  #          raise ArgumentError , "The hp ilo driver cannot be found, is the ilo driver installed and loaded?"
+  #        else
+  #          return :hp
+  #        end
+  #        else
+  #        raise ArgumentError , "The manufacturer \"#{$manufacturer}\" is currently not
+  #                                           supported under the oem provider, please try freeipmi or ipmitool"
+  #      end
+  #
+  #    end
+  #  end
+  #end
+
+
+  newproperty(:ipsource) do
+    desc "The type of ip address to use static or dhcp"
+    newvalues(:static, :dhcp)
+    defaultto{:dhcp}
+
+  end
+
+  newproperty(:ip) do
+    desc "The ip address of the bmc device"
+    validate do |value|
+      valid = /^([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])){3}$/.match("#{value}")
+      if valid.nil?
+        raise ArgumentError , "%s is not a valid ip" % value
+      end
+    end
+  end
+
+  newproperty(:netmask) do
+    desc "The netmask address of the bmc device"
+    validate do |value|
+      valid = /^([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])){3}$/.match("#{value}")
+      if valid.nil?
+        raise ArgumentError , "%s is not a valid netmask" % value
+      end
+    end
+  end
+
+  newproperty(:gateway) do
+    desc "The gateway address of the bmc device"
+    validate do |value|
+      valid = /^([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])){3}$/.match("#{value}")
+      if valid.nil?
+        raise ArgumentError , "%s is not a valid gateway" % value
+      end
+    end
+  end
+
+  newproperty(:vlanid) do
+    defaultto {"off"}
+    validate do |value|
+      unless (1..4094).include?(value.to_i) or value == "off"
+        raise ArgumentError , "%s is not a valid vlan id, must be 1-4094" % value
+      end
+    end
+  end
+
+end
+
+

data/spec/fixtures/types/bmcuser.rb

@@ -0,0 +1,46 @@
+Puppet::Type.newtype(:bmcuser) do
+  @doc = "Manage BMC devices"
+
+
+  ensurable do
+    newvalue(:present) do
+      provider.create
+    end
+
+    newvalue(:absent) do
+      provider.destroy
+    end
+  end
+
+  newproperty(:id) do
+    desc 'The id of the user, gathered from the bmc user list'
+  end
+
+  newparam(:name) do
+    desc 'The name of the resource'
+  end
+
+  newproperty(:username, :namevar => true) do
+    desc "The username to be added"
+
+  end
+
+  newproperty(:userpass) do
+    desc "The password of the user to create"
+    def change_to_s(current, desire)
+      "userpass is different, changing to specified password"
+    end
+  end
+
+  newparam(:force) do
+    desc "The force parameter will set the password of the user with every puppet run"
+    newvalues(true, false)
+  end
+
+  newproperty(:privlevel) do
+    desc "The privilege level type for the user"
+    defaultto :ADMIN
+    newvalues(:ADMIN, :USER, :OPERATOR, :CALLBACK, :ADMINISTRATOR, :NOACCESS)
+  end
+
+end

data/spec/fixtures/types/db_opatch.rb

@@ -0,0 +1,93 @@
+Puppet::Type.newtype(:db_opatch) do
+    desc 'This is the Oracle Patch process called OPatch'
+
+    newproperty(:ensure) do
+      desc 'Whether a patch should be applied.'
+
+      newvalue(:present, :event => :opatch_installed) do
+        provider.present
+      end
+
+      newvalue(:absent, :event => :opatch_absent) do
+        provider.absent
+      end
+
+      aliasvalue(:installed, :present)
+      aliasvalue(:purged, :absent)
+
+      def retrieve
+        provider.status
+      end
+
+      def sync
+        event = super()
+
+        if property = @resource.property(:enable)
+          val = property.retrieve
+          property.sync unless property.safe_insync?(val)
+        end
+
+        event
+      end
+    end
+
+    newparam(:name) do
+      desc <<-EOT
+        The name of the OPatch.
+      EOT
+      isnamevar
+    end
+
+    newproperty(:test_boolean) do
+      #newvalue :true
+      newvalue :false
+      defaultto true
+    end
+    newparam(:patch_id) do
+      desc <<-EOT
+        The patchId of the OPatch.
+      EOT
+    end
+
+    newparam(:os_user) do
+      desc <<-EOT
+        The weblogic operating system user.
+      EOT
+    end
+
+    newparam(:oracle_product_home_dir) do
+      desc <<-EOT
+        The oracle product home folder.
+      EOT
+    end
+
+    newparam(:orainst_dir) do
+      desc <<-EOT
+        The orainst folder.
+      EOT
+    end
+
+    newparam(:extracted_patch_dir) do
+      desc <<-EOT
+        The extracted patch folder.
+      EOT
+    end
+
+    newparam(:ocmrf_file) do
+      desc <<-EOT
+        The ocmrf file.
+      EOT
+    end
+
+    newparam(:opatch_auto) do
+      desc <<-EOT
+        opatch auto bundle patch
+      EOT
+    end
+
+    newparam(:bundle_sub_patch_id) do
+      desc <<-EOT
+        One of the Sub patch number of the bundle patch
+      EOT
+    end
+end

data/spec/integration/retrospec_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
-describe "variable_store" do
-
+describe 'variable_store' do
   # after :all do
   #   # enabling the removal slows down tests, but from time to time we may need to
   #   FileUtils.rm_rf(fixture_modules_path) if ENV['RETROSPEC_CLEAN_UP_TEST_MODULES'] =~ /true/
@@ -32,5 +31,4 @@ describe "variable_store" do
   #   #clean_up_spec_dir(@path)
   #
   # end
-
 end

data/spec/spec_helper.rb

@@ -7,6 +7,18 @@ def fixture_modules_path
   @fixture_module_path ||= File.expand_path(File.join(fixtures_path, 'modules'))
 end
 
+def fake_fixture_modules
+  @fake_fixture_modules ||= File.expand_path(File.join(fixtures_path, 'fixture_modules'))
+end
+
+def gem_template_path
+  @gem_template_path ||= File.expand_path(File.join(File.dirname(File.dirname(__FILE__)), 'lib', 'retrospec', 'plugins', 'v1', 'plugin', 'templates'))
+end
+
+def sample_module_path
+   File.join(fixtures_path, 'fixture_modules', 'sample_module')
+end
+
 def fixtures_path
   @fixtures_path ||= File.expand_path(File.join(File.dirname(__FILE__), 'fixtures'))
 end
@@ -15,22 +27,37 @@ def fixtures_facts_path
   @fixtures_facts_path ||= File.expand_path(File.join(fixtures_path, 'facts'))
 end
 
+def fixtures_type_path
+  @fixtures_type_path ||= File.expand_path(File.join(fixtures_path, 'types'))
+end
+
+def fixtures_provider_path
+  @fixtures_provider_path ||= File.expand_path(File.join(fixtures_path, 'providers'))
+end
+
+def fixtures_functions_path
+  @fixtures_functions_path ||= File.expand_path(File.join(fixtures_path, 'functions'))
+end
+
 def clean_up_spec_dir(dir)
-  #puts "removing directory #{dir}"
+  # puts "removing directory #{dir}"
   FileUtils.rm_rf(File.join(dir, 'spec'))
   FileUtils.rm_f(File.join(dir, 'Gemfile'))
   FileUtils.rm_f(File.join(dir, '.fixtures.yml'))
   FileUtils.rm_f(File.join(dir, 'Rakefile'))
+end
 
+def retrospec_templates_path
+  # I like to develop the templates at the same time as this gem
+  # but I keep the templates in another repo
+  # as a side effect, puppet retrospec will pick up this environment variable as well
+  ENV['RETROSPEC_TEMPLATES_DIR'] ||= File.join(ENV['HOME'], 'github', 'retrospec-templates')
 end
 
 def install_module(module_name)
   FileUtils.mkdir_p(fixture_modules_path)
   puts `puppet module install -i #{fixture_modules_path} #{module_name}`
-  Dir.glob(File.join(fixture_modules_path, '**','spec')).each do |dir|
-     clean_up_spec_dir(dir)
+  Dir.glob(File.join(fixture_modules_path, '**', 'spec')).each do |dir|
+    clean_up_spec_dir(dir)
   end
 end
-
-
-