puppet-retrospec 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2a2f8b465a1d2884cfff1f96f1d46214c891d27f
-  data.tar.gz: b3458e26b5ccdab19bd1fa05c841eb7eb7e3952c
+  metadata.gz: 4fd53d7dc8e523b7ab53a2b04244836e7b0b972d
+  data.tar.gz: 5e4d3517dc4b7b34172ff914b6334b8fd59ff7c9
 SHA512:
-  metadata.gz: 9d65c5dfb1eb72b5dae00bf6ef11089f08ea9a2100c9641b82d0dab74d288288ecdda6f5fbba0db50c8fbf734692a44853959dfaf6c00ed432e81bce409bb24c
-  data.tar.gz: a517170cfcdad5f652805d205f22cae24e06b5db385ea5b2e567af8e23f563a736bd0e3af5c7e9f2b2b647691a5d95fa5db4337bcc369f4202a4c26dc213ddeb
+  metadata.gz: d1d577bb42dbcf4b39a8c0e458d5875615f1318dded5348c4d19ba81b2f5c6e957a469ad24eba172aaebf4e53fc48b321ea5e24d423188c68deb763b397610ce
+  data.tar.gz: 8feb4bab90ce38a5b9cdf4a60b479901af24f0443c01e4ad814bd26d983fdab725d1baa1153ee42eb4d9e5d7705e1183987b472422bc0417034175e604a94a3c

data/README.md

@@ -20,24 +20,14 @@ Install
 
 How to use
 =============
-Run from a rake task
-```
-require 'puppet-retrospec'
-
-desc "Scans the module directory and automatically creates basic spec tests"
-task :retrospec do
-  Retrospec.run
-end
-
-```
-
 Run from the command line
 ```
 $ retrospec -h
-Options:
-          --module-path, -m <s>:   destination directory to create spec tests in (Defaults to current directory)
+  Options:
+          --module-path, -m <s>:   The path (relative or absolute) to the module directory (Defaults to current directory)
          --template-dir, -t <s>:   Path to templates directory (only for overriding Retrospec templates)
-    --enable-user-templates, -e:   Use Retrospec templates from /Users/cosman/.puppet_retrospec_templates
+    --enable-user-templates, -e:   Use Retrospec templates from ~/.puppet_retrospec_templates
+      --enable-beaker-tests, -n:   Enable the creation of beaker tests
                      --help, -h:   Show this message
                      
 retrospec -m ~/projects/puppet_modules/apache
@@ -141,29 +131,42 @@ your puppet module with unit tests.
 Overriding the templates
 =======================
 There may be a time when you want to override the default templates used to generate the rspec related files.
-To override these templates just set **one** of the following environment variables.
+To override these templates just set **one** of the following cli options.
   
 ```shell
-RETROSPEC_ENABLE_LOCAL_TEMPLATES=true
-RETROSPEC_TEMPLATES_PATH=~/my_templates
+      --template-dir, -t <s>:   Path to templates directory (only for overriding Retrospec templates)
+    --enable-user-templates, -e:   Use Retrospec templates from ~/.puppet_retrospec_templates
 
 ```
 
-Once one of the variables is set the retrospec will copy over all the templates from the gem location to the default 
+Once one of the options is set, retrospec will copy over all the templates from the gem location to the default
 or specified override templates path.
 If you have already created the a erb file in the templates location, then puppet-retrospec will not overwrite the file.
-You can set multiple template paths if you use them for different projects so just be sure the set the correctly
-template path environment variable when running retrospec.
+You can set multiple template paths if you use them for different projects so just be sure the set the correct
+template option when running retrospec.
 
-Setting the `RETROSPEC_ENABLE_LOCAL_TEMPLATES=true` Environment variable will tell retrospec to use the default user template location.
+Setting the `--enable-user-templates` option will tell retrospec to use the default user template location.
 
 The default location for the templates when using this variable is ~/.puppet_retrospec_templates
 
-If you wish to override ~/.puppet_retrospec_templates location you can use the following environment variable 
-RETROSPEC_TEMPLATES_PATH.
-If you set this variable you are not required set RETROSPEC_ENABLE_LOCAL_TEMPLATES.
+If you wish to override ~/.puppet_retrospec_templates location you can use the following option
+`--template-dir`
+
+If you set the `--template-dir` option you are not required to set the set `--enable-user-templates` option
+
+Example:
+`--template-dir=~/my_templates`
+
+Beaker Testing
+=================
+Beaker is Puppetlabs acceptance testing framework that you use to test puppet code on real machines.  Beaker is fairly new
+and is subject to frequent changes.  Testing patterns have not been established yet so consider beaker support in puppet-retrospec
+to be experimental.
+
+If you wish to enable the creation of beaker tests you can use the following cli option.  By default these
+acceptance tests are not created.  However at a later time they will be enabled by default.
 
-`RETROSPEC_TEMPLATES_PATH=~/my_templates`
+`--enable-beaker-tests`
 
 Troubleshooting
 ===============

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.4.0

data/bin/retrospec

@@ -3,13 +3,14 @@ require 'trollop'
 require 'puppet-retrospec'
 
 opts = Trollop::options do
-  opt :module_path, "destination directory to create spec tests in (Defaults to current directory) " ,
+  opt :module_path, "The path (relative or absolute) to the module directory (Defaults to current directory) " ,
       :type => :string, :required => false, :default => nil
   opt :template_dir, "Path to templates directory (only for overriding Retrospec templates)", :type => :string,
       :required => false, :default => nil
   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
 end
-ENV['RETROSPEC_ENABLE_LOCAL_TEMPLATES'] = 'true' if opts[:enable_user_templates]
-ENV['RETROSPEC_TEMPLATES_PATH'] = opts[:template_dir] if not opts[:template_dir].nil?
-Retrospec.run(opts[:module_path])
+
+retro = Retrospec.new(opts[:module_path], opts)
+retro.create_files

data/lib/helpers.rb

@@ -56,10 +56,9 @@ class Helpers
   # creates and/or copies all templates in the gem to the user templates path
   # returns: user_template_dir
   def self.sync_user_template_dir(user_template_directory)
-    Dir.glob(File.join(gem_template_dir, "*.erb")).each do |src|
-      filename = File.basename(src)
-      dest = File.expand_path(File.join(user_template_directory, filename))
-      safe_copy_file(src, dest)
+    Dir.glob(File.join(gem_template_dir, '**', '*')).each do |src|
+      dest = src.gsub(gem_template_dir, user_template_directory)
+      safe_copy_file(src, dest) unless File.directory?(src)
     end
     user_template_directory
   end
@@ -82,12 +81,13 @@ class Helpers
   end
 
   def self.safe_copy_file(src, dest)
-    if File.exists?(dest)
+    if File.exists?(dest) and not File.zero?(dest)
       $stderr.puts "!! #{dest} already exists"
     else
       if not File.exists?(src)
         safe_touch(src)
       else
+        safe_mkdir(File.dirname(dest))
         FileUtils.cp(src,dest)
       end
       puts " + #{dest}"
@@ -108,7 +108,8 @@ class Helpers
   def self.safe_create_file(filename, content)
     if File.exists? filename
       old_content = File.read(filename)
-      if old_content != content
+      # 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?(filename)
         $stderr.puts "!! #{filename} already exists and differs from template"
       end
     else

data/lib/puppet-retrospec.rb

@@ -9,18 +9,31 @@ class Retrospec
   attr_reader :tmp_module_path
   attr_accessor :default_modules
   attr_accessor :facts_used
+  attr_accessor :module_name
+  attr_reader :template_dir
 
   # module path is the relative or absolute path to the module that should retro fitted
-  def initialize(path=nil, default_template_dir=ENV['RETROSPEC_TEMPLATES_PATH'])
+  # opts hash contains additional flags and options that can be user to control the creation of the tests
+  # opts[:enable_user_templates]
+  # opts[:enable_beaker_tests]
+  # opts[:template_dir]
+  def initialize(module_path=nil,opts={})
     # user supplied a template path or user wants to use local templates
-    if not default_template_dir.nil? or ENV['RETROSPEC_ENABLE_LOCAL_TEMPLATES'] =~ /true/i
-      default_template_dir = Helpers.setup_user_template_dir(default_template_dir)
+    if opts[:template_dir] or opts[:enable_user_templates]
+      @template_dir = Helpers.setup_user_template_dir(opts[:template_dir])
+    else
+      # if user doesn't supply template directory we assume we should use the templates in this gem
+      @template_dir = Helpers.gem_template_dir
     end
-    @module_path = validate_module_dir(path)
-    @template_dir = default_template_dir
+    @enable_beaker_tests = opts[:enable_beaker_tests]
+    @module_path = validate_module_dir(module_path)
     tmp_module_path
   end
 
+  def enable_beaker_tests?
+    @enable_beaker_tests == true
+  end
+
   def default_modules
     @default_modules ||= ['stdlib']
   end
@@ -31,13 +44,30 @@ class Retrospec
     safe_create_gemfile
     safe_create_rakefile
     safe_make_shared_context
+    safe_create_acceptance_spec_helper if enable_beaker_tests?
+    safe_create_node_sets if enable_beaker_tests?
     types.each do |type|
       safe_create_resource_spec_files(type)
+      if enable_beaker_tests?
+        safe_create_acceptance_tests(type)
+      end
     end
     FileUtils.remove_entry_secure tmp_modules_dir  # ensure we remove the temporary directory
     true
   end
 
+  def safe_create_node_sets
+    # copy all of the nodesets from the templates path nodesets directory
+    Dir.glob("#{template_dir}/nodesets/*.yml").each do |node_set_file|
+      dest = File.expand_path(File.join(module_path, 'spec', 'acceptance', 'nodesets', File.basename(node_set_file) ))
+      Helpers.safe_copy_file(node_set_file,dest)
+    end
+  end
+
+  def safe_create_acceptance_spec_helper(template='spec_helper_acceptance.rb.erb')
+     safe_create_template_file(File.join('spec', 'spec_helper_acceptance.rb'), template)
+  end
+
   def safe_create_rakefile(template='rakefile.erb')
     safe_create_template_file('Rakefile', template)
   end
@@ -81,15 +111,25 @@ class Retrospec
   def tmp_module_path
     if @tmp_module_path.nil?
       # create a link where source is the current repo and dest is /tmp/modules/module_name
-      path = File.join(tmp_modules_dir, module_name)
+      path = File.join(tmp_modules_dir, module_dir_name)
       FileUtils.ln_s(module_path, path)
       @tmp_module_path = path
     end
     @tmp_module_path
   end
 
+  # the directory name of the module
+  # usually this is the same as the module name but it can be namespaced sometimes
+  def module_dir_name
+    @module_dir_name ||= File.basename(module_path)
+  end
+
+  # returns the name of the module  ie. mysql::config  => mysql
   def module_name
-    @module_name ||= File.basename(module_path)
+    if @module_name.nil?
+      @module_name = types.first.name.split('::').first if types.length > 0
+    end
+    @module_name
   end
 
   # creates a tmp module directory so puppet can work correctly
@@ -103,24 +143,6 @@ class Retrospec
     @modules_dir
   end
 
-  # pass in either the path to the module directory
-  # or the path to a specific manifest
-  # defaults to all manifests in the current directory
-  # if ENV['RETROSPEC_ENABLE_LOCAL_TEMPLATES'] = 'true' the use the default user templates path
-  # if ENV["RETROSPEC_TEMPLATES_PATH"] is set then we will override the default user template path
-  # with the path provided
-  # we will use the necessary templates from that directory instead of the default gem path
-  def self.run(path=nil, template_dir=ENV['RETROSPEC_TEMPLATES_PATH'])
-    spec = Retrospec.new(path, template_dir)
-    spec.create_files
-  end
-
-  # if user doesn't supply template directory we assume we should use the templates in this gem
-  def template_dir
-    @template_dir ||= Helpers.gem_template_dir
-  end
-
-
   def modules_included
     @modules_included ||= default_modules + referenced_modules
   end
@@ -129,25 +151,7 @@ class Retrospec
     []
   end
 
-  # processes a directory and expands to its full path, assumes './'
-  # returns the validated dir
-  def validate_module_dir(dir)
-    # first check to see if manifests directory even exists when path is nil
-    if dir.nil?
-      dir = '.'
-    elsif dir.instance_of?(Array)
-      raise "Retrospec - an array of moudule paths is not supported at this time"
-    end
-    dir = File.expand_path(dir)
-    manifest_dir = File.join(dir,'manifests')
-    if ! File.exist?(manifest_dir)
-      raise "No manifest directory in #{manifest_dir}, cannot validate this is a module"
-    else
-      files = Dir.glob("#{manifest_dir}/**/*.pp")
-      warn 'No puppet manifest files found at #' if files.length < 1
-    end
-    dir
-  end
+
 
   # finds all the included resources so we can test and depend on in the fixtures file
   # def included_declarations(file)
@@ -175,23 +179,54 @@ class Retrospec
   #   @included_declarations
   # 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='resource_spec_file.erb')
-    classes_dir = 'spec/classes'
-    defines_dir = 'spec/defines'
-    hosts_dir   = 'spec/hosts'
     @parameters = type.arguments
     @type = type
+    file_path = generate_file_path(type, false)
+    safe_create_template_file(file_path, template)
+    file_path
+  end
+
+  def safe_create_acceptance_tests(type,template='acceptance_spec_test.erb')
+    @parameters = type.arguments
+    @type = type
+    file_path = generate_file_path(type, true)
+    safe_create_template_file(file_path, template)
+    file_path
+  end
+
+  # creates a puppet environment given a module path and environment name
+  def puppet_environment
+    @puppet_environment ||= Puppet::Node::Environment.create('production', [tmp_modules_dir])
+  end
+
+  # generates a file path for spec tests based on the resource name.  An added option
+  # is to generate directory names for each parent resource as a default option
+  # at this time acceptance tests follow this same test directory layout until best
+  # practices are formed.
+  def generate_file_path(type, is_acceptance_test)
+    classes_dir = 'classes'
+    defines_dir = 'defines'
+    hosts_dir   = 'hosts'
+    acceptance_dir = 'acceptance'
     case type.type
       when :hostclass
         type_dir_name = classes_dir
       when :definition
         type_dir_name = defines_dir
       else
-        raise "#{type.type} is not a supported resource type yet"
+        raise "#{type.type} retrospec does not support this resource type yet"
     end
+    if is_acceptance_test
+      type_dir_name = File.join('spec',acceptance_dir, type_dir_name)
+    else
+      type_dir_name = File.join('spec', type_dir_name)
+    end
+    file_name = generate_file_name(type.name)
     tokens = type.name.split('::')
-    file_name = tokens.pop  # the last item should be the filename
     # if there are only two tokens ie. tomcat::params we dont need to create a subdirectory
     if tokens.count > 1
       # this is a deep level resource ie. tomcat::config::server::connector
@@ -200,13 +235,23 @@ class Retrospec
       tokens.delete_at(0)
       # so lets make a directory structure out of it
       dir_name = File.join(tokens)  # config/server
-      dir_name = File.join(type_dir_name,dir_name) # spec/classes/tomcat/config/server
-      safe_create_template_file(File.join(dir_name,"#{file_name}_spec.rb"), template)
+      dir_name = File.join(type_dir_name,dir_name, file_name) # spec/classes/tomcat/config/server
     else
-      safe_create_template_file(File.join(type_dir_name,"#{file_name}_spec.rb"), template)
+      dir_name = File.join(type_dir_name,file_name)
     end
+    dir_name
   end
 
+  # returns the filename of the type
+  def generate_file_name(type_name)
+    tokens = type_name.split('::')
+    file_name = tokens.pop
+    "#{file_name}_spec.rb"
+  end
+
+  private
+
+  # creates a puppet resource request to be used indirectly
   def request(key, method)
     instance = Puppet::Indirector::Indirection.instance(:resource_type)
     indirection_name = 'test'
@@ -215,15 +260,11 @@ class Retrospec
     @request
   end
 
+  # creates an instance of the resource type parser
   def resource_type_parser
     @resource_type_parser ||= Puppet::Indirector::ResourceType::Parser.new
   end
 
-  # creates a puppet environment given a module path and environment name
-  def puppet_environment
-    @puppet_environment ||= Puppet::Node::Environment.create('production', [tmp_modules_dir])
-  end
-
   # returns the resource type ofject given a resource name ie. tomcat::connector
   def find_resource(resource_name)
     request = request(resource_name, 'find')
@@ -236,4 +277,23 @@ class Retrospec
     resource_type_parser.search(request)
   end
 
+  # processes a directory and expands to its full path, assumes './'
+  # returns the validated dir
+  def validate_module_dir(dir)
+    # first check to see if manifests directory even exists when path is nil
+    if dir.nil?
+      dir = '.'
+    elsif dir.instance_of?(Array)
+      raise "Retrospec - an array of moudule paths is not supported at this time"
+    end
+    dir = File.expand_path(dir)
+    manifest_dir = File.join(dir,'manifests')
+    if ! File.exist?(manifest_dir)
+      raise "No manifest directory in #{manifest_dir}, cannot validate this is a module"
+    else
+      files = Dir.glob("#{manifest_dir}/**/*.pp")
+      warn 'No puppet manifest files found at #' if files.length < 1
+    end
+    dir
+  end
 end

data/lib/templates/acceptance_spec_test.erb

@@ -0,0 +1,24 @@
+require 'spec_helper_acceptance'
+
+describe '<%= @type.name -%> <%= @type.type %>' do
+  describe 'running puppet code' do
+    it 'should work with no errors' do
+      pp = <<-EOS
+class { '<%= @type.name %>':
+<%- @parameters.each do |k,v| -%>
+  <%- if v.nil? -%>
+  <%= "#{k} => 'place_value_here'," %>
+  <%- else -%>
+  <%= "##{k} => #{v}," %>
+  <%- end -%>
+<%- end -%>
+}
+      EOS
+
+   # Run it twice and test for idempotency
+      apply_manifest(pp, :catch_failures => true)
+      expect(apply_manifest(pp, :catch_failures => true).exit_code).to be_zero
+    end
+
+  end
+end

data/lib/templates/gemfile.erb

@@ -1,8 +1,27 @@
 source "https://rubygems.org"
 
-group :development, :test do
-    gem 'bodeco_module_helper', :git => 'https://github.com/bodeco/bodeco_module_helper.git'
-    gem 'rspec-puppet-utils', :git => 'https://github.com/Accuity/rspec-puppet-utils.git'
-    gem 'hiera-puppet-helper', :git => 'https://github.com/bobtfish/hiera-puppet-helper.git'
+group :test do
+  gem "rake"
+  gem "puppet", ENV['PUPPET_VERSION'] || '~> 3.7.0'
+  gem "rspec-puppet", :git => 'https://github.com/rodjek/rspec-puppet.git'
+  gem "puppetlabs_spec_helper"
+  gem 'rspec-puppet-utils', :git => 'https://github.com/Accuity/rspec-puppet-utils.git'
+  gem 'hiera-puppet-helper', :git => 'https://github.com/bobtfish/hiera-puppet-helper.git'
+
+end
+
+group :development do
+  gem "travis"
+  gem "travis-lint"
+  <%- if enable_beaker_tests? -%>
+  gem "beaker", :git => 'https://github.com/logicminds/beaker.git', :branch => 'sshd_restart'
+  gem "beaker-rspec", :git => 'https://github.com/puppetlabs/beaker-rspec.git'
+  gem "vagrant-wrapper"
+  <%- end -%>
+  gem "puppet-blacksmith"
+  gem "guard-rake"
+  gem "metadata-json-lint"
+  gem 'puppet-syntax'
+  gem 'serverspec'
 end
 

data/lib/templates/nodesets/centos-59-x64.yml

@@ -0,0 +1,10 @@
+HOSTS:
+  centos-59-x64:
+    roles:
+      - master
+    platform: el-5-x86_64
+    box : centos-59-x64-vbox4210-nocm
+    box_url : http://puppet-vagrant-boxes.puppetlabs.com/centos-59-x64-vbox4210-nocm.box
+    hypervisor : vagrant
+CONFIG:
+  type: git

data/lib/templates/nodesets/centos-64-x64-pe.yml

@@ -0,0 +1,12 @@
+HOSTS:
+  centos-64-x64:
+    roles:
+      - master
+      - database
+      - dashboard
+    platform: el-6-x86_64
+    box : centos-64-x64-vbox4210-nocm
+    box_url : http://puppet-vagrant-boxes.puppetlabs.com/centos-64-x64-vbox4210-nocm.box
+    hypervisor : vagrant
+CONFIG:
+  type: pe

data/lib/templates/nodesets/centos-64-x64.yml

@@ -0,0 +1,11 @@
+HOSTS:
+  centos-64-x64:
+    roles:
+      - master
+    platform: el-6-x86_64
+    box : centos-64-x64-vbox4210-nocm
+    box_url : http://puppet-vagrant-boxes.puppetlabs.com/centos-64-x64-vbox4210-nocm.box
+    hypervisor : vagrant
+CONFIG:
+  log_level: debug
+  type: git

data/lib/templates/nodesets/centos-65-x64.yml

@@ -0,0 +1,10 @@
+HOSTS:
+  centos-65-x64:
+    roles:
+      - master
+    platform: el-6-x86_64
+    box : centos-65-x64-vbox436-nocm
+    box_url : http://puppet-vagrant-boxes.puppetlabs.com/centos-65-x64-virtualbox-nocm.box
+    hypervisor : vagrant
+CONFIG:
+  type: foss

data/lib/templates/nodesets/debian-607-x64.yml

@@ -0,0 +1,11 @@
+HOSTS:
+  debian-607-x64:
+    roles:
+      - master
+    platform: debian-6-amd64
+    box : debian-607-x64-vbox4210-nocm
+    box_url : http://puppet-vagrant-boxes.puppetlabs.com/debian-607-x64-vbox4210-nocm.box
+    hypervisor : vagrant
+CONFIG:
+  log_level: debug
+  type: git

data/lib/templates/nodesets/debian-70rc1-x64.yml

@@ -0,0 +1,11 @@
+HOSTS:
+  debian-70rc1-x64:
+    roles:
+      - master
+    platform: debian-7-amd64
+    box : debian-70rc1-x64-vbox4210-nocm
+    box_url : http://puppet-vagrant-boxes.puppetlabs.com/debian-70rc1-x64-vbox4210-nocm.box
+    hypervisor : vagrant
+CONFIG:
+  log_level: debug
+  type: git

data/lib/templates/nodesets/debian-73-i386.yml

@@ -0,0 +1,11 @@
+HOSTS:
+  debian-73-i386:
+    roles:
+      - master
+    platform: debian-7-i386
+    box : debian-73-i386-virtualbox-nocm
+    box_url : http://puppet-vagrant-boxes.puppetlabs.com/debian-73-i386-virtualbox-nocm.box
+    hypervisor : vagrant
+CONFIG:
+  log_level: debug
+  type: git

data/lib/templates/nodesets/debian-73-x64.yml

@@ -0,0 +1,11 @@
+HOSTS:
+  debian-73-x64:
+    roles:
+      - master
+    platform: debian-7-amd64
+    box : debian-73-x64-virtualbox-nocm
+    box_url : http://puppet-vagrant-boxes.puppetlabs.com/debian-73-x64-virtualbox-nocm.box
+    hypervisor : vagrant
+CONFIG:
+  log_level: debug
+  type: git

data/lib/templates/nodesets/default.yml

@@ -0,0 +1,11 @@
+HOSTS:
+  centos-64-x64:
+    roles:
+      - master
+    platform: el-6-x86_64
+    box : centos-64-x64-vbox4210-nocm
+    box_url : http://puppet-vagrant-boxes.puppetlabs.com/centos-64-x64-vbox4210-nocm.box
+    hypervisor : vagrant
+CONFIG:
+  log_level: debug
+  type: git

data/lib/templates/nodesets/fedora-18-x64.yml

@@ -0,0 +1,11 @@
+HOSTS:
+  fedora-18-x64:
+    roles:
+      - master
+    platform: fedora-18-x86_64
+    box : fedora-18-x64-vbox4210-nocm
+    box_url : http://puppet-vagrant-boxes.puppetlabs.com/fedora-18-x64-vbox4210-nocm.box
+    hypervisor : vagrant
+CONFIG:
+  log_level: debug
+  type: git

data/lib/templates/nodesets/sles-11sp1-x64.yml

@@ -0,0 +1,11 @@
+HOSTS:
+  sles-11sp1-x64:
+    roles:
+      - master
+    platform: sles-11-x86_64
+    box : sles-11sp1-x64-vbox4210-nocm
+    box_url : http://puppet-vagrant-boxes.puppetlabs.com/sles-11sp1-x64-vbox4210-nocm.box
+    hypervisor : vagrant
+CONFIG:
+  log_level: debug
+  type: git

data/lib/templates/nodesets/ubuntu-server-10044-x64.yml

@@ -0,0 +1,10 @@
+HOSTS:
+  ubuntu-server-10044-x64:
+    roles:
+      - master
+    platform: ubuntu-10.04-amd64
+    box : ubuntu-server-10044-x64-vbox4210-nocm
+    box_url : http://puppet-vagrant-boxes.puppetlabs.com/ubuntu-server-10044-x64-vbox4210-nocm.box
+    hypervisor : vagrant
+CONFIG:
+  type: foss

data/lib/templates/nodesets/ubuntu-server-12042-x64.yml

@@ -0,0 +1,10 @@
+HOSTS:
+  ubuntu-server-12042-x64:
+    roles:
+      - master
+    platform: ubuntu-12.04-amd64
+    box : ubuntu-server-12042-x64-vbox4210-nocm
+    box_url : http://puppet-vagrant-boxes.puppetlabs.com/ubuntu-server-12042-x64-vbox4210-nocm.box
+    hypervisor : vagrant
+CONFIG:
+  type: foss

data/lib/templates/nodesets/ubuntu-server-1310-x64.yml

@@ -0,0 +1,11 @@
+HOSTS:
+  ubuntu-server-1310-x64:
+    roles:
+      - master
+    platform: ubuntu-13.10-amd64
+    box : ubuntu-server-1310-x64-vbox4210-nocm
+    box_url : http://puppet-vagrant-boxes.puppetlabs.com/ubuntu-1310-x64-virtualbox-nocm.box
+    hypervisor : vagrant
+CONFIG:
+  log_level   : debug
+  type: git

data/lib/templates/nodesets/ubuntu-server-1404-x64.yml

@@ -0,0 +1,11 @@
+HOSTS:
+  ubuntu-server-1404-x64:
+    roles:
+      - master
+    platform: ubuntu-14.04-amd64
+    box : puppetlabs/ubuntu-14.04-64-nocm
+    box_url : https://vagrantcloud.com/puppetlabs/ubuntu-14.04-64-nocm
+    hypervisor : vagrant
+CONFIG:
+  log_level   : debug
+  type: git

data/lib/templates/rakefile.erb

@@ -1 +1,41 @@
-require 'bodeco_module_helper/rake_tasks'
+require 'puppetlabs_spec_helper/rake_tasks'
+require 'puppet-lint/tasks/puppet-lint'
+require 'puppet-syntax/tasks/puppet-syntax'
+
+# These two gems aren't always present, for instance
+# on Travis with --without development
+begin
+  require 'puppet_blacksmith/rake_tasks'
+rescue LoadError
+end
+
+PuppetLint.configuration.relative = true
+PuppetLint.configuration.send("disable_80chars")
+PuppetLint.configuration.log_format = "%{path}:%{linenumber}:%{check}:%{KIND}:%{message}"
+PuppetLint.configuration.fail_on_warnings = true
+
+# Forsake support for Puppet 2.6.2 for the benefit of cleaner code.
+# http://puppet-lint.com/checks/class_parameter_defaults/
+PuppetLint.configuration.send('disable_class_parameter_defaults')
+# http://puppet-lint.com/checks/class_inherits_from_params_class/
+PuppetLint.configuration.send('disable_class_inherits_from_params_class')
+
+exclude_paths = [
+  "pkg/**/*",
+  "vendor/**/*",
+  "spec/**/*",
+]
+PuppetLint.configuration.ignore_paths = exclude_paths
+PuppetSyntax.exclude_paths = exclude_paths
+
+task :metadata do
+  sh "metadata-json-lint metadata.json"
+end
+
+desc "Run syntax, lint, and spec tests."
+task :test => [
+       :syntax,
+       :lint,
+       :spec,
+       :metadata,
+     ]

data/lib/templates/spec_helper_acceptance.rb.erb

@@ -0,0 +1,33 @@
+require 'beaker-rspec'
+
+UNSUPPORTED_PLATFORMS = [ 'Windows', 'Solaris', 'AIX' ]
+
+unless ENV['RS_PROVISION'] == 'no' or ENV['BEAKER_provision'] == 'no'
+  # This will install the latest available package on el and deb based
+  # systems fail on windows and osx, and install via gem on other *nixes
+  foss_opts = { :default_action => 'gem_install' }
+
+  if default.is_pe?; then install_pe; else install_puppet( foss_opts ); end
+
+  hosts.each do |host|
+    on hosts, "mkdir -p #{host['distmoduledir']}"
+  end
+end
+
+RSpec.configure do |c|
+  # Project root
+  proj_root = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+  # Readable test descriptions
+  c.formatter = :documentation
+
+  # Configure all nodes in nodeset
+  c.before :suite do
+    hosts.each do |host|
+      # Install this module
+      copy_module_to(host, :source => proj_root, :module_name => '<%= @module_name %>')
+      # List other dependencies here so they are installed on the host
+      on host, puppet('module','install','puppetlabs-stdlib'), { :acceptable_exit_codes => [0,1] }
+    end
+  end
+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.3.0 ruby lib
+# stub: puppet-retrospec 0.4.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "puppet-retrospec"
-  s.version = "0.3.0"
+  s.version = "0.4.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 = "2014-11-14"
+  s.date = "2014-11-21"
   s.description = "Retrofits and generates valid puppet rspec test code to existing modules"
   s.email = "corey@logicminds.biz"
   s.executables = ["retrospec"]
@@ -31,11 +31,28 @@ Gem::Specification.new do |s|
     "bin/retrospec",
     "lib/helpers.rb",
     "lib/puppet-retrospec.rb",
+    "lib/templates/acceptance_spec_test.erb",
     "lib/templates/fixtures_file.erb",
     "lib/templates/gemfile.erb",
+    "lib/templates/nodesets/centos-59-x64.yml",
+    "lib/templates/nodesets/centos-64-x64-pe.yml",
+    "lib/templates/nodesets/centos-64-x64.yml",
+    "lib/templates/nodesets/centos-65-x64.yml",
+    "lib/templates/nodesets/debian-607-x64.yml",
+    "lib/templates/nodesets/debian-70rc1-x64.yml",
+    "lib/templates/nodesets/debian-73-i386.yml",
+    "lib/templates/nodesets/debian-73-x64.yml",
+    "lib/templates/nodesets/default.yml",
+    "lib/templates/nodesets/fedora-18-x64.yml",
+    "lib/templates/nodesets/sles-11sp1-x64.yml",
+    "lib/templates/nodesets/ubuntu-server-10044-x64.yml",
+    "lib/templates/nodesets/ubuntu-server-12042-x64.yml",
+    "lib/templates/nodesets/ubuntu-server-1310-x64.yml",
+    "lib/templates/nodesets/ubuntu-server-1404-x64.yml",
     "lib/templates/rakefile.erb",
     "lib/templates/resource_spec_file.erb",
     "lib/templates/shared_context.erb",
+    "lib/templates/spec_helper_acceptance.rb.erb",
     "lib/templates/spec_helper_file.erb",
     "puppet-retrospec.gemspec",
     "spec/fixtures/fixture_modules/zero_resource_module/manifests/not_a_resource_defination.pp",
@@ -46,7 +63,7 @@ Gem::Specification.new do |s|
   ]
   s.homepage = "http://github.com/logicminds/puppet-retrospec"
   s.licenses = ["MIT"]
-  s.rubygems_version = "2.2.2"
+  s.rubygems_version = "2.4.4"
   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."
 
   if s.respond_to? :specification_version then

data/spec/unit/puppet-retrospec_spec.rb

@@ -18,22 +18,46 @@ describe "puppet-retrospec" do
   end
 
   before :each do
-    ENV['RETROSPEC_ENABLE_LOCAL_TEMPLATES'] = nil
-    ENV['RETROSPEC_TEMPLATES_PATH'] = nil
     clean_up_spec_dir(@path)
-
+    @opts = {:module_path => @path, :enable_beaker_tests => false,
+             :enable_user_templates => false, :template_dir => nil }
   end
 
   it 'should run without errors using new' do
-    tomcat = Retrospec.new(@path)
+    tomcat = Retrospec.new(@opts[:module_path], @opts)
     expect(tomcat.create_files).to eq(true)
     expect(File.exists?(File.join(@path, 'Gemfile'))).to eq(true)
     expect(File.exists?(File.join(@path, '.fixtures.yml'))).to eq(true)
     expect(File.exists?(File.join(@path, 'spec','classes','tomcat_spec.rb'))).to eq(true)
   end
 
+  it 'should create acceptance test files' do
+    @opts[:enable_beaker_tests] = true
+    tomcat = Retrospec.new(@opts[:module_path], @opts)
+    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(true)
+    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(true)
+    expect(File.exists?(File.join(spec_path, 'acceptance', 'nodesets'))).to eq(true)
+    expect(File.exists?(File.join(spec_path, 'acceptance', 'nodesets', 'default.yml'))).to eq(true)
+
+  end
+
+  it 'should not create acceptance test files' do
+    @opts[:enable_beaker_tests] = false
+    tomcat = Retrospec.new(@opts[:module_path], @opts)
+    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', '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)
+  end
+
   it 'should create a local templates directory when flag is on' do
-    ENV['RETROSPEC_ENABLE_LOCAL_TEMPLATES'] = 'true'
+    @opts[:enable_user_templates] = true
     FakeFS do
       user_directory = Helpers.default_user_template_dir
       FileUtils.mkdir_p(Helpers.gem_template_dir)
@@ -42,23 +66,25 @@ describe "puppet-retrospec" do
       FileUtils.touch(File.join(Helpers.gem_template_dir, 'shared_context.erb'))
       FileUtils.touch(File.join(Helpers.gem_template_dir, 'spec_helper_file.erb'))
       FileUtils.touch(File.join(Helpers.gem_template_dir, 'gemfile.erb'))
-
+      FileUtils.mkdir_p(File.join(Helpers.gem_template_dir, 'nodesets'))
+      FileUtils.touch(File.join(Helpers.gem_template_dir, 'nodesets', 'default.yml'))
       FileUtils.mkdir_p('/modules/tomcat/manifests')
       FileUtils.touch('/modules/tomcat/manifests/init.pp')
-      Retrospec.new('/modules/tomcat')
+      @opts[:module_path] = '/modules/tomcat'
+      Retrospec.new(@opts[:module_path], @opts)
       expect(File.exists?(user_directory)).to eq(true)
       expect(File.exists?(File.join(user_directory, 'gemfile.erb'))).to eq(true)
       expect(File.exists?(File.join(user_directory, 'fixtures_file.erb'))).to eq(true)
       expect(File.exists?(File.join(user_directory, 'resource_spec_file.erb'))).to eq(true)
       expect(File.exists?(File.join(user_directory, 'shared_context.erb'))).to eq(true)
       expect(File.exists?(File.join(user_directory, 'spec_helper_file.erb'))).to eq(true)
+      expect(File.exists?(File.join(user_directory, 'nodesets'))).to eq(true)
+      expect(File.exists?(File.join(user_directory, 'nodesets', 'default.yml'))).to eq(true)
     end
-    ENV['RETROSPEC_ENABLE_LOCAL_TEMPLATES'] = nil
-    ENV['RETROSPEC_TEMPLATES_PATH'] = nil
   end
 
   it 'should create the user supplied templates directory when variable is set' do
-    ENV['RETROSPEC_TEMPLATES_PATH'] = '/tmp/my_templates'
+    @opts[:template_dir] = '/tmp/my_templates'
     FakeFS do
       FileUtils.mkdir_p(Helpers.gem_template_dir)
       FileUtils.touch(File.join(Helpers.gem_template_dir, 'fixtures_file.erb'))
@@ -66,9 +92,12 @@ describe "puppet-retrospec" do
       FileUtils.touch(File.join(Helpers.gem_template_dir, 'shared_context.erb'))
       FileUtils.touch(File.join(Helpers.gem_template_dir, 'spec_helper_file.erb'))
       FileUtils.touch(File.join(Helpers.gem_template_dir, 'gemfile.erb'))
+      FileUtils.mkdir_p(File.join(Helpers.gem_template_dir, 'nodesets'))
+      FileUtils.touch(File.join(Helpers.gem_template_dir, 'nodesets', 'default.yml'))
       FileUtils.mkdir_p('/modules/tomcat/manifests')
       FileUtils.touch('/modules/tomcat/manifests/init.pp')
-      r = Retrospec.new('/modules/tomcat')
+      @opts[:module_path] = '/modules/tomcat'
+      r = Retrospec.new(@opts[:module_path], @opts)
       user_directory = r.template_dir
       expect(user_directory).to eq('/tmp/my_templates')
       expect(File.exists?(user_directory)).to eq(true)
@@ -77,14 +106,14 @@ describe "puppet-retrospec" do
       expect(File.exists?(File.join(user_directory, 'resource_spec_file.erb'))).to eq(true)
       expect(File.exists?(File.join(user_directory, 'shared_context.erb'))).to eq(true)
       expect(File.exists?(File.join(user_directory, 'spec_helper_file.erb'))).to eq(true)
+      expect(File.exists?(File.join(user_directory, 'nodesets'))).to eq(true)
+      expect(File.exists?(File.join(user_directory, 'nodesets', 'default.yml'))).to eq(true)
     end
-    ENV['RETROSPEC_ENABLE_LOCAL_TEMPLATES'] = nil
-    ENV['RETROSPEC_TEMPLATES_PATH'] = nil
 
   end
 
   it 'should create proper spec helper file' do
-    tomcat = Retrospec.new(@path)
+    tomcat = Retrospec.new(@opts[:module_path], @opts)
     filepath = File.expand_path(File.join(@path, 'spec', 'spec_helper.rb'))
     path = tomcat.tmp_module_path
     tomcat.safe_create_spec_helper
@@ -92,22 +121,37 @@ describe "puppet-retrospec" do
   end
 
   it 'should create proper shared context file' do
-    tomcat = Retrospec.new(@path)
+    tomcat = Retrospec.new(@opts[:module_path], @opts)
     filepath = File.expand_path(File.join(@path, 'spec', 'shared_contexts.rb'))
     path = tomcat.tmp_module_path
     tomcat.safe_make_shared_context
     expect(File.exists?(filepath)).to eq(true)
   end
 
+  it 'should create acceptance spec helper file' do
+    tomcat = Retrospec.new(@opts[:module_path], @opts)
+    filepath = File.expand_path(File.join(@path, 'spec', 'spec_helper_acceptance.rb'))
+    tomcat.safe_create_acceptance_spec_helper
+    expect(File.exists?(filepath)).to eq(true)
+  end
+
+  it 'should create 15 nodesets' do
+    tomcat = Retrospec.new(@opts[:module_path], @opts)
+    filepath = File.expand_path(File.join(@path, 'spec', 'acceptance', 'nodesets', 'default.yml'))
+    tomcat.safe_create_node_sets
+    expect(File.exists?(filepath)).to eq(true)
+    expect(Dir.glob(File.expand_path(File.join(@path, 'spec', 'acceptance', 'nodesets', '*.yml'))).length).to eq(15)
+  end
+
   it 'should create Gemfile file' do
-    tomcat = Retrospec.new(@path)
+    tomcat = Retrospec.new(@opts[:module_path], @opts)
     filepath = File.expand_path(File.join(@path, 'Gemfile'))
     tomcat.safe_create_gemfile
     expect(File.exists?(filepath)).to eq(true)
   end
 
   it 'should create Rakefile file' do
-    tomcat = Retrospec.new(@path)
+    tomcat = Retrospec.new(@opts[:module_path], @opts)
     filepath = File.expand_path(File.join(@path, 'Rakefile'))
     tomcat.safe_create_rakefile
     expect(File.exists?(filepath)).to eq(true)
@@ -116,7 +160,7 @@ describe "puppet-retrospec" do
   it 'should create proper fixtures file' do
     filepath = File.expand_path(File.join(@path,'.fixtures.yml'))
     FileUtils.rm_f(filepath)  # ensure we have a clean state
-    tomcat = Retrospec.new(@path)
+    tomcat = Retrospec.new(@opts[:module_path], @opts)
     tomcat.safe_create_fixtures_file
     expect(File.exists?(filepath)).to eq(true)
   end
@@ -128,13 +172,13 @@ describe "puppet-retrospec" do
   end
 
   it 'should create a temp modules dir' do
-    tomcat = Retrospec.new(@path)
+    tomcat = Retrospec.new(@opts[:module_path], @opts)
     path = tomcat.tmp_modules_dir
     path.should =~ /modules/
   end
 
   it 'should create a link in the temp modules directory' do
-    tomcat = Retrospec.new(@path)
+    tomcat = Retrospec.new(@opts[:module_path], @opts)
     path = tomcat.tmp_modules_dir
     tomcat.tmp_module_path
     File.exists?(tomcat.tmp_module_path).should eq(true)
@@ -142,14 +186,59 @@ describe "puppet-retrospec" do
   end
 
   it 'should create a file from a template' do
-    tomcat = Retrospec.new(@path)
+    tomcat = Retrospec.new(@opts[:module_path], @opts)
     tomcat.safe_create_template_file('.fixtures.yml', 'fixtures_file.erb')
     file_path = File.join(@path,'.fixtures.yml')
     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")
+        allow(type).to receive(:type).and_return(:hostclass)
+        allow(type).to receive(:name).and_return('tomcat::config::server::connector')
+        tomcat = Retrospec.new(@opts[:module_path], @opts)
+        expect(tomcat.generate_file_path(type, true)).to eq("spec/acceptance/classes/config/server/connector/connector_spec.rb")
+      end
+      it 'should generate a normal test path correctly' do
+        type = double("type")
+        allow(type).to receive(:type).and_return(:hostclass)
+        allow(type).to receive(:name).and_return('tomcat::config::server::connector')
+        tomcat = Retrospec.new(@opts[:module_path], @opts)
+        expect(tomcat.generate_file_path(type, false)).to eq("spec/classes/config/server/connector/connector_spec.rb")
+      end
+    end
+
+    describe 'defines' do
+      it 'should generate a acceptance test path correctly' do
+        type = double("type")
+        allow(type).to receive(:type).and_return(:definition)
+        allow(type).to receive(:name).and_return('tomcat::config::server::connector')
+        tomcat = Retrospec.new(@opts[:module_path], @opts)
+        expect(tomcat.generate_file_path(type, true)).to eq("spec/acceptance/defines/config/server/connector/connector_spec.rb")
+      end
+
+      it 'should generate a normal test path correctly' do
+        type = double("type")
+        allow(type).to receive(:type).and_return(:definition)
+        allow(type).to receive(:name).and_return('tomcat::config::server::connector')
+        tomcat = Retrospec.new(@opts[:module_path], @opts)
+        expect(tomcat.generate_file_path(type, false)).to eq("spec/defines/config/server/connector/connector_spec.rb")
+      end
+    end
+  end
+
+  it 'should generate a test file name correctly' do
+     tomcat = Retrospec.new(@opts[:module_path], @opts)
+     expect(tomcat.generate_file_name('tomcat::config::server::connector')).to eq('connector_spec.rb')
+     expect(tomcat.generate_file_name('tomcat')).to eq('tomcat_spec.rb')
+     expect(tomcat.generate_file_name('tomcat::config')).to eq('config_spec.rb')
+  end
+
   # it 'should contain a list of parameters in the test' do
-  #   tomcat = Retrospec.new(@path)
+  #   tomcat = Retrospec.new(@opts[:module_path], @opts)
   #   tomcat.create_files
   #
   # end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-retrospec
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Corey Osman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-14 00:00:00.000000000 Z
+date: 2014-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet
@@ -156,11 +156,28 @@ files:
 - bin/retrospec
 - lib/helpers.rb
 - lib/puppet-retrospec.rb
+- lib/templates/acceptance_spec_test.erb
 - lib/templates/fixtures_file.erb
 - lib/templates/gemfile.erb
+- lib/templates/nodesets/centos-59-x64.yml
+- lib/templates/nodesets/centos-64-x64-pe.yml
+- lib/templates/nodesets/centos-64-x64.yml
+- lib/templates/nodesets/centos-65-x64.yml
+- lib/templates/nodesets/debian-607-x64.yml
+- lib/templates/nodesets/debian-70rc1-x64.yml
+- lib/templates/nodesets/debian-73-i386.yml
+- lib/templates/nodesets/debian-73-x64.yml
+- lib/templates/nodesets/default.yml
+- lib/templates/nodesets/fedora-18-x64.yml
+- lib/templates/nodesets/sles-11sp1-x64.yml
+- lib/templates/nodesets/ubuntu-server-10044-x64.yml
+- lib/templates/nodesets/ubuntu-server-12042-x64.yml
+- lib/templates/nodesets/ubuntu-server-1310-x64.yml
+- lib/templates/nodesets/ubuntu-server-1404-x64.yml
 - lib/templates/rakefile.erb
 - lib/templates/resource_spec_file.erb
 - lib/templates/shared_context.erb
+- lib/templates/spec_helper_acceptance.rb.erb
 - lib/templates/spec_helper_file.erb
 - puppet-retrospec.gemspec
 - spec/fixtures/fixture_modules/zero_resource_module/manifests/not_a_resource_defination.pp
@@ -188,7 +205,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.4
 signing_key: 
 specification_version: 4
 summary: Generates puppet rspec test code based on the classes and defines inside