ruby-grafana-reporter 0.3.0 → 0.4.4

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.
@@ -9,6 +9,13 @@ module GrafanaReporter
   # Objects of this class are also stored in {Application::Application}, unless
   # the retention time is over.
   class AbstractReport
+    # Array of supported event callback symbols
+    EVENT_CALLBACKS = %i[all on_before_create on_after_cancel on_after_finish].freeze
+
+    # Class variable for storing event listeners
+    @@event_listeners = {}
+    @@event_listeners.default = []
+
     # @return [String] path to the template
     attr_reader :template
 
@@ -28,21 +35,38 @@ module GrafanaReporter
     attr_reader :done
 
     # @param config [Configuration] configuration object
-    # @param template [String] path to the template to be used
-    # @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
-    def initialize(config, template, destination_file_or_path = nil, custom_attributes = {})
+    def initialize(config)
       @config = config
       @logger = Logger::TwoWayDelegateLogger.new
       @logger.additional_logger = @config.logger
-      @done = false
-      @template = template
-      @destination_file_or_path = destination_file_or_path
-      @custom_attributes = custom_attributes
-      @start_time = nil
-      @end_time = nil
-      @cancel = false
-      raise MissingTemplateError, @template.to_s unless File.exist?(@template.to_s)
+      @grafana_instances = {}
+
+      init_before_create
+    end
+
+    # Registers a new event listener object.
+    # @param event [Symbol] one of EVENT_CALLBACKS
+    # @param listener [Object] object responding to #callback(event_symbol, object)
+    def self.add_event_listener(event, listener)
+      @@event_listeners[event] = [] if @@event_listeners[event] == []
+      @@event_listeners[event].push(listener)
+    end
+
+    # Removes all registeres event listener objects
+    def self.clear_event_listeners
+      @@event_listeners = {}
+      @@event_listeners.default = []
+    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
 
     # Call to request cancelling the report generation.
@@ -50,6 +74,7 @@ module GrafanaReporter
     def cancel!
       @cancel = true
       logger.info('Cancelling report generation invoked.')
+      notify(:on_after_cancel)
     end
 
     # @return [String] path to the report destination file
@@ -81,9 +106,12 @@ module GrafanaReporter
       @error || []
     end
 
-    # @return [String] status of the report, one of 'in progress', 'cancelled', 'died' or 'finished'.
+    # @return [String] status of the report as string, either 'not started', 'in progress', 'cancelling',
+    #   'cancelled', 'died' or 'finished'.
     def status
+      return 'not started' unless @start_time
       return 'cancelled' if done && cancel
+      return 'cancelling' if !done && cancel
       return 'finished' if done && error.empty?
       return 'died' if done && !error.empty?
 
@@ -96,17 +124,123 @@ module GrafanaReporter
       logger.internal_messages
     end
 
-    # @abstract
-    # 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 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]
-    def create_report
-      raise NotImplementedError
+    def create_report(template, destination_file_or_path = nil, custom_attributes = {})
+      init_before_create
+      @template = template
+      @destination_file_or_path = destination_file_or_path
+      @custom_attributes = custom_attributes
+
+      # 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
+    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
+    # number of steps, which will be processed with each call of {#next_step}.
     # @return [Integer] number between 0 and 100, representing the current progress of the report creation.
     def progress
+      return @current_pos.to_i if @total_steps.to_i.zero?
+
+      @current_pos.to_f / @total_steps
+    end
+
+    # Increments the progress.
+    # @return [Integer] number of the current progress position.
+    def next_step
+      @current_pos += 1
+      @current_pos
+    end
+
+    # @abstract
+    # Provided class objects need to implement a method +build_demo_entry(panel)+.
+    # @return [Array<Class>] array of class objects, which shall be included in a demo report
+    def self.demo_report_classes
       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.
+    # @param error [StandardError] occured error
+    # @return [void]
+    def died_with_error(error)
+      @error = [error.message] << [error.backtrace]
+      done!
+    end
+
+    def init_before_create
+      @done = false
+      @start_time = nil
+      @end_time = nil
+      @cancel = false
+      @current_pos = 0
+    end
+
+    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
+      logger.info("Report creation ended after #{@end_time.to_i - @start_time.to_i} seconds with status '#{status}'")
+      notify(:on_after_finish)
+    end
+
+    def notify(event)
+      (@@event_listeners[:all] + @@event_listeners[event]).each do |listener|
+        logger.debug("Informing event listener '#{listener.class}' about event '#{event}' for report '#{object_id}'.")
+        begin
+          res = listener.callback(event, self)
+          logger.debug("Event listener '#{listener.class}' for event '#{event}' and report '#{object_id}' returned "\
+                       "with result '#{res}'.")
+        rescue StandardError => e
+          msg = "Event listener '#{listener.class}' for event '#{event}' and report '#{object_id}' returned with "\
+                "error: #{e.message} - #{e.backtrace}."
+          puts msg
+          logger.error(msg)
+        end
+      end
+    end
   end
 end

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

data/lib/grafana_reporter/alerts_table_query.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module GrafanaReporter
+  # This class is used to query alerts from grafana.
+  class AlertsTableQuery < AbstractQuery
+    # Check if mandatory {Grafana::Variable} +columns+ is specified in variables.
+    #
+    # The value of the +columns+ variable has to be a comma separated list of column titles, which
+    # need to be included in the following list:
+    # - limit
+    # - dashboardId
+    # - panelId
+    # - query
+    # - state
+    # - folderId
+    # - dashboardQuery
+    # - dashboardTag
+    # @return [void]
+    def pre_process
+      raise MissingMandatoryAttributeError, 'columns' unless @raw_query['columns']
+
+      @datasource = Grafana::GrafanaAlertsDatasource.new(nil)
+    end
+
+    # Filter the query result for the given columns and sets the result in the preformatted SQL
+    # result stlye.
+    #
+    # Additionally it applies {AbstractQuery#format_columns}, {AbstractQuery#replace_values} and
+    # {AbstractQuery#filter_columns}.
+    # @return [void]
+    def post_process
+      @result = format_columns(@result, @variables['format'])
+      @result = replace_values(@result, @variables.select { |k, _v| k =~ /^replace_values_\d+/ })
+      @result = filter_columns(@result, @variables['filter_columns'])
+
+      @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'])
+    end
+  end
+end

data/lib/grafana_reporter/annotations_table_query.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module GrafanaReporter
+  # This class is used to query annotations from grafana.
+  class AnnotationsTableQuery < AbstractQuery
+    # Check if mandatory {Grafana::Variable} +columns+ is specified in variables.
+    #
+    # The value of the +columns+ variable has to be a comma separated list of column titles, which
+    # need to be included in the following list:
+    # - limit
+    # - alertId
+    # - userId
+    # - type
+    # - tags
+    # - dashboardId
+    # - panelId
+    # @return [void]
+    def pre_process
+      raise MissingMandatoryAttributeError, 'columns' unless @raw_query['columns']
+
+      @datasource = Grafana::GrafanaAnnotationsDatasource.new(nil)
+    end
+
+    # Filters the query result for the given columns and sets the result
+    # in the preformatted SQL result style.
+    #
+    # Additionally it applies {AbstractQuery#format_columns}, {AbstractQuery#replace_values} and
+    # {AbstractQuery#filter_columns}.
+    # @return [void]
+    def post_process
+      @result = format_columns(@result, @variables['format'])
+      @result = replace_values(@result, @variables.select { |k, _v| k =~ /^replace_values_\d+/ })
+      @result = filter_columns(@result, @variables['filter_columns'])
+
+      @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'])
+    end
+  end
+end

data/lib/grafana_reporter/application/application.rb

@@ -13,14 +13,15 @@ module GrafanaReporter
     # It can be run to test the grafana connection, render a single template
     # or run as a service.
     class Application
-      # Default file name for grafana reporter configuration file
-      CONFIG_FILE = 'grafana_reporter.config'
-
       # Contains the {Configuration} object of the application.
       attr_accessor :config
 
+      # Stores the {Webservice} object of the application
+      attr_reader :webservice
+
       def initialize
         @config = Configuration.new
+        @webservice = Webservice.new
       end
 
       # This is the main method, which is called, if the application is
@@ -28,22 +29,26 @@ module GrafanaReporter
       # @param params [Array<String>] command line parameters, mainly ARGV can be used.
       # @return [Integer] 0 if everything is fine, -1 if execution aborted.
       def configure_and_run(params = [])
-        config_file = CONFIG_FILE
+        config_file = Configuration::DEFAULT_CONFIG_FILE_NAME
         tmp_config = Configuration.new
         action_wizard = false
 
         parser = OptionParser.new do |opts|
-          if ENV['OCRA_EXECUTABLE']
-            opts.banner = "Usage: #{ENV['OCRA_EXECUTABLE'].gsub("#{Dir.pwd}/".gsub('/', '\\'), '')} [options]"
-          else
-            opts.banner = "Usage: #{Gem.ruby} #{$PROGRAM_NAME} [options]"
-          end
+          opts.banner = if ENV['OCRA_EXECUTABLE']
+                          "Usage: #{ENV['OCRA_EXECUTABLE'].gsub("#{Dir.pwd}/".gsub('/', '\\'), '')} [options]"
+                        else
+                          "Usage: #{Gem.ruby} #{$PROGRAM_NAME} [options]"
+                        end
 
           opts.on('-c', '--config CONFIG_FILE_NAME', 'Specify custom configuration file,'\
-                  " instead of #{CONFIG_FILE}.") do |file_name|
+                  " instead of #{Configuration::DEFAULT_CONFIG_FILE_NAME}.") do |file_name|
             config_file = file_name
           end
 
+          opts.on('-r', '--register FILE', 'Register a custom plugin, e.g. your own Datasource implementation') do |plugin|
+            require plugin
+          end
+
           opts.on('-d', '--debug LEVEL', 'Specify detail level: FATAL, ERROR, WARN, INFO, DEBUG.') do |level|
             tmp_config.set_param('grafana-reporter:debug-level', level)
           end
@@ -61,7 +66,7 @@ module GrafanaReporter
 
           opts.on('--ssl-cert FILE', 'Manually specify a SSL cert file for HTTPS connection to grafana. Only '\
                   'needed if not working properly otherwise.') do |file|
-            if File.exist?(file)
+            if File.file?(file)
               tmp_config.set_param('grafana-reporter:ssl-cert', file)
             else
               config.logger.warn("SSL certificate file #{file} does not exist. Setting will be ignored.")
@@ -102,22 +107,14 @@ module GrafanaReporter
         end
 
         # abort if config file does not exist
-        unless File.exist?(config_file)
+        unless File.file?(config_file)
           puts "Config file '#{config_file}' does not exist. Consider calling the configuration wizard"\
                ' with option \'-w\' or use \'-h\' to see help message. Aborting.'
           return -1
         end
 
-        # read config file
-        config_hash = nil
-        begin
-          config_hash = YAML.load_file(config_file)
-        rescue StandardError => e
-          raise ConfigurationError, "Could not read config file '#{config_file}' (Error: #{e.message})"
-        end
-
         # merge command line configuration with read config file
-        @config.config = config_hash
+        @config.load_config_from_file(config_file)
         @config.merge!(tmp_config)
 
         run
@@ -137,18 +134,24 @@ module GrafanaReporter
         when Configuration::MODE_CONNECTION_TEST
           res = Grafana::Grafana.new(config.grafana_host(config.test_instance),
                                      config.grafana_api_key(config.test_instance),
-                                     logger: config.logger, ssl_cert: config.ssl_cert).test_connection
+                                     logger: config.logger).test_connection
           puts res
 
         when Configuration::MODE_SINGLE_RENDER
           begin
-            config.report_class.new(config, config.template, config.to_file).create_report
+            template_ext = config.report_class.default_template_extension
+            report_ext = config.report_class.default_result_extension
+            default_to_file = File.basename(config.template.to_s.gsub(/(?:\.#{template_ext})?$/, ".#{report_ext}"))
+
+            to_file = config.to_file
+            to_file = "#{config.reports_folder}#{default_to_file}" if to_file == true
+            config.report_class.new(config).create_report(config.template, to_file)
           rescue StandardError => e
-            puts e.message
+            puts "#{e.message}\n#{e.backtrace.join("\n")}"
           end
 
         when Configuration::MODE_SERVICE
-          Webservice.new(config).run
+          @webservice.run(config)
         end
 
         0