puppet-retrospec 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1b8a2d188fa0d01a182d58443a8ff7c109e67228
-  data.tar.gz: 2e63276ab8d5b814a386615df85233191d9af9f4
+  metadata.gz: d2d1e94be8d1bb747a80e140e221d2ec084c4e84
+  data.tar.gz: cfc0f190bc77582fe7e1d851d60c6b06662efb16
 SHA512:
-  metadata.gz: d4bab8bfad24ac10fc8b362e4ca7445075912d876d2bb9e2b2147f1f1e91ae44a65ac8cf50c3324766f30c5e9c39cebf7a4de1c5a2e4570c8d6a2daf03d77922
-  data.tar.gz: 34a74fce6aa0cdb20acf9088e6c843076d209c813413eee0813566a4fa89ffa2458f8dcb11f477c984ae5651d1902699bc97e80d8ceea1f616c3caedc8f7660b
+  metadata.gz: 8a30bcaa63582f99df12131482eb08055825c0a72bf01c11faafb0b312da1bbb32ac3208dda81b1461d31097f9dbbe9d21481fbcf6c44d4650d52951cbaa6764
+  data.tar.gz: 1b577832ee652ac2113dfe1828326c26ef5576593e9acb3833ecc0eecd49c6fe2871f3a707e4444706a774d9ba9b41b01e99ecacafe385a96ae32fcb78649c14

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.7.0
+ * gh-18 puppet 4 code syntax does not work
+ * gh-10 safe file creation should use colors
+
 ## 0.6.1
  * gh-12 - allow new templates to be easily added without changing code
  * gh-8 - tests are not created when manifest is invalid 

data/README.md

@@ -25,6 +25,7 @@ Table of Contents
   * [Running Tests](#running-tests)
   * [Understanding Variable Resolution](#understanding-variable-resolution)
   * [Todo](#todo)
+  * [Future Parser Support](#future-parser-support)
   * [Support](#support)
 
 Created by [gh-md-toc](https://github.com/ekalinin/github-markdown-toc)
@@ -478,6 +479,25 @@ Resolution workflow.
 2. Find all vardef objects, resolve them if possible and store the values
 3. Anything contained in a block of code is currently ignored, until later refinement.
 
+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.
+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 --enable-future-parser
+
+ ```
+
 Todo
 ============
 - Add support to fill out used facts in the unit tests automatically

data/VERSION

@@ -1 +1 @@
-0.6.1
+0.7.0

data/bin/retrospec

@@ -10,6 +10,7 @@ opts = Trollop::options do
   opt :enable_user_templates, "Use Retrospec templates from #{File.expand_path('~/.puppet_retrospec_templates')}",
       :require => false, :type => :boolean
   opt :enable_beaker_tests, "Enable the creation of beaker tests", :require => false, :type => :boolean
+  opt :enable_future_parser, "Enables the future parser only during validation", :require => false, :type => :boolean
 end
 include Puppet_Retrospec
 

data/lib/retrospec.rb

@@ -22,6 +22,7 @@ class Retrospec
   # opts[:enable_beaker_tests]
   # opts[:template_dir]
   def initialize(supplied_module_path=nil,opts={})
+    Utilities::PuppetModule.instance.future_parser = opts[:enable_future_parser]
     # user supplied a template path or user wants to use local templates
     if opts[:template_dir] or opts[:enable_user_templates]
       @template_dir = Helpers.setup_user_template_dir(opts[:template_dir])
@@ -156,8 +157,14 @@ class Retrospec
     file_name = tokens.pop
     "#{file_name}_spec.rb"
   end
-
-  private
-
-
 end
+
+class String
+  def red;            "\033[31m#{self}\033[0m" end
+  def green;          "\033[32m#{self}\033[0m" end
+  def cyan;           "\033[36m#{self}\033[0m" end
+  def yellow;         "\033[33m#{self}\033[0m" end
+  def warning;        yellow                   end
+  def fatal;          red                      end
+  def info;           green                    end
+end

data/lib/retrospec/helpers.rb

@@ -32,11 +32,11 @@ class Helpers
   def self.safe_mkdir(dir)
     if File.exists? dir
       unless File.directory? dir
-        $stderr.puts "!! #{dir} already exists and is not a directory"
+        $stderr.puts "!! #{dir} already exists and is not a directory".fatal
       end
     else
       FileUtils.mkdir_p dir
-      puts " + #{dir}/"
+      puts " + #{dir}/".info
     end
   end
 
@@ -82,7 +82,7 @@ class Helpers
 
   def self.safe_copy_file(src, dest)
     if File.exists?(dest) and not File.zero?(dest)
-      $stderr.puts "!! #{dest} already exists"
+      $stderr.puts "!! #{dest} already exists".warning
     else
       if not File.exists?(src)
         safe_touch(src)
@@ -90,18 +90,18 @@ class Helpers
         safe_mkdir(File.dirname(dest))
         FileUtils.cp(src,dest)
       end
-      puts " + #{dest}"
+      puts " + #{dest}".info
     end
   end
 
   def self.safe_touch(file)
     if File.exists? file
       unless File.file? file
-        $stderr.puts "!! #{file} already exists and is not a regular file"
+        $stderr.puts "!! #{file} already exists and is not a regular file".fatal
       end
     else
       FileUtils.touch file
-      puts " + #{file}"
+      puts " + #{file}".info
     end
   end
 
@@ -110,14 +110,14 @@ class Helpers
       old_content = File.read(filepath)
       # if we did a better comparison of content we could be smarter about when we create files
       if old_content != content or not File.zero?(filepath)
-        $stderr.puts "!! #{filepath} already exists and differs from template"
+        $stderr.puts "!! #{filepath} already exists and differs from template".warning
       end
     else
       safe_mkdir(File.dirname(filepath)) unless File.exists? File.dirname(filepath)
       File.open(filepath, 'w') do |f|
         f.puts content
       end
-      puts " + #{filepath}"
+      puts " + #{filepath}".info
     end
   end
 end

data/lib/retrospec/puppet_module.rb

@@ -3,6 +3,7 @@ require 'puppet/face'
 module Utilities
   class PuppetModule
     attr_writer :module_path
+    attr_accessor :future_parser
 
     include Singleton
 
@@ -61,26 +62,29 @@ module Utilities
       if dir.nil?
         dir = '.'
       elsif dir.instance_of?(Array)
-        puts "Retrospec - an array of module paths is not supported at this time"
+        puts "Retrospec - an array of module paths is not supported at this time".fatal
         exit 1
       end
       dir = File.expand_path(dir)
       manifest_dir = File.join(dir,'manifests')
       if ! File.exist?(manifest_dir)
-        puts "No manifest directory in #{manifest_dir}, cannot validate this is a module"
+        puts "No manifest directory in #{manifest_dir}, cannot validate this is a module".fatal
         exit 1
       else
         files = Dir.glob("#{manifest_dir}/**/*.pp")
-        warn "No puppet manifest files found at #{manifest_dir}" if files.length < 1
+        warn "No puppet manifest files found at #{manifest_dir}".warning if files.length < 1
         # validate the manifest files, because if one files doesn't work it affects everything
         files.each do |file|
           begin
-            Puppet::Face[:parser, '0.0.1'].validate(file)
+            Puppet[:parser] = 'future' if future_parser
+            Puppet::Face[:parser, :current].validate(file)
           rescue SystemExit => e
-            puts "Manifest file: #{file} has parser errors, please fix and re-check using\n puppet parser validate #{file}"
+            puts "Manifest file: #{file} has parser errors, please fix and re-check using\n puppet parser validate #{file}".fatal
             exit 1
           end
         end
+        # switch back to current parser, since we rely on the AST parser
+        Puppet[:parser] = 'current' if future_parser
       end
       dir
     end

data/puppet-retrospec.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: puppet-retrospec 0.6.1 ruby lib
+# stub: puppet-retrospec 0.7.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "puppet-retrospec"
-  s.version = "0.6.1"
+  s.version = "0.7.0"
 
   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 = "2015-03-27"
+  s.date = "2015-04-07"
   s.description = "Retrofits and generates valid puppet rspec test code to existing modules"
   s.email = "corey@logicminds.biz"
   s.executables = ["retrospec"]

data/spec/unit/puppet-retrospec_spec.rb

@@ -28,6 +28,13 @@ describe "puppet-retrospec" do
     expect(tomcat).to be_instance_of(Retrospec)
   end
 
+  it 'should set the parser to future' do
+    opts = {:module_path => @path, :enable_beaker_tests => false,
+            :enable_user_templates => false, :template_dir => nil, :enable_future_parser => true }
+    tomcat = Retrospec.new(opts[:module_path], opts)
+    expect(tomcat.spec_object.instance.future_parser).to eq(true)
+  end
+
   it 'should create files without error' do
     tomcat = Retrospec.new(@opts[:module_path], @opts)
     tomcat.create_files

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-retrospec
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Corey Osman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-27 00:00:00.000000000 Z
+date: 2015-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet