pdqtest 0.3.5 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 55f9c73918d6c1128abdef3472810ef1b9ae62f7
-  data.tar.gz: a20905b57f5aedd8890fb2f5914aabff3516c526
+  metadata.gz: ac2a8fe5df5117bb7d74fb011f0f857fb07df03e
+  data.tar.gz: 11bc05363b086d465cd7598d17446d05a31c9d3a
 SHA512:
-  metadata.gz: bc77dcba12d994aadd887977155db02d0dcb83f719f07976022314529e21da59b1e6cc6503e09e5df8061b3a8b4923628d5ddb1de0e84e2c43f1779046baba6a
-  data.tar.gz: 78a5a29ada1309e9b63ba39d5455c3b46c437866c9b9eec6080ae6b965a3a99a941d6e4cab517116e4c60870731180e3dacee87e51c9e6efdda51a2f26613aff
+  metadata.gz: 640a8be2625c579bf0a461d1c6f894d18bc339ae641afe8aafbce00dd46b8f07420ede16f6fe97388c753effdeb1cecdef681ae0fda237975ab5be5279387324
+  data.tar.gz: 1f9775686e4b5aea26b2a7e21c7db4a6559b9fd10cac9a95c486e7f96e1927784b52f9a5a690a7a48ecc43090f651cf70dc24d029f66b5435b3dc363398e581d

data/README.md

@@ -76,6 +76,8 @@ spec/merge_facts
 
 Inside the module being tested will result in all JSON files contained being merged into all OS specific factsets used for testing as generated by `pdqtest generate_rspec`.  To put it simply, drop `.json` file(s) in this directory to add them to every factset.
 
+These facts will be made automatically avaialable to facter when running acceptance testing
+
 ### All tests
 If you just want to run all tests:
 
@@ -96,14 +98,14 @@ pdqtest shell
 ```
 
 * Open a shell inside the docker container that would be used to run tests
-* Your code is available at `/cut`
+* Your code is available at `/testcase`
 
 ```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`
+* 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 `/testcase`
 
 ## About acceptance tests
 * Acceptance tests run within a Docker container managed by PDQTest
@@ -240,6 +242,7 @@ You should use pdqtest if you find it increases your productivity and enriches y
 * If you need a private key to access private repositories, set this up for your regular git command/ssh and `pdqtest` will reuse the settings
 * Be sure to annotate the examples you wish to acceptance test with the magic marker comment `#@PDQTest`
 * Sometimes you might get an error: `Could not resolve the dependencies.` when executing tests.  This message is from librarian puppet and usually indicates a conflict between the `metadata.json` files somewhere in the set of modules you are attempting to use.  Running the command `librarian-puppet install --path spec/fixtures/ --destructive --verbose` should give you enough information to resolve the error
+* Be sure to run `make` or `bundle exec pdqtest all` to download dependencies when running acceptance tests.  Previous versions (re)downloaded modules as required from inside docker but this step has been replaced with a simple symlink.
 
 ## Support
 This software is not supported by Puppet, Inc.  Use at your own risk.
@@ -247,6 +250,9 @@ 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.
 
+## Upgrade notes
+* Previous versions of PDQTest mounted code at `/cut` (Code Under Test), this will still work for a few versions but the preferred mountpoint is now the more obvious `/testcase`
+
 ### 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`

data/docker_images/centos/Dockerfile

@@ -61,9 +61,14 @@ 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
+# testcase (our module)
+RUN mkdir /testcase
+VOLUME /testcase
+
+# code under test (deprecated)
 RUN mkdir /cut
 VOLUME /cut
 
+
 # alternate shudown for systemd
 STOPSIGNAL SIGRTMIN+3

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-04-04-0'
+    IMAGE_NAME='geoffwilliams/pdqtest-centos:2017-05-04-0'
 
 
     def self.wrap_cmd(cmd)
@@ -21,11 +21,13 @@ module PDQTest
         'Image'   => IMAGE_NAME,
         'Volumes' => {
           test_dir         => {pwd               => 'rw'},
+          '/cut'           => {pwd               => 'rw'}, # DEPRECATED -FOR REMOVAL
           '/sys/fs/cgroup' => {'/sys/fs/cgroup'  => 'ro'},
         },
         'HostConfig' => {
           "Binds": [
             "/sys/fs/cgroup:/sys/fs/cgroup:ro",
+            "#{pwd}:/cut:rw",                               # DEPRECATED -FOR REMOVAL
             "#{pwd}:#{test_dir}:rw",
           ],
         },

data/lib/pdqtest/instance.rb

@@ -5,7 +5,7 @@ require 'escort'
 
 module PDQTest
   module Instance
-    TEST_DIR='/cut'
+    TEST_DIR='/testcase'
     @@keep_container = false
     @@active_container = nil
 

data/lib/pdqtest/puppet.rb

@@ -1,6 +1,7 @@
 require 'pdqtest/puppet'
 require 'pdqtest/docker'
 require 'pdqtest/instance'
+require 'pdqtest/emoji'
 require 'escort'
 require 'yaml'
 
@@ -47,7 +48,20 @@ module PDQTest
     end
 
     def self.link_module
-      "mkdir -p #{MODULE_DIR} && ln -s #{PDQTest::Instance::TEST_DIR} #{MODULE_DIR}/#{module_name}"
+      "test -e #{MODULE_DIR} || mkdir -p #{MODULE_DIR} && ln -s #{PDQTest::Instance::TEST_DIR} #{MODULE_DIR}/#{module_name}"
+    end
+
+    # Link all modules - this also saves re-downloading in the acceptance test
+    # environment.  Of course it means that you must have already run `make` to
+    # download the modules on your host computer
+    def self.link_deps
+      "test -e #{MODULE_DIR} || mkdir -p #{MODULE_DIR} && ln -s #{PDQTest::Instance::TEST_DIR}/spec/fixtures/modules/* #{MODULE_DIR}"
+    end
+
+    # link /etc/facter/facts.d to /testcase/spec/merge_facts to allow additional
+    # facts supplied by user to work automatically
+    def self.link_merge_facts
+      "mkdir -p /etc/facter/ && ln -s #{PDQTest::Instance::TEST_DIR}/spec/merge_facts /etc/facter/facts.d"
     end
 
     def self.install_deps
@@ -228,40 +242,59 @@ module PDQTest
     end
 
     def self.run(container, example=nil)
+      # we must always have ./spec/fixtures/modules because we need to create a
+      # symlink back to the main module inside here...
+      # (spec/fixtures/modules/foo -> /testcase)
+      if ! Dir.exists?('spec/fixtures/modules')
+        Escort::Logger.output.puts
+          "creating empty spec/fixtures/modules, if you module fails to run due "
+          "to missing dependencies run `make` or `pdqtest all` to retrieve them"
+        FileUtils.mkdir_p('spec/fixtures/modules')
+      end
+
       status = true
-      Escort::Logger.output.puts "...fetch deps"
-      cmd = install_deps
+      Escort::Logger.output.puts "...linking dependencies"
+      cmd = link_deps
       res = PDQTest::Docker.exec(container, cmd)
       status &= PDQTest::Docker.exec_status(res)
       if status
-        Escort::Logger.output.puts "...linking"
+        Escort::Logger.output.puts "...linking testcase (this module)"
         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 #{example} failed!"
+          Escort::Logger.output.puts "...linking spec/merge_facts"
+          cmd = link_merge_facts
+          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 #{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
-            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
-            }
+            PDQTest::Docker.log_all(res)
+            Escort::Logger.error.error "Error linking ./spec/merge_facts directory, see previous error, command was: #{cmd}"
           end
         else
           PDQTest::Docker.log_all(res)
-          Escort::Logger.error.error "Error linking module, see previous error, command was: #{cmd}"
+          Escort::Logger.error.error "Error linking testcase (this) 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}"
+        Escort::Logger.error.error "Error linking module, see previous error, command was: #{cmd}"
       end
 
       PDQTest::Emoji.partial_status(status, 'Puppet')

data/lib/pdqtest/version.rb

@@ -1,3 +1,3 @@
 module PDQTest
-  VERSION = "0.3.5"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pdqtest
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.4.0
 platform: ruby
 authors:
 - Geoff Williams
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-29 00:00:00.000000000 Z
+date: 2017-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler