puppet-retrospec 0.5.1 → 0.6.0

data/lib/retrospec/templates/nodesets/centos-66-x64.yml

@@ -0,0 +1,11 @@
+HOSTS:
+  centos-66-x64:
+    roles:
+      - master
+    platform: el-6-x86_64
+    box: puppetlabs/centos-6.6-64-nocm
+    box_url: https://vagrantcloud.com/puppetlabs/boxes/centos-6.6-64-nocm
+    hypervisor: vagrant
+CONFIG:
+  log_level: verbose
+  type: foss

data/lib/retrospec/templates/rakefile.erb

@@ -6,6 +6,9 @@ require 'puppet-syntax/tasks/puppet-syntax'
 # on Travis with --without development
 begin
   require 'puppet_blacksmith/rake_tasks'
+  Blacksmith::RakeTask.new do |t|
+    t.tag_pattern = "v%s" # Use a custom pattern with git tag. %s is replaced with the version number.
+  end
 rescue LoadError
 end
 

data/lib/retrospec/templates/resource_spec_file.erb

@@ -10,7 +10,7 @@ describe '<%= @type.name -%>' do
   #include_context :hiera
 
   <%- if @type.type == :definition -%>
-  let(:title) { 'example_name' }
+  let(:title) { 'XXreplace_meXX' }
   <%- end -%>
 
   # below is the facts hash that gives you the ability to mock
@@ -28,7 +28,7 @@ describe '<%= @type.name -%>' do
         <%- if v.nil? -%>
       <%= ":#{k} => 'place_value_here'," %>
         <%- else -%>
-      <%= "#:#{k} => #{v}," %>
+      <%= "#:#{k} => #{variable_value(v)}," %>
         <%- end -%>
     <%- end -%>
     }
@@ -38,7 +38,7 @@ describe '<%= @type.name -%>' do
   # Puppet::Util::Log.newdestination(:console)
   <%- @resources.each do |res| -%>
   it do
-    should contain_<%= res.type.gsub('::', '__')%>('<%= res.title %>').
+    is_expected.to contain_<%= res.type.gsub('::', '__')%>('<%= res.title %>').
              with(<%= res.parameters.to_s.gsub(/\",/, "\",\n                  ") %>)
   end
   <%- end -%>

data/lib/retrospec/templates/spec_helper_file.erb

@@ -6,4 +6,5 @@ require 'rspec-puppet-utils'
 
 RSpec.configure do |c|
     c.formatter = 'documentation'
+    config.mock_with :rspec
 end

data/lib/retrospec/templates/travis.yml.erb

@@ -0,0 +1,14 @@
+branches:
+script: "bundle exec rake spec SPEC_OPTS='--format documentation'"
+bundler_args: --without development
+
+rvm:
+- 1.9.3
+- 2.0.0
+- 2.1.5
+- 2.2.0
+env:
+  matrix:
+    - PUPPET_GEM_VERSION="~> 3.2"
+    - PUPPET_GEM_VERSION="~> 3.7"
+

data/lib/retrospec/type_code.rb

@@ -1,12 +1,24 @@
+require 'retrospec/puppet_module'
+require 'retrospec/variable_store'
+require 'retrospec/exceptions'
+
 class TypeCode
-  attr_reader :type, :variables, :scope_name
+  attr_reader :type, :variables, :scope_name, :parent, :name
 
   #TODO figure out how to store vardef statements that are contained inside conditional blocks
   def initialize(type)
-    @scope_name = type.name
+    raise TypeNotFoundException unless type
+    @scope_name = type.namespace
+    @name = type.name
     @type = type
+    @parent = type.parent
+  end
+  # need to figure out a way to load the parent or dependent manfifests
+  def has_parent?
+    @parent.nil?
   end
 
+  # returns a list of variables found in the main code block
   def variables
     if @type.code.respond_to?(:find_all)
       @variables ||= @type.code.find_all {|i| i.instance_of?(Puppet::Parser::AST::VarDef) }

data/lib/retrospec/variable_store.rb

@@ -1,5 +1,6 @@
 require 'singleton'
 require 'retrospec/type_code'
+require 'logger'
 
 class VariableStore
   attr_reader :store
@@ -8,6 +9,9 @@ class VariableStore
 
   def initialize
     @store = {}
+    # a defined type will sometimes use the name variable within other variables
+    # so we need to setup a name to reference
+    @store['$name'] = 'XXreplace_meXX'
   end
 
   def self.instance
@@ -17,7 +21,13 @@ class VariableStore
   # key should be a variable starting with $
   # enable_value_conversion converts the value to a string
   def self.add(key, value, enable_value_conversion=true)
-    key = "$#{key.to_s}" unless key.to_s.start_with?('$')
+    if key.respond_to?(:value)
+      key = key.value
+    end
+    # the key name must always be the same and look like $key_name or $key_name::other::name
+    key = "#{'$' + key.to_s}" unless key.to_s.start_with?('$')
+    key = key.to_s.gsub('$::', '$') if key.to_s.start_with?('$::')    # sometimes variables start with $::
+    #return if instance.store[key] == value
     if value.instance_of?(String) or value.instance_of?(Puppet::Parser::AST::String)
       value = value.to_s.gsub("\"",'')
     end
@@ -30,24 +40,36 @@ class VariableStore
 
   # lookup the key in the hash, if we dont' find it lets just return the string representation
   def self.lookup(key)
+    if key.respond_to?(:value)
+      key = key.value
+    end
     key = "$#{key.to_s}" unless key.to_s.start_with?('$')
+    key = key.gsub('$::', '$') if key.to_s.start_with?('$::')    # sometimes variables start with $::
+    #puts "Looking up: #{key}"
     begin
       value = VariableStore.instance.store.fetch(key.to_s)
       # try and resolve if necessary
       if [Puppet::Parser::AST::Variable,Puppet::Parser::AST::VarDef].include?(value.class)
         value = resolve(value)
+      else
+        if captures = value.scan(/(\$[::]?[\w+::]*\w+)/).flatten
+          # produces an array of variables that have not been resolved yet
+          #  ["$concat1", "$concat"] = "$concat1/test3183/$concat"
+          captures.each { |c| value.gsub(c, resolve(c))}
+        end
       end
     rescue
       return key
     end
     value
   end
-
+  # the problem is that when it tries to lookup file name pieces it doesn't have the namespace
+  # ie. $file_name/test3183/$some_var
   def self.variable_resolution(variable)
     res = nil
     if variable.instance_of? Puppet::Parser::AST::VarDef
       res = lookup(variable.name.value)
-      add(variable.name, variable.value,false) unless res.nil?
+      #add(variable.name, variable.value,false) unless res.nil?
     elsif variable.instance_of?(Puppet::Parser::AST::Variable)
       res = lookup(variable.value)
     elsif variable.instance_of?(Puppet::Parser::AST::Concat)
@@ -60,10 +82,10 @@ class VariableStore
       # I give up, I can't find the variable value so will just assign the variable name
       res = variable.to_s
     end
-    if not res.nil?
+    unless res.nil?
       if variable.instance_of?(Puppet::Parser::AST::Variable)
-        if not VariableStore.instance.store.keys.include?(variable.to_s)
-          add(variable, res)
+        unless res = lookup(variable.to_s)
+          #add(variable.to_s, res)
         end
       end
     end
@@ -75,8 +97,47 @@ class VariableStore
     res = variable_resolution(variable)
   end
 
-  # gets all the variables and passes them through the resolve function to populate the variable store
-  def self.populate(type)
-    TypeCode.new(type).variables.each {|v| add(v.name, resolve(v.value))}
+  # gets all the variables and parameters and passes them through the resolve function to populate the variable store
+  # we use recursion to evaluate inherited manifests
+  # TODO use the same recursion method to evaluate included manifests
+  def self.populate(type, is_parent=false)
+    if type.parent
+      p = type.parent.gsub(/\A::/, '')
+      parent = type.resource_type_collection.hostclasses[p]
+    else
+      parent = nil
+    end
+    if parent
+      # type has a parent and we want to add the parent variables first so we call populate first
+      # then we load the type's variable
+      populate(parent,true)
+      # we load the local scope and top scope variables because we need access to both
+      # there is a chance some of the local scope variables will be overwritten but by the time that happens
+      # we won't need them anymore.
+      type.arguments.each do |k,v|
+        # store the class params
+        add(k.to_s,resolve(v),true)
+        add(("$#{type.namespace}::" << k.to_s),resolve(v),true)
+      end
+      TypeCode.new(type).variables.each do |v|
+        add(v.name.to_s, resolve(v.value))
+        add(("$#{type.namespace}::" << v.name.to_s), resolve(v.value))
+      end
+    elsif is_parent
+      # if this is the parent we load the variables
+      type.arguments.each {|k,v| add(("$#{type.namespace}::" << k.to_s),resolve(v),true)}
+      TypeCode.new(type).variables.each {|v| add(("$#{type.namespace}::" << v.name.to_s), resolve(v.value))}
+    else
+      # if the type does not have a parent we load the variables
+      type.arguments.each do |k,v|
+        # store the class params
+        add(k.to_s,resolve(v),true)
+        add(("$#{type.namespace}::" << k.to_s),resolve(v),true)
+      end
+      TypeCode.new(type).variables.each do |v|
+        add(v.name.to_s, resolve(v.value))
+        add(("$#{type.namespace}::" << v.name.to_s), resolve(v.value))
+      end
+    end
   end
 end

data/lib/retrospec/version.rb

@@ -1,3 +1,3 @@
 module Puppet_Retrospec
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

data/puppet-retrospec.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: puppet-retrospec 0.5.1 ruby lib
+# stub: puppet-retrospec 0.6.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "puppet-retrospec"
-  s.version = "0.5.1"
+  s.version = "0.6.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Corey Osman"]
-  s.date = "2015-02-16"
+  s.date = "2015-03-25"
   s.description = "Retrofits and generates valid puppet rspec test code to existing modules"
   s.email = "corey@logicminds.biz"
   s.executables = ["retrospec"]
@@ -31,16 +31,18 @@ Gem::Specification.new do |s|
     "bin/retrospec",
     "lib/retrospec.rb",
     "lib/retrospec/conditional.rb",
+    "lib/retrospec/exceptions.rb",
     "lib/retrospec/helpers.rb",
-    "lib/retrospec/module_utilities.rb",
+    "lib/retrospec/puppet_module.rb",
     "lib/retrospec/resource.rb",
+    "lib/retrospec/spec_object.rb",
     "lib/retrospec/templates/acceptance_spec_test.erb",
     "lib/retrospec/templates/fixtures_file.erb",
     "lib/retrospec/templates/gemfile.erb",
     "lib/retrospec/templates/nodesets/centos-59-x64.yml",
     "lib/retrospec/templates/nodesets/centos-64-x64-pe.yml",
     "lib/retrospec/templates/nodesets/centos-64-x64.yml",
-    "lib/retrospec/templates/nodesets/centos-65-x64.yml",
+    "lib/retrospec/templates/nodesets/centos-66-x64.yml",
     "lib/retrospec/templates/nodesets/debian-607-x64.yml",
     "lib/retrospec/templates/nodesets/debian-70rc1-x64.yml",
     "lib/retrospec/templates/nodesets/debian-73-i386.yml",
@@ -57,18 +59,23 @@ Gem::Specification.new do |s|
     "lib/retrospec/templates/shared_context.erb",
     "lib/retrospec/templates/spec_helper_acceptance.rb.erb",
     "lib/retrospec/templates/spec_helper_file.erb",
+    "lib/retrospec/templates/travis.yml.erb",
     "lib/retrospec/type_code.rb",
     "lib/retrospec/variable_store.rb",
     "lib/retrospec/version.rb",
     "puppet-retrospec.gemspec",
-    "spec/fixtures/fixture_modules/one_resource_module/manifests/another_resource_class.pp",
+    "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/zero_resource_module/manifests/empty_class.pp",
     "spec/fixtures/fixture_modules/zero_resource_module/manifests/not_a_resource_defination.pp",
     "spec/fixtures/manifests/includes-class.pp",
     "spec/fixtures/manifests/includes-defines.pp",
+    "spec/integration/retrospec_spec.rb",
     "spec/spec_helper.rb",
     "spec/unit/conditional_spec.rb",
+    "spec/unit/module_spec.rb",
     "spec/unit/puppet-retrospec_spec.rb",
     "spec/unit/resource_spec.rb",
     "spec/unit/type_code_spec.rb",
@@ -76,7 +83,7 @@ Gem::Specification.new do |s|
   ]
   s.homepage = "http://github.com/logicminds/puppet-retrospec"
   s.licenses = ["MIT"]
-  s.rubygems_version = "2.4.5"
+  s.rubygems_version = "2.4.4"
   s.summary = "Generates puppet rspec test code based on the classes and defines inside the manifests directory. Aims to reduce some of the boilerplate coding with default test patterns."
 
   if s.respond_to? :specification_version then

data/spec/fixtures/fixture_modules/one_resource_module/manifests/{another_resource_class.pp → another_resource.pp}

@@ -2,13 +2,14 @@ class one_resource::another_resource(
   $var1 = 'value1',
   $var2 = 'value2',
   $file_name = '/tmp/test3',
-  $config_base_path = '/etc/hammer'
+  $config_base_path = '/etc/hammer',
+  $config_set     = $one_resource::params::param1_var1,
 
-){
+) inherits one_resource::params {
   $some_var = "oohhhh"
   $concat_var = "${file_name}/test3183/${some_var}"
   $cli_modules = "${config_base_path}/cli.modules.d"
-
+  $inherited_variable = $one_resource::params::var1
   file{'/tmp/test2':
     ensure => present,
   }

data/spec/fixtures/fixture_modules/one_resource_module/manifests/inherits_params.pp

@@ -0,0 +1,8 @@
+class one_resource::inherits_params(
+   $some_var = $one_resource::params::var1
+
+) inherits one_resource::params {
+
+   $string = $::osfamily
+
+}

data/spec/fixtures/fixture_modules/one_resource_module/manifests/params.pp

@@ -0,0 +1,19 @@
+class one_resource::params(
+  $param1_var1 = 'param1_value'
+){
+  $var1 = 'params_class_value1'
+  $var2 = 'value2'
+
+  case $::osfamily{
+    'windows': {
+      $osfamily_var = 'windows'
+    }
+    'redhat': {
+      $osfamily_var = 'redhat'
+    }
+    default: {
+      $osfamily_var = 'default'
+    }
+
+  }
+}

data/spec/integration/retrospec_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+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/
+  # end
+  #
+  # before :all do
+  #   #enabling the removal of real modules 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/
+  #   install_module('puppetlabs-tomcat')
+  #   @path = File.join(fixture_modules_path, 'tomcat')
+  #   @bin_path = File.expand_path(File.join('/Users/cosman/bodeco/puppet-retrospec', 'bin', 'retrospec'))
+  #
+  # end
+  #
+  # before :each do
+  #   clean_up_spec_dir("#{@path}/spec")
+  #   @opts = {:module_path => @path, :enable_beaker_tests => false,
+  #            :enable_user_templates => false, :template_dir => nil }
+  # end
+  #
+  # it 'should create files without error' do
+  #   `#{@bin_path} #{@path}`
+  #   expect(File.exists?(File.join(@path, 'Gemfile'))).to eq(true)
+  #   expect(File.exists?(File.join(@path, 'Rakefile'))).to eq(true)
+  #   expect(File.exists?(File.join(@path, 'spec', 'shared_contexts.rb'))).to eq(true)
+  #   expect(File.exists?(File.join(@path, '.fixtures.yml'))).to eq(true)
+  #   expect(File.exists?(File.join(@path, 'spec','classes','tomcat_spec.rb'))).to eq(true)
+  #   #clean_up_spec_dir(@path)
+  #
+  # end
+
+end

data/spec/unit/conditional_spec.rb

@@ -1,6 +1,10 @@
 require 'spec_helper'
 
 describe "conditional" 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/
@@ -11,33 +15,47 @@ describe "conditional" do
     FileUtils.rm_rf(fixture_modules_path) if ENV['RETROSPEC_CLEAN_UP_TEST_MODULES'] =~ /true/
   end
 
-  before :each do
-    my_path = File.expand_path(File.join('spec', 'fixtures', 'fixture_modules', 'one_resource_module'))
-    my_retro = Retrospec.new(my_path)
-    @test_type = my_retro.types.find {|x| x.name == 'one_resource::another_resource'}
-    Resource.all(@test_type)
-    conds = Conditional.find_conditionals(@test_type)
-    @con = Conditional.new(conds.first, @test_type.arguments)
-  end
 
-  it 'should initialize ' do
-    expect(@con.class).to eq(Conditional)
-  end
+  describe 'one resource module' do
+
+    let(:instance) {Utilities::PuppetModule.send :new}
 
+    it 'should initialize ' do
+      my_path = File.expand_path(File.join('spec', 'fixtures', 'fixture_modules', 'one_resource_module'))
+      m = instance
+      m.module_path =my_path
+      m.create_tmp_module_path(my_path)
+      test_type = m.types.find {|x| x.name == 'one_resource::another_resource'}
+      Resource.all(test_type)
+      conds = Conditional.find_conditionals(test_type)
+      con = Conditional.new(conds.first, test_type.arguments)
+      expect(con.class).to eq(Conditional)
+    end
 
-  it 'should generate conditional resources' do
-    r = Conditional.all(@test_type)
-    VariableStore.populate(@test_type)
-    expect(r.length).to eq(1)
-    expect(r[0].parameters).to eq({"ensure"=>"present"})
-    expect(r[0].title).to eq("/tmp/test3/3")
-    expect(r[0].type).to eq("file")
+    it 'should generate conditional resources' do
+      my_path = File.expand_path(File.join('spec', 'fixtures', 'fixture_modules', 'one_resource_module'))
+      m = instance
+      m.module_path =my_path
+      m.create_tmp_module_path(my_path)
+      test_type = m.types.find {|x| x.name == 'one_resource::another_resource'}
+      VariableStore.populate(test_type)
+      r = Conditional.all(test_type)
+      expect(r.length).to eq(1)
+      expect(r[0].parameters).to eq({"ensure"=>"present"})
+      expect(r[0].title).to eq("/tmp/test3/3")
+      expect(r[0].type).to eq("file")
+    end
   end
 
-  it 'should respond correctly to empty class' do
-    my_path = File.expand_path(File.join('spec', 'fixtures', 'fixture_modules', 'zero_resource_module'))
-    my_retro = Retrospec.new(my_path)
-    test_type = my_retro.types.find {|x| x.name == 'empty_class'}
-    expect{Conditional.all(test_type)}.to_not raise_error
+  describe 'zero module' do
+    let(:instance) {Utilities::PuppetModule.send :new}
+    it 'should respond correctly when class is empty' do
+      my_path = File.expand_path(File.join('spec', 'fixtures', 'fixture_modules', 'zero_resource_module'))
+      m = instance
+      m.module_path = my_path
+      m.create_tmp_module_path(my_path)
+      test_type = m.types.find {|x| x.name == 'empty_class'}
+      expect{Conditional.all(test_type)}.to_not raise_error
+    end
   end
 end