ruby-grafana-reporter 0.4.5 → 0.5.2

data/lib/grafana_reporter/configuration.rb

@@ -152,6 +152,32 @@ module GrafanaReporter
       get_config('default-document-attributes') || {}
     end
 
+    # Checks if this is the latest ruby-grafana-reporter version. If and how often the check if
+    # performed, depends on the configuration setting `check-for-updates`. By default this is
+    # 0 (=disabled). If a number >0 is specified, the checks are performed once every n-days on
+    # report creation or call of overview webpage.
+    # @return [Boolean] true, if is ok, false if a newer version exists
+    def latest_version_check_ok?
+      return false if @newer_version_exists
+
+      value = get_config('grafana-reporter:check-for-updates') || 0
+      return true if value <= 0
+
+      # repeat check only every n-th day
+      if @last_version_check
+        return true if (Time.now - @last_version_check) < (value * 24*60*60)
+      end
+
+      # check for newer version
+      @last_version_check = Time.now
+      url = 'https://github.com/divinity666/ruby-grafana-reporter/releases/latest'
+      response = Grafana::WebRequest.new(url).execute
+      return true if response['location'] =~ /.*[\/v]#{GRAFANA_REPORTER_VERSION.join('.')}$/
+
+      @newer_version_exists = true
+      return false
+    end
+
     # This function shall be called, before the configuration object is used in the
     # {Application::Application#run}. It ensures, that everything is setup properly
     # and all necessary folders exist. Appropriate errors are raised in case of errors.
@@ -237,13 +263,13 @@ module GrafanaReporter
       cur_pos
     end
 
-    def validate_schema(schema, subject)
+    def validate_schema(schema, subject, pattern = nil)
       return nil if subject.nil?
 
       schema.each do |key, config|
-        type, min_occurence, next_level = config
+        type, min_occurence, pattern, next_level = config
 
-        validate_schema(next_level, subject[key]) if next_level
+        validate_schema(next_level, subject[key], pattern) if next_level
 
         if key.nil?
           # apply to all on this level
@@ -263,9 +289,13 @@ module GrafanaReporter
         elsif subject.is_a?(Hash)
           if !subject.key?(key) && min_occurence.positive?
             raise ConfigurationDoesNotMatchSchemaError.new(key, 'occur', min_occurence, 0)
-          end
-          if !subject[key].is_a?(type) && subject.key?(key)
+          elsif !subject[key].is_a?(type) && subject.key?(key)
             raise ConfigurationDoesNotMatchSchemaError.new(key, 'be a', type, subject[key].class)
+          elsif pattern
+            # validate for regex
+            unless subject[key].to_s =~ pattern
+              raise ConfigurationDoesNotMatchSchemaError.new(key, 'match pattern', pattern.inspect, subject[key].to_s)
+            end
           end
 
         else
@@ -286,34 +316,35 @@ module GrafanaReporter
       {
         'grafana' =>
          [
-           Hash, 1,
+           Hash, 1, nil,
            {
              nil =>
               [
-                Hash, 1,
+                Hash, 1, nil,
                 {
-                  'host' => [String, 1],
-                  'api_key' => [String, 0]
+                  'host' => [String, 1, %r{^http(s)?://.+}],
+                  'api_key' => [String, 0, %r{^(?:[\w]+[=]*)?$}]
                 }
               ]
            }
          ],
-        'default-document-attributes' => [Hash, explicit ? 1 : 0],
-        'to_file' => [String, 0],
+        'default-document-attributes' => [Hash, explicit ? 1 : 0, nil],
+        'to_file' => [String, 0, nil],
         'grafana-reporter' =>
         [
-          Hash, 1,
+          Hash, 1, nil,
           {
-            'debug-level' => [String, 0],
-            'run-mode' => [String, 0],
-            'test-instance' => [String, 0],
-            'templates-folder' => [String, explicit ? 1 : 0],
-            'report-class' => [String, 1],
-            'reports-folder' => [String, explicit ? 1 : 0],
-            'report-retention' => [Integer, explicit ? 1 : 0],
-            'ssl-cert' => [String, 0],
-            'webservice-port' => [Integer, explicit ? 1 : 0],
-            'callbacks' => [Hash, 0, { nil => [String, 1] }]
+            'check-for-updates' => [Integer, 0, /^[0-9]*$/],
+            'debug-level' => [String, 0, /^(?:DEBUG|INFO|WARN|ERROR|FATAL|UNKNOWN)?$/],
+            'run-mode' => [String, 0, /^(?:test|single-render|webservice)?$/],
+            'test-instance' => [String, 0, nil],
+            'templates-folder' => [String, explicit ? 1 : 0, nil],
+            'report-class' => [String, 1, nil],
+            'reports-folder' => [String, explicit ? 1 : 0, nil],
+            'report-retention' => [Integer, explicit ? 1 : 0, nil],
+            'ssl-cert' => [String, 0, nil],
+            'webservice-port' => [Integer, explicit ? 1 : 0, nil],
+            'callbacks' => [Hash, 0, nil, { nil => [String, 1, nil] }]
           }
         ]
       }

data/lib/grafana_reporter/console_configuration_wizard.rb

@@ -6,7 +6,6 @@ module GrafanaReporter
   class ConsoleConfigurationWizard
     # Provides a command line configuration wizard for setting up the necessary configuration
     # file.
-    # TODO: refactor class
     def start_wizard(config_file, console_config)
       action = overwrite_or_use_config_file(config_file)
       return if action == 'abort'
@@ -73,6 +72,9 @@ module GrafanaReporter
 #{grafana}
 
 grafana-reporter:
+# Specifies how often the reporter shall check for newer versions [number of days].
+# You may set check-for-updates to 0 to disable
+  check-for-updates: 1
   report-class: GrafanaReporter::Asciidoctor::Report
   templates-folder: #{templates}
   reports-folder: #{reports}

data/lib/grafana_reporter/csv_table_format_strategy.rb

@@ -9,15 +9,17 @@ module GrafanaReporter
       'csv'
     end
 
-    # @see AbstractTableFormatStrategy#format
-    def format(result, include_headline)
-      headline = result[:header].map { |item| item.to_s.gsub(',', '\\,') }.join(',')
-
-      content = result[:content].map do |row|
-        row.map { |item| item.to_s.gsub(',', '\,') }.join(',')
-      end.join("\n")
-
-      "#{"#{headline}\n" if include_headline}#{content}"
+    # @see AbstractTableFormatStrategy#format_rules
+    def format_rules
+      {
+        row_start: '',
+        row_end: "\n",
+        cell_start: '',
+        between_cells: ', ',
+        cell_end: '',
+        replace_string_or_regex: ',',
+        replacement: '\\,'
+      }
     end
   end
 end

data/lib/grafana_reporter/demo_report_wizard.rb

@@ -55,12 +55,6 @@ module GrafanaReporter
       results = {}
 
       dashboard.panels.shuffle.each do |panel|
-        begin
-          next if panel.datasource.is_a?(Grafana::UnsupportedDatasource)
-        rescue Grafana::DatasourceDoesNotExistError
-          next
-        end
-
         query_classes.each do |query_class|
           unless query_class.public_instance_methods.include?(:build_demo_entry)
             results[query_class] = "Method 'build_demo_entry' not implemented for #{query_class.name}"
@@ -77,6 +71,9 @@ module GrafanaReporter
             # currently not allowed
           rescue StandardError => e
             puts "#{e.message}\n#{e.backtrace.join("\n")}"
+          rescue NotImplementedError
+            # Ignore these errors, as it only means, that a class does not implement
+            # the demo entry
           end
         end
       end

data/lib/grafana_reporter/errors.rb

@@ -27,7 +27,7 @@ module GrafanaReporter
   # Raised if the return value of a datasource request does not match the expected return hash.
   class DatasourceRequestInvalidReturnValueError < GrafanaReporterError
     def initialize(datasource, message)
-      super("The datasource request to '#{datasource.name}' (#{datasource.class})"\
+      super("The datasource request to '#{datasource.name}' (#{datasource.class}) "\
             "returned an invalid value: '#{message}'")
     end
   end
@@ -65,7 +65,7 @@ module GrafanaReporter
   # Details about how to fix that are provided in the message.
   class ConfigurationDoesNotMatchSchemaError < ConfigurationError
     def initialize(item, verb, expected, currently)
-      super("Configuration file does not match schema definition. Expected '#{item}' to #{verb} '#{expected}',"\
+      super("Configuration file does not match schema definition. Expected '#{item}' to #{verb} '#{expected}', "\
             "but was '#{currently}'.")
     end
   end

data/lib/grafana_reporter/panel_image_query.rb

@@ -15,7 +15,6 @@ module GrafanaReporter
     # Returns the body of the http query, which contains the raw image.
     def post_process
       @result = @result[:content].first
-      raise ::Grafana::ImageCouldNotBeRenderedError, @panel if @result.include?('<html')
     end
 
     # @see AbstractQuery#raw_query

data/lib/grafana_reporter/query_value_query.rb

@@ -19,8 +19,14 @@ module GrafanaReporter
       modify_results
 
       case @variables['result_type'].raw_value
+      when 'object'
+
       when /(?:panel_table|sql_table)/
-        @result = format_table_output(@result, row_divider: @variables['row_divider'], column_divider: @variables['column_divider'], table_formatter: @variables['table_formatter'], include_headline: @variables['include_headline'])
+        @result = format_table_output(@result, row_divider: @variables['row_divider'],
+                                               column_divider: @variables['column_divider'],
+                                               table_formatter: @variables['table_formatter'],
+                                               include_headline: @variables['include_headline'],
+                                               transpose: @variables['transpose'])
 
       when /(?:panel_value|sql_value)/
         tmp = @result[:content] || []

data/lib/grafana_reporter/reporter_environment_datasource.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module GrafanaReporter
+  # Implements a datasource to return environment related information about the reporter in a tabular format.
+  class ReporterEnvironmentDatasource < ::Grafana::AbstractDatasource
+    # @see AbstractDatasource#request
+    def request(query_description)
+      {
+        header: ['Version', 'Release Date'],
+        content: [[GRAFANA_REPORTER_VERSION.join('.'), GRAFANA_REPORTER_RELEASE_DATE]]
+      }
+    end
+
+    # @see AbstractDatasource#default_variable_format
+    def default_variable_format
+      nil
+    end
+
+    # @see AbstractDatasource#name
+    def name
+      self.class.to_s
+    end
+  end
+end

data/lib/ruby_grafana_reporter.rb

@@ -18,16 +18,16 @@ require 'asciidoctor-pdf'
 require 'zip'
 require_relative 'VERSION'
 
-# TODO: add test to see if datasource default formats are applied
-# TODO: add test for render-height and render-width, as they are not forwarded
-# TODO: show convert-backend, template language and all variables in webservice overview
+# TODO: add test for variable replacement for sql
+# TODO: check why value is All instead of $__all
+# TODO: check why single sql values are replaced including ticks, whereas grafana does not do so
+
+# TODO: add FAQ for fixing most common issues with the reporter
+# TODO: implement an easy function to document a whole dashboard at once with different presentations
 # TODO: add automated test against grafana playground before building a new release
 # TODO: allow registration of files to be defined in config file
-# TODO: PRIO: check in cloud - variables fetched from queries are replaced with SQL query instead of the resolved values, which can lead to issues, e.g. when using that in a function as SUBSTRING
-# TODO: PRIO: allow multiple report classes in configuration file including possibility to decide for the individual class for each rendering call
-# TODO: add configuration example to README
-# TODO: find a way, how to automatically update test grafana responses with _real_ grafana responses
 # TODO: append necessary variables on demo report creation for plain SQL queries, as they are lacking the grafana reference
+# TODO: make demo report more readable
 
 folders = [
   %w[grafana],

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-grafana-reporter
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.5.2
 platform: ruby
 authors:
 - Christian Kohlmeyer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-26 00:00:00.000000000 Z
+date: 2022-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -100,9 +100,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.9'
-description: Build reports based on grafana dashboards in asciidoctor syntax. Runs
-  as webservice for easy integration with grafana, or as a standalone, command line
-  utility.
+description: Build reports based on grafana dashboards in asciidoctor or ERB syntax.
+  Runs as webservice for easy integration with grafana, or as a standalone, command
+  line utility.
 email: kohly@gmx.de
 executables:
 - ruby-grafana-reporter
@@ -118,6 +118,7 @@ files:
 - "./lib/grafana/grafana.rb"
 - "./lib/grafana/grafana_alerts_datasource.rb"
 - "./lib/grafana/grafana_annotations_datasource.rb"
+- "./lib/grafana/grafana_environment_datasource.rb"
 - "./lib/grafana/grafana_property_datasource.rb"
 - "./lib/grafana/graphite_datasource.rb"
 - "./lib/grafana/image_rendering_datasource.rb"
@@ -165,6 +166,7 @@ files:
 - "./lib/grafana_reporter/panel_property_query.rb"
 - "./lib/grafana_reporter/query_value_query.rb"
 - "./lib/grafana_reporter/report_webhook.rb"
+- "./lib/grafana_reporter/reporter_environment_datasource.rb"
 - "./lib/ruby_grafana_extension.rb"
 - "./lib/ruby_grafana_reporter.rb"
 - LICENSE
@@ -191,8 +193,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
+rubygems_version: 3.2.5
 signing_key: 
 specification_version: 4
 summary: Reporter Service for Grafana