puppet-retrospec 0.4.0 → 0.5.0

data/lib/retrospec/templates/resource_spec_file.erb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+require 'shared_contexts'
+
+describe '<%= @type.name -%>' do
+  # by default the hiera integration uses hirea data from the shared_contexts.rb file
+  # but basically to mock hiera you first need to add a key/value pair
+  # to the specific context in the spec/shared_contexts.rb file
+  # Note: you can only use a single hiera context per describe/context block
+  # rspec-puppet does not allow you to swap out hiera data on a per test block
+  #include_context :hiera
+
+  <%- if @type.type == :definition -%>
+  let(:title) { 'example_name' }
+  <%- end -%>
+
+  # below is the facts hash that gives you the ability to mock
+  # facts on a per describe/context block.  If you use a fact in your
+  # manifest you should mock the facts below.
+  let(:facts) do
+    {}
+  end
+  # below is a list of the resource parameters that you can override.
+  # By default all non-required parameters are commented out,
+  # while all required parameters will require you to add a value
+  let(:params) do
+    {
+    <%- @parameters.each do |k,v| -%>
+        <%- if v.nil? -%>
+      <%= ":#{k} => 'place_value_here'," %>
+        <%- else -%>
+      <%= "#:#{k} => #{v}," %>
+        <%- end -%>
+    <%- end -%>
+    }
+  end
+  # add these two lines in a single test block to enable puppet and hiera debug mode
+  # Puppet::Util::Log.level = :debug
+  # Puppet::Util::Log.newdestination(:console)
+  <%- @resources.each do |res| -%>
+  it do
+    should contain_<%= res.type.gsub('::', '__')%>('<%= res.title %>').
+             with(<%= res.parameters.to_s.gsub(/\",/, "\",\n                  ") %>)
+  end
+  <%- end -%>
+end

data/lib/{templates → retrospec/templates}/shared_context.erb

@@ -1,6 +1,8 @@
 require 'hiera-puppet-helper'
 
-# optional, this should be the path to where the hirea data config file is in this repo
+# optional, this should be the path to where the hiera data config file is in this repo
+# You must update this if your actual hiera data lives inside your module.
+# I only assume its data, but it could be anything
 hiera_config_file = File.expand_path(File.join(File.dirname(__FILE__), '..','data', 'hiera.yaml'))
 
 # hiera_file and hiera_data are mutally exclusive contexts.

data/lib/retrospec/type_code.rb

@@ -0,0 +1,18 @@
+class TypeCode
+  attr_reader :type, :variables, :scope_name
+
+  #TODO figure out how to store vardef statements that are contained inside conditional blocks
+  def initialize(type)
+    @scope_name = type.name
+    @type = type
+  end
+
+  def variables
+    if @type.code.respond_to?(:find_all)
+      @variables ||= @type.code.find_all {|i| i.instance_of?(Puppet::Parser::AST::VarDef) }
+    else
+      @variables = []
+    end
+    @variables
+  end
+end

data/lib/retrospec/variable_store.rb

@@ -0,0 +1,82 @@
+require 'singleton'
+require 'retrospec/type_code'
+
+class VariableStore
+  attr_reader :store
+
+  include Singleton
+
+  def initialize
+    @store = {}
+  end
+
+  def self.instance
+    @@instance ||= new
+  end
+
+  # 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 value.instance_of?(String) or value.instance_of?(Puppet::Parser::AST::String)
+      value = value.to_s.gsub("\"",'')
+    end
+    if enable_value_conversion
+      instance.store[key.to_s] = value.to_s
+    else
+      instance.store[key.to_s] = value
+    end
+  end
+
+  # lookup the key in the hash, if we dont' find it lets just return the string representation
+  def self.lookup(key)
+    key = "$#{key.to_s}" unless key.to_s.start_with?('$')
+    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)
+      end
+    rescue
+      return key
+    end
+    value
+  end
+
+  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?
+    elsif variable.instance_of?(Puppet::Parser::AST::Variable)
+      res = lookup(variable.value)
+    elsif variable.instance_of?(Puppet::Parser::AST::Concat)
+      begin
+        res = variable.value.map { |i| variable_resolution(i)}.join.gsub("\"",'')
+      rescue
+        res = variable.value
+      end
+    else
+      # 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?
+      if variable.instance_of?(Puppet::Parser::AST::Variable)
+        if not VariableStore.instance.store.keys.include?(variable.to_s)
+          add(variable, res)
+        end
+      end
+    end
+    res
+  end
+
+  # will try and resolve the variable to a value by consulting the variables hash
+  def self.resolve(variable)
+    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))}
+  end
+end

data/lib/retrospec/version.rb

@@ -0,0 +1,3 @@
+module Puppet_Retrospec
+  VERSION = "0.5.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.4.0 ruby lib
+# stub: puppet-retrospec 0.5.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "puppet-retrospec"
-  s.version = "0.4.0"
+  s.version = "0.5.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 = "2014-11-21"
+  s.date = "2015-02-09"
   s.description = "Retrofits and generates valid puppet rspec test code to existing modules"
   s.email = "corey@logicminds.biz"
   s.executables = ["retrospec"]
@@ -29,48 +29,60 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "bin/retrospec",
-    "lib/helpers.rb",
-    "lib/puppet-retrospec.rb",
-    "lib/templates/acceptance_spec_test.erb",
-    "lib/templates/fixtures_file.erb",
-    "lib/templates/gemfile.erb",
-    "lib/templates/nodesets/centos-59-x64.yml",
-    "lib/templates/nodesets/centos-64-x64-pe.yml",
-    "lib/templates/nodesets/centos-64-x64.yml",
-    "lib/templates/nodesets/centos-65-x64.yml",
-    "lib/templates/nodesets/debian-607-x64.yml",
-    "lib/templates/nodesets/debian-70rc1-x64.yml",
-    "lib/templates/nodesets/debian-73-i386.yml",
-    "lib/templates/nodesets/debian-73-x64.yml",
-    "lib/templates/nodesets/default.yml",
-    "lib/templates/nodesets/fedora-18-x64.yml",
-    "lib/templates/nodesets/sles-11sp1-x64.yml",
-    "lib/templates/nodesets/ubuntu-server-10044-x64.yml",
-    "lib/templates/nodesets/ubuntu-server-12042-x64.yml",
-    "lib/templates/nodesets/ubuntu-server-1310-x64.yml",
-    "lib/templates/nodesets/ubuntu-server-1404-x64.yml",
-    "lib/templates/rakefile.erb",
-    "lib/templates/resource_spec_file.erb",
-    "lib/templates/shared_context.erb",
-    "lib/templates/spec_helper_acceptance.rb.erb",
-    "lib/templates/spec_helper_file.erb",
+    "lib/retrospec.rb",
+    "lib/retrospec/conditional.rb",
+    "lib/retrospec/helpers.rb",
+    "lib/retrospec/resource.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/debian-607-x64.yml",
+    "lib/retrospec/templates/nodesets/debian-70rc1-x64.yml",
+    "lib/retrospec/templates/nodesets/debian-73-i386.yml",
+    "lib/retrospec/templates/nodesets/debian-73-x64.yml",
+    "lib/retrospec/templates/nodesets/default.yml",
+    "lib/retrospec/templates/nodesets/fedora-18-x64.yml",
+    "lib/retrospec/templates/nodesets/sles-11sp1-x64.yml",
+    "lib/retrospec/templates/nodesets/ubuntu-server-10044-x64.yml",
+    "lib/retrospec/templates/nodesets/ubuntu-server-12042-x64.yml",
+    "lib/retrospec/templates/nodesets/ubuntu-server-1310-x64.yml",
+    "lib/retrospec/templates/nodesets/ubuntu-server-1404-x64.yml",
+    "lib/retrospec/templates/rakefile.erb",
+    "lib/retrospec/templates/resource_spec_file.erb",
+    "lib/retrospec/templates/shared_context.erb",
+    "lib/retrospec/templates/spec_helper_acceptance.rb.erb",
+    "lib/retrospec/templates/spec_helper_file.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/one_resource_class.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/spec_helper.rb",
-    "spec/unit/puppet-retrospec_spec.rb"
+    "spec/unit/conditional_spec.rb",
+    "spec/unit/puppet-retrospec_spec.rb",
+    "spec/unit/resource_spec.rb",
+    "spec/unit/type_code_spec.rb",
+    "spec/unit/variable_store_spec.rb"
   ]
   s.homepage = "http://github.com/logicminds/puppet-retrospec"
   s.licenses = ["MIT"]
-  s.rubygems_version = "2.4.4"
+  s.rubygems_version = "2.4.5"
   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
     s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<puppet>, [">= 0"])
+      s.add_runtime_dependency(%q<puppet>, ["= 3.7.3"])
       s.add_runtime_dependency(%q<trollop>, [">= 0"])
       s.add_development_dependency(%q<rspec>, ["~> 2.14"])
       s.add_development_dependency(%q<yard>, ["~> 0.7"])
@@ -79,8 +91,11 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<jeweler>, [">= 0"])
       s.add_development_dependency(%q<pry>, [">= 0"])
       s.add_development_dependency(%q<fakefs>, [">= 0"])
+      s.add_development_dependency(%q<pry-rescue>, [">= 0"])
+      s.add_development_dependency(%q<pry-stack_explorer>, [">= 0"])
+      s.add_development_dependency(%q<pry-coolline>, [">= 0"])
     else
-      s.add_dependency(%q<puppet>, [">= 0"])
+      s.add_dependency(%q<puppet>, ["= 3.7.3"])
       s.add_dependency(%q<trollop>, [">= 0"])
       s.add_dependency(%q<rspec>, ["~> 2.14"])
       s.add_dependency(%q<yard>, ["~> 0.7"])
@@ -89,9 +104,12 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<jeweler>, [">= 0"])
       s.add_dependency(%q<pry>, [">= 0"])
       s.add_dependency(%q<fakefs>, [">= 0"])
+      s.add_dependency(%q<pry-rescue>, [">= 0"])
+      s.add_dependency(%q<pry-stack_explorer>, [">= 0"])
+      s.add_dependency(%q<pry-coolline>, [">= 0"])
     end
   else
-    s.add_dependency(%q<puppet>, [">= 0"])
+    s.add_dependency(%q<puppet>, ["= 3.7.3"])
     s.add_dependency(%q<trollop>, [">= 0"])
     s.add_dependency(%q<rspec>, ["~> 2.14"])
     s.add_dependency(%q<yard>, ["~> 0.7"])
@@ -100,6 +118,9 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<jeweler>, [">= 0"])
     s.add_dependency(%q<pry>, [">= 0"])
     s.add_dependency(%q<fakefs>, [">= 0"])
+    s.add_dependency(%q<pry-rescue>, [">= 0"])
+    s.add_dependency(%q<pry-stack_explorer>, [">= 0"])
+    s.add_dependency(%q<pry-coolline>, [">= 0"])
   end
 end
 

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

@@ -0,0 +1,28 @@
+class one_resource::another_resource(
+  $var1 = 'value1',
+  $var2 = 'value2',
+  $file_name = '/tmp/test3',
+  $config_base_path = '/etc/hammer'
+
+){
+  $some_var = "oohhhh"
+  $concat_var = "${file_name}/test3183/${some_var}"
+  $cli_modules = "${config_base_path}/cli.modules.d"
+
+  file{'/tmp/test2':
+    ensure => present,
+  }
+  file{$file_name:
+    ensure => present,
+    content => $concat_var
+  }
+  if $file_name {
+    $if_var1 = 'if_var1_value1'
+    file{"$file_name/3":
+      ensure => present,
+    }
+  }
+  else {
+    $if_var1 = 'if_var1_value2'
+  }
+}

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

@@ -0,0 +1,6 @@
+class one_resource{
+
+  file{'/tmp/test':
+    ensure => present,
+  }
+}

data/spec/fixtures/fixture_modules/zero_resource_module/manifests/empty_class.pp

@@ -0,0 +1,3 @@
+class empty_class{
+
+}

data/spec/spec_helper.rb

@@ -1,6 +1,7 @@
-require 'puppet-retrospec'
+require 'retrospec'
 require 'rspec'
 require 'puppet'
+require 'pry'
 
 def fixture_modules_path
   @fixture_module_path ||= File.expand_path(File.join(fixtures_path, 'modules'))

data/spec/unit/conditional_spec.rb

@@ -0,0 +1,43 @@
+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/
+  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/
+  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
+
+
+  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")
+  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
+  end
+end

data/spec/unit/puppet-retrospec_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
-require 'puppet-retrospec'
-require 'helpers'
+require 'retrospec'
 require 'fakefs/safe'
+require 'retrospec/helpers'
 
 describe "puppet-retrospec" do
   after :all do
@@ -18,7 +18,7 @@ describe "puppet-retrospec" do
   end
 
   before :each do
-    clean_up_spec_dir(@path)
+    #clean_up_spec_dir(@path)
     @opts = {:module_path => @path, :enable_beaker_tests => false,
              :enable_user_templates => false, :template_dir => nil }
   end
@@ -45,6 +45,7 @@ describe "puppet-retrospec" do
   end
 
   it 'should not create acceptance test files' do
+    clean_up_spec_dir(@path)
     @opts[:enable_beaker_tests] = false
     tomcat = Retrospec.new(@opts[:module_path], @opts)
     spec_path = File.expand_path(File.join(@path, 'spec'))
@@ -237,42 +238,4 @@ describe "puppet-retrospec" do
      expect(tomcat.generate_file_name('tomcat::config')).to eq('config_spec.rb')
   end
 
-  # it 'should contain a list of parameters in the test' do
-  #   tomcat = Retrospec.new(@opts[:module_path], @opts)
-  #   tomcat.create_files
-  #
-  # end
-  #
-  # it 'should retrieve a list of includes' do
-  #   # ie. {"includes-class"=>["class1", "class2", "class3", "class6"]}
-  #   includes = @retro.included_declarations('spec/fixtures/manifests/includes-class.pp')
-  #   includes['includes-class'].should eq(["class1", "class2", "class3", "class6"])
-  # end
-  #
-  # it 'should not include the require statements' do
-  #   # ie. {"includes-class"=>["class1", "class2", "class3", "class6"]}
-  #   includes = @retro.included_declarations('spec/fixtures/manifests/includes-class.pp')
-  #   includes['includes-class'].should_not eq(["class1", "class2", "class3", "class4", "class5", "class6"])
-  # end
-  #
-  #
-  # it 'should retrieve a list of define names' do
-  #   # ie. [{:filename=>"includes-class", :types=>[{:type_name=>"class", :name=>"includes-class"}]}]
-  #   my_retro = Retrospec.new('spec/fixtures/manifests/includes-defines.pp')
-  #   classes = my_retro.classes_and_defines('spec/fixtures/manifests/includes-defines.pp')
-  #   types = classes.first[:types]
-  #   types.first[:type_name].should eq('define')
-  #   types.first[:name].should eq("webinstance")
-  # end
-  #
-  #
-  # it 'included_declarations should not be nil' do
-  #   @retro.included_declarations(@retro.manifest_files.first).length.should >= 1
-  # end
-  #
-  #
-  # it 'modules_included should not be nil' do
-  #   @retro.modules_included.length.should eq(1)
-  # end
-
 end