pdqtest 1.9.9beta6 → 1.9.9beta7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9833010ae1e09cfb08af4e3ce5471a07df1fcc7fd8f674b44399f6f5dc021fc
-  data.tar.gz: c5310840d59b593d0bae1d63a2cc61b84f47ccc8cfa6f72afedb5e9f10335e91
+  metadata.gz: dd42c9920bb14bf63ba6dc6d021cb5bc2cb336aca20b76dcb41f8c19a317e545
+  data.tar.gz: 295dec7313f15b1e59348ea7e1106b8a03523ee5efe5bacb61b7a1df0e8e48bd
 SHA512:
-  metadata.gz: d2472553063f8d3b17612b7b692a6af350bb7f83090296042778cce7e0e40e0b87a680af4abb98cda3916276643e8bc409e42dc9b46edcd8397a69de538ef07c
-  data.tar.gz: bacbb3ffde09c8df33c5d5861a3b51735d830bef228b7d42ff9d00533bbd08bf30b7590b2e0092429c785e881355296a8bd648b9296db715aa3efe359712e646
+  metadata.gz: a886738ec27f9f20017f4a42d224b7a2b1edc62e3e55f5e8e472850abe61219e57766793c130d872389e1250b2000cf7fc5f703e0ca99569250ab71efabb8516
+  data.tar.gz: 62b42b4dc521d8f2d36937ef910bceb3fe193d6ddb866bbf11fe29ffc5f0c5d090123f33344cc73a77c1f59299260152377394d96a24681c0e5f86787554b9db

data/doc/pdk.md

@@ -44,7 +44,7 @@ VMs in order to extract maximum speed. It offers a different approach to
 Of course, this will only ever give you an approximation of a real-world system
 but in many cases this is all that's needed. The complexity of setting up a
 100% accurate test environment is a daunting task and one that may never provide
-ROI on the effort spent configuring and maintaining it.
+ROI vs the effort spent configuring and maintaining it.
 
 If perfect accuracy is indeed required, then PDQTest is not what you are looking
 for and you should look towards solutions like Beaker or 
@@ -61,7 +61,10 @@ New projects should be created using PDK: `pdk new module`.
 This will give you all the PDK versioned files you would ever need. When you run
 `pdqtest init` on a new project created with PDK, we only copy in our own 
 integration files and do not not touch the PDK generated files at all (the ones
-marked 🛠 below), 
+marked 🛠 below).
+
+After running `pdqtest init`, run `pdk update` to have PDK process the
+`.sync.yml` we installed.
 
 ### Existing PDQTest projects
 To make upgrading to PDQTest 2.0 + PDK easy for our existing users, we automate
@@ -79,18 +82,37 @@ unless PDK starts writing new files that we are already using.
     * `template-url`
     * `template-ref`
   The values for these fields are obtained automatically from PDK itself and are
-  consistent with the system installed PDK.
+  consistent with the system installed PDK (we generate a temporary project and 
+  read files/values from it).
 
 **Gemfile.project**
 
-* Add a reference to the `pdqtest` gem
+If you require PDK to know about a particular gem for your project, add it to
+this file and then run:
+
+*Linux*
+```shell
+make Gemfile.local
+```
+
+*Windows*
+```shell
+.\make.ps1 Gemfile.local
+```
+
+Depending on platform, this will symlink or copy `Gemfile.project` to 
+`Gemfile.local` respectively, then run `pdk bundle install` to update PDK's 
+knowledge of the new gem.
+
 
 **Miscellaneous skeletons**
 
 When `pdqtest init` is run, we install a small set of skeleton files in the root
-of your project. This is a one-off operation to get you started. After your 
-module has been marked as PDK compatible, we no longer attempt to update these
-files and you must only manage them using PDK from then-on.
+of your project. This is a one-off operation to get you started and is _only_
+done if your project is not already marked PDK compatible. 
+
+After your module has been marked as PDK compatible, you must only manage these
+files using PDK.
 
 Skeletons are generated on the fly using PDK itself, so they are always 
 up-to-date according to the PDK you have installed on your system.
@@ -99,7 +121,7 @@ up-to-date according to the PDK you have installed on your system.
 If you have an existing Puppet project that does not use PDQTest or PDK (eg 
 created by hand or with the old `puppet module generate` command), then the 
 recommended way to enable PDQTest is to first enable PDK by running 
-`pdk convert` and following the wizard.
+`pdk convert`, then follow the wizard.
 
 You may then enable `PDQTest` by running `pdqtest init`.
 
@@ -134,7 +156,7 @@ These are the files installed, files marked 🛠 are generated by PDK:
 
 The remaining files are specific to PDQTest - notably:
 * `.travis.yml` - Complete test suite for Linux modules
-* `bitbucket-pipelines.yaml` - RSpec testing only 
+* `bitbucket-pipelines.yaml` - logical testing only (unit/RSpec) 
 * `.puppet-lint.rc` - Make lint errors test failures, ignore double quotes, etc
 * `Makefile` - Essential launch script for Linux
 * `make.ps1` - Essential launch script for Windows

data/doc/tips_and_tricks.md

@@ -20,4 +20,5 @@
   * Create/copy files, directories, etc.
   * Install OS packages
   * Install python scripts to mock database servers using SQLite... 😉
-* Files added by PDQTest >= 2.0 have the magic marker: `*File originally created by PDQTest*`
+* Files added by PDQTest >= 2.0 have the magic marker: 
+  `*File originally created by PDQTest*`

data/docker_images/windows/make.ps1

@@ -1,2 +1,2 @@
-docker build -t declarativesystems/pdqtest-windows:$([datetime]::now.tostring("yyyy-MM-dd"))-0 .
+docker build --no-cache -t declarativesystems/pdqtest-windows:$([datetime]::now.tostring("yyyy-MM-dd"))-0 .
 

data/lib/pdqtest/docker.rb

@@ -10,7 +10,7 @@ module PDQTest
     IMAGES = {
      :DEFAULT => 'declarativesystems/pdqtest-centos:2018-09-15-0',
      :UBUNTU  => 'declarativesystems/pdqtest-ubuntu:2018-09-15-0',
-     :WINDOWS => 'declarativesystems/pdqtest-windows:2018-09-18-0',
+     :WINDOWS => 'declarativesystems/pdqtest-windows:2018-09-29-0',
     }
 
     # volume paths are different for windows containers

data/lib/pdqtest/fastcheck.rb

@@ -7,13 +7,20 @@ module PDQTest
     def self.run
       $logger.debug "inside Fastcheck::run - current dir: #{Dir.pwd}"
 
-      $logger.debug "Running syntax..."
-      status = system("bundle exec 'rake syntax'")
+      # On windows, `system()` always executes `cmd.exe` so we can use `&&` to
+      # join commands... even when we launched from powershell.exe (! unproved)
+      #
+      # also must, MUST, MUST!!! use double quotes not singles to feed `system`
+      # or it will be eaten
+      cmd = "cd .pdqtest && bundle exec \"cd .. && rake syntax\""
+      $logger.debug "Running syntax...: #{cmd}"
+      status = system(cmd)
       $logger.debug "...done; result: #{status}"
 
       if status
-        $logger.debug "Running lint..."
-        status = system("bundle exec 'puppet-lint manifests'")
+        cmd = "cd .pdqtest && bundle exec \"cd .. && puppet lint --relative manifests\""
+        $logger.debug "Running lint...: #{cmd}"
+        status = system(cmd)
         $logger.debug "...done; result: #{status}"
       end
 

data/lib/pdqtest/skeleton.rb

@@ -27,6 +27,7 @@ module PDQTest
         "Gemfile",
         "Rakefile",
         ".gitignore",
+        ".gitattributes",
     ]
 
     # PDK adds custom metadata fields which we can ONLY get by creating a new
@@ -42,6 +43,15 @@ module PDQTest
             "paths" => [
                 ".Puppetfile.pdqtest",
             ],
+        },
+        ".gitattributes" => {
+            "include" => [
+                "*.epp eol=lf",
+                "*.json eol=lf",
+                "*.yaml eol=lf",
+                "*.yml eol=lf",
+                "*.md eol=lf",
+            ]
         }
     }.freeze
 
@@ -170,6 +180,13 @@ module PDQTest
               # snag generated metadata now we are in the temporary module dir
               Dir.chdir TEMP_PDK_MODULE do
                 @@pdk_metadata = PDQTest::Puppet.module_metadata
+
+                # Now we need to install .sync.yml and re-install otherwise not
+                # applied until `pdk update`
+                PDQTest::Pdk.amend_sync_yml(SYNC_YML_CONTENT)
+
+                # Next do a forced update to make PDK process sync.yml
+                PDQTest::Pdk.run("update --force")
               end
 
               PDK_FILES.each do |pdk_file|

data/lib/pdqtest/upgrade.rb

@@ -2,16 +2,15 @@ require 'pdqtest/skeleton'
 
 module PDQTest
   module Upgrade
-    GEMDIR              = '.pdqtest'
+    GEMDIR              = '.pdqtest'.freeze
     GEMFILE             = File.join(GEMDIR,'Gemfile')
     GEM_REGEXP          = /gem ('|")([-\w]+)('|").*$/
     GEM_ATTRIB_REGEXP   = /^\s*:\w+/
 
+    GEM_SOURCE = "source ENV['GEM_SOURCE'] || 'https://rubygems.org'".freeze
+    PDQTEST_MAGIC_MARKER = "*File originally created by PDQTest*".freeze
+
     GEMS = {
-      # 'gemsource' => {
-      #     'line' => "source ENV['GEM_SOURCE'] || 'https://rubygems.org'",
-      #     'added' => false,
-      # },
       'pdqtest' => {
           'line' => "gem 'pdqtest', '#{PDQTest::VERSION}'",
           'added' => false,
@@ -21,18 +20,25 @@ module PDQTest
           'added' => false,
       },
       'puppet' => {
-          'line' => "gem 'puppet'",
+          'line' => "gem 'puppet', '5.5.3'",
           'added' => false,
       },
       'puppet-lint' => {
-          'line' => "gem 'puppet-lint'",
+          'line' => "gem 'puppet-lint', '2.3.6'",
           'added' => false,
       },
       'puppet-syntax' => {
-          'line' => "gem 'puppet-syntax'",
+          'line' => "gem 'puppet-syntax', '2.4.1'",
+          'added' => false,
+      },
+      'puppetlabs_spec_helper' => {
+          'line' => "gem 'puppetlabs_spec_helper', '2.11.0'",
+          'added' => false,
+      },
+      'rake' => {
+          'line' => "gem 'rake', '12.3.1'",
           'added' => false,
       },
-
     }.freeze
 
 
@@ -48,6 +54,13 @@ module PDQTest
 
       if ! File.exists?(GEMFILE)
         FileUtils.touch(GEMFILE)
+
+        # We are creating Gemfile for the first time, so add a gemsource and
+        # a magic marker
+        File.open(GEMFILE, 'w') do |file|
+          file.puts("# #{PDQTEST_MAGIC_MARKER}")
+          file.puts(GEM_SOURCE)
+        end
       end
       File.open(GEMFILE, 'r') do |f|
         f.each_line { |line|

data/lib/pdqtest/version.rb

@@ -1,3 +1,3 @@
 module PDQTest
-  VERSION = "1.9.9beta6"
+  VERSION = "1.9.9beta7"
 end

data/res/skeleton/Makefile

@@ -27,7 +27,7 @@ pdqtestbundle:
 	cd .pdqtest && pwd && bundle install
 
 docs:
-	cd .pdqtest && pwd && bundle exec "cd ..&& puppet strings"
+	cd .pdqtest && pwd && bundle exec "cd ..&& puppet strings generate --format markdown"
 
 
 Gemfile.local:
@@ -37,3 +37,7 @@ Gemfile.local:
 
 pdkbundle:
 	pdk bundle install
+
+clean:
+	rm -rf pkg
+	rm -rf spec/fixtures/modules

data/res/skeleton/bitbucket-pipelines.yml

@@ -1,5 +1,8 @@
 # *File originally created by PDQTest*
-image: ruby:2.3.5
+# To run locally:
+# https://confluence.atlassian.com/bitbucket/debug-your-pipelines-locally-with-docker-838273569.html
+---
+image: ruby:2.4.1
 
 pipelines:
   default:
@@ -9,7 +12,12 @@ pipelines:
         script:
           - ruby --version
           - bundler --version
-          - bundle install
+          - wget https://apt.puppetlabs.com/puppet5-release-trusty.deb
+          - dpkg -i puppet5-release-trusty.deb
+          - apt-get update
+          - apt install -y pdk
+          - sh .ci_custom.sh
+          - make pdqtestbundle
           - make logical
 
 definitions:

data/res/skeleton/make.ps1

@@ -10,10 +10,10 @@
 .PARAMETER target
   Test suite to run
 #>
-# *File originally created by PDQTest*
 param(
     $target = "all"
 )
+# *File originally created by PDQTest*
 
 $gfl = "Gemfile.local"
 $gfp = "Gemfile.project"
@@ -41,25 +41,44 @@ function Install-GemfileLocal {
 
 switch ($target) {
     "all" {
-      Install-GemfileLocal
-	    bundle exec pdqtest all
+        cd .pdqtest; bundle exec pdqtest all; cd ..
     }
     "fast" {
-      Install-GemfileLocal
-	    bundle exec pdqtest fast
+        cd .pdqtest; bundle exec pdqtest fast; cd ..
+    }
+    "acceptance" {
+        cd .pdqtest; bundle exec pdqtest acceptance; cd ..
     }
     "shell" {
-      Install-GemfileLocal
-	    bundle exec pdqtest --keep-container acceptance
+        cd .pdqtest; bundle exec pdqtest --keep-container acceptance; cd ..
     }
     "shellnopuppet" {
-      Install-GemfileLocal
-	    bundle exec pdqtest shell
+        cd .pdqtest; bundle exec pdqtest shell; cd ..
+    }
+    "setup" {
+        cd .pdqtest; bundle exec pdqtest setup; cd ..
     }
     "logical" {
-      Install-GemfileLocal
-	    bundle exec pdqtest syntax
-	    bundle exec pdqtest rspec
+        cd .pdqtest; bundle exec pdqtest logical; cd ..
+        cd .pdqtest ; bundle exec "cd ..; puppet strings"; cd ..
+    }
+    "docs" {
+        cd .pdqtest ; bundle exec "cd ..; puppet strings generate --format markdown"; cd ..
+    }
+    "Gemfile.local" {
+        echo "[(-_-)zzz] *copying* Gemfile.project to Gemfile.local and running pdk bundle..."
+        Install-GemfileLocal
+        .\make.ps1 pdkbundle
+    }
+    "pdqtestbundle" {
+        cd .pdqtest ; bundle install; cd ..
+    }
+    "pdkbundle" {
+        pdk bundle install
+    }
+    "clean" {
+        Remove-Item -ErrorAction SilentlyContinue -Confirm:$false -Recurse -force pkg
+        Remove-Item -ErrorAction SilentlyContinue -Confirm:$false -Recurse -force spec/fixtures/modules
     }
     default {
         Write-Error "No such target: $($target)"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pdqtest
 version: !ruby/object:Gem::Version
-  version: 1.9.9beta6
+  version: 1.9.9beta7
 platform: ruby
 authors:
 - Geoff Williams
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-29 00:00:00.000000000 Z
+date: 2018-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler