rspec-puppet-utils 3.2.2 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f89a0b9d1954d53efa11f7127b7a0b074eac63b0
-  data.tar.gz: 8b952e545404d63e1b2824c8ec54ba0ab292ca9f
+  metadata.gz: 9889ff4f04abf064cb1bb613d08cc43ab297dddc
+  data.tar.gz: 5962bbdd9291625f70a65b53d3cdb17ccb513efd
 SHA512:
-  metadata.gz: 79e5d9f74540f16112126eff2572e5221c97dc9ce8a51047a8c136bd68a873e0f6b60d632ded9d6481c40032dcf2a2d2be97f803dab904d60280b43a804a819d
-  data.tar.gz: 620b9073ef83624615d028d929a2c8df9a2aa182a16b5db8e848b0093f8710aeda35ef1751a25a226a8d0d1844fac54f8b0a28435c2c040ba6e8125eca871d1a
+  metadata.gz: d51415db60d4fcac48d2b1710550e8fc1e7ee7c6251d7645eb6699ba6a2b3eabf2a125b45800692c6d621d1b64d125606d405f1ef93034f68c7719aa7c1d1aa3
+  data.tar.gz: 0184e3591aeb8c9bb8f4719ec5b731189d1a651492ab32a9f4761b5d681e7215c7ef42d4e5b9d4b24c69f11241dfc17660ce2eeb1378d06728049af582f89b7c

data/lib/rspec_puppet_utils/rake/project_tasks.rb

@@ -8,12 +8,12 @@ module Rake
 
   class Puppet
 
-    attr_accessor :module_path, :excluded_modules
+    attr_accessor :module_dirs, :excluded_modules
     attr_accessor :package_dir, :package_files, :package_version, :package_versioning
 
-    @module_path        # (string)   The directory containing all the modules to test
-    @excluded_dirs      # (string[]) Directories excluded from rspec search
-    @excluded_modules   # (string[]) Modules excluded from rspec testing
+    @module_dirs        # (string[]) The directories containing modules to test
+    @excluded_dirs      # (string[]) Directories excluded from spec search
+    @excluded_modules   # (string[]) Modules excluded from spec testing
     @package_dir        # (string)   Where the puppet zip package will be created
     @package_files      # (string[]) Files and directories to include in the package
     @package_name       # (string)   Name of the package
@@ -23,11 +23,11 @@ module Rake
     def initialize
       extend Rake::DSL  # makes 'namespace' and 'task' methods available to instance
 
-      @module_path        = 'modules' # Deliberately excludes modules-lib dir
+      @module_dirs        = ['lib', 'site'] # Deliberately excludes 'modules' dir
       @excluded_dirs      = ['.', '..']
       @excluded_modules   = []
       @package_dir        = 'pkg'
-      @package_files      = ['modules', 'modules-lib', 'environment.conf']
+      @package_files      = @module_dirs + ['modules', 'hieradata', 'environment.conf']
       @package_name       = 'puppet'
       @package_version    = nil
       @package_versioning = true
@@ -39,23 +39,29 @@ module Rake
     end
 
     def testable_modules
-      raise ArgumentError, 'Excluded modules must be an array' unless @excluded_modules.is_a? Array
-      module_dirs = Dir.entries(@module_path) - @excluded_dirs - @excluded_modules
-      filter_modules module_dirs
+      raise ArgumentError, 'module_paths must be an array' unless @module_dirs.is_a? Array
+      raise ArgumentError, 'excluded_modules must be an array' unless @excluded_modules.is_a? Array
+      modules = []
+      @module_dirs.each { |module_dir|
+        raise ArgumentError, "Module path #{module_dir} could not be found" unless Dir.exist?(module_dir)
+        entries = Dir.entries(module_dir) - @excluded_dirs - @excluded_modules
+        modules.concat entries.collect { |entry| "#{module_dir}/#{entry}" }
+      }
+      filter_modules modules
     end
 
-    def filter_modules(module_dirs)
-      module_dirs.select! { |m| module_has_specs?(m) and module_has_rakefile?(m) }
-      module_dirs
+    def filter_modules(modules)
+      modules.select! { |m| module_has_specs?(m) and module_has_rakefile?(m) }
+      modules
     end
 
     def module_has_specs?(module_dir)
-      File.directory?("#{@module_path}/#{module_dir}/spec")
+      File.directory? "#{module_dir}/spec"
     end
 
     def module_has_rakefile?(module_dir)
       rakefiles = ['rakefile', 'rakefile.rb']
-      entries   = Dir.entries("#{@module_path}/#{module_dir}")
+      entries   = Dir.entries module_dir
       entries.collect! { |f| f.downcase }
       rakefiles.each { |rf| return true if entries.include? rf }
       false
@@ -63,27 +69,25 @@ module Rake
 
     def load_module_tasks
 
-      modules    = testable_modules
-      spec_tasks = modules.collect { |m| "#{m}:#{:spec}" }
-      # lint_tasks = modules.collect { |m| "#{m}:#{:lint}" }
+      modules      = testable_modules
+      module_names = testable_modules.collect { |m| m.split('/')[1] }
+      spec_tasks   = module_names.collect { |mn| "#{mn}:#{:spec}" }
+
+      modules.each_with_index { |module_path, i|
 
-      modules.each { |puppet_module|
-        namespace puppet_module do
+        module_name = module_names[i]
 
-          desc "Run #{puppet_module} module specs"
+        namespace module_name do
+          desc "Run #{module_name} module specs"
           task :spec do
-            Dir.chdir "#{@module_path}/#{puppet_module}" do
+            Dir.chdir module_path do
               success = system('rake spec') # This isn't perfect but ...
               exit 1 unless success
             end
           end
-
         end
       }
 
-      # desc 'Run lint checks for all modules'
-      # task :lint => lint_tasks
-
       desc 'Run specs in all modules'
       task :spec    => spec_tasks
       task :default => :spec
@@ -109,7 +113,7 @@ module Rake
 
         task :package => [:prep] do
           # Exclude all the spec code as it's not needed once deployed
-          exclude_patterns = ['modules/\*/spec/\*', 'modules-lib/\*/spec/\*']
+          exclude_patterns = ['\*/\*/spec/\*']
           exclude_string   = "-x #{exclude_patterns.join(' ')}"
           include_string   = @package_files.join(' ')
           cmd     = "zip -qr #{package_path} #{include_string} #{exclude_string}"

data/rspec-puppet-utils.gemspec

@@ -1,7 +1,7 @@
 # -*- encoding: utf-8 -*-
 Gem::Specification.new do |gem|
   gem.name          = 'rspec-puppet-utils'
-  gem.version       = '3.2.2'
+  gem.version       = '3.3.0'
   gem.description   = 'Helper classes for mock/stub functions, templates and hieradata'
   gem.summary       = ''
   gem.author        = 'Tom Poulton'

data/spec/classes/rake/project_tasks_spec.rb

@@ -3,10 +3,10 @@ require 'lib/rspec_puppet_utils/rake/project_tasks'
 
 describe Rake::Puppet do
 
-  module_path      = 'modules'
-  testable_modules = [ 'core', 'base' ]
-  modules_dir_list = [ 'core', 'base', 'role', 'profiles' ]
-  rakefile_names   = ['Rakefile', 'rakefile', 'Rakefile.rb', 'rakefile.rb']
+  testable_module_names = [ 'core', 'base' ]
+  testable_modules = [ 'lib/core', 'lib/base' ]
+  sample_modules   = [ 'lib/core', 'lib/base', 'site/role', 'site/profile' ]
+  rakefile_names   = [ 'Rakefile', 'rakefile', 'Rakefile.rb', 'rakefile.rb' ]
 
   let(:puppet) { Rake::Puppet.new }
 
@@ -30,7 +30,7 @@ describe Rake::Puppet do
 
     it 'creates a task for each module' do
       puppet.load_module_tasks
-      testable_modules.each { |mod|
+      testable_module_names.each { |mod|
         expect(Rake::Task.task_defined?("#{mod}:spec")).to eq true
       }
     end
@@ -40,6 +40,13 @@ describe Rake::Puppet do
       expect(Rake::Task.task_defined?(:spec)).to eq true
     end
 
+    it 'makes module spec tasks prerequisites of main spec task' do
+      puppet.load_module_tasks
+      task_names = testable_module_names.collect { |mn| "#{mn}:spec" }
+      prerequisites = Rake::Task[:spec].prerequisites
+      expect(prerequisites).to match_array task_names
+    end
+
   end
 
   describe 'load_build_tasks' do
@@ -105,9 +112,9 @@ describe Rake::Puppet do
       Dir.stubs(:entries).returns rakefile_names # bypass Rakefile filter
 
       File.stubs(:directory?).returns false
-      File.stubs(:directory?).with(regexp_matches( /(#{testable_modules.join '|'})\/spec$/ )).returns(true)
+      File.stubs(:directory?).with(regexp_matches( /^(#{testable_modules.join '|'})\/spec$/ )).returns(true)
 
-      result = puppet.filter_modules modules_dir_list
+      result = puppet.filter_modules sample_modules
       expect(result).to match_array testable_modules
     end
 
@@ -115,9 +122,9 @@ describe Rake::Puppet do
       it 'filters modules with a Rakefile' do
         File.stubs(:directory?).returns true # bypass spec dir filter
 
-        Dir.stubs(:entries).with(regexp_matches( /#{testable_modules.join '|'}/ )).returns([filename])
+        Dir.stubs(:entries).with(regexp_matches( /^#{testable_modules.join '|'}/ )).returns([filename])
 
-        result = puppet.filter_modules modules_dir_list
+        result = puppet.filter_modules sample_modules
         expect(result).to match_array testable_modules
       end
     }
@@ -131,35 +138,46 @@ describe Rake::Puppet do
       def puppet.filter_modules(_modules)
         _modules
       end
+
+      Dir.stubs(:exist?).returns true
+      Dir.stubs(:entries).with('lib').returns(['one', 'two'])
+      Dir.stubs(:entries).with('site').returns(['three', 'four'])
+      Dir.stubs(:entries).with('extra').returns(['five', 'six'])
     end
 
-    it 'ignores excluded directories' do
-      Dir.stubs(:entries).with(module_path).returns testable_modules + ['.', '..']
+    it 'finds modules in all paths' do
+      puppet.module_dirs << 'extra'
+      modules = ['lib/one', 'lib/two', 'site/three', 'site/four', 'extra/five', 'extra/six']
+      expect(puppet.testable_modules).to match_array modules
+    end
 
-      result = puppet.testable_modules
-      expect(result).to match_array testable_modules
+    it 'ignores excluded directories' do
+      Dir.stubs(:entries).with('lib').returns(['.', '..', 'one', 'two'])
+      modules = ['lib/one', 'lib/two', 'site/three', 'site/four']
+      expect(puppet.testable_modules).to match_array modules
     end
 
     it 'ignores excluded modules' do
-      Dir.stubs(:entries).with(module_path).returns testable_modules + ['exclude_me']
+      puppet.excluded_modules = ['two', 'four']
+      modules = ['lib/one', 'site/three']
+      expect(puppet.testable_modules).to match_array modules
+    end
 
-      puppet.excluded_modules = ['exclude_me']
-      result = puppet.testable_modules
-      expect(result).to match_array testable_modules
+    it 'raises an error if module_paths is not an array' do
+      puppet.module_dirs = 'not an array'
+      expect { puppet.testable_modules }.to raise_error(ArgumentError, /must be an array/)
     end
 
-    it 'throws error if excluded modules is not an array' do
+    it 'raises an error if excluded modules is not an array' do
       puppet.excluded_modules = 'not an array'
       expect { puppet.testable_modules }.to raise_error(ArgumentError, /must be an array/)
     end
 
-    it 'finds modules within module_path' do
-      alt_module_path = 'modules-alt'
-
-      Dir.expects(:entries).with(alt_module_path).returns modules_dir_list
-
-      puppet.module_path = alt_module_path
-      puppet.testable_modules
+    it 'raises an error if a path directory does not exist' do
+      Dir.stubs(:exist?).with('lib').returns false
+      expect {
+        puppet.testable_modules
+      }.to raise_error(ArgumentError, /lib could not be found/)
     end
 
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-puppet-utils
 version: !ruby/object:Gem::Version
-  version: 3.2.2
+  version: 3.3.0
 platform: ruby
 authors:
 - Tom Poulton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-17 00:00:00.000000000 Z
+date: 2017-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet