st1105 addition (#80)

* st1105 added, master port check task

* new lines added at end of files

* rubocop changes

* lines shortened manually for rubocop

* perms update

* ports array removed

* pdk template update

Author: pgrant87

.rubocop.yml

@@ -27,6 +27,7 @@ GetText/DecorateString:
   Description: We don't want to decorate test output.
   Exclude:
   - spec/**/*
+  Enabled: false
 RSpec/BeforeAfterAll:
   Description: Beware of using after(:all) as it may cause state to leak between tests.
     A necessary evil in acceptance testing.
@@ -88,6 +89,12 @@ Style/MethodCalledOnDoEndBlock:
   Enabled: true
 Style/StringMethods:
   Enabled: true
+GetText/DecorateFunctionMessage:
+  Enabled: false
+GetText/DecorateStringFormattingUsingInterpolation:
+  Enabled: false
+GetText/DecorateStringFormattingUsingPercent:
+  Enabled: false
 Layout/EndOfLine:
   Enabled: false
 Layout/IndentHeredoc:

.travis.yml

@@ -1,18 +1,22 @@
 ---
+os: linux
 dist: xenial
 language: ruby
 cache: bundler
 before_install:
   - bundle -v
   - rm -f Gemfile.lock
-  - yes | gem update --system $RUBYGEMS_VERSION
+  - "# Update system gems if requested. This is useful to temporarily workaround troubles in the test runner"
+  - "# See https://github.com/puppetlabs/pdk-templates/commit/705154d5c437796b821691b707156e1b056d244f for an example of how this was used"
+  - "# Ignore exit code of SIGPIPE'd yes to not fail with shell's pipefail set"
+  - '[ -z "$RUBYGEMS_VERSION" ] || (yes || true) | gem update --system $RUBYGEMS_VERSION'
   - gem --version
   - bundle -v
 script:
   - 'bundle exec rake $CHECK'
 bundler_args: --without system_tests
 rvm:
-  - 2.5.3
+  - 2.5.7
 env:
   global:
     - SHELLCHECK_OPTS="-e SC1117"
@@ -23,15 +27,16 @@ stages:
   -
     if: tag =~ ^v\d
     name: deploy
-matrix:
+jobs:
   fast_finish: true
   include:
     -
       env: CHECK="check:symlinks check:git_ignore check:dot_underscore check:test_file rubocop syntax lint metadata_lint"
       stage: static
     -
-      env: DEPLOY_TO_FORGE=yes
-      stage: deploy
+      env: PUPPET_GEM_VERSION="~> 6.0" CHECK=parallel_spec
+      rvm: 2.5.7
+      stage: spec
     -
       env: CHECK="shellcheck tasknames"
       stage: static
@@ -58,7 +63,7 @@ matrix:
       dist: trusty
       env: ["PLATFORMS=el_puppet5", "PROVISION_LIST=litmus_el", "PUPPET_VERSION=puppet5"]
       rvm: 2.5.1
-      script: ["bundle exec rake \"litmus:provision_list[${PROVISION_LIST}]\"", "bundle exec rake \"litmus:install_agent[${PUPPET_VERSION}]\"", "bundle exec rake litmus:install_module", "bundle exec rake litmus:acceptance:parallel"]
+      script: ["bundle exec rake \"litmus:provision_list[${PROVISION_LIST}]\"", "bundle exec rake \"litmus:install_agent[${PUPPET_VERSION}]\"", "bundle exec rake litmus:install_module", "travis_wait 45 bundle exec rake litmus:acceptance:parallel"]
       services: docker
       stage: acceptance
       sudo: required
@@ -67,10 +72,13 @@ matrix:
       dist: trusty
       env: ["PLATFORMS=el_puppet6", "PROVISION_LIST=litmus_el", "PUPPET_VERSION=puppet6"]
       rvm: 2.5.1
-      script: ["bundle exec rake \"litmus:provision_list[${PROVISION_LIST}]\"", "bundle exec rake \"litmus:install_agent[${PUPPET_VERSION}]\"", "bundle exec rake litmus:install_module", "bundle exec rake litmus:acceptance:parallel"]
+      script: ["bundle exec rake \"litmus:provision_list[${PROVISION_LIST}]\"", "bundle exec rake \"litmus:install_agent[${PUPPET_VERSION}]\"", "bundle exec rake litmus:install_module", "travis_wait 45 bundle exec rake litmus:acceptance:parallel"]
       services: docker
       stage: acceptance
       sudo: required
+    -
+      env: DEPLOY_TO_FORGE=yes
+      stage: deploy
 branches:
   only:
     - master
@@ -80,7 +88,7 @@ notifications:
   email: false
 deploy:
   provider: puppetforge
-  user: puppetlabs
+  username: puppetlabs
   password:
     secure: "ChaeM/FvQKwbznBtKkxky2jFSmbWDhlnChRqnXK+tA6D2FjIbdnIlbP66R6pPiQ1vH8MRFnCnsuPvY7yRjMdVWWRkRS1jPBb2r2iNLCAcKVW7SOlT6HuzKjbVdOqgDRMEWFrQ5NFywN5YDN+H5UqS/WWPIGT8P+72w0ennOws1Ie4xcVt1foYymuaaxGC27KT0Wn2xplAX6/quTINtEXibEtIMuBq5Y1Uh5OJr7UFZ5SOzgoTV15xVMKqFNVG+FJ3mg2PEu8XRsFK6pho6+n3x7x30pVt1/JgLWF2wngtQ14QSL2d8XrHFT8w7uxrxWMMzFu4MRYNZh9Mvt8giHl4VxzX63YWWq5uKvut6Cw0xotwGesNjrubSnKoOLGCnKAB4FWs2xli1NIQHuPFRLiv/1E5obrls6Bea43s53gGjHdeHMbK6U7sHY15z77z+xjFJBdTdlMe2dDKg7s5awDkeas62OpclmnFBVqKQ5FEFlVaRrVzjpd1zp8V3CaSnztlLSLxvmix40avsZ8fALkwKy1c369nzlwFKLMeWL1lD2IHLClhibLlL/U+6dvCp8wqGArq/c82WYIK1k4L6iNVLHGzIdTvfuBatO0et5zG5yOpjC8EoaZ2y1K1IxVd0I/tQypV9URwCUfM1I+JMNdPW0aqUmTT7MNTGu52S4mHLg="
   on:

Gemfile

@@ -24,10 +24,10 @@ group :development do
   gem "json", '= 2.0.4',                                         require: false if Gem::Requirement.create('~> 2.4.2').satisfied_by?(Gem::Version.new(RUBY_VERSION.dup))
   gem "json", '= 2.1.0',                                         require: false if Gem::Requirement.create(['>= 2.5.0', '< 2.7.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup))
   gem "rb-readline", '= 0.5.5',                                  require: false, platforms: [:mswin, :mingw, :x64_mingw]
-  gem "puppet-module-posix-default-r#{minor_version}", '~> 0.3', require: false, platforms: [:ruby]
-  gem "puppet-module-posix-dev-r#{minor_version}", '~> 0.3',     require: false, platforms: [:ruby]
-  gem "puppet-module-win-default-r#{minor_version}", '~> 0.3',   require: false, platforms: [:mswin, :mingw, :x64_mingw]
-  gem "puppet-module-win-dev-r#{minor_version}", '~> 0.3',       require: false, platforms: [:mswin, :mingw, :x64_mingw]
+  gem "puppet-module-posix-default-r#{minor_version}", '~> 0.4', require: false, platforms: [:ruby]
+  gem "puppet-module-posix-dev-r#{minor_version}", '~> 0.4',     require: false, platforms: [:ruby]
+  gem "puppet-module-win-default-r#{minor_version}", '~> 0.4',   require: false, platforms: [:mswin, :mingw, :x64_mingw]
+  gem "puppet-module-win-dev-r#{minor_version}", '~> 0.4',       require: false, platforms: [:mswin, :mingw, :x64_mingw]
 end
 group :system_tests do
   gem "puppet-module-posix-system-r#{minor_version}", require: false, platforms: [:ruby]

Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'puppet_litmus/rake_tasks' if Bundler.rubygems.find_name('puppet_litmus').any?
 require 'puppetlabs_spec_helper/rake_tasks'
 require 'puppet-syntax/tasks/puppet-syntax'

metadata.json

@@ -93,7 +93,7 @@
       "version_requirement": ">= 5.3.2 < 7.0.0"
     }
   ],
-  "pdk-version": "1.14.1",
-  "template-url": "https://github.com/puppetlabs/pdk-templates#1.13.0",
-  "template-ref": "1.13.0-0-g66e1443"
+  "pdk-version": "1.17.0",
+  "template-url": "https://github.com/puppetlabs/pdk-templates#1.17.0",
+  "template-ref": "tags/1.17.0-0-gd3a4319"
 }

spec/default_facts.yml

@@ -3,5 +3,6 @@
 # Facts specified here will override the values provided by rspec-puppet-facts.
 ---
 ipaddress: "172.16.254.254"
+ipaddress6: "FE80:0000:0000:0000:AAAA:AAAA:AAAA"
 is_pe: false
 macaddress: "AA:AA:AA:AA:AA:AA"

spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'puppetlabs_spec_helper/module_spec_helper'
 require 'rspec-puppet-facts'
 

tasks/st1105_master_port_check.json

@@ -0,0 +1,5 @@
+{
+    "puppet_task_version": 1,
+    "description": "Task to test TCP port connectivity of the Puppet Master",
+    "supports_noop": false
+}

tasks/st1105_master_port_check.rb

@@ -0,0 +1,58 @@
+#!/opt/puppetlabs/puppet/bin/ruby
+
+# st1105_master_port_check
+# Checks the port requirements for a puppet master and prints a short description of the port and it's status.
+# PE only and this is to be run against the Puppet Master.
+
+require 'socket'
+require 'json'
+
+destination = Socket.gethostbyname(Socket.gethostname).first
+portdesc = {
+  '8140' => "The master uses this port to accept inbound traffic/requests from agents.
+             The console sends requests to the master on this port. Certificate requests are passed over this port unless ca_port is set differently.
+             Puppet Server status checks are sent over this port.",
+  '443'  => 'This port provides host access to the console. The console accepts HTTPS traffic from end users on this port.',
+  '4433' => 'This port is used as a classifier/console services API endpoint. The master communicates with the console over this port.',
+  '8081' => 'PuppetDB accepts traffic/requests on this port. The master and console send traffic to PuppetDB on this port. PuppetDB status checks are sent over this port.',
+  '8142' => 'Orchestrator and the Run Puppet button use this port on the master of masters to accept inbound traffic/responses from agents via the Puppet Execution Protocol agent.',
+  '8143' => 'Orchestrator uses this port to accept connections from Puppet Communications Protocol brokers to relay communications.
+             The orchestrator client also uses this port to communicate with the orchestration services running on the master of masters.
+             If you install the client on a workstation, this port must be available on the workstation.',
+  '5432' => 'This port is used in a High Availability configuration to replicate data between the master and replica.',
+  '8170' => 'Code Manager uses this port to deploy environments, run webhooks, and make API calls.',
+}
+
+def port_test(dest, port)
+  begin
+    Socket.tcp(dest, port, connect_timeout: 5)
+  rescue Errno::ECONNREFUSED, Errno::EHOSTUNREACH, Errno::ETIMEDOUT
+    return false
+  end
+  true
+end
+
+results_json = []
+
+portdesc.keys.each do |port_no|
+  # If port is open
+  result = if port_test(destination, port_no)
+             {
+               'destination' => destination.to_s,
+               'port' => port_no,
+               'result' => 'pass',
+               'description' => portdesc[port_no],
+             }
+           # If port is closed
+           else
+             {
+               'destination' => destination.to_s,
+               'port' => port_no,
+               'result' => 'fail',
+               'description' => portdesc[port_no],
+             }
+           end
+  results_json << result
+end
+
+puts JSON.pretty_generate(results_json)