puppet-retrospec 0.6.0 → 0.6.1

data/lib/retrospec/templates/resource_spec_file.erb

@@ -2,7 +2,7 @@ require 'spec_helper'
 require 'shared_contexts'
 
 describe '<%= @type.name -%>' do
-  # by default the hiera integration uses hirea data from the shared_contexts.rb file
+  # by default the hiera integration uses hiera data from the shared_contexts.rb file
   # but basically to mock hiera you first need to add a key/value pair
   # to the specific context in the spec/shared_contexts.rb file
   # Note: you can only use a single hiera context per describe/context block

data/lib/retrospec.rb

@@ -39,14 +39,7 @@ class Retrospec
   end
 
   def create_files
-    safe_create_spec_helper
-    safe_create_fixtures_file
-    safe_create_gemfile
-    safe_create_rakefile
-    safe_make_shared_context
-    safe_create_ci_file
-    safe_create_acceptance_spec_helper if spec_object.enable_beaker_tests?
-    safe_create_node_sets if spec_object.enable_beaker_tests?
+    safe_create_module_files
     # a Type is nothing more than a defined type or puppet class
     # we could have named this manifest but there could be multiple types
     # in a manifest.
@@ -60,59 +53,42 @@ class Retrospec
     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)
+  # creates any file that is contained in the templates/modules_files directory structure
+  # loops through the directory looking for erb files, all other files are ignored.
+  # strips the erb extension and renders the template to the current module path
+  # 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 = Dir.glob(File.join(template_dir,'module_files', '**', '{*,.*}')).find_all {|t| File.file?(t)}
+    templates.each do |template|
+      # need to remove the erb extension and rework the destination path
+      if template =~ /nodesets|spec_helper_acceptance/ and !spec_object.enable_beaker_tests?
+        next
+      else
+        dest = template.gsub(File.join(template_dir,'module_files'), module_path).gsub('.erb', '')
+        safe_create_template_file(dest, template)
+      end
     end
   end
 
-  def safe_create_ci_file(template='travis.yml.erb')
-     safe_create_template_file('.travis.yml.erb', template)
-  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
-
-  def safe_make_shared_context(template='shared_context.erb')
-    safe_create_template_file(File.join('spec','shared_contexts.rb'), template)
-  end
-
-  def safe_create_fixtures_file(template='fixtures_file.erb')
-    safe_create_template_file('.fixtures.yml', template)
-  end
-
-  def safe_create_spec_helper(template='spec_helper_file.erb')
-    safe_create_template_file(File.join('spec','spec_helper.rb'), template)
-  end
-
-  def safe_create_gemfile(template='gemfile.erb')
-    safe_create_template_file('Gemfile', template)
-  end
-
+  # path is the full path of the file to create
+  # template is the full path to the template file
   def safe_create_template_file(path, template)
     # check to ensure parent directory exists
-    file_dir_path = File.expand_path(File.join(module_path,File.dirname(path)))
+    file_dir_path = File.expand_path(File.dirname(path))
     if ! File.exists?(file_dir_path)
       Helpers.safe_mkdir(file_dir_path)
     end
-    template_path = File.join(template_dir, template)
-    File.open(template_path) do |file|
+    File.open(template) do |file|
       renderer = ERB.new(file.read, 0, '-')
       content = renderer.result spec_object.get_binding
-      dest_path = File.expand_path(File.join(module_path,path))
+      dest_path = File.expand_path(path)
       Helpers.safe_create_file(dest_path, content)
     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='resource_spec_file.erb')
+  def safe_create_resource_spec_files(type,template=File.join(template_dir,'resource_spec_file.erb'))
     spec_object.parameters = type.arguments
     spec_object.type = type
     VariableStore.populate(type)
@@ -120,15 +96,15 @@ class Retrospec
     # pass the type to the variable store and it will discover all the variables and try to resolve them.
     # this does not get deep nested conditional blocks
     spec_object.resources += Conditional.all(type)
-    file_path = generate_file_path(type, false)
+    file_path = File.join(module_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')
+  def safe_create_acceptance_tests(type,template=File.join(template_dir,'acceptance_spec_test.erb'))
     @parameters = type.arguments
     @type = type
-    file_path = generate_file_path(type, true)
+    file_path = File.join(module_path,generate_file_path(type, true))
     safe_create_template_file(file_path, template)
     file_path
   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.0 ruby lib
+# stub: puppet-retrospec 0.6.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "puppet-retrospec"
-  s.version = "0.6.0"
+  s.version = "0.6.1"
 
   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-25"
+  s.date = "2015-03-27"
   s.description = "Retrofits and generates valid puppet rspec test code to existing modules"
   s.email = "corey@logicminds.biz"
   s.executables = ["retrospec"]
@@ -23,6 +23,7 @@ Gem::Specification.new do |s|
     ".document",
     ".rspec",
     ".travis.yml",
+    "CHANGELOG.md",
     "Gemfile",
     "LICENSE",
     "README.md",
@@ -37,29 +38,30 @@ Gem::Specification.new do |s|
     "lib/retrospec/resource.rb",
     "lib/retrospec/spec_object.rb",
     "lib/retrospec/templates/acceptance_spec_test.erb",
-    "lib/retrospec/templates/fixtures_file.erb",
-    "lib/retrospec/templates/gemfile.erb",
-    "lib/retrospec/templates/nodesets/centos-59-x64.yml",
-    "lib/retrospec/templates/nodesets/centos-64-x64-pe.yml",
-    "lib/retrospec/templates/nodesets/centos-64-x64.yml",
-    "lib/retrospec/templates/nodesets/centos-66-x64.yml",
-    "lib/retrospec/templates/nodesets/debian-607-x64.yml",
-    "lib/retrospec/templates/nodesets/debian-70rc1-x64.yml",
-    "lib/retrospec/templates/nodesets/debian-73-i386.yml",
-    "lib/retrospec/templates/nodesets/debian-73-x64.yml",
-    "lib/retrospec/templates/nodesets/default.yml",
-    "lib/retrospec/templates/nodesets/fedora-18-x64.yml",
-    "lib/retrospec/templates/nodesets/sles-11sp1-x64.yml",
-    "lib/retrospec/templates/nodesets/ubuntu-server-10044-x64.yml",
-    "lib/retrospec/templates/nodesets/ubuntu-server-12042-x64.yml",
-    "lib/retrospec/templates/nodesets/ubuntu-server-1310-x64.yml",
-    "lib/retrospec/templates/nodesets/ubuntu-server-1404-x64.yml",
-    "lib/retrospec/templates/rakefile.erb",
+    "lib/retrospec/templates/module_files/.fixtures.yml",
+    "lib/retrospec/templates/module_files/.gitignore.erb",
+    "lib/retrospec/templates/module_files/.travis.yml",
+    "lib/retrospec/templates/module_files/Gemfile",
+    "lib/retrospec/templates/module_files/Rakefile",
+    "lib/retrospec/templates/module_files/spec/acceptance/nodesets/centos-59-x64.yml",
+    "lib/retrospec/templates/module_files/spec/acceptance/nodesets/centos-64-x64-pe.yml",
+    "lib/retrospec/templates/module_files/spec/acceptance/nodesets/centos-64-x64.yml",
+    "lib/retrospec/templates/module_files/spec/acceptance/nodesets/centos-66-x64.yml",
+    "lib/retrospec/templates/module_files/spec/acceptance/nodesets/debian-607-x64.yml",
+    "lib/retrospec/templates/module_files/spec/acceptance/nodesets/debian-70rc1-x64.yml",
+    "lib/retrospec/templates/module_files/spec/acceptance/nodesets/debian-73-i386.yml",
+    "lib/retrospec/templates/module_files/spec/acceptance/nodesets/debian-73-x64.yml",
+    "lib/retrospec/templates/module_files/spec/acceptance/nodesets/default.yml",
+    "lib/retrospec/templates/module_files/spec/acceptance/nodesets/fedora-18-x64.yml",
+    "lib/retrospec/templates/module_files/spec/acceptance/nodesets/sles-11sp1-x64.yml",
+    "lib/retrospec/templates/module_files/spec/acceptance/nodesets/ubuntu-server-10044-x64.yml",
+    "lib/retrospec/templates/module_files/spec/acceptance/nodesets/ubuntu-server-12042-x64.yml",
+    "lib/retrospec/templates/module_files/spec/acceptance/nodesets/ubuntu-server-1310-x64.yml",
+    "lib/retrospec/templates/module_files/spec/acceptance/nodesets/ubuntu-server-1404-x64.yml",
+    "lib/retrospec/templates/module_files/spec/shared_contexts.rb",
+    "lib/retrospec/templates/module_files/spec/spec_helper.rb",
+    "lib/retrospec/templates/module_files/spec/spec_helper_acceptance.rb",
     "lib/retrospec/templates/resource_spec_file.erb",
-    "lib/retrospec/templates/shared_context.erb",
-    "lib/retrospec/templates/spec_helper_acceptance.rb.erb",
-    "lib/retrospec/templates/spec_helper_file.erb",
-    "lib/retrospec/templates/travis.yml.erb",
     "lib/retrospec/type_code.rb",
     "lib/retrospec/variable_store.rb",
     "lib/retrospec/version.rb",
@@ -83,7 +85,7 @@ Gem::Specification.new do |s|
   ]
   s.homepage = "http://github.com/logicminds/puppet-retrospec"
   s.licenses = ["MIT"]
-  s.rubygems_version = "2.4.4"
+  s.rubygems_version = "2.4.5"
   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

@@ -30,9 +30,11 @@ describe "puppet-retrospec" do
 
   it 'should create files without error' do
     tomcat = Retrospec.new(@opts[:module_path], @opts)
-    expect(tomcat.create_files).to eq(true)
+    tomcat.create_files
     expect(File.exists?(File.join(@path, 'Gemfile'))).to eq(true)
     expect(File.exists?(File.join(@path, 'Rakefile'))).to eq(true)
+    expect(File.exists?(File.join(@path, 'spec','spec_helper.rb'))).to eq(true)
+    expect(File.exists?(File.join(@path, '.travis.yml'))).to eq(true)
     expect(File.exists?(File.join(@path, 'spec', 'shared_contexts.rb'))).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)
@@ -68,54 +70,58 @@ describe "puppet-retrospec" do
     @opts[:enable_user_templates] = true
     FakeFS do
       user_directory = Helpers.default_user_template_dir
-      FileUtils.mkdir_p(Helpers.gem_template_dir)
-      FileUtils.touch(File.join(Helpers.gem_template_dir, 'fixtures_file.erb'))
+      FileUtils.mkdir_p(File.join(Helpers.gem_template_dir, 'module_files', 'spec', 'acceptance','nodesets'))
+      FileUtils.touch(File.join(Helpers.gem_template_dir, 'module_files', '.fixtures.yml'))
       FileUtils.touch(File.join(Helpers.gem_template_dir, 'resource_spec_file.erb'))
-      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.touch(File.join(Helpers.gem_template_dir, 'module_files', 'spec','shared_contexts.rb'))
+      FileUtils.touch(File.join(Helpers.gem_template_dir, 'module_files', 'spec','spec_helper.rb'))
+      FileUtils.touch(File.join(Helpers.gem_template_dir, 'module_files','Gemfile'))
+      FileUtils.touch(File.join(Helpers.gem_template_dir, 'module_files','Rakefile'))
+      FileUtils.touch(File.join(Helpers.gem_template_dir, 'module_files', 'spec', 'acceptance','nodesets', 'default.yml'))
       FileUtils.mkdir_p('/modules/tomcat/manifests')
-      FileUtils.touch('/modules/tomcat/manifests/init.pp')
+      #FileUtils.open('/modules/tomcat/manifests/init.pp', 'w') {|f| f.write("class 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, 'module_files', '.fixtures.yml'))).to eq(true)
+      expect(File.exists?(File.join(user_directory, 'module_files','Gemfile'))).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)
+      expect(File.exists?(File.join(user_directory, 'module_files','spec','shared_contexts.rb'))).to eq(true)
+      expect(File.exists?(File.join(user_directory, 'module_files','spec','spec_helper.rb'))).to eq(true)
+      expect(File.exists?(File.join(user_directory, 'module_files','spec','acceptance','nodesets'))).to eq(true)
+      expect(File.exists?(File.join(user_directory, 'module_files','spec','acceptance','nodesets','default.yml'))).to eq(true)
+      expect(File.exists?(File.join(user_directory, 'module_files','Rakefile'))).to eq(true)
+
     end
   end
 
   it 'should create the user supplied templates directory when variable is set' do
     @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'))
+      FileUtils.mkdir_p(File.join(Helpers.gem_template_dir, 'module_files', 'spec', 'acceptance','nodesets'))
+      FileUtils.touch(File.join(Helpers.gem_template_dir, 'module_files', '.fixtures.yml'))
       FileUtils.touch(File.join(Helpers.gem_template_dir, 'resource_spec_file.erb'))
-      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.touch(File.join(Helpers.gem_template_dir, 'module_files', 'spec','shared_contexts.rb'))
+      FileUtils.touch(File.join(Helpers.gem_template_dir, 'module_files', 'spec','spec_helper.rb'))
+      FileUtils.touch(File.join(Helpers.gem_template_dir, 'module_files','Gemfile'))
+      FileUtils.touch(File.join(Helpers.gem_template_dir, 'module_files','Rakefile'))
+      FileUtils.touch(File.join(Helpers.gem_template_dir, 'module_files', 'spec', 'acceptance','nodesets', 'default.yml'))
       FileUtils.mkdir_p('/modules/tomcat/manifests')
-      FileUtils.touch('/modules/tomcat/manifests/init.pp')
+      #FileUtils.open('/modules/tomcat/manifests/init.pp', 'w') {|f| f.write("class 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)
-      expect(File.exists?(File.join(user_directory, 'fixtures_file.erb'))).to eq(true)
-      expect(File.exists?(File.join(user_directory, 'gemfile.erb'))).to eq(true)
+      expect(File.exists?(File.join(user_directory, 'module_files', '.fixtures.yml'))).to eq(true)
+      expect(File.exists?(File.join(user_directory, 'module_files','Gemfile'))).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)
+      expect(File.exists?(File.join(user_directory, 'module_files','spec','shared_contexts.rb'))).to eq(true)
+      expect(File.exists?(File.join(user_directory, 'module_files','spec','spec_helper.rb'))).to eq(true)
+      expect(File.exists?(File.join(user_directory, 'module_files','spec','acceptance','nodesets'))).to eq(true)
+      expect(File.exists?(File.join(user_directory, 'module_files','spec','acceptance','nodesets','default.yml'))).to eq(true)
+      expect(File.exists?(File.join(user_directory, 'module_files','Rakefile'))).to eq(true)
+
     end
 
   end
@@ -123,45 +129,58 @@ describe "puppet-retrospec" do
   it 'should create proper spec helper file' do
     tomcat = Retrospec.new(@opts[:module_path], @opts)
     filepath = File.expand_path(File.join(@path, 'spec', 'spec_helper.rb'))
+    tomcat.safe_create_module_files
     path = tomcat.module_path
-    tomcat.safe_create_spec_helper
     expect(File.exists?(filepath)).to eq(true)
   end
 
   it 'should create proper shared context file' do
     tomcat = Retrospec.new(@opts[:module_path], @opts)
     filepath = File.expand_path(File.join(@path, 'spec', 'shared_contexts.rb'))
+    tomcat.safe_create_module_files
     path = tomcat.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)
+    opts = {:module_path => @path, :enable_beaker_tests => true,
+             :enable_user_templates => false, :template_dir => nil }
+    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
+    tomcat.safe_create_module_files
     expect(File.exists?(filepath)).to eq(true)
   end
 
+  it 'should not create acceptance spec helper file' do
+    opts = {:module_path => @path, :enable_beaker_tests => false,
+            :enable_user_templates => false, :template_dir => nil }
+    filepath = File.expand_path(File.join(@path, 'spec', 'spec_helper_acceptance.rb'))
+    tomcat = Retrospec.new(@opts[:module_path], opts)
+    tomcat.safe_create_module_files
+    expect(File.exists?(filepath)).to eq(false)
+  end
+
   it 'should create 15 nodesets' do
-    tomcat = Retrospec.new(@opts[:module_path], @opts)
+    opts = {:module_path => @path, :enable_beaker_tests => true,
+            :enable_user_templates => false, :template_dir => nil }
+    tomcat = Retrospec.new(@opts[:module_path], opts)
     filepath = File.expand_path(File.join(@path, 'spec', 'acceptance', 'nodesets', 'default.yml'))
-    tomcat.safe_create_node_sets
+    tomcat.safe_create_module_files
     expect(File.exists?(filepath)).to eq(true)
-    expect(Dir.glob(File.expand_path(File.join(@path, 'spec', 'acceptance', 'nodesets', '*.yml'))).length).to eq(15)
+    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(@opts[:module_path], @opts)
     filepath = File.expand_path(File.join(@path, 'Gemfile'))
-    tomcat.safe_create_gemfile
+    tomcat.safe_create_module_files
     expect(File.exists?(filepath)).to eq(true)
   end
 
   it 'should create Rakefile file' do
     tomcat = Retrospec.new(@opts[:module_path], @opts)
     filepath = File.expand_path(File.join(@path, 'Rakefile'))
-    tomcat.safe_create_rakefile
+    tomcat.safe_create_module_files
     expect(File.exists?(filepath)).to eq(true)
   end
 
@@ -169,7 +188,7 @@ describe "puppet-retrospec" do
     filepath = File.expand_path(File.join(@path,'.fixtures.yml'))
     FileUtils.rm_f(filepath)  # ensure we have a clean state
     tomcat = Retrospec.new(@opts[:module_path], @opts)
-    tomcat.safe_create_fixtures_file
+    tomcat.safe_create_module_files
     expect(File.exists?(filepath)).to eq(true)
   end
 
@@ -181,8 +200,9 @@ describe "puppet-retrospec" do
 
   it 'should create a file from a template' do
     tomcat = Retrospec.new(@opts[:module_path], @opts)
-    tomcat.safe_create_template_file('.fixtures.yml', 'fixtures_file.erb')
     file_path = File.join(@path,'.fixtures.yml')
+    template_file = File.join(tomcat.template_dir,'module_files','.fixtures.yml')
+    tomcat.safe_create_template_file(file_path, template_file)
     expect(File.exists?(file_path)).to eq(true)
   end
 
@@ -230,5 +250,4 @@ describe "puppet-retrospec" do
      expect(tomcat.generate_file_name('tomcat')).to eq('tomcat_spec.rb')
      expect(tomcat.generate_file_name('tomcat::config')).to eq('config_spec.rb')
   end
-
 end