pdqtest 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8d8bf6717a22891ee4b7d7a57436357135f21c2c
+  data.tar.gz: a89f67be7be4450c0af8c632020a0ef42f11a84f
+SHA512:
+  metadata.gz: 3f2e86d6b37464f7690d1cbd19e5a34818dd9bbd4bd36a10bc7cf2629bd0c2d52cdea93e3dc24d8d87c710e77b7f733e0cf9c440cf45c2dc19be9d5024192cb6
+  data.tar.gz: f17400d1bc19650bae85ca29cb2bca977a528f78a6b7d8965b38256a6eb2dbfd23d565736c975790558638d3f446f350a72c9f1e1347204105bd357a271c1e29

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.tmp
+.librarian
+Puppetfile.lock
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,8 @@
+sudo: false
+language: ruby
+services:
+  - docker
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.13.6 && docker pull geoffwilliams/pdqtest-centos:2017-01-08-0
+script: "bundle exec rake spec"

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pdqtest.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,51 @@
+[![Build Status](https://travis-ci.org/GeoffWilliams/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.
+
+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!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pdqtest'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pdqtest
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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.
+
+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).
+
+## Who should use PDQTest?
+You should use pdqtest if you find it increases your productivity and enriches your life
+
+## Troubleshooting
+* If you can't find the `pdqtest` command and your using `rbenv` be sure to run `rbenv rehash` after installing the gem to create the necessary symlinks
+
+## Support
+This software is not supported by Puppet, Inc.  Use at your own risk.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/GeoffWilliams/pdqtest.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pdqtest"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/docker_images/centos/Dockerfile

@@ -0,0 +1,47 @@
+# Install all the RPM packages that puppet will install and disable
+# metadata updates so that the environment can be joined to puppet
+# and run without error in an offline environment
+FROM centos:centos7
+
+# from https://hub.docker.com/r/picoded/centos-systemd/ but switched
+# to upstream centos to keep image size down
+ENV container docker
+RUN yum -y swap -- remove fakesystemd -- install systemd systemd-libs
+RUN yum -y update; yum clean all; \
+(cd /lib/systemd/system/sysinit.target.wants/; for i in *; do [ $i == systemd-tmpfiles-setup.service ] || rm -f $i; done); \
+rm -f /lib/systemd/system/multi-user.target.wants/*;\
+rm -f /etc/systemd/system/*.wants/*;\
+rm -f /lib/systemd/system/local-fs.target.wants/*; \
+rm -f /lib/systemd/system/sockets.target.wants/*udev*; \
+rm -f /lib/systemd/system/sockets.target.wants/*initctl*; \
+rm -f /lib/systemd/system/basic.target.wants/*;\
+rm -f /lib/systemd/system/anaconda.target.wants/*;
+VOLUME [ "/sys/fs/cgroup" ]
+CMD ["/usr/sbin/init"]
+
+MAINTAINER Geoff Williams <geoff.williams@puppet.com>
+RUN yum install -y cronie \
+    initscripts \
+    git \
+    zlib-devel \
+    which \
+    gpm-libs \
+    policycoreutils \
+    policycoreutils-restorecond && yum clean all
+RUN echo "metadata_expire=never" >> /etc/yum.conf && \
+  echo "LANG=C" >> /etc/environment && \
+  echo "LC_ALL=C" >> /etc/environment && \
+  echo "export PATH=/usr/local/bats/bin:/opt/puppetlabs/puppet/bin/:${PATH}" >> /etc/environment && \
+  echo "export TERM=xterm"  >> /etc/environment 
+
+# puppet
+RUN yum -y install http://yum.puppetlabs.com/el/7/PC1/x86_64/puppet-agent-1.8.2-1.el7.x86_64.rpm && \
+  /opt/puppetlabs/puppet/bin/puppet --version && \
+  /opt/puppetlabs/puppet/bin/facter --version
+
+RUN git clone https://github.com/sstephenson/bats /usr/local/bats
+RUN /opt/puppetlabs/puppet/bin/gem install librarian-puppet
+
+# code under test
+RUN mkdir /cut
+VOLUME /cut

data/docker_images/centos/Makefile

@@ -0,0 +1 @@
+docker build --squash -t geoffwilliams/pdqtest-centos:2017-01-08-0 . 

data/exe/pdqtest

@@ -0,0 +1,76 @@
+#!/usr/bin/env ruby
+require 'pdqtest/instance'
+require 'pdqtest/rspec'
+require 'pdqtest/skeleton'
+require 'pdqtest/lint'
+require 'pdqtest/syntax'
+require 'pdqtest/core'
+require 'escort'
+
+# display help if nothing specified
+ARGV.push('-h') if ARGV.empty?
+
+Escort::App.create do |app|
+  app.version PDQTest::VERSION
+  app.summary "pdqtest"
+  app.description "test puppet code quickly"
+
+  app.options do |opts|
+    opts.opt(:keep_container,
+      'Leave container running?',
+      :long     => '--keep-container',
+      :type     => :boolean,
+      :default  => false,
+    )
+  end
+
+  app.command :all do |command|
+    command.action do |options, arguments|
+      PDQTest::Instance.set_keep_container(options[:global][:options][:keep_container])
+      PDQTest::core.run([
+        lambda {PDQTest::Syntax.puppet},
+        lambda {PDQTest::Lint.puppet},
+        lambda {PDQTest::Rspec.run},
+        lambda {PDQTest::Instance.run},
+      ])
+    end
+  end
+
+  app.command :rspec do |command|
+    command.action do |options, arguments|
+      PDQTest::core.run(lambda {PDQTest::Rspec.run})
+    end
+  end
+
+
+  app.command :acceptance do |command|
+    command.action do |options, arguments|
+      PDQTest::Instance.set_keep_container(options[:global][:options][:keep_container])
+      PDQTest::core.run(lambda {PDQTest::Instance.run})
+    end
+  end
+
+  app.command :init do |command|
+    command.action do |options, arguments|
+      PDQTest::Skeleton.init
+    end
+  end
+
+  app.command :shell do |command|
+    command.action do |options, arguments|
+      PDQTest::Instance.shell
+    end
+  end
+
+  app.command :syntax do |command|
+    command.action do |options, arguments|
+      PDQTest::core.run(lambda {PDQTest::Syntax.puppet})
+    end
+  end
+
+  app.command :lint do |command|
+    command.action do |options, arguments|
+      PDQTest::core.run(lambda {PDQTest::Lint.puppet})
+    end
+  end
+end

data/lib/pdqtest/core.rb

@@ -0,0 +1,17 @@
+module PDQTest
+  module Core
+
+    def self.run(functions)
+      # wrap in array if needed
+      functions = Array(functions)
+      functions.each { |f|
+        if ! f.call
+          abort("ABORTED - there are test failures! :(")
+        end
+      }
+
+      true
+    end
+
+  end
+end

data/lib/pdqtest/docker.rb

@@ -0,0 +1,45 @@
+module PDQTest
+  module Docker
+    STDOUT = 0
+    STDERR = 1
+    STATUS = 2
+    ENV='export TERM=xterm LC_ALL=C PATH=/usr/local/bats/bin:/opt/puppetlabs/puppet/bin:$PATH;'
+    IMAGE_NAME='geoffwilliams/pdqtest-centos:2017-01-08-0'
+
+
+    def self.wrap_cmd(cmd)
+      ['bash',  '-c', "#{ENV} #{cmd}"]
+    end
+
+    def self.exec(container, cmd)
+      container.exec(wrap_cmd(cmd), tty: true)
+    end
+
+    def self.new_container(test_dir)
+      pwd = Dir.pwd
+      container = ::Docker::Container.create(
+        'Image' => IMAGE_NAME,
+        'Volumes' => {test_dir => {pwd => 'ro'}},
+      )
+      container.start({'Binds' => [ pwd +':'+ test_dir]})
+
+      container
+    end
+
+    def self.cleanup_container(container)
+      container.stop
+      container.delete(:force => true)
+    end
+
+    def self.exec_status(res, puppet=false)
+      if puppet
+        # 0 == ok, no changes
+        # 2 == ok, changes made
+        allowable_values = [0,2]
+      else
+        allowable_values = [0]
+      end
+      status = allowable_values.include?(res[STATUS])
+    end
+  end
+end

data/lib/pdqtest/instance.rb

@@ -0,0 +1,67 @@
+require 'docker-api'
+require 'pdqtest/puppet'
+require 'pdqtest/docker'
+require 'escort'
+
+module PDQTest
+  module Instance
+    TEST_DIR='/cut'
+    @@keep_container = false
+    @@active_container = nil
+
+    def self.get_active_container
+      @@active_container
+    end
+
+    def self.get_keep_container
+      @@keep_container
+    end
+
+    def self.set_keep_container(keep_container)
+      @@keep_container = keep_container
+    end
+
+    def self.run
+      # needed to prevent timeouts from container.exec()
+      Excon.defaults[:write_timeout] = 1000
+      Excon.defaults[:read_timeout] = 1000
+
+      @@active_container = PDQTest::Docker::new_container(TEST_DIR)
+      Escort::Logger.output.puts "alive, running tests"
+      status = PDQTest::Puppet.run(@@active_container)
+
+      if @@keep_container
+        Escort::Logger.output.puts "finished build, container #{@@active_container.id} left on system"
+        Escort::Logger.output.puts "  docker exec -ti #{@@active_container.id} bash "
+      else
+          PDQTest::Docker.cleanup_container(@@active_container)
+          @@active_container = nil
+      end
+
+      status
+    end
+
+    def self.shell
+      @@active_container = PDQTest::Docker::new_container(TEST_DIR)
+
+      # In theory I should be able to get something like the code below to
+      # redirect all input streams and give a makeshift interactive shell, howeve
+      # I'm damned if I get get this to do anything at all, so instead go the
+      # easy way and start the container running, then use system() to redirect
+      # all streams using the regular docker command.  Works a treat!
+      # @@active_container.tap(&:start).attach(:tty => true)
+      # @@active_container.exec('bash', tty: true).tap(&:start).attach( :tty => true, :stdin => $stdin) { |out, err|
+      #   puts out
+      #   puts err
+      # }
+      system("docker exec -ti #{@@active_container.id} bash")
+      if @@keep_container
+        Escort::Logger.output.puts "finished build, container #{@@active_container.id} left on system"
+        Escort::Logger.output.puts "  docker exec -ti #{@@active_container.id} bash "
+      else
+          PDQTest::Docker.cleanup_container(@@active_container)
+          @@active_container = nil
+      end
+    end
+  end
+end

data/lib/pdqtest/lint.rb

@@ -0,0 +1,27 @@
+module PDQTest
+  module Lint
+    LINT_PATHS = [
+      "manifests"
+    ]
+
+    LINT_OPTIONS = [
+      "--fail-on-warnings",
+      "--no-double_quoted_strings-check",
+      "--no-80chars-check",
+      "--no-variable_scope-check",
+    ]
+    def self.puppet
+      status = true
+      LINT_PATHS.each { |p|
+        if Dir.exists?(p)
+          if ! system("puppet-lint #{LINT_OPTIONS.join ' '} manifests")
+            status = false
+          end
+        end
+      }
+
+      status
+    end
+
+  end
+end

data/lib/pdqtest/puppet.rb

@@ -0,0 +1,138 @@
+require 'pdqtest/puppet'
+require 'pdqtest/docker'
+require 'pdqtest/instance'
+require 'escort'
+
+module PDQTest
+  class Puppet
+    METADATA      = 'metadata.json'
+    MODULE_DIR    = '/etc/puppetlabs/code/modules'
+    MAGIC_MARKER  = /#\s*@PDQTest/
+    BATS_TESTS    = './spec/acceptance'
+    SETUP_SUFFIX  = '__setup.sh'
+    BEFORE_SUFFIX = '__before.bats'
+    AFTER_SUFFIX  = '.bats'
+    EXAMPLES_DIR  = './examples'
+    @@bats_executed = []
+    @@setup_executed = []
+
+    def self.reset_bats_executed
+      @@bats_executed = []
+    end
+
+    def self.reset_setup_executed
+      @@setup_executed = []
+    end
+
+    def self.get_bats_executed
+      @@bats_executed
+    end
+
+    def self.get_setup_executed
+      @@setup_executed
+    end
+
+    def self.module_metadata
+      file = File.read(Dir.pwd + File::SEPARATOR + METADATA)
+      JSON.parse(file)
+    end
+
+    def self.module_name
+      module_metadata['name'].split('-')[1]
+    end
+
+    def self.link_module
+      "mkdir -p #{MODULE_DIR} && ln -s #{PDQTest::Instance::TEST_DIR} #{MODULE_DIR}/#{module_name}"
+    end
+
+    def self.install_deps
+      # Install dependencies for module
+      "cd #{PDQTest::Instance::TEST_DIR} && librarian-puppet install --path #{MODULE_DIR} --destructive"
+    end
+
+    def self.find_examples()
+      examples = []
+      if Dir.exists?(EXAMPLES_DIR)
+        Find.find(EXAMPLES_DIR) do |e|
+          if ! File.directory?(e) and ! File.readlines(e).grep(MAGIC_MARKER).empty?
+            examples << e
+          end
+        end
+      end
+      Escort::Logger.output.puts "examples to run" + examples.to_s
+      examples
+    end
+
+    def self.test_basename(t)
+      # remove examples/ and .pp
+      # eg ./examples/apache/mod/mod_php.pp --> apache/mod/mod_php
+      t.gsub(EXAMPLES_DIR + '/','').gsub('.pp','')
+    end
+
+    def self.bats_test(container, example, suffix)
+      testcase = BATS_TESTS + '/' + test_basename(example) + suffix
+      if File.exists?(testcase)
+        Escort::Logger.output.puts "*** bats test **** bats #{PDQTest::Instance::TEST_DIR}/#{testcase}"
+        res = PDQTest::Docker.exec(container, "bats #{PDQTest::Instance::TEST_DIR}/#{testcase}")
+        status = PDQTest::Docker.exec_status(res)
+        Escort::Logger.output.puts res
+        @@bats_executed << testcase
+      else
+        Escort::Logger.error.error "no #{suffix} tests for #{example} (should be at #{testcase})"
+        status = true
+      end
+
+      status
+    end
+
+    def self.setup_test(container, example)
+      setup = BATS_TESTS + '/' + test_basename(example) + SETUP_SUFFIX
+      if File.exists?(setup)
+        Escort::Logger.output.puts "Setting up test for #{example}"
+        script = File.read(setup)
+        res = PDQTest::Docker.exec(container, script)
+        status = PDQTest::Docker.exec_status(res)
+        @@setup_executed << setup
+      else
+        Escort::Logger.output.puts "no setup file for #{example} (should be in #{setup})"
+        status = true
+      end
+
+      status
+    end
+
+    def self.run(container)
+      status = true
+      Escort::Logger.output.puts "fetch deps"
+      res = PDQTest::Docker.exec(container, install_deps)
+      status &= PDQTest::Docker.exec_status(res)
+
+      Escort::Logger.output.puts "linking"
+      res = PDQTest::Docker.exec(container, link_module)
+      status &= PDQTest::Docker.exec_status(res)
+      Escort::Logger.output.puts "run tests"
+      find_examples.each { |e|
+        Escort::Logger.output.puts "testing #{e} #{status}"
+
+        status &= setup_test(container, e)
+
+        # see if we should run a bats test before running puppet
+        status &= bats_test(container, e, BEFORE_SUFFIX)
+
+        # run puppet apply
+        res = PDQTest::Docker.exec(container, puppet_apply(e))
+        status &= PDQTest::Docker.exec_status(res, true)
+        Escort::Logger.output.puts res
+
+        # see if we should run a bats test after running puppet
+        status &= bats_test(container, e, AFTER_SUFFIX)
+      }
+
+      status
+    end
+
+    def self.puppet_apply(example)
+      "cd #{PDQTest::Instance::TEST_DIR} && puppet apply #{example}"
+    end
+  end
+end

data/lib/pdqtest/rspec.rb

@@ -0,0 +1,11 @@
+module PDQTest
+  module Rspec
+    def self.run
+      status = system("bundle exec librarian-puppet install --path ./spec/fixtures/modules --destructive")
+      status &= system("bundle exec rake spec")
+
+      status
+    end
+
+  end
+end

data/lib/pdqtest/skeleton.rb

@@ -0,0 +1,98 @@
+require 'fileutils'
+require 'digest'
+require 'pdqtest/puppet'
+require 'pdqtest/version'
+
+module PDQTest
+  module Skeleton
+    FIXTURES        = '.fixtures.yml'
+    BACKUP_EXT      = '.pdqtest_old'
+    SPEC_DIR        = 'spec'
+    ACCEPTANCE_DIR  = File.join(SPEC_DIR, 'acceptance')
+    CLASSES_DIR     = File.join(SPEC_DIR, 'classes')
+    SKELETON_DIR    = File.join('res', 'skeleton')
+    EXAMPLES_DIR    = 'examples'
+    GEMFILE         = 'Gemfile'
+    GEMFILE_LINE    = "gem 'pdqtest', '#{PDQTest::VERSION}'"
+
+
+    def self.should_replace_file(target, skeleton)
+      target_hash   = Digest::SHA256.file target
+      skeleton_hash = File.join(SKELETON_DIR, skeleton)
+
+      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))
+      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)
+        install = true
+      else
+        install = true
+      end
+      if install
+        FileUtils.cp(skeleton_file, target_file)
+      end
+    end
+
+    def self.install_example
+      example_file = File.join(EXAMPLES_DIR, 'init.pp')
+      if ! File.exists?(example_file)
+        init_pp = <<-END
+          #{PDQTest::Puppet::MAGIC_MARKER}
+          include #{PDQTest::Puppet.module_name}
+        END
+        File.write(example_file, init_pp)
+      end
+    end
+
+    def self.install_gemfile
+      insert_gem = false
+      if File.exists?(GEMFILE)
+        if ! File.readlines(GEMFILE).grep(/pdqtest/).any?
+          insert_gem = true
+        end
+      else
+        install_skeleton(GEMFILE, GEMFILE)
+        insert_gem = true
+      end
+      if insert_gem
+        open(GEMFILE, 'a') { |f|
+          f.puts GEMFILE_LINE
+        }
+      end
+    end
+
+    def self.init
+
+      # move .fixtures.yml out of the way
+      if File.exists?(FIXTURES)
+        FileUtils.mv(FIXTURES, FIXTURES + BACKUP_EXT)
+      end
+
+      # make directory structure for testcases
+      FileUtils.mkdir_p(ACCEPTANCE_DIR)
+      FileUtils.mkdir_p(CLASSES_DIR)
+      FileUtils.mkdir_p(EXAMPLES_DIR)
+
+
+      # skeleton files if required
+      install_skeleton('Rakefile', 'Rakefile')
+      install_skeleton(File.join('spec', 'spec_helper.rb'), 'spec_helper.rb')
+      install_skeleton(File.join('spec', 'acceptance', 'init.bats'), 'init.bats', false)
+      install_skeleton(File.join('spec', 'acceptance', 'init__before.bats'), 'init__before.bats', false)
+      install_skeleton(File.join('spec', 'acceptance', 'init__setup.sh'), 'init__setup.sh', false)
+
+      install_example()
+      install_gemfile()
+
+      # Make sure there is a Gemfile and we are in it
+    end
+  end
+end

data/lib/pdqtest/syntax.rb

@@ -0,0 +1,8 @@
+require 'puppet-syntax/tasks/puppet-syntax'
+module PDQTest
+  module Syntax
+    def self.puppet
+      system("rake syntax")
+    end
+  end
+end

data/lib/pdqtest/version.rb

@@ -0,0 +1,3 @@
+module PDQTest
+  VERSION = "0.1.0"
+end

data/lib/pdqtest.rb

@@ -0,0 +1,5 @@
+require "pdqtest/version"
+
+module PDQTest
+  # Your code goes here...
+end

data/pdqtest.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pdqtest/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pdqtest"
+  spec.version       = PDQTest::VERSION
+  spec.authors       = ["Geoff Williams"]
+  spec.email         = ["geoff.williams@puppetlabs.com"]
+
+  spec.summary       = %q{Quick and simple integration tests run inside of a docker container}
+  spec.description   = %q{write one...}
+  spec.homepage      = "https://github.com/GeoffWilliams/pdqtest"
+  spec.licenses      = 'Apache-2.0'
+
+  # file MUST be in git to be fucking readable!!!!!
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "1.14.1"
+  spec.add_development_dependency "rake", "12.0.0"
+  spec.add_development_dependency "rspec", "3.5.0"
+  spec.add_development_dependency "simplecov", "0.12.0"
+  spec.add_development_dependency "fakefs", "0.10.2"
+  spec.add_development_dependency "puppet", "4.8.2"
+
+  spec.add_runtime_dependency "escort", "0.4.0"
+  spec.add_runtime_dependency "docker-api", "1.33.1"
+  spec.add_runtime_dependency "puppet-lint", "2.1.0"
+  spec.add_runtime_dependency "puppet-syntax", "2.2.0"
+  spec.add_runtime_dependency "puppetlabs_spec_helper", "1.2.2"
+end

data/res/skeleton/Gemfile

@@ -0,0 +1,18 @@
+source ENV['GEM_SOURCE'] || 'https://rubygems.org'
+
+puppetversion = ENV.key?('PUPPET_VERSION') ? ENV['PUPPET_VERSION'] : ['>= 3.3']
+gem 'metadata-json-lint'
+gem 'puppet', puppetversion
+gem 'puppetlabs_spec_helper', '>= 1.0.0'
+gem 'puppet-lint', '>= 1.0.0'
+gem 'facter', '>= 1.7.0'
+gem 'rspec-puppet'
+
+# rspec must be v2 for ruby 1.8.7
+if RUBY_VERSION >= '1.8.7' && RUBY_VERSION < '1.9'
+  gem 'rspec', '~> 2.0'
+  gem 'rake', '~> 10.0'
+else
+  # rubocop requires ruby >= 1.9
+  gem 'rubocop'
+end

data/res/skeleton/Rakefile

@@ -0,0 +1,3 @@
+require 'puppetlabs_spec_helper/rake_tasks'
+require 'puppet-lint/tasks/puppet-lint'
+require 'puppet-syntax/tasks/puppet-syntax'

data/res/skeleton/init.bats

@@ -0,0 +1,9 @@
+# BATS test file to run after executing 'examples/init.pp' with puppet.
+#
+# For more info on BATS see https://github.com/sstephenson/bats
+
+# Tests are really easy! just the exit status of running a command...
+@test "addition using bc" {
+  result="$(ls /)"
+  [ "$?" -eq 0 ]
+}

data/res/skeleton/init__before.bats

@@ -0,0 +1,9 @@
+# BATS test file to run before executing 'examples/init.pp' with puppet.
+#
+# For more info on BATS see https://github.com/sstephenson/bats
+
+# Tests are really easy! just the exit status of running a command...
+@test "addition using bc" {
+  result="$(ls /)"
+  [ "$?" -eq 0 ]
+}

data/res/skeleton/init__setup.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+# If this file exists it will be run on the system under test before puppet runs
+# to setup any prequisite test conditions, etc

data/res/skeleton/spec_helper.rb

@@ -0,0 +1 @@
+require 'puppetlabs_spec_helper/module_spec_helper'

metadata

@@ -0,0 +1,228 @@
+--- !ruby/object:Gem::Specification
+name: pdqtest
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Geoff Williams
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.14.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 12.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 12.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.2
+- !ruby/object:Gem::Dependency
+  name: puppet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.8.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.8.2
+- !ruby/object:Gem::Dependency
+  name: escort
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: docker-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.33.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.33.1
+- !ruby/object:Gem::Dependency
+  name: puppet-lint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: puppet-syntax
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: puppetlabs_spec_helper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+description: write one...
+email:
+- geoff.williams@puppetlabs.com
+executables:
+- pdqtest
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- docker_images/centos/Dockerfile
+- docker_images/centos/Makefile
+- exe/pdqtest
+- lib/pdqtest.rb
+- lib/pdqtest/core.rb
+- lib/pdqtest/docker.rb
+- lib/pdqtest/instance.rb
+- lib/pdqtest/lint.rb
+- lib/pdqtest/puppet.rb
+- lib/pdqtest/rspec.rb
+- lib/pdqtest/skeleton.rb
+- lib/pdqtest/syntax.rb
+- lib/pdqtest/version.rb
+- pdqtest.gemspec
+- res/skeleton/Gemfile
+- res/skeleton/Rakefile
+- res/skeleton/init.bats
+- res/skeleton/init__before.bats
+- res/skeleton/init__setup.sh
+- res/skeleton/spec_helper.rb
+homepage: https://github.com/GeoffWilliams/pdqtest
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.2
+signing_key: 
+specification_version: 4
+summary: Quick and simple integration tests run inside of a docker container
+test_files: []