puppet-retrospec 0.12.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7546e86b698b80a13fbecf6fe9eb3c0af22c404e
-  data.tar.gz: a11141ddd056cbc6ec55c0720e01bf58d4f3c21e
+  metadata.gz: 4de2854b6c2b6674f37bc22022748b044129724c
+  data.tar.gz: 009dcf84cc52f7ae9a49bc85a047c7d178bc4356
 SHA512:
-  metadata.gz: 7ac02b13f25bac9005750699ed27e065d1b898a767c2452d1fa4aeea9da872256a1720aa7ab154c7876fa14a06debee912a3673d9126a54e658712be5255e558
-  data.tar.gz: 02c3b1f2f628fda3588acbb989a02571a51fa685b717a5657972b1e7e9f921f920adc747e9bf1c3cc0534773c764a44509d27a9c9b304def4129c09d9e4bc39a
+  metadata.gz: 06478ad8cf39bffc20b41fa6fb2f5c1ac7b79128b982833ab3573135781d590fb9d14cb8869e7b176a9c8cb5f57a0f1c2e62d11ffd9c550d6dc04d7b8acb5ddb
+  data.tar.gz: fe4b5dd3a1341c8e649d6509e22b62b1423cd93e47a780ef8c8aee52fa13a533144e23c5f4df2a3dda052520560e7d56e61e5b61a09f86e6a36505c8c4cd8ba5

data/.dockerignore

@@ -0,0 +1,4 @@
+pkg
+bundle
+.bundle
+.git

data/.gitlab-ci.yml

@@ -1,7 +1,10 @@
 variables:
   #RETROSPEC_TEMPLATES_DIR: /root/.retrospec/repos/retrospec-puppet-templates
 before_script:
+  - gem install bundler
   - bundle install --without development build
+  - bundle exec ruby lib/retrospec/plugins/v1/plugin/templates/clone-hook
+
 ruby193:
   stage: test
   script:
@@ -20,6 +23,18 @@ ruby2.1:
     - "bundle exec rake spec"
   image: ruby:2.1
 
+ruby2.2:
+  stage: test
+  script:
+    - "bundle exec rake spec"
+  image: ruby:2.2
+
+ruby2.3:
+  stage: test
+  script:
+    - "bundle exec rake spec"
+  image: ruby:2.3
+
 stages:
   - test
   - deploy

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## 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
+ for generating more test coverage.
+ This release is a breaking release which requires your puppet code to adhere
+ to the new parser rules.  If you are not able update your puppet code you should use the pre 1.x releases of retrospec puppet.
+
+ * 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/DEVELOPMENT.md

@@ -1,3 +1,5 @@
 # Development
 
-Coming soon
+## Vendoring libraries
+gem unpack puppet -​-target vendor/gems
+gem specification --ruby puppet > vendor/gems/puppet-4.5.2/puppet.gemspec

data/Dockerfile

@@ -0,0 +1,22 @@
+FROM ruby:2.2
+MAINTAINER Corey Osman
+RUN useradd developer -m -s /bin/bash
+USER developer
+WORKDIR /home/developer/module
+ENV HOME /home/developer
+ENV GEM_HOME "${HOME}/.gems"
+ENV PATH "$${PATH}:${HOME}/bin"
+# don't include ri/rdoc with gem installs
+RUN mkdir /home/developer/puppet-retrospec && echo "gem: --no-rdoc --no-ri --bindir ~/bin\ngemdir: ~/.gems" > /home/developer/.gemrc
+
+# Install
+COPY ./ /home/developer/puppet-retrospec
+RUN cd /home/developer/puppet-retrospec && \
+    gem build puppet-retrospec.gemspec && \
+    gem install /home/developer/puppet-retrospec/puppet-retrospec*.gem facter hiera
+
+# RUN THIS COMMAND AND EXIT
+CMD retrospec puppet
+
+# TO BUILD RUN
+# docker build --rm -t nwops/puppet-retrospec:latest .

data/Gemfile

@@ -4,15 +4,15 @@ gem 'trollop'
 gem 'retrospec', '~> 0.4'
 gem 'awesome_print'
 gem 'facets'
-# Include everything needed to run rake, tests, features, etc.
+
 group :development do
   gem 'rdoc', '~> 3.12'
   gem 'pry'
-  gem 'puppet', '3.7.3', :path => 'vendor/gems/puppet-3.7.3'
 end
 
 group :test do
-  gem 'puppet', '3.7.3', :path => 'vendor/gems/puppet-3.7.3'
+  gem 'rspec', '~> 3.2'
+  gem 'puppet', '4.5.2', :path => 'vendor/gems/puppet-4.5.2'
   gem 'rake'
   gem 'bundler', '~> 1.0'
   gem 'yard', '~> 0.7'

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
-  remote: vendor/gems/puppet-3.7.3
+  remote: vendor/gems/puppet-4.5.2
   specs:
-    puppet (3.7.3)
-      facter (> 1.6, < 3)
-      hiera (~> 1.0)
+    puppet (4.5.2)
+      facter (> 2.0, < 4)
+      hiera (>= 2.0, < 4)
       json_pure
 
 GEM
@@ -18,7 +18,7 @@ GEM
       thread_safe (~> 0.3, >= 0.3.1)
     diff-lcs (1.2.5)
     facets (3.0.0)
-    facter (2.4.4)
+    facter (2.4.6)
       CFPropertyList (~> 2.2.6)
     fakefs (0.6.7)
     faraday (0.9.2)
@@ -33,7 +33,7 @@ GEM
       nokogiri (~> 1.6.6)
       oauth2
     hashie (3.4.2)
-    hiera (1.3.4)
+    hiera (3.1.2)
       json_pure
     highline (1.7.8)
     jeweler (2.0.1)
@@ -46,7 +46,7 @@ GEM
       rake
       rdoc
     json (1.8.3)
-    json_pure (1.8.2)
+    json_pure (1.8.3)
     jwt (1.5.1)
     method_source (0.8.2)
     mini_portile (0.6.2)
@@ -99,10 +99,13 @@ DEPENDENCIES
   fakefs
   jeweler
   pry
-  puppet (= 3.7.3)!
+  puppet (= 4.5.2)!
   rake
   rdoc (~> 3.12)
   retrospec (~> 0.4)
   rspec (~> 3.2)
   trollop
   yard (~> 0.7)
+
+BUNDLED WITH
+   1.12.5

data/README.md

@@ -51,6 +51,8 @@ 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
+### 6-28-16
+Version 1.0.0 is release 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:
 
@@ -107,7 +109,6 @@ new_function
   -b, --branch=<s>              Branch you want to use for the retrospec template repo (default: master)
   -a, --namespace=<s>           The namespace to use only when creating a new module (default: namespace)
   -e, --enable-beaker-tests     Enable the creation of beaker tests
-  -l, --enable-future-parser    Enables the future parser only during validation
   -v, --version                 Print version and exit
   -h, --help                    Show this message  -h, --help                    Show this message
 ```
@@ -115,7 +116,7 @@ new_function
 ## Design Goals
 One of the design goals of this plugin is to try to introspect as much information as possible so we don't need input from the user. If you are not sure what default values are used, use the `-h` option and the defaults will be revealed. Most of the defaults are dynamic.  
 
-Another design goal is to allow the user to configure every option, so that passing
+Another design goal is to allow the user to configure every option so that passing
 additional options is not required when configured correctly.  Please see the [Configuration Section](#configuration) for setting a config file.
 
 ## Using the Generators
@@ -555,21 +556,15 @@ Because the code does not rely on catalog compilation we have to build our own s
 3. Anything contained in a block of code is currently ignored, until later refinement.
 
 ##Future Parser Support
-Currently Retrospec uses the old/current AST parser for code parsing.  If your code contains future parser syntax the current parser will fail to render some resource definitions but will still render the spec file template without parameters
-and resource tests that are contained in your manifest. Retrospec is still extremely useful with Puppet 4.
+As of 1.0.0 Retrospec Puppet provides full support for code written against the 4.x/future parser.
+If you have 3.x code the 4.x parser may throw errors instead of deprecation warnings.
+If you do not wish to convert your 3.x to 4.x code yet, you will need to use the puppet-retrospec
+version < 1.0.0
 
-Since Puppet 4 introduces many new things and breaks many other things  I am not sure
-which side of the grass is greener at this time.  What I do know is that most people are using Puppet 3 and it may take time to move to Puppet 4.  I would suspect Retrospec would be more valuable for those moving to Puppet 4 who don't have unit tests that currently have Puppet 3 codebases.  For those with a clean slate and start directly in Puppet 4, Retrospec will still be able to produce the templates but some of the test cases will be missing if the old AST parser cannot read future code syntax.  If your puppet 4 codebase is compatible with puppet 3 syntax there should not be an issue.
-
-In order to allow future parser validation please run retrospec with the following option.
-
- ```shell
-    retrospec puppet --enable-future-parser
-
- ```
 
 ##Ruby Support
-Currently this library only supports ruby >= 1.9.3.  It might work on 1.8.7 but I won't support if it fails.
+Currently this library only supports ruby >= 1.9.3.  Since we vendor Puppet 4.5.x you need to have
+a supported ruby version that puppet 4.5 supports which.  
 
 ##Paid Support
 Want to see new features developed much faster?  Contact me about a support contract so I can develop this tool during

data/Rakefile

@@ -11,10 +11,13 @@ rescue Bundler::BundlerError => e
 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.)

data/VERSION

@@ -1 +1 @@
-0.12.2
+1.0.0

data/lib/retrospec-puppet.rb

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

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

@@ -1,7 +1,5 @@
-require_relative 'generators/fact_generator'
-require_relative 'generators/module_generator'
-require_relative 'generators/function_generator'
-require_relative 'generators/type_generator'
-require_relative 'generators/provider_generator'
-require_relative 'generators/schema_generator'
 require_relative 'exceptions'
+# load all the generators found in the generators directory
+Dir.glob(File.join(File.dirname(__FILE__),'generators', '*.rb')).each do |file|
+  require_relative File.join('generators', File.basename(file, '.rb'))
+end

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

@@ -0,0 +1,51 @@
+require_relative 'resource_base_generator'
+require_relative 'serializers/rspec_dumper'
+require 'puppet'
+require 'puppet/pops'
+
+module Retrospec
+  module Puppet
+    module Generators
+      class AcceptanceGenerator < Retrospec::Puppet::Generators::ResourceBaseGenerator
+        # 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
+          @singular_name = 'acceptance'
+          @plural_name = 'acceptance'
+        end
+
+        def spec_template_file
+          File.join('acceptance_spec_test.rb.retrospec.erb')
+        end
+
+        def spec_path
+          File.join(module_path, 'spec', plural_name, 'classes')
+        end
+
+        def self.supported_types
+          unless @supported_types
+            @supported_types =
+            [
+              ::Puppet::Pops::Model::HostClassDefinition,
+              ::Puppet::Pops::Model::ResourceTypeDefinition
+            ]
+          end
+          @supported_types
+        end
+
+        def self.generate_spec_files(module_path, config_data)
+          files = []
+          manifest_files(module_path).each do |file|
+            acceptance = new(module_path, config_data.merge({:manifest_file => file}))
+            next unless supported_types.include?(acceptance.resource_type)
+            files << acceptance.generate_spec_file
+          end
+          files
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,91 @@
+module Retrospec
+  module Puppet
+    module Generators
+      class BaseGenerator < Retrospec::Plugins::V1::Plugin
+        attr_reader :template_dir, :generator_template_dir_name, :plural_name, :singular_name
+        attr_accessor :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 = {})
+          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.
+          @context = OpenStruct.new(spec_object)
+        end
+
+        def logger
+          Retrospec::Plugins::V1::Puppet.logger
+        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)
+          sub_command_opts = Trollop.options(args) do
+            banner <<-EOS
+            ""
+            EOS
+            opt :name, "The name of the item you wish to create", :type => :string, :required => true, :short => '-n'
+          end
+          unless sub_command_opts[:name]
+            Trollop.educate
+            exit 1
+          end
+          plugin_data = global_opts.merge(sub_command_opts)
+          plugin_data
+        end
+
+        def generate_lib_files
+          raise NotImplementedError
+        end
+
+        def generate_spec_files
+          raise NotImplementedError
+        end
+
+        # run is the main method that gets called automatically
+        def run
+          generate_lib_files
+        end
+
+        def item_name
+          context.name
+        end
+
+        def item_path
+          File.join(lib_path, "#{item_name}.rb")
+        end
+
+        def item_spec_path
+          File.join(spec_path, "#{item_name}_spec.rb")
+        end
+
+        def spec_path
+          File.join(module_path, 'spec', 'unit', 'puppet', plural_name)
+        end
+
+        def lib_path
+          File.join(module_path, 'lib', 'puppet', plural_name)
+        end
+
+        # returns the path to the templates
+        # first looks inside the external templates directory for specific file
+        # then looks inside the gem path templates directory, which is really only useful
+        # when developing new templates.
+        def template_dir
+          if config_data[:template_dir]
+            external_templates = Dir.glob(File.expand_path(File.join(config_data[:template_dir], plural_name, '*.erb')))
+          end
+          if external_templates and external_templates.count > 0
+            File.join(config_data[:template_dir], plural_name)
+          else
+            File.expand_path(File.join(File.dirname(File.dirname(__FILE__)), 'templates', plural_name))
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+require_relative 'resource_base_generator'
+require_relative 'serializers/rspec_dumper'
+require 'puppet'
+require 'puppet/pops'
+
+module Retrospec
+  module Puppet
+    module Generators
+      class DefinitionGenerator < Retrospec::Puppet::Generators::ResourceBaseGenerator
+        # 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
+          @singular_name = 'define'
+          @plural_name = 'defines'
+        end
+
+        def spec_template_file
+          'definition_spec.rb.retrospec.erb'
+        end
+
+        def self.generate_spec_files(module_path, config_data)
+          files = []
+          manifest_files(module_path).each do |file|
+            definition = new(module_path, config_data.merge({:manifest_file => file}))
+            next unless definition.resource_type == ::Puppet::Pops::Model::ResourceTypeDefinition
+            files << definition.generate_spec_file
+          end
+          files
+        end
+
+      end
+
+    end
+  end
+end