lazylead 0.1.2 → 0.4.1

data/lib/lazylead/model.rb

@@ -22,11 +22,15 @@
 # ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
 # OR OTHER DEALINGS IN THE SOFTWARE.
 
-require "active_record"
+require "backtrace"
 require "require_all"
+require "forwardable"
+require "active_record"
 require_rel "task"
 require_rel "system"
+require_relative "cc"
 require_relative "log"
+require_relative "opts"
 require_relative "postman"
 require_relative "exchange"
 
@@ -64,7 +68,9 @@ module Lazylead
       opts.each_with_object({}) do |e, o|
         k = e[0]
         v = e[1]
-        v = ENV[v.slice(2, v.length - 3)] if v.start_with? "${"
+        if v.respond_to? :start_with?
+          v = ENV[v.slice(2, v.length - 3)] if v.start_with? "${"
+        end
         o[k] = v
       end
     end
@@ -88,35 +94,74 @@ module Lazylead
       belongs_to :team, foreign_key: "team_id"
       belongs_to :system, foreign_key: "system"
 
-      def exec(log = Log::NOTHING)
-        log.debug("Task ##{id} '#{name}' is started")
-        action.constantize
-              .new(log)
-              .run(system.connect(log), postman(log), props)
-        log.debug("Task ##{id} '#{name}' is completed")
+      def exec
+        sys = system.connect
+        opts = props
+        opts = detect_cc(sys) if opts.key? "cc"
+        action.constantize.new(log).run(sys, postman, opts)
+      end
+
+      def detect_cc(sys)
+        opts = props
+        opts["cc"] = CC.new.detect(opts["cc"], sys)
+        return opts.except "cc" if opts["cc"].is_a? EmptyCC
+        opts
       end
 
       def props
-        return @prop if defined? @prop
-        @prop = team.to_hash.merge(to_hash)
+        @props ||= begin
+                     if team.nil?
+                       Opts.new(env(to_hash))
+                     else
+                       Opts.new(env(team.to_hash.merge(to_hash)))
+                     end
+                   end
       end
 
-      def postman(log = Log::NOTHING)
+      def postman
         if props.key? "postman"
-          props["postman"].constantize.new(log)
+          props["postman"].constantize.new
         else
-          log.warn "No postman details provided, an local stub is used."
           Postman.new
         end
       end
     end
 
+    # A task with extended logging
+    # @see Lazylead::ORM::Task
+    class VerboseTask
+      extend Forwardable
+      def_delegators :@orig, :id, :name, :team, :to_s, :inspect, :props
+
+      def initialize(orig, log = Log.new)
+        @orig = orig
+        @log = log
+      end
+
+      def exec
+        Logging.mdc["tid"] = "task #{id}"
+        @log.debug "'#{name}' is started."
+        @log.warn "No postman, stub is used." unless props.key? "postman"
+        @log.warn "No team." if team.nil?
+        @orig.exec
+        @log.debug "'#{name}' is completed"
+      rescue StandardError => e
+        msg = <<~MSG
+          ll-006: Task ##{id} #{e} (#{e.class}) at #{self}
+          #{Backtrace.new(e) if ARGV.include? '--trace'}"
+        MSG
+        @log.error msg
+      ensure
+        Logging.mdc["tid"] = ""
+      end
+    end
+
     # Ticketing systems to monitor.
     class System < ActiveRecord::Base
       include ORM
 
       # Make an instance of ticketing system for future interaction.
-      def connect(log = Log::NOTHING)
+      def connect(log = Log.new)
         opts = to_hash
         if opts["type"].empty?
           log.warn "No task system details provided, an empty stub is used."
@@ -124,8 +169,7 @@ module Lazylead
         else
           opts["type"].constantize.new(
             env(opts.except("type", "salt")),
-            opts["salt"].blank? ? NoSalt.new : Salt.new(opts["salt"]),
-            log
+            opts["salt"].blank? ? NoSalt.new : Salt.new(opts["salt"])
           )
         end
       end

data/lib/lazylead/opts.rb

@@ -0,0 +1,68 @@
+# 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 "forwardable"
+
+module Lazylead
+  #
+  # Default options for all lazylead tasks.
+  #
+  # Author:: Yurii Dubinka (yurii.dubinka@gmail.com)
+  # Copyright:: Copyright (c) 2019-2020 Yurii Dubinka
+  # License:: MIT
+  class Opts
+    extend Forwardable
+    def_delegators :@origin, :[], :[]=, :to_s, :key?, :fetch, :merge
+
+    def initialize(origin = {})
+      @origin = origin
+    end
+
+    # 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?)
+    end
+
+    def blank?(key)
+      to_h[key].nil? || @origin[key].blank?
+    end
+
+    def to_h
+      @origin
+    end
+
+    # Default Jira options to use during search for all Jira-based tasks.
+    def jira_defaults
+      {
+        max_results: fetch("max_results", 50),
+        fields: jira_fields
+      }
+    end
+
+    # Default fields which to fetch within the Jira issue
+    def jira_fields
+      to_h.fetch("fields", "").split(",").map(&:to_sym)
+    end
+  end
+end

data/lib/lazylead/postman.rb

@@ -46,7 +46,7 @@ module Lazylead
   class Postman
     include Emailing
 
-    def initialize(log = Log::NOTHING)
+    def initialize(log = Log.new)
       @log = log
     end
 
@@ -54,25 +54,25 @@ module Lazylead
     # :opts   :: the mail configuration like to, from, cc, subject, template.
     def send(opts)
       html = make_body(opts)
-      cc = detect_cc(opts)
-      Mail.deliver do
-        to opts[:to] || opts["to"]
-        from opts["from"]
-        cc cc if opts.key? "cc"
-        subject opts["subject"]
-        html_part do
-          content_type "text/html; charset=UTF-8"
-          body html
-        end
+      mail = Mail.new
+      mail.to opts[:to] || opts["to"]
+      mail.from opts["from"]
+      mail.cc opts["cc"] if opts.key? "cc"
+      mail.subject opts["subject"]
+      mail.html_part do
+        content_type "text/html; charset=UTF-8"
+        body html
       end
+      add_attachments mail, opts
+      mail.deliver
       @log.debug "Email was generated from #{opts} and send by #{__FILE__}. " \
                  "Here is the body: #{html}"
     end
 
-    def detect_cc(opts)
-      cc = opts["cc"]
-      cc = split("cc", opts) if !cc.nil? && cc.include?(",")
-      cc
+    def add_attachments(mail, opts)
+      return unless opts.key? "attachments"
+      opts["attachments"].select { |a| File.file? a }
+                         .each { |a| mail.add_file a }
     end
   end
 end

data/lib/lazylead/schedule.rb

@@ -22,7 +22,7 @@
 # ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
 # OR OTHER DEALINGS IN THE SOFTWARE.
 
-require "json"
+require "active_support"
 require "rufus-scheduler"
 require_relative "log"
 require_relative "model"
@@ -40,7 +40,7 @@ module Lazylead
     #  schedule some task once or at particular time period like in next 200ms).
     #  For cron expressions we should define separate test suite which will test
     #  in parallel without blocking main CI process.
-    def initialize(log = Log::NOTHING, cling = true)
+    def initialize(log = Log.new, cling = true)
       @log = log
       @cling = cling
       @trigger = Rufus::Scheduler.new
@@ -51,7 +51,9 @@ module Lazylead
     def register(task)
       raise "ll-002: task can't be a null" if task.nil?
       @trigger.cron task.cron do
-        task.exec @log
+        ActiveRecord::Base.connection_pool.with_connection do
+          ORM::VerboseTask.new(task, @log).exec
+        end
       end
       @log.debug "Task scheduled: #{task}"
     end
@@ -73,7 +75,7 @@ module Lazylead
 
   # Fake application schedule for unit testing purposes
   class NoSchedule
-    def initialize(log = Log::NOTHING)
+    def initialize(log = Log.new)
       @log = log
     end
 

data/lib/lazylead/smtp.rb

@@ -34,7 +34,7 @@ module Lazylead
   # Copyright:: Copyright (c) 2019-2020 Yurii Dubinka
   # License:: MIT
   class Smtp
-    def initialize(log = Log::NOTHING, salt = NoSalt.new, opts = {})
+    def initialize(log = Log.new, salt = NoSalt.new, opts = {})
       @log = log
       @salt = salt
       @opts = opts

data/lib/lazylead/system/fake.rb

@@ -34,7 +34,7 @@ module Lazylead
       @issues = issues
     end
 
-    def issues(_)
+    def issues(*)
       @issues
     end
   end

data/lib/lazylead/system/jira.rb

@@ -23,6 +23,7 @@
 # OR OTHER DEALINGS IN THE SOFTWARE.
 
 require "jira-ruby"
+require "forwardable"
 require_relative "../salt"
 
 module Lazylead
@@ -35,7 +36,7 @@ module Lazylead
     # @todo #57/DEV The debug method should be moved outside of ctor.
     #  This was moved here from 'client' method because Rubocop failed the build
     #  due to 'Metrics/AbcSize' violation.
-    def initialize(opts, salt = NoSalt.new, log = Log::NOTHING)
+    def initialize(opts, salt = NoSalt.new, log = Log.new)
       @opts = opts
       @salt = salt
       @log = log
@@ -46,7 +47,7 @@ module Lazylead
 
     def issues(jql, opts = {})
       raw do |jira|
-        jira.Issue.jql(jql, opts).map { |i| Lazylead::Issue.new(i) }
+        jira.Issue.jql(jql, opts).map { |i| Lazylead::Issue.new(i, jira) }
       end
     end
 
@@ -136,8 +137,9 @@ module Lazylead
   # Copyright:: Copyright (c) 2019-2020 Yurii Dubinka
   # License:: MIT
   class Issue
-    def initialize(issue)
+    def initialize(issue, jira)
       @issue = issue
+      @jira = jira
     end
 
     def id
@@ -183,7 +185,10 @@ module Lazylead
     end
 
     def comments
-      @issue.comments
+      return @comments if defined? @comments
+      @comments = @jira.Issue.find(@issue.id, expand: "comments", fields: "")
+                       .comments
+                       .map { |c| Comment.new(c) }
     end
 
     def to_s
@@ -193,6 +198,14 @@ module Lazylead
     def inspect
       to_s
     end
+
+    def status
+      @issue.status.attrs["name"]
+    end
+
+    def post(markdown)
+      @issue.comments.build.save!(body: markdown)
+    end
   end
 
   # The jira issue comments
@@ -224,26 +237,56 @@ module Lazylead
     end
   end
 
+  # Comment in jira ticket
+  class Comment
+    def initialize(comment)
+      @comment = comment
+    end
+
+    # Check that comment has expected text
+    def include?(text)
+      @comment.attrs["body"].include? text
+    end
+  end
+
   # Jira instance without authentication in order to access public filters
   #  or dashboards.
   class NoAuthJira
-    def initialize(url, log = Log::NOTHING)
+    extend Forwardable
+    def_delegators :@jira, :issues, :raw
+
+    def initialize(url, path = "", log = Log.new)
       @jira = Jira.new(
-        { username: nil, password: nil, site: url, context_path: "" },
+        {
+          username: nil,
+          password: nil,
+          site: url,
+          context_path: path
+        },
         NoSalt.new,
         log
       )
     end
+  end
 
-    def issues(jql, opts = {})
-      @jira.issues(jql, opts)
+  # A fake jira system which allows to work with sub-tasks.
+  class Fake
+    def initialize(issues)
+      @issues = issues
+    end
+
+    def issues(*)
+      @issues
     end
 
     # Execute request to the ticketing system using raw client.
-    # For Jira the raw client is 'jira-ruby' gem.
-    def raw(&block)
-      raise "ll-07: No block given to method" unless block_given?
-      @jira.raw(&block)
+    def raw
+      raise "ll-08: No block given to method" unless block_given?
+      yield(OpenStruct.new(Issue: self))
+    end
+
+    def find(id)
+      @issues.detect { |i| i.id.eql? id }
     end
   end
 end

data/lib/lazylead/system/synced.rb

@@ -30,7 +30,8 @@ module Lazylead
       @sys = sys
     end
 
-    # @todo #/DEV Unit tests for 'issues' function
+    # @todo #/DEV Unit tests for 'issues' function, moreover the other methods
+    #  from ticketing system obj are required
     #
     def issues(jql)
       @mutex.synchronize do

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

@@ -0,0 +1,140 @@
+# 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"
+require_relative "../../email"
+require_relative "../../version"
+require_relative "../../postman"
+
+module Lazylead
+  module Task
+    #
+    # Evaluate ticket format and accuracy
+    #
+    # The task supports the following features:
+    #  - fetch issues from remote ticketing system by query
+    #  - evaluate each field within the ticket
+    #  - post the score to the ticket
+    class Accuracy
+      def initialize(log = Log.new)
+        @log = log
+      end
+
+      def run(sys, postman, opts)
+        require_rules
+        rules = opts.slice("rules", ",")
+                    .map(&:constantize)
+                    .map(&:new)
+        raised = sys.issues(opts["jql"], opts.jira_defaults)
+                    .map { |i| Score.new(i, opts, rules) }
+                    .each(&:evaluate)
+                    .each(&:post)
+        postman.send opts.merge(tickets: raised) unless raised.empty?
+      end
+
+      # Load all ticket accuracy rules for future verification
+      def require_rules
+        rules = File.dirname(__FILE__)
+        $LOAD_PATH.unshift(rules) unless $LOAD_PATH.include?(rules)
+      end
+    end
+  end
+
+  # The ticket score based on fields content.
+  class Score
+    attr_reader :issue, :total, :score, :accuracy
+
+    def initialize(issue, opts, rules)
+      @issue = issue
+      @link = opts["docs"]
+      @opts = opts
+      @rules = rules
+    end
+
+    # Estimate the ticket score and accuracy.
+    # Accuracy is a percentage between current score and maximum possible value.
+    def evaluate(digits = 2)
+      @total = @rules.map(&:score).sum
+      @score = @rules.select { |r| r.passed(@issue) }
+                     .map(&:score)
+                     .sum
+      @accuracy = (score / @total * 100).round(digits)
+    end
+
+    # Post the comment with score and accuracy to the ticket.
+    def post
+      @issue.post(comment) unless @opts.key? "silent"
+    end
+
+    # The jira comment in markdown format
+    def comment
+      comment = [
+        "Hi [~#{@issue.reporter.id}],",
+        "",
+        "The triage accuracy is '{color:#{color}}#{@score}{color}'" \
+          " (~{color:#{color}}#{@accuracy}%{color}), here are the reasons why:",
+        "|| Ticket requirement || Status || Field ||"
+      ]
+      @rules.each do |r|
+        comment << "|#{r.desc}|#{r.passed(@issue) ? '(/)' : '(-)'}|#{r.field}|"
+      end
+      comment << docs_link
+      comment << ""
+      comment << "Posted by [lazylead v#{Lazylead::VERSION}|" \
+                    "https://bit.ly/2NjdndS]."
+      comment.join("\r\n")
+    end
+
+    # Link to ticket formatting rules
+    def docs_link
+      if @link.nil? || @link.blank?
+        ""
+      else
+        "The requirements/examples of ticket formatting rules you may find " \
+          "[here|#{@link}]."
+      end
+    end
+
+    def color
+      if colors.nil? || !defined?(@score) || !@score.is_a?(Numeric)
+        return "#061306"
+      end
+      colors.reverse_each do |color|
+        return color.last if @accuracy >= color.first
+      end
+      "#061306"
+    end
+
+    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
+    end
+  end
+end