Release prep & CI overhaul

This does most of the prep for the next release and updates the CI process to use the PDK instead of a Ruby environment.

Author: genebean

.github/workflows/ci.yml

@@ -4,42 +4,27 @@ on:
   pull_request:
     branches:
       - master
+  push:
 
 jobs:
   test:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-18.04
     strategy:
       matrix:
-        ruby: [ '2.4.x', '2.5.x' ]
+        puppet_versions:
+          - '5'
+          - '6'
 
-    name: Ruby ${{ matrix.ruby }}
+    name: Puppet ${{ matrix.puppet_versions }}
     steps:
     - uses: actions/checkout@v1
-    - name: Set up Ruby
-      uses: actions/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby }}
-        architecture: 'x64'
-    - name: Run tests
+    - name: Install the Puppet PDK
       run: |
-        RUBY_MINOR_VERSION=$(ruby --version |cut -f 2 -d ' ' | cut -d '.' -f1,2)
-        case $RUBY_MINOR_VERSION in
-          '2.4')
-            PUPPET_GEM_VERSION='~> 5.0'
-            ;;
-          '2.5')
-            PUPPET_GEM_VERSION='~> 6.0'
-            ;;
-          *)
-            exit 1
-            ;;
-        esac
-        gem install bundler
-        bundle -v
-        rm -f Gemfile.lock
-        gem update --system $RUBYGEMS_VERSION
-        gem --version
-        bundle -v 
-        bundle install --jobs=3 --retry=3 --without system_tests
-        bundle exec rake check:symlinks check:git_ignore check:dot_underscore check:test_file rubocop syntax lint metadata_lint
-        bundle exec rake parallel_spec
+        wget https://apt.puppet.com/puppet-tools-release-bionic.deb
+        sudo dpkg -i puppet-tools-release-bionic.deb
+        sudo apt-get update 
+        sudo apt-get install pdk
+    - name: Syntax validation
+      run: pdk validate --puppet-version ${{ matrix.puppet_versions }}
+    - name: Unit tests
+      run: pdk test unit --puppet-version ${{ matrix.puppet_versions }}

.rubocop.yml

@@ -40,6 +40,10 @@ Style/BlockDelimiters:
   Description: Prefer braces for chaining. Mostly an aesthetical choice. Better to
     be consistent then.
   EnforcedStyle: braces_for_chaining
+Style/BracesAroundHashParameters:
+  Description: Braces are required by Ruby 2.7. Cop removed from RuboCop v0.80.0.
+    See https://github.com/rubocop-hq/rubocop/pull/7643
+  Enabled: true
 Style/ClassAndModuleChildren:
   Description: Compact style reduces the required amount of indentation.
   EnforcedStyle: compact

.vscode/extensions.json

@@ -1,6 +1,6 @@
 {
   "recommendations": [
-    "jpogran.puppet-vscode",
+    "puppet.puppet-vscode",
     "rebornix.Ruby"
   ]
 }

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]
   gem "github_changelog_generator", '1.15.0',                    require: false
 end
 

REFERENCE.md

@@ -1,28 +1,29 @@
 # Reference
+
 <!-- DO NOT EDIT: This document was generated by Puppet Strings -->
 
 ## Table of Contents
 
-**Classes**
+### Classes
 
-_Public Classes_
+#### Public Classes
 
 * [`promtail`](#promtail): promtail's main interface. All interactions should be with this class.
 
-_Private Classes_
+#### Private Classes
 
 * `promtail::config`: Creates files and folders associated with promtail's config
 * `promtail::install`: Installs promtail
 * `promtail::service`: Creates a service defintion for promtail
 
-**Functions**
+### Functions
 
 * [`promtail::strip_yaml_header`](#promtailstrip_yaml_header): A function to strip the --- from the beginning of a string
 * [`promtail::to_yaml`](#promtailto_yaml): A function to convert a hash into yaml for the promtail config
 
 ## Classes
 
-### promtail
+### `promtail`
 
 promtail's main interface. All interactions should be with this class. The promtail
 module is intended to install and configure Grafana's promtail tool for shipping
@@ -68,7 +69,6 @@ promtail::positions_config_hash:
 promtail::scrape_configs_hash:
   scrape_configs:
     - job_name: system_secure
-      entry_parser: raw
       static_configs:
       - targets:
           - localhost
@@ -77,7 +77,6 @@ promtail::scrape_configs_hash:
           host: "%{facts.networking.fqdn}"
           __path__: /var/log/secure
     - job_name: system_messages
-      entry_parser: raw
       static_configs:
       - targets:
           - localhost
@@ -102,6 +101,12 @@ class profile::logging::promtail {
 
 The following parameters are available in the `promtail` class.
 
+##### `service_enable`
+
+Data type: `Boolean`
+
+The value passed to the service resource's enable parameter for promtail's service
+
 ##### `service_ensure`
 
 Data type: `Enum['running', 'stopped']`
@@ -163,7 +168,7 @@ is omitted.
 See https://github.com/grafana/loki/blob/master/docs/clients/promtail/configuration.md
 for all parameters.
 
-Default value: `undef`
+Default value: ``undef``
 
 ##### `target_config_hash`
 
@@ -174,15 +179,15 @@ is omitted.
 See https://github.com/grafana/loki/blob/master/docs/clients/promtail/configuration.md
 for all parameters.
 
-Default value: `undef`
+Default value: ``undef``
 
 ##### `password_file_path`
 
 Data type: `Optional[Stdlib::Absolutepath]`
 
 The fully qualified path to the file containing the password used for basic auth
 
-Default value: `undef`
+Default value: ``undef``
 
 ##### `password_file_content`
 
@@ -191,11 +196,19 @@ Data type: `Optional[Sensitive[String[1]]]`
 The value to be placed in the password file. This value is cast to Sensitive via
 lookup_options defined in `data/common.yaml`
 
-Default value: `undef`
+Default value: ``undef``
+
+##### `source_url`
+
+Data type: `Stdlib::HTTPUrl`
+
+The URL from which promtail packages can be downloaded
+
+Default value: `'https://github.com/grafana/loki/releases/download'`
 
 ## Functions
 
-### promtail::strip_yaml_header
+### `promtail::strip_yaml_header`
 
 Type: Ruby 4.x API
 
@@ -237,7 +250,7 @@ Data type: `String`
 
 A string that may start with the ---'s used to denote a YAML file
 
-### promtail::to_yaml
+### `promtail::to_yaml`
 
 Type: Ruby 4.x API
 

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'
@@ -51,36 +53,35 @@ if Bundler.rubygems.find_name('github_changelog_generator').any?
     config.header = "# Change log\n\nAll notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org)."
     config.add_pr_wo_labels = true
     config.issues = false
-    config.merge_prefix = "### UNCATEGORIZED PRS; GO LABEL THEM"
+    config.merge_prefix = "### UNCATEGORIZED PRS; LABEL THEM ON GITHUB"
     config.configure_sections = {
       "Changed" => {
         "prefix" => "### Changed",
         "labels" => ["backwards-incompatible"],
       },
       "Added" => {
         "prefix" => "### Added",
-        "labels" => ["feature", "enhancement"],
+        "labels" => ["enhancement", "feature"],
       },
       "Fixed" => {
         "prefix" => "### Fixed",
-        "labels" => ["bugfix"],
+        "labels" => ["bug", "documentation", "bugfix"],
       },
     }
   end
 else
   desc 'Generate a Changelog from GitHub'
   task :changelog do
     raise <<EOM
-The changelog tasks depends on unreleased features of the github_changelog_generator gem.
+The changelog tasks depends on recent features of the github_changelog_generator gem.
 Please manually add it to your .sync.yml for now, and run `pdk update`:
 ---
 Gemfile:
   optional:
     ':development':
       - gem: 'github_changelog_generator'
-        git: 'https://github.com/skywinder/github-changelog-generator'
-        ref: '20ee04ba1234e9e83eb2ffb5056e23d641c7a018'
-        condition: "Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.2.2')"
+        version: '~> 1.15'
+        condition: "Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.3.0')"
 EOM
   end
 end

manifests/init.pp

@@ -4,6 +4,9 @@
 # module is intended to install and configure Grafana's promtail tool for shipping
 # logs to Loki.
 #
+# @param [Boolean] service_enable
+#   The value passed to the service resource's enable parameter for promtail's service
+#
 # @param [Enum['running', 'stopped']] service_ensure
 #   The value passed to the service resource's ensure parameter for promtail's service
 #
@@ -54,6 +57,9 @@
 #   The value to be placed in the password file. This value is cast to Sensitive via
 #   lookup_options defined in `data/common.yaml`
 #
+# @param [Stdlib::HTTPUrl] source_url
+#   The URL from which promtail packages can be downloaded
+#
 # @example
 #   include promtail
 #
@@ -84,7 +90,6 @@
 #   promtail::scrape_configs_hash:
 #     scrape_configs:
 #       - job_name: system_secure
-#         entry_parser: raw
 #         static_configs:
 #         - targets:
 #             - localhost
@@ -93,7 +98,6 @@
 #             host: "%{facts.networking.fqdn}"
 #             __path__: /var/log/secure
 #       - job_name: system_messages
-#         entry_parser: raw
 #         static_configs:
 #         - targets:
 #             - localhost
@@ -111,8 +115,8 @@
 #   }
 #
 class promtail (
-  Enum['running', 'stopped']     $service_ensure,
   Boolean                        $service_enable,
+  Enum['running', 'stopped']     $service_ensure,
   Hash                           $clients_config_hash,
   Hash                           $positions_config_hash,
   Hash                           $scrape_configs_hash,

metadata.json

@@ -1,6 +1,6 @@
 {
   "name": "grafana-promtail",
-  "version": "0.4.0",
+  "version": "0.4.1",
   "author": "grafana",
   "summary": "Deploy and configure Grafana's Promtail",
   "license": "Apache-2.0",
@@ -69,7 +69,7 @@
       "version_requirement": ">= 4.10.0 < 7.0.0"
     }
   ],
-  "pdk-version": "1.15.0",
-  "template-url": "pdk-default#1.15.0",
-  "template-ref": "tags/1.15.0-0-g0bc522e"
+  "pdk-version": "1.18.1",
+  "template-url": "pdk-default#1.18.1",
+  "template-ref": "tags/1.18.1-0-g3d2e75c"
 }

spec/classes/config_spec.rb

@@ -32,7 +32,6 @@
             scrape_configs_hash => {
               'scrape_configs' => [{
                 'job_name'       => 'system_secure',
-                'entry_parser'   => 'raw',
                 'static_configs' => [{
                   'targets' => [ 'localhost' ],
                   'labels'  => {

spec/classes/install_spec.rb

@@ -32,7 +32,6 @@
             scrape_configs_hash => {
               'scrape_configs' => [{
                 'job_name'       => 'system_secure',
-                'entry_parser'   => 'raw',
                 'static_configs' => [{
                   'targets' => [ 'localhost' ],
                   'labels'  => {