puppet-retrospec 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8ee18423b45926dd5af55e9ae5ab06ad259d391a
-  data.tar.gz: 8fdb6a385bebe775d225e7a7481babb93285a5ac
+  metadata.gz: 3461b3345064309ba4d62c62b0393ed4f4223ba6
+  data.tar.gz: 57deba94c2c1d0e62c85263bbedf9771f4b5f213
 SHA512:
-  metadata.gz: d726ea817412307e481be8394b37d7c4904b010a37068ba824337a9715b67679c8da15f3805d8abdb88386328e664d4563c9c577272a5f946dc0eca8f5dfab85
-  data.tar.gz: 695e39765fa941e955d36acda5cb4882a0aa7c61b228bdc3c740e92a4876f1326cc7357bfe22b5b141df142eddd2bcf98712cd2737656f578f53e2a32029529f
+  metadata.gz: 81efc82dbb22d30e873dbb1e9a1ddf4fc10b065f31174cfce7a4959876019a0e6e183ce2eed64e2e54264e82834bea2e85c695075195ce1f83326ed3cc73694d
+  data.tar.gz: c1e46dea03222cfd8a7ee237bbde5e54937dc6223cfcacaeeb3b2b863b4fa4e9e023634de458ad91125ae55dbd43b6d07aaf615dd3b62c9e660b036f4f96c068

data/README.md

@@ -15,9 +15,11 @@ Table of Contents
 =================
 
   * [Build Status](#build-status)
+  * [News](#news)
   * [Dependency](#dependency)
   * [Install](#install)
   * [How to use](#how-to-use)
+  * [Config file](#config_file)
   * [Example](#example)
   * [About the test suite](#about-the-test-suite)
   * [How Does it do this](#how-does-it-do-this)
@@ -38,6 +40,34 @@ Build Status
 [![Build Status](https://travis-ci.org/logicminds/puppet-retrospec.png)](https://travis-ci.org/logicminds/puppet-retrospec)
 [![Gem Version](https://badge.fury.io/rb/puppet-retrospec.svg)](http://badge.fury.io/rb/puppet-retrospec)
 
+## News
+This gem has been converted to a retrospec plugin.  This means that this gem no longer contains a binary and instead
+depends on the retrospec framework.  The new way of using this gem is : `retrospec puppet`
+
+Because I found this gem to be so useful I figured I could make it automate other types of projects and generalized its 
+use case.  So now any project you create can have its development workflow automated with retrospec.
+
+More info: https://github.com/nwops/retrospec.git
+
+As a result you may have a conflict with the retrospec binary when installing this plugin, please allow the new retrospec
+binary to replace the old one.
+
+```shell
+[puppet@puppetdev module]$ gem install puppet-retrospec
+Fetching: retrospec-0.3.0.gem (100%)
+retrospec's executable "retrospec" conflicts with puppet-retrospec
+Overwrite the executable? [yN]  y
+Successfully installed retrospec-0.3.0
+Fetching: puppet-retrospec-0.9.0.gem (100%)
+Successfully installed puppet-retrospec-0.9.0
+Parsing documentation for retrospec-0.3.0
+Installing ri documentation for retrospec-0.3.0
+Parsing documentation for puppet-retrospec-0.9.0
+Installing ri documentation for puppet-retrospec-0.9.0
+2 gems installed
+
+```
+
 Dependency
 ============
 Retrospec relies heavily on the puppet 3.7.x codebase.  Because of this hard dependency the puppet gem is vendored into
@@ -47,28 +77,44 @@ Install
 =============
 `gem install puppet-retrospec`  
 
+This will also install the retrospec framework that is required to use the plugin.
 
 How to use
 =============
 Run from the command line
 ```
-$ retrospec -h
+retrospec puppet -h
 Generates puppet rspec test code based on the classes and defines inside the manifests directory.
-   -m, --module-path=<s>         The path (relative or absolute) to the module directory (Defaults to current directory) 
-   -t, --template-dir=<s>        Path to templates directory (only for overriding Retrospec templates) (default: /Users/user1/.retrospec_templates)
-   -s, --scm-url=<s>             SCM url for retrospec templates
-   -b, --branch=<s>              Branch you want to use for the retrospec template repo
-   -e, --enable-beaker-tests     Enable the creation of beaker tests
-   -n, --enable-future-parser    Enables the future parser only during validation
-   -v, --version                 Print version and exit
-   -h, --help                    Show this message
+  -t, --template-dir=<s>        Path to templates directory (only for overriding Retrospec templates) (default: /home/puppet/.retrospec/repos/retrospec-puppet-templates)
+  -s, --scm-url=<s>             SCM url for retrospec templates (default: https://github.com/nwops/retrospec-templates)
+  -b, --branch=<s>              Branch you want to use for the retrospec template repo (default: master)
+  -e, --enable-beaker-tests     Enable the creation of beaker tests
+  -n, --enable-future-parser    Enables the future parser only during validation
+  -v, --version                 Print version and exit
+  -h, --help                    Show this message
+
 
                      
-retrospec -m ~/projects/puppet_modules/apache
+retrospec -m ~/projects/puppet_modules/apache puppet --enable-future-parser
+
 ```
 
+## Config file
+Previously before release 0.9.0 there was no way to set a config file so you were stuck with always 
+having to pass in the same cli options. With the 0.9.0 release we now rely on the retrospec framework which
+gives us access to config file options for free. Below is a list of options that you can set
+in the config file.  (/Users/username/.retrospec/config.yaml)  `retrospec -h`
+
+```yaml
 plugins::puppet::templates::url: https://github.com/nwops/retrospec-templates
 plugins::puppet::templates::ref: master
+plugins::puppet::enable_beaker_tests: true
+plugins::puppet::enable_future_parser: true
+plugins::puppet::template_dir: /Users/username/.retrospec/repos/retrospec-puppet-templates
+```
+
+Note: your not require to set any of these as they can be specified on the cli and also default to 
+sane values.
 
 Example
 ======================
@@ -82,7 +128,7 @@ with retrospec.
 ```shell
 $ pwd
 /Users/cosman/github/puppetlabs-apache
-$ retrospec
+$ retrospec puppet
  + /Users/cosman/github/puppetlabs-apache/Gemfile
   + /Users/cosman/github/puppetlabs-apache/Rakefile
   + /Users/cosman/github/puppetlabs-apache/spec/
@@ -340,7 +386,7 @@ versioned controlled in their own repo and update them before each retrospec use
 contributions to be spread to other team members quickly.
   
 ```shell
-    -t, --template-dir=<s>  Path to templates directory (only for overriding Retrospec templates) (default: /Users/user1/.retrospec_templates)
+    -t, --template-dir=<s>  Path to templates directory (only for overriding Retrospec templates) (default: /Users/user1/.retrospec/repos/retrospec-puppet-templates)
     -s, --scm-url=<s>       SCM url for retrospec templates
     -b, --branch=<s>        Branch you want to use for the retrospec template repo
 
@@ -348,8 +394,8 @@ contributions to be spread to other team members quickly.
 
 ### Environment variables to set template defaults
 
-RETROSPEC_SCM_URL  # set this to auto set your scm url to the templates
-RETROSPEC_SCM_BRANCH # set this to auto checkout a particular branch (only works upon initial checkout)
+RETROSPEC_PUPPET_SCM_URL  # set this to auto set your scm url to the templates
+RETROSPEC_PUPPET_SCM_BRANCH # set this to auto checkout a particular branch (only works upon initial checkout)
 
 After running retrospec, retrospec will clone the templates from the default template url or from whatever you set to the templates path.  
 If you have already created the erb file in the templates location, then retrospec will not overwrite the file as there will

data/VERSION

@@ -1 +1 @@
-0.9.0
+0.9.1

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

@@ -124,26 +124,34 @@ Generates puppet rspec test code based on the classes and defines inside the man
         # filenames must named how they would appear in the normal module path.  The directory
         # structure where the file is contained
         def safe_create_module_files
-          templates = Find.find(File.join(template_dir,'module_files')).find_all {|f| !File.directory?(f)}.sort
+          templates = Find.find(File.join(template_dir,'module_files')).sort
           templates.each do |template|
             # need to remove the erb extension and rework the destination path
             if template =~ /nodesets|spec_helper_acceptance/ and !context.enable_beaker_tests?
               next
             else
-              dest = template.gsub(File.join(template_dir,'module_files'), module_path).gsub('.erb', '')
+              dest = template.gsub(File.join(template_dir,'module_files'), module_path)
               if File.symlink?(template)
                 safe_create_symlink(template, dest)
               elsif File.directory?(template)
                 safe_mkdir(dest)
               else
-                safe_create_template_file(dest, template, context)
+                # because some plugins contain erb files themselves any erb file will be copied only
+                # so we need to designate which files should be rendered with .retrospec.erb
+                if template =~ /\.retrospec\.erb/
+                  # render any file ending in .retrospec_erb as a template
+                  dest = dest.gsub(/\.retrospec\.erb/, '')
+                  safe_create_template_file(dest, template, context)
+                else
+                  safe_copy_file(template, dest)
+                end
               end
             end
           end
         end
 
         # Creates an associated spec file for each type and even creates the subfolders for nested classes one::two::three
-        def safe_create_resource_spec_files(type,template=File.join(template_dir,'resource_spec_file.erb'))
+        def safe_create_resource_spec_files(type,template=File.join(template_dir,'resource_spec_file.retrospec.erb'))
           context.parameters = type.arguments
           context.type = type
           VariableStore.populate(type)
@@ -156,7 +164,7 @@ Generates puppet rspec test code based on the classes and defines inside the man
           dest
         end
 
-        def safe_create_acceptance_tests(type,template=File.join(template_dir,'acceptance_spec_test.erb'))
+        def safe_create_acceptance_tests(type,template=File.join(template_dir,'acceptance_spec_test.retrospec.erb'))
           @parameters = type.arguments
           @type = type
           dest = File.join(module_path,generate_file_path(type, true))

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

@@ -1,5 +1,5 @@
 module Retrospec
   module Puppet
-    VERSION = '0.9.0'
+    VERSION = '0.9.1'
   end
 end

data/puppet-retrospec.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "puppet-retrospec"
-  s.version = "0.9.0"
+  s.version = "0.9.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Corey Osman"]
-  s.date = "2015-09-27"
+  s.date = "2015-09-28"
   s.description = "Retrofits and generates valid puppet rspec test code to existing modules"
   s.email = "corey@logicminds.biz"
   s.extra_rdoc_files = [

data/spec/unit/puppet-retrospec_spec.rb

@@ -64,7 +64,7 @@ describe "puppet-retrospec" do
     spec_path = File.expand_path(File.join(@path, 'spec'))
     tomcat.create_files
     expect(File.exists?(File.join(spec_path, 'spec_helper_acceptance.rb'))).to eq(false)
-    expect(File.exists?(File.join(spec_path, 'acceptance'))).to eq(false)
+    expect(File.exists?(File.join(spec_path, 'acceptance'))).to eq(true)
     expect(File.exists?(File.join(spec_path, 'acceptance', 'classes', 'tomcat_spec.rb'))).to eq(false)
     expect(File.exists?(File.join(spec_path, 'acceptance', 'nodesets'))).to eq(false)
     expect(File.exists?(File.join(spec_path, 'acceptance', 'nodesets', 'default.yml'))).to eq(false)
@@ -162,13 +162,12 @@ describe "puppet-retrospec" do
   it 'should create a file from a template' do
     tomcat = Retrospec::Plugins::V1::Puppet.new(@opts[:module_path], @opts)
     file_path = File.join(@path,'.fixtures.yml')
-    template_file = File.join(tomcat.template_dir,'module_files','.fixtures.yml')
+    template_file = File.join(tomcat.template_dir,'module_files','.fixtures.yml.retrospec.erb')
     tomcat.safe_create_template_file(file_path, template_file, tomcat.context)
     expect(File.exists?(file_path)).to eq(true)
   end
 
   describe 'generate_file_path' do
-
     describe 'classes' do
       it 'should generate a acceptance test path correctly' do
         type = double("type")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-retrospec
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Corey Osman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-27 00:00:00.000000000 Z
+date: 2015-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trollop