ruby-grafana-reporter 0.9.3 → 0.9.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c90ce3f15b0a5fa90cb7569a54467e10a251fce77d3642b75053b6792288d72d
-  data.tar.gz: 3855618dd7c3a721340516b7949777f2efe045a0c093f0d1b7d3457eb1bcfc01
+  metadata.gz: 57a3edcb1aa6c41ed2a26688dc6a8a80fba3b9169aa79ee061eeb2d2c0df1cb9
+  data.tar.gz: 897ae84eb2672b645528e118ff7107e2fab7a4f334f63a4c87bb29a020cf93a8
 SHA512:
-  metadata.gz: a7d90bac8d4dee595da22401d53f27380d4119ccca5df73020ae6abd12eb71ad4cee577f9b8bfc4200ca73e90a4467060aab6e3ffcb6db52af4682c1926f2feb
-  data.tar.gz: 6851b6fc6714cf4376499dc585449040ed2f341536c80856c012eaf58bacdaca2f71813f66e07ce6c18926c973f3586cb364eedbb8896c66fea61f9674c0a17e
+  metadata.gz: b3889cace3794d62bfd50978a24c4eb39cda1148398a4bed8c4354d5c51ad339faa7da7a81b4f001cb29c383ac98334494520a9cbeec2b44019dcafae883bfdb
+  data.tar.gz: 9a7fbf743f0e48e114deaa1d518ba993ea0318229ab391d90481bad43f859b20fca9f8ffaafe6799729a81ace22673d4904797963c776cf9a22c942289f35c23

data/lib/VERSION.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 # Version information
-GRAFANA_REPORTER_VERSION = [0, 9, 3].freeze
+GRAFANA_REPORTER_VERSION = [0, 9, 4].freeze
 # Release date
-GRAFANA_REPORTER_RELEASE_DATE = '2024-07-13'
+GRAFANA_REPORTER_RELEASE_DATE = '2024-08-22'

data/lib/grafana/dashboard.rb

@@ -62,8 +62,7 @@ module Grafana
         begin
           @variables << Variable.new(item, self)
         rescue => e
-          # TODO: show this message as a warning - needs test cleanup
-          @grafana.logger.debug(e.message)
+          @grafana.logger.warn(e.message)
         end
       end
     end

data/lib/grafana/grafana_alerts_datasource.rb

@@ -23,6 +23,7 @@ module Grafana
 
       result = webrequest.execute(query_description[:timeout])
       return unless result
+      return result.body unless result.code.to_s == "200"
 
       json = JSON.parse(result.body)
 

data/lib/grafana/variable.rb

@@ -240,7 +240,7 @@ module Grafana
         if !@config['current'].nil?
           self.raw_value = @config['current']['value']
         else
-          raise GrafanaError.new("Grafana variable with type '#{@config['type']}' and name '#{@config['name']}' cannot be handled properly by the reporter. Check your results and raise a ticket on github.")
+          raise GrafanaError.new("Dashboard variable with type '#{@config['type']}' and name '#{@config['name']}' cannot be handled properly by the reporter in queries. Check your resulting report and raise a ticket on github if you face issues.")
         end
       end
     end

data/lib/grafana_reporter/application/application.rb

@@ -134,6 +134,7 @@ module GrafanaReporter
           begin
             template_ext = config.report_class.default_template_extension
             report_ext = config.report_class.default_result_extension
+            report_ext = 'zip' if config.default_document_attributes["convert-backend"] != "pdf" and not config.default_document_attributes["convert-backend"].nil?
             default_to_file = File.basename(config.template.to_s.gsub(/(?:\.#{template_ext})?$/, ".#{report_ext}"))
 
             to_file = config.to_file

data/lib/grafana_reporter/asciidoctor/panel_query_table_include_processor.rb

@@ -80,6 +80,7 @@ module GrafanaReporter
       # @see ProcessorMixin#build_demo_entry
       def build_demo_entry(panel)
         return nil unless panel
+        return nil unless panel.model['targets']
 
         ref_id = nil
         panel.model['targets'].each do |item|

data/lib/grafana_reporter/asciidoctor/panel_query_value_inline_macro.rb

@@ -74,6 +74,7 @@ module GrafanaReporter
       # @see ProcessorMixin#build_demo_entry
       def build_demo_entry(panel)
         return nil unless panel
+        return nil unless panel.model['targets']
 
         ref_id = nil
         panel.model['targets'].each do |item|

data/lib/grafana_reporter/asciidoctor/report.rb

@@ -41,36 +41,29 @@ module GrafanaReporter
         ::Asciidoctor.convert_file(@template, extension_registry: registry, backend: attrs['convert-backend'],
                                               to_file: path, attributes: attrs, header_footer: true)
 
-        # store report including als images as ZIP file, if the result is not a PDF
+        # store report including all images as ZIP file, if the result is not a PDF
         if attrs['convert-backend'] != 'pdf'
           # build zip file
-          zip_file = Tempfile.new('gf_zip')
           buffer = Zip::OutputStream.write_buffer do |zipfile|
             # add report file
-            zipfile.put_next_entry("#{path.gsub(@config.reports_folder, '')}.#{attrs['convert-backend']}")
-            zipfile.write File.read(path)
+            zipfile.put_next_entry("#{path.gsub(@config.reports_folder, '').gsub(/\.[\w\d]+$/, '')}.#{attrs['convert-backend']}")
+            zipfile.write File.open(path, 'rb') { |f| f.read }
 
             # add image files
             @image_files.each do |file|
               zipfile.put_next_entry(file.path.gsub(@config.images_folder, ''))
-              zipfile.write File.read(file.path)
+              zipfile.write File.open(file.path, 'rb') { |f| f.read }
             end
           end
-          File.open(zip_file, 'wb') do |f|
-            f.write buffer.string
-          end
 
-          # replace original file with zip file
-          zip_file.rewind
+          # write zip file
           begin
-            File.write(path, zip_file.read)
+            File.open(path, 'wb') do |f|
+              f.write buffer.string
+            end
           rescue StandardError => e
-            logger.fatal("Could not overwrite report file '#{path}' with ZIP file. (#{e.message}).")
+            logger.fatal("Could not overwrite file '#{path}' with zipped file. (#{e.message}).")
           end
-
-          # cleanup temporary zip file
-          zip_file.close
-          zip_file.unlink
         end
 
         clean_image_files

data/lib/grafana_reporter/asciidoctor/sql_table_include_processor.rb

@@ -84,6 +84,8 @@ module GrafanaReporter
           end
         end
         return nil unless ref_id
+        # FIXME this filters out e.g. prometheus in demo reports, as the query method returns a Hash instead of a string
+        return nil unless panel.query(ref_id).is_a?(String)
 
         "|===\ninclude::grafana_sql_table:#{panel.dashboard.grafana.datasource_by_model_entry(panel.model['datasource']).id}"\
         "[sql=\"#{panel.query(ref_id).gsub(/"/, '\"').gsub("\r\n", ' ').gsub("\n", ' ').gsub(/\\/, '\\\\')}\",filter_columns=\"time\","\

data/lib/grafana_reporter/asciidoctor/sql_value_inline_macro.rb

@@ -89,6 +89,8 @@ module GrafanaReporter
           end
         end
         return nil unless ref_id
+        # FIXME this filters out e.g. prometheus in demo reports, as the query method returns a Hash instead of a string
+        return nil unless panel.query(ref_id).is_a?(String)
 
         "grafana_sql_value:#{panel.dashboard.grafana.datasource_by_model_entry(panel.model['datasource']).id}"\
         "[sql=\"#{panel.query(ref_id).gsub(/"/, '\"').gsub("\r\n", ' ').gsub("\n", ' ').gsub(/\\/, '\\\\')}\",from=\"now-1h\","\

data/lib/grafana_reporter/console_configuration_wizard.rb

@@ -319,8 +319,10 @@ default-document-attributes:
     end
 
     def user_input(text, default)
+      $stdout.sync = true
       print "#{text} [#{default}]: "
-      input = gets.gsub(/\n$/, '')
+      $stdout.sync = false
+      input = gets.gsub(/[\n\r]*$/, '')
       input = default if input.empty?
       input
     end

data/lib/ruby_grafana_reporter.rb

@@ -1,9 +1,6 @@
 # frozen_string_literal: true
 
-require 'rubygems'
-require 'rubygems/name_tuple'
-require 'rubygems/specification_policy'
-require 'rubygems/ext'
+require 'rubygems' # for OCRAN
 require 'net/http'
 require 'fileutils'
 require 'yaml'
@@ -17,7 +14,7 @@ require 'date'
 require 'time'
 require 'logger'
 require 'asciidoctor'
-require 'asciidoctor/extensions'
+require 'asciidoctor/converter/html5' # for OCRAN
 require 'asciidoctor-pdf'
 require 'zip'
 require_relative 'VERSION'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-grafana-reporter
 version: !ruby/object:Gem::Version
-  version: 0.9.3
+  version: 0.9.4
 platform: ruby
 authors:
 - Christian Kohlmeyer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-07-13 00:00:00.000000000 Z
+date: 2024-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor