ruby-grafana-reporter 0.4.3 → 0.4.4

data/lib/grafana_reporter/asciidoctor/panel_image_block_macro.rb

@@ -46,10 +46,14 @@ module GrafanaReporter
                              " panel: #{target})")
 
         begin
-          query = PanelImageQuery.new(@report.grafana(instance).dashboard(dashboard).panel(target), variables: build_attribute_hash(parent.document.attributes, attrs))
+          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)
+        rescue GrafanaError => e
+          @report.logger.error(e.message)
+          return create_paragraph(parent, e.message, attrs)
         rescue GrafanaReporterError => e
           @report.logger.error(e.message)
           return create_paragraph(parent, e.message, attrs)

data/lib/grafana_reporter/asciidoctor/panel_image_inline_macro.rb

@@ -48,10 +48,14 @@ module GrafanaReporter
         begin
           # set alt text to a default, because otherwise asciidoctor fails
           attrs['alt'] = '' unless attrs['alt']
-          query = PanelImageQuery.new(@report.grafana(instance).dashboard(dashboard).panel(target), variables: build_attribute_hash(parent.document.attributes, attrs))
+          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)
+        rescue GrafanaError => e
+          @report.logger.error(e.message)
+          return create_inline(parent, :quoted, e.message)
         rescue GrafanaReporterError => e
           @report.logger.error(e.message)
           return create_inline(parent, :quoted, e.message)

data/lib/grafana_reporter/asciidoctor/panel_property_inline_macro.rb

@@ -38,10 +38,14 @@ module GrafanaReporter
                              " panel: #{target}, property: #{attrs[:field]})")
 
         begin
-          query = PanelPropertyQuery.new(@report.grafana(instance).dashboard(dashboard).panel(target), variables: build_attribute_hash(parent.document.attributes, attrs))
+          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] }
 
           description = query.execute
+        rescue GrafanaError => e
+          @report.logger.error(e.message)
+          return create_inline(parent, :quoted, e.message)
         rescue GrafanaReporterError => e
           @report.logger.error(e.message)
           return create_inline(parent, :quoted, e.message)

data/lib/grafana_reporter/asciidoctor/panel_query_table_include_processor.rb

@@ -59,9 +59,13 @@ module GrafanaReporter
 
         begin
           panel = @report.grafana(instance).dashboard(dashboard).panel(panel_id)
-          query = QueryValueQuery.new(panel, variables: build_attribute_hash(doc.attributes, attrs))
+          vars = { 'table_formatter' => 'adoc_plain' }.merge(build_attribute_hash(doc.attributes, attrs))
+          query = QueryValueQuery.new(panel, variables: vars)
 
           reader.unshift_lines query.execute
+        rescue GrafanaError => e
+          @report.logger.error(e.message)
+          reader.unshift_line "|#{e.message}"
         rescue GrafanaReporterError => e
           @report.logger.error(e.message)
           reader.unshift_line "|#{e.message}"

data/lib/grafana_reporter/asciidoctor/panel_query_value_inline_macro.rb

@@ -59,6 +59,9 @@ module GrafanaReporter
           query = QueryValueQuery.new(panel, variables: build_attribute_hash(parent.document.attributes, attrs))
 
           create_inline(parent, :quoted, query.execute)
+        rescue GrafanaError => e
+          @report.logger.error(e.message)
+          create_inline(parent, :quoted, e.message)
         rescue GrafanaReporterError => e
           @report.logger.error(e.message)
           create_inline(parent, :quoted, e.message)

data/lib/grafana_reporter/asciidoctor/processor_mixin.rb

@@ -38,8 +38,9 @@ module GrafanaReporter
           # 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
+          k =~ /filter_columns|format|replace_values_.*|transpose|from_timezone|
+               to_timezone|result_type|query|table_formatter|include_headline|
+               column_divider|row_divider/x
         end)
 
         result

data/lib/grafana_reporter/asciidoctor/report.rb

@@ -15,7 +15,7 @@ module GrafanaReporter
       # Starts to create an asciidoctor report. It utilizes all extensions in the {GrafanaReporter::Asciidoctor}
       # namespace to realize the conversion.
       # @see AbstractReport#build
-      def build(template, destination_file_or_path, custom_attributes)
+      def build
         attrs = { 'convert-backend' => 'pdf' }.merge(@config.default_document_attributes.merge(@custom_attributes))
         logger.debug("Document attributes: #{attrs}")
 
@@ -41,22 +41,14 @@ module GrafanaReporter
         ::Asciidoctor.convert_file(@template, extension_registry: registry, backend: attrs['convert-backend'],
                                               to_file: path, attributes: attrs, header_footer: true)
 
-        @destination_file_or_path.close if @destination_file_or_path.is_a?(File)
-
         # store report including als images as ZIP file, if the result is not a PDF
         if attrs['convert-backend'] != 'pdf'
-          dest_path = if @destination_file_or_path.is_a?(File) || @destination_file_or_path.is_a?(Tempfile)
-                        @destination_file_or_path.path
-                      else
-                        @destination_file_or_path
-                      end
-
           # build zip file
           zip_file = Tempfile.new('gf_zip')
           buffer = Zip::OutputStream.write_buffer do |zipfile|
             # add report file
-            zipfile.put_next_entry("#{dest_path.gsub(@config.reports_folder, '')}.#{attrs['convert-backend']}")
-            zipfile.write File.read(dest_path)
+            zipfile.put_next_entry("#{path.gsub(@config.reports_folder, '')}.#{attrs['convert-backend']}")
+            zipfile.write File.read(path)
 
             # add image files
             @image_files.each do |file|
@@ -71,9 +63,9 @@ module GrafanaReporter
           # replace original file with zip file
           zip_file.rewind
           begin
-            File.write(dest_path, zip_file.read)
+            File.write(path, zip_file.read)
           rescue StandardError => e
-            logger.fatal("Could not overwrite report file '#{dest_path}' with ZIP file. (#{e.message}).")
+            logger.fatal("Could not overwrite report file '#{path}' with ZIP file. (#{e.message}).")
           end
 
           # cleanup temporary zip file
@@ -100,6 +92,16 @@ module GrafanaReporter
         path
       end
 
+      # @see AbstractReport#default_template_extension
+      def self.default_template_extension
+        'adoc'
+      end
+
+      # @see AbstractReport#default_result_extension
+      def self.default_result_extension
+        'pdf'
+      end
+
       # @see AbstractReport#demo_report_classes
       def self.demo_report_classes
         [AlertsTableIncludeProcessor, AnnotationsTableIncludeProcessor, PanelImageBlockMacro, PanelImageInlineMacro,

data/lib/grafana_reporter/asciidoctor/show_help_include_processor.rb

@@ -23,7 +23,7 @@ module GrafanaReporter
         @report.next_step
         @report.logger.debug('Processing ShowHelpIncludeProcessor')
 
-        reader.unshift_lines GrafanaReporter::Help.new.asciidoctor.split("\n")
+        reader.unshift_lines Help.new.asciidoctor.split("\n")
       end
 
       # @see ProcessorMixin#build_demo_entry

data/lib/grafana_reporter/asciidoctor/sql_table_include_processor.rb

@@ -51,11 +51,15 @@ module GrafanaReporter
 
         begin
           # catch properly if datasource could not be identified
-          query = QueryValueQuery.new(@report.grafana(instance), variables: build_attribute_hash(doc.attributes, attrs))
+          vars = { 'table_formatter' => 'adoc_plain' }.merge(build_attribute_hash(doc.attributes, attrs))
+          query = QueryValueQuery.new(@report.grafana(instance), variables: vars)
           query.datasource = @report.grafana(instance).datasource_by_id(target.split(':')[1].to_i)
           query.raw_query = attrs['sql']
 
           reader.unshift_lines query.execute
+        rescue GrafanaError => e
+          @report.logger.error(e.message)
+          reader.unshift_line "|#{e.message}"
         rescue GrafanaReporterError => e
           @report.logger.error(e.message)
           reader.unshift_line "|#{e.message}"

data/lib/grafana_reporter/asciidoctor/sql_value_inline_macro.rb

@@ -49,11 +49,15 @@ module GrafanaReporter
 
         begin
           # catch properly if datasource could not be identified
-          query = QueryValueQuery.new(@report.grafana(instance), variables: build_attribute_hash(parent.document.attributes, attrs))
+          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']
 
           create_inline(parent, :quoted, query.execute)
+        rescue GrafanaError => e
+          @report.logger.error(e.message)
+          create_inline(parent, :quoted, e.message)
         rescue GrafanaReporterError => e
           @report.logger.error(e.message)
           create_inline(parent, :quoted, e.message)

data/lib/grafana_reporter/console_configuration_wizard.rb

@@ -39,7 +39,7 @@ module GrafanaReporter
       puts 'Now everything is setup properly. Create your reports as required in the templates '\
            'folder and run the reporter either standalone with e.g. the following command:'
       puts
-      puts "   #{program_call}#{config_param} -t #{demo_report} -o demo_report_with_help.pdf"
+      puts "   #{program_call}#{config_param} -t #{demo_report} -o demo_report.#{config.report_class.default_result_extension}"
       puts
       puts 'or run it as a service using the following command:'
       puts
@@ -120,7 +120,7 @@ default-document-attributes:
       return nil unless create =~ /^(?:y|Y)$/
 
       demo_report = 'demo_report'
-      demo_report_file = "#{config.templates_folder}#{demo_report}.adoc"
+      demo_report_file = "#{config.templates_folder}#{demo_report}.#{config.report_class.default_template_extension}"
 
       # ask to overwrite file
       if File.exist?(demo_report_file)

data/lib/grafana_reporter/csv_table_format_strategy.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module GrafanaReporter
+  # Implements a default table format strategy, which will return tables
+  # as CSV formatted strings.
+  class CsvTableFormatStrategy < AbstractTableFormatStrategy
+    # @see AbstractTableFormatStrategy#abbreviation
+    def self.abbreviation
+      '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}"
+    end
+  end
+end

data/lib/grafana_reporter/demo_report_wizard.rb

@@ -84,7 +84,6 @@ module GrafanaReporter
       results
     end
 
-    # TODO: move this method to Asciidoctor::Report
     def format_results(raw_results)
       results = ['= Demo report',
                  "Created by `+ruby-grafana-reporter+` version #{GRAFANA_REPORTER_VERSION.join('.')}",

data/lib/grafana_reporter/erb/demo_report_builder.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module GrafanaReporter
+  module ERB
+    # This class builds a demo report for ERB templates
+    class DemoReportBuilder
+      # This method is called if a demo report shall be built for the given {Grafana::Panel}.
+      # @param panel [Grafana::Panel] panel object, for which a demo entry shall be created.
+      # @return [String] String containing the entry, or nil if not possible for given panel
+      def build_demo_entry(panel)
+        return nil unless panel
+        return nil unless panel.model['type'].include?('table')
+
+        ref_id = nil
+        panel.model['targets'].each do |item|
+          if !item['hide'] && !panel.query(item['refId']).to_s.empty?
+            ref_id = item['refId']
+            break
+          end
+        end
+        return nil unless ref_id
+
+        <<~DEMO_ERB_TEMPLATE
+          <%
+          dashboard = '#{panel.dashboard.id}'
+          instance = 'default'
+          # load the panel object from grafana instance
+          panel = @report.grafana(instance).dashboard(dashboard).panel(#{panel.id})
+          # build a complete attributes hash, including the variables set for this report call
+          # e.g. including command line parameters etc.
+          attrs = @attributes.merge({ 'result_type' => 'panel_table', 'query' => '#{ref_id}' })
+          query = QueryValueQuery.new(panel, variables: attrs)
+          %>
+
+          This is a test table for panel <%= panel.id %>:
+
+          <%= query.execute %>
+
+          For detailed API documentation you may start with:
+            1) the AbstractReport (https://rubydoc.info/gems/ruby-grafana-reporter/GrafanaReporter/AbstractReport), or
+            2) subclasses of the AbstractQuery (https://rubydoc.info/gems/ruby-grafana-reporter/GrafanaReporter/AbstractQuery)
+        DEMO_ERB_TEMPLATE
+      end
+    end
+  end
+end

data/lib/grafana_reporter/erb/report.rb

@@ -10,20 +10,26 @@ module GrafanaReporter
       # Starts to create an asciidoctor report. It utilizes all extensions in the {GrafanaReporter::Asciidoctor}
       # namespace to realize the conversion.
       # @see AbstractReport#build
-      def build(template, destination_file_or_path, custom_attributes)
-        attrs = @config.default_document_attributes.merge(@custom_attributes)
+      def build
+        attrs = @config.default_document_attributes.merge(@custom_attributes).merge({ 'grafana_report_timestamp' => ::Grafana::Variable.new(Time.now.to_s) })
         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
-        File.write(path, ::ERB.new(File.read(template)).result(ReportJail.new(self, attrs).bind))
+        File.write(path, ::ERB.new(File.read(@template)).result(ReportJail.new(self, attrs).bind))
+      end
+
+      # @see AbstractReport#default_template_extension
+      def self.default_template_extension
+        'erb'
+      end
 
-        # 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)
+      # @see AbstractReport#default_result_extension
+      def self.default_result_extension
+        'txt'
       end
 
       # @see AbstractReport#demo_report_classes
       def self.demo_report_classes
-        []
+        [DemoReportBuilder]
       end
     end
   end

data/lib/grafana_reporter/errors.rb

@@ -10,23 +10,25 @@ module GrafanaReporter
 
   # Raised if a datasource shall be queried, which is not (yet) supported by the reporter
   class DatasourceNotSupportedError < GrafanaReporterError
-    def initialize(ds, query)
-      super("The datasource '#{ds.name}' is of type '#{ds.type}' which is currently not supported for "\
-            "the query type '#{query}'.")
+    def initialize(datasource, query)
+      super("The datasource '#{datasource.name}' is of type '#{datasource.type}' which is currently "\
+            "not supported for the query type '#{query}'.")
     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}")
+    def initialize(datasource, message)
+      super("The datasource request to '#{datasource.name}' (#{datasource.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}'")
+    def initialize(datasource, message)
+      super("The datasource request to '#{datasource.name}' (#{datasource.class})"\
+            "returned an invalid value: '#{message}'")
     end
   end
 

data/lib/grafana_reporter/query_value_query.rb

@@ -20,7 +20,7 @@ module GrafanaReporter
 
       case @variables['result_type'].raw_value
       when /(?:panel_table|sql_table)/
-        @result = format_table_output(@result, row_divider: @variables['row_divider'], column_divider: @variables['column_divider'])
+        @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'])
 
       when /(?:panel_value|sql_value)/
         tmp = @result[:content] || []

data/lib/grafana_reporter/report_webhook.rb

@@ -12,14 +12,18 @@ module GrafanaReporter
     # Implements the call of the configured webhook.
     # Provides the following report information in JSON format:
     #
-    # +object_id+ - id of the current report
-    # +path+ - file path to the report
-    # +status+ - report status as string, e.g. +cancelled+, +finished+ or +in progress+
-    # +execution_time+ - execution time of the report
-    # +template+ - name of the used template
-    # +start_time+ - time when the report creation started
-    # +end_time+ - time when the report creation ended
-    # +event+ - event, which has happened
+    #   :object_id      - id of the current report
+    #   :path           - file path to the report
+    #   :status         - report status as string, e.g. `cancelled`, `finished` or `in progress`
+    #   :execution_time - execution time in seconds of the report
+    #   :template       - name of the used template
+    #   :start_time     - time when the report creation started
+    #   :end_time       - time when the report creation ended
+    #   :event          - event, which has happened, e.g. `on-before-create`
+    #
+    # Please note that this callback is a non-blocking event, i.e. the report
+    # generation is proceeding, no matter if the callback is successfull and
+    # no matter how long the execution of the callback does take.
     def callback(event, report)
       # build report information as JSON
       data = { object_id: report.object_id, path: report.path, status: report.status,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-grafana-reporter
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.4.4
 platform: ruby
 authors:
 - Christian Kohlmeyer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-18 00:00:00.000000000 Z
+date: 2021-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -130,13 +130,16 @@ files:
 - "./lib/grafana/webrequest.rb"
 - "./lib/grafana_reporter/abstract_query.rb"
 - "./lib/grafana_reporter/abstract_report.rb"
+- "./lib/grafana_reporter/abstract_table_format_strategy.rb"
 - "./lib/grafana_reporter/alerts_table_query.rb"
 - "./lib/grafana_reporter/annotations_table_query.rb"
 - "./lib/grafana_reporter/application/application.rb"
 - "./lib/grafana_reporter/application/errors.rb"
 - "./lib/grafana_reporter/application/webservice.rb"
+- "./lib/grafana_reporter/asciidoctor/adoc_plain_table_format_strategy.rb"
 - "./lib/grafana_reporter/asciidoctor/alerts_table_include_processor.rb"
 - "./lib/grafana_reporter/asciidoctor/annotations_table_include_processor.rb"
+- "./lib/grafana_reporter/asciidoctor/help.rb"
 - "./lib/grafana_reporter/asciidoctor/panel_image_block_macro.rb"
 - "./lib/grafana_reporter/asciidoctor/panel_image_inline_macro.rb"
 - "./lib/grafana_reporter/asciidoctor/panel_property_inline_macro.rb"
@@ -151,11 +154,12 @@ files:
 - "./lib/grafana_reporter/asciidoctor/value_as_variable_include_processor.rb"
 - "./lib/grafana_reporter/configuration.rb"
 - "./lib/grafana_reporter/console_configuration_wizard.rb"
+- "./lib/grafana_reporter/csv_table_format_strategy.rb"
 - "./lib/grafana_reporter/demo_report_wizard.rb"
+- "./lib/grafana_reporter/erb/demo_report_builder.rb"
 - "./lib/grafana_reporter/erb/report.rb"
 - "./lib/grafana_reporter/erb/report_jail.rb"
 - "./lib/grafana_reporter/errors.rb"
-- "./lib/grafana_reporter/help.rb"
 - "./lib/grafana_reporter/logger/two_way_delegate_logger.rb"
 - "./lib/grafana_reporter/panel_image_query.rb"
 - "./lib/grafana_reporter/panel_property_query.rb"