ruby-grafana-reporter 0.1.7 → 0.2.0

data/lib/grafana_reporter/asciidoctor/report.rb

@@ -1,159 +1,177 @@
-module GrafanaReporter
-  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 = {})
-        super
-        @current_pos = 0
-        @image_files = []
-        @grafana_instances = {}
-      end
-
-      # Starts to create an asciidoctor report. It utilizes all {Extensions} to
-      # realize the conversion.
-      # @see AbstractReport#create_report
-      # @return [void]
-      def create_report
-        @start_time = Time.now
-        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.to_s)
-        logger.debug('Document attributes: ' + attrs.to_s)
-
-        initialize_step_counter
-
-        # register necessary extensions for the current report
-        ::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)
-
-        ::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
-        # TODO add tests for zipping results
-        if attrs['convert-backend'] != 'pdf'
-          dest_path = @destination_file_or_path
-          dest_path = @destination_file_or_path.path if @destination_file_or_path.is_a?(File)
-
-          # build zip file
-          zip_file = Tempfile.new("gf_zip")
-          Zip::File.open(zip_file.path, Zip::File::CREATE) do |zipfile|
-            # add report file
-            zipfile.get_output_stream(dest_path.gsub(@config.reports_folder, '') + ".#{attrs['convert-backend']}") { |f| f.puts 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) }
-            end
-          end
-
-          # replace original file with zip file
-          zip_file.rewind
-          begin
-            File.write(dest_path, zip_file.read)
-          rescue => e
-            logger.fatal("Could not overwrite report file '#{dest_path}' with ZIP file. (#{e.message}).")
-          end
-
-          # cleanup temporary zip file
-          zip_file.close
-          zip_file.unlink
-        end
-        
-        clean_image_files
-        @end_time = Time.now
-        logger.info('Report finished after ' + (@end_time - @start_time).to_s + ' seconds.')
-        @done = true
-      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
-      end
-
-      # Called to save a temporary image file. After the final generation of the
-      # report, these temporary files will automatically be removed.
-      # @param img_data [String] image file raw data, which shall be saved
-      # @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.write(img_data)
-        path = file.path.gsub(/#{@config.images_folder}/, '')
-
-        @image_files << file
-        file.close
-
-        path
-      end
-
-      # Called, if the report generation has died with an error.
-      # @param e [StandardError] occured error
-      # @return [void]
-      def died_with_error(e)
-        @error = [e.message] << [e.backtrace]
-        @end_time = Time.now
-        @done = true
-      end
-
-      private
-
-      def clean_image_files
-        @image_files.each(&:unlink)
-        @image_files = []
-      end
-      
-      def initialize_step_counter
-        @total_steps = 0
-        File.readlines(@template).each do |line|
-          begin
-            @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|grafana_panel_property|grafana_annotations|grafana_alerts|grafana_value_as_variable)/).length
-          rescue => e
-            logger.error("Could not process line '#{line}' (Error: #{e.message})")
-            raise e
-          end
-        end
-        logger.debug("Template #{@template} contains #{@total_steps.to_s} calls of grafana reporter functions.")
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module GrafanaReporter
+  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 = {})
+        super
+        @current_pos = 0
+        @image_files = []
+        @grafana_instances = {}
+      end
+
+      # Starts to create an asciidoctor report. It utilizes all {Extensions} to
+      # realize the conversion.
+      # @see AbstractReport#create_report
+      # @return [void]
+      def create_report
+        @start_time = Time.now
+        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
+
+        # register necessary extensions for the current report
+        ::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)
+
+        ::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 = 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
+
+          # build zip file
+          zip_file = Tempfile.new('gf_zip')
+          Zip::File.open(zip_file.path, Zip::File::CREATE) 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
+
+            # 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) }
+            end
+          end
+
+          # replace original file with zip file
+          zip_file.rewind
+          begin
+            File.write(dest_path, zip_file.read)
+          rescue StandardError => e
+            logger.fatal("Could not overwrite report file '#{dest_path}' with ZIP file. (#{e.message}).")
+          end
+
+          # cleanup temporary zip file
+          zip_file.close
+          zip_file.unlink
+        end
+
+        clean_image_files
+        @end_time = Time.now
+        logger.info("Report finished after #{@end_time - @start_time} seconds.")
+        @done = true
+      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
+      end
+
+      # Called to save a temporary image file. After the final generation of the
+      # report, these temporary files will automatically be removed.
+      # @param img_data [String] image file raw data, which shall be saved
+      # @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.write(img_data)
+        path = file.path.gsub(/#{@config.images_folder}/, '')
+
+        @image_files << file
+        file.close
+
+        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
+      end
+
+      private
+
+      def clean_image_files
+        @image_files.each(&:unlink)
+        @image_files = []
+      end
+
+      def initialize_step_counter
+        @total_steps = 0
+        File.readlines(@template).each do |line|
+          begin
+            @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|
+                                                         grafana_panel_property|grafana_annotations|grafana_alerts|
+                                                         grafana_value_as_variable)/x).length
+          rescue StandardError => e
+            logger.error("Could not process line '#{line}' (Error: #{e.message})")
+            raise e
+          end
+        end
+        logger.debug("Template #{@template} contains #{@total_steps} calls of grafana reporter functions.")
+      end
+    end
+  end
+end

data/lib/grafana_reporter/asciidoctor/sql_first_value_query.rb

@@ -1,34 +1,37 @@
-module GrafanaReporter
-  module Asciidoctor
-    # This class is being used to execute a SQL query against a grafana datasource.
-    # Only the first result in the first column will be returned as a single value.
-    class SqlFirstValueQuery < Grafana::AbstractSqlQuery
-      include QueryMixin
-
-      # Executes {QueryMixin#format_columns}, {QueryMixin#replace_values} and
-      # {QueryMixin#filter_columns} on the query results.
-      #
-      # Finally only the first value in the first row and the first column of
-      # will be returned.
-      # @return [void]
-      def post_process
-        results = preformat_sql_result(@result.body)
-        results = format_columns(results, @variables['format'])
-        results = replace_values(results, @variables.select { |k, _v| k =~ /^replace_values_\d+/ })
-        results = filter_columns(results, @variables['filter_columns'])
-        if @variables['filter_column']
-          @report.logger.warn("DEPRECATED: Call of  no longer supported function 'filter_column' has been found. Rename to 'filter_columns'")
-          results = filter_columns(results, @variables['filter_column'])
-        end
-
-        unless results[:content].empty?
-          unless results[:content][0].empty?
-            @result = results[:content][0][0]
-            return
-          end
-        end
-        @result = ''
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module GrafanaReporter
+  module Asciidoctor
+    # This class is being used to execute a SQL query against a grafana datasource.
+    # Only the first result in the first column will be returned as a single value.
+    class SqlFirstValueQuery < Grafana::AbstractSqlQuery
+      include QueryMixin
+
+      # Executes {QueryMixin#format_columns}, {QueryMixin#replace_values} and
+      # {QueryMixin#filter_columns} on the query results.
+      #
+      # Finally only the first value in the first row and the first column of
+      # will be returned.
+      # @return [void]
+      def post_process
+        results = preformat_sql_result(@result.body)
+        results = format_columns(results, @variables['format'])
+        results = replace_values(results, @variables.select { |k, _v| k =~ /^replace_values_\d+/ })
+        results = filter_columns(results, @variables['filter_columns'])
+        if @variables['filter_column']
+          @report.logger.warn("DEPRECATED: Call of  no longer supported function 'filter_column' has been found."\
+                              " Rename to 'filter_columns'")
+          results = filter_columns(results, @variables['filter_column'])
+        end
+
+        unless results[:content].empty?
+          unless results[:content][0].empty?
+            @result = results[:content][0][0]
+            return
+          end
+        end
+        @result = ''
+      end
+    end
+  end
+end

data/lib/grafana_reporter/asciidoctor/sql_table_query.rb

@@ -1,32 +1,39 @@
-module GrafanaReporter
-  module Asciidoctor
-    # This class is being used to execute a SQL query against a grafana datasource.
-    # The results will be formatted as as asciidoctor table.
-    class SqlTableQuery < Grafana::AbstractSqlQuery
-      include QueryMixin
-
-      # Executes {QueryMixin#format_columns}, {QueryMixin#replace_values} and
-      # {QueryMixin#filter_columns} on the query results.
-      #
-      # Finally the results are formatted as a asciidoctor table.
-      # @return [void]
-      def post_process
-        results = preformat_sql_result(@result.body)
-        results = format_columns(results, @variables['format'])
-        results = replace_values(results, @variables.select { |k, _v| k =~ /^replace_values_\d+/ })
-        results = filter_columns(results, @variables['filter_columns'])
-        if @variables['filter_column']
-          @report.logger.warn("DEPRECATED: Call of  no longer supported function 'filter_column' has been found. Rename to 'filter_columns'")
-          results = filter_columns(results, @variables['filter_column'])
-        end
-        results = transpose(results, @variables['transpose'])
-        row_divider = '| '
-        row_divider = @variables['row_divider'].raw_value if @variables['row_divider'].is_a?(Grafana::Variable)
-        column_divider = ' | '
-        column_divider = @variables['column_divider'].raw_value if @variables['column_divider'].is_a?(Grafana::Variable)
-
-        @result = results[:content].map { |row| row_divider + row.map { |item| column_divider == ' | ' ? item.to_s.gsub('|', '\\|') : item.to_s }.join(column_divider) }
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module GrafanaReporter
+  module Asciidoctor
+    # This class is being used to execute a SQL query against a grafana datasource.
+    # The results will be formatted as as asciidoctor table.
+    class SqlTableQuery < Grafana::AbstractSqlQuery
+      include QueryMixin
+
+      # Executes {QueryMixin#format_columns}, {QueryMixin#replace_values} and
+      # {QueryMixin#filter_columns} on the query results.
+      #
+      # Finally the results are formatted as a asciidoctor table.
+      # @return [void]
+      def post_process
+        results = preformat_sql_result(@result.body)
+        results = format_columns(results, @variables['format'])
+        results = replace_values(results, @variables.select { |k, _v| k =~ /^replace_values_\d+/ })
+        results = filter_columns(results, @variables['filter_columns'])
+        if @variables['filter_column']
+          @report.logger.warn("DEPRECATED: Call of  no longer supported function 'filter_column' has been found."\
+                              " Rename to 'filter_columns'")
+          results = filter_columns(results, @variables['filter_column'])
+        end
+        results = transpose(results, @variables['transpose'])
+        row_divider = '| '
+        row_divider = @variables['row_divider'].raw_value if @variables['row_divider'].is_a?(Grafana::Variable)
+        column_divider = ' | '
+        column_divider = @variables['column_divider'].raw_value if @variables['column_divider'].is_a?(Grafana::Variable)
+
+        @result = results[:content].map do |row|
+          row_divider + row.map do |item|
+            column_divider == ' | ' ? item.to_s.gsub('|', '\\|') : item.to_s
+          end.join(column_divider)
+        end
+      end
+    end
+  end
+end