puppet-retrospec 1.0.0 → 1.1.0

data/CHANGELOG.md

@@ -1,3 +1,5 @@
+## 1.1.0
+ * fixes gh-62 - add support for creating native puppet fuctions
 ## 1.0.0
  This is a major release which vendors the latest puppet version.  The core parser
  was rewritten to use the new puppet parser and opens up a bunch of new possibilities
@@ -8,7 +10,7 @@
  * Fixes gh-56 - variable_value: rendering values with escapes creates invalid tests
  * Fixes gh-15 - nested conditionals are not discovered
  * Fixes gh-54 - Vendored puppet 3.7 doesn't work on newer rubies
- 
+
 ## 0.12.2
  * fixes issue with ruby193 and openstruct
  * fix unit tests from failing on missing hook file

data/Gemfile

@@ -11,6 +11,7 @@ group :development do
 end
 
 group :test do
+  gem 'rubocop'
   gem 'rspec', '~> 3.2'
   gem 'puppet', '4.5.2', :path => 'vendor/gems/puppet-4.5.2'
   gem 'rake'
@@ -19,7 +20,3 @@ group :test do
   gem 'fakefs', :require => 'fakefs/safe'
   gem 'rspec', '~> 3.2'
 end
-
-group :build do
-  gem 'jeweler'
-end

data/Gemfile.lock

@@ -10,84 +10,56 @@ GEM
   remote: http://rubygems.org/
   specs:
     CFPropertyList (2.2.8)
-    addressable (2.3.8)
-    awesome_print (1.6.1)
-    builder (3.2.2)
-    coderay (1.1.0)
-    descendants_tracker (0.0.4)
-      thread_safe (~> 0.3, >= 0.3.1)
+    ast (2.3.0)
+    awesome_print (1.7.0)
+    coderay (1.1.1)
     diff-lcs (1.2.5)
-    facets (3.0.0)
+    facets (3.1.0)
     facter (2.4.6)
       CFPropertyList (~> 2.2.6)
-    fakefs (0.6.7)
-    faraday (0.9.2)
-      multipart-post (>= 1.2, < 3)
-    git (1.2.9.1)
-    github_api (0.12.4)
-      addressable (~> 2.3)
-      descendants_tracker (~> 0.0.4)
-      faraday (~> 0.8, < 0.10)
-      hashie (>= 3.4)
-      multi_json (>= 1.7.5, < 2.0)
-      nokogiri (~> 1.6.6)
-      oauth2
-    hashie (3.4.2)
-    hiera (3.1.2)
+    fakefs (0.9.0)
+    hiera (3.2.0)
       json_pure
-    highline (1.7.8)
-    jeweler (2.0.1)
-      builder
-      bundler (>= 1.0)
-      git (>= 1.2.5)
-      github_api
-      highline (>= 1.6.15)
-      nokogiri (>= 1.5.10)
-      rake
-      rdoc
     json (1.8.3)
-    json_pure (1.8.3)
-    jwt (1.5.1)
+    json_pure (2.0.2)
     method_source (0.8.2)
-    mini_portile (0.6.2)
-    multi_json (1.11.2)
-    multi_xml (0.5.5)
-    multipart-post (2.0.0)
-    nokogiri (1.6.6.2)
-      mini_portile (~> 0.6.0)
-    oauth2 (1.0.0)
-      faraday (>= 0.8, < 0.10)
-      jwt (~> 1.0)
-      multi_json (~> 1.3)
-      multi_xml (~> 0.5)
-      rack (~> 1.2)
-    pry (0.10.2)
+    parser (2.3.1.2)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    pry (0.10.4)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
-    rack (1.6.4)
-    rake (10.4.2)
+    rainbow (2.1.0)
+    rake (11.2.2)
     rdoc (3.12.2)
       json (~> 1.4)
     retrospec (0.4.0)
       trollop
-    rspec (3.3.0)
-      rspec-core (~> 3.3.0)
-      rspec-expectations (~> 3.3.0)
-      rspec-mocks (~> 3.3.0)
-    rspec-core (3.3.2)
-      rspec-support (~> 3.3.0)
-    rspec-expectations (3.3.1)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.1)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.3.0)
-    rspec-mocks (3.3.2)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.3.0)
-    rspec-support (3.3.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    rubocop (0.42.0)
+      parser (>= 2.3.1.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
     slop (3.6.0)
-    thread_safe (0.3.5)
     trollop (2.1.2)
-    yard (0.8.7.6)
+    unicode-display_width (1.1.0)
+    yard (0.9.5)
 
 PLATFORMS
   ruby
@@ -97,13 +69,13 @@ DEPENDENCIES
   bundler (~> 1.0)
   facets
   fakefs
-  jeweler
   pry
   puppet (= 4.5.2)!
   rake
   rdoc (~> 3.12)
   retrospec (~> 0.4)
   rspec (~> 3.2)
+  rubocop
   trollop
   yard (~> 0.7)
 

data/README.md

@@ -52,14 +52,14 @@ TOC Created by [gh-md-toc](https://github.com/ekalinin/github-markdown-toc)
 
 ## News
 ### 6-28-16
-Version 1.0.0 is release with full support for puppet 4.x code.  
+Version 1.0.0 is released with full support for puppet 4.x code.  
 ### 1-18-16
 A slew of new features has been added with the 0.12 update. If you already use retrospec to retrofit your modules, now you can use retrospec to generate some of the more advanced puppet module customizations such as:
 
 - custom facts
 - providers
 - custom types
-- functions (v3 and v4)
+- functions (v3,v4, and native)
 - parameter schemas  
 
 This has been a feature in the making since Puppetconf 2015.  I would have finished this sooner but was sucked in

data/Rakefile

@@ -2,34 +2,16 @@
 
 require 'rubygems'
 require 'bundler'
+require "bundler/gem_tasks"
+require "rake/testtask"
 begin
-  Bundler.setup(:default, :development)
+  Bundler.setup(:default, :development, :test)
 rescue Bundler::BundlerError => e
   $stderr.puts e.message
   $stderr.puts 'Run `bundle install` to install missing gems'
   exit e.status_code
 end
 require 'rake'
-begin
-require_relative 'lib/retrospec/plugins/v1/plugin/version'
-require 'jeweler'
-plugin_version = "#{Retrospec::Puppet::VERSION}"
-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.version = "#{plugin_version}"
-  gem.homepage = 'http://github.com/nwops/puppet-retrospec'
-  gem.license = 'MIT'
-  gem.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.)
-  gem.description = %(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
-rescue LoadError
-  # do need jeweler for all tasks
-end
 require 'rspec/core'
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec) do |spec|

data/lib/retrospec/plugins/v1/plugin/generators/fact_generator.rb

@@ -87,11 +87,11 @@ Generates a new fact with the given name
         def template_dir
           unless @template_dir
             external_templates = File.expand_path(File.join(config_data[:template_dir], 'facts', 'fact.rb.retrospec.erb'))
-            if File.exist?(external_templates)
-              @template_dir = File.join(config_data[:template_dir], 'facts')
-            else
-              @template_dir = File.expand_path(File.join(File.dirname(File.dirname(__FILE__)), 'templates', 'facts'))
-            end
+            @template_dir = if File.exist?(external_templates)
+                              File.join(config_data[:template_dir], 'facts')
+                            else
+                              File.expand_path(File.join(File.dirname(File.dirname(__FILE__)), 'templates', 'facts'))
+                            end
           end
           @template_dir
         end

data/lib/retrospec/plugins/v1/plugin/generators/function_generator.rb

@@ -1,11 +1,10 @@
 require_relative 'parsers/function'
-
+require_relative 'parsers/native_function'
 module Retrospec
   module Puppet
     module Generators
       class FunctionGenerator < Retrospec::Plugins::V1::Plugin
         attr_reader :template_dir, :context
-
         # retrospec will initilalize this class so its up to you
         # to set any additional variables you need to get the job done.
         def initialize(module_path, spec_object = {})
@@ -14,7 +13,8 @@ module Retrospec
           # you will need to initialize this object, so the erb templates can get the binding
           # the SpecObject can be customized to your liking as its different for every plugin gem.
           @context = OpenStruct.new(:name => spec_object[:name], :return_type => spec_object[:return_type],
-                                    :function_type => spec_object[:type], :test_type => spec_object[:test_type])
+                                    :function_type => spec_object[:type],
+                                    :test_type => spec_object[:test_type])
         end
 
         # Puppet currently has two versions of functions (v3, v4).  At the time of writing v4 is still new
@@ -24,7 +24,8 @@ module Retrospec
         # By default this method looks inside the user supplied template dir for existence of a template and if true returns that base path, if
         # false returns the template directory inside the gem location which is mainly used for development only.
         def template_dir
-          external_templates = File.expand_path(File.join(config_data[:template_dir], 'functions',function_type, 'function_template.rb.retrospec.erb'))
+          external_templates = File.expand_path(File.join(config_data[:template_dir], 'functions',
+                                                          function_type, "function_template#{function_ext}.retrospec.erb"))
           if File.exist?(external_templates)
             File.join(config_data[:template_dir], 'functions', function_type)
           else
@@ -32,7 +33,7 @@ module Retrospec
           end
         end
 
-        # returns v3 or v4 to specify the function type
+        # returns v3,v4, native to specify the function type
         def function_type
           context.function_type
         end
@@ -43,8 +44,8 @@ module Retrospec
         # all options here are available in the config passed into config object
         # returns the parameters
         def self.run_cli(global_opts, args=ARGV)
-          func_types = ['v3', 'v4']
-          func_type  = global_opts['plugins::puppet::default_function_version'] || 'v3'
+          func_types = ['v3', 'v4', 'native']
+          func_type  = global_opts['plugins::puppet::default_function_version'] || 'v4'
           test_type  = global_opts['plugins::puppet::default_function_test_type'] || 'rspec'
           sub_command_opts = Trollop.options(args) do
             banner <<-EOS
@@ -52,7 +53,7 @@ Generates a new function with the given name.
 
             EOS
             opt :name, 'The name of the function you wish to create', :type => :string, :required => true, :short => '-n'
-            opt :type, 'The version type of the function (v3, v4)', :type => :string, :required => false, :short => '-t',
+            opt :type, "The version type of the function (#{func_types.join(',')})", :type => :string, :required => false, :short => '-t',
                 :default => func_type
             opt :test_type, 'The type of test file to create (rspec, ruby)', :default => test_type, :type => :string, :short => '-u'
             opt :return_type, 'The return type of the function (rvalue, statement)', :type => :string, :required => false,
@@ -74,10 +75,13 @@ Generates a new function with the given name.
 
         # returns the function directory to create the the function in
         def function_dir
-          if function_type == 'v3'
+          case function_type
+          when 'v3'
             v3_function_dir
-          else
+          when 'v4'
             v4_function_dir
+          when 'native'
+            native_function_dir
           end
         end
 
@@ -91,9 +95,18 @@ Generates a new function with the given name.
           @v4_function_dir || File.join(module_path, 'lib', 'puppet', 'functions')
         end
 
+        def native_function_dir
+          @native_function_dir || File.join(module_path, 'functions')
+        end
+
         # returns the path to the function using the function directory
         def function_path
-          File.join(function_dir, "#{function_name}.rb")
+          path = File.join(function_dir, function_name.to_s)
+          path + function_ext
+        end
+
+        def function_ext
+          function_type == 'native' ? '.pp' : '.rb'
         end
 
         # returns the name of the function
@@ -101,9 +114,13 @@ Generates a new function with the given name.
           context.name
         end
 
+        def function_file_path
+          File.join(template_dir, "function_template#{function_ext}.retrospec.erb")
+        end
+
         # generates the function file based on the template and context
         def generate_function_file
-          safe_create_template_file(function_path, File.join(template_dir, 'function_template.rb.retrospec.erb'), context)
+          safe_create_template_file(function_path, function_file_path, context)
           function_path
         end
 
@@ -111,13 +128,20 @@ Generates a new function with the given name.
         # because this can vary between test types and function types
         # there are many supporting functions to determine which directory to use
         def spec_file_dir
-          if function_type == 'v3'
+          case function_type
+          when 'v3'
             v3_spec_dir
-          else
+          when 'v4'
             v4_spec_dir
+          when 'native'
+            native_spec_dir
           end
         end
 
+        def native_spec_dir
+          File.join(module_path, 'spec', 'functions')
+        end
+
         # returns the path to the v3 spec directory if using using rspec test type
         # the spec/functions is returned
         def v3_spec_dir
@@ -138,12 +162,28 @@ Generates a new function with the given name.
           end
         end
 
-        # returns an array of functions found in either the v3 or v4 directories
+        # @return [Array] an array of functions found in either the v3,v4, native directories
         def discovered_functions
-          Dir.glob([File.join(v3_function_dir, '*.rb'), File.join(v4_function_dir, '*.rb')]).sort
+          Dir.glob([File.join(v3_function_dir, '*.rb'),
+                    File.join(v4_function_dir, '*.rb'), File.join(native_function_dir, '*.pp')]).sort
+        end
+
+        # @return [Boolean] true if the function file is a native function
+        def native_function?(function_file)
+          # mod_name/functions
+          File.basename(Pathname.new(function_file).parent) == 'functions' &&
+            File.extname(function_file) == '.pp'
+        end
+
+        # @return [Boolean] true if the function file is a v4 function
+        def v4_function?(function_file)
+          # mod_name/lib/puppet/functions
+          File.basename(Pathname.new(function_file).parent.parent) == 'functions'
         end
 
-        def is_v3_function?(function_file)
+        # @return [Boolean] true if the function file is a v3 function
+        def v3_function?(function_file)
+          # mod_name/lib/puppet/parser/functions
           File.basename(Pathname.new(function_file).parent.parent) == 'parser'
         end
 
@@ -161,9 +201,13 @@ Generates a new function with the given name.
           spec_files = []
           discovered_functions.each do |file|
             begin
-              if is_v3_function?(file)
+              if v3_function?(file)
                 context.function_type = 'v3'
                 file_data = Retrospec::Puppet::Parser::Functions.load_function(file)
+              elsif native_function?(file)
+                context.test_type = 'rspec'
+                context.function_type = 'native'
+                file_data = Parsers::NativeFunction.load_function(file)
               else
                 context.function_type = 'v4'
                 file_data = Retrospec::Puppet::Functions.load_function(file)

data/lib/retrospec/plugins/v1/plugin/generators/parsers/native_function.rb

@@ -0,0 +1,58 @@
+require_relative '../serializers/rspec_dumper'
+require 'ostruct'
+module Parsers
+  class NativeFunction
+    attr_reader :manifest_file
+
+    def initialize(file)
+      @manifest_file = file
+    end
+
+    # @param [String] - path to the function file
+    # @return [OpenStruct] - a object with name and parameters
+    def self.load_function(file)
+      f = new(file)
+      @model = OpenStruct.new(:name => f.definition.name,
+                              :parameters => f.parameter_list,
+                              :parameter_names => f.parameter_list.keys)
+      @model
+    end
+
+    def ast
+      unless @ast
+        raise ArgumentError, 'please set the manifest file' if manifest_file.nil?
+        parser = ::Puppet::Pops::Parser::EvaluatingParser.new
+        result = parser.parse_file(manifest_file)
+        @ast = result.current
+      end
+      @ast
+    end
+
+    def dumper
+      @dumper ||= Retrospec::Puppet::RspecDumper.new
+    end
+
+    def definition
+      ast.body
+    end
+
+    # return a manifest body object
+    def body
+      ast.body.body
+    end
+
+    def parameters
+      ast.body.parameters
+    end
+
+    def function_name
+      body.name
+    end
+
+    def parameter_list
+      list = {}
+      parameters.each { |p| list[p.name.to_sym] = p.value }
+      list
+    end
+  end
+end