puppet-retrospec 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cbc49b480678daffff061e656b863bd070e751aa
-  data.tar.gz: 664b47744df42f5fa4df4121ac631a443c578818
+  metadata.gz: 4a46b9123ebdcbabc88aea95e6d9bf8bc4d8186e
+  data.tar.gz: d051e9b7a2e86b5a6260382b5ce41517a058d7d6
 SHA512:
-  metadata.gz: 3c933d5fb7ee82ea64ab460dfe40f4b6e8a79d690785ece5422109323aedf9998112f27f0d0b949a89e2dfae0edf7b28314ef5c0f6b43442a2c1dfb112575b31
-  data.tar.gz: 8df5426ac543a838444891ca1a4cbca589d9dc228344e589975da6fab5d16eaee44674f8489e02d1325cf9b9f66938a79fdebad7013c2725b6028681bc1f06a1
+  metadata.gz: ea9f08b9433abd1b92cbcc4ebef5e161acba887b78dc9048b442f308d4f210bf02a11936b3593edd55f94d0c4acc19b403a9e8b6f07f790dcdf911552db2684a
+  data.tar.gz: d55f442ff7e53df1b2736ea9fc493da6b1fdaca921f151402a0548b95327e2bb86e875772d04a9b325b3a90402912f7fd395f28130697f0a59b75e11bc09d8c1

data/Gemfile

@@ -1,7 +1,8 @@
 source "http://rubygems.org"
 
 gem 'trollop'
-gem 'retrospec', "~> 0.4.0"
+gem 'retrospec', "~> 0.4"
+gem 'awesome_print'
 # Include everything needed to run rake, tests, features, etc.
 group :development do
   gem "rspec", "~> 3.2"

data/Gemfile.lock

@@ -11,6 +11,7 @@ GEM
   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)
@@ -19,7 +20,7 @@ GEM
     facter (2.4.4)
       CFPropertyList (~> 2.2.6)
     fakefs (0.6.7)
-    faraday (0.9.1)
+    faraday (0.9.2)
       multipart-post (>= 1.2, < 3)
     git (1.2.9.1)
     github_api (0.12.4)
@@ -33,7 +34,7 @@ GEM
     hashie (3.4.2)
     hiera (1.3.4)
       json_pure
-    highline (1.7.7)
+    highline (1.7.8)
     jeweler (2.0.1)
       builder
       bundler (>= 1.0)
@@ -91,13 +92,14 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  awesome_print
   bundler (~> 1.0)
   fakefs
   jeweler
   pry
   puppet (= 3.7.3)!
   rdoc (~> 3.12)
-  retrospec (~> 0.4.0)
+  retrospec (~> 0.4)
   rspec (~> 3.2)
   trollop
   yard (~> 0.7)

data/README.md

@@ -1,3 +1,5 @@
+[![Gem Version](https://badge.fury.io/rb/puppet-retrospec.svg)](http://badge.fury.io/rb/puppet-retrospec)
+
 Puppet-Retrospec
 ================
 

data/VERSION

@@ -1 +1 @@
-0.10.0
+0.11.0

data/lib/retrospec-puppet.rb

@@ -1,3 +1,4 @@
 vendor = File.join(File.dirname(File.dirname(__FILE__)),'vendor')
 $:.unshift(File.expand_path(File.join([vendor, "gems", "puppet-3.7.3", "lib"])))
 require 'retrospec/plugins/v1/plugin/puppet'
+require 'awesome_print'  # required for printing templates

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

@@ -0,0 +1,93 @@
+require_relative 'facter'
+
+module Retrospec
+  module Puppet
+    module Generators
+      class FactGenerator < Retrospec::Plugins::V1::Plugin
+
+        attr_reader :template_dir, :context, :module_path, :fact_name, :config_data
+
+        # 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={})
+          # below is the Spec Object which serves as a context for template rendering
+          # 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.
+          @module_path = module_path
+          @config_data = spec_object
+          @context = OpenStruct.new(:fact_name => spec_object[:name])
+        end
+
+        # used to display subcommand options to the cli
+        # the global options are passed in for your usage
+        # http://trollop.rubyforge.org
+        # all options here are available in the config passed into config object
+        def self.run_cli(global_opts)
+          sub_command_opts = Trollop::options do
+            banner <<-EOS
+Generates a new fact with the given name
+
+            EOS
+            opt :name, "The name of the fact you wish to create", :type => :string, :require => :true, :short => '-n'
+          end
+          unless sub_command_opts[:name]
+            Trollop.educate
+            exit 1
+          end
+          plugin_data = global_opts.merge(sub_command_opts)
+          Retrospec::Puppet::Generators::FactGenerator.new(plugin_data[:module_path], plugin_data)
+        end
+
+        def fact_name
+          context[:fact_name]
+        end
+
+        def facter_dir
+          @facter_dir ||= File.join(module_path, 'lib', 'facter')
+        end
+
+        def facter_spec_dir
+          @facter_spec_dir ||= File.join(module_path, 'spec', 'unit', 'facter')
+        end
+
+        def fact_name_path
+          File.join(facter_dir, "#{fact_name}.rb")
+        end
+
+        # generates a fact file with the given name based on the template in the templates directory
+        def generate_fact_file
+          safe_create_template_file(fact_name_path, File.join(template_dir, 'fact.rb.retrospec.erb'), context)
+          generate_fact_spec_files
+        end
+
+        # generates spec files for each fact defined in the fact file
+        def generate_fact_spec_files
+          fact_files = Dir.glob(File.join(facter_dir, '*.rb')).sort
+          fact_files.each do | fact_file|
+            fact_file_data = Retrospec::Puppet::Generators::Facter.load_fact(fact_file)
+            fact_file_data.facts.each do |name, fact_data|
+              # because many facts can be in a single file we want to create a unique file for each fact
+              fact_spec_path = File.join(facter_spec_dir, "#{name}_spec.rb")
+              safe_create_template_file(fact_spec_path, File.join(template_dir, 'fact_spec.rb.retrospec.erb'), fact_data)
+            end
+          end
+        end
+
+        # the template directory located inside the your retrospec plugin gem
+        # you should not have to modify this unless you move the templates directory
+        # for now we are going to choose the correct template directory that contains the templates
+        def template_dir
+          unless @template_dir
+            external_templates = File.expand_path(File.join(config_data[:template_dir], 'facts', 'fact.rb.retrospec.erb'))
+            if File.exists?(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
+          end
+          @template_dir
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,116 @@
+require 'ostruct'
+
+# this is required to use when processing erb templates
+class OpenStruct
+  def get_binding
+    binding()
+  end
+end
+
+module Retrospec
+  module Puppet
+    module Generators
+      class Facter
+        # anytime a fact uses a facter lib we need to "mock" the fuction and record the value
+        class Core
+          class Execution
+            def self.execute(command, options={})
+              value = {:klass => self.to_s.gsub('Retrospec::Puppet::Generators::', ''),
+              :method => :execute, :value => command}
+              Retrospec::Puppet::Generators::Facter.exec_calls[command] = value
+            end
+          end
+        end
+
+        @model = OpenStruct.new(:facts => {})
+        @used_facts = {}
+        @confines = []
+        @methods_defined = []
+
+        def initialize(name, options, &block)
+          @fact_name = name
+          #block.call
+        end
+
+        def self.exec_calls
+          @exec_calls ||= {}
+        end
+
+        def self.used_facts
+          @used_facts ||= {}
+        end
+
+        def self.value(name)
+          used_facts[name] = {:name => name}
+        end
+
+        def self.fact(name)
+          fake_fact = OpenStruct.new(:value => '')
+          used_facts[name] = {:name => name}
+          fake_fact
+        end
+
+        def self.method_missing(method_sym, *arguments, &block)
+          @methods_defined << method_sym
+        end
+
+        def self.setcode(&block)
+          begin
+            block.call
+          rescue NameError => e
+          end
+        end
+
+        def self.confine(fact, *values)
+          @confines << fact
+        end
+
+        # loads the fact into the loader for evaluation
+        # and data collection
+        def self.load_fact(file)
+          @model = OpenStruct.new(:facts => {})
+          @used_facts = {}
+          @model = eval(File.read(file))
+          transform_data(@model)
+        end
+
+        # every fact will have a Facter.add functionality
+        # this is the startign point to collect all data
+        def self.add(name, options={}, &block)
+          @model.facts[name] = OpenStruct.new(:fact_name => name)
+          # calls the facter.add block
+          # this may call separate confine statements
+          @model.global_used_facts = used_facts
+          @used_facts = {}  # clear before fact specific are evaluated
+          @model.global_used_execs = exec_calls
+          @exec_calls = {}
+          begin
+            block.call
+          rescue NameError => e
+          end
+          @model.facts[name].used_facts = used_facts
+          @model.facts[name].confines = @confines
+          # clear any persistant data
+          @confines = []
+          @model.defined_methods = @methods_defined
+          @model.facts[name].exec_calls = exec_calls
+          @model
+        end
+
+        def self.transform_data(data)
+          #ObenStruct.new(:)
+          # {:method_fact=>
+          #      {:fact_name=>:method_fact,
+          #       :used_facts=>{:is_virtual=>{:name=>:is_virtual}},
+          #       :confines=>[{:kernel=>"Linux"}],
+          #       :exec_calls=>["which lsb"]},
+          #  :global_used_facts=>{},
+          #  :global_used_execs=>[],
+          #  :defined_methods=>[:default_kernel]}
+          data
+        end
+      end
+
+     end
+  end
+end

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

@@ -0,0 +1,114 @@
+require 'retrospec/plugins/v1/module_helpers'
+require 'retrospec/plugins/v1'
+
+module Retrospec
+  module Puppet
+    module Generators
+      class ModuleGenerator < Retrospec::Plugins::V1::Plugin
+
+        attr_reader :template_dir, :context, :module_path, :fact_name, :config_data
+
+        # 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={})
+          super
+          # below is the Spec Object which serves as a context for template rendering
+          # 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.
+          @template_dir = spec_object[:template_dir]
+          @context = OpenStruct.new(:module_name => spec_object[:name])
+        end
+
+        # used to display subcommand options to the cli
+        # the global options are passed in for your usage
+        # http://trollop.rubyforge.org
+        # all options here are available in the config passed into config object
+        # returns a new instance of this class
+        def self.run_cli(global_opts)
+          namespace     = global_opts['plugins::puppet::namespace'] || 'namespace'
+          author        = global_opts['plugins::puppet::author'] || 'author_name'
+          sub_command_opts = Trollop::options do
+            banner <<-EOS
+Generates a new module with the given name and namespace
+
+            EOS
+            opt :name, "The name of the module you wish to create", :type => :string, :required => false, :short => '-n',
+                :default => File.basename(global_opts[:module_path])
+            opt :namespace, "The namespace to use only when creating a new module", :default => namespace, :required => false,
+                :type => :string
+            opt :author, "The full name of the module author", :default => author, :required => false, :short => '-a',
+                :type => :string
+          end
+          unless sub_command_opts[:name]
+            Trollop.educate
+            exit 1
+          end
+          plugin_data = global_opts.merge(sub_command_opts)
+          Retrospec::Puppet::Generators::ModuleGenerator.new(plugin_data[:module_path], plugin_data)
+        end
+
+        def run(manifest_dir)
+          unless File.exist?(manifest_dir)
+            init_class = File.join(manifest_dir, 'init.pp')
+            content = File.read(File.join(template_dir, 'manifest_file.pp'))
+            unless ENV['RETROSPEC_PUPPET_AUTO_GENERATE'] == 'true'
+              print "The module located at: #{module_path} does not exist, do you wish to create it? (y/n): "
+              answer = gets.chomp
+              unless answer =~ /y/i
+                exit 1
+              end
+            end
+
+            create_manifest_file(init_class, content)
+            generate_metadata_file(config_data[:name], config_data)
+          end
+        end
+
+        def create_manifest_file(dest, content)
+          # replace the name in the target file with the module_name from this class
+          # I would have just used a template but the context does not exist yet
+          new_content = content.gsub('CLASS_NAME', config_data[:name])
+          safe_create_file(dest, new_content)
+        end
+
+        def self.generate_metadata_file(mod_name, config_data)
+          f = Retrospec::Puppet::Generators::ModuleGenerator.new(config_data[:module_path], config_data)
+          f.generate_metadata_file(mod_name, config_data)
+        end
+
+        # generates the metadata file in the module directory
+        def generate_metadata_file(mod_name,config_data)
+          require 'puppet/module_tool/metadata'
+          # make sure the metadata file exists
+          module_path = config_data[:module_path]
+          author = config_data[:author] || config_data['plugins::puppet::author'] || 'your_name'
+          namespace = config_data[:namespace] || config_data['plugins::puppet::namespace'] || 'namespace'
+          metadata_file = File.join(module_path, 'metadata.json')
+          unless File.exists?(metadata_file)
+            # by default the module tool metadata checks for a namespece
+            if ! mod_name.include?('-')
+              name = "#{namespace}-#{mod_name}"
+            else
+              name = mod_name
+            end
+            begin
+              metadata = ::Puppet::ModuleTool::Metadata.new.update(
+                  'name' => name.downcase,
+                  'version' => '0.1.0',
+                  'author'  => author,
+                  'dependencies' => [
+                      { 'name' => 'puppetlabs-stdlib', 'version_requirement' => '>= 4.9.0' }
+                  ]
+              )
+            rescue ArgumentError => e
+              puts e.message
+              exit -1
+            end
+            safe_create_file(metadata_file, metadata.to_json)
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/retrospec/plugins/v1/plugin/puppet.rb

@@ -1,6 +1,8 @@
 require 'retrospec/plugins/v1/module_helpers'
 require 'retrospec/plugins/v1'
 require 'retrospec/config'
+require_relative 'generators/fact_generator'
+require_relative 'generators/module_generator'
 require_relative 'spec_object'
 require 'erb'
 require_relative 'template_helpers'
@@ -35,7 +37,7 @@ module Retrospec
           Utilities::PuppetModule.instance.module_path = module_path
           Utilities::PuppetModule.create_tmp_module_path # this is required to finish initialization
           # setting the context is require to make other methods below work.  #TODO lazy create the context
-          @context = ::Puppet::SpecObject.new(module_path, Utilities::PuppetModule.instance, config_data)
+          @context = ::Retrospec::Puppet::SpecObject.new(module_path, Utilities::PuppetModule.instance, config_data)
         end
 
         # if the module does not exist lets create it
@@ -44,17 +46,9 @@ module Retrospec
         # anything since it is not mandatory
         # I thought about using the the module face to perform this generation but it seems like its not
         # supported at this time, and you can't specify the path to generate the module in
-        def new_module
-          unless File.exist?(manifest_dir)
-            init_class = File.join(manifest_dir, 'init.pp')
-            content = File.read(File.join(template_dir, 'manifest_file.pp'))
-            print "The module located at: #{module_path} does not exist, do you wish to create it? (y/n): "
-            answer = gets.chomp
-            unless answer =~ /y/i
-              exit 1
-            end
-            create_manifest_file(init_class, content)
-          end
+        def new_module(plugin_data)
+          f = Retrospec::Puppet::Generators::ModuleGenerator.run_cli(plugin_data)
+          f.run(manifest_dir)
         end
 
         # used to display subcommand options to tglobal_confighe cli
@@ -68,16 +62,15 @@ module Retrospec
           scm_branch = ENV['RETROSPEC_PUPPET_SCM_BRANCH'] || plugin_config['plugins::puppet::templates::ref'] || 'master'
           future_parser = plugin_config['plugins::puppet::enable_future_parser'] || false
           beaker_tests  = plugin_config['plugins::puppet::enable_beaker_tests'] || false
-          namespace     = plugin_config['plugins::puppet::namespace'] || 'namespace'
           # a list of subcommands for this plugin
-          sub_commands  = [:new_module]
+          sub_commands  = ['new_module', 'new_fact']
           if sub_commands.count > 0
             sub_command_help = "Subcommands:\n#{sub_commands.join("\n")}\n"
           else
             sub_command_help = ""
           end
           plugin_opts = Trollop::options do
-            version "#{Retrospec::Puppet::VERSION} (c) Corey Osman"
+            version "Retrospec puppet plugin: #{Retrospec::Puppet::VERSION} (c) Corey Osman"
             banner <<-EOS
 Generates puppet rspec test code based on the classes and defines inside the manifests directory.\n
 #{sub_command_help}
@@ -87,12 +80,8 @@ Generates puppet rspec test code based on the classes and defines inside the man
                 :required => false, :default => template_dir
             opt :scm_url, "SCM url for retrospec templates", :type => :string, :required => false,
                 :default => scm_url
-            opt :name, "The name of the module you wish to create", :type => :string, :require => :false, :short => '-n',
-                :default => File.basename(global_opts[:module_path])
             opt :branch, "Branch you want to use for the retrospec template repo", :type => :string, :required => false,
                 :default => scm_branch
-            opt :namespace, "The namespace to use only when creating a new module", :default => namespace, :required => false,
-                :type => :string
             opt :enable_beaker_tests, "Enable the creation of beaker tests", :require => false, :type => :boolean, :default => beaker_tests
             opt :enable_future_parser, "Enables the future parser only during validation", :default => future_parser, :require => false, :type => :boolean
             stop_on sub_commands
@@ -107,13 +96,15 @@ Generates puppet rspec test code based on the classes and defines inside the man
           if plugin.respond_to?(sub_command)
             case sub_command
               when :new_module
-                plugin.send(sub_command)
+                plugin.send(sub_command, plugin_data)
                 plugin.post_init   # finish initialization
               when :run
                 plugin.post_init   # finish initialization
+              when :new_fact
+                plugin.new_fact(plugin_data)
               else
                 plugin.post_init   # finish initialization
-                plugin.send(sub_command)
+                plugin.send(sub_command, plugin_data[:module_path], plugin_data)
             end
             plugin.send(:run)
           else
@@ -122,6 +113,18 @@ Generates puppet rspec test code based on the classes and defines inside the man
           end
         end
 
+        def new_fact(plugin_data)
+          f = Retrospec::Puppet::Generators::FactGenerator.run_cli(plugin_data)
+          post_init   # finish initialization
+          f.generate_fact_file
+        end
+
+        # generates the fact spec files
+        def fact(module_path, config)
+          f = Retrospec::Puppet::Generators::FactGenerator.new(module_path, config)
+          f.generate_fact_spec_files
+        end
+
         # this is the main method the starts all the magic
         def run
           run_pre_hook
@@ -168,7 +171,8 @@ Generates puppet rspec test code based on the classes and defines inside the man
         def create_files
           types = context.types
           safe_create_module_files
-          generate_metadata_file
+          fact(module_path, config_data)
+          Retrospec::Puppet::Generators::ModuleGenerator.generate_metadata_file(context.module_name, config_data)
           # a Type is nothing more than a defined type or puppet class
           # we could have named this manifest but there could be multiple types
           # in a manifest.
@@ -303,41 +307,6 @@ Generates puppet rspec test code based on the classes and defines inside the man
           '.pp'
         end
 
-        def create_manifest_file(dest, content)
-          # replace the name in the target file with the module_name from this class
-          # I would have just used a template but the context does not exist yet
-          new_content = content.gsub('CLASS_NAME', config_data[:name])
-          safe_create_file(dest, new_content)
-        end
-
-        # generates the metadata file in the module directory
-        def generate_metadata_file
-          require 'puppet/module_tool/metadata'
-          # make sure the metadata file exists
-          metadata_file = File.join(module_path, 'metadata.json')
-          unless File.exists?(metadata_file)
-            # by default the module tool metadata checks for a namespece
-            if ! config_data[:name].include?('-')
-              name = "#{config_data[:namespace]}-#{config_data[:name]}"
-            else
-              name = config_data[:name]
-            end
-            begin
-              metadata = ::Puppet::ModuleTool::Metadata.new.update(
-                  'name' => name,
-                  'version' => '0.1.0',
-                  'author'  => (config_data['plugins::puppet::author'] || nil ),
-                  'dependencies' => [
-                      { 'name' => 'puppetlabs-stdlib', 'version_requirement' => '>= 1.0.0' }
-                  ]
-              )
-            rescue ArgumentError => e
-              puts e.message
-              exit -1
-            end
-            safe_create_file(metadata_file, metadata.to_json)
-          end
-        end
       end
     end
   end

data/lib/retrospec/plugins/v1/plugin/spec_object.rb

@@ -1,65 +1,70 @@
 require 'retrospec/plugins/v1/context_object'
+module Retrospec
+  module Puppet
+    # this object is passed to the templates for erb template rendering
+    # you can use data contained in this object in your templates
+    class SpecObject < Retrospec::Plugins::V1::ContextObject
 
-module Puppet
-  # this object is passed to the templates for erb template rendering
-  # you can use data contained in this object in your templates
-  class SpecObject < Retrospec::Plugins::V1::ContextObject
+      attr_reader :instance, :module_path, :module_name, :all_hiera_data, :config
+      attr_accessor :enable_beaker_tests, :parameters, :types, :resources, :type
 
-    attr_reader :instance, :module_path, :module_name, :all_hiera_data, :config
-    attr_accessor :enable_beaker_tests, :parameters, :types, :resources, :type
 
+      def initialize(mod_path, instance_data, config_data)
+        @instance = instance_data
+        @config = config_data
+        @module_path = mod_path
+        all_hiera_data
+      end
 
-    def initialize(mod_path, instance_data, config_data)
-      @instance = instance_data
-      @config = config_data
-      @module_path = mod_path
-      all_hiera_data
-    end
-
-    def module_name
-      instance.module_name
-    end
-
-    def types
-      instance.types
-    end
+      def module_name
+        instance.module_name
+      end
 
-    def class_hiera_data(classname)
-      data = {}
-      types.each do |t|
-        next unless t.type == :hostclass   #defines don't have hiera lookup values
-        next unless t.name == classname
-        t.arguments.each do |k, v|
-          key = "#{t.name}::#{k}"
-          data[key] = nil
-        end
+      def types
+        instance.types
       end
-      data
-    end
 
-    # gathers all the class parameters that could be used in hiera data mocking
-    def all_hiera_data
-      if @all_hiera_data.nil?
-        @all_hiera_data = {}
+      def class_hiera_data(classname)
+        data = {}
         types.each do |t|
           next unless t.type == :hostclass   #defines don't have hiera lookup values
+          next unless t.name == classname
           t.arguments.each do |k, v|
             key = "#{t.name}::#{k}"
-            @all_hiera_data[key] = nil
+            data[key] = nil
           end
         end
+        data
       end
-      @all_hiera_data
-    end
 
-    def enable_beaker_tests?
-      config[:enable_beaker_tests]
-    end
+      # gathers all the class parameters that could be used in hiera data mocking
+      def all_hiera_data
+        if @all_hiera_data.nil?
+          @all_hiera_data = {}
+          types.each do |t|
+            next unless t.type == :hostclass   #defines don't have hiera lookup values
+            t.arguments.each do |k, v|
+              key = "#{t.name}::#{k}"
+              @all_hiera_data[key] = nil
+            end
+          end
+        end
+        @all_hiera_data
+      end
 
-    # allows the user to use the variable store to resolve the variable if it exists
-    def variable_value(key)
-      VariableStore.resolve(key)
-    end
+      def enable_beaker_tests?
+        config[:enable_beaker_tests]
+      end
 
+      # allows the user to use the variable store to resolve the variable if it exists
+      def variable_value(key)
+        VariableStore.resolve(key)
+      end
+
+      def fact_name
+        instance[:name]
+      end
+
+    end
   end
-end
+end

data/lib/retrospec/plugins/v1/plugin/version.rb

@@ -1,5 +1,5 @@
 module Retrospec
   module Puppet
-    VERSION = '0.10.0'
+    VERSION = '0.11.0'
   end
 end

data/puppet-retrospec.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "puppet-retrospec"
-  s.version = "0.10.0"
+  s.version = "0.11.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Corey Osman"]
-  s.date = "2015-10-12"
+  s.date = "2015-10-26"
   s.description = "Retrofits and generates valid puppet rspec test code to existing modules"
   s.email = "corey@logicminds.biz"
   s.extra_rdoc_files = [
@@ -29,6 +29,9 @@ Gem::Specification.new do |s|
     "VERSION",
     "lib/retrospec-puppet.rb",
     "lib/retrospec/plugins/v1/plugin/conditional.rb",
+    "lib/retrospec/plugins/v1/plugin/generators/fact_generator.rb",
+    "lib/retrospec/plugins/v1/plugin/generators/facter.rb",
+    "lib/retrospec/plugins/v1/plugin/generators/module_generator.rb",
     "lib/retrospec/plugins/v1/plugin/helpers.rb",
     "lib/retrospec/plugins/v1/plugin/puppet.rb",
     "lib/retrospec/plugins/v1/plugin/puppet_module.rb",
@@ -40,6 +43,9 @@ Gem::Specification.new do |s|
     "lib/retrospec/plugins/v1/plugin/variable_store.rb",
     "lib/retrospec/plugins/v1/plugin/version.rb",
     "puppet-retrospec.gemspec",
+    "spec/fixtures/facts/datacenter_facts.rb",
+    "spec/fixtures/facts/facts_with_methods.rb",
+    "spec/fixtures/facts/node_role.rb",
     "spec/fixtures/fixture_modules/one_resource_module/manifests/another_resource.pp",
     "spec/fixtures/fixture_modules/one_resource_module/manifests/inherits_params.pp",
     "spec/fixtures/fixture_modules/one_resource_module/manifests/one_resource_class.pp",
@@ -559,6 +565,8 @@ Gem::Specification.new do |s|
     "spec/integration/retrospec_spec.rb",
     "spec/spec_helper.rb",
     "spec/unit/conditional_spec.rb",
+    "spec/unit/generators/fact_generater_spec.rb",
+    "spec/unit/generators/fact_spec.rb",
     "spec/unit/module_spec.rb",
     "spec/unit/plugin_spec.rb",
     "spec/unit/puppet-retrospec_spec.rb",
@@ -1822,7 +1830,8 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<trollop>, [">= 0"])
-      s.add_runtime_dependency(%q<retrospec>, ["~> 0.4.0"])
+      s.add_runtime_dependency(%q<retrospec>, ["~> 0.4"])
+      s.add_runtime_dependency(%q<awesome_print>, [">= 0"])
       s.add_development_dependency(%q<rspec>, ["~> 3.2"])
       s.add_development_dependency(%q<puppet>, ["= 3.7.3"])
       s.add_development_dependency(%q<yard>, ["~> 0.7"])
@@ -1833,7 +1842,8 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<fakefs>, [">= 0"])
     else
       s.add_dependency(%q<trollop>, [">= 0"])
-      s.add_dependency(%q<retrospec>, ["~> 0.4.0"])
+      s.add_dependency(%q<retrospec>, ["~> 0.4"])
+      s.add_dependency(%q<awesome_print>, [">= 0"])
       s.add_dependency(%q<rspec>, ["~> 3.2"])
       s.add_dependency(%q<puppet>, ["= 3.7.3"])
       s.add_dependency(%q<yard>, ["~> 0.7"])
@@ -1845,7 +1855,8 @@ Gem::Specification.new do |s|
     end
   else
     s.add_dependency(%q<trollop>, [">= 0"])
-    s.add_dependency(%q<retrospec>, ["~> 0.4.0"])
+    s.add_dependency(%q<retrospec>, ["~> 0.4"])
+    s.add_dependency(%q<awesome_print>, [">= 0"])
     s.add_dependency(%q<rspec>, ["~> 3.2"])
     s.add_dependency(%q<puppet>, ["= 3.7.3"])
     s.add_dependency(%q<yard>, ["~> 0.7"])

data/spec/fixtures/facts/datacenter_facts.rb

@@ -0,0 +1,15 @@
+# this is an example of a fact file with multiple facts
+Facter.add(:fact1) do
+  confine :kernel => 'Linux'
+  setcode do
+    'value1'
+  end
+end
+Facter.add(:fact2) do
+  confine :kernel => 'Windows'
+  setcode do
+    'value2'
+    Facter::Core::Execution.execute('which lsb')
+
+  end
+end

data/spec/fixtures/facts/facts_with_methods.rb

@@ -0,0 +1,19 @@
+# this is just an example fact that uses method logic outside the Facter.add block
+def default_kernel
+  if Facter.value(:kernel) == 'Windows'
+    'Windows'
+  else
+    'Linux'
+  end
+end
+
+Facter.add(:method_fact) do
+  confine :kernel => 'Linux'
+  confine :osfamily => 'RedHat'
+  setcode do
+    is_virtual = Facter.fact(:is_virtual).value
+    default_kernel
+    Facter::Core::Execution.execute('which lsb')
+  end
+end
+

data/spec/fixtures/facts/node_role.rb

@@ -0,0 +1,8 @@
+# this is just an example fact that uses confines and returns a default value
+Facter.add(:node_role) do
+  confine :kernel => 'Windows'
+  confine :is_virtual => true
+  setcode do
+    'default_role'
+  end
+end

data/spec/spec_helper.rb

@@ -11,6 +11,10 @@ def fixtures_path
   @fixtures_path ||= File.expand_path(File.join(File.dirname(__FILE__), 'fixtures'))
 end
 
+def fixtures_facts_path
+  @fixtures_facts_path ||= File.expand_path(File.join(fixtures_path, 'facts'))
+end
+
 def clean_up_spec_dir(dir)
   #puts "removing directory #{dir}"
   FileUtils.rm_rf(File.join(dir, 'spec'))

data/spec/unit/conditional_spec.rb

@@ -2,9 +2,6 @@ require 'spec_helper'
 
 describe "conditional" do
 
-
-
-
   after :all do
     # enabling the removal slows down tests, but from time to time we may need to
     FileUtils.rm_rf(fixture_modules_path) if ENV['RETROSPEC_CLEAN_UP_TEST_MODULES'] =~ /true/

data/spec/unit/generators/fact_generater_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe "fact generator" do
+
+  before :each do
+    FileUtils.rm_rf(facter_spec_dir)
+    allow(generator).to receive(:facter_dir).and_return(fixtures_facts_path)
+    allow(generator).to receive(:fact_name_path).and_return(File.join(module_path, 'lib', 'facter', "#{generator.fact_name}.rb"))
+  end
+
+  after :each do
+    FileUtils.rm_f(generator.fact_name_path) # ensure the file does not exist
+  end
+
+  let(:facter_spec_dir) do
+    File.join(module_path, 'spec', 'unit', 'facter')
+  end
+
+  let(:module_path) do
+    File.join(fixture_modules_path, 'tomcat')
+  end
+
+  let(:context) do
+    {:name => 'datacenter', :template_dir => File.expand_path(File.join(ENV['HOME'], '.retrospec', 'repos', 'retrospec-puppet-templates'))}
+  end
+
+  let(:generator) do
+    Retrospec::Puppet::Generators::FactGenerator.new(module_path, context )
+  end
+
+  it 'returns facter dir' do
+    expect(generator.facter_dir).to eq(fixtures_facts_path)
+  end
+
+  it 'returns module path' do
+    expect(generator.facter_spec_dir).to eq(facter_spec_dir)
+  end
+
+  it 'can return fact name' do
+    expect(generator.fact_name).to eq('datacenter')
+  end
+
+  it 'can generate a fact file' do
+    expect(generator.generate_fact_file.count).to eq(3)
+    expect(File.exists?(File.join(generator.facter_dir, "#{generator.fact_name}.rb")))
+  end
+
+  it 'can generate a spec file' do
+
+    expect(generator.generate_fact_spec_files.count).to eq(3)
+  end
+
+end

data/spec/unit/generators/fact_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+describe "facter" do
+
+  let(:file) do
+    File.join(fixtures_facts_path , 'node_role.rb')
+  end
+
+  it 'can eval code' do
+    models = Retrospec::Puppet::Generators::Facter.load_fact(file)
+    fact_name = models.facts.keys.first
+    fact_data = models.facts[fact_name]
+    confines = fact_data.confines
+    model_facts = models.facts[fact_name].used_facts
+    global_used_facts = models.global_used_facts
+    expect(fact_name).to eq(:node_role)
+    expect(confines).to eq([{:kernel=>"Windows"}, {:is_virtual=>true}])
+    expect(model_facts).to eq({})
+    expect(global_used_facts).to eq({})
+  end
+
+  describe 'multiple facts' do
+    let(:file) do
+      File.join(fixtures_facts_path , 'datacenter_facts.rb')
+    end
+
+    it 'can eval code with multiple facts' do
+      models = Retrospec::Puppet::Generators::Facter.load_fact(file)
+      global_used_facts = models[:global_used_facts]
+      fact_name = models.facts.keys.first
+      fact_data = models.facts[fact_name]
+      confines = fact_data.confines
+      model_facts = fact_data.used_facts
+      expect(fact_name).to eq(:fact1)
+      expect(confines).to eq([{:kernel=>"Linux"}])
+      expect(model_facts).to eq({})
+      expect(global_used_facts).to eq({})
+      fact_name = models.facts.keys.last
+      fact_data = models.facts[fact_name]
+      confines = fact_data.confines
+      model_facts = fact_data.used_facts
+      expect(fact_name).to eq(:fact2)
+      expect(confines).to eq([{:kernel=>"Windows"}])
+      expect(model_facts).to eq({})
+      expect(global_used_facts).to eq({})
+    end
+  end
+
+  describe 'fact value' do
+    let(:file) do
+      File.join(fixtures_facts_path , 'facts_with_methods.rb')
+    end
+    it 'can be processed' do
+      Retrospec::Puppet::Generators::Facter.load_fact(file)
+    end
+  end
+
+end

data/spec/unit/puppet-retrospec_spec.rb

@@ -63,10 +63,13 @@ describe "puppet-retrospec" do
     it 'should create a module when it does not exist' do
       opts = {'plugins::puppet::author' => 'test_name', :module_path => '/tmp/new_module', :create => true,
               :namespace => 'retrospec', :enable_beaker_tests => false,
-              :enable_user_templates => false, :name => 'moduletest', :template_dir => nil, :enable_future_parser => true }
+              :enable_user_templates => false, :name => 'moduletest',
+              :template_dir => File.expand_path(File.join(ENV['HOME'], '.retrospec', 'repos', 'retrospec-puppet-templates')),
+                                                :enable_future_parser => true }
+      ENV['RETROSPEC_PUPPET_AUTO_GENERATE'] = 'true'
       new_module = Retrospec::Plugins::V1::Puppet.new(opts[:module_path], opts)
       allow(new_module).to receive(:gets).and_return("y\n")
-      new_module.new_module
+      new_module.new_module(opts)
       new_module.post_init
       new_module.run
       expect(File.exists?(File.join(new_module.manifest_dir, 'init.pp'))).to eq(true)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-retrospec
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Corey Osman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-12 00:00:00.000000000 Z
+date: 2015-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trollop
@@ -30,14 +30,28 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: '0.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  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
@@ -170,6 +184,9 @@ files:
 - VERSION
 - lib/retrospec-puppet.rb
 - lib/retrospec/plugins/v1/plugin/conditional.rb
+- lib/retrospec/plugins/v1/plugin/generators/fact_generator.rb
+- lib/retrospec/plugins/v1/plugin/generators/facter.rb
+- lib/retrospec/plugins/v1/plugin/generators/module_generator.rb
 - lib/retrospec/plugins/v1/plugin/helpers.rb
 - lib/retrospec/plugins/v1/plugin/puppet.rb
 - lib/retrospec/plugins/v1/plugin/puppet_module.rb
@@ -181,6 +198,9 @@ files:
 - lib/retrospec/plugins/v1/plugin/variable_store.rb
 - lib/retrospec/plugins/v1/plugin/version.rb
 - puppet-retrospec.gemspec
+- spec/fixtures/facts/datacenter_facts.rb
+- spec/fixtures/facts/facts_with_methods.rb
+- spec/fixtures/facts/node_role.rb
 - spec/fixtures/fixture_modules/one_resource_module/manifests/another_resource.pp
 - spec/fixtures/fixture_modules/one_resource_module/manifests/inherits_params.pp
 - spec/fixtures/fixture_modules/one_resource_module/manifests/one_resource_class.pp
@@ -700,6 +720,8 @@ files:
 - spec/integration/retrospec_spec.rb
 - spec/spec_helper.rb
 - spec/unit/conditional_spec.rb
+- spec/unit/generators/fact_generater_spec.rb
+- spec/unit/generators/fact_spec.rb
 - spec/unit/module_spec.rb
 - spec/unit/plugin_spec.rb
 - spec/unit/puppet-retrospec_spec.rb