pdqtest 0.1.13 → 0.1.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5266f16024798c5f5557f7f9ca6efcb9ca6e4b7e
-  data.tar.gz: 42a2a7498e5102b0ee2eef1e52562f956e4924bc
+  metadata.gz: 252a38cb94b84c965c798e0813a55fcb429e522b
+  data.tar.gz: fb594b19707e074e9050d412ef9aca00afc76aa0
 SHA512:
-  metadata.gz: fa0cde45a6031b7d9971faaba5d2109bbffd825957274842e964d0b9b819554ff642bcba01eb6cc86b7f92b397ccff4df0dd2365a075ec8141056cc18ccf1850
-  data.tar.gz: 0cf5640d97c1e32b6c03656d36984049c740fd72c7218ddbd7ae57fb36c821824c30807e9c7ccb342fe37f74e2278c11ca5afc08959938034a964abfeedf6301
+  metadata.gz: 95a764923fa9e77f8c8b32840f80e9a5377e44711cdf4ca0af98a9545f01ae2894356391ccb540d2d363fbbd8025030e7a925435c3c8f02e6c3a5cd3d4c0a164
+  data.tar.gz: 01ac447b7dd030e560f0400d32c481fa26549b0b0220f373d12eee2cf9adead4cff50f9d281b3249985b7d60b507a1aa00d3f4b416ef87e7fc59553b2b3dae55

data/.gitignore

@@ -11,3 +11,4 @@
 .librarian
 Puppetfile.lock
 *.gem
+/fixtures/passing_tests/spec/fixtures

data/README.md

@@ -36,8 +36,18 @@ This will install PDQTest into the `Gemfile` and will generate an example set of
 ## Running tests
 
 ### 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.
+Ordinarily, there is no need to maintain a `.fixtures.yml` file.  Dependencies on public forge modules should be specified in your module's `metadata.json` file.
 
+If you need to download modules from git (eg those not available on forge.puppetlabs.com), then you must populate the `fixtures` section of `.fixtures.yml`, eg:
+
+```
+repositories:
+  corporatestuff:
+    repo: 'https://nonpublicgit.megacorp.com/corporatestuff.git'
+    ref: 'mybranch'
+```
+
+Note that only the repositories section of the file will be processed as we do not use `puppetlabs_spec_helper` to do this for us.
 
 ### All tests
 If you just want to run all tests:
@@ -86,5 +96,10 @@ You should use pdqtest if you find it increases your productivity and enriches y
 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/declarativesystems/pdqtest.
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/GeoffWilliams/pdqtest.
+### Running tests
+* PDQTest includes a comprehensive tests for core library functions.  Please ensure tests pass before and after any PRs
+* Run all tests `bundle exec rake spec`
+* Run specific test file `bundle exec rspec ./spec/SPEC/FILE/TO/RUN.rb`
+* Run specific test case `bundle exec rspec ./spec/SPEC/FILE/TO/RUN.rb:99` (where 99 is the line number of the test)

data/docker_images/centos/Dockerfile

@@ -28,20 +28,39 @@ RUN yum install -y cronie \
     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 
+RUN echo "metadata_expire=never" >> /etc/yum.conf
+
+# fix locale
+RUN echo 'LANG=en_US.UTF-8' > /etc/locale.conf
+RUN yum -y reinstall glibc-common
+# swallow errors
+RUN localedef --quiet -v -c -i en_US -f UTF-8 en_US.UTF-8 || true
+
+
+ENV LANG en_US.UTF-8
+# && \
+#  echo "LANG=C" >> /etc/environment && \
+ENV LC_ALL en_US.UTF-8
+#  echo "LC_ALL=C" >> /etc/environment && \
+ENV PATH /usr/local/bats/bin:/opt/puppetlabs/puppet/bin/:/usr/sbin:/sbin:/usr/bin:/bin
+#  echo "export PATH=/usr/local/bats/bin:/opt/puppetlabs/puppet/bin/:${PATH}" >> /etc/environment && \
+ENV TERM xterm
+#  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
 
+# bats
 RUN git clone https://github.com/sstephenson/bats /usr/local/bats
+
+# librarian
 RUN /opt/puppetlabs/puppet/bin/gem install librarian-puppet
 
+# git refresh (for processing .fixtures.yml git modules)
+RUN /opt/puppetlabs/puppet/bin/gem install git_refresh
+
 # code under test
 RUN mkdir /cut
 VOLUME /cut

data/docker_images/centos/Makefile

@@ -1 +1,3 @@
-docker build --squash -t geoffwilliams/pdqtest-centos:2017-01-08-0 . 
+all:
+	# requires experimental mode - see https://github.com/docker/docker/tree/master/experimental#use-docker-experimental
+	bash -c 'docker build --squash -t geoffwilliams/pdqtest-centos:$$(date -I)-0 .'

data/exe/pdqtest

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+require 'pdqtest'
+require 'pdqtest/emoji'
 require 'pdqtest/instance'
 require 'pdqtest/rspec'
 require 'pdqtest/util'
@@ -23,12 +25,21 @@ Escort::App.create do |app|
       :type     => :boolean,
       :default  => false,
     )
+
+    opts.opt(:disable_emoji,
+      'Do not display emoji status characters',
+      :long     => '--disable-emoji',
+      :type     => :boolean,
+      :default  => false,
+    )
   end
 
   app.command :all do |command|
     command.summary "All"
     command.description "Run all tests"
     command.action do |options, arguments|
+      PDQTest::Emoji.disable(options[:global][:options][:disable_emoji])
+
       PDQTest::Instance.set_keep_container(options[:global][:options][:keep_container])
       PDQTest::Core.run([
         lambda {PDQTest::Syntax.puppet},
@@ -43,6 +54,7 @@ Escort::App.create do |app|
     command.summary "RSpec"
     command.description "Run the RSpec tests"
     command.action do |options, arguments|
+      PDQTest::Emoji.disable(options[:global][:options][:disable_emoji])
       PDQTest::Core.run(lambda {PDQTest::Rspec.run})
     end
   end
@@ -60,6 +72,7 @@ Escort::App.create do |app|
       )
     end
     command.action do |options, arguments|
+      PDQTest::Emoji.disable(options[:global][:options][:disable_emoji])
       PDQTest::Instance.set_keep_container(options[:global][:options][:keep_container])
       example = options[:global][:commands][:acceptance][:options][:example]
       PDQTest::Core.run(lambda {PDQTest::Instance.run(example)})
@@ -70,6 +83,7 @@ Escort::App.create do |app|
     command.summary "Initialise testing"
     command.description "Install skeleton testing configuration into this module"
     command.action do |options, arguments|
+      PDQTest::Emoji.disable(options[:global][:options][:disable_emoji])
       PDQTest::Skeleton.init
     end
   end
@@ -78,6 +92,7 @@ Escort::App.create do |app|
     command.summary "Generate RSpec"
     command.description "For each class in the module, generate basic RSpec tests"
     command.action do |options, arguments|
+      PDQTest::Emoji.disable(options[:global][:options][:disable_emoji])
       PDQTest::Rspec.gen_specs
     end
   end
@@ -95,6 +110,7 @@ Escort::App.create do |app|
     command.summary "Syntax"
     command.description "Check for syntax errors"
     command.action do |options, arguments|
+      PDQTest::Emoji.disable(options[:global][:options][:disable_emoji])
       PDQTest::Core.run(lambda {PDQTest::Syntax.puppet})
     end
   end
@@ -104,6 +120,7 @@ Escort::App.create do |app|
     command.description "Check for lint errors"
 
     command.action do |options, arguments|
+      PDQTest::Emoji.disable(options[:global][:options][:disable_emoji])
       PDQTest::Core.run(lambda {PDQTest::Lint.puppet})
     end
   end

data/lib/pdqtest/core.rb

@@ -1,3 +1,5 @@
+require 'pdqtest'
+require 'pdqtest/emoji'
 module PDQTest
   module Core
 
@@ -7,10 +9,15 @@ module PDQTest
       functions.each { |f|
         if ! f.call
           Escort::Logger.error.error "Error encountered running #{f.to_s}"
+
+          # epic fail, exit program
+          PDQTest::Emoji.final_status(false)
           abort("ABORTED - there are test failures! :(")
         end
       }
 
+      # we passed already
+      PDQTest::Emoji.final_status(true)
       true
     end
 

data/lib/pdqtest/docker.rb

@@ -4,7 +4,7 @@ module PDQTest
     ERR = 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'
+    IMAGE_NAME='geoffwilliams/pdqtest-centos:2017-03-30-0'
 
 
     def self.wrap_cmd(cmd)
@@ -58,6 +58,11 @@ module PDQTest
       }
     end
 
+    def self.log_all(res)
+      log_err(res)
+      log_out(res)
+    end
+
     def self.log_err(res)
       exec_err(res).each { |l|
         # Output comes back as an array and needs to be iterated or we lose our

data/lib/pdqtest/emoji.rb

@@ -0,0 +1,33 @@
+module PDQTest
+  module Emoji
+    @@disable = false
+
+    def self.disable(disable)
+      @@disable = disable
+    end
+
+    # print cool emoji based on status
+    def self.emoji_status(status, emoji_pass, emoji_fail, label)
+      lable_string = "#{label}: "
+      if ! @@disable
+        if status
+          # cool bananas
+          Escort::Logger.output.puts lable_string + emoji_pass
+        else
+          # boom! crappy code
+          Escort::Logger.error.error lable_string + emoji_fail
+        end
+      end
+    end
+
+    # partial status when lots to do
+    def self.partial_status(status, label)
+      emoji_status(status, "😬", "💣", label)
+    end
+
+    # Overall program exit status
+    def self.final_status(status)
+      emoji_status(status, "😎", "💩", 'Overall')
+    end
+  end
+end

data/lib/pdqtest/instance.rb

@@ -26,16 +26,24 @@ module PDQTest
       Excon.defaults[:write_timeout] = 10000
       Excon.defaults[:read_timeout] = 10000
 
-      @@active_container = PDQTest::Docker::new_container(TEST_DIR)
-      Escort::Logger.output.puts "alive, running tests"
-      status = PDQTest::Puppet.run(@@active_container, example)
+      # remove reference to any previous test container
+      @@active_container = nil
 
-      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 "
+      if PDQTest::Puppet::find_examples().empty?
+        Escort::Logger.output.puts "No acceptance tests found, annotate examples with #{PDQTest::Puppet::MAGIC_MARKER} to make some"
+        status = true
       else
-          PDQTest::Docker.cleanup_container(@@active_container)
-          @@active_container = nil
+        @@active_container = PDQTest::Docker::new_container(TEST_DIR)
+        Escort::Logger.output.puts "alive, running tests"
+        status = PDQTest::Puppet.run(@@active_container, example)
+
+        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
       Escort::Logger.output.puts "...finished status=#{status}"
       status

data/lib/pdqtest/lint.rb

@@ -1,3 +1,4 @@
+require 'pdqtest/emoji'
 module PDQTest
   module Lint
     LINT_PATHS = [
@@ -22,6 +23,7 @@ module PDQTest
         end
       }
 
+      PDQTest::Emoji.partial_status(status, 'Linter')
       status
     end
 

data/lib/pdqtest/puppet.rb

@@ -2,6 +2,7 @@ require 'pdqtest/puppet'
 require 'pdqtest/docker'
 require 'pdqtest/instance'
 require 'escort'
+require 'yaml'
 
 module PDQTest
   class Puppet
@@ -18,6 +19,7 @@ module PDQTest
     CLASS_RE          = /^class /
     @@bats_executed   = []
     @@setup_executed  = []
+    FIXTURES          = '.fixtures.yml'
 
     def self.reset_bats_executed
       @@bats_executed = []
@@ -50,7 +52,12 @@ module PDQTest
 
     def self.install_deps
       # Install dependencies for module
-      "cd #{PDQTest::Instance::TEST_DIR} && librarian-puppet install --path #{MODULE_DIR} --destructive"
+      steps = []
+      steps << "cd #{PDQTest::Instance::TEST_DIR}"
+      steps << "librarian-puppet install --path #{MODULE_DIR} --destructive"
+      steps + git_fixtures
+
+      steps.join(' && ')
     end
 
     def self.class2filename(c)
@@ -86,6 +93,33 @@ module PDQTest
       examples
     end
 
+    # process fixtures->repositories->* from .fixtures.yml if present to
+    # generate an array of commands to run ON THE DOCKER VM to checkout the
+    # required modules from git
+    def self.git_fixtures()
+      refresh_cmd = []
+      if File.exists?(FIXTURES)
+        fixtures = YAML.load_file(FIXTURES)
+        if fixtures.has_key?('repositories')
+          fixtures['repositories'].each { |fixture, opts|
+            if opts.instance_of?(String)
+              source = opts
+              target = "spec/fixtures/modules/#{fixture}"
+              ref    = 'master'
+            elsif opts.instance_of?(Hash)
+              target = "spec/fixtures/modules/#{fixture}"
+              source = opts['repo']
+              ref    = opts['ref']
+            end
+
+            refresh_cmd << "git_refresh #{target} #{source} #{ref}"
+          }
+        end
+      end
+
+      refresh_cmd
+    end
+
     # find the available classes in this module
     def self.find_classes()
       mod_name = module_name
@@ -192,26 +226,42 @@ module PDQTest
 
     def self.run(container, example=nil)
       status = true
-      Escort::Logger.output.puts "fetch deps"
-      res = PDQTest::Docker.exec(container, install_deps)
+      Escort::Logger.output.puts "...fetch deps"
+      cmd = install_deps
+      res = PDQTest::Docker.exec(container, cmd)
       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"
-      if example
-        status &= run_example(container, example)
-      else
-        find_examples.each { |e|
-          if status
-            status &= run_example(container, e)
+      if status
+        Escort::Logger.output.puts "...linking"
+        cmd = link_module
+        res = PDQTest::Docker.exec(container, cmd)
+        status &= PDQTest::Docker.exec_status(res)
+        if status
+          Escort::Logger.output.puts "...run tests"
+          if example
+            status &= run_example(container, example)
             if ! status
-              Escort::Logger.error.error "Example #{e} failed! - skipping rest of tests"
+              Escort::Logger.error.error "Example #{example} failed!"
             end
+          else
+            find_examples.each { |e|
+              if status
+                status &= run_example(container, e)
+                if ! status
+                  Escort::Logger.error.error "Example #{e} failed! - skipping rest of tests"
+                end
+              end
+            }
           end
-        }
+        else
+          PDQTest::Docker.log_all(res)
+          Escort::Logger.error.error "Error linking module, see previous error, command was: #{cmd}"
+        end
+      else
+        PDQTest::Docker.log_all(res)
+        Escort::Logger.error.error "Error installing dependencies, see previous error, command was: #{cmd}"
       end
+
+      PDQTest::Emoji.partial_status(status, 'Puppet')
       status
     end
 

data/lib/pdqtest/rspec.rb

@@ -1,5 +1,7 @@
+require 'pdqtest'
 require 'pdqtest/puppet'
 require 'pdqtest/util'
+require 'pdqtest/emoji'
 require 'erb'
 module PDQTest
   module Rspec
@@ -8,8 +10,18 @@ module PDQTest
 
     def self.run
       status = system("bundle exec librarian-puppet install --path ./spec/fixtures/modules --destructive")
-      status &= system("bundle exec rake spec")
+      PDQTest::Puppet.git_fixtures.each { |extra_mod_install_cmd|
+        if status
+          # fast-fail
+          status &= system("bundle exec #{extra_mod_install_cmd}")
+        end
+      }
+      if status
+        # fail fast on test execution
+        status &= system("bundle exec rake spec")
+      end
 
+      PDQTest::Emoji.partial_status(status, 'RSpec-Puppet')
       status
     end
 

data/lib/pdqtest/syntax.rb

@@ -1,8 +1,13 @@
 require 'puppet-syntax/tasks/puppet-syntax'
+require 'pdqtest'
+require 'pdqtest/emoji'
 module PDQTest
   module Syntax
     def self.puppet
-      system("rake syntax")
+      status = system("rake syntax")
+      PDQTest::Emoji.partial_status(status, 'Syntax')
+
+      status
     end
   end
 end

data/lib/pdqtest/version.rb

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

data/pdqtest.gemspec

@@ -35,4 +35,5 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "puppet-syntax", "2.2.0"
   spec.add_runtime_dependency "puppetlabs_spec_helper", "1.2.2"
   spec.add_runtime_dependency "librarian-puppet", "2.2.3"
+  spec.add_runtime_dependency "git_refresh", "0.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pdqtest
 version: !ruby/object:Gem::Version
-  version: 0.1.13
+  version: 0.1.14
 platform: ruby
 authors:
 - Geoff Williams
@@ -178,6 +178,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 2.2.3
+- !ruby/object:Gem::Dependency
+  name: git_refresh
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.0
 description: write one...
 email:
 - geoff.williams@puppetlabs.com
@@ -201,6 +215,7 @@ files:
 - lib/pdqtest.rb
 - lib/pdqtest/core.rb
 - lib/pdqtest/docker.rb
+- lib/pdqtest/emoji.rb
 - lib/pdqtest/instance.rb
 - lib/pdqtest/lint.rb
 - lib/pdqtest/puppet.rb