bicho 0.0.17 → 0.0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a39452db1de9982c467632c0281411f7eba7cca7c12e16df8dd1e72bc85013ec
-  data.tar.gz: 727d92d8a6d8c01e2f063fe33289df527fdefd23eaa4243aeb852724bf5e1c8e
+  metadata.gz: 989cbc71faf777687a387a11719ff751e4379221924201ef1119299695cd9048
+  data.tar.gz: ed3b3d6edefe8f016ce659920465ac585fefaaa30f8e7d2f1b6bae287afbbec1
 SHA512:
-  metadata.gz: 860b3b7817b544b8e519deae0c359c42892b30726ae1f0bc1e51cdf79a9e5ff35c8afb67da810beace1e483929e0cbe86721f11a344cc760c493a40f444ec7f8
-  data.tar.gz: 2559b837eb36217d52477db9c9808292510cd967cb298046024e1550769e32462401a5e6dfedb1b302318e5bec2d8c0d92bb301020c5b025c48f4671a65728fa
+  metadata.gz: f6ed3ef1413ecb35359686c23ff4eff39442dc7f2e7513e881a57b20627be34795d7beecc4217b7e29c94ac3c9bba2bf91f4606e5072da0789e19023987bc97e
+  data.tar.gz: 37b5da1cad2f97e88def0bc0b2e4d3f65cdea47878101d201439781f710534edb1fcaf61a3552b89b7489525b9ac25b4b686e9db4b205166a5c0aa81f2a35c70

data/.rubocop.yml

@@ -1 +1,10 @@
 inherit_from: .rubocop_todo.yml
+
+Style/AsciiComments:
+  AllowedChars: ['ä', 'ü', 'ö']
+
+Metrics/ClassLength:
+  Enabled: false
+
+AllCops:
+  TargetRubyVersion: 2.3

data/.rubocop_todo.yml

@@ -6,13 +6,6 @@
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 1
-# Configuration parameters: Include.
-# Include: **/*.gemspec
-Gemspec/RequiredRubyVersion:
-  Exclude:
-    - 'bicho.gemspec'
-
 # Offense count: 1
 # Cop supports --auto-correct.
 Layout/ClosingHeredocIndentation:

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'http://rubygems.org'
 
 # Specify your gem's dependencies in bicho.gemspec

data/README.md

@@ -3,7 +3,7 @@
 * http://github.com/dmacvicar/bicho
 
 ![stable](https://img.shields.io/badge/stability-stable-green.svg)
-![maintained](https://img.shields.io/maintenance/yes/2018.svg)
+![maintained](https://img.shields.io/maintenance/yes/2019.svg)
 [![Build Status](https://travis-ci.org/dmacvicar/bicho.svg?branch=master)](https://travis-ci.org/dmacvicar/bicho)
 
 ## Introduction
@@ -19,10 +19,12 @@ Main use case is report generation, therefore only the following
 features are implemented right now:
 
 * get bugs
-* search bugs
+* search bugs (create queries)
 
 Plugins can be written to deal with specific bugzilla installations.
 
+Additionally, some utilities are provided, like exporting the total number of bugs of a query to the [Prometheus push gateway](https://prometheus.io/docs/practices/pushing/) format.
+
 ## Example (API)
 
 ### Client API

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 $LOAD_PATH.push(File.join(File.dirname(__FILE__), 'lib'))
 require 'bundler/gem_tasks'
 require 'bicho/version'
@@ -6,9 +8,8 @@ require 'rake/testtask'
 extra_docs = ['README*', 'TODO*', 'CHANGELOG*']
 
 task default: [:test]
-
 Rake::TestTask.new do |t|
-  t.test_files = Dir.glob(File.join(Dir.pwd, '/test/test_*.rb'))
+  t.pattern = 'test/test_*.rb'
   t.verbose = true if ENV['DEBUG']
 end
 

data/bicho.gemspec

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 $LOAD_PATH.push File.expand_path('lib', __dir__)
 require 'bicho/version'
 
+# rubocop:disable Metrics/BlockLength
 Gem::Specification.new do |s|
   s.name        = 'bicho'
   s.version     = Bicho::VERSION
@@ -13,7 +16,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency('highline', ['~> 2.0.0'])
   s.add_dependency('inifile', ['~> 3.0.0'])
-  s.add_dependency('nokogiri', ['~> 1.8.5'])
+  s.add_dependency('nokogiri', ['~> 1.10.4'])
   s.add_dependency('optimist', ['~> 3.0.0'])
   s.add_dependency('xmlrpc', ['~> 0.3.0'])
 
@@ -21,6 +24,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency('minitest-reporters')
   s.add_development_dependency('rake')
   s.add_development_dependency('rubocop', '~> 0.59.0')
+  s.add_development_dependency('solargraph')
   s.add_development_dependency('vcr')
   s.add_development_dependency('webmock')
 
@@ -32,3 +36,4 @@ Gem::Specification.new do |s|
   s.require_paths = ['lib']
   s.required_ruby_version = '>= 2.3'
 end
+# rubocop:enable Metrics/BlockLength

data/bin/bicho

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 #--
 # Copyright (c) 2011 SUSE LINUX Products GmbH
 #

data/lib/bicho.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #--
 # Copyright (c) 2011 SUSE LINUX Products GmbH
 #

data/lib/bicho/attachment.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #--
 # Copyright (c) 2016 SUSE LLC
 #

data/lib/bicho/bug.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bicho/query'
 
 module Bicho
@@ -85,6 +87,16 @@ module Bicho
       end
     end
 
+    # reopen a closed bug
+    # @param a String comment to add
+    # @param @optional a Boolean indicator if the new comment should be private (defaults to 'false')
+    #
+    # @returns id of re-opened bug
+    #
+    def reopen!(comment, is_private = false)
+      @client.update_bug(id, status: 'REOPENED', comment: { body: comment.to_s, is_private: is_private.to_b })
+    end
+
     # URL where the bug can be viewed
     # Example: http://bugs.foo.com/2345
     def url

data/lib/bicho/cli/command.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #--
 # Copyright (c) 2011 SUSE LINUX Products GmbH
 #

data/lib/bicho/cli/commands/attachments.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #--
 # Copyright (c) 2011 SUSE LINUX Products GmbH
 #

data/lib/bicho/cli/commands/history.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #--
 # Copyright (c) 2011 SUSE LINUX Products GmbH
 #

data/lib/bicho/cli/commands/reopen.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+#--
+# Copyright (c) 2011 SUSE LINUX Products GmbH
+#
+# Author: Klaus Kämpf <kkaempf@suse.de>
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#++
+
+require 'bicho/cli/command'
+require 'bicho/client'
+
+module Bicho
+  module CLI
+    module Commands
+      # Command to reopen a bug.
+      class Reopen < ::Bicho::CLI::Command
+        options do
+          opt :comment, 'Comment to add', type: :string
+          opt :private, 'Set the comment to private', type: :boolean
+        end
+
+        def do(global_opts, opts, args)
+          unless opts[:comment]
+            t.say('Reopen must have a comment')
+            return 1
+          end
+          client = ::Bicho::Client.new(global_opts[:bugzilla])
+          client.get_bugs(*args).each do |bug|
+            id = bug.reopen!(opts[:comment], opts[:private])
+            if id == bug.id
+              t.say("Bug #{id} reopened")
+            else
+              t.say("#{t.color('ERROR:', :error)} Failed to reopen bug #{id}")
+            end
+          end
+          0
+        end
+      end
+    end
+  end
+end

data/lib/bicho/cli/commands/search.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #--
 # Copyright (c) 2011 SUSE LINUX Products GmbH
 #
@@ -37,10 +39,12 @@ module Bicho::CLI::Commands
       Bicho::SEARCH_FIELDS.each do |field|
         opt field[0], field[2], type: field[1], multi: field[3]
       end
+      opt :format, 'Output format (json, prometheus)', type: :string
     end
 
     def do(global_opts, opts, _args)
       server = ::Bicho::Client.new(global_opts[:bugzilla])
+      Bicho.client = server
       # for most parameter we accept arrays, and also multi mode
       # this means parameters come in arrays of arrays
       query = ::Bicho::Query.new
@@ -53,8 +57,13 @@ module Bicho::CLI::Commands
         end
       end
 
-      server.search_bugs(query).each do |bug|
-        t.say("#{t.color(bug.id.to_s, :headline)} #{bug.summary}")
+      case opts[:format]
+      when 'prometheus'
+        STDOUT.puts Bicho::Export.to_prometheus_push_gateway(query)
+      else
+        server.search_bugs(query).each do |bug|
+          t.say("#{t.color(bug.id.to_s, :headline)} #{bug.summary}")
+        end
       end
       0
     end

data/lib/bicho/cli/commands/show.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #--
 # Copyright (c) 2011 SUSE LINUX Products GmbH
 #

data/lib/bicho/cli/commands/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #--
 # Copyright (c) 2011 SUSE LINUX Products GmbH
 #

data/lib/bicho/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #--
 # Copyright (c) 2011 SUSE LINUX Products GmbH
 #
@@ -207,6 +209,23 @@ module Bicho
       ret['id']
     end
 
+    # Update a bug
+    #
+    # @param id - bug number (Integer) or alias (String) of bug to be updated
+    # @param **kwargs - keyword-args containing optional/defaulted params
+    #
+    # @returns id of updated bug
+    #
+    def update_bug(id, **kwargs)
+      params = {}
+      params = params.merge(kwargs)
+      params[:ids] = normalize_ids [id]
+      ret = @client.call('Bug.update', params)
+      logger.info "Bug.update returned #{ret.inspect}"
+      handle_faults(ret)
+      ret.dig('bugs', 0, 'id')
+    end
+
     # Search for a bug
     #
     # +query+ has to be either a +Query+ object or

data/lib/bicho/common_client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #--
 # Copyright (c) 2011 SUSE LINUX Products GmbH
 #

data/lib/bicho/export.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 require 'json'
+require 'stringio'
 
 module Bicho
   # Utility methods for exporting bugs to other systems
@@ -11,5 +14,33 @@ module Bicho
       bug_h['resolution_time'] = Bicho::Reports.resolution_time(bug)
       JSON.generate(bug_h)
     end
+
+    # Export a query for usage as a metric in prometheus
+    # See https://github.com/prometheus/pushgateway
+    #
+    # The metric name will be 'bugs_total'
+    # See https://prometheus.io/docs/practices/naming/)
+    #
+    # And every attributed
+    # specified in the query will be used as a label
+    def self.to_prometheus_push_gateway(query)
+      buf = StringIO.new
+      dimensions = [:product, :status, :priority, :severity, :resolution, :component]
+      grouped = query.to_a.group_by do |i|
+        puts i
+        dimensions.map { |d| [d, i[d]] }.to_h
+      end
+
+      buf.write("# TYPE bugs_total gauge\n")
+      grouped.each do |attrs, set|
+        labels = attrs
+                 .map { |e| "#{e[0]}=\"#{e[1]}\"" }
+                 .join(',')
+        buf.write("bugs_total{#{labels}} #{set.size}\n")
+      end
+      buf.write("\n")
+      buf.close
+      buf.string
+    end
   end
 end

data/lib/bicho/ext/logger_colors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Colorizes the output of the standard library logger, depending on the logger level:
 # To adjust the colors, look at Logger::Colors::SCHEMA and Logger::Colors::constants
 
@@ -6,25 +8,25 @@ require 'logger'
 # Utility class to color output.
 class Logger
   module Colors
-    VERSION = '1.0.0'.freeze
-
-    NOTHING      = '0;0'.freeze
-    BLACK        = '0;30'.freeze
-    RED          = '0;31'.freeze
-    GREEN        = '0;32'.freeze
-    BROWN        = '0;33'.freeze
-    BLUE         = '0;34'.freeze
-    PURPLE       = '0;35'.freeze
-    CYAN         = '0;36'.freeze
-    LIGHT_GRAY   = '0;37'.freeze
-    DARK_GRAY    = '1;30'.freeze
-    LIGHT_RED    = '1;31'.freeze
-    LIGHT_GREEN  = '1;32'.freeze
-    YELLOW       = '1;33'.freeze
-    LIGHT_BLUE   = '1;34'.freeze
-    LIGHT_PURPLE = '1;35'.freeze
-    LIGHT_CYAN   = '1;36'.freeze
-    WHITE        = '1;37'.freeze
+    VERSION = '1.0.0'
+
+    NOTHING      = '0;0'
+    BLACK        = '0;30'
+    RED          = '0;31'
+    GREEN        = '0;32'
+    BROWN        = '0;33'
+    BLUE         = '0;34'
+    PURPLE       = '0;35'
+    CYAN         = '0;36'
+    LIGHT_GRAY   = '0;37'
+    DARK_GRAY    = '1;30'
+    LIGHT_RED    = '1;31'
+    LIGHT_GREEN  = '1;32'
+    YELLOW       = '1;33'
+    LIGHT_BLUE   = '1;34'
+    LIGHT_PURPLE = '1;35'
+    LIGHT_CYAN   = '1;36'
+    WHITE        = '1;37'
 
     SCHEMA = {
       STDOUT => %w(nothing green brown red purple cyan),

data/lib/bicho/history.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #--
 # Copyright (c) 2011 SUSE LINUX Products GmbH
 #

data/lib/bicho/logging.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #--
 # Copyright (c) 2011 SUSE LINUX Products GmbH
 #

data/lib/bicho/plugins/aliases.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bicho
   module Plugins
     # This plugin allows to specify shortcuts for bugzilla urls

data/lib/bicho/plugins/novell.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #--
 # Copyright (c) 2011 SUSE LINUX Products GmbH
 # =>
@@ -37,7 +39,7 @@ module Bicho
     # your oscrc.
     #
     class Novell
-      OSCRC_CREDENTIALS = 'https://api.opensuse.org'.freeze unless defined? OSCRC_CREDENTIALS
+      OSCRC_CREDENTIALS = 'https://api.opensuse.org' unless defined? OSCRC_CREDENTIALS
       DEFAULT_OSCRC_PATH = File.join(ENV['HOME'], '.oscrc') unless defined? DEFAULT_OSCRC_PATH
       DOMAINS = ['bugzilla.novell.com', 'bugzilla.suse.com'].freeze
       XMLRPC_DOMAINS = ['apibugzilla.novell.com', 'apibugzilla.suse.com'].freeze
@@ -77,7 +79,7 @@ module Bicho
       end
 
       def transform_api_url_hook(url, logger)
-        return url unless DOMAINS.map { |domain| url.host.include?(domain) }.any?
+        return url unless DOMAINS.map { |domain| url.host&.include?(domain) }.any?
 
         begin
           url = url.clone