ruby-grafana-reporter 0.4.3 → 0.4.4

data/lib/VERSION.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 # Version information
-GRAFANA_REPORTER_VERSION = [0, 4, 3].freeze
+GRAFANA_REPORTER_VERSION = [0, 4, 4].freeze
 # Release date
-GRAFANA_REPORTER_RELEASE_DATE = '2021-06-18'
+GRAFANA_REPORTER_RELEASE_DATE = '2021-07-12'

data/lib/grafana/abstract_datasource.rb

@@ -42,12 +42,12 @@ module Grafana
       @model = model
     end
 
-    # @return [String] category of the datasource, e.g. `tsdb` or `sql`
+    # @return [String] category of the datasource, e.g. +tsdb+ or +sql+
     def category
       @model['meta']['category']
     end
 
-    # @return [String] type of the datasource, e.g. `mysql`
+    # @return [String] type of the datasource, e.g. +mysql+
     def type
       @model['type'] || @model['meta']['id']
     end
@@ -126,10 +126,13 @@ module Grafana
       while repeat && (repeat_count < 3)
         repeat = false
         repeat_count += 1
+
         variables.each do |name, variable|
           # only set ticks if value is string
           var_name = name.gsub(/^var-/, '')
-          res = res.gsub(/(?:\$\{#{var_name}(?::(?<format>\w+))?\}|\$#{var_name})/) do
+          next unless var_name =~ /^\w+$/
+
+          res = res.gsub(/(?:\$\{#{var_name}(?::(?<format>\w+))?\}|\$#{var_name}(?!\w))/) do
             format = default_variable_format
             if $LAST_MATCH_INFO
               format = $LAST_MATCH_INFO[:format] if $LAST_MATCH_INFO[:format]

data/lib/grafana/errors.rb

@@ -37,9 +37,9 @@ module Grafana
 
   # Raised if a given datasource does not exist in a specific {Grafana} instance.
   class DatasourceDoesNotExistError < GrafanaError
-    # @param field [String] specifies, how the datasource has been searched, e.g. 'id' or 'name'
+    # @param field [String] specifies, how the datasource has been searched, e.g. +id+ or +name+
     # @param datasource_identifier [String] identifier of the datasource, which could not be found,
-    #   e.g. the specifiy id or name
+    #   e.g. the specified id or name
     def initialize(field, datasource_identifier)
       super("Datasource with #{field} '#{datasource_identifier}' does not exist.")
     end

data/lib/grafana/grafana_property_datasource.rb

@@ -16,6 +16,8 @@ module Grafana
       panel = query_description[:raw_query][:panel]
       property_name = query_description[:raw_query][:property_name]
 
+      return "Panel property '#{property_name}' does not exist for panel '#{panel.id}'" unless panel.field(property_name)
+
       {
         header: [query_description[:raw_query][:property_name]],
         content: [replace_variables(panel.field(property_name), query_description[:variables])]
@@ -24,7 +26,12 @@ module Grafana
 
     # @see AbstractDatasource#default_variable_format
     def default_variable_format
-        'glob'
+      'glob'
+    end
+
+    # @see AbstractDatasource#name
+    def name
+      self.class.to_s
     end
   end
 end

data/lib/grafana/panel.rb

@@ -18,7 +18,7 @@ module Grafana
     def field(field)
       return @model[field] if @model.key?(field)
 
-      ''
+      nil
     end
 
     # @return [String] panel ID

data/lib/grafana/sql_datasource.rb

@@ -19,7 +19,7 @@ module Grafana
         body: {
           from: query_description[:from],
           to: query_description[:to],
-          queries: [rawSql: prepare_sql(sql), datasourceId: id, format: 'table']
+          queries: [rawSql: sql, datasourceId: id, format: 'table']
         }.to_json,
         request: Net::HTTP::Post
       }
@@ -66,13 +66,5 @@ module Grafana
 
       results
     end
-
-    def prepare_sql(sql)
-      # remove comments in query
-      sql.gsub!(/--[^\r\n]*(?:[\r\n]+|$)/, ' ')
-      sql.gsub!(/\r\n/, ' ')
-      sql.gsub!(/\n/, ' ')
-      sql
-    end
   end
 end

data/lib/grafana/variable.rb

@@ -63,92 +63,96 @@ module Grafana
       value = @raw_value
 
       # handle value 'All' properly
-      # TODO: fix check for selection of All properly
-      if (value == 'All') || (@text == 'All')
+      if value == '$__all'
         if !@config['options'].empty?
+          # this query contains predefined values, so capture them and format the values accordingly
+          # this happens either if type='custom' or a query, which is never updated
           value = @config['options'].map { |item| item['value'] }
-        elsif !@config['query'].empty?
-          # TODO: replace variables in this query, too
+
+        elsif @config['type'] == 'query' && !@config['query'].empty?
+          # TODO: replace variables in query, execute it and evaluate the results as if they were normally selected
+          # "multiFormat": contains variable replacement in "query", e.g. 'regex values' or 'glob'
+          # "datasource": contains name of datasource
           return @config['query']
-          # TODO: handle 'All' value properly for query attributes
+
         else
-          # TODO: how to handle All selection properly at this point?
+          # TODO: add support for variable type: 'datasource' and 'adhoc'
         end
       end
 
       case format
       when 'csv'
-        return value.join(',').to_s if multi?
+        return value.join(',').to_s if multi? && value.is_a?(Array)
 
         value.to_s
 
       when 'distributed'
-        return value.join(",#{name}=") if multi?
+        return value.join(",#{name}=") if multi? && value.is_a?(Array)
 
         value
       when 'doublequote'
-        if multi?
+        if multi? && value.is_a?(Array)
           value = value.map { |item| "\"#{item.gsub(/\\/, '\\\\').gsub(/"/, '\\"')}\"" }
           return value.join(',')
         end
         "\"#{value.gsub(/"/, '\\"')}\""
 
       when 'json'
-        if multi?
+        if multi? && value.is_a?(Array)
           value = value.map { |item| "\"#{item.gsub(/["\\]/, '\\\\\0')}\"" }
           return "[#{value.join(',')}]"
         end
         "\"#{value.gsub(/"/, '\\"')}\""
 
       when 'percentencode'
-        value = "{#{value.join(',')}}" if multi?
+        value = "{#{value.join(',')}}" if multi? && value.is_a?(Array)
         ERB::Util.url_encode(value)
 
       when 'pipe'
-        return value.join('|') if multi?
+        return value.join('|') if multi? && value.is_a?(Array)
 
         value
 
       when 'raw'
-        return "{#{value.join(',')}}" if multi?
+        return "{#{value.join(',')}}" if multi? && value.is_a?(Array)
 
         value
 
       when 'regex'
-        if multi?
+        if multi? && value.is_a?(Array)
           value = value.map { |item| item.gsub(%r{[/$.|\\]}, '\\\\\0') }
           return "(#{value.join('|')})"
         end
         value.gsub(%r{[/$.|\\]}, '\\\\\0')
 
       when 'singlequote'
-        if multi?
+        if multi? && value.is_a?(Array)
           value = value.map { |item| "'#{item.gsub(/'/, '\\\\\0')}'" }
           return value.join(',')
         end
         "'#{value.gsub(/'/, '\\\\\0')}'"
 
       when 'sqlstring'
-        if multi?
+        if multi? && value.is_a?(Array)
           value = value.map { |item| "'#{item.gsub(/'/, "''")}'" }
           return value.join(',')
         end
         "'#{value.gsub(/'/, "''")}'"
 
       when 'lucene'
-        if multi?
+        if multi? && value.is_a?(Array)
           value = value.map { |item| "\"#{item.gsub(%r{[" |=/\\]}, '\\\\\0')}\"" }
           return "(#{value.join(' OR ')})"
         end
         value.gsub(%r{[" |=/\\]}, '\\\\\0')
 
       when /^date(?::(?<format>.*))?$/
-        # TODO: validate how grafana handles multivariables with date format
+        # TODO: grafana does not seem to allow multivariables with date format - so properly handle here as well
         get_date_formatted(value, Regexp.last_match(1))
 
       when ''
         # default
-        if multi?
+        if multi? && value.is_a?(Array)
           value = value.map { |item| "'#{item.gsub(/'/, "''")}'" }
           return value.join(',')
         end
@@ -162,7 +166,7 @@ module Grafana
       end
     end
 
-    # @return [Boolean] true, if the value can contain multiple selections, i.e. is an Array
+    # @return [Boolean] true, if the value can contain multiple selections, i.e. can contain an Array
     def multi?
       return @config['multi'] unless @config['multi'].nil?
 
@@ -196,6 +200,8 @@ module Grafana
       until work_string.empty?
         tmp = work_string.scan(/^(?:M{1,4}|D{1,4}|d{1,4}|e|E|w{1,2}|W{1,2}|Y{4}|Y{2}|A|a|H{1,2}|
                                     h{1,2}|k{1,2}|m{1,2}|s{1,2}|S+|X)/x)
+
+        # TODO: add test for sub! and switch to non-modifying frozen string action
         if tmp.empty?
           matches << work_string[0]
           work_string.sub!(/^#{work_string[0]}/, '')

data/lib/grafana_reporter/abstract_query.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require_relative 'abstract_table_format_strategy'
+require_relative 'csv_table_format_strategy'
+
 module GrafanaReporter
   # @abstract Override {#pre_process} and {#post_process} in subclass.
   #
@@ -89,6 +92,7 @@ module GrafanaReporter
       end
 
       raise DatasourceRequestInvalidReturnValueError.new(@datasource, @result) unless datasource_response_valid?
+
       post_process
       @result
     end
@@ -216,7 +220,6 @@ module GrafanaReporter
     # @param result [Hash] preformatted query result (see {Grafana::AbstractDatasource#request}.
     # @param configs [Array<Grafana::Variable>] one variable for replacing values in one column
     # @return [Hash] query result with replaced values
-    # TODO: make sure that caught errors are also visible in logger
     def replace_values(result, configs)
       return result if configs.empty?
 
@@ -231,8 +234,11 @@ module GrafanaReporter
 
           k = arr[0]
           v = arr[1]
-          k.gsub!(/\\([:,])/, '\1')
-          v.gsub!(/\\([:,])/, '\1')
+
+          # allow keys and values to contain escaped colons or commas
+          k = k.gsub(/\\([:,])/, '\1')
+          v = v.gsub(/\\([:,])/, '\1')
+
           result[:content].map do |row|
             (row.length - 1).downto 0 do |i|
               if cols.include?(i + 1) || cols.empty?
@@ -267,6 +273,7 @@ module GrafanaReporter
                                  end
                       end
                     rescue StandardError => e
+                      @grafana.logger.error(e.message)
                       row[i] = e.message
                     end
                   end
@@ -284,22 +291,32 @@ module GrafanaReporter
       result
     end
 
-    # Used to build a output format matching the requested report format.
+    # Used to build a table output in a custom format.
     # @param result [Hash] preformatted sql hash, (see {Grafana::AbstractDatasource#request})
     # @param opts [Hash] options for the formatting:
-    # @option opts [Grafana::Variable] :row_divider requested row divider for the result table
-    # @option opts [Grafana::Variable] :column_divider requested row divider for the result table
-    # @option opts [Regex or String] :escape_regex regular expression which specifies a part of a cell content, which has to be escaped
-    # @option opts [String] :escape_replacement specifies how the found :escape_regex shall be replaced
-    # @return [String] formatted table result in requested output format
+    # @option opts [Grafana::Variable] :row_divider requested row divider for the result table, only to be used with table_formatter `adoc_deprecated`
+    # @option opts [Grafana::Variable] :column_divider requested row divider for the result table, only to be used with table_formatter `adoc_deprecated`
+    # @option opts [Grafana::Variable] :include_headline specifies if table should contain headline, defaults to false
+    # @option opts [Grafana::Variable] :table_formatter specifies which formatter shall be used, defaults to 'csv'
+    # @return [String] table in custom output format
     def format_table_output(result, opts)
-      opts = { escape_regex: '|', escape_replacement: '\\|', row_divider: Grafana::Variable.new('| '), column_divider: Grafana::Variable.new(' | ') }.merge(opts.delete_if {|_k, v| v.nil? })
-
-      result[:content].map do |row|
-        opts[:row_divider].raw_value + row.map do |item|
-          item.to_s.gsub(opts[:escape_regex], opts[:escape_replacement])
-        end.join(opts[:column_divider].raw_value)
+      opts = { include_headline: Grafana::Variable.new('false'),
+               table_formatter: Grafana::Variable.new('csv'),
+               row_divider: Grafana::Variable.new('| '),
+               column_divider: Grafana::Variable.new(' | ') }.merge(opts.delete_if {|_k, v| v.nil? })
+
+      if opts[:table_formatter].raw_value == 'adoc_deprecated'
+        @grafana.logger.warn("You are using deprecated 'table_formatter' named 'adoc_deprecated', which will be "\
+                             "removed in a future version. Start using 'adoc' or register your own implementation "\
+                             "of AbstractTableFormatStrategy.")
+        return result[:content].map do |row|
+          opts[:row_divider].raw_value + row.map do |item|
+            item.to_s.gsub('|', '\\|')
+          end.join(opts[:column_divider].raw_value)
+        end
       end
+
+      AbstractTableFormatStrategy.get(opts[:table_formatter].raw_value).format(result, opts[:include_headline].raw_value.downcase == 'true')
     end
 
     # Used to translate the relative date strings used by grafana, e.g. +now-5d/w+ to the
@@ -317,9 +334,10 @@ module GrafanaReporter
     # @param timezone [Grafana::Variable] timezone to use, if not system timezone
     # @return [String] translated date as timestamp string
     def translate_date(orig_date, report_time, is_to_time, timezone = nil)
-      # TODO: add test case for creation of variable, if not given, maybe also print a warning
+      @grafana.logger.warn("#translate_date has been called without 'report_time' - using current time as fallback.") unless report_time
       report_time ||= ::Grafana::Variable.new(Time.now.to_s)
       orig_date = orig_date.raw_value if orig_date.is_a?(Grafana::Variable)
+
       return (DateTime.parse(report_time.raw_value).to_time.to_i * 1000).to_s unless orig_date
       return orig_date if orig_date =~ /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$/
       return orig_date if orig_date =~ /^\d+$/
@@ -387,10 +405,10 @@ module GrafanaReporter
     def datasource_response_valid?
       return false if @result.nil?
       return false unless @result.is_a?(Hash)
-      # TODO: check if it should be ok if a datasource request returns an empty hash only
+      # TODO: compare how empty valid responses look like in grafana
       return true if @result.empty?
-      return false unless @result.has_key?(:header)
-      return false unless @result.has_key?(:content)
+      return false unless @result.key?(:header)
+      return false unless @result.key?(:content)
       return false unless @result[:header].is_a?(Array)
       return false unless @result[:content].is_a?(Array)
 

data/lib/grafana_reporter/abstract_report.rb

@@ -126,7 +126,7 @@ module GrafanaReporter
 
     # Is being called to start the report generation. To execute the specific report generation, this function
     # calls the abstract {#build} method with the given parameters.
-    # @param template [String] path to the template to be used, trailing +.adoc+ extension may be omitted
+    # @param template [String] path to the template to be used, trailing extension may be omitted, whereas {#default_template_extension} will be appended
     # @param destination_file_or_path [String or File] path to the destination report or file object to use
     # @param custom_attributes [Hash] custom attributes, which shall be merged with priority over the configuration
     # @return [void]
@@ -136,14 +136,14 @@ module GrafanaReporter
       @destination_file_or_path = destination_file_or_path
       @custom_attributes = custom_attributes
 
-      # automatically add extension, if a file with adoc extension exists
-      @template = "#{@template}.adoc" if File.file?("#{@template}.adoc") && !File.file?(@template.to_s)
+      # automatically add extension, if a file with default template extension exists
+      @template = "#{@template}.#{self.class.default_template_extension}" if File.file?("#{@template}.#{self.class.default_template_extension}") && !File.file?(@template.to_s)
       raise MissingTemplateError, @template.to_s unless File.file?(@template.to_s)
 
       notify(:on_before_create)
       @start_time = Time.new
       logger.info("Report started at #{@start_time}")
-      build(template, destination_file_or_path, custom_attributes)
+      build
     rescue MissingTemplateError => e
       @logger.error(e.message)
       @error = [e.message]
@@ -186,6 +186,18 @@ module GrafanaReporter
       raise NotImplementedError
     end
 
+    # @abstract
+    # @return [String] specifying the default extension of a template file
+    def self.default_template_extension
+      raise NotImplementedError
+    end
+
+    # @abstract
+    # @return [String] specifying the default extension of a rendered result file
+    def self.default_result_extension
+      raise NotImplementedError
+    end
+
     private
 
     # Called, if the report generation has died with an error.
@@ -207,6 +219,7 @@ module GrafanaReporter
     def done!
       return if @done
 
+      @destination_file_or_path.close if @destination_file_or_path.is_a?(File)
       @done = true
       @end_time = Time.new
       @start_time ||= @end_time

data/lib/grafana_reporter/abstract_table_format_strategy.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module GrafanaReporter
+  # The abstract base class, which is to be implemented for different table
+  # output formats. By implementing this class, you e.g. can decide if a table
+  # will be formatted as CSV, JSON or any other format.
+  class AbstractTableFormatStrategy
+    @@subclasses = []
+
+    def self.inherited(obj)
+      @@subclasses << obj
+    end
+
+    # @param abbreviation [String] name of the requested table format strategy
+    # @return [AbstractTableFormatStrategy] fitting strategy instance for the given name
+    def self.get(abbreviation)
+      @@subclasses.select { |item| item.abbreviation == abbreviation }.first.new
+    end
+
+    # @abstract
+    # @return [String] short name of the current stategy, under which it shall be accessible
+    def self.abbreviation
+      raise NotImplementedError
+    end
+
+    # @abstract
+    # @param column [Array] datasource table result
+    # @param include_headline [Boolean] true, if headline should be included in result
+    # @return [String] formatted in table format
+    def format(content, include_headline)
+      raise NotImplementedError
+    end
+  end
+end