rspec-puppet-utils 2.2.2 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: de78cb06b14b34d3a9193f34585c28b139181f3b
-  data.tar.gz: 880c5cb408b1821ede607aca8856b3f7faed8c2f
+  metadata.gz: b31522fac4fbed8dc6baec05a6bee345a9f47930
+  data.tar.gz: b81fd7100d872efcf62856306b49cd2c9848fbf4
 SHA512:
-  metadata.gz: f17a5991f2febc75f534c9f32d80cc4a2627985978fda0c5b3f85e52ddda198cdb205578375b4ad98f24dd6baa228640f15c0e03fd92d5f578d54d99e5188df7
-  data.tar.gz: 9735e55bb916dbd6eac1fee36dd649790be5b5caa153534ea69e5483e889d241898448cf51635cb30437384e2aea748201c861a26e2445d2cf423318950e9f10
+  metadata.gz: 06b599705b6ee01e0aadac7494286c8e6191539ef66c9db7f3b97b1ff46d3180598b5f7119af8e7a401c44c1de7ecd59e3bfa3f0a346a663b7f5ea641461a927
+  data.tar.gz: e6279da7519fda3c31400d1099e0e590ee67a401a7dffc59148888eb629e0e66091e732791ccfa13b6b4a2028f54ac3c5c63b0267beb86ed91343086ba432368

data/DESIGN.md

@@ -0,0 +1,23 @@
+# Design Thoughts
+
+This is to explain our design thoughts for anyone that's interested, although it's mainly to remind ourselves in the future ;)
+
+## Rake Tasks
+
+### Project Tasks
+
+The spec rake tasks are structured on the basis that each module in a project (ignoring external modules for now) has its own set of rspec tests.
+
+We could fix the issues with the main `spec` task by changing it to scan all modules' spec directories for spec files and run them:
+
+```ruby
+RSpec::Core::RakeTask.new :spec do |t|
+    t.pattern = "#{module_path}/**/#{RSpec::Core::RakeTask::DEFAULT_PATTERN}"
+end
+```
+
+However that means that we need a toplevel project `spec_helper` file, and there could be other issues as well (I'm not an rspec expert).
+
+Another option would be to move all module specs into one project `spec` directory, 
+however (putting aside potential `rspec-puppet` file structure issues) having all specs for all modules in one directory could make tests hard to isolate, 
+and it will make it hard to separate a module into it's own repo in the future.

data/Gemfile

@@ -1,3 +1,7 @@
 source 'https://rubygems.org/'
 
 gemspec
+
+group :test do
+  gem 'rake'
+end

data/README.md

@@ -4,17 +4,23 @@ This is a more refined version of a previous project about [rspec-puppet unit te
 
 See [release notes](../../wiki/Release-Notes) about latest version
 
-## Usage
+## Updates:
 
-### MockFunction
+#### 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.
+
+The internal file structure has also changed, which shouldn't affect usage, but it might :) 
 
-#####Update:
+#### v2.1.0
 
-As of version 2.1.0 the `#stub` and `#expect` methods have been superseded by `#stubbed` and `#expected` so that you can use parameter matchers. The only difference in usage from previous versions is that the methods take a set of parameters rather than a single array (e.g. `f.expected.with(1, 2, 3)` instead of `f.expect.with([1, 2, 3])`)
+The `MockFunction` `#stub` and `#expect` methods have been superseded by `#stubbed` and `#expected` so that you can use parameter matchers. The only difference in usage from previous versions is that the methods take a set of parameters rather than a single array (e.g. `f.expected.with(1, 2, 3)` instead of `f.expect.with([1, 2, 3])`)
 
 The change is backwards compatible so `#stub` and `#expect` are still available and function as before
 
-#####Usage:
+## Usage
+
+### MockFunction
 
 The basic usage is to create your mock function with `MockFunction.new` and then use `mocha` to stub any particular calls that you need
 
@@ -54,14 +60,14 @@ If you use let, **use `let!()` and not `let()`**, this is because lets are lazy-
 
 Also if you use `let` when mocking hiera, **you can't use `:hiera` as the name due to conflicts** so you have to do something like `let!(:mock_hiera) { MockFunction.new('hiera') }`
 
-#####Mocha stubs and expects:
+##### Mocha stubs and expects:
 `f.stubbed` and `f.expected` are helper methods for `f.stubs(:execute)` and `f.expects(:execute)`
 
 Internally `#expected` will clear the rspec-puppet catalog cache. This is because rspec-puppet will only re-compile the catalog for a test if `:title`, `:params`, or `:facts` are changed. This means that if you setup an expectaion in a test, it might not be satisfied because the catalog was already compiled for a previous test, and so the functions weren't called!
 
 Clearing the cache ensures tests aren't coupled and order dependent. The downside is that the catalog isn't cached and has to be re-compiled which slows down your tests. If you're concerned about performance and you are explicitly changing `:title`, `:params`, or `:facts` for a test, you can keep the cache intact with `f.expected(:keep_cache)`
 
-#####Notes:
+##### Notes:
 - You always stub the `execute` method as that gets called internally
 - The `execute` method takes a set of arguments instead of an array of arguments
 
@@ -69,7 +75,7 @@ Clearing the cache ensures tests aren't coupled and order dependent. The downsid
 
 I've created a rough version for now just to help myself out, if people find it useful or find bugs, let me know
 
-#####Usage:
+##### Usage:
 
 To stop your tests dissapearing down a rabbit hole, you can use the rspec-puppet `let(:pre_condition) { ... }` feature to create mock versions of resources that your puppet class depends on. For example:
 
@@ -221,6 +227,70 @@ Diff:
 
 For more about usage see the [wiki page](../../wiki/Hiera-Data-Validator)
 
-## Setup
+### Setup
 - Add `rspec-puppet-utils` to your Gemfile (or use `gem install rspec-puppet-utils`)
 - Add `require 'rspec-puppet-utils'` to the top of your `spec_helper`
+
+## Rake Tasks (experimental feature)
+
+`rspec-puppet-utils` also provides helper classes to add common rake tasks to a Puppet project or module.
+
+### Project Tasks
+
+The `Rake::Puppet` class provides tasks that handle testing and building a Puppet project.
+
+##### Usage:
+
+An example `Rakefile` might look like this:
+
+```ruby
+require 'rake'
+require 'rspec_puppet_utils/rake/project_tasks'
+
+puppet = Rake::Puppet.new
+puppet.package_version = '1.0.0'
+puppet.load_tasks
+```
+
+Running `rake -T` afterwords should 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
+...
+```
+
+There is an spec task for each module, as well as a main `spec` task that will run all specs in a project.
+
+The `build` task will bundle all Puppet code (modules, hiera data file, environment.conf files, etc) into a .zip file which can then be deployed. 
+
+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)
+
+##### 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`.
+
+Running the `build` or `quick_build` tasks will delete any existing builds in the `pkg` directory.
+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:
+
+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
+
+### Module Tasks
+
+WIP

data/lib/rspec-puppet-utils.rb

@@ -1,7 +1,7 @@
-require 'mock_function'
-require 'mock_resource'
-require 'template_harness'
-require 'hieradata/validator'
-require 'hieradata/yaml_validator'
+require 'rspec_puppet_utils/mock_function'
+require 'rspec_puppet_utils/mock_resource'
+require 'rspec_puppet_utils/template_harness'
+require 'rspec_puppet_utils/hieradata/validator'
+require 'rspec_puppet_utils/hieradata/yaml_validator'
 
 include RSpecPuppetUtils

data/lib/{hieradata → rspec_puppet_utils/hieradata}/yaml_validator.rb

@@ -1,4 +1,4 @@
-require 'hieradata/validator'
+require 'rspec_puppet_utils/hieradata/validator'
 require 'yaml'
 
 module RSpecPuppetUtils

data/lib/rspec_puppet_utils/rake/project_tasks.rb

@@ -0,0 +1,117 @@
+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
+
+  class Puppet
+
+    attr_accessor :module_path, :excluded_modules
+    attr_accessor :package_dir, :package_files, :package_version
+
+    @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)
+
+    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
+    end
+
+    def load_tasks
+      load_spec_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") }
+      module_dirs
+    end
+
+    def load_spec_tasks
+
+      modules      = testable_modules
+      module_tasks = modules.collect { |m| "#{:spec}:#{m}" }
+
+      namespace :spec do
+        modules.each { |puppet_module|
+          module_root = "#{@module_path}/#{puppet_module}"
+          opts_path   = "#{module_root}/spec/spec.opts"
+
+          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 : ''
+          end
+        }
+      end
+
+      desc 'Run specs in all modules'
+      task :spec    => module_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?
+
+      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"
+
+        # 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
+          }
+        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 #{@package_name}.zip . #{exclude_patterns}", '&&', 'cd -']
+          puts `#{cmds.join(' ')}`
+        end
+
+        task :cleanup do
+          puts "Cleaning up #{build_dir}/"
+          FileUtils.rm_r build_dir if File.exist?(build_dir)
+        end
+      end
+
+      desc "Build #{@package_name}.zip v#{@package_version} without tests"
+      task :quick_build => ['build:package', 'build:cleanup'] do
+        puts "Built #{@package_name}.zip version #{@package_version}"
+      end
+
+      desc "Build #{@package_name}.zip v#{@package_version}"
+      task :build => [:spec, :quick_build]
+    end
+
+  end
+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       = '2.2.2'
+  gem.version       = '3.0.0'
   gem.description   = 'Helper classes for mock/stub functions, templates and hieradata'
   gem.summary       = ''
   gem.author        = 'Tom Poulton'

data/spec/classes/hieradata/validator_spec.rb

@@ -1,5 +1,5 @@
 require 'spec_helper'
-require 'lib/hieradata/validator'
+require 'lib/rspec_puppet_utils/hieradata/validator'
 
 include RSpecPuppetUtils
 

data/spec/classes/hieradata/yaml_validator_spec.rb

@@ -1,5 +1,5 @@
 require 'spec_helper'
-require 'lib/hieradata/yaml_validator'
+require 'lib/rspec_puppet_utils/hieradata/yaml_validator'
 
 include RSpecPuppetUtils
 

data/spec/classes/mock_function_spec.rb

@@ -1,5 +1,5 @@
 require 'spec_helper'
-require 'lib/mock_function'
+require 'lib/rspec_puppet_utils/mock_function'
 
 include RSpecPuppetUtils
 

data/spec/classes/mock_resource_spec.rb

@@ -1,5 +1,5 @@
 require 'spec_helper'
-require 'lib/mock_resource'
+require 'lib/rspec_puppet_utils/mock_resource'
 
 include RSpecPuppetUtils
 

data/spec/classes/rake/project_tasks_spec.rb

@@ -0,0 +1,116 @@
+require 'spec_helper'
+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' ]
+
+  let(:puppet) { Rake::Puppet.new }
+
+  describe 'load_spec_tasks' do
+
+    before(:each) do
+      puppet.stubs(:testable_modules).returns(testable_modules) # not exactly best practice, but hey
+    end
+
+    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
+    end
+
+    it 'creates a task for each module' do
+      puppet.load_spec_tasks
+      testable_modules.each { |mod|
+        expect(Rake::Task.task_defined?("spec:#{mod}")).to eq true
+      }
+    end
+
+    it 'loads the main spec task' do
+      puppet.load_spec_tasks
+      expect(Rake::Task.task_defined?(:spec)).to eq true
+    end
+
+  end
+
+  describe 'load_build_tasks' do
+
+    it 'fails if no version is provided' do
+      expect { puppet.load_build_tasks }.to raise_error(ArgumentError, /provide a package_version/)
+    end
+
+    context 'when version is set' do
+
+      let(:package_version) { '1.2.3' }
+      before(:each) {
+        puppet.package_version = package_version
+        puppet.load_build_tasks
+      }
+
+      it 'loads the "build" task' do
+        expect(Rake::Task.task_defined?(:build)).to eq true
+      end
+
+      it 'loads the "quick_build" task' do
+        expect(Rake::Task.task_defined?(:quick_build)).to eq true
+      end
+
+      it 'includes package_version in task description' do
+        build_task = Rake::Task[:build]
+        expect(build_task.application.last_description).to match /v#{package_version}/
+      end
+
+    end
+
+  end
+
+  describe 'testable_modules' do
+
+    it 'finds modules with a spec directory' do
+      Dir.stubs(:entries).with(module_path).returns modules_dir_list.clone
+
+      File.stubs(:directory?).returns(false)
+      File.stubs(:directory?).with(regexp_matches( /(#{testable_modules.join '|'})\/spec$/ )).returns(true)
+
+      result = puppet.testable_modules
+      expect(result).to match_array testable_modules
+    end
+
+    it 'finds modules within module_path' do
+      alt_module_path = 'modules-alt'
+
+      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)
+      }
+
+      puppet.module_path = alt_module_path
+      puppet.testable_modules
+    end
+
+    it 'ignores excluded modules' do
+      Dir.stubs(:entries).with(module_path).returns testable_modules.clone
+      File.stubs(:directory?).returns(true)
+
+      puppet.excluded_modules = ['core']
+      result = puppet.testable_modules
+      expect(result).to match_array ['base']
+    end
+
+    it 'throws 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 'ignores excluded directories' do
+      Dir.stubs(:entries).with(module_path).returns testable_modules + ['.', '..']
+      File.stubs(:directory?).returns(true)
+
+      result = puppet.testable_modules
+      expect(result).to match_array testable_modules
+    end
+
+  end
+
+end

data/spec/classes/template_harness_spec.rb

@@ -1,5 +1,5 @@
 require 'spec_helper'
-require 'lib/template_harness'
+require 'lib/rspec_puppet_utils/template_harness'
 
 include RSpecPuppetUtils
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-puppet-utils
 version: !ruby/object:Gem::Version
-  version: 2.2.2
+  version: 3.0.0
 platform: ruby
 authors:
 - Tom Poulton
@@ -87,21 +87,24 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- DESIGN.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- lib/hieradata/validator.rb
-- lib/hieradata/yaml_validator.rb
-- lib/mock_function.rb
-- lib/mock_resource.rb
 - lib/rspec-puppet-utils.rb
-- lib/template_harness.rb
+- lib/rspec_puppet_utils/hieradata/validator.rb
+- lib/rspec_puppet_utils/hieradata/yaml_validator.rb
+- lib/rspec_puppet_utils/mock_function.rb
+- lib/rspec_puppet_utils/mock_resource.rb
+- lib/rspec_puppet_utils/rake/project_tasks.rb
+- lib/rspec_puppet_utils/template_harness.rb
 - rspec-puppet-utils.gemspec
 - spec/classes/hieradata/validator_spec.rb
 - spec/classes/hieradata/yaml_validator_spec.rb
 - spec/classes/mock_function_spec.rb
 - spec/classes/mock_resource_spec.rb
+- spec/classes/rake/project_tasks_spec.rb
 - spec/classes/template_harness_spec.rb
 - spec/classes/utils_spec.rb
 - spec/fixtures/hieradata/empty/empty.yaml
@@ -145,6 +148,7 @@ test_files:
 - spec/classes/hieradata/yaml_validator_spec.rb
 - spec/classes/mock_function_spec.rb
 - spec/classes/mock_resource_spec.rb
+- spec/classes/rake/project_tasks_spec.rb
 - spec/classes/template_harness_spec.rb
 - spec/classes/utils_spec.rb
 - spec/fixtures/hieradata/empty/empty.yaml