puppet-retrospec 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 027977cdd2e60766923d0d8c013efb9beafcff28
-  data.tar.gz: 1652ba814a16849574a492e2f06c917829625416
+  metadata.gz: 2a2f8b465a1d2884cfff1f96f1d46214c891d27f
+  data.tar.gz: b3458e26b5ccdab19bd1fa05c841eb7eb7e3952c
 SHA512:
-  metadata.gz: 81ab8cff8a124a17b60d2dfe2c3ea50a467a58fe30aaedc3d10791f23328cb68a32fa31efb93298d699d879cfacb3401bc5de9412b59678ecf6f7f12822b6914
-  data.tar.gz: 70a98a402f0a993551fd46c81540289955a36427b5cc38804485d5639e3004e7a0344542b54d126ea3f980b63fb3819e798818e6bb43d93bd7ae855d51b8bca5
+  metadata.gz: 9d65c5dfb1eb72b5dae00bf6ef11089f08ea9a2100c9641b82d0dab74d288288ecdda6f5fbba0db50c8fbf734692a44853959dfaf6c00ed432e81bce409bb24c
+  data.tar.gz: a517170cfcdad5f652805d205f22cae24e06b5db385ea5b2e567af8e23f563a736bd0e3af5c7e9f2b2b647691a5d95fa5db4337bcc369f4202a4c26dc213ddeb

data/README.md

@@ -1,4 +1,4 @@
-puppet-retrospec
+Puppet-Retrospec
 ================
 
 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.
@@ -7,11 +7,12 @@ Retrospec makes it dead simple to get started with puppet unit testing.  When yo
 and actually write some very basic rspec-puppet test code.  Thus this gem will retrofit your existing puppet module
 with everything needed to get going with puppet unit testing.
 
+The project was named retrospec because there are many times when you need to retrofit your module with spec tests.
 
 Build Status
 ============
 [![Build Status](https://travis-ci.org/logicminds/puppet-retrospec.png)](https://travis-ci.org/logicminds/puppet-retrospec)
-
+[![Gem Version](https://badge.fury.io/rb/puppet-retrospec.svg)](http://badge.fury.io/rb/puppet-retrospec)
 Install
 =============
 `gem install puppet-retrospec`  
@@ -38,38 +39,169 @@ Options:
          --template-dir, -t <s>:   Path to templates directory (only for overriding Retrospec templates)
     --enable-user-templates, -e:   Use Retrospec templates from /Users/cosman/.puppet_retrospec_templates
                      --help, -h:   Show this message
+                     
+retrospec -m ~/projects/puppet_modules/apache
+```
+
+Example
+======================
+
+Below you can see that it creates files for every resource in the tomcat module in addition to other files
+that you need for unit testing puppet code.
+
+```shell
+$ ls
+CHANGELOG.md	CONTRIBUTING.md	LICENSE		README.md	Rakefile	checksums.json	examples	manifests	metadata.json
+$ pwd
+/Users/cosman/bodeco/puppet-retrospec/spec/fixtures/modules/tomcat
+$ retrospec
+ + /Users/cosman/bodeco/puppet-retrospec/spec/fixtures/modules/tomcat/spec/
+ + /Users/cosman/bodeco/puppet-retrospec/spec/fixtures/modules/tomcat/spec/spec_helper.rb
+!! /Users/cosman/bodeco/puppet-retrospec/spec/fixtures/modules/tomcat/.fixtures.yml already exists and differs from template
+ + /Users/cosman/bodeco/puppet-retrospec/spec/fixtures/modules/tomcat/Gemfile
+ + /Users/cosman/bodeco/puppet-retrospec/spec/fixtures/modules/tomcat/spec/shared_contexts.rb
+ + /Users/cosman/bodeco/puppet-retrospec/spec/fixtures/modules/tomcat/spec/classes/
+ + /Users/cosman/bodeco/puppet-retrospec/spec/fixtures/modules/tomcat/spec/classes/tomcat_spec.rb
+ + /Users/cosman/bodeco/puppet-retrospec/spec/fixtures/modules/tomcat/spec/classes/params_spec.rb
+ + /Users/cosman/bodeco/puppet-retrospec/spec/fixtures/modules/tomcat/spec/defines/config/server/
+ + /Users/cosman/bodeco/puppet-retrospec/spec/fixtures/modules/tomcat/spec/defines/config/server/connector_spec.rb
+ + /Users/cosman/bodeco/puppet-retrospec/spec/fixtures/modules/tomcat/spec/defines/config/server/engine_spec.rb
+ + /Users/cosman/bodeco/puppet-retrospec/spec/fixtures/modules/tomcat/spec/defines/config/server/host_spec.rb
+ + /Users/cosman/bodeco/puppet-retrospec/spec/fixtures/modules/tomcat/spec/defines/config/server/service_spec.rb
+ + /Users/cosman/bodeco/puppet-retrospec/spec/fixtures/modules/tomcat/spec/defines/config/server/valve_spec.rb
+ + /Users/cosman/bodeco/puppet-retrospec/spec/fixtures/modules/tomcat/spec/defines/config/server_spec.rb
+ + /Users/cosman/bodeco/puppet-retrospec/spec/fixtures/modules/tomcat/spec/defines/instance/
+ + /Users/cosman/bodeco/puppet-retrospec/spec/fixtures/modules/tomcat/spec/defines/instance/package_spec.rb
+ + /Users/cosman/bodeco/puppet-retrospec/spec/fixtures/modules/tomcat/spec/defines/instance/source_spec.rb
+ + /Users/cosman/bodeco/puppet-retrospec/spec/fixtures/modules/tomcat/spec/defines/instance_spec.rb
+ + /Users/cosman/bodeco/puppet-retrospec/spec/fixtures/modules/tomcat/spec/defines/service_spec.rb
+ + /Users/cosman/bodeco/puppet-retrospec/spec/fixtures/modules/tomcat/spec/defines/setenv/
+ + /Users/cosman/bodeco/puppet-retrospec/spec/fixtures/modules/tomcat/spec/defines/setenv/entry_spec.rb
+ + /Users/cosman/bodeco/puppet-retrospec/spec/fixtures/modules/tomcat/spec/defines/war_spec.rb
+ 
+```
+
+Looking at the file we can see that it did a lot of work for us.
+Below is the classes/tomcat_spec.rb file  
+   
+```ruby
+require 'spec_helper'
+require 'shared_contexts'
+   describe 'tomcat' do
+       # by default the hiera integration is commented out
+       # 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
+       # 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
+         {
+          #:catalina_home => $::tomcat::params::catalina_home,
+          #:user => $::tomcat::params::user,
+          #:group => $::tomcat::params::group,
+          #:install_from_source => true,
+          #:purge_connectors => false,
+          #:manage_user => true,
+          #:manage_group => true,
+         }
+       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)
+       it { should compile }
+   end
 
 ```
 
+About the test suite
+======================
+At this time the test suite that is automatically generated is extremely basic.  Essentially it just ensures that your
+code will compile correctly.  However, one of the major stumbling blocks is just constructing everything in the spec 
+directory which retrospec does for you automatically.  Its now up to you to further enhance your test suite with more
+tests and conditional logic.  For now you will probably want to read up on the following documentation:
+
+* [Puppet Rspec](http://rspec-puppet.com)
+* [Puppet spec helper](https://github.com/puppetlabs/puppetlabs_spec_helper/blob/master/README.markdown)
+
+
 How Does it do this
 =======================
-Basically Retrospec uses the puppet lexer to scan your code in order to fill out some basic templates that will retrofit
+Basically Retrospec uses the puppet lexer and parser to scan your code in order to fill out some basic templates that will retrofit
 your puppet module with unit tests.
 
 Overriding the templates
 =======================
 There may be a time when you want to override the default templates used to generate the rspec related files.
-To override these templates just set the following environment variables.  Once one of the variables is set
-the first run will copy over the templates from the gem location.  If you have already created the file, then
-puppet-retrospec will not overwrite the file.  You can set multiple template path if you use them for 
-different projects so just be sure the set the correctly template path.
+To override these templates just set **one** of the following environment variables.
+  
+```shell
+RETROSPEC_ENABLE_LOCAL_TEMPLATES=true
+RETROSPEC_TEMPLATES_PATH=~/my_templates
+
+```
+
+Once one of the variables is set the retrospec will copy over all the templates from the gem location to the default 
+or specified override templates path.
+If you have already created the a erb file in the templates location, then puppet-retrospec will not overwrite the file.
+You can set multiple template paths if you use them for different projects so just be sure the set the correctly
+template path environment variable when running retrospec.
 
 Setting the `RETROSPEC_ENABLE_LOCAL_TEMPLATES=true` Environment variable will tell retrospec to use the default user template location.
 
-The default override location for the templates is ~/.puppet_retrospec_templates
+The default location for the templates when using this variable is ~/.puppet_retrospec_templates
 
-If you wish to override the default template location you can use the following environment variable RETROSPEC_TEMPLATES_PATH.
+If you wish to override ~/.puppet_retrospec_templates location you can use the following environment variable 
+RETROSPEC_TEMPLATES_PATH.
 If you set this variable you are not required set RETROSPEC_ENABLE_LOCAL_TEMPLATES.
 
 `RETROSPEC_TEMPLATES_PATH=~/my_templates`
 
+Troubleshooting
+===============
+If you see the following, this error means that you need to add a fixture to the fixtures file.
+At this time I have no idea what your module requires.  So just add the module that this class belongs to 
+in the .fixtures file.
+
+See [fixtures doc](https://github.com/puppetlabs/puppetlabs_spec_helper#using-fixtures) for more information
+
+```shell
+8) tomcat::instance::source
+     Failure/Error: it { should compile }
+     Puppet::Error:
+       Could not find class staging for coreys-macbook-pro-2.local on node coreys-macbook-pro-2.local
+     # ./spec/defines/instance/source_spec.rb:34:in `block (2 levels) in <top (required)>'
+```
+
+Running Tests
+=============
+Puppet-retrospec tests its code against real modules downloaded directly from puppet forge. 
+We also do a little mocking as well but for the majority of the tests we download are 'fixtures'.
+
+To run a clean test suite and re-download you must run with environment variable set
+```
+RETROSPEC_CLEAN_UP_TEST_MODULES=true bundle exec rake spec 
+```
+
+Otherwise to save time we skip the removal of test puppet modules therefore we don't re-download
+```
+bundle exec rake spec
+```
+
 Todo
 ============
-- Add support to fill out the params in unit tests automatically
 - Add support to fill out used facts in the unit tests automatically
 - Add describe blocks around conditions in test code that change the catalog compilation
 - Auto add dependicies to fixtures file
 
 Support
 ============
-Currently this library only supports ruby >= 1.9.3.  There is currently a bug with ruby version 1.8.7.
+Currently this library only supports ruby >= 1.9.3.  It might work on 1.8.7 but I won't support if it fails.

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/lib/helpers.rb

@@ -2,37 +2,6 @@ require 'fileutils'
 
 class Helpers
 
-
-  def self.run(module_name=nil)
-    unless is_module_dir?
-      $stderr.puts "Does not appear to be a Puppet module.  Aborting"
-      return false
-    end
-
-    if module_name.nil?
-      module_name = get_module_name
-      if module_name.nil?
-        $stderr.puts "Unable to determine module name.  Aborting"
-        return false
-      end
-    end
-
-    [
-        'spec',
-        'spec/classes',
-        'spec/defines',
-        'spec/functions',
-        'spec/unit', 'spec/unit/facter', 'spec/unit/puppet', 'spec/unit/puppet/type', 'spec/unit/puppet/provider',
-        'spec/hosts',
-    ].each { |dir| safe_mkdir(dir) }
-
-
-    safe_create_spec_helper
-    safe_create_fixtures_file
-    safe_create_resource_spec_files
-    safe_make_shared_context
-  end
-
   def self.get_module_name
     module_name = nil
     Dir["manifests/*.pp"].entries.each do |manifest|
@@ -56,8 +25,8 @@ class Helpers
     module_name
   end
 
-  def self.is_module_dir?
-    Dir["*"].entries.include? "manifests"
+  def self.is_module_dir?(dir)
+    Dir[File.join(dir,"*")].entries.include? "manifests"
   end
 
   def self.safe_mkdir(dir)
@@ -98,10 +67,10 @@ class Helpers
   # creates and syncs the specifed user template diretory
   # returns: user_template_dir
   def self.setup_user_template_dir(user_template_directory=nil)
-     if user_template_directory.nil?
-       user_template_directory = default_user_template_dir
-     end
-     sync_user_template_dir(create_user_template_dir(user_template_directory))
+    if user_template_directory.nil?
+      user_template_directory = default_user_template_dir
+    end
+    sync_user_template_dir(create_user_template_dir(user_template_directory))
   end
 
   def self.default_user_template_dir

data/lib/puppet-retrospec.rb

@@ -5,35 +5,102 @@ require 'fileutils'
 
 class Retrospec
   attr_reader :included_declarations
-  attr_reader :classes_and_defines
-  attr_reader :module_name
-  attr_reader :modules_included
-  attr_accessor :default_path
-  attr_accessor :manifest_files
+  attr_reader :module_path
+  attr_reader :tmp_module_path
   attr_accessor :default_modules
-  attr_accessor :template_dir
-
+  attr_accessor :facts_used
 
+  # module path is the relative or absolute path to the module that should retro fitted
   def initialize(path=nil, default_template_dir=ENV['RETROSPEC_TEMPLATES_PATH'])
     # user supplied a template path or user wants to use local templates
     if not default_template_dir.nil? or ENV['RETROSPEC_ENABLE_LOCAL_TEMPLATES'] =~ /true/i
       default_template_dir = Helpers.setup_user_template_dir(default_template_dir)
     end
-    @default_path = path
-    @default_modules = ['stdlib']
+    @module_path = validate_module_dir(path)
     @template_dir = default_template_dir
-    module_name
-    modules_included
+    tmp_module_path
+  end
+
+  def default_modules
+    @default_modules ||= ['stdlib']
   end
 
   def create_files
     safe_create_spec_helper
     safe_create_fixtures_file
     safe_create_gemfile
-    manifest_files.each do |file|
-      safe_create_resource_spec_files(file)
-    end
+    safe_create_rakefile
     safe_make_shared_context
+    types.each do |type|
+      safe_create_resource_spec_files(type)
+    end
+    FileUtils.remove_entry_secure tmp_modules_dir  # ensure we remove the temporary directory
+    true
+  end
+
+  def safe_create_rakefile(template='rakefile.erb')
+    safe_create_template_file('Rakefile', template)
+  end
+
+  def safe_make_shared_context(template='shared_context.erb')
+    safe_create_template_file(File.join('spec','shared_contexts.rb'), template)
+  end
+
+  def safe_create_fixtures_file(template='fixtures_file.erb')
+    safe_create_template_file('.fixtures.yml', template)
+  end
+
+  def safe_create_spec_helper(template='spec_helper_file.erb')
+    safe_create_template_file(File.join('spec','spec_helper.rb'), template)
+  end
+
+  def safe_create_gemfile(template='gemfile.erb')
+    safe_create_template_file('Gemfile', template)
+  end
+
+  def safe_create_template_file(path, template)
+    # check to ensure parent directory exists
+    file_dir_path = File.expand_path(File.join(module_path,File.dirname(path)))
+    if ! File.exists?(file_dir_path)
+      Helpers.safe_mkdir(file_dir_path)
+    end
+    template_path = File.join(template_dir, template)
+    File.open(template_path) do |file|
+      renderer = ERB.new(file.read, 0, '-')
+      content = renderer.result binding
+      dest_path = File.expand_path(File.join(module_path,path))
+      Helpers.safe_create_file(dest_path, content)
+    end
+  end
+
+  def types
+    @types ||= search_module || []
+  end
+
+  # puts a symlink in that module directory that points back to the user supplied module path
+  def tmp_module_path
+    if @tmp_module_path.nil?
+      # create a link where source is the current repo and dest is /tmp/modules/module_name
+      path = File.join(tmp_modules_dir, module_name)
+      FileUtils.ln_s(module_path, path)
+      @tmp_module_path = path
+    end
+    @tmp_module_path
+  end
+
+  def module_name
+    @module_name ||= File.basename(module_path)
+  end
+
+  # creates a tmp module directory so puppet can work correctly
+  def tmp_modules_dir
+    if @modules_dir.nil?
+      dir = Dir.mktmpdir
+      tmp_modules_path = File.expand_path(File.join(dir, 'modules'))
+      FileUtils.mkdir_p(tmp_modules_path)
+      @modules_dir = tmp_modules_path
+    end
+    @modules_dir
   end
 
   # pass in either the path to the module directory
@@ -48,15 +115,12 @@ class Retrospec
     spec.create_files
   end
 
-  def safe_create_gemfile(template='gemfile.erb')
-    safe_create_template_file('Gemfile', template)
-  end
-
   # if user doesn't supply template directory we assume we should use the templates in this gem
   def template_dir
     @template_dir ||= Helpers.gem_template_dir
   end
 
+
   def modules_included
     @modules_included ||= default_modules + referenced_modules
   end
@@ -65,169 +129,111 @@ class Retrospec
     []
   end
 
-  def module_name
-    @module_name ||= Helpers.get_module_name
-  end
-
-  def manifest_files
-    if @manifest_files.nil?
-      # first check to see if manifests directory even exists when path is nil
-      if default_path.nil?
-        raise 'No manifest directory' if ! File.exist?('manifests')
-        @default_path = 'manifests/**/*.pp'
-      # check to see if at least one of the files given is a pp file
-      # remove any non pp files
-      elsif default_path.instance_of?(Array)
-         data = default_path.find_all { |file| File.extname(file) == '.pp' }
-         if data.length < 1
-           raise "No valid puppet manifests given"
-         end
-         @default_path = data
-      # this should be a module directory which would have a manifests directory
-      elsif Dir.exist?(File.expand_path(default_path))
-        raise 'No manifest directory' if ! File.exist?(File.expand_path(File.join(default_path, 'manifests')))
-        @default_path = File.join(default_path, 'manifests/**/*.pp')
-      else
-        path = File.expand_path(default_path)
-        raise "File does not exist at path #{path}" if ! File.exist?(path)
-        raise 'Not a puppet manifest file' if File.extname(path) != '.pp'
-      end
-      @manifest_files = Dir.glob(default_path)
-
+  # processes a directory and expands to its full path, assumes './'
+  # returns the validated dir
+  def validate_module_dir(dir)
+    # first check to see if manifests directory even exists when path is nil
+    if dir.nil?
+      dir = '.'
+    elsif dir.instance_of?(Array)
+      raise "Retrospec - an array of moudule paths is not supported at this time"
     end
-    @manifest_files
-  end
-
-  def classes_and_defines(file)
-      @classes_and_defines = []
-      # for each file we are going to use the puppet lexer to find the class or define
-      resources = []
-      p = Puppet::Parser::Lexer.new
-      p.string = File.read(file)
-      tokens = p.fullscan
-      tokens.each do | token|
-        if [:CLASS, :DEFINE].include? token.first
-          k = tokens.index { |token| [:NAME].include? token.first }
-          # there is some sort of ordering bug here with ruby 1.8.7 and I have to modify the code like below
-          # to get it working. I think its this index method above
-          # TODO make this work with ruby versions 1.8.7 and above
-          #resources.push({:type_name => tokens[k-1].last[:value], :name => token.last[:value] })
-          resources.push({:type_name => token.last[:value] , :name => tokens[k].last[:value] })
-        end
-      end
-      # sometimes the manifest can be blank and not include a class or define statement
-      if resources.length > 0
-        @classes_and_defines.push({:filename => File.basename(file, '.pp'), :types => resources })
-      end
-    @classes_and_defines
-  end
-
-  # finds all the included resources so we can test and depend on in the fixtures file
-  def included_declarations(file)
-    @included_declarations = {}
-    includes = []
-    p = Puppet::Parser::Lexer.new
-    p.string = File.read(file)
-    tokens = p.fullscan
-    k = 0
-    typename = nil
-    tokens.each do | token|
-      next if not token.last.is_a?(Hash)
-      if typename.nil? and [:CLASS, :DEFINE].include? token.first
-        j = tokens.index { |token| [:NAME].include? token.first }
-        typename = tokens[j].last[:value]
-      end
-      if token.last.fetch(:value, nil) == 'include'
-        key = token.last[:value]
-        value = tokens[k + 1].last[:value]
-        includes << value
-      end
-      k = k + 1
+    dir = File.expand_path(dir)
+    manifest_dir = File.join(dir,'manifests')
+    if ! File.exist?(manifest_dir)
+      raise "No manifest directory in #{manifest_dir}, cannot validate this is a module"
+    else
+      files = Dir.glob("#{manifest_dir}/**/*.pp")
+      warn 'No puppet manifest files found at #' if files.length < 1
     end
-    @included_declarations[typename] = includes
-    @included_declarations
+    dir
   end
 
+  # finds all the included resources so we can test and depend on in the fixtures file
+  # def included_declarations(file)
+  #   @included_declarations = {}
+  #   includes = []
+  #   p = Puppet::Parser::Lexer.new
+  #   p.string = File.read(file)
+  #   tokens = p.fullscan
+  #   k = 0
+  #   typename = nil
+  #   tokens.each do | token|
+  #     next if not token.last.is_a?(Hash)
+  #     if typename.nil? and [:CLASS, :DEFINE].include? token.first
+  #       j = tokens.index { |token| [:NAME].include? token.first }
+  #       typename = tokens[j].last[:value]
+  #     end
+  #     if token.last.fetch(:value, nil) == 'include'
+  #       key = token.last[:value]
+  #       value = tokens[k + 1].last[:value]
+  #       includes << value
+  #     end
+  #     k = k + 1
+  #   end
+  #   @included_declarations[typename] = includes
+  #   @included_declarations
+  # end
 
-  def safe_make_shared_context(template='shared_context.erb')
-    safe_create_template_file('spec/shared_contexts.rb', template)
-  end
-
-  # Gets all the classes and define types from all the files in the manifests directory
   # Creates an associated spec file for each type and even creates the subfolders for nested classes one::two::three
-  def safe_create_resource_spec_files(manifest_file,template='resource_spec_file.erb')
+  def safe_create_resource_spec_files(type,template='resource_spec_file.erb')
     classes_dir = 'spec/classes'
     defines_dir = 'spec/defines'
-    classes_and_defines(manifest_file).each do |value|
-      types = value[:types]
-      types.each do |type|
-        # run template
-        tokens = type[:name].split('::')
-        if type[:type_name] == 'class'
-          type_dir_name = classes_dir
-        else
-          type_dir_name = defines_dir
-        end
-        file_name = tokens.pop  # the last item should be the filename
-        # if there are only two tokens ie. tomcat::params we dont need to create a subdirectory
-        if tokens.count > 1
-          # this is a deep level resource ie. tomcat::config::server::connector
-          # however we don't need the tomcat directory so we can just remove it
-          # this should leave us with config/server/connector_spec.rb
-          tokens.delete_at(0)
-          # so lets make a directory structure out of it
-          dir_name = File.join(tokens)  # config/server
-          dir_name = File.join(type_dir_name,dir_name) # spec/classes/tomcat/config/server
-          safe_create_template_file(File.join(dir_name,"#{file_name}_spec.rb"), template)
-        else
-          safe_create_template_file(File.join(type_dir_name,"#{file_name}_spec.rb"), template)
-        end
-      end
+    hosts_dir   = 'spec/hosts'
+    @parameters = type.arguments
+    @type = type
+    case type.type
+      when :hostclass
+        type_dir_name = classes_dir
+      when :definition
+        type_dir_name = defines_dir
+      else
+        raise "#{type.type} is not a supported resource type yet"
+    end
+    tokens = type.name.split('::')
+    file_name = tokens.pop  # the last item should be the filename
+    # if there are only two tokens ie. tomcat::params we dont need to create a subdirectory
+    if tokens.count > 1
+      # this is a deep level resource ie. tomcat::config::server::connector
+      # however we don't need the tomcat directory so we can just remove it
+      # this should leave us with config/server/connector_spec.rb
+      tokens.delete_at(0)
+      # so lets make a directory structure out of it
+      dir_name = File.join(tokens)  # config/server
+      dir_name = File.join(type_dir_name,dir_name) # spec/classes/tomcat/config/server
+      safe_create_template_file(File.join(dir_name,"#{file_name}_spec.rb"), template)
+    else
+      safe_create_template_file(File.join(type_dir_name,"#{file_name}_spec.rb"), template)
     end
   end
 
-  def safe_create_fixtures_file(template='fixtures_file.erb')
-    safe_create_template_file('.fixtures.yml', template)
+  def request(key, method)
+    instance = Puppet::Indirector::Indirection.instance(:resource_type)
+    indirection_name = 'test'
+    @request = Puppet::Indirector::Request.new(indirection_name, method, key, instance)
+    @request.environment = puppet_environment
+    @request
   end
 
-  def safe_create_spec_helper(template='spec_helper_file.erb')
-    safe_create_template_file('spec/spec_helper.rb', template)
+  def resource_type_parser
+    @resource_type_parser ||= Puppet::Indirector::ResourceType::Parser.new
   end
 
-  def safe_create_template_file(path, template)
-    # check to ensure parent directory exists
-    file_dir_path = File.expand_path(File.join(module_dir,File.dirname(path)))
-    if ! File.exists?(file_dir_path)
-      Helpers.safe_mkdir(file_dir_path)
-    end
-    template_path = File.join(template_dir, template)
-    File.open(template_path) do |file|
-      renderer = ERB.new(file.read, 0, '-')
-      content = renderer.result binding
-      Helpers.safe_create_file(File.expand_path(File.join(module_dir,path)), content)
-    end
-
+  # creates a puppet environment given a module path and environment name
+  def puppet_environment
+    @puppet_environment ||= Puppet::Node::Environment.create('production', [tmp_modules_dir])
   end
 
-  # calculates where the spec directory is by going one directory back from manifests directory
-  def module_dir
-    @spec_dir ||= File.join(File.dirname(manifest_dir))
+  # returns the resource type ofject given a resource name ie. tomcat::connector
+  def find_resource(resource_name)
+    request = request(resource_name, 'find')
+    resource_type_parser.find(request)
   end
 
-  def manifest_dir
-    # look and compare, then get basename, loop till found
-    if @manifest_dir.nil?
-      file = manifest_files.first
-      file.split(File::SEPARATOR).each do |part|
-        filename = File.basename(file)
-        if filename != 'manifests'
-          file = File.dirname(file)
-        else
-          @manifest_dir = file
-        end
-      end
-    end
-    @manifest_dir
+  # returns the resource types found in the module
+  def search_module(pattern='*')
+    request = request(pattern, 'search')
+    resource_type_parser.search(request)
   end
 
 end

data/lib/templates/fixtures_file.erb

@@ -4,4 +4,5 @@ fixtures:
     repositories:
       stdlib:
         repo: https://github.com/puppetlabs/puppetlabs-stdlib.git
-        ref: 4.3.2
+        ref: 4.3.2
+    forge_modules:

data/lib/templates/rakefile.erb

@@ -0,0 +1 @@
+require 'bodeco_module_helper/rake_tasks'

data/lib/templates/resource_spec_file.erb

@@ -1,25 +1,40 @@
 require 'spec_helper'
 require 'shared_contexts'
 
-<% @classes_and_defines.each do | value |  -%>
-<% types = value[:types]  -%>
-<% types.each do |type| -%>
-<% tname = type[:name] -%>
-describe '<%= tname %>' do
+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_name] == 'define' -%>
+
+    <%- if @type.type == :definition -%>
     let(:title) { 'example_name' }
-<% end -%>
+    <%- 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 to enable puppet and hiera debug mode
+    # 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)
     it { should compile }
-<% end -%>
-end
-<% end -%>
+end

data/lib/templates/shared_context.erb

@@ -5,6 +5,12 @@ hiera_config_file = File.expand_path(File.join(File.dirname(__FILE__), '..','dat
 
 # hiera_file and hiera_data are mutally exclusive contexts.
 
+shared_context :hiera do
+    # example only,
+    let(:hiera_data) do
+        {:some_key => "some_value" }
+    end
+end
 
 shared_context :linux_hiera do
     # example only,

data/puppet-retrospec.gemspec

@@ -2,23 +2,22 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: puppet-retrospec 0.2.0 ruby lib
+# stub: puppet-retrospec 0.3.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "puppet-retrospec"
-  s.version = "0.2.0"
+  s.version = "0.3.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-12"
+  s.date = "2014-11-14"
   s.description = "Retrofits and generates valid puppet rspec test code to existing modules"
   s.email = "corey@logicminds.biz"
   s.executables = ["retrospec"]
   s.extra_rdoc_files = [
     "LICENSE",
-    "README.md",
-    "README.rdoc"
+    "README.md"
   ]
   s.files = [
     ".document",
@@ -27,7 +26,6 @@ Gem::Specification.new do |s|
     "Gemfile",
     "LICENSE",
     "README.md",
-    "README.rdoc",
     "Rakefile",
     "VERSION",
     "bin/retrospec",
@@ -35,13 +33,14 @@ Gem::Specification.new do |s|
     "lib/puppet-retrospec.rb",
     "lib/templates/fixtures_file.erb",
     "lib/templates/gemfile.erb",
+    "lib/templates/rakefile.erb",
     "lib/templates/resource_spec_file.erb",
     "lib/templates/shared_context.erb",
     "lib/templates/spec_helper_file.erb",
     "puppet-retrospec.gemspec",
+    "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/fixtures/manifests/not_a_resource_defination.pp",
     "spec/spec_helper.rb",
     "spec/unit/puppet-retrospec_spec.rb"
   ]

data/spec/spec_helper.rb

@@ -10,12 +10,20 @@ def fixtures_path
   @fixtures_path ||= File.expand_path(File.join(File.dirname(__FILE__), 'fixtures'))
 end
 
+def clean_up_spec_dir(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 install_module(module_name)
   FileUtils.mkdir_p(fixture_modules_path)
-  puts "Downloading modules to fixtures directory"
-  `puppet module install -i #{fixture_modules_path} #{module_name}`
-  Dir.glob('spec/fixtures/modules/**/spec').each do |dir|
-    FileUtils.rm_rf(dir)
+  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)
   end
 end
 

data/spec/unit/puppet-retrospec_spec.rb

@@ -2,25 +2,34 @@ require 'spec_helper'
 require 'puppet-retrospec'
 require 'helpers'
 require 'fakefs/safe'
-require 'pry'
 
 describe "puppet-retrospec" do
   after :all do
-    #FileUtils.rm_rf(fixture_modules_path)
+    # 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')
+
   end
 
   before :each do
-    @retro = Retrospec.new(Dir.glob('spec/fixtures/manifests/*.pp'))
     ENV['RETROSPEC_ENABLE_LOCAL_TEMPLATES'] = nil
     ENV['RETROSPEC_TEMPLATES_PATH'] = nil
-
+    clean_up_spec_dir(@path)
 
   end
 
-  it 'should run without errors' do
-    install_module('puppetlabs-tomcat')
-    tomcat = Retrospec.new('spec/fixtures/modules/tomcat')
-    tomcat.create_files
+  it 'should run without errors using new' do
+    tomcat = Retrospec.new(@path)
+    expect(tomcat.create_files).to eq(true)
+    expect(File.exists?(File.join(@path, 'Gemfile'))).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)
   end
 
   it 'should create a local templates directory when flag is on' do
@@ -48,7 +57,7 @@ describe "puppet-retrospec" do
     ENV['RETROSPEC_TEMPLATES_PATH'] = nil
   end
 
-  it 'should create and use the user supplied templates directory when variable is set' do
+  it 'should create the user supplied templates directory when variable is set' do
     ENV['RETROSPEC_TEMPLATES_PATH'] = '/tmp/my_templates'
     FakeFS do
       FileUtils.mkdir_p(Helpers.gem_template_dir)
@@ -62,7 +71,6 @@ describe "puppet-retrospec" do
       r = Retrospec.new('/modules/tomcat')
       user_directory = r.template_dir
       expect(user_directory).to eq('/tmp/my_templates')
-      r.create_files
       expect(File.exists?(user_directory)).to eq(true)
       expect(File.exists?(File.join(user_directory, 'fixtures_file.erb'))).to eq(true)
       expect(File.exists?(File.join(user_directory, 'gemfile.erb'))).to eq(true)
@@ -72,90 +80,110 @@ describe "puppet-retrospec" do
     end
     ENV['RETROSPEC_ENABLE_LOCAL_TEMPLATES'] = nil
     ENV['RETROSPEC_TEMPLATES_PATH'] = nil
-  end
-
-  it 'manifest path is calculated correctly' do
-    @retro.manifest_dir.should eq('spec/fixtures/manifests')
-  end
-
-  it 'should return a list of files' do
-    @retro.manifest_files.length.should == 3
-  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 class names' do
-    # ie. [{:filename=>"includes-class", :types=>[{:type_name=>"class", :name=>"includes-class"}]}]
-    classes = @retro.classes_and_defines('spec/fixtures/manifests/includes-class.pp')
-    types = classes.first[:types]
-    types.first[:type_name].should eq('class')
-    types.first[:name].should eq("includes-class")
-  end
-
-  it 'should retrieve 0 defines or classes' do
-    my_retro = Retrospec.new('spec/fixtures/manifests/not_a_resource_defination.pp')
-    classes = my_retro.classes_and_defines('spec/fixtures/manifests/not_a_resource_defination.pp')
-    classes.count.should == 0
-  end
-
-  it 'should not create any files when 0 resources exists' do
-    my_retro = Retrospec.new('spec/fixtures/manifests/not_a_resource_defination.pp')
-    my_retro.safe_create_resource_spec_files(my_retro.manifest_files.first)
-  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 'should create proper spec helper file' do
-    filepath = File.expand_path(File.join(fixtures_path, 'spec/spec_helper.rb'))
-    Helpers.should_receive(:safe_create_file).with(filepath,anything).once
-    @retro.safe_create_spec_helper('spec_helper_file.erb')
-
+    tomcat = Retrospec.new(@path)
+    filepath = File.expand_path(File.join(@path, 'spec', 'spec_helper.rb'))
+    path = tomcat.tmp_module_path
+    tomcat.safe_create_spec_helper
+    expect(File.exists?(filepath)).to eq(true)
   end
 
-  it 'should return the correct module name' do
-    Helpers.should_receive(:get_module_name).and_return('mymodule')
-    @retro.module_name.should eq('mymodule')
+  it 'should create proper shared context file' do
+    tomcat = Retrospec.new(@path)
+    filepath = File.expand_path(File.join(@path, 'spec', 'shared_contexts.rb'))
+    path = tomcat.tmp_module_path
+    tomcat.safe_make_shared_context
+    expect(File.exists?(filepath)).to eq(true)
   end
 
-  it 'should create proper fixtures file' do
-    filepath = File.expand_path(File.join(fixtures_path, '.fixtures.yml'))
-    Helpers.should_receive(:safe_create_file).with(filepath,anything).once
-    @retro.safe_create_fixtures_file('fixtures_file.erb')
-
-  end
-
-  it 'included_declarations should not be nil' do
-    @retro.included_declarations(@retro.manifest_files.first).length.should >= 1
+  it 'should create Gemfile file' do
+    tomcat = Retrospec.new(@path)
+    filepath = File.expand_path(File.join(@path, 'Gemfile'))
+    tomcat.safe_create_gemfile
+    expect(File.exists?(filepath)).to eq(true)
   end
 
-  it 'classes_and_defines should not be nil' do
-    @retro.classes_and_defines(@retro.manifest_files.first).length.should >= 1
+  it 'should create Rakefile file' do
+    tomcat = Retrospec.new(@path)
+    filepath = File.expand_path(File.join(@path, 'Rakefile'))
+    tomcat.safe_create_rakefile
+    expect(File.exists?(filepath)).to eq(true)
   end
 
-  it 'module_name should not be nil' do
-    Helpers.should_receive(:get_module_name).and_return('mymodule')
-    @retro.module_name.should_not be_nil
+  it 'should create proper fixtures file' do
+    filepath = File.expand_path(File.join(@path,'.fixtures.yml'))
+    FileUtils.rm_f(filepath)  # ensure we have a clean state
+    tomcat = Retrospec.new(@path)
+    tomcat.safe_create_fixtures_file
+    expect(File.exists?(filepath)).to eq(true)
   end
 
-  it 'modules_included should not be nil' do
-    @retro.modules_included.length.should eq(1)
-  end
+  it 'should not create any files when 0 resources exists' do
+    my_path = File.expand_path(File.join('spec', 'fixtures', 'fixture_modules', 'zero_resource_module'))
+    my_retro = Retrospec.new(my_path)
+    Helpers.should_not_receive(:safe_create_file).with(anything,'resource_spec_file.erb')
+  end
+
+  it 'should create a temp modules dir' do
+    tomcat = Retrospec.new(@path)
+    path = tomcat.tmp_modules_dir
+    path.should =~ /modules/
+  end
+
+  it 'should create a link in the temp modules directory' do
+    tomcat = Retrospec.new(@path)
+    path = tomcat.tmp_modules_dir
+    tomcat.tmp_module_path
+    File.exists?(tomcat.tmp_module_path).should eq(true)
+    tomcat.tmp_module_path.should eq(File.join(path, tomcat.module_name))
+  end
+
+  it 'should create a file from a template' do
+    tomcat = Retrospec.new(@path)
+    tomcat.safe_create_template_file('.fixtures.yml', 'fixtures_file.erb')
+    file_path = File.join(@path,'.fixtures.yml')
+    expect(File.exists?(file_path)).to eq(true)
+  end
+
+  # it 'should contain a list of parameters in the test' do
+  #   tomcat = Retrospec.new(@path)
+  #   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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-retrospec
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Corey Osman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-12 00:00:00.000000000 Z
+date: 2014-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet
@@ -144,7 +144,6 @@ extensions: []
 extra_rdoc_files:
 - LICENSE
 - README.md
-- README.rdoc
 files:
 - .document
 - .rspec
@@ -152,7 +151,6 @@ files:
 - Gemfile
 - LICENSE
 - README.md
-- README.rdoc
 - Rakefile
 - VERSION
 - bin/retrospec
@@ -160,13 +158,14 @@ files:
 - lib/puppet-retrospec.rb
 - lib/templates/fixtures_file.erb
 - lib/templates/gemfile.erb
+- lib/templates/rakefile.erb
 - lib/templates/resource_spec_file.erb
 - lib/templates/shared_context.erb
 - lib/templates/spec_helper_file.erb
 - puppet-retrospec.gemspec
+- 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/fixtures/manifests/not_a_resource_defination.pp
 - spec/spec_helper.rb
 - spec/unit/puppet-retrospec_spec.rb
 homepage: http://github.com/logicminds/puppet-retrospec

data/README.rdoc

@@ -1,19 +0,0 @@
-= puppet-retrospec2
-
-Description goes here.
-
-== Contributing to puppet-retrospec2
- 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
-* Fork the project.
-* Start a feature/bugfix branch.
-* Commit and push until you are happy with your contribution.
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-
-== Copyright
-
-Copyright (c) 2013 Corey Osman. See LICENSE.txt for
-further details.
-