ruby-grafana-reporter 0.4.0 → 0.4.1

data/lib/grafana_reporter/configuration.rb

@@ -13,6 +13,10 @@ module GrafanaReporter
   class Configuration
     # @return [AbstractReport] specific report class, which should be used.
     attr_accessor :report_class
+    attr_accessor :logger
+
+    # Default file name for grafana reporter configuration file
+    DEFAULT_CONFIG_FILE_NAME = 'grafana_reporter.config'
 
     # Returned by {#mode} if only a connection test shall be executed.
     MODE_CONNECTION_TEST = 'test'
@@ -30,7 +34,15 @@ module GrafanaReporter
       @logger = ::Logger.new($stderr, level: :info)
     end
 
-    attr_accessor :logger
+    # Reads a given configuration file.
+    # @param config_file [String] path to configuration file, defaults to DEFAULT_CONFIG_FILE_NAME
+    # @return [Hash] configuration hash to be set as {Configuration#config}
+    def load_config_from_file(config_file = nil)
+      config_file ||= DEFAULT_CONFIG_FILE_NAME
+      self.config = YAML.load_file(config_file)
+    rescue StandardError => e
+      raise ConfigurationError, "Could not read config file '#{config_file}' (Error: #{e.message})"
+    end
 
     # Used to overwrite the current configuration.
     def config=(new_config)
@@ -53,7 +65,7 @@ module GrafanaReporter
     def template
       return nil if get_config('default-document-attributes:var-template').nil?
 
-      "#{templates_folder}#{get_config('default-document-attributes:var-template')}.adoc"
+      "#{templates_folder}#{get_config('default-document-attributes:var-template')}"
     end
 
     # @return [String] destination filename for the report in {MODE_SINGLE_RENDER}.

data/lib/grafana_reporter/console_configuration_wizard.rb

@@ -31,7 +31,7 @@ module GrafanaReporter
       demo_report = create_demo_report(config)
 
       demo_report ||= '<<your_report_name>>'
-      config_param = config_file == Application::Application::CONFIG_FILE ? '' : " -c #{config_file}"
+      config_param = config_file == Configuration::DEFAULT_CONFIG_FILE_NAME ? '' : " -c #{config_file}"
       program_call = "#{Gem.ruby} #{$PROGRAM_NAME}"
       program_call = ENV['OCRA_EXECUTABLE'].gsub("#{Dir.pwd}/".gsub('/', '\\'), '') if ENV['OCRA_EXECUTABLE']
 
@@ -137,16 +137,8 @@ default-document-attributes:
         end
       end
 
-      # TODO: move this to Asciidoctor::Report class
-      classes = [Asciidoctor::AlertsTableIncludeProcessor, Asciidoctor::AnnotationsTableIncludeProcessor,
-                 Asciidoctor::PanelImageBlockMacro, Asciidoctor::PanelImageInlineMacro,
-                 Asciidoctor::PanelPropertyInlineMacro, Asciidoctor::PanelQueryTableIncludeProcessor,
-                 Asciidoctor::PanelQueryValueInlineMacro, Asciidoctor::SqlTableIncludeProcessor,
-                 Asciidoctor::SqlValueInlineMacro, Asciidoctor::ShowHelpIncludeProcessor,
-                 Asciidoctor::ShowEnvironmentIncludeProcessor]
-
       grafana = ::Grafana::Grafana.new(config.grafana_host, config.grafana_api_key)
-      demo_report_content = DemoReportWizard.new(classes).build(grafana)
+      demo_report_content = DemoReportWizard.new(config.report_class.demo_report_classes).build(grafana)
 
       begin
         File.write(demo_report_file, demo_report_content, mode: 'w')

data/lib/grafana_reporter/demo_report_wizard.rb

@@ -26,8 +26,15 @@ module GrafanaReporter
         puts "done - #{(@query_classes - results.keys).length} examples to go"
         break if (@query_classes - results.keys).empty?
       end
-      puts 'Aborting evaluating further dashboards after 15 samples.' if grafana.dashboard_ids.length > 15 and !(@query_classes - results.keys).empty?
-      puts "For #{(@query_classes - results.keys).length} reporter functionalities no appropriate examples could be found in the configured grafana instance." unless (@query_classes - results.keys).empty?
+
+      if grafana.dashboard_ids.length > 15 && !(@query_classes - results.keys).empty?
+        puts 'Aborting evaluating further dashboards after 15 samples.'
+      end
+
+      unless (@query_classes - results.keys).empty?
+        puts "For #{(@query_classes - results.keys).length} reporter functionalities no appropriate "\
+             'examples could be found in the configured grafana instance.'
+      end
 
       format_results(default_result(@query_classes - results.keys).merge(results))
     end
@@ -48,6 +55,8 @@ module GrafanaReporter
       results = {}
 
       dashboard.panels.shuffle.each do |panel|
+        next if panel.datasource.is_a?(Grafana::UnsupportedDatasource)
+
         query_classes.each do |query_class|
           unless query_class.public_instance_methods.include?(:build_demo_entry)
             results[query_class] = "Method 'build_demo_entry' not implemented for #{query_class.name}"
@@ -57,6 +66,11 @@ module GrafanaReporter
           begin
             result = query_class.new.build_demo_entry(panel)
             results[query_class] = result if result
+          rescue Grafana::DatasourceDoesNotExistError
+            # properly catch DatasourceDoesNotExist errors here, as they don't lead to a real issue
+            # during demo report creation
+            # This may e.g. happen if a panel asks e.g. for datasource '-- Dashboard --' which is
+            # currently not allowed
           rescue StandardError => e
             puts "#{e.message}\n#{e.backtrace.join("\n")}"
           end

data/lib/grafana_reporter/erb/report.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'erb'
+
+module GrafanaReporter
+  module ERB
+    # Implementation of a specific {AbstractReport}. It is used to
+    # build reports specifically for erb templates.
+    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
+        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))
+
+        # 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
+      def self.demo_report_classes
+        []
+      end
+    end
+  end
+end

data/lib/grafana_reporter/errors.rb

@@ -8,6 +8,14 @@ module GrafanaReporter
     end
   end
 
+  # 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}'.")
+    end
+  end
+
   # Thrown, if the requested grafana instance does not have the mandatory 'host'
   # setting configured.
   class GrafanaInstanceWithoutHostError < GrafanaReporterError
@@ -46,7 +54,7 @@ module GrafanaReporter
     end
   end
 
-  # Thrown, if the value configuration in {QueryMixin#replace_values} is
+  # Thrown, if the value configuration in {AbstractQuery#replace_values} is
   # invalid.
   class MalformedReplaceValuesStatementError < GrafanaReporterError
     def initialize(statement)

data/lib/grafana_reporter/help.rb

@@ -18,11 +18,6 @@ module GrafanaReporter
       "#{toc}\n\n#{help_text(github_options.merge(level: headline_level))}"
     end
 
-    # @see AbstractQuery#self.build_demo_entry
-    def self.build_demo_entry(_panel)
-      'include::grafana_help[]'
-    end
-
     private
 
     def github_options
@@ -134,6 +129,7 @@ end}
       result
     end
 
+    # TODO: use same wording/grouping as in README file
     def raw_help_yaml
       <<~YAML_HELP
         global_options:

data/lib/grafana_reporter/panel_image_query.rb

@@ -5,9 +5,9 @@ module GrafanaReporter
   class PanelImageQuery < AbstractQuery
     # Sets the proper render variables.
     def pre_process
-      @from = translate_date(@from, @variables['grafana-report-timestamp'], false, @variables['from_timezone'] ||
+      @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'] ||
+      @to = translate_date(@to, @variables['grafana_report_timestamp'], true, @variables['to_timezone'] ||
                            @variables['grafana_default_to_timezone'])
       # TODO: ensure that in case of timezones are specified, that they are also forwarded to the image renderer
       # rename "render-" variables

data/lib/grafana_reporter/query_value_query.rb

@@ -8,15 +8,15 @@ module GrafanaReporter
     def pre_process
       @datasource = @panel.datasource if @panel
 
-      @from = translate_date(@from, @variables['grafana-report-timestamp'], false, @variables['from_timezone'] ||
+      @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'] ||
+      @to = translate_date(@to, @variables['grafana_report_timestamp'], true, @variables['to_timezone'] ||
                            @variables['grafana_default_to_timezone'])
       @variables['result_type'] ||= Variable.new('')
     end
 
-    # Executes {QueryMixin#format_columns}, {QueryMixin#replace_values} and
-    # {QueryMixin#filter_columns} on the query results.
+    # Executes {AbstractQuery#format_columns}, {AbstractQuery#replace_values} and
+    # {AbstractQuery#filter_columns} on the query results.
     #
     # Finally the results are formatted as a asciidoctor table.
     # @see Grafana::AbstractQuery#post_process

data/lib/ruby_grafana_extension.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative 'ruby_grafana_reporter'
+
+config = GrafanaReporter::Configuration.new
+config.config = GrafanaReporter::Application::Application.load_config
+
+GrafanaReporter::Asciidoctor::Report.new(config).register

data/lib/ruby_grafana_reporter.rb

@@ -18,12 +18,25 @@ require 'asciidoctor-pdf'
 require 'zip'
 require_relative 'VERSION'
 
+# TODO: show error in document, if grafana could not be accessed
+# TODO: show backtrace in extension error rescues
+# TODO: improve ERB calls
+# TODO: add test case for proper image generation
+# TODO: allow to choose report-class during execution, not mandatory by config file
+# TODO: add docu for ERB reports
+# TODO: add docu for custom plugins
+# TODO: add docu for webhook
+
+# TODO: enable as asciidoctor extension
+# TODO: build ADOC template as a result with resolved grafana content for further editing
+
 folders = [
   %w[grafana],
   %w[grafana_reporter logger],
   %w[grafana_reporter],
   %w[grafana_reporter asciidoctor extensions],
   %w[grafana_reporter asciidoctor],
+  %w[grafana_reporter erb],
   %w[grafana_reporter application]
 ]
 folders.each { |folder| Dir[File.join(__dir__, *folder, '*.rb')].sort.each { |file| require_relative file } }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-grafana-reporter
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Christian Kohlmeyer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-14 00:00:00.000000000 Z
+date: 2021-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
@@ -124,6 +124,7 @@ files:
 - "./lib/grafana/panel.rb"
 - "./lib/grafana/prometheus_datasource.rb"
 - "./lib/grafana/sql_datasource.rb"
+- "./lib/grafana/unsupported_datasource.rb"
 - "./lib/grafana/variable.rb"
 - "./lib/grafana/webrequest.rb"
 - "./lib/grafana_reporter/abstract_query.rb"
@@ -150,13 +151,15 @@ files:
 - "./lib/grafana_reporter/configuration.rb"
 - "./lib/grafana_reporter/console_configuration_wizard.rb"
 - "./lib/grafana_reporter/demo_report_wizard.rb"
+- "./lib/grafana_reporter/erb/report.rb"
 - "./lib/grafana_reporter/errors.rb"
 - "./lib/grafana_reporter/help.rb"
-- "./lib/grafana_reporter/logger/two_way_logger.rb"
+- "./lib/grafana_reporter/logger/two_way_delegate_logger.rb"
 - "./lib/grafana_reporter/panel_image_query.rb"
 - "./lib/grafana_reporter/panel_property_query.rb"
 - "./lib/grafana_reporter/query_value_query.rb"
 - "./lib/grafana_reporter/report_webhook.rb"
+- "./lib/ruby_grafana_extension.rb"
 - "./lib/ruby_grafana_reporter.rb"
 - LICENSE
 - README.md
@@ -175,7 +178,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.3
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="