ruby-grafana-reporter 0.4.0 → 0.4.1

data/lib/grafana_reporter/application/webservice.rb

@@ -6,9 +6,12 @@ module GrafanaReporter
     # make use of `webrick` or similar, so that it can be used without futher dependencies
     # in conjunction with the standard asciidoctor docker container.
     class Webservice
+      # Array of possible webservice running states
+      STATUS = %I[stopped running stopping].freeze
+
       def initialize
         @reports = []
-        @running = false
+        @status = :stopped
       end
 
       # Runs the webservice with the given {Configuration} object.
@@ -19,17 +22,32 @@ module GrafanaReporter
         # start webserver
         @server = TCPServer.new(@config.webserver_port)
         @logger.info("Server listening on port #{@config.webserver_port}...")
-        @running = true
 
         @progress_reporter = Thread.new {}
 
+        @status = :running
         accept_requests_loop
-        @running = false
+        @status = :stopped
+      end
+
+      # @return True, if webservice is stopped, false otherwise
+      def stopped?
+        @status == :stopped
       end
 
       # @return True, if webservice is up and running, false otherwise
       def running?
-        @running
+        @status == :running
+      end
+
+      # Forces stopping the webservice.
+      def stop!
+        @status = :stopping
+
+        # invoke a new request, so that the webservice stops.
+        socket = TCPSocket.new('localhost', @config.webserver_port)
+        socket.send '', 0
+        socket.close
       end
 
       private
@@ -39,6 +57,14 @@ module GrafanaReporter
           # step 1) accept incoming connection
           socket = @server.accept
 
+          # TODO: shutdown properly on SIGINT/SIGHUB
+
+          # stop webservice properly, if shall be shutdown
+          if @status == :stopping
+            socket.close
+            break
+          end
+
           # step 2) print the request headers (separated by a blank line e.g. \r\n)
           request = ''
           line = ''
@@ -57,9 +83,6 @@ module GrafanaReporter
           rescue WebserviceUnknownPathError => e
             @logger.debug(e.message)
             socket.write http_response(404, '', e.message)
-          rescue MissingTemplateError => e
-            @logger.error(e.message)
-            socket.write http_response(400, 'Bad Request', e.message)
           rescue WebserviceGeneralRenderingError => e
             @logger.fatal(e.message)
             socket.write http_response(400, 'Bad Request', e.message)
@@ -179,7 +202,7 @@ module GrafanaReporter
 
       def render_report(attrs)
         # build report
-        template_file = "#{@config.templates_folder}#{attrs['var-template']}.adoc"
+        template_file = "#{@config.templates_folder}#{attrs['var-template']}"
 
         file = Tempfile.new('gf_pdf_', @config.reports_folder)
         begin
@@ -188,9 +211,10 @@ module GrafanaReporter
           @logger.debug("File permissions could not be set for #{file.path}: #{e.message}")
         end
 
-        report = @config.report_class.new(@config, template_file, file, attrs)
+        report = @config.report_class.new(@config)
+        Thread.report_on_exception = false
         Thread.new do
-          report.create_report
+          report.create_report(template_file, file, attrs)
         end
         @reports << report
 

data/lib/grafana_reporter/asciidoctor/alerts_table_include_processor.rb

@@ -31,11 +31,11 @@ module GrafanaReporter
     #
     # +to+ - 'to' time for the sql query
     #
-    # +format+ - see {QueryMixin#format_columns}
+    # +format+ - see {AbstractQuery#format_columns}
     #
-    # +replace_values+ - see {QueryMixin#replace_values}
+    # +replace_values+ - see {AbstractQuery#replace_values}
     #
-    # +filter_columns+ - see {QueryMixin#filter_columns}
+    # +filter_columns+ - see {AbstractQuery#filter_columns}
     class AlertsTableIncludeProcessor < ::Asciidoctor::Extensions::IncludeProcessor
       include ProcessorMixin
 
@@ -56,12 +56,12 @@ module GrafanaReporter
                              " dashboard: #{dashboard_id}, panel: #{panel_id})")
 
         query = AlertsTableQuery.new(@report.grafana(instance))
-        query.set_defaults_from_dashboard(@report.grafana(instance).dashboard(dashboard_id)) if dashboard_id
+        assign_dashboard_defaults(query, @report.grafana(instance).dashboard(dashboard_id)) if dashboard_id
         defaults = {}
         defaults['dashboardId'] = dashboard_id if dashboard_id
         defaults['panelId'] = panel_id if panel_id
 
-        query.merge_hash_variables(doc.attributes, attrs)
+        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

data/lib/grafana_reporter/asciidoctor/annotations_table_include_processor.rb

@@ -31,11 +31,11 @@ module GrafanaReporter
     #
     # +to+ - 'to' time for the sql query
     #
-    # +format+ - see {QueryMixin#format_columns}
+    # +format+ - see {AbstractQuery#format_columns}
     #
-    # +replace_values+ - see {QueryMixin#replace_values}
+    # +replace_values+ - see {AbstractQuery#replace_values}
     #
-    # +filter_columns+ - see {QueryMixin#filter_columns}
+    # +filter_columns+ - see {AbstractQuery#filter_columns}
     class AnnotationsTableIncludeProcessor < ::Asciidoctor::Extensions::IncludeProcessor
       include ProcessorMixin
 
@@ -55,12 +55,12 @@ module GrafanaReporter
         @report.logger.debug("Processing AnnotationsTableIncludeProcessor (instance: #{instance})")
 
         query = AnnotationsTableQuery.new(@report.grafana(instance))
-        query.set_defaults_from_dashboard(@report.grafana(instance).dashboard(dashboard_id)) if dashboard_id
+        assign_dashboard_defaults(query, @report.grafana(instance).dashboard(dashboard_id)) if dashboard_id
         defaults = {}
         defaults['dashboardId'] = dashboard_id if dashboard_id
         defaults['panelId'] = panel_id if panel_id
 
-        query.merge_hash_variables(doc.attributes, attrs)
+        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

data/lib/grafana_reporter/asciidoctor/panel_image_block_macro.rb

@@ -47,7 +47,8 @@ module GrafanaReporter
 
         begin
           query = PanelImageQuery.new(@report.grafana(instance).dashboard(dashboard).panel(target))
-          query.merge_hash_variables(parent.document.attributes, attrs)
+          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}")
 
           image = query.execute

data/lib/grafana_reporter/asciidoctor/panel_image_inline_macro.rb

@@ -44,13 +44,15 @@ module GrafanaReporter
         dashboard = attrs['dashboard'] || parent.document.attr('grafana_default_dashboard')
         @report.logger.debug("Processing PanelImageInlineMacro (instance: #{instance}, dashboard: #{dashboard},"\
                              " panel: #{target})")
-        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']
-        query.merge_hash_variables(parent.document.attributes, attrs)
-        @report.logger.debug("from: #{query.from}, to: #{query.to}")
 
         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}")
+
           image = query.execute
           image_path = @report.save_image_file(image)
         rescue GrafanaReporterError => e

data/lib/grafana_reporter/asciidoctor/panel_property_inline_macro.rb

@@ -40,7 +40,8 @@ module GrafanaReporter
         begin
           query = PanelPropertyQuery.new(@report.grafana(instance).dashboard(dashboard).panel(target))
           query.raw_query = { property_name: attrs[:field] }
-          query.merge_hash_variables(parent.document.attributes, attrs)
+          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

data/lib/grafana_reporter/asciidoctor/panel_query_table_include_processor.rb

@@ -32,11 +32,11 @@ module GrafanaReporter
     #
     # +to+ - 'to' time for the sql query
     #
-    # +format+ - see {QueryMixin#format_columns}
+    # +format+ - see {AbstractQuery#format_columns}
     #
-    # +replace_values+ - see {QueryMixin#replace_values}
+    # +replace_values+ - see {AbstractQuery#replace_values}
     #
-    # +filter_columns+ - see {QueryMixin#filter_columns}
+    # +filter_columns+ - see {AbstractQuery#filter_columns}
     class PanelQueryTableIncludeProcessor < ::Asciidoctor::Extensions::IncludeProcessor
       include ProcessorMixin
 
@@ -51,6 +51,7 @@ 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,8 +61,8 @@ module GrafanaReporter
         begin
           panel = @report.grafana(instance).dashboard(dashboard).panel(panel_id)
           query = QueryValueQuery.new(panel)
-          query.set_defaults_from_dashboard(panel.dashboard)
-          query.merge_hash_variables(doc.attributes, attrs)
+          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

data/lib/grafana_reporter/asciidoctor/panel_query_value_inline_macro.rb

@@ -32,11 +32,11 @@ module GrafanaReporter
     #
     # +to+ - 'to' time for the sql query
     #
-    # +format+ - see {QueryMixin#format_columns}
+    # +format+ - see {AbstractQuery#format_columns}
     #
-    # +replace_values+ - see {QueryMixin#replace_values}
+    # +replace_values+ - see {AbstractQuery#replace_values}
     #
-    # +filter_columns+ - see {QueryMixin#filter_columns}
+    # +filter_columns+ - see {AbstractQuery#filter_columns}
     class PanelQueryValueInlineMacro < ::Asciidoctor::Extensions::InlineMacroProcessor
       include ProcessorMixin
       use_dsl
@@ -57,8 +57,8 @@ module GrafanaReporter
         begin
           panel = @report.grafana(instance).dashboard(dashboard).panel(target)
           query = QueryValueQuery.new(panel)
-          query.set_defaults_from_dashboard(panel.dashboard)
-          query.merge_hash_variables(parent.document.attributes, attrs)
+          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)

data/lib/grafana_reporter/asciidoctor/processor_mixin.rb

@@ -12,12 +12,53 @@ module GrafanaReporter
         self
       end
 
-      # This method is called if a demo report shall be built for the given {Panel}.
-      # @param panel [Panel] panel object, for which a demo entry shall be created.
+      # 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

@@ -6,22 +6,18 @@ module GrafanaReporter
     # 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 = {})
+      # @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
+      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.debug("Document attributes: #{attrs}")
 
         initialize_step_counter
@@ -87,37 +83,17 @@ 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
-      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)
-        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
@@ -126,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}/, '')
 
@@ -135,12 +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]
-        done!
+      # @see AbstractReport#demo_report_classes
+      def self.demo_report_classes
+        [AlertsTableIncludeProcessor, AnnotationsTableIncludeProcessor, PanelImageBlockMacro, PanelImageInlineMacro,
+         PanelPropertyInlineMacro, PanelQueryTableIncludeProcessor, PanelQueryValueInlineMacro,
+         SqlTableIncludeProcessor, SqlValueInlineMacro, ShowHelpIncludeProcessor, ShowEnvironmentIncludeProcessor]
       end
 
       private

data/lib/grafana_reporter/asciidoctor/sql_table_include_processor.rb

@@ -26,11 +26,11 @@ module GrafanaReporter
     #
     # +to+ - 'to' time for the sql query
     #
-    # +format+ - see {QueryMixin#format_columns}
+    # +format+ - see {AbstractQuery#format_columns}
     #
-    # +replace_values+ - see {QueryMixin#replace_values}
+    # +replace_values+ - see {AbstractQuery#replace_values}
     #
-    # +filter_columns+ - see {QueryMixin#filter_columns}
+    # +filter_columns+ - see {AbstractQuery#filter_columns}
     class SqlTableIncludeProcessor < ::Asciidoctor::Extensions::IncludeProcessor
       include ProcessorMixin
 
@@ -54,7 +54,7 @@ module GrafanaReporter
           query = QueryValueQuery.new(@report.grafana(instance))
           query.datasource = @report.grafana(instance).datasource_by_id(target.split(':')[1].to_i)
           query.raw_query = attrs['sql']
-          query.merge_hash_variables(doc.attributes, attrs)
+          assign_doc_and_item_variables(query, doc.attributes, attrs)
           @report.logger.debug("from: #{query.from}, to: #{query.to}")
 
           reader.unshift_lines query.execute

data/lib/grafana_reporter/asciidoctor/sql_value_inline_macro.rb

@@ -26,11 +26,11 @@ module GrafanaReporter
     #
     # +to+ - 'to' time for the sql query
     #
-    # +format+ - see {QueryMixin#format_columns}
+    # +format+ - see {AbstractQuery#format_columns}
     #
-    # +replace_values+ - see {QueryMixin#replace_values}
+    # +replace_values+ - see {AbstractQuery#replace_values}
     #
-    # +filter_columns+ - see {QueryMixin#filter_columns}
+    # +filter_columns+ - see {AbstractQuery#filter_columns}
     class SqlValueInlineMacro < ::Asciidoctor::Extensions::InlineMacroProcessor
       include ProcessorMixin
       use_dsl
@@ -52,7 +52,7 @@ module GrafanaReporter
           query = QueryValueQuery.new(@report.grafana(instance))
           query.datasource = @report.grafana(instance).datasource_by_id(target)
           query.raw_query = attrs['sql']
-          query.merge_hash_variables(parent.document.attributes, attrs)
+          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)