lazylead 0.5.1 → 0.7.0

data/lib/lazylead/log.rb

@@ -23,6 +23,7 @@
 # OR OTHER DEALINGS IN THE SOFTWARE.
 
 require "logging"
+require "colorize"
 require "forwardable"
 
 module Lazylead
@@ -68,7 +69,7 @@ module Lazylead
     Logging.appenders.stdout(
       "stdout",
       layout: Logging.layouts.pattern(
-        pattern: "[%d] %-5l [%X{tid}] %m\n",
+        pattern: "[%d] %-5l #{'[%X{tid}]'.colorize(:light_green)} %m\n",
         color_scheme: "bright"
       )
     )

data/lib/lazylead/model.rb

@@ -68,9 +68,7 @@ module Lazylead
       opts.each_with_object({}) do |e, o|
         k = e[0]
         v = e[1]
-        if v.respond_to? :start_with?
-          v = ENV[v.slice(2, v.length - 3)] if v.start_with? "${"
-        end
+        v = ENV[v.slice(2, v.length - 3)] if v.respond_to?(:start_with?) && v.start_with?("${")
         o[k] = v
       end
     end
@@ -80,6 +78,13 @@ module Lazylead
       JSON.parse(properties).to_h
     end
 
+    def to_h?
+      return true unless to_hash.nil?
+      false
+    rescue StandardError => _e
+      false
+    end
+
     def to_s
       attributes.map { |k, v| "#{k}='#{v}'" }.join(", ")
     end
@@ -99,6 +104,7 @@ module Lazylead
         sys = system.connect
         opts = props
         opts = detect_cc(sys) if opts.key? "cc"
+        opts["system"] = second_sys if opts.numeric? "system"
         action.constantize.new.run(sys, postman, opts)
       end
 
@@ -130,12 +136,12 @@ module Lazylead
 
       def props
         @props ||= begin
-                     if team.nil?
-                       Opts.new(env(to_hash))
-                     else
-                       Opts.new(env(team.to_hash.merge(to_hash)))
-                     end
-                   end
+          if team.nil?
+            Opts.new(env(to_hash))
+          else
+            Opts.new(env(team.to_hash.merge(to_hash)))
+          end
+        end
       end
 
       def postman
@@ -146,17 +152,21 @@ module Lazylead
         end
       end
 
+      def second_sys
+        sys = System.find(props["system"])
+        raise "ll-014: No ticketing system found for #{self}" if sys.nil?
+        sys.connect
+      end
+
       private
 
       # Parse scheduling #type and #unit
       def trigger
         @trigger ||= begin
-                       trg = schedule.split(":")
-                       unless trg.size == 2
-                         raise "ll-007: illegal schedule format '#{schedule}'"
-                       end
-                       trg.map(&:strip).map(&:chomp)
-                     end
+          trg = schedule.split(":")
+          raise "ll-007: illegal schedule format '#{schedule}'" unless trg.size == 2
+          trg.map(&:strip).map(&:chomp)
+        end
       end
     end
 
@@ -172,6 +182,10 @@ module Lazylead
         @log = log
       end
 
+      # @todo #/DEV Remove the suppression during next refactoring (or enhancements)
+      #  for the method below
+      #
+      # rubocop:disable Metrics/AbcSize
       def exec
         Logging.mdc["tid"] = "task #{id}"
         @log.debug "'#{name}' is started."
@@ -182,12 +196,13 @@ module Lazylead
       rescue StandardError => e
         msg = <<~MSG
           ll-006: Task ##{id} #{e} (#{e.class}) at #{self}
-          #{Backtrace.new(e) if ARGV.include? '--trace'}"
+          #{Backtrace.new(e) if ARGV.include? '--trace'}
         MSG
         @log.error msg
       ensure
         Logging.mdc["tid"] = ""
       end
+      # rubocop:enable Metrics/AbcSize
     end
 
     # Ticketing systems to monitor.

data/lib/lazylead/opts.rb

@@ -34,7 +34,8 @@ module Lazylead
   # License:: MIT
   class Opts
     extend Forwardable
-    def_delegators :@origin, :[], :[]=, :to_s, :key?, :fetch, :merge, :except
+    def_delegators :@origin, :[], :[]=, :to_s, :key?, :fetch, :except, :each,
+                   :each_pair, :sort_by
 
     def initialize(origin = {})
       @origin = origin
@@ -42,7 +43,14 @@ module Lazylead
 
     # Split text value by delimiter, trim all spaces and reject blank items
     def slice(key, delim)
-      to_h[key].split(delim).map(&:chomp).map(&:strip).reject(&:blank?)
+      return [] unless to_h.key? key
+      trim to_h[key].split(delim)
+    end
+
+    # Trim all spaces and reject blank items in array
+    def trim(arr)
+      return [] if arr.nil?
+      arr.map(&:chomp).map(&:strip).reject(&:blank?)
     end
 
     def blank?(key)
@@ -76,5 +84,60 @@ module Lazylead
       return Salt.new(sid).decrypt(text) if ENV.key? sid
       text
     end
+
+    def merge(args)
+      return self unless args.is_a? Hash
+      Opts.new @origin.merge(args)
+    end
+
+    # Construct html document from template and binds.
+    def msg_body(template = "template")
+      Email.new(
+        to_h[template],
+        to_h.merge(version: Lazylead::VERSION)
+      ).render
+    end
+
+    def msg_to(delim = ",")
+      sliced delim, :to, "to"
+    end
+
+    def msg_cc(delim = ",")
+      sliced delim, :cc, "cc"
+    end
+
+    def msg_from(delim = ",")
+      sliced delim, :from, "from"
+    end
+
+    def msg_attachments(delim = ",")
+      sliced(delim, :attachments, "attachments").select { |f| File.file? f }
+    end
+
+    #
+    # Find the option by key and split by delimiter
+    #   Opts.new("key" => "a,b").sliced(",", "key")     => [a, b]
+    #   Opts.new(key: "a,b").sliced(",", :key)          => [a, b]
+    #   Opts.new(key: "a,b").sliced(",", "key", :key)   => [a, b]
+    #   Opts.new(key: "").sliced ",", :key)             => []
+    #
+    def sliced(delim, *keys)
+      return [] if keys.empty?
+      key = keys.detect { |k| key? k }
+      val = to_h[key]
+      return [] if val.nil? || val.blank?
+      return val if val.is_a? Array
+      return [val] unless val.include? delim
+      slice key, delim
+    end
+
+    # Ensure that particular key from options is a positive numer
+    #   Opts.new("key" => "1").numeric? "key"   => true
+    #   Opts.new("key" => "0").numeric? "key"   => false
+    #   Opts.new("key" => ".").numeric? "key"   => false
+    #   Opts.new("key" => "nil").numeric? "key" => false
+    def numeric?(key)
+      to_h[key].to_i.positive?
+    end
   end
 end

data/lib/lazylead/postman.rb

@@ -44,8 +44,6 @@ module Lazylead
   # Copyright:: Copyright (c) 2019-2020 Yurii Dubinka
   # License:: MIT
   class Postman
-    include Emailing
-
     def initialize(log = Log.new)
       @log = log
     end
@@ -53,25 +51,29 @@ module Lazylead
     # Send an email.
     # :opts   :: the mail configuration like to, from, cc, subject, template.
     def send(opts)
-      html = make_body(opts)
+      if opts.msg_to.empty?
+        @log.warn "ll-013: Email can't be sent to '#{opts.msg_to}," \
+                  " more: '#{opts}'"
+      else
+        mail = make_email(opts)
+        mail.deliver
+        @log.debug "#{__FILE__} sent '#{mail.subject}' to '#{mail.to}'."
+      end
+    end
+
+    # Construct an email based on input arguments
+    def make_email(opts)
       mail = Mail.new
-      mail.to opts[:to] || opts["to"]
-      mail.from opts["from"]
-      mail.cc opts["cc"] if opts.key? "cc"
+      mail.to opts.msg_to
+      mail.from opts.msg_from
+      mail.cc opts.msg_cc if opts.key? "cc"
       mail.subject opts["subject"]
       mail.html_part do
         content_type "text/html; charset=UTF-8"
-        body html
+        body opts.msg_body
       end
-      add_attachments mail, opts
-      mail.deliver
-      @log.debug "#{__FILE__} sent email based on #{opts}."
-    end
-
-    def add_attachments(mail, opts)
-      return unless opts.key? "attachments"
-      opts["attachments"].select { |a| File.file? a }
-                         .each { |a| mail.add_file a }
+      opts.msg_attachments.each { |f| mail.add_file f }
+      mail
     end
   end
 end

data/lib/lazylead/salt.rb

@@ -39,6 +39,7 @@ module Lazylead
   #
   class Salt
     attr_reader :id
+
     #
     # Each salt should be defined as a environment variable with id, like
     #  salt1=E1F53135E559C253

data/lib/lazylead/smtp.rb

@@ -23,6 +23,7 @@
 # OR OTHER DEALINGS IN THE SOFTWARE.
 
 require "mail"
+require "colorize"
 require_relative "log"
 require_relative "salt"
 
@@ -45,7 +46,8 @@ module Lazylead
         Mail.defaults do
           delivery_method :test
         end
-        @log.warn "SMTP connection enabled in test mode."
+        @log.warn "SMTP connection enabled in " \
+                  "#{'test'.colorize(:light_yellow)} mode."
       else
         setup_smtp
       end

data/lib/lazylead/system/jira.rb

@@ -25,6 +25,7 @@
 require "jira-ruby"
 require "forwardable"
 require_relative "../salt"
+require_relative "../opts"
 
 module Lazylead
   # Jira system for manipulation with issues.
@@ -45,16 +46,32 @@ module Lazylead
                  " and salt #{@salt.id} (found=#{@salt.specified?})"
     end
 
-    def issues(jql, opts = {})
+    # Find the jira issues by 'JQL'
+    # @param 'jql' - Jira search query
+    # @param 'opts' - Parameters for Jira search query.
+    #   :max_results => maximum number of tickets per one iteration.
+    #   :fields      => ticket fields to be fetched like assignee, summary, etc.
+    def issues(jql, opts = { max_results: 50, fields: nil, expand: nil })
       raw do |jira|
-        jira.Issue.jql(jql, opts).map { |i| Lazylead::Issue.new(i, jira) }
+        start = 0
+        tickets = []
+        total = jira.Issue.jql(jql, max_results: 0)
+        @log.debug "Found #{total} ticket(s) in '#{jql}'"
+        loop do
+          tickets.concat(jira.Issue.jql(jql, opts.merge(start_at: start))
+                             .map { |i| Lazylead::Issue.new(i, jira) })
+          @log.debug "Fetched #{tickets.size}"
+          start += opts.fetch(:max_results, 50).to_i
+          break if start > total
+        end
+        tickets
       end
     end
 
     # Execute request to the ticketing system using raw client.
     # For Jira the raw client is 'jira-ruby' gem.
     def raw
-      raise "ll-06: No block given to method" unless block_given?
+      raise "ll-009: No block given to method" unless block_given?
       yield client
     end
 
@@ -160,7 +177,7 @@ module Lazylead
     end
 
     def url
-      @issue.attrs["self"].split("/rest/api/").first + "/browse/" + key
+      "#{@issue.attrs['self'].split('/rest/api/').first}/browse/#{key}"
     end
 
     def duedate
@@ -237,15 +254,23 @@ module Lazylead
 
     def add_label(label, *more)
       lbl = labels
+      lbl = [] if lbl.nil?
       lbl << label
       lbl += more if more.size.positive?
-      save!("fields" => { "labels" => lbl.uniq })
+      labels! lbl
     end
 
+    # Get the labels for a particular issue
     def labels
       fields["labels"]
     end
 
+    # Update the labels for a particular issue
+    def labels!(lbl)
+      return if lbl.nil? || lbl.empty?
+      save!("fields" => { "labels" => lbl.uniq })
+    end
+
     def save!(opts)
       @issue.save(opts)
     end
@@ -324,7 +349,7 @@ module Lazylead
 
     # Execute request to the ticketing system using raw client.
     def raw
-      raise "ll-08: No block given to method" unless block_given?
+      raise "ll-008: No block given to method" unless block_given?
       yield(OpenStruct.new(Issue: self))
     end
 

data/lib/lazylead/task/accuracy/accuracy.rb

@@ -81,7 +81,7 @@ module Lazylead
     def post
       return if @opts.key? "silent"
       @issue.post comment
-      @issue.add_label "LL.accuracy", grade(@accuracy)
+      @issue.add_label "LL.accuracy", "#{grade(@accuracy)}%"
     end
 
     # The jira comment in markdown format
@@ -114,9 +114,7 @@ module Lazylead
     end
 
     def color
-      if colors.nil? || !defined?(@score) || !@score.is_a?(Numeric)
-        return "#061306"
-      end
+      return "#061306" if colors.nil? || !defined?(@score) || !@score.is_a?(Numeric)
       colors.reverse_each do |color|
         return color.last if @accuracy >= color.first
       end
@@ -125,12 +123,12 @@ module Lazylead
 
     def colors
       @colors ||= begin
-                    JSON.parse(@opts["colors"])
-                        .to_h
-                        .to_a
-                        .each { |e| e[0] = e[0].to_i }
-                        .sort_by { |e| e[0] }
-                  end
+        JSON.parse(@opts["colors"])
+            .to_h
+            .to_a
+            .each { |e| e[0] = e[0].to_i }
+            .sort_by { |e| e[0] }
+      end
     end
 
     # Calculate grade for accuracy

data/lib/lazylead/task/accuracy/attachment.rb

@@ -27,10 +27,6 @@ require_relative "requirement"
 module Lazylead
   # Check that ticket has an attachment.
   class Attachment < Lazylead::Requirement
-    def initialize(desc, score, field)
-      super(desc, score, field)
-    end
-
     def passed(issue)
       issue.attachments.any?(&method(:matching))
     end

data/lib/lazylead/task/accuracy/logs.rb

@@ -27,14 +27,18 @@ require_relative "attachment"
 module Lazylead
   # Check that ticket has log file(s) in attachment.
   class Logs < Lazylead::Attachment
-    def initialize
+    def initialize(files = %w[log.zip logs.zip log.gz logs.gz log.tar.gz
+                              logs.tar.gz log.7z logs.7z log.tar logs.tar])
       super("Log files", 2, "Attachments")
+      @files = files
     end
 
-    # Ensure that ticket has a '*.log' file more '10KB'
+    # Ensure that ticket has a '*.log' file more '5KB'
     def matching(attachment)
-      attachment.attrs["size"].to_i > 10_240 &&
-        File.extname(attachment.attrs["filename"]).downcase.start_with?(".log")
+      name = attachment.attrs["filename"].downcase
+      return false unless attachment.attrs["size"].to_i > 5120
+      return true if File.extname(name).start_with? ".log", ".txt", ".out"
+      @files.any? { |l| name.end_with? l }
     end
   end
 end

data/lib/lazylead/task/accuracy/onlyll.rb

@@ -0,0 +1,148 @@
+# frozen_string_literal: true
+
+# The MIT License
+#
+# Copyright (c) 2019-2020 Yurii Dubinka
+#
+# 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 NON-INFRINGEMENT. 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_relative "../../log"
+require_relative "../../opts"
+
+module Lazylead
+  module Task
+    #
+    # Ensure that ticket accuracy evaluation labels are set only by LL, not by
+    #  some person.
+    #
+    # The task supports the following features:
+    #  - fetch issues from remote ticketing system by query
+    #  - check the history of labels modification
+    #  - remove evaluation labels if they set not by LL
+    class OnlyLL
+      def initialize(log = Log.new)
+        @log = log
+      end
+
+      def run(sys, postman, opts)
+        found = sys.issues(opts["jql"],
+                           opts.jira_defaults.merge(expand: "changelog"))
+                   .map { |i| Labels.new(i, opts) }
+                   .select(&:exists?)
+                   .reject(&:valid?)
+                   .each(&:remove)
+        postman.send opts.merge(tickets: found) unless found.empty?
+      end
+    end
+  end
+
+  # The ticket with grid labels
+  class Labels
+    attr_reader :issue
+
+    def initialize(issue, opts)
+      @issue = issue
+      @opts = opts
+    end
+
+    # Ensure that issue has evaluation labels for accuracy rules
+    def exists?
+      return false if @issue.labels.nil? || @issue.labels.empty?
+      return false unless @issue.labels.is_a? Array
+      grid.any? { |g| @issue.labels.any? { |l| g.eql? l } }
+    end
+
+    # Compare the score evaluated by LL and current ticket score.
+    # @return true if current score equal to LL evaluation
+    def valid?
+      score.eql?(@issue.labels.sort.find { |l| grid.any? { |g| l.eql? g } })
+    end
+
+    # Find expected ticket score evaluated by LL.
+    # If LL evaluated the same ticket several times (no matter why),
+    #  then the last score would be returned.
+    def score
+      to_l(
+        @issue.history
+              .select { |h| h["author"]["key"].eql? @opts["author"] }
+              .select { |h| to_l(h) }
+              .reverse
+              .first
+      ).fetch("toString", "").split.find { |l| grid.any? { |g| l.eql? g } }
+    end
+
+    # Find history record with labels changes.
+    def to_l(history)
+      return {} if history.nil? || history.empty?
+      history["items"].find { |f| f["field"].eql? "labels" }
+    end
+
+    # Detect the percentage grid for tickets, by default its 0%, 10%, 20%, etc.
+    def grid
+      @grid ||= begin
+        if @opts.key? "grid"
+          @opts.slice("grid", ",")
+        else
+          %w[0% 10% 20% 30% 40% 50% 60% 70% 80% 90% 100%]
+        end
+      end
+    end
+
+    # Remove score labels from the ticket.
+    def remove
+      @issue.labels!(@issue.labels - grid)
+    end
+
+    # Detect the violators with their changes.
+    #   .violators  => ["Tom Hhhh set 40%", "Bob Mmmm set 50%"]
+    def violators
+      @issue.history
+            .reject { |h| h["author"]["key"].eql? @opts["author"] }
+            .select { |h| grid?(h) }
+            .group_by { |h| h["author"]["key"] }
+            .map do |a|
+        "#{a.last.first['author']['displayName']} set #{hacked(a.last)}"
+      end
+    end
+
+    # Ensure that history record has label change related to LL grid labels.
+    # @return true if LL grid labels added
+    def grid?(record)
+      diff(record).any? { |d| d.find { |l| grid.any? { |g| l.eql? g } } }
+    end
+
+    # Detect label diff in single history record from ticket's history.
+    def diff(record)
+      record["items"].select { |f| f["field"].eql? "labels" }
+                     .reject { |f| f["toString"].nil? || f["toString"].blank? }
+                     .map do |f|
+        from = []
+        from = f["fromString"].split unless f["fromString"].nil?
+        f["toString"].split - from
+      end
+    end
+
+    # Hacked score by violator in ticket's history.
+    def hacked(record)
+      diff(record.first)
+        .first
+        .find { |l| grid.any? { |g| l.eql? g } }
+    end
+  end
+end