puppet-retrospec 0.4.0 → 0.5.0

data/README.md

@@ -24,11 +24,11 @@ Run from the command line
 ```
 $ retrospec -h
   Options:
-          --module-path, -m <s>:   The path (relative or absolute) to the module directory (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 ~/.puppet_retrospec_templates
-      --enable-beaker-tests, -n:   Enable the creation of beaker tests
-                     --help, -h:   Show this message
+          --module-path, -m <s>: The path (relative or absolute) to the module directory
+         --template-dir, -t <s>: Path to templates directory (only for overriding Retrospec templates)
+    --enable-user-templates, -e: Use Retrospec templates from ~/.puppet_retrospec_templates
+      --enable-beaker-tests, -n: Enable the creation of beaker tests
+                     --help, -h: Show this message
                      
 retrospec -m ~/projects/puppet_modules/apache
 ```
@@ -71,53 +71,88 @@ $ retrospec
  
 ```
 
-Looking at the file we can see that it did a lot of work for us.
-Below is the classes/tomcat_spec.rb file  
+Looking at the file we can see that it did a lot of work for us.  Retrospec generate three tests automatically.
+However the variable resolution isn't perfect so you will need to manually resolve all variables.  This doesn't produce
+100% coverage but all you did was press enter to produce all this anyways.
+Below is the defines/instance_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
+
+describe 'tomcat' 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
+
+
+  # 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 do
+    should contain_file('$::tomcat::params::catalina_home').
+             with({"ensure"=>"directory",
+                   "owner"=>"$::tomcat::params::user",
+                   "group"=>"$::tomcat::params::group"})
+  end
+  it do
+    should contain_user('$::tomcat::params::user').
+             with({"ensure"=>"present",
+                   "gid"=>"$::tomcat::params::group"})
+  end
+  it do
+    should contain_group('$::tomcat::params::group').
+             with({"ensure"=>"present"})
+  end
+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 
+At this time the test suite that is automatically generated is very basic.  Essentially it just creates a test for every
+resource not in a code block with the exception of conditional code blocks.  While this might be all you need, the more
+complex your code is the less retrospec will generate until further improvements to the generator are made.
+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:
+tests and conditional logic using describe blocks and such.  You will notice that some variables are not resolved.
+Currently this is a limitation that I hope to overcome, but until now its up to you to manually resolve those variables
+prefixed with a '$'.
+
+Example:
+
+```ruby
+should contain_file('$::tomcat::params::catalina_home').
+             with({"ensure"=>"directory",
+                   "owner"=>"$::tomcat::params::user",
+                   "group"=>"$::tomcat::params::group"})
+
+```
+
+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)
@@ -126,7 +161,7 @@ tests and conditional logic.  For now you will probably want to read up on the f
 How Does it do this
 =======================
 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.
+your puppet module with unit tests.  Currently I rely on the old AST parser to generate all this
 
 Overriding the templates
 =======================
@@ -141,7 +176,7 @@ To override these templates just set **one** of the following cli options.
 
 Once one of the options is set, 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.
+If you have already created the 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 correct
 template option when running retrospec.
 
@@ -199,11 +234,24 @@ Otherwise to save time we skip the removal of test puppet modules therefore we d
 bundle exec rake spec
 ```
 
+Understanding Variable Resolution
+=============
+I do my best to try and resolve all the variables.  Because the code does not rely on catalog compilation we have to
+build our own scope through non trival methods.  Some variables will get resolved while others will not.  As this code
+progresses we might find a better way at resolving variables.  For now, some variable will require manual interpolation.
+
+Resolution workflow.
+
+1. load code in parser and find all parameters. Store these parameter values.
+2. Find all vardef objects, resolve them if possible and store the values
+3. Anything contained in a block of code is currently ignored, until later refinement.
+
 Todo
 ============
 - 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
+- Auto add dependencies to fixtures file
+- Show a diff of the test file when retrospec is run multiple times and the test file is already created.
 
 Support
 ============

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.5.0

data/bin/retrospec

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
 require 'trollop'
-require 'puppet-retrospec'
+require 'retrospec'
+require 'retrospec/version'
 
 opts = Trollop::options do
   opt :module_path, "The path (relative or absolute) to the module directory (Defaults to current directory) " ,
@@ -10,7 +11,10 @@ opts = Trollop::options do
   opt :enable_user_templates, "Use Retrospec templates from #{File.expand_path('~/.puppet_retrospec_templates')}",
       :require => false, :type => :boolean
   opt :enable_beaker_tests, "Enable the creation of beaker tests", :require => false, :type => :boolean
+  opt :version, "The Version of the Gem", :required => false, :type => :boolean
+end
+if opts[:version]
+  puts "Puppet Retrospec Version: #{Puppet_Retrospec::VERSION}"
 end
-
 retro = Retrospec.new(opts[:module_path], opts)
 retro.create_files

data/lib/{puppet-retrospec.rb → retrospec.rb}

@@ -1,14 +1,14 @@
 require 'erb'
 require 'puppet'
-require 'helpers'
+require 'retrospec/helpers'
 require 'fileutils'
+require 'retrospec/resource'
+require 'retrospec/conditional'
+require 'retrospec/variable_store'
 
 class Retrospec
-  attr_reader :included_declarations
   attr_reader :module_path
   attr_reader :tmp_module_path
-  attr_accessor :default_modules
-  attr_accessor :facts_used
   attr_accessor :module_name
   attr_reader :template_dir
 
@@ -27,17 +27,13 @@ class Retrospec
     end
     @enable_beaker_tests = opts[:enable_beaker_tests]
     @module_path = validate_module_dir(module_path)
-    tmp_module_path
+    tmp_module_path # this is required to finish initialization
   end
 
   def enable_beaker_tests?
     @enable_beaker_tests == true
   end
 
-  def default_modules
-    @default_modules ||= ['stdlib']
-  end
-
   def create_files
     safe_create_spec_helper
     safe_create_fixtures_file
@@ -126,10 +122,11 @@ class Retrospec
 
   # returns the name of the module  ie. mysql::config  => mysql
   def module_name
-    if @module_name.nil?
-      @module_name = types.first.name.split('::').first if types.length > 0
+    begin
+      @module_name ||= types.first.name.split('::').first
+    rescue
+      @module_name = module_dir_name
     end
-    @module_name
   end
 
   # creates a tmp module directory so puppet can work correctly
@@ -143,48 +140,14 @@ class Retrospec
     @modules_dir
   end
 
-  def modules_included
-    @modules_included ||= default_modules + referenced_modules
-  end
-
-  def referenced_modules
-    []
-  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
-
-
-
   # 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(type,template='resource_spec_file.erb')
     @parameters = type.arguments
     @type = type
+    @resources = Resource.all(type)
+    # pass the type to the variable store and it will discover all the variables and try to resolve them.
+    VariableStore.populate(type)
+    @resources += Conditional.all(type)
     file_path = generate_file_path(type, false)
     safe_create_template_file(file_path, template)
     file_path

data/lib/retrospec/conditional.rb

@@ -0,0 +1,53 @@
+require 'retrospec/resource'
+
+class Conditional
+  attr_reader :test, :value, :statements
+
+  # things I need:  a key/value store for variables
+  # types of variables
+  # those that can be changed
+  # those that can be influenced (facts, other variables that contain variables)
+  # takes a subtype of Puppet::AST::Branch that contains conditional logic
+  def initialize(branch, parameters)
+     @statements = branch.statements
+  end
+
+  # get the attributes for the given resources found in the type code passed in
+  # this will return a array of hashes, one for each resource found
+  def self.all(type)
+    r_attrs = []
+    generate_conditionals(type).each do |c|
+      r_attrs << Resource.all(c.statements)
+    end
+    r_attrs.flatten
+  end
+
+  # a array of types the are known to contain conditional code and statements
+  def self.types
+    #test, statement, value
+    # if I don't have a statement that I am part of a bigger code block
+    # [Puppet::Parser::AST::IfStatement, Puppet::Parser::AST::CaseStatement, Puppet::Parser::AST::Else,
+    #  Puppet::Parser::AST::CaseOpt, Puppet::Parser::AST::Selector]
+    [Puppet::Parser::AST::IfStatement, Puppet::Parser::AST::Else]
+  end
+
+  # returns a array of branch subtypes
+  def self.find_conditionals(type)
+    conds = []
+    if type.code.respond_to?(:find_all)
+      conds = type.code.find_all {|c| types.include?(c.class)  }
+    end
+    conds
+  end
+
+  # find and create an array of conditionals
+  # we need the type so we can look through the code to find conditional statements
+  def self.generate_conditionals(type)
+    conditionals = []
+    find_conditionals(type).each do |cond|
+      conditionals << Conditional.new(cond, type.arguments)
+    end
+    conditionals
+  end
+
+end

data/lib/{helpers.rb → retrospec/helpers.rb}

@@ -80,6 +80,10 @@ class Helpers
     File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
   end
 
+
+
+
+
   def self.safe_copy_file(src, dest)
     if File.exists?(dest) and not File.zero?(dest)
       $stderr.puts "!! #{dest} already exists"

data/lib/retrospec/resource.rb

@@ -0,0 +1,37 @@
+require 'retrospec/variable_store'
+
+class Resource
+
+  attr_reader :type, :title, :parameters, :scope_name
+
+  def initialize(type_name,instance)
+    @parameters = Hash[instance.parameters.map { |k| [k.param, VariableStore.resolve(k.value).gsub("\"", '')]}]
+    @type = type_name
+    @title = VariableStore.resolve(instance.title).gsub("\"", '')
+  end
+
+  # Gets all resources in the type that are not in a code block
+  def self.all(statements)
+    if statements.respond_to?(:code)
+      # store the class params
+      statements.arguments.each {|k,v| VariableStore.add(k,v)}
+      # if we accidently pass a type in without specifing the code
+      statements = statements.code unless statements.nil?
+    end
+    a = []
+    # sometimes the code is empty
+    if statements.respond_to?(:find_all)
+      res = statements.find_all { |s| s.instance_of?(Puppet::Parser::AST::Resource)}
+      res.each do |r|
+        r.instances.each do |i|
+          a << Resource.new(r.type, i)
+        end
+      end
+    end
+    a
+  end
+
+  def self.all_resources
+    ObjectSpace.each_object(Puppet::Parser::AST::Resource).map {|x| x}
+  end
+end

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

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

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

@@ -14,7 +14,7 @@ group :development do
   gem "travis"
   gem "travis-lint"
   <%- if enable_beaker_tests? -%>
-  gem "beaker", :git => 'https://github.com/logicminds/beaker.git', :branch => 'sshd_restart'
+  gem "beaker", :git => 'https://github.com/puppetlabs/beaker.git'
   gem "beaker-rspec", :git => 'https://github.com/puppetlabs/beaker-rspec.git'
   gem "vagrant-wrapper"
   <%- end -%>