rspec-puppet-utils 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b31522fac4fbed8dc6baec05a6bee345a9f47930
-  data.tar.gz: b81fd7100d872efcf62856306b49cd2c9848fbf4
+  metadata.gz: 924d4f298027f823e62dea1fb2c6b5aaee469b61
+  data.tar.gz: 7b0f41dbb693412266edc0d75f4f50db282bc9ff
 SHA512:
-  metadata.gz: 06b599705b6ee01e0aadac7494286c8e6191539ef66c9db7f3b97b1ff46d3180598b5f7119af8e7a401c44c1de7ecd59e3bfa3f0a346a663b7f5ea641461a927
-  data.tar.gz: e6279da7519fda3c31400d1099e0e590ee67a401a7dffc59148888eb629e0e66091e732791ccfa13b6b4a2028f54ac3c5c63b0267beb86ed91343086ba432368
+  metadata.gz: 3de55b7778ccaf128ff7ac8630e076dc6eb0c981dde9bb43f5de612977154a5554bb6ce94e32cd2b501062fead337c37b8d713dc1c708bc40c707e6971af47ff
+  data.tar.gz: 2367547ae235d27906bfff7b1e5647cc7ef272ad7dd6169362815813ae740cb8cf5b75cb91ea3e8e2ca751fec455081d84cfc36c68efa9fc478f15513f422f05

data/README.md

@@ -6,6 +6,14 @@ See [release notes](../../wiki/Release-Notes) about latest version
 
 ## Updates:
 
+#### v3.1.0
+
+By default the zip file now includes the version (e.g. `puppet-1.2.0.zip`). In v3.0.0 the file was just called `puppet.zip`
+
+You can omit the version from the zip name like so: `puppet.package_versioning = false`
+
+Given that v3.0.0 was only released the day before, I'll keep it as a minor version update
+
 #### v3.0.0
 
 The project is now developed against ruby 2.1.0 and so it may not be backwards compatible when running on ruby 1.8.7.
@@ -270,11 +278,11 @@ The `build` task will bundle all Puppet code (modules, hiera data file, environm
 
 In the example above `package_version` is set as it's a required field. The other accessible properties are:
 
-- 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_version  - The version of the package (e.g. 2.1.0)
+- 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_versioning - Is the version included in the package name? (default: true)
 
 ##### NB:
 
@@ -287,7 +295,7 @@ It also guarantees that the binary at the end of a build was just built, and was
 
 ##### 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 `spec:<module>` 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
 

data/lib/rspec_puppet_utils/rake/project_tasks.rb

@@ -2,7 +2,6 @@ require 'rake'
 require 'rspec/core/rake_task'
 require 'fileutils'
 
-# ToDo: Add flag to include version in package file name or not e.g. puppet-1.2.3.zip
 # ToDo: replace zip cmds with ruby zip lib to avoid shelling out
 
 module Rake
@@ -10,26 +9,28 @@ module Rake
   class Puppet
 
     attr_accessor :module_path, :excluded_modules
-    attr_accessor :package_dir, :package_files, :package_version
+    attr_accessor :package_dir, :package_files, :package_version, :package_versioning
 
-    @module_path      # The directory containing all the modules to test
-    @excluded_dirs    # Directories excluded from rspec search
-    @excluded_modules # Modules to exclude from rspec testing
-    @package_dir      # Where the puppet zip package will be created
-    @package_files    # Files and directories to include in the package
-    @package_name     # Name of the package
-    @package_version  # The version of the package (e.g. 2.1.0)
+    @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
+    @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_path      = 'modules' # Deliberately excludes modules-lib dir
-      @excluded_dirs    = ['.', '..']
-      @excluded_modules = []
-      @package_dir      = 'pkg'
-      @package_files    = ['modules', 'modules-lib', 'config/environment.conf']
-      @package_name     = 'puppet'
-      @package_version  = nil
+      @module_path        = 'modules' # Deliberately excludes modules-lib dir
+      @excluded_dirs      = ['.', '..']
+      @excluded_modules   = []
+      @package_dir        = 'pkg'
+      @package_files      = ['modules', 'modules-lib', 'config/environment.conf']
+      @package_name       = 'puppet'
+      @package_version    = nil
+      @package_versioning = true
     end
 
     def load_tasks
@@ -71,10 +72,12 @@ module Rake
 
       raise(ArgumentError, 'Please provide a package_version (e.g. "1.0.0")') if @package_version.nil?
 
-      namespace :build do
+      # 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}"
 
-        # The build_dir (i.e. 'puppet') is the root dir of the files when the zip is extracted
-        build_dir = "#{@package_dir}/puppet"
+      namespace :build do
 
         # Preps build directory
         task :prep do
@@ -94,7 +97,7 @@ module Rake
         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 #{@package_name}.zip . #{exclude_patterns}", '&&', 'cd -']
+          cmds = ["cd #{@package_dir}", '&&', "zip -qr #{full_package_name} . #{exclude_patterns}", '&&', 'cd -']
           puts `#{cmds.join(' ')}`
         end
 
@@ -104,12 +107,12 @@ module Rake
         end
       end
 
-      desc "Build #{@package_name}.zip v#{@package_version} without tests"
+      desc "Build #{package_desc} without tests"
       task :quick_build => ['build:package', 'build:cleanup'] do
-        puts "Built #{@package_name}.zip version #{@package_version}"
+        puts "Built #{package_desc}"
       end
 
-      desc "Build #{@package_name}.zip v#{@package_version}"
+      desc "Build #{package_desc}"
       task :build => [:spec, :quick_build]
     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.0.0'
+  gem.version       = '3.1.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

@@ -9,6 +9,13 @@ describe Rake::Puppet do
 
   let(:puppet) { Rake::Puppet.new }
 
+  it 'allows adding to package_files list' do
+    initial_count = puppet.package_files.count
+    puppet.package_files << 'extra_file'
+    expect(puppet.package_files).to include 'extra_file'
+    expect(puppet.package_files.count).to eq initial_count + 1
+  end
+
   describe 'load_spec_tasks' do
 
     before(:each) do
@@ -45,20 +52,42 @@ describe Rake::Puppet do
       let(:package_version) { '1.2.3' }
       before(:each) {
         puppet.package_version = package_version
-        puppet.load_build_tasks
       }
 
       it 'loads the "build" task' do
+        puppet.load_build_tasks
         expect(Rake::Task.task_defined?(:build)).to eq true
       end
 
       it 'loads the "quick_build" task' do
+        puppet.load_build_tasks
         expect(Rake::Task.task_defined?(:quick_build)).to eq true
       end
 
-      it 'includes package_version in task description' do
+      it 'includes package_version in package name' do
+        puppet.load_build_tasks
         build_task = Rake::Task[:build]
-        expect(build_task.application.last_description).to match /v#{package_version}/
+        expect(build_task.application.last_description).to match /puppet-#{package_version}.zip/
+      end
+
+      context 'when package_versioning is turned off' do
+
+        before(:each) do
+          puppet.package_versioning = false
+        end
+
+        it 'omits the version from the package name' do
+          puppet.load_build_tasks
+          build_task = Rake::Task[:build]
+          expect(build_task.application.last_description).to match /puppet.zip/
+        end
+
+        it 'includes the version in the task description' do
+          puppet.load_build_tasks
+          build_task = Rake::Task[:build]
+          expect(build_task.application.last_description).to match /v#{package_version}/
+        end
+
       end
 
     end

data/spec/require_spec.rb

@@ -1,4 +1,4 @@
-require 'mock_function'
+require 'lib/rspec_puppet_utils/mock_function'
 
 describe 'requires' do
   it 'requires mocha properly without the spec_helper' do

metadata

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