rspec-puppet-utils 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 924d4f298027f823e62dea1fb2c6b5aaee469b61
-  data.tar.gz: 7b0f41dbb693412266edc0d75f4f50db282bc9ff
+  metadata.gz: 6408456fd57f31f7a1dac8a2e5d2f77abce8ec74
+  data.tar.gz: 4c315ea6bd272943af43901067793efd9e5b842c
 SHA512:
-  metadata.gz: 3de55b7778ccaf128ff7ac8630e076dc6eb0c981dde9bb43f5de612977154a5554bb6ce94e32cd2b501062fead337c37b8d713dc1c708bc40c707e6971af47ff
-  data.tar.gz: 2367547ae235d27906bfff7b1e5647cc7ef272ad7dd6169362815813ae740cb8cf5b75cb91ea3e8e2ca751fec455081d84cfc36c68efa9fc478f15513f422f05
+  metadata.gz: bfcc051e951a036c1a9037555f74e7be1a5de6b0a2310005013d97ff9f1c32a4ed03aeb8f10516952cbf3b541395940c8d98bd81db62f4efc2847ac047389a4a
+  data.tar.gz: 0aceea0bb7188ceff7ee84338de98310beded94f938f9e1ae5a6aec01f369dddd1b8444f0b739b0294cdd4dd9a80234cae8cc1911261027cf1fac4ea0910e83c

data/README.md

@@ -247,12 +247,11 @@ For more about usage see the [wiki page](../../wiki/Hiera-Data-Validator)
 
 The `Rake::Puppet` class provides tasks that handle testing and building a Puppet project.
 
-##### Usage:
+##### Usage
 
 An example `Rakefile` might look like this:
 
 ```ruby
-require 'rake'
 require 'rspec_puppet_utils/rake/project_tasks'
 
 puppet = Rake::Puppet.new
@@ -260,15 +259,15 @@ puppet.package_version = '1.0.0'
 puppet.load_tasks
 ```
 
-Running `rake -T` afterwords should show a list of spec and build tasks:
+Running `rake -T` should now show a list of spec and build tasks:
 
 ```bash
 $ rake -T
 rake build            # Build puppet.zip v1.0.0
 rake quick_build      # Build puppet.zip v1.0.0 without tests
 rake spec             # Run specs in all modules
-rake spec:<mod a>     # Run <mod a> module specs
-rake spec:<mod b>     # Run <mod b> module specs
+rake <mod a>:spec     # Run <mod a> module specs
+rake <mod b>:spec     # Run <mod b> module specs
 ...
 ```
 
@@ -281,10 +280,40 @@ In the example above `package_version` is set as it's a required field. The othe
 - module_path        - The directory containing all the modules to test (default: 'modules')
 - excluded_modules   - Modules to exclude from rspec testing (default: [])
 - package_dir        - Where the puppet zip package will be created (default: 'pkg')
-- package_files      - Files and directories to include in the package (default: ['modules', 'modules-lib', 'config/environment.conf'])
+- package_files      - Files and directories to include in the package (default: ['modules', 'modules-lib', 'environment.conf'])
 - package_versioning - Is the version included in the package name? (default: true)
 
-##### NB:
+##### Setup
+
+The `spec` task for each module actually just executes the `spec` task defined in the module's Rakefile, 
+and the `Rake::Puppet` class will filter out modules that dont have a Rakefile, 
+
+Therefore each module needs the following two files:
+
+```ruby
+# <mod>/Rakefile
+require 'puppetlabs_spec_helper/rake_tasks'
+```
+
+```ruby
+# <mod>/spec/spec_helper.rb
+require 'rspec-puppet-utils'
+require 'puppetlabs_spec_helper/module_spec_helper'
+```
+
+Extra content/tasks/options/etc can be added to these files, but this is the suggested minimum
+
+In order for the `modules-lib` modules to be available to the Puppet server, each environment will need an `environment.conf` file to set the module path, 
+therefore an `environment.conf` file should be present in the project root:
+
+```
+# environment.conf
+modulepath = ./modules:./modules-lib:$basemodulepath
+```
+
+Again, other settings can be changed, this is just the minimum to get the modules-lib pattern working
+
+##### NB
 
 The `package_files` list is setup for the modules-lib pattern by default. In this pattern external (e.g. Puppet Forge) modules are installed in a separate 'modules-lib', leaving the 'modules' dir for project modules such as 'components', 'profiles', 'role', etc. 
 If you're not using this pattern then just provide a new array for `package_files`.
@@ -293,12 +322,8 @@ Running the `build` or `quick_build` tasks will delete any existing builds in th
 This is so the same build task can be run over and over on a build server (e.g. Jenkins) without filling up the disk.
 It also guarantees that the binary at the end of a build was just built, and wasn't left over from a previous build.
 
-##### ToDo:
+##### ToDo
 
-Currently the `spec` task runs all the `spec:<module>` tasks. If one of these fails then none of the subsequent tasks will run. This isn't ideal!
+Currently the `spec` task runs all the `<module>:spec` tasks. If one of these fails then none of the subsequent tasks will run. This isn't ideal!
 
 The zip commands need to be replaced by ruby zip library to avoid shelling out, this helps with support for Windows environments
-
-### Module Tasks
-
-WIP

data/lib/rspec_puppet_utils/rake/project_tasks.rb

@@ -27,88 +27,100 @@ module Rake
       @excluded_dirs      = ['.', '..']
       @excluded_modules   = []
       @package_dir        = 'pkg'
-      @package_files      = ['modules', 'modules-lib', 'config/environment.conf']
+      @package_files      = ['modules', 'modules-lib', 'environment.conf']
       @package_name       = 'puppet'
       @package_version    = nil
       @package_versioning = true
     end
 
     def load_tasks
-      load_spec_tasks
+      load_module_tasks
       load_build_tasks
     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
-      module_dirs.select! {|e| File.directory?("#{@module_path}/#{e}/spec") }
+      filter_modules module_dirs
+    end
+
+    def filter_modules(module_dirs)
+      module_dirs.select! { |m| module_has_specs?(m) and module_has_rakefile?(m) }
       module_dirs
     end
 
-    def load_spec_tasks
+    def module_has_specs?(module_dir)
+      File.directory?("#{@module_path}/#{module_dir}/spec")
+    end
 
-      modules      = testable_modules
-      module_tasks = modules.collect { |m| "#{:spec}:#{m}" }
+    def module_has_rakefile?(module_dir)
+      rakefiles = ['rakefile', 'rakefile.rb']
+      entries   = Dir.entries("#{@module_path}/#{module_dir}")
+      entries.collect! { |f| f.downcase }
+      rakefiles.each { |rf| return true if entries.include? rf }
+      false
+    end
 
-      namespace :spec do
-        modules.each { |puppet_module|
-          module_root = "#{@module_path}/#{puppet_module}"
-          opts_path   = "#{module_root}/spec/spec.opts"
+    def load_module_tasks
+
+      modules    = testable_modules
+      spec_tasks = modules.collect { |m| "#{m}:#{:spec}" }
+      # lint_tasks = modules.collect { |m| "#{m}:#{:lint}" }
+
+      modules.each { |puppet_module|
+        namespace puppet_module do
 
           desc "Run #{puppet_module} module specs"
-          RSpec::Core::RakeTask.new puppet_module do |t|
-            t.ruby_opts  = "-C#{module_root}"
-            t.rspec_opts = File.exists?(opts_path) ? File.read(opts_path).chomp : ''
+          task :spec do
+            Dir.chdir "#{@module_path}/#{puppet_module}" do
+              success = system('rake spec') # This isn't perfect but ...
+              exit success ? 0 : 1
+            end
           end
-        }
-      end
+
+        end
+      }
+
+      # desc 'Run lint checks for all modules'
+      # task :lint => lint_tasks
 
       desc 'Run specs in all modules'
-      task :spec    => module_tasks
+      task :spec    => spec_tasks
       task :default => :spec
+
     end
 
     def load_build_tasks
 
       raise(ArgumentError, 'Please provide a package_version (e.g. "1.0.0")') if @package_version.nil?
 
-      # The build_dir (i.e. 'puppet') is the root dir of the files when the zip is extracted
-      build_dir         = "#{@package_dir}/puppet"
       full_package_name = @package_versioning ? "puppet-#{@package_version}.zip" : 'puppet.zip'
       package_desc      = @package_versioning ? full_package_name : "#{full_package_name} v#{@package_version}"
+      package_path      = "#{@package_dir}/#{full_package_name}"
 
       namespace :build do
 
         # Preps build directory
         task :prep do
           puts 'Preparing build'
-          FileUtils.rm_r @package_dir if File.exist?(@package_dir)
-          FileUtils.mkdir_p build_dir
-          @package_files.each {|f|
-            if File.exist? f
-              puts "Copying #{f} to #{build_dir}"
-              FileUtils.cp_r f, build_dir
-            else
-              fail "Could not find #{f} file or directory: Ensure that the package_files list is correct"
-            end
-          }
+          FileUtils.mkdir_p @package_dir
+          FileUtils.rm package_path if File.exist?(package_path)
         end
 
         task :package => [:prep] do
-          # Exclude modules' spec directories as they're not needed once deployed
-          exclude_patterns = '-x puppet/modules/\*/spec/\* puppet/modules-lib/\*/spec/\*'
-          cmds = ["cd #{@package_dir}", '&&', "zip -qr #{full_package_name} . #{exclude_patterns}", '&&', 'cd -']
-          puts `#{cmds.join(' ')}`
+          # Exclude all the spec code as it's not needed once deployed
+          exclude_patterns = ['modules/\*/spec/\*', 'modules-lib/\*/spec/\*']
+          exclude_string   = "-x #{exclude_patterns.join(' ')}"
+          include_string   = @package_files.join(' ')
+          cmd     = "zip -qr #{package_path} #{include_string} #{exclude_string}"
+          success = system(cmd)
+          exit 1 unless success
         end
 
-        task :cleanup do
-          puts "Cleaning up #{build_dir}/"
-          FileUtils.rm_r build_dir if File.exist?(build_dir)
-        end
       end
 
       desc "Build #{package_desc} without tests"
-      task :quick_build => ['build:package', 'build:cleanup'] do
+      task :quick_build => 'build:package' do
         puts "Built #{package_desc}"
       end
 

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.1.0'
+  gem.version       = '3.2.0'
   gem.description   = 'Helper classes for mock/stub functions, templates and hieradata'
   gem.summary       = ''
   gem.author        = 'Tom Poulton'
@@ -12,7 +12,7 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ['lib']
 
-  gem.add_dependency('puppet', '>= 3')
+  gem.add_dependency('puppet')
   gem.add_dependency('rspec')
   gem.add_dependency('rspec-puppet')
   gem.add_dependency('puppetlabs_spec_helper')

data/spec/classes/rake/project_tasks_spec.rb

@@ -6,6 +6,7 @@ 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']
 
   let(:puppet) { Rake::Puppet.new }
 
@@ -16,7 +17,7 @@ describe Rake::Puppet do
     expect(puppet.package_files.count).to eq initial_count + 1
   end
 
-  describe 'load_spec_tasks' do
+  describe 'load_module_tasks' do
 
     before(:each) do
       puppet.stubs(:testable_modules).returns(testable_modules) # not exactly best practice, but hey
@@ -24,18 +25,18 @@ describe Rake::Puppet do
 
     it 'includes namespace and task methods from Rake::DSL' do
       # It would throw error on load if task or namespace methods are missing
-      expect { puppet.load_spec_tasks }.to_not raise_error
+      expect { puppet.load_module_tasks }.to_not raise_error
     end
 
     it 'creates a task for each module' do
-      puppet.load_spec_tasks
+      puppet.load_module_tasks
       testable_modules.each { |mod|
-        expect(Rake::Task.task_defined?("spec:#{mod}")).to eq true
+        expect(Rake::Task.task_defined?("#{mod}:spec")).to eq true
       }
     end
 
     it 'loads the main spec task' do
-      puppet.load_spec_tasks
+      puppet.load_module_tasks
       expect(Rake::Task.task_defined?(:spec)).to eq true
     end
 
@@ -94,37 +95,57 @@ describe Rake::Puppet do
 
   end
 
-  describe 'testable_modules' do
+  describe 'filter_modules' do
 
-    it 'finds modules with a spec directory' do
-      Dir.stubs(:entries).with(module_path).returns modules_dir_list.clone
+    before(:each) do
+      Dir.stubs(:entries).returns []
+    end
 
-      File.stubs(:directory?).returns(false)
+    it 'filters modules with a spec directory' 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)
 
-      result = puppet.testable_modules
+      result = puppet.filter_modules modules_dir_list
       expect(result).to match_array testable_modules
     end
 
-    it 'finds modules within module_path' do
-      alt_module_path = 'modules-alt'
+    rakefile_names.each { |filename|
+      it 'filters modules with a Rakefile' do
+        File.stubs(:directory?).returns true # bypass spec dir filter
 
-      Dir.expects(:entries).with(alt_module_path).returns testable_modules
-      testable_modules.each { |m|
-        File.expects(:directory?).with(regexp_matches( /#{alt_module_path}\/#{m}/ )).returns(true)
-      }
+        Dir.stubs(:entries).with(regexp_matches( /#{testable_modules.join '|'}/ )).returns([filename])
 
-      puppet.module_path = alt_module_path
-      puppet.testable_modules
+        result = puppet.filter_modules modules_dir_list
+        expect(result).to match_array testable_modules
+      end
+    }
+
+  end
+
+  describe 'testable_modules' do
+
+    before(:each) do
+      # Bypass the filter logic. Again, not exactly best practice, but hey
+      def puppet.filter_modules(_modules)
+        _modules
+      end
+    end
+
+    it 'ignores excluded directories' do
+      Dir.stubs(:entries).with(module_path).returns testable_modules + ['.', '..']
+
+      result = puppet.testable_modules
+      expect(result).to match_array testable_modules
     end
 
     it 'ignores excluded modules' do
-      Dir.stubs(:entries).with(module_path).returns testable_modules.clone
-      File.stubs(:directory?).returns(true)
+      Dir.stubs(:entries).with(module_path).returns testable_modules + ['exclude_me']
 
-      puppet.excluded_modules = ['core']
+      puppet.excluded_modules = ['exclude_me']
       result = puppet.testable_modules
-      expect(result).to match_array ['base']
+      expect(result).to match_array testable_modules
     end
 
     it 'throws error if excluded modules is not an array' do
@@ -132,14 +153,15 @@ describe Rake::Puppet do
       expect { puppet.testable_modules }.to raise_error(ArgumentError, /must be an array/)
     end
 
-    it 'ignores excluded directories' do
-      Dir.stubs(:entries).with(module_path).returns testable_modules + ['.', '..']
-      File.stubs(:directory?).returns(true)
+    it 'finds modules within module_path' do
+      alt_module_path = 'modules-alt'
 
-      result = puppet.testable_modules
-      expect(result).to match_array testable_modules
+      Dir.expects(:entries).with(alt_module_path).returns modules_dir_list
+
+      puppet.module_path = alt_module_path
+      puppet.testable_modules
     end
 
   end
 
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-puppet-utils
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Tom Poulton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-02 00:00:00.000000000 Z
+date: 2017-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement