puppet-retrospec 1.3.2 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1f328e9862dddc6c820ec45e1eede2b31fcdacd9
-  data.tar.gz: 1529743a6bf2c40ac94639566f57969596bcfce6
+  metadata.gz: b6e329b9bf28b9a369953d9fca8ff19d1cc32e82
+  data.tar.gz: f5198887c6b93f1b6b44383d2dd3f9183cb001eb
 SHA512:
-  metadata.gz: cc34e24096c58029d2d26f83a223e2e8755fe2a1d6c1a565bebce3fc12d56f5d77a82664f426d4a7d9364bfa2788499355d9daaadad6886f1c534802a17e3f17
-  data.tar.gz: 7e6773fb54a027563e4d4ad6eef61180115ed42d735588de56dc0c21ca920f7d998c3d0cf22d53116acd14e9b86a339bd5e76906a7b28ef7273458dc9f718196
+  metadata.gz: e3601799c03379311d561889c8f9ecf7bafab7c817cf40d68ada86ed4ddbf572e01fd1dee95f685dcd6652c09c4efda9166dba6c30af767fd104d870c608f226
+  data.tar.gz: c21306e18c27ffac761fa3384c93f923b68063fe69e944b62bf828771b40634b62d9f3700eb0ebb0cda9aed1f0e3466a9cc0f7ad7fd54b1ec8932dc2cfb1437a

data/.rubocop_todo.yml

@@ -5,7 +5,8 @@
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
-
+Bundler/OrderedGems:
+  Enabled: false
 Style/MultilineIfModifier:
   Exclude:
     - 'lib/retrospec/plugins/v1/plugin/generators/serializers/rspec_dumper_full.rb'
@@ -159,6 +160,7 @@ Style/AccessorMethodName:
     - 'lib/retrospec/plugins/v1/plugin/generators/parsers/function.rb'
     - 'lib/retrospec/plugins/v1/plugin/generators/parsers/type.rb'
     - 'lib/retrospec/plugins/v1/plugin/helpers.rb'
+    - 'lib/retrospec/plugins/v1/plugin/generators/base_generator.rb'
 
 # Offense count: 14
 # Cop supports --auto-correct.

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 1.4.0
+ * Fixes gh-67 - adds abiltity to auto generate data in a module
+ * Forces retrospec version 0.6.2 or greater
 ## 1.3.2
  * Fixes gh-70 - Finding puppetfiles in nested folders
 ## 1.3.1

data/Gemfile

@@ -2,7 +2,7 @@ source 'http://rubygems.org'
 
 gem 'awesome_print'
 gem 'facets'
-gem 'retrospec', '~> 0.6'
+gem 'retrospec', '>= 0.6.1'
 gem 'trollop'
 
 group :development do
@@ -20,4 +20,5 @@ group :test do
   gem 'rspec', '~> 3.2'
   gem 'rubocop'
   gem 'yard', '~> 0.7'
+  gem 'puppet-retrospec', :path => './'
 end

data/Gemfile.lock

@@ -1,3 +1,12 @@
+PATH
+  remote: .
+  specs:
+    puppet-retrospec (1.4.0)
+      awesome_print
+      facets
+      retrospec (>= 0.6.2)
+      trollop
+
 PATH
   remote: vendor/gems/puppet-4.5.2
   specs:
@@ -40,7 +49,7 @@ GEM
     rake (11.3.0)
     rdoc (3.12.2)
       json (~> 1.4)
-    retrospec (0.6.0)
+    retrospec (0.6.2)
       trollop
     rspec (3.5.0)
       rspec-core (~> 3.5.0)
@@ -79,13 +88,14 @@ DEPENDENCIES
   overcommit
   pry
   puppet (= 4.5.2)!
+  puppet-retrospec!
   rake
   rdoc (~> 3.12)
-  retrospec (~> 0.6)
+  retrospec (>= 0.6.1)
   rspec (~> 3.2)
   rubocop
   trollop
   yard (~> 0.7)
 
 BUNDLED WITH
-   1.13.7
+   1.14.6

data/README.md

@@ -50,6 +50,16 @@ TOC Created by [gh-md-toc](https://github.com/ekalinin/github-markdown-toc)
 [![Gem Version](https://badge.fury.io/rb/puppet-retrospec.svg)](http://badge.fury.io/rb/puppet-retrospec)
 
 ## News
+### 4/20/17
+With all the changes in hiera recently and the ability to provide data in puppet modules.  I thought it would be a good 
+time to create a generator for retrospec to create hiera backends and data in module scaffolding. With the 1.6.0 release
+you are now a simple step away to retrofitting data into your module.
+
+Just run `retrospec puppet module_data` to auto create the scaffolding. 
+
+Note: You must be using puppet 4.7+ (PE 2016.4.x) to actually use data in a module, but there is nothing stopping
+you from creating the scaffolding.
+
 ### 3/7/17
 You can now sync files.  Any template file that contains a `.sync` in the file name will automatically
 be syncronized.  This is especially helpful for Gemfiles, Rakefiles and other static files that need to be updated.

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

@@ -85,6 +85,10 @@ module Retrospec
             File.expand_path(File.join(File.dirname(File.dirname(__FILE__)), 'templates', plural_name))
           end
         end
+
+        def get_binding
+          binding
+        end
       end
     end
   end

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

@@ -12,9 +12,9 @@ module Retrospec
           # 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.
-          @context = OpenStruct.new(:name => spec_object[:name], :return_type => spec_object[:return_type],
+          @context = OpenStruct.new({ :name => spec_object[:name], :return_type => spec_object[:return_type],
                                     :function_type => spec_object[:type],
-                                    :test_type => spec_object[:test_type])
+                                    :test_type => spec_object[:test_type] }.merge(spec_object))
         end
 
         # Puppet currently has two versions of functions (v3, v4).  At the time of writing v4 is still new
@@ -111,7 +111,7 @@ Generates a new function with the given name.
 
         # returns the name of the function
         def function_name
-          context.name
+          context.name.gsub('::', '_')
         end
 
         def function_file_path
@@ -119,8 +119,9 @@ Generates a new function with the given name.
         end
 
         # generates the function file based on the template and context
-        def generate_function_file
-          safe_create_template_file(function_path, function_file_path, context)
+        def generate_function_file(template = nil)
+          template ||= function_file_path
+          safe_create_template_file(function_path, template, context)
           function_path
         end
 

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

@@ -0,0 +1,115 @@
+require 'retrospec/plugins/v1/module_helpers'
+require 'retrospec/plugins/v1'
+
+module Retrospec
+  module Puppet
+    module Generators
+      class ModuleDataGenerator < Retrospec::Puppet::Generators::BaseGenerator
+        attr_reader :module_name, :spec_object
+        def initialize(module_path, spec_object = {})
+          super
+          @plural_name = 'module_data'
+          @spec_object = spec_object
+          @singular_name = @plural_name
+        end
+
+        def module_name
+          @module_name ||= Utilities::PuppetModule.instance.module_name.split(%r{-|\/}).last
+        end
+
+        # @return [String] backend type
+        def backend_type
+          context.backend_type
+        end
+
+        # @return [String] backend name
+        def backend_name
+          context.backend_name
+        end
+
+        # @return [String] function type
+        def backend_function_type
+          context.function_type
+        end
+
+        def generate_module_data_for_hiera
+          safe_create_directory_files(template_dir, module_path, context, /functions/)
+        end
+
+        def generate_hiera_file
+          path = File.join(module_path, 'hiera.yaml')
+          template = File.join(template_dir, 'hiera.yaml.retrospec.erb')
+          safe_create_template_file(path, template, self)
+        end
+
+        def generate_module_data_for_function(_type)
+          data = { :name => backend_name,
+                   :type => backend_function_type,
+                   :test_type => 'rspec',
+                   :module_name => module_name }.merge(spec_object)
+          f = FunctionGenerator.new(module_path, data)
+          ext = backend_function_type == 'native' ? 'pp' : 'rb'
+          template_path = File.join(template_dir, 'functions', backend_function_type, "function_#{backend_type}.#{ext}.retrospec.erb")
+          f.generate_function_file(template_path)
+          generate_hiera_file
+        end
+
+        def template_dir
+          external_templates = File.expand_path(File.join(config_data[:template_dir], @plural_name))
+          if File.exist?(external_templates)
+            File.join(config_data[:template_dir], 'module_data')
+          else
+            File.expand_path(File.join(File.dirname(File.dirname(__FILE__)), 'templates', @plural_name))
+          end
+        end
+
+        def run
+          if backend_type == 'hiera'
+            generate_module_data_for_hiera
+          else
+            generate_module_data_for_function(backend_type)
+          end
+        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 the parameters
+        def self.run_cli(global_opts, args = ARGV)
+          backend_types = %w(hiera data_hash lookup_key data_dig)
+          sub_command_opts = Trollop.options(args) do
+            banner <<-EOS
+Generate the scaffolding required to use data in a module from hiera or a custom hiera backend.
+ * Data in module is only available in puppet 4.7+
+ * Hiera 5 backends are only available in puppet 4.9+
+    * https://docs.puppet.com/puppet/4.10/hiera_custom_backends.html
+
+Examples:
+  retrospec puppet module_data -b data_hash -n my_custom_hash -t native
+  retrospec puppet module_data  (uses defaults which is the hiera backend type, most people will want this )
+
+Options:
+
+            EOS
+            opt :backend_type, "Which hiera backend type to use (#{backend_types.join(', ')})",
+                :type => :string, :required => false, default: 'hiera', :short => '-b'
+            opt :backend_name, 'The name of the custom backend',
+                :type => :string, :required => false, default: 'custom', :short => '-n'
+            opt :function_type, 'What type of function to create the backend type with (native or v4)',
+                :type => :string, :required => false, default: 'native', :short => '-t'
+          end
+          unless backend_types.include?(sub_command_opts[:backend_type])
+            Trollop.die :backend_type, "must be one of #{backend_types.join(', ')}"
+          end
+          unless %w(native v4).include?(sub_command_opts[:function_type])
+            Trollop.die :function_type, "must be one of #{%w(native v4).join(', ')}"
+          end
+
+          plugin_data = global_opts.merge(sub_command_opts)
+          plugin_data
+        end
+      end
+    end
+  end
+end

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

@@ -92,7 +92,7 @@ module Retrospec
           scm_branch = ENV['RETROSPEC_PUPPET_SCM_BRANCH'] || plugin_config['plugins::puppet::templates::ref'] || 'master'
           beaker_tests  = plugin_config['plugins::puppet::enable_beaker_tests'] || false
           # a list of subcommands for this plugin
-          sub_commands  = %w(new_module new_fact new_type new_provider new_function new_report)
+          sub_commands  = %w(new_module new_fact new_type new_provider new_function new_report module_data)
           if sub_commands.count > 0
             sub_command_help = "Subcommands:\n  #{sub_commands.join("\n  ")}\n"
           else
@@ -165,6 +165,12 @@ Generates puppet rspec test code and puppet module components.
           plugin_data
         end
 
+        def module_data(module_path, config, args=[])
+          plugin_data = Retrospec::Puppet::Generators::ModuleDataGenerator.run_cli(config, args)
+          p = Retrospec::Puppet::Generators::ModuleDataGenerator.new(module_path, plugin_data)
+          p.run
+        end
+
         def new_report(module_path, config, args=[])
           plugin_data = Retrospec::Puppet::Generators::ReportGenerator.run_cli(config, args)
           p = Retrospec::Puppet::Generators::ReportGenerator.new(module_path, plugin_data)

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

@@ -1,5 +1,5 @@
 module Retrospec
   module Puppet
-    VERSION = '1.3.2'
+    VERSION = '1.4.0'
   end
 end

data/puppet-retrospec.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   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 = "2017-03-17"
+  s.date = "2017-04-20"
   s.description = "Retrofits and generates valid puppet rspec test code to existing modules"
   s.email = "corey@nwops.io"
   s.extra_rdoc_files = [
@@ -24,7 +24,7 @@ Gem::Specification.new do |s|
   s.rubygems_version = "2.4.5.1"
   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."
   s.add_runtime_dependency(%q<trollop>, [">= 0"])
-  s.add_runtime_dependency(%q<retrospec>, ["~> 0.6"])
+  s.add_runtime_dependency(%q<retrospec>, [">= 0.6.2"])
   s.add_runtime_dependency(%q<awesome_print>, [">= 0"])
   s.add_runtime_dependency(%q<facets>, [">= 0"])
   s.add_development_dependency(%q<rdoc>, ["~> 3.12"])

data/spec/unit/generators/module_data_spec.rb

@@ -0,0 +1,148 @@
+require 'spec_helper'
+
+describe 'ModuleDataGenerator' do
+  let(:cli_opts) do
+    cli_opts = Retrospec::Puppet::Generators::ModuleDataGenerator.run_cli(context, opts)
+  end
+
+  let(:context) do
+    { :module_path => module_path,
+      :template_dir => retrospec_templates_path }
+  end
+
+  let(:module_path) do
+    File.join(fixture_modules_path, 'tomcat')
+  end
+
+  let(:generator) do
+    Retrospec::Puppet::Generators::ModuleDataGenerator.new(module_path, cli_opts)
+  end
+
+  before(:each) do
+    FileUtils.rm_rf(File.join(module_path, 'data')) # ensure the file does not exist
+    FileUtils.rm_f(File.join(module_path, 'hiera.yaml')) # ensure the file does not exist
+    FileUtils.rm_rf(File.join(module_path, 'functions')) # ensure the file does not exist
+    FileUtils.rm_rf(File.join(module_path, 'lib', 'puppet', 'functions')) # ensure the file does not exist
+
+    Utilities::PuppetModule.instance.module_dir_name = File.basename(module_path)
+    Utilities::PuppetModule.instance.module_name = File.basename(module_path)
+    Utilities::PuppetModule.instance.module_path = module_path
+    Utilities::PuppetModule.create_tmp_module_path # this is required to finish initialization
+  end
+
+  describe 'hiera' do
+    let(:opts) do
+      ['-b', 'hiera']
+    end
+    it 'works with hiera' do
+      generator.run
+      expect(File.exist?(File.join(module_path, 'data'))).to eq(true)
+      expect(File.exist?(File.join(module_path, 'functions'))).to eq(false)
+      expect(File.exist?(File.join(module_path, 'data', 'os'))).to eq(true)
+      expect(File.exist?(File.join(module_path, 'data', 'common.yaml'))).to eq(true)
+      expect(File.exist?(File.join(module_path, 'hiera.yaml'))).to eq(true)
+    end
+  end
+
+  describe 'data_hash native' do
+    let(:opts) do
+      ['-b', 'data_hash', '-n', 'my_custom', '-t', 'native']
+    end
+    it 'works with function' do
+      generator.run
+      expect(File.exist?(File.join(module_path, 'functions', 'my_custom.pp'))).to eq(true)
+      expect(File.exist?(File.join(module_path, 'data'))).to eq(false)
+      expect(File.exist?(File.join(module_path, 'data', 'os'))).to eq(false)
+      expect(File.exist?(File.join(module_path, 'data', 'common.yaml'))).to eq(false)
+      expect(File.exist?(File.join(module_path, 'hiera.yaml'))).to eq(true)
+      file_data = File.readlines(File.join(module_path, 'functions', 'my_custom.pp'))
+      expect(file_data.grep(/tomcat::my_custom/)).to eq(["function tomcat::my_custom(\n"])
+    end
+  end
+
+  describe 'data_dig native' do
+    let(:opts) do
+      ['-b', 'data_dig', '-n', 'my_custom', '-t', 'native']
+    end
+    it 'works with function' do
+      generator.run
+      expect(File.exist?(File.join(module_path, 'functions', 'my_custom.pp'))).to eq(true)
+      expect(File.exist?(File.join(module_path, 'data'))).to eq(false)
+      expect(File.exist?(File.join(module_path, 'data', 'os'))).to eq(false)
+      expect(File.exist?(File.join(module_path, 'data', 'common.yaml'))).to eq(false)
+      expect(File.exist?(File.join(module_path, 'hiera.yaml'))).to eq(true)
+      file_data = File.readlines(File.join(module_path, 'functions', 'my_custom.pp'))
+      expect(file_data.grep(/tomcat::my_custom/)).to eq(["function tomcat::my_custom(\n"])
+    end
+  end
+
+  describe 'lookup_key native' do
+    let(:opts) do
+      ['-b', 'lookup_key', '-n', 'my_custom', '-t', 'native']
+    end
+    it 'works with function' do
+      generator.run
+      expect(File.exist?(File.join(module_path, 'functions', 'my_custom.pp'))).to eq(true)
+      expect(File.exist?(File.join(module_path, 'data'))).to eq(false)
+      expect(File.exist?(File.join(module_path, 'data', 'os'))).to eq(false)
+      expect(File.exist?(File.join(module_path, 'data', 'common.yaml'))).to eq(false)
+      expect(File.exist?(File.join(module_path, 'hiera.yaml'))).to eq(true)
+      file_data = File.readlines(File.join(module_path, 'functions', 'my_custom.pp'))
+      expect(file_data.grep(/tomcat::my_custom/)).to eq(["function tomcat::my_custom(\n"])
+    end
+  end
+
+  describe 'data_hash ruby' do
+    let(:opts) do
+      ['-b', 'data_hash', '-n', 'my_custom', '-t', 'v4']
+    end
+    it 'works with function' do
+      generator.run
+      expect(File.exist?(File.join(module_path, 'lib', 'puppet', 'functions', 'my_custom.rb'))).to eq(true)
+      expect(File.exist?(File.join(module_path, 'data'))).to eq(false)
+      expect(File.exist?(File.join(module_path, 'data', 'os'))).to eq(false)
+      expect(File.exist?(File.join(module_path, 'data', 'common.yaml'))).to eq(false)
+      expect(File.exist?(File.join(module_path, 'hiera.yaml'))).to eq(true)
+      file_data = File.readlines(File.join(module_path, 'lib', 'puppet', 'functions', 'my_custom.rb'))
+      expect(file_data.grep(/tomcat::my_custom/)).to eq(["Puppet::Functions.create_function(:\"tomcat::my_custom\") do\n"])
+      expect(file_data.grep(/dispatch :my_custom/)).to eq(["  dispatch :my_custom do\n"])
+      expect(file_data.grep(/def my_custom/)).to eq(["  def my_custom(options, context)\n"])
+    end
+  end
+
+  describe 'data_dig ruby' do
+    let(:opts) do
+      ['-b', 'data_dig', '-n', 'my_custom', '-t', 'v4']
+    end
+    it 'works with function' do
+      generator.run
+      expect(File.exist?(File.join(module_path, 'lib', 'puppet', 'functions', 'my_custom.rb'))).to eq(true)
+      expect(File.exist?(File.join(module_path, 'data'))).to eq(false)
+      expect(File.exist?(File.join(module_path, 'data', 'os'))).to eq(false)
+      expect(File.exist?(File.join(module_path, 'data', 'common.yaml'))).to eq(false)
+      expect(File.exist?(File.join(module_path, 'hiera.yaml'))).to eq(true)
+      file_data = File.readlines(File.join(module_path, 'lib', 'puppet', 'functions', 'my_custom.rb'))
+      expect(file_data.grep(/tomcat::my_custom/)).to eq(["Puppet::Functions.create_function(:\"tomcat::my_custom\") do\n"])
+      expect(file_data.grep(/dispatch :my_custom/)).to eq(["  dispatch :my_custom do\n"])
+      expect(file_data.grep(/def my_custom/)).to eq(["  def my_custom(segments, options, context)\n"])
+    end
+  end
+
+  describe 'lookup_key ruby' do
+    let(:opts) do
+      ['-b', 'lookup_key', '-n', 'my_custom', '-t', 'v4']
+    end
+    it 'works with function' do
+      generator.run
+      expect(File.exist?(File.join(module_path, 'lib', 'puppet', 'functions', 'my_custom.rb'))).to eq(true)
+      expect(File.exist?(File.join(module_path, 'data'))).to eq(false)
+      expect(File.exist?(File.join(module_path, 'data', 'os'))).to eq(false)
+      expect(File.exist?(File.join(module_path, 'data', 'common.yaml'))).to eq(false)
+      expect(File.exist?(File.join(module_path, 'hiera.yaml'))).to eq(true)
+      file_data = File.readlines(File.join(module_path, 'lib', 'puppet', 'functions', 'my_custom.rb'))
+      expect(file_data.grep(/tomcat::my_custom/)).to eq(["Puppet::Functions.create_function(:\"tomcat::my_custom\") do\n"])
+      expect(file_data.grep(/dispatch :my_custom/)).to eq(["  dispatch :my_custom do\n"])
+      expect(file_data.grep(/def my_custom/)).to eq(["  def my_custom(key, options, context)\n"])
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-retrospec
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.4.0
 platform: ruby
 authors:
 - Corey Osman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-17 00:00:00.000000000 Z
+date: 2017-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trollop
@@ -28,16 +28,16 @@ dependencies:
   name: retrospec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: 0.6.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: 0.6.2
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
@@ -129,6 +129,7 @@ files:
 - lib/retrospec/plugins/v1/plugin/generators/fact_generator.rb
 - lib/retrospec/plugins/v1/plugin/generators/function_generator.rb
 - lib/retrospec/plugins/v1/plugin/generators/hostclass_generator.rb
+- lib/retrospec/plugins/v1/plugin/generators/module_data_generator.rb
 - lib/retrospec/plugins/v1/plugin/generators/module_generator.rb
 - lib/retrospec/plugins/v1/plugin/generators/node_generator.rb
 - lib/retrospec/plugins/v1/plugin/generators/parsers/facter.rb
@@ -415,6 +416,7 @@ files:
 - spec/unit/generators/function_generator_spec.rb
 - spec/unit/generators/function_spec.rb
 - spec/unit/generators/hostclass_generator_spec.rb
+- spec/unit/generators/module_data_spec.rb
 - spec/unit/generators/node_generator_spec.rb
 - spec/unit/generators/parsers/fact_spec.rb
 - spec/unit/generators/parsers/provider_spec.rb