puppet-retrospec 0.8.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ada5efee2f6a122df764761d60307c1951614028
-  data.tar.gz: db4283ea63f82033a71fedcd38e96735804f2efa
+  metadata.gz: 8ee18423b45926dd5af55e9ae5ab06ad259d391a
+  data.tar.gz: 8fdb6a385bebe775d225e7a7481babb93285a5ac
 SHA512:
-  metadata.gz: 3b0884dc164408e7c701e6bb9e54539994e3825a8b7c2179887d865cbc05108b1c947b5c8316882971678aa55f75e00c1029eed1d31275fcc0c4c3330773f267
-  data.tar.gz: 8b3b5639d4dd851beb2ab140e2f17df1b123fb79d1f015e05580730835f5f81c00867c5e1d2e79e1a4c8cc3d9422de70abe5be7147dc8d0c2afbcab3b8fda823
+  metadata.gz: d726ea817412307e481be8394b37d7c4904b010a37068ba824337a9715b67679c8da15f3805d8abdb88386328e664d4563c9c577272a5f946dc0eca8f5dfab85
+  data.tar.gz: 695e39765fa941e955d36acda5cb4882a0aa7c61b228bdc3c740e92a4876f1326cc7357bfe22b5b141df142eddd2bcf98712cd2737656f578f53e2a32029529f

data/.travis.yml

@@ -15,6 +15,7 @@ env:
     - PUPPET_GEM_VERSION="~> 3.6"
     - PUPPET_GEM_VERSION="~> 3.7"
 
+
 matrix:
   exclude:
     - rvm: 1.9.3

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.9.0
+ * convert to retrospec plugin
+ This is a big change in how you run puppet-retrospec please see the readme for changes.
+ 
 ## 0.8.1
  * gh-30 - add support for host resource types
 ## 0.8.0

data/Gemfile

@@ -6,9 +6,10 @@ source "http://rubygems.org"
 #gem 'hiera', '~> 1.0'
 
 gem 'trollop'
+gem 'retrospec', "~> 0.3"
 # Include everything needed to run rake, tests, features, etc.
 group :development do
-  gem "rspec", "~> 2.14"
+  gem "rspec", "~> 3.2"
   gem 'puppet', '3.7.3',  :path => 'vendor/gems/puppet-3.7.3'
   #gem 'facter', '< 3', '> 1.6'
   #gem 'hiera', '~> 1.0'

data/Gemfile.lock

@@ -0,0 +1,121 @@
+PATH
+  remote: vendor/gems/puppet-3.7.3
+  specs:
+    puppet (3.7.3)
+      facter (> 1.6, < 3)
+      hiera (~> 1.0)
+      json_pure
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    CFPropertyList (2.2.8)
+    addressable (2.3.8)
+    binding_of_caller (0.7.2)
+      debug_inspector (>= 0.0.1)
+    builder (3.2.2)
+    coderay (1.1.0)
+    coolline (0.5.0)
+      unicode_utils (~> 1.4)
+    debug_inspector (0.0.2)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.2.5)
+    facter (2.4.4)
+      CFPropertyList (~> 2.2.6)
+    fakefs (0.6.7)
+    faraday (0.9.1)
+      multipart-post (>= 1.2, < 3)
+    git (1.2.9.1)
+    github_api (0.12.4)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 3.4)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.6)
+      oauth2
+    hashie (3.4.2)
+    hiera (1.3.4)
+      json_pure
+    highline (1.7.7)
+    interception (0.5)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    json (1.8.3)
+    json_pure (1.8.2)
+    jwt (1.5.1)
+    method_source (0.8.2)
+    mini_portile (0.6.2)
+    multi_json (1.11.2)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    oauth2 (1.0.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    pry (0.10.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-coolline (0.2.5)
+      coolline (~> 0.5)
+    pry-rescue (1.4.2)
+      interception (>= 0.5)
+      pry
+    pry-stack_explorer (0.4.9.2)
+      binding_of_caller (>= 0.7)
+      pry (>= 0.9.11)
+    rack (1.6.4)
+    rake (10.4.2)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    retrospec (0.3.0)
+      trollop
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    slop (3.6.0)
+    thread_safe (0.3.5)
+    trollop (2.1.2)
+    unicode_utils (1.4.0)
+    yard (0.8.7.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  fakefs
+  jeweler
+  pry
+  pry-coolline
+  pry-rescue
+  pry-stack_explorer
+  puppet (= 3.7.3)!
+  rdoc (~> 3.12)
+  retrospec (~> 0.3)
+  rspec (~> 3.2)
+  trollop
+  yard (~> 0.7)

data/README.md

@@ -67,6 +67,9 @@ Generates puppet rspec test code based on the classes and defines inside the man
 retrospec -m ~/projects/puppet_modules/apache
 ```
 
+plugins::puppet::templates::url: https://github.com/nwops/retrospec-templates
+plugins::puppet::templates::ref: master
+
 Example
 ======================
 

data/Rakefile

@@ -15,7 +15,7 @@ require 'jeweler'
 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.homepage = "http://github.com/logicminds/puppet-retrospec"
+  gem.homepage = "http://github.com/nwops/puppet-retrospec"
   gem.license = "MIT"
   gem.summary = %Q{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.}
   gem.description = %Q{Retrofits and generates valid puppet rspec test code to existing modules}

data/VERSION

@@ -1 +1 @@
-0.8.1
+0.9.0

data/lib/retrospec-puppet.rb

@@ -0,0 +1,3 @@
+vendor = File.join(File.dirname(File.dirname(__FILE__)),'vendor')
+$:.unshift(File.expand_path(File.join([vendor, "gems", "puppet-3.7.3", "lib"])))
+require 'retrospec/plugins/v1/plugin/puppet'

data/lib/retrospec/{conditional.rb → plugins/v1/plugin/conditional.rb}

@@ -1,4 +1,4 @@
-require 'retrospec/resource'
+require_relative 'resource'
 
 class Conditional
   attr_reader :test, :value, :statements

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

@@ -0,0 +1,32 @@
+require 'fileutils'
+
+class Helpers
+
+  def self.get_module_name
+    module_name = nil
+    Dir["manifests/*.pp"].entries.each do |manifest|
+      module_name = get_module_name_from_file(manifest)
+      break unless module_name.nil?
+    end
+    module_name
+  end
+
+  def self.get_module_name_from_file(file)
+    p = Puppet::Parser::Lexer.new
+    module_name = nil
+    p.string = File.read(file)
+    tokens = p.fullscan
+
+    i = tokens.index { |token| [:CLASS, :DEFINE].include? token.first }
+    unless i.nil?
+      module_name = tokens[i + 1].last[:value].split('::').first
+    end
+
+    module_name
+  end
+
+  def self.is_module_dir?(dir)
+    Dir[File.join(dir,"*")].entries.include? "manifests"
+  end
+
+end

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

@@ -0,0 +1,248 @@
+require 'retrospec/plugins/v1/module_helpers'
+require 'retrospec/plugins/v1'
+require_relative 'spec_object'
+require 'erb'
+require_relative 'template_helpers'
+require 'fileutils'
+require_relative 'resource'
+require_relative 'conditional'
+require_relative 'variable_store'
+require_relative 'puppet_module'
+require 'retrospec/exceptions'
+require_relative 'version'
+require 'find'
+require 'puppet'
+
+module Retrospec
+  module Plugins
+    module V1
+      class Puppet < Retrospec::Plugins::V1::Plugin
+        include Retrospec::Puppet::TemplateHelpers
+        attr_reader :template_dir, :context, :manifest_dir, :manifest_files
+
+        def initialize(supplied_module_path=nil,config={})
+          super
+          @manifest_dir = File.join(supplied_module_path,'manifests')
+          Utilities::PuppetModule.instance.future_parser = config_data[:enable_future_parser]
+          # user supplied a template path or user wants to use local templates
+          @template_dir = setup_user_template_dir(config_data[:template_dir], config_data[:scm_url], config_data[:ref])
+          # validation also occurs when setting the module path
+          Utilities::PuppetModule.instance.module_path = module_path
+          Utilities::PuppetModule.create_tmp_module_path # this is required to finish initialization
+          @context = ::Puppet::SpecObject.new(module_path, Utilities::PuppetModule.instance, config_data)
+        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 the initialize code
+        def self.cli_options(global_opts)
+          template_dir = global_opts['plugins::puppet::template_dir'] || File.expand_path('~/.retrospec/repos/retrospec-puppet-templates')
+          scm_url = ENV['RETROSPEC_PUPPET_SCM_URL'] || global_opts['plugins::puppet::templates::url']
+          scm_branch = ENV['RETROSPEC_PUPPET_SCM_BRANCH'] || global_opts['plugins::puppet::templates::ref'] || 'master'
+          future_parser = global_opts['plugins::puppet::enable_future_parser']
+          beaker_tests  = global_opts['plugins::puppet::enable_beaker_tests']
+          Trollop::options do
+            version "#{Retrospec::Puppet::VERSION} (c) Corey Osman"
+            banner <<-EOS
+Generates puppet rspec test code based on the classes and defines inside the manifests directory.
+
+            EOS
+            opt :template_dir, "Path to templates directory (only for overriding Retrospec templates)", :type => :string,
+                :required => false, :default => template_dir
+            opt :scm_url, "SCM url for retrospec templates", :type => :string, :required => false,
+                :default => scm_url
+            opt :branch, "Branch you want to use for the retrospec template repo", :type => :string, :required => false,
+                :default => scm_branch
+            opt :enable_beaker_tests, "Enable the creation of beaker tests", :require => false, :type => :boolean, :default => beaker_tests
+            opt :enable_future_parser, "Enables the future parser only during validation", :default => future_parser, :require => false, :type => :boolean
+          end
+        end
+
+        # this is the main method the starts all the magic
+        def run
+          run_pre_hook
+          create_files
+          run_post_hook
+        end
+
+        # the template directory located inside the retrospec gem
+        def template_dir
+          @template_dir ||= File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+        end
+
+        # runs a user defined hook called pre-hook
+        def run_pre_hook
+          hook_file = File.join(template_dir,'pre-hook')
+          if File.exists?(hook_file)
+            output = `#{hook_file} #{module_path}`
+            if $?.success?
+              puts "Successfully ran hook: #{hook_file}".info
+              puts output.info
+            else
+              puts "Error running hook: #{hook_file}".fatal
+              puts output.fatal
+            end
+          end
+        end
+
+        # runs a user defined hook called post-hook
+        def run_post_hook
+          hook_file = File.join(template_dir,'post-hook')
+          if File.exists?(hook_file)
+            output = `#{hook_file} #{module_path}`
+            if $?.success?
+              puts "Successfully ran hook: #{hook_file}".info
+              puts output.info
+            else
+              puts "Error running hook: #{hook_file}".fatal
+              puts output.fatal
+            end
+          end
+        end
+
+        # this is the method that performs all the magic and creates all the files
+        def create_files
+          types = context.types
+          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.
+          types.each do |type|
+            safe_create_resource_spec_files(type)
+            if context.enable_beaker_tests?
+              safe_create_acceptance_tests(type)
+            end
+          end
+          Utilities::PuppetModule.clean_tmp_modules_dir
+          true
+        end
+
+        # creates any file that is contained in the templates/modules_files directory structure
+        # loops through the directory looking for erb files or other files.
+        # 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 = Find.find(File.join(template_dir,'module_files')).find_all {|f| !File.directory?(f)}.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', '')
+              if File.symlink?(template)
+                safe_create_symlink(template, dest)
+              elsif File.directory?(template)
+                safe_mkdir(dest)
+              else
+                safe_create_template_file(dest, template, context)
+              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'))
+          context.parameters = type.arguments
+          context.type = type
+          VariableStore.populate(type)
+          context.resources = Resource.all(type)
+          # 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
+          context.resources += Conditional.all(type)
+          dest = File.join(module_path,generate_file_path(type, false))
+          safe_create_template_file(dest, template, context)
+          dest
+        end
+
+        def safe_create_acceptance_tests(type,template=File.join(template_dir,'acceptance_spec_test.erb'))
+          @parameters = type.arguments
+          @type = type
+          dest = File.join(module_path,generate_file_path(type, true))
+          safe_create_template_file(dest, template, context)
+          dest
+        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
+            when :node
+              type_dir_name = hosts_dir
+            else
+              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('::')
+          # if there are only two tokens ie. tomcat::params we dont need to create a subdirectory
+          if tokens.count > 2
+            # this is a deep level resource ie. tomcat::config::server::connector
+            # however we don't need the tomcat directory so we can just remove it
+            # this should leave us with config/server/connector_spec.rb
+            tokens.delete_at(0)
+            # remove the last token since its the class name
+            tokens.pop
+            # 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, file_name) # spec/classes/tomcat/config/server
+          else
+            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
+
+        def description
+          'Generates puppet rspec test code based on the classes and defines inside the manifests directory'
+        end
+
+        def manifest_files
+          @manifest_files ||= Dir.glob("#{manifest_dir}/**/*.pp")
+        end
+
+        def files
+          @files ||= manifest_files
+        end
+
+        # the main file type that is used to help discover what the module is
+        def self.file_type
+          '.pp'
+        end
+
+        # # validates module directory fits the description of this plugin
+        # def self.validate_type(dir)
+        #   if ! File.exist?(manifest_dir)
+        #     message = "No manifest directory in #{manifest_dir}, cannot validate this is a module".fatal
+        #     raise TypeValidationException message
+        #   else
+        #     manifest_files ||= Dir.glob("#{manifest_dir}/**/*.pp")
+        #     warn "No puppet manifest files found at #{manifest_dir}".warning if manifest_files.length < 1
+        #   end
+        #   true
+        # end
+      end
+    end
+  end
+end