puppet-retrospec 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 027977cdd2e60766923d0d8c013efb9beafcff28
+  data.tar.gz: 1652ba814a16849574a492e2f06c917829625416
+SHA512:
+  metadata.gz: 81ab8cff8a124a17b60d2dfe2c3ea50a467a58fe30aaedc3d10791f23328cb68a32fa31efb93298d699d879cfacb3401bc5de9412b59678ecf6f7f12822b6914
+  data.tar.gz: 70a98a402f0a993551fd46c81540289955a36427b5cc38804485d5639e3004e7a0344542b54d126ea3f980b63fb3819e798818e6bb43d93bd7ae855d51b8bca5

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,28 @@
+branches:
+  only:
+    - master
+    - development
+language: ruby
+script: "bundle exec rake spec SPEC_OPTS='--format documentation'"
+rvm:
+- 1.9.3
+- 2.0.0
+- 2.1.3
+env:
+  matrix:
+    - PUPPET_GEM_VERSION="~> 2.7"
+    - PUPPET_GEM_VERSION="~> 3.2"
+    - PUPPET_GEM_VERSION="~> 3.6"
+    - PUPPET_GEM_VERSION="~> 3.7"
+
+matrix:
+  exclude:
+    - rvm: 1.9.3
+      env: PUPPET_GEM_VERSION="~> 2.7"
+    - rvm: 2.0.0
+      env: PUPPET_GEM_VERSION="~> 2.7"
+    - rvm: 2.1.3
+      env: PUPPET_GEM_VERSION="~> 2.7"
+notifications:
+  email: corey@logicminds.biz
+

data/Gemfile

@@ -0,0 +1,21 @@
+source "http://rubygems.org"
+
+if puppetversion = ENV['PUPPET_GEM_VERSION']
+  gem 'puppet', puppetversion, :require => false
+else
+  gem 'puppet', :require => false
+  end
+
+gem 'trollop'
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.14"
+  gem "yard", "~> 0.7"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0"
+  gem "jeweler"
+  gem 'pry'
+  gem "fakefs", :require => "fakefs/safe"
+
+end

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Corey Osman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,75 @@
+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.
+
+Retrospec makes it dead simple to get started with puppet unit testing.  When you run retrospec will scan you puppet manifests
+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.
+
+
+Build Status
+============
+[![Build Status](https://travis-ci.org/logicminds/puppet-retrospec.png)](https://travis-ci.org/logicminds/puppet-retrospec)
+
+Install
+=============
+`gem install puppet-retrospec`  
+
+
+How to use
+=============
+Run from a rake task
+```
+require 'puppet-retrospec'
+
+desc "Scans the module directory and automatically creates basic spec tests"
+task :retrospec do
+  Retrospec.run
+end
+
+```
+
+Run from the command line
+```
+$ retrospec -h
+Options:
+          --module-path, -m <s>:   destination directory to create spec tests in (Defaults to current directory)
+         --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
+
+```
+
+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
+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.
+
+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
+
+If you wish to override the default template 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`
+
+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.

data/README.rdoc

@@ -0,0 +1,19 @@
+= 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.
+

data/Rakefile

@@ -0,0 +1,37 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "puppet-retrospec"
+  gem.homepage = "http://github.com/logicminds/puppet-retrospec"
+  gem.license = "MIT"
+  gem.summary = %Q{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.}
+  gem.description = %Q{Retrofits and generates valid puppet rspec test code to existing modules}
+  gem.email = "corey@logicminds.biz"
+  gem.authors = ["Corey Osman"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb'].exclude('spec/fixtures/**/*_spec.rb')
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/bin/retrospec

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+require 'trollop'
+require 'puppet-retrospec'
+
+opts = Trollop::options do
+  opt :module_path, "destination directory to create spec tests in (Defaults to current directory) " ,
+      :type => :string, :required => false, :default => nil
+  opt :template_dir, "Path to templates directory (only for overriding Retrospec templates)", :type => :string,
+      :required => false, :default => nil
+  opt :enable_user_templates, "Use Retrospec templates from #{File.expand_path('~/.puppet_retrospec_templates')}",
+      :require => false, :type => :boolean
+end
+ENV['RETROSPEC_ENABLE_LOCAL_TEMPLATES'] = 'true' if opts[:enable_user_templates]
+ENV['RETROSPEC_TEMPLATES_PATH'] = opts[:template_dir] if not opts[:template_dir].nil?
+Retrospec.run(opts[:module_path])

data/lib/helpers.rb

@@ -0,0 +1,152 @@
+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|
+      module_name = get_module_name_from_file(manifest)
+      break unless module_name.nil?
+    end
+    module_name
+  end
+
+  def self.get_module_name_from_file(file)
+    p = Puppet::Parser::Lexer.new
+    module_name = nil
+    p.string = File.read(file)
+    tokens = p.fullscan
+
+    i = tokens.index { |token| [:CLASS, :DEFINE].include? token.first }
+    unless i.nil?
+      module_name = tokens[i + 1].last[:value].split('::').first
+    end
+
+    module_name
+  end
+
+  def self.is_module_dir?
+    Dir["*"].entries.include? "manifests"
+  end
+
+  def self.safe_mkdir(dir)
+    if File.exists? dir
+      unless File.directory? dir
+        $stderr.puts "!! #{dir} already exists and is not a directory"
+      end
+    else
+      FileUtils.mkdir_p dir
+      puts " + #{dir}/"
+    end
+  end
+
+  # creates the user supplied or default template directory
+  # returns: user_template_dir
+  def self.create_user_template_dir(user_template_directory=nil)
+    if user_template_directory.nil?
+      user_template_directory = default_user_template_dir
+    end
+    # create default user template path or supplied user template path
+    if not File.exists?(user_template_directory)
+      FileUtils.mkdir_p(File.expand_path(user_template_directory))
+    end
+    user_template_directory
+  end
+
+  # creates and/or copies all templates in the gem to the user templates path
+  # returns: user_template_dir
+  def self.sync_user_template_dir(user_template_directory)
+    Dir.glob(File.join(gem_template_dir, "*.erb")).each do |src|
+      filename = File.basename(src)
+      dest = File.expand_path(File.join(user_template_directory, filename))
+      safe_copy_file(src, dest)
+    end
+    user_template_directory
+  end
+
+  # 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))
+  end
+
+  def self.default_user_template_dir
+    File.expand_path(File.join(ENV['HOME'], '.puppet_retrospec_templates' ))
+  end
+
+  def self.gem_template_dir
+    File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+  end
+
+  def self.safe_copy_file(src, dest)
+    if File.exists?(dest)
+      $stderr.puts "!! #{dest} already exists"
+    else
+      if not File.exists?(src)
+        safe_touch(src)
+      else
+        FileUtils.cp(src,dest)
+      end
+      puts " + #{dest}"
+    end
+  end
+
+  def self.safe_touch(file)
+    if File.exists? file
+      unless File.file? file
+        $stderr.puts "!! #{file} already exists and is not a regular file"
+      end
+    else
+      FileUtils.touch file
+      puts " + #{file}"
+    end
+  end
+
+  def self.safe_create_file(filename, content)
+    if File.exists? filename
+      old_content = File.read(filename)
+      if old_content != content
+        $stderr.puts "!! #{filename} already exists and differs from template"
+      end
+    else
+      File.open(filename, 'w') do |f|
+        f.puts content
+      end
+      puts " + #{filename}"
+    end
+  end
+end

data/lib/puppet-retrospec.rb

@@ -0,0 +1,233 @@
+require 'erb'
+require 'puppet'
+require 'helpers'
+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_accessor :default_modules
+  attr_accessor :template_dir
+
+
+  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']
+    @template_dir = default_template_dir
+    module_name
+    modules_included
+  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_make_shared_context
+  end
+
+  # pass in either the path to the module directory
+  # or the path to a specific manifest
+  # defaults to all manifests in the current directory
+  # if ENV['RETROSPEC_ENABLE_LOCAL_TEMPLATES'] = 'true' the use the default user templates path
+  # if ENV["RETROSPEC_TEMPLATES_PATH"] is set then we will override the default user template path
+  # with the path provided
+  # we will use the necessary templates from that directory instead of the default gem path
+  def self.run(path=nil, template_dir=ENV['RETROSPEC_TEMPLATES_PATH'])
+    spec = Retrospec.new(path, template_dir)
+    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
+
+  def referenced_modules
+    []
+  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)
+
+    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
+    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')
+    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
+    end
+  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('spec/spec_helper.rb', template)
+  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
+
+  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))
+  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
+  end
+
+end

data/lib/templates/fixtures_file.erb

@@ -0,0 +1,7 @@
+fixtures:
+    symlinks:
+        <%= @module_name %>: "#{source_dir}"
+    repositories:
+      stdlib:
+        repo: https://github.com/puppetlabs/puppetlabs-stdlib.git
+        ref: 4.3.2

data/lib/templates/gemfile.erb

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+group :development, :test do
+    gem 'bodeco_module_helper', :git => 'https://github.com/bodeco/bodeco_module_helper.git'
+    gem 'rspec-puppet-utils', :git => 'https://github.com/Accuity/rspec-puppet-utils.git'
+    gem 'hiera-puppet-helper', :git => 'https://github.com/bobtfish/hiera-puppet-helper.git'
+end
+

data/lib/templates/resource_spec_file.erb

@@ -0,0 +1,25 @@
+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
+    include_context :hiera
+<% if type[:type_name] == 'define' -%>
+    let(:title) { 'example_name' }
+<% end -%>
+    let(:facts) do
+       {}
+    end
+    let(:params) do
+       {}
+    end
+    # add these two lines in a single test to enable puppet and hiera debug mode
+    # Puppet::Util::Log.level = :debug
+    # Puppet::Util::Log.newdestination(:console)
+    it { should compile }
+<% end -%>
+end
+<% end -%>

data/lib/templates/shared_context.erb

@@ -0,0 +1,28 @@
+require 'hiera-puppet-helper'
+
+# optional, this should be the path to where the hirea data config file is in this repo
+hiera_config_file = File.expand_path(File.join(File.dirname(__FILE__), '..','data', 'hiera.yaml'))
+
+# hiera_file and hiera_data are mutally exclusive contexts.
+
+
+shared_context :linux_hiera do
+    # example only,
+    let(:hiera_data) do
+        {:some_key => "some_value" }
+    end
+end
+
+# In case you want a more specific set of mocked hiera data for windows
+shared_context :windows_hiera do
+    # example only,
+    let(:hiera_data) do
+        {:some_key => "some_value" }
+    end
+end
+
+shared_context :real_hiera_data do
+    let(:hiera_config) do
+       hirea_config_file
+    end
+end

data/lib/templates/spec_helper_file.erb

@@ -0,0 +1,9 @@
+require 'puppetlabs_spec_helper/module_spec_helper'
+require 'rspec-puppet-utils'
+
+# Uncomment this to show coverage report, also useful for debugging
+#at_exit { RSpec::Puppet::Coverage.report! }
+
+RSpec.configure do |c|
+    c.formatter = 'documentation'
+end

data/puppet-retrospec.gemspec

@@ -0,0 +1,89 @@
+# Generated by jeweler
+# 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
+
+Gem::Specification.new do |s|
+  s.name = "puppet-retrospec"
+  s.version = "0.2.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.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"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    ".travis.yml",
+    "Gemfile",
+    "LICENSE",
+    "README.md",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "bin/retrospec",
+    "lib/helpers.rb",
+    "lib/puppet-retrospec.rb",
+    "lib/templates/fixtures_file.erb",
+    "lib/templates/gemfile.erb",
+    "lib/templates/resource_spec_file.erb",
+    "lib/templates/shared_context.erb",
+    "lib/templates/spec_helper_file.erb",
+    "puppet-retrospec.gemspec",
+    "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"
+  ]
+  s.homepage = "http://github.com/logicminds/puppet-retrospec"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.2.2"
+  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<trollop>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.14"])
+      s.add_development_dependency(%q<yard>, ["~> 0.7"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<pry>, [">= 0"])
+      s.add_development_dependency(%q<fakefs>, [">= 0"])
+    else
+      s.add_dependency(%q<puppet>, [">= 0"])
+      s.add_dependency(%q<trollop>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2.14"])
+      s.add_dependency(%q<yard>, ["~> 0.7"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<pry>, [">= 0"])
+      s.add_dependency(%q<fakefs>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<puppet>, [">= 0"])
+    s.add_dependency(%q<trollop>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 2.14"])
+    s.add_dependency(%q<yard>, ["~> 0.7"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<pry>, [">= 0"])
+    s.add_dependency(%q<fakefs>, [">= 0"])
+  end
+end
+

data/spec/fixtures/manifests/includes-class.pp

@@ -0,0 +1,26 @@
+class includes-class{
+
+  include class1
+  include class2
+  include class3
+
+
+  require class4
+  require class5
+
+  $var1 = 'true'
+
+  file{"dummytest":
+    ensure => directory
+
+  }
+
+  file{"dummytest":
+    ensure => directory
+  }
+
+  if $var1 == 'true'{
+    include class6
+  }
+
+}

data/spec/fixtures/manifests/includes-defines.pp

@@ -0,0 +1,26 @@
+define webinstance{
+
+  include class1
+  include class2
+  include class3
+
+
+  require class4
+  require class5
+
+  $var1 = 'true'
+
+  file{"dummytest":
+    ensure => directory
+
+  }
+
+  file{"dummytest":
+    ensure => directory
+  }
+
+  if $var1 == 'true'{
+    include class6
+  }
+
+}

data/spec/fixtures/manifests/not_a_resource_defination.pp

@@ -0,0 +1 @@
+include class1

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+require 'puppet-retrospec'
+require 'rspec'
+require 'puppet'
+
+def fixture_modules_path
+  @fixture_module_path ||= File.expand_path(File.join(fixtures_path, 'modules'))
+end
+
+def fixtures_path
+  @fixtures_path ||= File.expand_path(File.join(File.dirname(__FILE__), 'fixtures'))
+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)
+  end
+end
+
+
+

data/spec/unit/puppet-retrospec_spec.rb

@@ -0,0 +1,161 @@
+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)
+  end
+
+  before :each do
+    @retro = Retrospec.new(Dir.glob('spec/fixtures/manifests/*.pp'))
+    ENV['RETROSPEC_ENABLE_LOCAL_TEMPLATES'] = nil
+    ENV['RETROSPEC_TEMPLATES_PATH'] = nil
+
+
+  end
+
+  it 'should run without errors' do
+    install_module('puppetlabs-tomcat')
+    tomcat = Retrospec.new('spec/fixtures/modules/tomcat')
+    tomcat.create_files
+  end
+
+  it 'should create a local templates directory when flag is on' do
+    ENV['RETROSPEC_ENABLE_LOCAL_TEMPLATES'] = 'true'
+    FakeFS do
+      user_directory = Helpers.default_user_template_dir
+      FileUtils.mkdir_p(Helpers.gem_template_dir)
+      FileUtils.touch(File.join(Helpers.gem_template_dir, 'fixtures_file.erb'))
+      FileUtils.touch(File.join(Helpers.gem_template_dir, 'resource_spec_file.erb'))
+      FileUtils.touch(File.join(Helpers.gem_template_dir, 'shared_context.erb'))
+      FileUtils.touch(File.join(Helpers.gem_template_dir, 'spec_helper_file.erb'))
+      FileUtils.touch(File.join(Helpers.gem_template_dir, 'gemfile.erb'))
+
+      FileUtils.mkdir_p('/modules/tomcat/manifests')
+      FileUtils.touch('/modules/tomcat/manifests/init.pp')
+      Retrospec.new('/modules/tomcat')
+      expect(File.exists?(user_directory)).to eq(true)
+      expect(File.exists?(File.join(user_directory, 'gemfile.erb'))).to eq(true)
+      expect(File.exists?(File.join(user_directory, 'fixtures_file.erb'))).to eq(true)
+      expect(File.exists?(File.join(user_directory, 'resource_spec_file.erb'))).to eq(true)
+      expect(File.exists?(File.join(user_directory, 'shared_context.erb'))).to eq(true)
+      expect(File.exists?(File.join(user_directory, 'spec_helper_file.erb'))).to eq(true)
+    end
+    ENV['RETROSPEC_ENABLE_LOCAL_TEMPLATES'] = nil
+    ENV['RETROSPEC_TEMPLATES_PATH'] = nil
+  end
+
+  it 'should create and use 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)
+      FileUtils.touch(File.join(Helpers.gem_template_dir, 'fixtures_file.erb'))
+      FileUtils.touch(File.join(Helpers.gem_template_dir, 'resource_spec_file.erb'))
+      FileUtils.touch(File.join(Helpers.gem_template_dir, 'shared_context.erb'))
+      FileUtils.touch(File.join(Helpers.gem_template_dir, 'spec_helper_file.erb'))
+      FileUtils.touch(File.join(Helpers.gem_template_dir, 'gemfile.erb'))
+      FileUtils.mkdir_p('/modules/tomcat/manifests')
+      FileUtils.touch('/modules/tomcat/manifests/init.pp')
+      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)
+      expect(File.exists?(File.join(user_directory, 'resource_spec_file.erb'))).to eq(true)
+      expect(File.exists?(File.join(user_directory, 'shared_context.erb'))).to eq(true)
+      expect(File.exists?(File.join(user_directory, 'spec_helper_file.erb'))).to eq(true)
+    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')
+
+  end
+
+  it 'should return the correct module name' do
+    Helpers.should_receive(:get_module_name).and_return('mymodule')
+    @retro.module_name.should eq('mymodule')
+  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
+  end
+
+  it 'classes_and_defines should not be nil' do
+    @retro.classes_and_defines(@retro.manifest_files.first).length.should >= 1
+  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
+  end
+
+  it 'modules_included should not be nil' do
+    @retro.modules_included.length.should eq(1)
+  end
+
+end

metadata

@@ -0,0 +1,198 @@
+--- !ruby/object:Gem::Specification
+name: puppet-retrospec
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Corey Osman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: puppet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: trollop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Retrofits and generates valid puppet rspec test code to existing modules
+email: corey@logicminds.biz
+executables:
+- retrospec
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+- README.rdoc
+files:
+- .document
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/retrospec
+- lib/helpers.rb
+- lib/puppet-retrospec.rb
+- lib/templates/fixtures_file.erb
+- lib/templates/gemfile.erb
+- lib/templates/resource_spec_file.erb
+- lib/templates/shared_context.erb
+- lib/templates/spec_helper_file.erb
+- puppet-retrospec.gemspec
+- 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
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+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.
+test_files: []