ruby-grafana-reporter 0.4.1 → 0.4.2

data/lib/grafana_reporter/abstract_report.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module GrafanaReporter
-  # @abstract Override {#create_report} and {#progress}.
+  # @abstract Override {#build} and {#progress}.
   #
   # This class is used to build a report on basis of a given configuration and
   # template.
@@ -124,7 +124,8 @@ module GrafanaReporter
       logger.internal_messages
     end
 
-    # Is being called to start the report generation.
+    # 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 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
@@ -142,6 +143,24 @@ module GrafanaReporter
       notify(:on_before_create)
       @start_time = Time.new
       logger.info("Report started at #{@start_time}")
+      build(template, destination_file_or_path, custom_attributes)
+    rescue MissingTemplateError => e
+      @logger.error(e.message)
+      @error = [e.message]
+      done!
+      raise e
+    rescue StandardError => e
+      # catch all errors during execution
+      died_with_error(e)
+      raise e
+    ensure
+      done!
+    end
+
+    # @abstract
+    # Needs to be overridden by the report implementation.
+    def build(template, destination_file_or_path, custom_attributes)
+      raise NotImplementedError
     end
 
     # Used to calculate the progress of a report. By default expects +@total_steps+ to contain the total

data/lib/grafana_reporter/alerts_table_query.rb

@@ -19,10 +19,6 @@ module GrafanaReporter
     def pre_process
       raise MissingMandatoryAttributeError, 'columns' unless @raw_query['columns']
 
-      @from = translate_date(@from, @variables['grafana_report_timestamp'], false, @variables['from_timezone'] ||
-                             @variables['grafana_default_from_timezone'])
-      @to = translate_date(@to, @variables['grafana_report_timestamp'], true, @variables['to_timezone'] ||
-                           @variables['grafana_default_to_timezone'])
       @datasource = Grafana::GrafanaAlertsDatasource.new(nil)
     end
 
@@ -37,8 +33,7 @@ module GrafanaReporter
       @result = replace_values(@result, @variables.select { |k, _v| k =~ /^replace_values_\d+/ })
       @result = filter_columns(@result, @variables['filter_columns'])
 
-      # TODO: move formatting to Asciidoctor namespace
-      @result = @result[:content].map { |row| "| #{row.map { |item| item.to_s.gsub('|', '\\|') }.join(' | ')}" }
+      @result = format_table_output(@result, row_divider: @variables['row_divider'], column_divider: @variables['column_divider'])
     end
   end
 end

data/lib/grafana_reporter/annotations_table_query.rb

@@ -18,10 +18,6 @@ module GrafanaReporter
     def pre_process
       raise MissingMandatoryAttributeError, 'columns' unless @raw_query['columns']
 
-      @from = translate_date(@from, @variables['grafana_report_timestamp'], false, @variables['from_timezone'] ||
-                             @variables['grafana_default_from_timezone'])
-      @to = translate_date(@to, @variables['grafana_report_timestamp'], true, @variables['to_timezone'] ||
-                           @variables['grafana_default_to_timezone'])
       @datasource = Grafana::GrafanaAnnotationsDatasource.new(nil)
     end
 
@@ -36,8 +32,7 @@ module GrafanaReporter
       @result = replace_values(@result, @variables.select { |k, _v| k =~ /^replace_values_\d+/ })
       @result = filter_columns(@result, @variables['filter_columns'])
 
-      # TODO: move formatting to Asciidoctor namespace
-      @result = result[:content].map { |row| "| #{row.map { |item| item.to_s.gsub('|', '\\|') }.join(' | ')}" }
+      @result = format_table_output(@result, row_divider: @variables['row_divider'], column_divider: @variables['column_divider'])
     end
   end
 end

data/lib/grafana_reporter/application/webservice.rb

@@ -84,7 +84,7 @@ module GrafanaReporter
             @logger.debug(e.message)
             socket.write http_response(404, '', e.message)
           rescue WebserviceGeneralRenderingError => e
-            @logger.fatal(e.message)
+            @logger.error(e.message)
             socket.write http_response(400, 'Bad Request', e.message)
           rescue StandardError => e
             @logger.fatal(e.message)

data/lib/grafana_reporter/asciidoctor/alerts_table_include_processor.rb

@@ -55,18 +55,19 @@ module GrafanaReporter
         @report.logger.debug("Processing AlertsTableIncludeProcessor (instance: #{instance},"\
                              " dashboard: #{dashboard_id}, panel: #{panel_id})")
 
-        query = AlertsTableQuery.new(@report.grafana(instance))
-        assign_dashboard_defaults(query, @report.grafana(instance).dashboard(dashboard_id)) if dashboard_id
+        grafana_obj = @report.grafana(instance)
+        grafana_obj = @report.grafana(instance).dashboard(dashboard_id) if dashboard_id
+        grafana_obj = grafana_obj.panel(panel_id) if panel_id
+
+        query = AlertsTableQuery.new(grafana_obj, variables: build_attribute_hash(doc.attributes, attrs))
         defaults = {}
         defaults['dashboardId'] = dashboard_id if dashboard_id
         defaults['panelId'] = panel_id if panel_id
 
-        assign_doc_and_item_variables(query, doc.attributes, attrs)
         selected_attrs = attrs.select do |k, _v|
           k =~ /(?:columns|limit|folderId|dashboardId|panelId|dahboardTag|dashboardQuery|state|query)/x
         end
         query.raw_query = defaults.merge(selected_attrs.each_with_object({}) { |(k, v), h| h[k] = v })
-        @report.logger.debug("from: #{query.from}, to: #{query.to}")
 
         begin
           reader.unshift_lines query.execute

data/lib/grafana_reporter/asciidoctor/annotations_table_include_processor.rb

@@ -54,18 +54,19 @@ module GrafanaReporter
         panel_id = attrs['panel']
         @report.logger.debug("Processing AnnotationsTableIncludeProcessor (instance: #{instance})")
 
-        query = AnnotationsTableQuery.new(@report.grafana(instance))
-        assign_dashboard_defaults(query, @report.grafana(instance).dashboard(dashboard_id)) if dashboard_id
+        grafana_obj = @report.grafana(instance)
+        grafana_obj = @report.grafana(instance).dashboard(dashboard_id) if dashboard_id
+        grafana_obj = grafana_obj.panel(panel_id) if panel_id
+
+        query = AnnotationsTableQuery.new(grafana_obj, variables: build_attribute_hash(doc.attributes, attrs))
         defaults = {}
         defaults['dashboardId'] = dashboard_id if dashboard_id
         defaults['panelId'] = panel_id if panel_id
 
-        assign_doc_and_item_variables(query, doc.attributes, attrs)
         selected_attrs = attrs.select do |k, _v|
           k =~ /(?:columns|limit|alertId|dashboardId|panelId|userId|type|tags)/
         end
         query.raw_query = defaults.merge(selected_attrs.each_with_object({}) { |(k, v), h| h[k] = v })
-        @report.logger.debug("from: #{query.from}, to: #{query.to}")
 
         begin
           reader.unshift_lines query.execute

data/lib/grafana_reporter/asciidoctor/panel_image_block_macro.rb

@@ -46,10 +46,7 @@ module GrafanaReporter
                              " panel: #{target})")
 
         begin
-          query = PanelImageQuery.new(@report.grafana(instance).dashboard(dashboard).panel(target))
-          assign_dashboard_defaults(query, @report.grafana(instance).dashboard(dashboard))
-          assign_doc_and_item_variables(query, parent.document.attributes, attrs)
-          @report.logger.debug("from: #{query.from}, to: #{query.to}")
+          query = PanelImageQuery.new(@report.grafana(instance).dashboard(dashboard).panel(target), variables: build_attribute_hash(parent.document.attributes, attrs))
 
           image = query.execute
           image_path = @report.save_image_file(image)

data/lib/grafana_reporter/asciidoctor/panel_image_inline_macro.rb

@@ -46,12 +46,9 @@ module GrafanaReporter
                              " panel: #{target})")
 
         begin
-          query = PanelImageQuery.new(@report.grafana(instance).dashboard(dashboard).panel(target))
           # set alt text to a default, because otherwise asciidoctor fails
           attrs['alt'] = '' unless attrs['alt']
-          assign_dashboard_defaults(query, @report.grafana(instance).dashboard(dashboard))
-          assign_doc_and_item_variables(query, parent.document.attributes, attrs)
-          @report.logger.debug("from: #{query.from}, to: #{query.to}")
+          query = PanelImageQuery.new(@report.grafana(instance).dashboard(dashboard).panel(target), variables: build_attribute_hash(parent.document.attributes, attrs))
 
           image = query.execute
           image_path = @report.save_image_file(image)

data/lib/grafana_reporter/asciidoctor/panel_property_inline_macro.rb

@@ -38,11 +38,8 @@ module GrafanaReporter
                              " panel: #{target}, property: #{attrs[:field]})")
 
         begin
-          query = PanelPropertyQuery.new(@report.grafana(instance).dashboard(dashboard).panel(target))
+          query = PanelPropertyQuery.new(@report.grafana(instance).dashboard(dashboard).panel(target), variables: build_attribute_hash(parent.document.attributes, attrs))
           query.raw_query = { property_name: attrs[:field] }
-          assign_dashboard_defaults(query, @report.grafana(instance).dashboard(dashboard))
-          assign_doc_and_item_variables(query, parent.document.attributes, attrs)
-          @report.logger.debug("from: #{query.from}, to: #{query.to}")
 
           description = query.execute
         rescue GrafanaReporterError => e

data/lib/grafana_reporter/asciidoctor/panel_query_table_include_processor.rb

@@ -51,7 +51,6 @@ module GrafanaReporter
 
         @report.next_step
         panel_id = target.split(':')[1]
-        # TODO: check if instance and dashboard shouldn't be set in assign_doc_and_item_variables method
         instance = attrs['instance'] || doc.attr('grafana_default_instance') || 'default'
         dashboard = attrs['dashboard'] || doc.attr('grafana_default_dashboard')
         attrs['result_type'] = 'panel_table'
@@ -60,10 +59,7 @@ module GrafanaReporter
 
         begin
           panel = @report.grafana(instance).dashboard(dashboard).panel(panel_id)
-          query = QueryValueQuery.new(panel)
-          assign_dashboard_defaults(query, panel.dashboard)
-          assign_doc_and_item_variables(query, doc.attributes, attrs)
-          @report.logger.debug("from: #{query.from}, to: #{query.to}")
+          query = QueryValueQuery.new(panel, variables: build_attribute_hash(doc.attributes, attrs))
 
           reader.unshift_lines query.execute
         rescue GrafanaReporterError => e

data/lib/grafana_reporter/asciidoctor/panel_query_value_inline_macro.rb

@@ -56,10 +56,7 @@ module GrafanaReporter
 
         begin
           panel = @report.grafana(instance).dashboard(dashboard).panel(target)
-          query = QueryValueQuery.new(panel)
-          assign_dashboard_defaults(query, panel.dashboard)
-          assign_doc_and_item_variables(query, parent.document.attributes, attrs)
-          @report.logger.debug("from: #{query.from}, to: #{query.to}")
+          query = QueryValueQuery.new(panel, variables: build_attribute_hash(parent.document.attributes, attrs))
 
           create_inline(parent, :quoted, query.execute)
         rescue GrafanaReporterError => e

data/lib/grafana_reporter/asciidoctor/processor_mixin.rb

@@ -19,45 +19,30 @@ module GrafanaReporter
         raise NotImplementedError
       end
 
-      # Sets default configurations from the given {Grafana::Dashboard} and store them as settings in the
-      # {AbstractQuery}.
-      #
-      # Following data is extracted:
-      # - +from+, by {Grafana::Dashboard#from_time}
-      # - +to+, by {Grafana::Dashboard#to_time}
-      # - and all variables as {Grafana::Variable}, prefixed with +var-+, as grafana also does it
-      # @param query [AbstractQuery] query object, for which the defaults are set
-      # @param dashboard [Grafana::Dashboard] dashboard from which the defaults are captured
-      # TODO: assign_dashboard_defaults is a common method for all report classes - move it to a public place
-      def assign_dashboard_defaults(query, dashboard)
-        query.from = dashboard.from_time
-        query.to = dashboard.to_time
-        dashboard.variables.each { |item| query.assign_variable("var-#{item.name}", item) }
-      end
-
-      # Merges the given hashes to the given query object. It respects the priorities of the hashes and the
-      # object and allows only valid variables to be passed.
-      # @param query [AbstractQuery] query object, for which the defaults are set
+      # Merges the given hashes to a common attribute Hash. It respects the priorities of the hashes and the
+      # object and allows only valid variables to be used.
       # @param document_hash [Hash] variables from report template level
       # @param item_hash [Hash] variables from item configuration level, i.e. specific call, which may override document
-      # @return [void]
-      def assign_doc_and_item_variables(query, document_hash, item_hash)
-        sel_doc_items = document_hash.select do |k, _v|
-          k =~ /^var-/ || k =~ /grafana_default_(?:from|to)_timezone/
-        end
-        sel_doc_items.each { |k, v| query.assign_variable(k, ::Grafana::Variable.new(v)) }
-        query.assign_variable('grafana_report_timestamp', ::Grafana::Variable.new(document_hash['localdatetime']))
+      # @return [Hash] containing accepted variable names including values
+      def build_attribute_hash(document_hash, item_hash)
+        result = {}
+
+        result['grafana_report_timestamp'] = document_hash['localdatetime']
+        result.merge!(document_hash.select do |k, _v|
+          k =~ /^var-/ ||
+          k =~ /^(?:from|to)$/ ||
+          k =~ /^grafana_default_(?:from_timezone|to_timezone|timeout)$/
+        end)
 
-        sel_items = item_hash.select do |k, _v|
-          # TODO: specify accepted options in each class or check if simply all can be allowed with prefix +var-+
-          k =~ /^var-/ || k =~ /^render-/ || k =~ /filter_columns|format|replace_values_.*|transpose|column_divider|
-                                                   row_divider|from_timezone|to_timezone|result_type|query/x
-        end
-        sel_items.each { |k, v| query.assign_variable(k, ::Grafana::Variable.new(v)) }
+        result.merge!(item_hash.select do |k, _v|
+          # TODO: specify accepted options for each processor class individually
+          k =~ /^(?:var-|render-)/ ||
+          k =~ /^(?:timeout|from|to)$/ ||
+          k =~ /filter_columns|format|replace_values_.*|transpose|column_divider|
+               row_divider|from_timezone|to_timezone|result_type|query/x
+        end)
 
-        query.timeout = item_hash['timeout'] || document_hash['grafana-default-timeout'] || query.timeout
-        query.from = item_hash['from'] || document_hash['from'] || query.from
-        query.to = item_hash['to'] || document_hash['to'] || query.to
+        result
       end
     end
   end

data/lib/grafana_reporter/asciidoctor/report.rb

@@ -14,9 +14,8 @@ module GrafanaReporter
 
       # Starts to create an asciidoctor report. It utilizes all extensions in the {GrafanaReporter::Asciidoctor}
       # namespace to realize the conversion.
-      # @see AbstractReport#create_report
-      def create_report(template, destination_file_or_path = nil, custom_attributes = {})
-        super
+      # @see AbstractReport#build
+      def build(template, destination_file_or_path, custom_attributes)
         attrs = { 'convert-backend' => 'pdf' }.merge(@config.default_document_attributes.merge(@custom_attributes))
         logger.debug("Document attributes: #{attrs}")
 
@@ -83,17 +82,6 @@ module GrafanaReporter
         end
 
         clean_image_files
-      rescue MissingTemplateError => e
-        @logger.error(e.message)
-        @error = [e.message]
-        done!
-        raise e
-      rescue StandardError => e
-        # catch all errors during execution
-        died_with_error(e)
-        raise e
-      ensure
-        done!
       end
 
       # Called to save a temporary image file. After the final generation of the

data/lib/grafana_reporter/asciidoctor/sql_table_include_processor.rb

@@ -51,11 +51,9 @@ module GrafanaReporter
 
         begin
           # catch properly if datasource could not be identified
-          query = QueryValueQuery.new(@report.grafana(instance))
+          query = QueryValueQuery.new(@report.grafana(instance), variables: build_attribute_hash(doc.attributes, attrs))
           query.datasource = @report.grafana(instance).datasource_by_id(target.split(':')[1].to_i)
           query.raw_query = attrs['sql']
-          assign_doc_and_item_variables(query, doc.attributes, attrs)
-          @report.logger.debug("from: #{query.from}, to: #{query.to}")
 
           reader.unshift_lines query.execute
         rescue GrafanaReporterError => e

data/lib/grafana_reporter/asciidoctor/sql_value_inline_macro.rb

@@ -49,11 +49,9 @@ module GrafanaReporter
 
         begin
           # catch properly if datasource could not be identified
-          query = QueryValueQuery.new(@report.grafana(instance))
+          query = QueryValueQuery.new(@report.grafana(instance), variables: build_attribute_hash(parent.document.attributes, attrs))
           query.datasource = @report.grafana(instance).datasource_by_id(target)
           query.raw_query = attrs['sql']
-          assign_doc_and_item_variables(query, parent.document.attributes, attrs)
-          @report.logger.debug("from: #{query.from}, to: #{query.to}")
 
           create_inline(parent, :quoted, query.execute)
         rescue GrafanaReporterError => e

data/lib/grafana_reporter/demo_report_wizard.rb

@@ -55,7 +55,11 @@ module GrafanaReporter
       results = {}
 
       dashboard.panels.shuffle.each do |panel|
-        next if panel.datasource.is_a?(Grafana::UnsupportedDatasource)
+        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)

data/lib/grafana_reporter/erb/report.rb

@@ -9,29 +9,16 @@ module GrafanaReporter
     class Report < ::GrafanaReporter::AbstractReport
       # Starts to create an asciidoctor report. It utilizes all extensions in the {GrafanaReporter::Asciidoctor}
       # namespace to realize the conversion.
-      # @see AbstractReport#create_report
-      def create_report(template, destination_file_or_path = nil, custom_attributes = {})
-        super
+      # @see AbstractReport#build
+      def build(template, destination_file_or_path, custom_attributes)
         attrs = @config.default_document_attributes.merge(@custom_attributes)
         logger.debug("Document attributes: #{attrs}")
 
         # TODO: if path is true, a default filename has to be generated. check if this should be a general function instead
-        @report = self
-        File.write(path, ::ERB.new(File.read(template)).result(binding))
+        File.write(path, ::ERB.new(File.read(template)).result(ReportJail.new(self, attrs).bind))
 
         # TODO: check if closing output file is correct here, or maybe can be moved to AbstractReport.done!
         @destination_file_or_path.close if @destination_file_or_path.is_a?(File)
-      rescue MissingTemplateError => e
-        @logger.error(e.message)
-        @error = [e.message]
-        done!
-        raise e
-      rescue StandardError => e
-        # catch all errors during execution
-        died_with_error(e)
-        raise e
-      ensure
-        done!
       end
 
       # @see AbstractReport#demo_report_classes

data/lib/grafana_reporter/erb/report_jail.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module GrafanaReporter
+  module ERB
+    # An instance of this class is used as binding for the ERB execution, i.e.
+    # this class contains everything known within the ERB template
+    class ReportJail
+      attr_reader :report, :attributes
+
+      def initialize(report, attributes)
+        @report = report
+        @attributes = attributes
+      end
+
+      # @return binding to this object
+      def bind
+        binding
+      end
+    end
+  end
+end

data/lib/grafana_reporter/errors.rb

@@ -16,6 +16,20 @@ module GrafanaReporter
     end
   end
 
+  # Raised if some unhandled exception is raised during a datasource request execution.
+  class DatasourceRequestInternalError < GrafanaReporterError
+    def initialize(ds, message)
+      super("The datasource request to '#{ds.name}' (#{ds.class}) failed with an internal error: #{message}")
+    end
+  end
+
+  # Raised if the return value of a datasource request does not match the expected return hash.
+  class DatasourceRequestInvalidReturnValueError < GrafanaReporterError
+    def initialize(ds, message)
+      super("The datasource request to '#{ds.name}' (#{ds.class}) returned an invalid value: '#{message}'")
+    end
+  end
+
   # Thrown, if the requested grafana instance does not have the mandatory 'host'
   # setting configured.
   class GrafanaInstanceWithoutHostError < GrafanaReporterError

data/lib/grafana_reporter/help.rb

@@ -5,6 +5,7 @@ require 'yaml'
 module GrafanaReporter
   # This class generates the functional help documentation for the reporter.
   # It can create the documentation for github markdown, as well as in asciidoctor.
+  # TODO: this help is limited to Asciidoctor - move it to that namespace
   class Help
     # @param headline_level [Integer] top level of headline
     # @return [String] asciidoctor compatible documentation
@@ -129,7 +130,6 @@ end}
       result
     end
 
-    # TODO: use same wording/grouping as in README file
     def raw_help_yaml
       <<~YAML_HELP
         global_options:
@@ -236,7 +236,7 @@ end}
           timeout:
             call: timeout="<timeout_in_seconds>"
             description: >-
-              Set a timeout for the current query. If not overridden with `grafana-default-timeout` in the report template,
+              Set a timeout for the current query. If not overridden with `grafana_default_timeout` in the report template,
               this defaults to 60 seconds.
 
         # ----------------------------------