ruby-grafana-reporter 0.2.0 → 0.4.1

data/lib/grafana_reporter/asciidoctor/panel_property_inline_macro.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require_relative 'processor_mixin'
+
+module GrafanaReporter
+  module Asciidoctor
+    # Implements the hook
+    #   grafana_panel_property:<panel_id>[<options>]
+    #
+    # Returns the requested panel property.
+    #
+    # == Used document parameters
+    # +grafana_default_instance+ - name of grafana instance, 'default' if not specified
+    #
+    # +grafana_default_dashboard+ - uid of grafana default dashboard to use
+    #
+    # == Supported options
+    # +field+ - property to query for, e.g. +description+ or +title+ (*mandatory*)
+    #
+    # +instance+ - name of grafana instance, 'default' if not specified
+    #
+    # +dashboard+ - uid of grafana dashboard to use
+    class PanelPropertyInlineMacro < ::Asciidoctor::Extensions::InlineMacroProcessor
+      include ProcessorMixin
+      use_dsl
+
+      named :grafana_panel_property
+      name_positional_attributes :field
+
+      # :nodoc:
+      def process(parent, target, attrs)
+        return if @report.cancel
+
+        @report.next_step
+        instance = attrs['instance'] || parent.document.attr('grafana_default_instance') || 'default'
+        dashboard = attrs['dashboard'] || parent.document.attr('grafana_default_dashboard')
+        @report.logger.debug("Processing PanelPropertyInlineMacro (instance: #{instance}, dashboard: #{dashboard},"\
+                             " panel: #{target}, property: #{attrs[:field]})")
+
+        begin
+          query = PanelPropertyQuery.new(@report.grafana(instance).dashboard(dashboard).panel(target))
+          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
+          @report.logger.error(e.message)
+          return create_inline(parent, :quoted, e.message)
+        rescue StandardError => e
+          @report.logger.fatal(e.message)
+          return create_inline(parent, :quoted, e.message)
+        end
+
+        # translate linebreaks to asciidoctor syntax
+        # and HTML encode to make sure, that HTML formattings are respected
+        create_inline(parent, :quoted, CGI.escapeHTML(description.gsub(%r{//[^\n]*(?:\n)?}, '').gsub(/\n/, " +\n")))
+      end
+
+      # @see ProcessorMixin#build_demo_entry
+      def build_demo_entry(panel)
+        return nil unless panel
+        return nil unless panel.model['title']
+        return nil if panel.model['title'].strip == ''
+        return nil if panel.model['title'].strip == 'Panel Title'
+
+        "this text includes the panel with title grafana_panel_property:#{panel.id}[\"title\","\
+        "dashboard=\"#{panel.dashboard.id}\"]"
+      end
+    end
+  end
+end

data/lib/grafana_reporter/asciidoctor/panel_query_table_include_processor.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+require_relative 'processor_mixin'
+
+module GrafanaReporter
+  module Asciidoctor
+    # Implements the hook
+    #   include::grafana_panel_query_table:<panel_id>[<options>]
+    #
+    # Returns the results of the SQL query as a asciidoctor table.
+    #
+    # == Used document parameters
+    # +grafana_default_instance+ - name of grafana instance, 'default' if not specified
+    #
+    # +grafana_default_dashboard+ - uid of grafana default dashboard to use
+    #
+    # +from+ - 'from' time for the sql query
+    #
+    # +to+ - 'to' time for the sql query
+    #
+    # All other variables starting with +var-+ will be used to replace grafana templating strings
+    # in the given SQL query.
+    #
+    # == Supported options
+    # +query+ - query letter, which shall be used, e.g. +C+ (*mandatory*)
+    #
+    # +instance+ - name of grafana instance, 'default' if not specified
+    #
+    # +dashboard+ - uid of grafana dashboard to use
+    #
+    # +from+ - 'from' time for the sql query
+    #
+    # +to+ - 'to' time for the sql query
+    #
+    # +format+ - see {AbstractQuery#format_columns}
+    #
+    # +replace_values+ - see {AbstractQuery#replace_values}
+    #
+    # +filter_columns+ - see {AbstractQuery#filter_columns}
+    class PanelQueryTableIncludeProcessor < ::Asciidoctor::Extensions::IncludeProcessor
+      include ProcessorMixin
+
+      # :nodoc:
+      def handles?(target)
+        target.start_with? 'grafana_panel_query_table:'
+      end
+
+      # :nodoc:
+      def process(doc, reader, target, attrs)
+        return if @report.cancel
+
+        @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'
+        @report.logger.debug("Processing PanelQueryTableIncludeProcessor (instance: #{instance}, "\
+                             "dashboard: #{dashboard}, panel: #{panel_id}, query: #{attrs['query']})")
+
+        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}")
+
+          reader.unshift_lines query.execute
+        rescue GrafanaReporterError => e
+          @report.logger.error(e.message)
+          reader.unshift_line "|#{e.message}"
+        rescue StandardError => e
+          @report.logger.fatal(e.message)
+          reader.unshift_line "|#{e.message}"
+        end
+
+        reader
+      end
+
+      # @see ProcessorMixin#build_demo_entry
+      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
+
+        "|===\ninclude::grafana_panel_query_table:#{panel.id}[query=\"#{ref_id}\",filter_columns=\"time\","\
+        "dashboard=\"#{panel.dashboard.id}\"]\n|==="
+      end
+    end
+  end
+end

data/lib/grafana_reporter/asciidoctor/panel_query_value_inline_macro.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require_relative 'processor_mixin'
+
+module GrafanaReporter
+  module Asciidoctor
+    # Implements the hook
+    #   grafana_panel_query_value:<panel_id>[<options>]
+    #
+    # Returns the first value of the resulting SQL query.
+    #
+    # == Used document parameters
+    # +grafana_default_instance+ - name of grafana instance, 'default' if not specified
+    #
+    # +grafana_default_dashboard+ - uid of grafana default dashboard to use
+    #
+    # +from+ - 'from' time for the sql query
+    #
+    # +to+ - 'to' time for the sql query
+    #
+    # All other variables starting with +var-+ will be used to replace grafana templating strings
+    # in the given SQL query.
+    #
+    # == Supported options
+    # +query+ - query letter, which shall be used, e.g. +C+ (*mandatory*)
+    #
+    # +instance+ - name of grafana instance, 'default' if not specified
+    #
+    # +dashboard+ - uid of grafana dashboard to use
+    #
+    # +from+ - 'from' time for the sql query
+    #
+    # +to+ - 'to' time for the sql query
+    #
+    # +format+ - see {AbstractQuery#format_columns}
+    #
+    # +replace_values+ - see {AbstractQuery#replace_values}
+    #
+    # +filter_columns+ - see {AbstractQuery#filter_columns}
+    class PanelQueryValueInlineMacro < ::Asciidoctor::Extensions::InlineMacroProcessor
+      include ProcessorMixin
+      use_dsl
+
+      named :grafana_panel_query_value
+
+      # :nodoc:
+      def process(parent, target, attrs)
+        return if @report.cancel
+
+        @report.next_step
+        instance = attrs['instance'] || parent.document.attr('grafana_default_instance') || 'default'
+        dashboard = attrs['dashboard'] || parent.document.attr('grafana_default_dashboard')
+        attrs['result_type'] = 'panel_value'
+        @report.logger.debug("Processing PanelQueryValueInlineMacro (instance: #{instance}, dashboard: #{dashboard},"\
+                             " panel: #{target}, query: #{attrs['query']})")
+
+        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}")
+
+          create_inline(parent, :quoted, query.execute)
+        rescue GrafanaReporterError => e
+          @report.logger.error(e.message)
+          create_inline(parent, :quoted, e.message)
+        rescue StandardError => e
+          @report.logger.fatal(e.message)
+          create_inline(parent, :quoted, e.message)
+        end
+      end
+
+      # @see ProcessorMixin#build_demo_entry
+      def build_demo_entry(panel)
+        return nil unless panel
+        return nil unless panel.model['type'] == 'singlestat'
+
+        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
+
+        "it's easily possible to include the query value: grafana_panel_query_value:#{panel.id}[query=\"#{ref_id}\""\
+        ",dashboard=\"#{panel.dashboard.id}\"] - just within this text."
+      end
+    end
+  end
+end

data/lib/grafana_reporter/asciidoctor/processor_mixin.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module GrafanaReporter
+  module Asciidoctor
+    # This module contains common methods for all asciidoctor extensions.
+    module ProcessorMixin
+      # Used when initializing a object instance, to set the report object, which is currently in progress.
+      # @param report [GrafanaReporter::Asciidoctor::Report] current report
+      # @return [::Asciidoctor::Extensions::Processor] self
+      def current_report(report)
+        @report = report
+        self
+      end
+
+      # 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)
+        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
+      # @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']))
+
+        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)) }
+
+        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
+      end
+    end
+  end
+end

data/lib/grafana_reporter/asciidoctor/report.rb

@@ -1,27 +1,23 @@
 # frozen_string_literal: true
 
 module GrafanaReporter
+  # This module contains all classes, which are necessary to use the reporter in conjunction with asciidoctor.
   module Asciidoctor
     # Implementation of a specific {AbstractReport}. It is used to
     # build reports specifically for asciidoctor results.
-    class Report < GrafanaReporter::AbstractReport
-      # (see AbstractReport#initialize)
-      def initialize(config, template, destination_file_or_path = nil, custom_attributes = {})
+    class Report < ::GrafanaReporter::AbstractReport
+      # @see AbstractReport#initialize
+      def initialize(config)
         super
-        @current_pos = 0
         @image_files = []
-        @grafana_instances = {}
       end
 
-      # Starts to create an asciidoctor report. It utilizes all {Extensions} to
-      # realize the conversion.
+      # Starts to create an asciidoctor report. It utilizes all extensions in the {GrafanaReporter::Asciidoctor}
+      # namespace to realize the conversion.
       # @see AbstractReport#create_report
-      # @return [void]
-      def create_report
-        @start_time = Time.now
+      def create_report(template, destination_file_or_path = nil, custom_attributes = {})
+        super
         attrs = { 'convert-backend' => 'pdf' }.merge(@config.default_document_attributes.merge(@custom_attributes))
-        attrs['grafana-report-timestamp'] = @start_time.to_s
-        logger.info("Report started at #{@start_time}")
         logger.debug("Document attributes: #{attrs}")
 
         initialize_step_counter
@@ -30,19 +26,18 @@ module GrafanaReporter
         ::Asciidoctor::LoggerManager.logger = logger
 
         registry = ::Asciidoctor::Extensions::Registry.new
-        # TODO: dynamically register macros, which is also needed when supporting custom macros
-        registry.inline_macro Extensions::PanelImageInlineMacro.new.current_report(self)
-        registry.inline_macro Extensions::PanelQueryValueInlineMacro.new.current_report(self)
-        registry.inline_macro Extensions::PanelPropertyInlineMacro.new.current_report(self)
-        registry.inline_macro Extensions::SqlValueInlineMacro.new.current_report(self)
-        registry.block_macro Extensions::PanelImageBlockMacro.new.current_report(self)
-        registry.include_processor Extensions::ValueAsVariableIncludeProcessor.new.current_report(self)
-        registry.include_processor Extensions::PanelQueryTableIncludeProcessor.new.current_report(self)
-        registry.include_processor Extensions::SqlTableIncludeProcessor.new.current_report(self)
-        registry.include_processor Extensions::ShowEnvironmentIncludeProcessor.new.current_report(self)
-        registry.include_processor Extensions::ShowHelpIncludeProcessor.new.current_report(self)
-        registry.include_processor Extensions::AnnotationsTableIncludeProcessor.new.current_report(self)
-        registry.include_processor Extensions::AlertsTableIncludeProcessor.new.current_report(self)
+        registry.inline_macro PanelImageInlineMacro.new.current_report(self)
+        registry.inline_macro PanelQueryValueInlineMacro.new.current_report(self)
+        registry.inline_macro PanelPropertyInlineMacro.new.current_report(self)
+        registry.inline_macro SqlValueInlineMacro.new.current_report(self)
+        registry.block_macro PanelImageBlockMacro.new.current_report(self)
+        registry.include_processor ValueAsVariableIncludeProcessor.new.current_report(self)
+        registry.include_processor PanelQueryTableIncludeProcessor.new.current_report(self)
+        registry.include_processor SqlTableIncludeProcessor.new.current_report(self)
+        registry.include_processor ShowEnvironmentIncludeProcessor.new.current_report(self)
+        registry.include_processor ShowHelpIncludeProcessor.new.current_report(self)
+        registry.include_processor AnnotationsTableIncludeProcessor.new.current_report(self)
+        registry.include_processor AlertsTableIncludeProcessor.new.current_report(self)
 
         ::Asciidoctor.convert_file(@template, extension_registry: registry, backend: attrs['convert-backend'],
                                               to_file: path, attributes: attrs, header_footer: true)
@@ -51,29 +46,28 @@ module GrafanaReporter
 
         # store report including als images as ZIP file, if the result is not a PDF
         if attrs['convert-backend'] != 'pdf'
-          dest_path = nil
-          case
-          when @destination_file_or_path.is_a?(File)
-            dest_path = @destination_file_or_path.path
-          when @destination_file_or_path.is_a?(Tempfile)
-            dest_path = @destination_file_or_path.path
-          else
-            dest_path = @destination_file_or_path
-          end
+          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')
-          Zip::File.open(zip_file.path, Zip::File::CREATE) do |zipfile|
+          buffer = Zip::OutputStream.write_buffer do |zipfile|
             # add report file
-            zipfile.get_output_stream("#{dest_path.gsub(@config.reports_folder, '')}.#{attrs['convert-backend']}") do |f|
-              f.puts File.read(dest_path)
-            end
+            zipfile.put_next_entry("#{dest_path.gsub(@config.reports_folder, '')}.#{attrs['convert-backend']}")
+            zipfile.write File.read(dest_path)
 
             # add image files
             @image_files.each do |file|
-              zipfile.get_output_stream(file.path.gsub(@config.images_folder, '')) { |f| f.puts File.read(file.path) }
+              zipfile.put_next_entry(file.path.gsub(@config.images_folder, ''))
+              zipfile.write File.read(file.path)
             end
           end
+          File.open(zip_file, 'wb') do |f|
+            f.write buffer.string
+          end
 
           # replace original file with zip file
           zip_file.rewind
@@ -89,40 +83,17 @@ module GrafanaReporter
         end
 
         clean_image_files
-        @end_time = Time.now
-        logger.info("Report finished after #{@end_time - @start_time} seconds.")
-        @done = true
+      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
-      end
-
-      # @see AbstractReport#progress
-      # @return [Float] number between 0 and 1 reflecting the current progress.
-      def progress
-        return 0 if @total_steps.to_i.zero?
-
-        @current_pos.to_f / @total_steps
-      end
-
-      # @param instance [String] requested grafana instance
-      # @return [Grafana::Grafana] the requested grafana instance.
-      def grafana(instance)
-        unless @grafana_instances[instance]
-          @grafana_instances[instance] = ::Grafana::Grafana.new(@config.grafana_host(instance),
-                                                                @config.grafana_api_key(instance),
-                                                                logger: @logger,
-                                                                datasources: @config.grafana_datasources(instance))
-        end
-        @grafana_instances[instance]
-      end
-
-      # Increments the progress.
-      # @return [Integer] number of the current progress position.
-      def next_step
-        @current_pos += 1
-        @current_pos
+      ensure
+        done!
       end
 
       # Called to save a temporary image file. After the final generation of the
@@ -131,6 +102,7 @@ module GrafanaReporter
       # @return [String] path to the temporary file.
       def save_image_file(img_data)
         file = Tempfile.new(['gf_image_', '.png'], @config.images_folder.to_s)
+        file.binmode
         file.write(img_data)
         path = file.path.gsub(/#{@config.images_folder}/, '')
 
@@ -140,13 +112,11 @@ module GrafanaReporter
         path
       end
 
-      # Called, if the report generation has died with an error.
-      # @param error [StandardError] occured error
-      # @return [void]
-      def died_with_error(error)
-        @error = [error.message] << [error.backtrace]
-        @end_time = Time.now
-        @done = true
+      # @see AbstractReport#demo_report_classes
+      def self.demo_report_classes
+        [AlertsTableIncludeProcessor, AnnotationsTableIncludeProcessor, PanelImageBlockMacro, PanelImageInlineMacro,
+         PanelPropertyInlineMacro, PanelQueryTableIncludeProcessor, PanelQueryValueInlineMacro,
+         SqlTableIncludeProcessor, SqlValueInlineMacro, ShowHelpIncludeProcessor, ShowEnvironmentIncludeProcessor]
       end
 
       private
@@ -160,6 +130,7 @@ module GrafanaReporter
         @total_steps = 0
         File.readlines(@template).each do |line|
           begin
+            # TODO: move these calls to the specific processors to ensure all are counted properly
             @total_steps += line.gsub(%r{//.*}, '').scan(/(?:grafana_panel_image|grafana_panel_query_value|
                                                          grafana_panel_query_table|grafana_sql_value|
                                                          grafana_sql_table|grafana_environment|grafana_help|