.github/workflows/ci.yml

@@ -6,6 +6,10 @@ name: CI
 
 on: pull_request
 
+concurrency:
+  group: ${{ github.head_ref }}
+  cancel-in-progress: true
+
 jobs:
   setup_matrix:
     name: 'Setup Test Matrix'

.msync.yml

@@ -2,4 +2,4 @@
 # Managed by modulesync - DO NOT EDIT
 # https://voxpupuli.org/docs/updating-files-managed-with-modulesync/
 
-modulesync_config_version: '4.2.0'
+modulesync_config_version: '5.1.0'

.puppet-lint.rc

@@ -0,0 +1,2 @@
+--fail-on-warnings
+--no-parameter_documentation-check

.sync.yml

@@ -5,3 +5,6 @@ Gemfile:
       - gem: 'toml'
 spec/spec_helper_acceptance.rb:
   unmanaged: false
+.puppet-lint.rc:
+  enabled_lint_checks:
+    - parameter_types

CHANGELOG.md

@@ -4,6 +4,26 @@ All notable changes to this project will be documented in this file.
 Each new release typically also includes the latest modulesync defaults.
 These should not affect the functionality of the module.
 
+## [v10.0.0](https://github.com/voxpupuli/puppet-grafana/tree/v10.0.0) (2021-11-26)
+
+[Full Changelog](https://github.com/voxpupuli/puppet-grafana/compare/v9.0.1...v10.0.0)
+
+**Breaking changes:**
+
+- Drop support for Debian 9, Ubuntu 16.04 \(EOL\) [\#262](https://github.com/voxpupuli/puppet-grafana/pull/262) ([smortex](https://github.com/smortex))
+
+**Implemented enhancements:**
+
+- Add support for Debian 11, CentOS 8, RedHat 8 and FreeBSD 13 [\#255](https://github.com/voxpupuli/puppet-grafana/pull/255) ([smortex](https://github.com/smortex))
+
+**Fixed bugs:**
+
+- Fix dashboard api call in grafana\_dashboard [\#267](https://github.com/voxpupuli/puppet-grafana/pull/267) ([joernott](https://github.com/joernott))
+
+**Closed issues:**
+
+- grafana\_dashboards ov version 9.0.1 does not work with Grafana 6.7.6 [\#261](https://github.com/voxpupuli/puppet-grafana/issues/261)
+
 ## [v9.0.1](https://github.com/voxpupuli/puppet-grafana/tree/v9.0.1) (2021-08-26)
 
 [Full Changelog](https://github.com/voxpupuli/puppet-grafana/compare/v9.0.0...v9.0.1)

Gemfile

@@ -4,7 +4,7 @@
 source ENV['GEM_SOURCE'] || "https://rubygems.org"
 
 group :test do
-  gem 'voxpupuli-test', '~> 2.5',   :require => false
+  gem 'voxpupuli-test', '~> 5.0',   :require => false
   gem 'coveralls',                  :require => false
   gem 'simplecov-console',          :require => false
   gem 'puppet_metadata', '~> 1.0',  :require => false
@@ -22,7 +22,7 @@ end
 
 group :release do
   gem 'github_changelog_generator', '>= 1.16.1',  :require => false if RUBY_VERSION >= '2.5'
-  gem 'voxpupuli-release', '>= 1.0.2',            :require => false
+  gem 'voxpupuli-release', '>= 1.2.0',            :require => false
   gem 'puppet-strings', '>= 2.2',                 :require => false
 end
 

README.md

@@ -673,7 +673,7 @@ grafana_dashboard { 'example_dashboard':
 }
 ```
 
-`content` must be valid JSON, and is parsed before imported.
+`content` must be valid JSON, and is parsed before imported. You can use the JSON generated with the share/export functionality or from the API call to /dashboards/uid but must remove the fields "id", "uid", "title" and "version" to make the resource call idempotent.
 `grafana_user` and `grafana_password` are optional, and required when
 authentication is enabled in Grafana. `grafana_api_path` is optional, and only used when using sub-paths for the API. `organization` is optional, and used when creating a dashboard for a specific organization.
 `folder` is an optional parameter, but the folder resource must exist.

Rakefile

@@ -1,7 +1,7 @@
 # Managed by modulesync - DO NOT EDIT
 # https://voxpupuli.org/docs/updating-files-managed-with-modulesync/
 
-# Attempt to load voxupuli-test (which pulls in puppetlabs_spec_helper),
+# Attempt to load voxpupuli-test (which pulls in puppetlabs_spec_helper),
 # otherwise attempt to load it directly.
 begin
   require 'voxpupuli/test/rake'

lib/puppet/functions/grafana/deep_find_and_remove.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # == Function: deep_find_and_remove
 #
 # This function takes a hash as input, along with a string
@@ -28,9 +30,7 @@ def deep_find_and_remove(key, object, removekey = 'puppetsource')
       foundpaths << object[key].dup
       object[key].delete(removekey)
     end
-    if object.is_a? Enumerable
-      foundpaths << object.map { |*a| deep_find_and_remove(key, a.last) }
-    end
+    foundpaths << object.map { |*a| deep_find_and_remove(key, a.last) } if object.is_a? Enumerable
     foundpaths.flatten.compact
     foundpaths
   end

lib/puppet/functions/grafana/get_sub_paths.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # == Function get_sub_paths
 #
 # This function receives an input path as an input parameter, and
@@ -28,10 +30,11 @@ def get_sub_paths(inputpath)
     parts = ip.split('/')
     parts.each_with_index do |value, index|
       next if index.zero? || index == (parts.length - 1)
+
       allsubs << if index == 1
-                   '/' + value
+                   "/#{value}"
                  else
-                   allsubs[index - 2] + '/' + value
+                   "#{allsubs[index - 2]}/#{value}"
                  end
     end
     allsubs

lib/puppet/provider/grafana.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #    Copyright 2015 Mirantis, Inc.
 #
 require 'cgi'
@@ -7,19 +9,17 @@
 class Puppet::Provider::Grafana < Puppet::Provider
   # Helper methods
   def grafana_host
-    @grafana_host = URI.parse(resource[:grafana_url]).host unless @grafana_host
+    @grafana_host ||= URI.parse(resource[:grafana_url]).host
     @grafana_host
   end
 
   def grafana_port
-    @grafana_port = URI.parse(resource[:grafana_url]).port unless @grafana_port
+    @grafana_port ||= URI.parse(resource[:grafana_url]).port
     @grafana_port
   end
 
   def grafana_scheme
-    unless @grafana_scheme
-      @grafana_scheme = URI.parse(resource[:grafana_url]).scheme
-    end
+    @grafana_scheme ||= URI.parse(resource[:grafana_url]).scheme
     @grafana_scheme
   end
 
@@ -56,9 +56,7 @@ def send_request(operation = 'GET', path = '', data = nil, search_path = {})
     end
 
     request.content_type = 'application/json'
-    if resource[:grafana_user] && resource[:grafana_password]
-      request.basic_auth resource[:grafana_user], resource[:grafana_password]
-    end
+    request.basic_auth resource[:grafana_user], resource[:grafana_password] if resource[:grafana_user] && resource[:grafana_password]
 
     Net::HTTP.start(grafana_host, grafana_port,
                     use_ssl: grafana_scheme == 'https',

lib/puppet/provider/grafana_conn_validator/net_http.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # In this case I'm trying the relative path first, then falling back to normal
 # mechanisms. This should be fixed in future versions of puppet but it looks
 # like we'll need to maintain this for some time perhaps.
@@ -36,9 +38,7 @@ def exists?
       success = validator.attempt_connection
     end
 
-    unless success
-      Puppet.notice("Failed to connect to Grafana within timeout window of #{timeout} seconds; giving up.")
-    end
+    Puppet.notice("Failed to connect to Grafana within timeout window of #{timeout} seconds; giving up.") unless success
 
     success
   end

lib/puppet/provider/grafana_dashboard/grafana.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 #    Copyright 2015 Mirantis, Inc.
 #
 require 'json'
 
 require File.expand_path(File.join(File.dirname(__FILE__), '..', 'grafana'))
 
-# Note: this class doesn't implement the self.instances and self.prefetch
+# NOTE: this class doesn't implement the self.instances and self.prefetch
 # methods because the Grafana API doesn't allow to retrieve the dashboards and
 # all their properties in a single call.
 Puppet::Type.type(:grafana_dashboard).provide(:grafana, parent: Puppet::Provider::Grafana) do
@@ -22,18 +24,14 @@ def grafana_api_path
 
   def fetch_organizations
     response = send_request('GET', format('%s/orgs', resource[:grafana_api_path]))
-    if response.code != '200'
-      raise format('Fail to retrieve organizations (HTTP response: %s/%s)', response.code, response.body)
-    end
+    raise format('Fail to retrieve organizations (HTTP response: %s/%s)', response.code, response.body) if response.code != '200'
 
     begin
       fetch_organizations = JSON.parse(response.body)
 
       fetch_organizations.map { |x| x['id'] }.map do |id|
         response = send_request 'GET', format('%s/orgs/%s', resource[:grafana_api_path], id)
-        if response.code != '200'
-          raise format('Failed to retrieve organization %d (HTTP response: %s/%s)', id, response.code, response.body)
-        end
+        raise format('Failed to retrieve organization %d (HTTP response: %s/%s)', id, response.code, response.body) if response.code != '200'
 
         fetch_organization = JSON.parse(response.body)
 
@@ -48,22 +46,17 @@ def fetch_organizations
   end
 
   def fetch_organization
-    unless @fetch_organization
-      @fetch_organization =
-        if resource[:organization].is_a?(Numeric) || resource[:organization].match(%r{^[0-9]*$})
-          fetch_organizations.find { |x| x[:id] == resource[:organization] }
-        else
-          fetch_organizations.find { |x| x[:name] == resource[:organization] }
-        end
-    end
+    @fetch_organization ||= if resource[:organization].is_a?(Numeric) || resource[:organization].match(%r{^[0-9]*$})
+                              fetch_organizations.find { |x| x[:id] == resource[:organization] }
+                            else
+                              fetch_organizations.find { |x| x[:name] == resource[:organization] }
+                            end
     @fetch_organization
   end
 
   def folders
     response = send_request('GET', format('%s/folders', resource[:grafana_api_path]))
-    if response.code != '200'
-      raise format('Fail to retrieve the folders (HTTP response: %s/%s)', response.code, response.body)
-    end
+    raise format('Fail to retrieve the folders (HTTP response: %s/%s)', response.code, response.body) if response.code != '200'
 
     begin
       @folders = JSON.parse(response.body)
@@ -87,13 +80,10 @@ def find_folder
   def dashboards
     # change organizations
     response = send_request 'POST', format('%s/user/using/%s', resource[:grafana_api_path], fetch_organization[:id])
-    unless response.code == '200'
-      raise format('Failed to switch to org %s (HTTP response: %s/%s)', fetch_organization[:id], response.code, response.body)
-    end
+    raise format('Failed to switch to org %s (HTTP response: %s/%s)', fetch_organization[:id], response.code, response.body) unless response.code == '200'
+
     response = send_request('GET', format('%s/search', resource[:grafana_api_path]), nil, q: '', starred: false)
-    if response.code != '200'
-      raise format('Fail to retrieve the dashboards (HTTP response: %s/%s)', response.code, response.body)
-    end
+    raise format('Fail to retrieve the dashboards (HTTP response: %s/%s)', response.code, response.body) if response.code != '200'
 
     begin
       JSON.parse(response.body)
@@ -104,13 +94,12 @@ def dashboards
 
   # Return the dashboard matching with the resource's title
   def find_dashboard
-    return unless dashboards.find { |x| x['title'] == resource[:title] }
+    db = dashboards.find { |x| x['title'] == resource[:title] }
+    return if db.nil?
 
-    response = send_request('GET', format('%s/dashboards/uid/%s', resource[:grafana_api_path], slug))
+    response = send_request('GET', format('%s/dashboards/uid/%s', resource[:grafana_api_path], db['uid']))
 
-    if response.code != '200'
-      raise format('Fail to retrieve dashboard %s (HTTP response: %s/%s)', resource[:title], response.code, response.body)
-    end
+    raise format('Fail to retrieve dashboard %s by uid %s (HTTP response: %s/%s)', resource[:title], db['uid'], response.code, response.body) if response.code != '200'
 
     begin
       # Cache the dashboard's content
@@ -125,26 +114,25 @@ def save_dashboard(dashboard)
 
     # change organizations
     response = send_request 'POST', format('%s/user/using/%s', resource[:grafana_api_path], fetch_organization[:id])
-    unless response.code == '200'
-      raise format('Failed to switch to org %s (HTTP response: %s/%s)', fetch_organization[:id], response.code, response.body)
-    end
+    raise format('Failed to switch to org %s (HTTP response: %s/%s)', fetch_organization[:id], response.code, response.body) unless response.code == '200'
 
     data = {
       dashboard: dashboard.merge('title' => resource[:title],
                                  'id' => @dashboard ? @dashboard['id'] : nil,
-                                 'uid' => slug,
+                                 'uid' => @dashboard ? @dashboard['uid'] : slug,
                                  'version' => @dashboard ? @dashboard['version'] + 1 : 0),
       folderId: @folder ? @folder['id'] : nil,
       overwrite: !@dashboard.nil?
     }
 
     response = send_request('POST', format('%s/dashboards/db', resource[:grafana_api_path]), data)
     return unless (response.code != '200') && (response.code != '412')
-    raise format('Fail to save dashboard %s (HTTP response: %s/%s', resource[:name], response.code, response.body)
+
+    raise format('Fail to save dashboard %s (HTTP response: %s/%s)', resource[:name], response.code, response.body)
   end
 
   def slug
-    resource[:title].downcase.gsub(%r{[ \+]+}, '-').gsub(%r{[^\w\- ]}, '')
+    resource[:title].downcase.gsub(%r{[ +]+}, '-').gsub(%r{[^\w\- ]}, '')
   end
 
   def content
@@ -160,10 +148,14 @@ def create
   end
 
   def destroy
-    response = send_request('DELETE', format('%s/dashboards/uid/%s', resource[:grafana_api_path], slug))
+    db = dashboards.find { |x| x['title'] == resource[:title] }
+    raise Puppet::Error, format('Failed to delete dashboard %s, dashboard not found', resource[:title]) if db.nil?
+
+    response = send_request('DELETE', format('%s/dashboards/uid/%s', resource[:grafana_api_path], db['uid']))
 
     return unless response.code != '200'
-    raise Puppet::Error, format('Failed to delete dashboard %s (HTTP response: %s/%s', resource[:title], response.code, response.body)
+
+    raise Puppet::Error, format('Failed to delete dashboard %s (HTTP response: %s/%s)', resource[:title], response.code, response.body)
   end
 
   def exists?

lib/puppet/provider/grafana_dashboard_permission/grafana.rb

@@ -182,7 +182,7 @@ def permission=(value)
   def new_permission
     key = resource[:user] ? :userId : :teamId
     subject_id = resource[:user] ? user[:id] : team[:id]
-    permission = case resource[:permission]
+    permission = case resource[:permission] # rubocop:disable Style/HashLikeCase
                  when :View
                    1
                  when :Edit
@@ -218,7 +218,7 @@ def existing_permissions
     end
   end
 
-  def permission_data(destroy = false)
+  def permission_data(destroy = false) # rubocop:disable Style/OptionalBooleanParameter
     raise format('Unknown dashboard: %s', resource[:dashboard]) unless dashboard
 
     endpoint = format('%s/dashboards/id/%s/permissions', grafana_api_path, dashboard[:id])