pdqtest 0.1.12 → 0.1.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f84fa7c300bff2430cfe06aa6f619b833591aec1
-  data.tar.gz: 7c7a78d048256e9052bb2b64130f349567937cf5
+  metadata.gz: 5266f16024798c5f5557f7f9ca6efcb9ca6e4b7e
+  data.tar.gz: 42a2a7498e5102b0ee2eef1e52562f956e4924bc
 SHA512:
-  metadata.gz: 683a4431c5f40c7669bd42fcbd2f14dc60ef0d6d1a5cdda23dfbe9dc1a48d5f38bb693029eb620a3196f8ea69208a158a13b4670a3ad8e927cbc8611cd4e322f
-  data.tar.gz: 9528006988dc8f0cc9a96b1757bbca614305ed6d705adbf7e12ac43c57eaab75798b086493ed3349bdfe7c43f6397f8a370b7556a8b3613d19bf11cf2e2ed05f
+  metadata.gz: fa0cde45a6031b7d9971faaba5d2109bbffd825957274842e964d0b9b819554ff642bcba01eb6cc86b7f92b397ccff4df0dd2365a075ec8141056cc18ccf1850
+  data.tar.gz: 0cf5640d97c1e32b6c03656d36984049c740fd72c7218ddbd7ae57fb36c821824c30807e9c7ccb342fe37f74e2278c11ca5afc08959938034a964abfeedf6301

data/README.md

@@ -1,41 +1,80 @@
-[![Build Status](https://travis-ci.org/GeoffWilliams/pdqtest.svg?branch=master)](https://travis-ci.org/GeoffWilliams/pdqtest)
+[![Build Status](https://travis-ci.org/declarativesystems/pdqtest.svg?branch=master)](https://travis-ci.org/GeoffWilliams/pdqtest)
 
 # PDQTest
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/pdqtest`. To experiment with that code, run `bin/console` for an interactive prompt.
+PDQTest - Puppet Docker Quick-test - is the quickest and easiest way to test your puppet modules. PDQTest features tests for:
+* Linting
+* Syntax
+* RSpec
+* Acceptance (BATS)
 
-TODO: Delete this and the text above, and describe your gem
-
-## Statistics
-Without running puppet, spinning up containers and running bats tests took on average 1-3 seconds, vs ~15 with a hacked version of testkitchen, ~4 minutes with unhacked (when offline).
-
-Thats a sick improvement!
+PDQTest runs linting, syntax and RSpec tests within the machine it is running from and then loads a docker container to perform acceptance testing.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+To install PDQTest on your system:
 
+### System Ruby
+```shell
+gem install pdqtest
+```
+
+### Bundler, add this line to your application's Gemfile:
 ```ruby
-gem 'pdqtest'
+gem 'pdqtest
 ```
+* It's advisable to specify a version number to ensure repeatable builds
 
-And then execute:
+### Puppet modules
+To add PDQTests to a puppet module, run the command:
+```
+pdqtest init
+```
+
+This will install PDQTest into the `Gemfile` and will generate an example set of acceptance tests
 
-    $ bundle
+## Running tests
 
-Or install it yourself as:
+### Module dependencies/.fixtures.yml
+Module dependencies should be specified in your module's `metadata.json` file.  There is no requirement to maintain a `.fixtures.yml` file.
 
-    $ gem install pdqtest
 
-## Usage
+### All tests
+If you just want to run all tests:
 
-TODO: Write usage instructions here
+```shell
+bundle exec pdqtest all
+```
+
+### RSpec tests
+```shell
+bundle exec pdqtest rspec
+```
+
+### Debugging failed builds
+PDQTest makes it easy to debug failed builds:
+
+```shell
+pdqtest shell
+```
+
+* Open a shell inside the docker container that would be used to run tests
+* Your code is available at `/cut`
+
+```shell
+pdqtest --keep-container all
+```
+* Run all tests, report pass/fail status
+* Keep the container Running
+* After testing, the container used to run tests will be left running and a message will be printed showing how to enter the container used for testing.  Your code is avaiable at `/cut`
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+PRs welcome :)  Please ensure suitable tests cover any new functionality and that all tests are passing before and after your development work:
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```shell
+bundle exec rake spec
+```
 
 ## Who should use PDQTest?
 You should use pdqtest if you find it increases your productivity and enriches your life

data/exe/pdqtest

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
 require 'pdqtest/instance'
 require 'pdqtest/rspec'
+require 'pdqtest/util'
 require 'pdqtest/skeleton'
 require 'pdqtest/lint'
 require 'pdqtest/syntax'
@@ -25,6 +26,8 @@ Escort::App.create do |app|
   end
 
   app.command :all do |command|
+    command.summary "All"
+    command.description "Run all tests"
     command.action do |options, arguments|
       PDQTest::Instance.set_keep_container(options[:global][:options][:keep_container])
       PDQTest::Core.run([
@@ -37,6 +40,8 @@ Escort::App.create do |app|
   end
 
   app.command :rspec do |command|
+    command.summary "RSpec"
+    command.description "Run the RSpec tests"
     command.action do |options, arguments|
       PDQTest::Core.run(lambda {PDQTest::Rspec.run})
     end
@@ -44,6 +49,8 @@ Escort::App.create do |app|
 
 
   app.command :acceptance do |command|
+    command.summary "Acceptance"
+    command.description "Run the acceptance (Docker) tests"
     command.options do |opts|
       opts.opt(:example,
         'Run only this example (eg --example examples/init.pp)',
@@ -60,34 +67,64 @@ Escort::App.create do |app|
   end
 
   app.command :init do |command|
+    command.summary "Initialise testing"
+    command.description "Install skeleton testing configuration into this module"
     command.action do |options, arguments|
       PDQTest::Skeleton.init
     end
   end
 
+  app.command :generate_rspec do |command|
+    command.summary "Generate RSpec"
+    command.description "For each class in the module, generate basic RSpec tests"
+    command.action do |options, arguments|
+      PDQTest::Rspec.gen_specs
+    end
+  end
+
+
   app.command :shell do |command|
+    command.summary "Shell"
+    command.description "Open a shell inside a docker container identical to the test environment before anything has run"
     command.action do |options, arguments|
       PDQTest::Instance.shell
     end
   end
 
   app.command :syntax do |command|
+    command.summary "Syntax"
+    command.description "Check for syntax errors"
     command.action do |options, arguments|
       PDQTest::Core.run(lambda {PDQTest::Syntax.puppet})
     end
   end
 
   app.command :lint do |command|
+    command.summary "Lint"
+    command.description "Check for lint errors"
+
     command.action do |options, arguments|
       PDQTest::Core.run(lambda {PDQTest::Lint.puppet})
     end
   end
 
   app.command :setup do |command|
+    command.summary "Setup"
+    command.description "Install the docker container required for testing"
+
     command.action do |options, arguments|
       PDQTest::Core.run(lambda {
         system("docker pull #{PDQTest::Docker::IMAGE_NAME}")
       })
     end
   end
+
+  app.command :info do |command|
+    command.summary "Info"
+    command.description "Print info about this module"
+    command.action do |options, arguments|
+      PDQTest::Puppet.info
+    end
+  end
+
 end

data/lib/pdqtest/puppet.rb

@@ -14,6 +14,8 @@ module PDQTest
     BEFORE_SUFFIX     = '__before.bats'
     AFTER_SUFFIX      = '.bats'
     EXAMPLES_DIR      = './examples'
+    MANIFESTS_DIR     = './manifests'
+    CLASS_RE          = /^class /
     @@bats_executed   = []
     @@setup_executed  = []
 
@@ -51,6 +53,26 @@ module PDQTest
       "cd #{PDQTest::Instance::TEST_DIR} && librarian-puppet install --path #{MODULE_DIR} --destructive"
     end
 
+    def self.class2filename(c)
+      if c == module_name
+        f = "#{MANIFESTS_DIR}/init.pp"
+      else
+        f = c.gsub(module_name, MANIFESTS_DIR).gsub('::', File::SEPARATOR) + '.pp'
+      end
+
+      f
+    end
+
+    def self.filename2class(f)
+      if f == "#{MANIFESTS_DIR}/init.pp"
+        c = module_name
+      else
+        c = f.gsub(MANIFESTS_DIR, "#{module_name}").gsub(File::SEPARATOR, '::').gsub('.pp','')
+      end
+
+      c
+    end
+
     def self.find_examples()
       examples = []
       if Dir.exists?(EXAMPLES_DIR)
@@ -64,6 +86,27 @@ module PDQTest
       examples
     end
 
+    # find the available classes in this module
+    def self.find_classes()
+      mod_name = module_name
+      classes = []
+      if Dir.exists?(MANIFESTS_DIR)
+        Find.find(MANIFESTS_DIR) do |m|
+          if m =~ /\.pp$/
+            # check the file contains a valid class
+            if ! File.readlines(m).grep(CLASS_RE).empty?
+              # Class detected, work out class name and add to list of found classes
+              classes << filename2class(m)
+            else
+              Escort::Logger.output.puts "no puppet class found in #{m}"
+            end
+          end
+        end
+      end
+
+      classes
+    end
+
     def self.test_basename(t)
       # remove examples/ and .pp
       # eg ./examples/apache/mod/mod_php.pp --> apache/mod/mod_php
@@ -175,5 +218,10 @@ module PDQTest
     def self.puppet_apply(example)
       "cd #{PDQTest::Instance::TEST_DIR} && puppet apply --detailed-exitcodes #{example}"
     end
+
+    def self.info
+      Escort::Logger.output.puts "Parsed module name: #{module_name}"
+      Escort::Logger.output.puts "Link module command: #{link_module}"
+    end
   end
 end

data/lib/pdqtest/rspec.rb

@@ -1,5 +1,11 @@
+require 'pdqtest/puppet'
+require 'pdqtest/util'
+require 'erb'
 module PDQTest
   module Rspec
+    SPEC_DIR          = './spec'
+    SPEC_CLASSES_DIR  = "#{SPEC_DIR}/classes"
+
     def self.run
       status = system("bundle exec librarian-puppet install --path ./spec/fixtures/modules --destructive")
       status &= system("bundle exec rake spec")
@@ -7,5 +13,32 @@ module PDQTest
       status
     end
 
+    def self.class2specfile(c)
+      pp = Puppet::class2filename(c)
+      pp.gsub(Puppet::MANIFESTS_DIR, SPEC_CLASSES_DIR).gsub('.pp', '_spec.rb')
+    end
+
+    def self.gen_specs
+      classes = PDQTest::Puppet::find_classes
+
+      classes.each { |classname|
+        spec_file = class2specfile(classname)
+        if File.exists?(spec_file)
+          Escort::Logger.output.puts "Skipped #{classname} - tests already exist at #{spec_file}"
+        else
+          # first ensure any nested directories exist
+          base_dir = File.dirname(spec_file)
+          if ! Dir.exists?(base_dir)
+            Dir.mkdir(base_dir)
+          end
+
+          # process the rspec template into a new file
+          template = File.read(Util::resource_path(File.join('templates', 'rspec.rb')))
+          testcase = ERB.new(template, nil, '-').result(binding)
+          File.write(spec_file, testcase)
+        end
+      }
+    end
+
   end
 end

data/lib/pdqtest/skeleton.rb

@@ -2,6 +2,7 @@ require 'fileutils'
 require 'digest'
 require 'pdqtest/puppet'
 require 'pdqtest/version'
+require 'pdqtest/util'
 
 module PDQTest
   module Skeleton
@@ -24,12 +25,8 @@ module PDQTest
       target_hash != skeleton_hash
     end
 
-    def self.resource_path(resource)
-      File.join(File.dirname(File.expand_path(__FILE__)), "../../res/#{resource}")
-    end
-
     def self.install_skeleton(target_file, skeleton, replace=true)
-      skeleton_file = resource_path(File.join('skeleton', skeleton))
+      skeleton_file = Util::resource_path(File.join('skeleton', skeleton))
       if File.exists?(target_file) and replace and should_replace_file(target_file, skeleton_file)
         # move existing file out of the way
         FileUtils.mv(target_file, target_file + BACKUP_EXT)

data/lib/pdqtest/util.rb

@@ -0,0 +1,7 @@
+module PDQTest
+  module Util
+    def self.resource_path(resource)
+      File.join(File.dirname(File.expand_path(__FILE__)), "../../res/#{resource}")
+    end
+  end
+end

data/lib/pdqtest/version.rb

@@ -1,3 +1,3 @@
 module PDQTest
-  VERSION = "0.1.12"
+  VERSION = "0.1.13"
 end

data/res/templates/rspec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+describe '<%= classname %>' do
+  context 'compiles ok' do
+    it { should compile }
+  end
+
+  context 'with default values for all parameters' do
+    it { should contain_class('<%= classname %>') }
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pdqtest
 version: !ruby/object:Gem::Version
-  version: 0.1.12
+  version: 0.1.13
 platform: ruby
 authors:
 - Geoff Williams
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-05 00:00:00.000000000 Z
+date: 2017-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -207,6 +207,7 @@ files:
 - lib/pdqtest/rspec.rb
 - lib/pdqtest/skeleton.rb
 - lib/pdqtest/syntax.rb
+- lib/pdqtest/util.rb
 - lib/pdqtest/version.rb
 - pdqtest.gemspec
 - res/skeleton/Gemfile
@@ -218,6 +219,7 @@ files:
 - res/skeleton/init__before.bats
 - res/skeleton/init__setup.sh
 - res/skeleton/spec_helper.rb
+- res/templates/rspec.rb
 homepage: https://github.com/GeoffWilliams/pdqtest
 licenses:
 - Apache-2.0
@@ -238,7 +240,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Quick and simple integration tests run inside of a docker container