rspec-puppet-utils 3.3.0 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9889ff4f04abf064cb1bb613d08cc43ab297dddc
-  data.tar.gz: 5962bbdd9291625f70a65b53d3cdb17ccb513efd
+  metadata.gz: 4e7ae5ec76add67852ea24ec8732dadd88b46a72
+  data.tar.gz: f0d1df43cb66693a55b7e8e22723d86e6b08e3b5
 SHA512:
-  metadata.gz: d51415db60d4fcac48d2b1710550e8fc1e7ee7c6251d7645eb6699ba6a2b3eabf2a125b45800692c6d621d1b64d125606d405f1ef93034f68c7719aa7c1d1aa3
-  data.tar.gz: 0184e3591aeb8c9bb8f4719ec5b731189d1a651492ab32a9f4761b5d681e7215c7ef42d4e5b9d4b24c69f11241dfc17660ce2eeb1378d06728049af582f89b7c
+  metadata.gz: 33b15833fe535717c27f94d2589b7ab67295d0c3b65d318167a0846c186e3f834267b0eb3603fd8d557439136e4df6e440970ec0f621cf1ff95e60bfeef76886
+  data.tar.gz: 605fa915c909fb127763db9258b61dc523c01dfb18c9be1f6897c0da0a4bfc82a09c22dc8d858bb40b4e80fe7fa4494cb357df42ad374c72a5c26aa7020d5723

data/lib/rspec_puppet_utils/rake/project_tasks.rb

@@ -3,46 +3,52 @@ require 'rspec/core/rake_task'
 require 'fileutils'
 
 # ToDo: replace zip cmds with ruby zip lib to avoid shelling out
+# ToDo: What if no lib dir exists?
 
 module Rake
 
   class Puppet
 
-    attr_accessor :module_dirs, :excluded_modules
-    attr_accessor :package_dir, :package_files, :package_version, :package_versioning
+    attr_accessor :excluded_modules, :package_dir, :package_files, :package_version, :package_versioning
 
-    @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
-    @package_version    # (string)   The version of the package (e.g. 2.1.0)
-    @package_versioning # (boolean)  Is the version included in the package name?
+    # @librarian_dir      (string)   Directory where librarian-puppet installs modules (default "modules")
+    # @site_dir           (string)   Directory for profiles, roles and components (default "site")
+    # @lib_dir            (string)   Directory for custom/internal modules (default "lib")
+    # @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
+    # @package_version    (string)   The version of the package (e.g. 2.1.0)
+    # @package_versioning (boolean)  Is the version included in the package name?
 
     def initialize
       extend Rake::DSL  # makes 'namespace' and 'task' methods available to instance
 
-      @module_dirs        = ['lib', 'site'] # Deliberately excludes 'modules' dir
+      @librarian_dir      = 'modules'
+      @site_dir           = 'site'
+      @lib_dir            = 'lib'
       @excluded_dirs      = ['.', '..']
       @excluded_modules   = []
       @package_dir        = 'pkg'
-      @package_files      = @module_dirs + ['modules', 'hieradata', 'environment.conf']
+      @package_files      = ['hieradata', 'environment.conf']
       @package_name       = 'puppet'
       @package_version    = nil
       @package_versioning = true
     end
 
     def load_tasks
+      validate_unique_module_names
       load_module_tasks
       load_build_tasks
     end
 
+    # private
+
     def testable_modules
-      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|
+      [@lib_dir, @site_dir].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}" }
@@ -67,6 +73,15 @@ module Rake
       false
     end
 
+    def validate_unique_module_names
+      # & == intersection : Returns elements common to the both arrays
+      duplicates =  Dir.entries(@site_dir) & Dir.entries(@librarian_dir)
+      duplicates += Dir.entries(@librarian_dir) & Dir.entries(@lib_dir)
+      duplicates += Dir.entries(@lib_dir) & Dir.entries(@site_dir)
+      duplicates -= @excluded_dirs
+      fail "Duplicate module names: #{duplicates.join ', '}" unless duplicates.empty?
+    end
+
     def load_module_tasks
 
       modules      = testable_modules
@@ -91,40 +106,66 @@ module Rake
       desc 'Run specs in all modules'
       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?
+      raise ArgumentError, 'Please provide a package_version (e.g. "1.0.0")' if @package_version.nil?
 
       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}"
+      package_path      = File.expand_path "#{@package_dir}/#{full_package_name}"
+      build_dir         = "#{@package_dir}/puppet"
 
       namespace :build do
 
         # Preps build directory
         task :prep do
           puts 'Preparing build'
-          FileUtils.mkdir_p @package_dir
+
           FileUtils.rm package_path if File.exist?(package_path)
+          FileUtils.rm_r build_dir if File.exist?(build_dir)
+          FileUtils.mkdir_p build_dir
         end
 
-        task :package => [:prep] do
+        task :copy_files => [:prep] do
+
+          # Copy librarian and site modules into build dir
+          puts 'Copying external and site modules'
+          FileUtils.cp_r @site_dir, build_dir
+          FileUtils.cp_r @librarian_dir, build_dir
+
+          # Copy lib modules into the librarian build dir
+          puts 'Copying lib modules'
+          FileUtils.cp_r "#{@lib_dir}/.", "#{build_dir}/#{@librarian_dir}"
+
+          # Copy other package files
+          @package_files.each {|f|
+            fail "Could not find package file or directory #{f}" unless File.exist? f
+            puts "Copying #{f} to #{build_dir}"
+            FileUtils.cp_r f, build_dir
+          }
+        end
+
+        task :package => [:copy_files] do
+          puts "Creating #{full_package_name}"
           # Exclude all the spec code as it's not needed once deployed
           exclude_patterns = ['\*/\*/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
+          FileUtils.cd(build_dir) {
+            out = `zip -qr '#{package_path}' . #{exclude_string}`
+            fail("Error creating package: #{out}") unless $?.exitstatus == 0
+          }
         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' do
+      task :quick_build => ['build:package', 'build:cleanup'] 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.3.0'
+  gem.version       = '3.4.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

@@ -17,6 +17,33 @@ describe Rake::Puppet do
     expect(puppet.package_files.count).to eq initial_count + 1
   end
 
+  describe 'load_tasks' do
+
+    before(:each) do
+      puppet.stubs(:validate_unique_module_names)
+      puppet.stubs(:load_module_tasks)
+      puppet.stubs(:load_build_tasks)
+    end
+
+    it 'validates module names' do
+      puppet.expects(:validate_unique_module_names).once
+      puppet.load_tasks
+    end
+
+    it 'loads module tasks' do
+      puppet.expects(:load_module_tasks).once
+      puppet.load_tasks
+    end
+
+    it 'loads build tasks' do
+      puppet.expects(:load_build_tasks).once
+      puppet.load_tasks
+    end
+
+  end
+
+  # private
+
   describe 'load_module_tasks' do
 
     before(:each) do
@@ -142,12 +169,10 @@ describe Rake::Puppet do
       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 'finds modules in all paths' do
-      puppet.module_dirs << 'extra'
-      modules = ['lib/one', 'lib/two', 'site/three', 'site/four', 'extra/five', 'extra/six']
+      modules = ['lib/one', 'lib/two', 'site/three', 'site/four']
       expect(puppet.testable_modules).to match_array modules
     end
 
@@ -163,11 +188,6 @@ describe Rake::Puppet do
       expect(puppet.testable_modules).to match_array modules
     end
 
-    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 '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/)
@@ -182,4 +202,45 @@ describe Rake::Puppet do
 
   end
 
+  describe 'validate_unique_module_names' do
+
+    let(:dir_list_a) { ['.', '..', 'foo', 'bar'] }
+    let(:dir_list_b) { ['.', '..', 'baz', 'bam'] }
+    let(:dir_list_c) { ['.', '..', 'fuzzy', 'bazzy'] }
+
+    before(:each) do
+      Dir.stubs(:entries).with('site').returns dir_list_a
+      Dir.stubs(:entries).with('modules').returns dir_list_b
+      Dir.stubs(:entries).with('lib').returns dir_list_c
+    end
+
+    it 'does not fail if all module names are unique' do
+      expect {
+        puppet.validate_unique_module_names
+      }.to_not raise_error
+    end
+
+    it 'fails if site and modules dirs have conflicting module names' do
+      Dir.stubs(:entries).with('modules').returns dir_list_a
+      expect {
+        puppet.validate_unique_module_names
+      }.to raise_error /Duplicate module names/
+    end
+
+    it 'fails if modules and lib dirs have conflicting module names' do
+      Dir.stubs(:entries).with('lib').returns dir_list_b
+      expect {
+        puppet.validate_unique_module_names
+      }.to raise_error /Duplicate module names/
+    end
+
+    it 'fails if lib and site dirs have conflicting module names' do
+      Dir.stubs(:entries).with('site').returns dir_list_c
+      expect {
+        puppet.validate_unique_module_names
+      }.to raise_error /Duplicate module names/
+    end
+
+  end
+
 end

metadata

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