puppet-retrospec 0.11.0 → 0.12.0

data/lib/retrospec/plugins/v1/plugin/version.rb

@@ -1,5 +1,5 @@
 module Retrospec
   module Puppet
-    VERSION = '0.11.0'
+    VERSION = '0.12.0'
   end
 end

data/puppet-retrospec.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "puppet-retrospec"
-  s.version = "0.11.0"
+  s.version = "0.12.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Corey Osman"]
-  s.date = "2015-10-26"
+  s.date = "2016-01-26"
   s.description = "Retrofits and generates valid puppet rspec test code to existing modules"
   s.email = "corey@logicminds.biz"
   s.extra_rdoc_files = [
@@ -19,8 +19,10 @@ Gem::Specification.new do |s|
   s.files = [
     ".document",
     ".rspec",
+    ".rubocop.yml",
     ".travis.yml",
     "CHANGELOG.md",
+    "DEVELOPMENT.md",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE",
@@ -29,9 +31,17 @@ Gem::Specification.new do |s|
     "VERSION",
     "lib/retrospec-puppet.rb",
     "lib/retrospec/plugins/v1/plugin/conditional.rb",
+    "lib/retrospec/plugins/v1/plugin/exceptions.rb",
+    "lib/retrospec/plugins/v1/plugin/generators.rb",
     "lib/retrospec/plugins/v1/plugin/generators/fact_generator.rb",
-    "lib/retrospec/plugins/v1/plugin/generators/facter.rb",
+    "lib/retrospec/plugins/v1/plugin/generators/function_generator.rb",
     "lib/retrospec/plugins/v1/plugin/generators/module_generator.rb",
+    "lib/retrospec/plugins/v1/plugin/generators/parsers/facter.rb",
+    "lib/retrospec/plugins/v1/plugin/generators/parsers/function.rb",
+    "lib/retrospec/plugins/v1/plugin/generators/parsers/type.rb",
+    "lib/retrospec/plugins/v1/plugin/generators/provider_generator.rb",
+    "lib/retrospec/plugins/v1/plugin/generators/schema_generator.rb",
+    "lib/retrospec/plugins/v1/plugin/generators/type_generator.rb",
     "lib/retrospec/plugins/v1/plugin/helpers.rb",
     "lib/retrospec/plugins/v1/plugin/puppet.rb",
     "lib/retrospec/plugins/v1/plugin/puppet_module.rb",
@@ -46,10 +56,19 @@ Gem::Specification.new do |s|
     "spec/fixtures/facts/datacenter_facts.rb",
     "spec/fixtures/facts/facts_with_methods.rb",
     "spec/fixtures/facts/node_role.rb",
+    "spec/fixtures/facts/oracle_controls.rb",
     "spec/fixtures/fixture_modules/one_resource_module/manifests/another_resource.pp",
     "spec/fixtures/fixture_modules/one_resource_module/manifests/inherits_params.pp",
     "spec/fixtures/fixture_modules/one_resource_module/manifests/one_resource_class.pp",
     "spec/fixtures/fixture_modules/one_resource_module/manifests/params.pp",
+    "spec/fixtures/fixture_modules/required_parameters/manifests/init.pp",
+    "spec/fixtures/fixture_modules/sample_module/lib/facter/fix_installed.rb",
+    "spec/fixtures/fixture_modules/sample_module/lib/puppet/functions/awesome_parser.rb",
+    "spec/fixtures/fixture_modules/sample_module/lib/puppet/functions/reduce.rb",
+    "spec/fixtures/fixture_modules/sample_module/lib/puppet/parser/functions/bad_sha1.rb",
+    "spec/fixtures/fixture_modules/sample_module/lib/puppet/parser/functions/defined.rb",
+    "spec/fixtures/fixture_modules/sample_module/lib/puppet/parser/functions/sha1.rb",
+    "spec/fixtures/fixture_modules/sample_module/spec/unit/facter/fix_installed_spec.rb",
     "spec/fixtures/fixture_modules/zero_resource_module/manifests/empty_class.pp",
     "spec/fixtures/fixture_modules/zero_resource_module/manifests/not_a_resource_defination.pp",
     "spec/fixtures/fixture_modules/zero_resource_module/metadata.json",
@@ -525,6 +544,7 @@ Gem::Specification.new do |s|
     "spec/fixtures/modules/stdlib/tests/has_ip_address.pp",
     "spec/fixtures/modules/stdlib/tests/has_ip_network.pp",
     "spec/fixtures/modules/stdlib/tests/init.pp",
+    "spec/fixtures/modules/tomcat/.bundle/config",
     "spec/fixtures/modules/tomcat/.gitignore",
     "spec/fixtures/modules/tomcat/.puppet-lint.rc",
     "spec/fixtures/modules/tomcat/.travis.yml",
@@ -543,6 +563,7 @@ Gem::Specification.new do |s|
     "spec/fixtures/modules/tomcat/examples/instance_with_role_and_user.pp",
     "spec/fixtures/modules/tomcat/examples/jsvc_install_from_source.pp",
     "spec/fixtures/modules/tomcat/examples/multiple_instances.pp",
+    "spec/fixtures/modules/tomcat/files/.gitkeep",
     "spec/fixtures/modules/tomcat/manifests/config/server.pp",
     "spec/fixtures/modules/tomcat/manifests/config/server/connector.pp",
     "spec/fixtures/modules/tomcat/manifests/config/server/context.pp",
@@ -562,15 +583,30 @@ Gem::Specification.new do |s|
     "spec/fixtures/modules/tomcat/manifests/setenv/entry.pp",
     "spec/fixtures/modules/tomcat/manifests/war.pp",
     "spec/fixtures/modules/tomcat/metadata.json",
+    "spec/fixtures/modules/tomcat/templates/.gitkeep",
+    "spec/fixtures/modules/tomcat/tests/.gitkeep",
+    "spec/fixtures/providers/bmc/ipmitool.rb",
+    "spec/fixtures/providers/bmcuser/ipmitool.rb",
+    "spec/fixtures/types/bmc.rb",
+    "spec/fixtures/types/bmcuser.rb",
+    "spec/fixtures/types/db_opatch.rb",
     "spec/integration/retrospec_spec.rb",
     "spec/spec_helper.rb",
     "spec/unit/conditional_spec.rb",
     "spec/unit/generators/fact_generater_spec.rb",
-    "spec/unit/generators/fact_spec.rb",
+    "spec/unit/generators/function_generator_spec.rb",
+    "spec/unit/generators/function_spec.rb",
+    "spec/unit/generators/parsers/fact_spec.rb",
+    "spec/unit/generators/parsers/provider_spec.rb",
+    "spec/unit/generators/parsers/type_spec.rb",
+    "spec/unit/generators/provider_generator_spec.rb",
+    "spec/unit/generators/schema_generator_spec.rb",
+    "spec/unit/generators/type_generator_spec.rb",
     "spec/unit/module_spec.rb",
     "spec/unit/plugin_spec.rb",
     "spec/unit/puppet-retrospec_spec.rb",
     "spec/unit/resource_spec.rb",
+    "spec/unit/spec_object_spec.rb",
     "spec/unit/type_code_spec.rb",
     "spec/unit/variable_store_spec.rb",
     "vendor/gems/puppet-3.7.3/Gemfile",
@@ -1832,6 +1868,7 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<trollop>, [">= 0"])
       s.add_runtime_dependency(%q<retrospec>, ["~> 0.4"])
       s.add_runtime_dependency(%q<awesome_print>, [">= 0"])
+      s.add_runtime_dependency(%q<facets>, [">= 0"])
       s.add_development_dependency(%q<rspec>, ["~> 3.2"])
       s.add_development_dependency(%q<puppet>, ["= 3.7.3"])
       s.add_development_dependency(%q<yard>, ["~> 0.7"])
@@ -1844,6 +1881,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<trollop>, [">= 0"])
       s.add_dependency(%q<retrospec>, ["~> 0.4"])
       s.add_dependency(%q<awesome_print>, [">= 0"])
+      s.add_dependency(%q<facets>, [">= 0"])
       s.add_dependency(%q<rspec>, ["~> 3.2"])
       s.add_dependency(%q<puppet>, ["= 3.7.3"])
       s.add_dependency(%q<yard>, ["~> 0.7"])
@@ -1857,6 +1895,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<trollop>, [">= 0"])
     s.add_dependency(%q<retrospec>, ["~> 0.4"])
     s.add_dependency(%q<awesome_print>, [">= 0"])
+    s.add_dependency(%q<facets>, [">= 0"])
     s.add_dependency(%q<rspec>, ["~> 3.2"])
     s.add_dependency(%q<puppet>, ["= 3.7.3"])
     s.add_dependency(%q<yard>, ["~> 0.7"])

data/spec/fixtures/facts/oracle_controls.rb

@@ -0,0 +1,38 @@
+require 'json'
+
+Facter.add(:oracle_controls) do
+  setcode do
+    confine :kernel => 'Linux'
+    confine :type => 'oracle'
+    script_data
+  end
+end
+
+# returns boolean true if all the checks pass
+Facter.add(:oracle_security_status) do
+  setcode do
+    confine :kernel => 'Linux'
+    confine :type => 'oracle'
+    # check all items in the hash and return true/false if any of them have failed
+    if script_data
+      ! script_data.find { | item| item['status'] =~ /true/i }.empty?  # negate because an empty array means all passing
+    end
+  end
+end
+
+# return the data by running the check db script and store in a variable for later caching
+# return nil if script cannot be run
+def script_data
+  unless @script_data
+    script = '/some/script.sh'
+    return nil unless File.exists?(script)
+    cmd = "#{script}"
+    json_data = Facter::Core::Execution.execute("/bin/su -c '#{cmd}' - oracle", :on_fail => nil)
+    if json_data
+      @script_data = JSON.parse(json_data)
+    else
+      @script_data = nil
+    end
+  end
+  @script_data
+end

data/spec/fixtures/fixture_modules/required_parameters/manifests/init.pp

@@ -0,0 +1,8 @@
+class required_parameters(
+  $required_parameter,
+  $not_required_parameter = undef,
+  $boolean_parameter = false,
+  $string_parameter = 'hello'
+) {
+  # do nothing
+}

data/spec/fixtures/fixture_modules/sample_module/lib/facter/fix_installed.rb

@@ -0,0 +1,11 @@
+Facter.add(:fix_installed) do
+  confine :kernel => 'windows'
+  setcode do
+    puts client_executable
+    File.exists?(client_executable)
+  end
+end
+
+def client_executable
+  "C:\\Program Files (x86)\\some.exe"
+end

data/spec/fixtures/fixture_modules/sample_module/lib/puppet/functions/awesome_parser.rb

@@ -0,0 +1,13 @@
+# extremely helpful documentation
+# https://github.com/puppetlabs/puppet-specifications/blob/master/language/func-api.md#the-4x-api
+Puppet::Functions.create_function(:awesome_parser) do
+  # the function below is called by puppet and and must match
+  # the name of the puppet function above. You can set your
+  # required parameters below and puppet 4 will enforce these
+  # change x and y to suit your needs although only one parameter is required
+  def awesome_parser(x,y)
+    x >= y ? x : y
+  end
+
+  # you can define other helper methods in this code block as well
+end

data/spec/fixtures/fixture_modules/sample_module/lib/puppet/functions/reduce.rb

@@ -0,0 +1,31 @@
+Puppet::Functions.create_function(:reduce) do
+
+  dispatch :reduce_without_memo do
+    param 'Any', :enumerable
+    block_param 'Callable[2,2]', :block
+  end
+
+  dispatch :reduce_with_memo do
+    param 'Any', :enumerable
+    param 'Any', :memo
+    block_param 'Callable[2,2]', :block
+  end
+
+  def reduce_without_memo(enumerable)
+    enum = asserted_enumerable(enumerable)
+    enum.reduce {|memo, x| yield(memo, x) }
+  end
+
+  def reduce_with_memo(enumerable, given_memo)
+    enum = asserted_enumerable(enumerable)
+    enum.reduce(given_memo) {|memo, x| yield(memo, x) }
+  end
+
+  def asserted_enumerable(obj)
+    unless enum = Puppet::Pops::Types::Enumeration.enumerator(obj)
+      raise ArgumentError, ("#{self.class.name}(): wrong argument type (#{obj.class}; must be something enumerable.")
+    end
+    enum
+  end
+
+end

data/spec/fixtures/fixture_modules/sample_module/lib/puppet/parser/functions/bad_sha1.rb

@@ -0,0 +1,6 @@
+require 'digest/sha1'
+
+Puppet::Parser::Functions::newfunction(:bad_sha1, :type => :rvalue, :arity => 1, :doc => "Returns a SHA1 hash value from a provided string.") do |args|
+  \crap
+  value = Digest::SHA1.hexdigest(args[0])
+end

data/spec/fixtures/fixture_modules/sample_module/lib/puppet/parser/functions/defined.rb

@@ -0,0 +1,94 @@
+# Test whether a given class or definition is defined
+Puppet::Parser::Functions::newfunction(:defined, :type => :rvalue, :arity => -2,
+                                       :doc => "Determine whether
+  a given class or resource type is defined. This function can also determine whether a
+  specific resource has been defined, or whether a variable has been assigned a value
+  (including `undef` - as opposed to never having been assigned anything). Returns `true`
+  or `false`. Accepts class names, type names, resource references, and variable
+  reference strings of the form `'$name'`. When more than one argument is
+  supplied, `defined()` returns `true` if any are defined.
+
+  The `defined` function checks both native and defined types, including types
+  provided as plugins via modules. Types and classes are both checked using their names:
+
+      defined(\"file\")
+      defined(\"customtype\")
+      defined(\"foo\")
+      defined(\"foo::bar\")
+      defined(\'$name\')
+
+  Resource declarations are checked using resource references, e.g.
+  `defined( File['/tmp/myfile'] )`. Checking whether a given resource
+  has been declared is, unfortunately, dependent on the evaluation order of
+  the configuration, and the following code will not work:
+
+      if defined(File['/tmp/foo']) {
+          notify { \"This configuration includes the /tmp/foo file.\":}
+      }
+      file { \"/tmp/foo\":
+          ensure => present,
+      }
+
+  However, this order requirement refers to evaluation order only, and ordering of
+  resources in the configuration graph (e.g. with `before` or `require`) does not
+  affect the behavior of `defined`.
+
+  You may also search using types:
+
+      defined(Resource[\'file\',\'/some/file\'])
+      defined(File[\'/some/file\'])
+      defined(Class[\'foo\'])
+
+  The `defined` function does not answer if 4.x data types (e.g. `Integer`) are defined. If
+  given the string 'integer' the result is false, and if given a non CatalogEntry type,
+  an error is raised.
+
+  The rules for asking for undef, empty strings, and the main class are different from 3.x
+  (non future parser) and 4.x (with future parser or in Puppet 4.0.0 and later):
+
+      defined('')     # 3.x => true, 4.x => false
+      defined(undef)  # 3.x => true, 4.x => error
+      defined('main') # 3.x => false, 4.x => true
+
+  With the future parser, it is also possible to ask specifically if a name is
+  a resource type (built in or defined), or a class, by giving its type:
+
+      defined(Type[Class['foo']])
+      defined(Type[Resource['foo']])
+
+  Which is different from asking:
+
+      defined('foo')
+
+  Since the later returns true if 'foo' is either a class, a built-in resource type, or a user defined
+  resource type, and a specific request like `Type[Class['foo']]` only returns true if `'foo'` is a class.
+
+ - Since 2.7.0
+ - Since 3.6.0 variable reference and future parser types
+ - Since 3.8.1 type specific requests with future parser") do |vals|
+  vals = [vals] unless vals.is_a?(Array)
+  vals.any? do |val|
+    case val
+      when String
+        if m = /^\$(.+)$/.match(val)
+          exist?(m[1])
+        else
+          find_resource_type(val) || find_definition(val) || find_hostclass(val)
+        end
+      when Puppet::Resource
+        compiler.findresource(val.type, val.title)
+      when Puppet::Pops::Types::PResourceType
+        raise ArgumentError, "The given resource type is a reference to all kind of types" if val.type_name.nil?
+        if val.title.nil?
+          find_builtin_resource_type(val.type_name) || find_definition(val.type_name)
+        else
+          compiler.findresource(val.type_name, val.title)
+        end
+      when Puppet::Pops::Types::PHostClassType
+        raise  ArgumentError, "The given class type is a reference to all classes" if val.class_name.nil?
+        find_hostclass(val.class_name)
+      else
+        raise ArgumentError, "Invalid argument of type '#{val.class}' to 'defined'"
+    end
+  end
+end

data/spec/fixtures/fixture_modules/sample_module/lib/puppet/parser/functions/sha1.rb

@@ -0,0 +1,6 @@
+require 'digest/sha1'
+
+Puppet::Parser::Functions::newfunction(:sha1, :type => :rvalue, :arity => 1, :doc => "Returns a SHA1 hash value from a provided string.") do |args|
+  value = Digest::SHA1.hexdigest(args[0])
+end
+

data/spec/fixtures/fixture_modules/sample_module/spec/unit/facter/fix_installed_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+require 'facter'
+
+describe :fix_installed, :type => :fact do
+
+  before :all do
+    # perform any action that should be run for the entire test suite
+  end
+
+  before :each do
+    # perform any action that should be run before every test
+    Facter.clear
+    # This will mock the facts that confine uses to limit facts running under certain conditions
+    allow(Facter.fact(:kernel)).to receive(:value).and_return("windows")
+  
+  end
+
+  it 'should return a value' do
+    expect(Facter.fact(:fix_installed).value).to eq('value123')  #<-- change the value to match your expectation
+  end
+end

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

@@ -0,0 +1,188 @@
+Puppet::Type.type(:bmc).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',
+  }
+  def initialize(value={})
+    super(value)
+    @property_flush = {}
+  end
+
+  # the flush method will be the last method called after applying all the other
+  # properties, by default nothing will be enabled or disabled unless the disable/enable are set to true
+  # if we ever move to a point were we can write all the settings via one big config file we
+  # would want to do that here.
+  def flush
+    if @property_flush
+      if @property_flush[:disable]
+        disable_channel  #TODO is this needed?
+      elsif @property_flush[:enable]
+        enable_channel  # TODO is this needed? what does this do ?
+      end
+    end
+    # resets the interface
+    Puppet.debug('rebooting the bmc device')
+    ipmitoolcmd(['bmc', 'reset', 'cold'])
+  end
+
+  ##### These are the default ensurable methods that must be implemented
+  def install
+    if resource[:ipsource] == :static
+      ip = resource[:ip]
+      netmask = resource[:netmask]
+      gateway = resource[:gateway]
+    end
+
+    ipsource = resource[:ipsource]
+    if resource[:vlanid]
+      vlanid = resource[:vlanid]
+    end
+  end
+
+  def remove
+    ipsource = "dhcp"
+
+  end
+
+  def exists?
+    @property_hash[:ensure] == :present
+  end
+
+  # return all instances of this resource which really should only be one instance
+  def self.instances
+    info          = self.laninfo
+    inst = new(
+        :name     => info["mac address"],
+        :ensure   => :present,
+        :ip       => info["ip address"],
+        :netmask  => info["subnet mask"],
+        :gateway  => info["default gateway ip"],
+        :vlanid   => info["802.1q vlan id"],
+        :ipsource => info["ip address source"]
+    )
+    [inst]
+  end
+
+  def self.prefetch(resources)
+    devices = instances
+    if devices
+      resources.keys.each do | name|
+        if provider = devices.find{|device| device.name == name }
+          resources[name].provider = provider
+        end
+      end
+    end
+  end
+
+  #def snmp
+  #  # TODO implement how to get the snmp string even when the device doesn't support snmp lookups
+  #end
+  #
+  #def snmp=(community)
+  #  ipmitoolcmd 'lan set 1 snmp', community
+  #end
+
+  # end - bmc parameters
+
+  def self.laninfo
+    landata = ipmitoolcmd([ "lan", "print", CHANNEL_LOOKUP.fetch(Facter.value(:manufacturer), '1') ])
+    info = {}
+    landata.lines.each do |line|
+      # clean up the data from spaces
+      item = line.split(':', 2)
+      key = item.first.strip.downcase
+      value = item.last.strip
+      info[key] = value
+    end
+    info
+    info['ip address source'] = convert_ip_source(info['ip address source'])
+    info["802.1q vlan id"] = convert_vlanid(info["802.1q vlan id"])
+    info
+  end
+
+  def gateway=(address)
+    ipmitoolcmd([ "lan", "set", channel, "defgw", "ipaddr", address ])
+  end
+
+  def ipsource=(source)
+    ipmitoolcmd([ "lan", "set", channel, "ipsrc", source.to_s ])
+  end
+
+  def ip=(address)
+    ipmitoolcmd([ "lan", "set", channel, "ipaddr", address ])
+  end
+
+  def netmask=(subnet)
+    ipmitoolcmd([ "lan", "set", channel, "netmask", subnet ])
+  end
+
+  def vlanid=(vid)
+    ipmitoolcmd([ "lan", "set", channel, "vlan", "id", vid ])
+  end
+
+  def self.convert_vlanid(id)
+    if id =~ /Disabled/i
+      'off'
+    else
+      id
+    end
+  end
+
+  def self.convert_ip_source(src)
+    case src
+      when /static/i
+        :static
+      when /dhcp/i
+        :dhcp
+      else
+        src
+    end
+  end
+
+  private
+
+  def mac
+    lanconfig["mac address"]
+  end
+
+  def dhcp?
+    lanconfig["ip address source"].match(/dhcp/i) != nil
+  end
+
+  def static?
+    lanconfig["ip address source"].match(/static/i) != nil
+  end
+
+  def channel_enabled?
+    # TODO implement how to look up this info
+    true
+  end
+
+  def channel
+    CHANNEL_LOOKUP.fetch(Facter.value(:manufacturer), '1')
+  end
+
+  def enable_channel
+    ipmitoolcmd([ "lan", "set", channel, "access", "on" ])
+  end
+
+  def disable_channel
+    ipmitoolcmd([ "lan", "set", channel, "access", "off" ])
+  end
+
+  def lanconfig
+    @lanconfig ||= self.class.laninfo
+  end
+end