lazylead 0.4.3 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd5d4e1e8d89064bfa868e1c088166d3a42b4c155fde98246979a262854d15b0
-  data.tar.gz: fa0d3aefc186740945b1da68318aebe1d597d7b88f70b079644058f5e201126b
+  metadata.gz: a8358ec8da9d97621f9c5ec28ddfa3114699f260af8ae4fd9632a998263f795e
+  data.tar.gz: 4a11f6cbd5cffbc91a2b40a5b7fb6c82d608301d16ebba1d8b2155a256101f48
 SHA512:
-  metadata.gz: 7b018d644048900e19d03bbf8b24847a0b617ba74721f213743687b90d1cc2078ca84f35af29c2660b73207e5fc5b86d4b9e45d3394d9c095645198400602dfe
-  data.tar.gz: 842cf53e33f2376891d80dcd7f7802f2a27a37bf26ea42a55c88d4b53925b6a161b3962cbc7df0467c2c1049532db8029977c78776340e938cc20f757f5d89b3
+  metadata.gz: 31259a7b7305b519f610e68dbbb7649fee65257415aae4a0bfe1a77bdd88f62662279a4689bb18872d37eba4d8c0b6537ddf5f1a1c415762085e507fb39d05ae
+  data.tar.gz: 2c6bc24efc4696496c8a0c58c697af93377bc7c6d216141138ce8d18f3606104e7a945c715d3657ebc97ede3f97db586da3a6fe57c01f826eb86c61f024f91b7

data/.docs/accuracy.md

@@ -66,7 +66,7 @@ For simplicity, we are using [docker-compose](https://docs.docker.com/compose/):
                values (1,'{"type":"Lazylead::Jira", "username":"${jira_user}", "password":"${jira_password}", "site":"${jira_url}", "context_path":""}');
     insert into tasks (name, cron, enabled, id, system, team_id, action, properties)
                values ('Post ticket score and accuracy to the tickets', 
-                       '0 8 * * 1-5', 
+                       'cron:0 8 * * 1-5', 
                        'true',
                        1, 1, 1, 
                        'Lazylead::Task::Accuracy',
@@ -82,7 +82,7 @@ For simplicity, we are using [docker-compose](https://docs.docker.com/compose/):
                         }
                        ');
     ```
-    Yes, for task scheduling we are using [cron](https://crontab.guru).
+    Yes, for task scheduling we are using [cron](https://crontab.guru) here, but you may use other scheduling types from [rufus-scheduler](https://github.com/jmettraux/rufus-scheduler).
 
 4.  Once you changed `./ll.db`, please restart the container using `docker-compose -f .github/tasks.yml restart`
     ```bash

data/.docs/duedate_expired.md

@@ -68,16 +68,16 @@ For simplicity, we are using [docker-compose](https://docs.docker.com/compose/):
                values (1, 'Dream team with lazylead', '{}');
     insert into systems(id, properties)    
                values (1,'{"type":"Lazylead::Jira", "username":"${jira_user}", "password":"${jira_password}", "site":"${jira_url}", "context_path":""}');
-    insert into tasks (name, cron, enabled, id, system, team_id, action, properties)
+    insert into tasks (name, schedule, enabled, id, system, team_id, action, properties)
                values ('Expired due dates', 
-                       '0 8 * * 1-5', 
+                       'cron:0 8 * * 1-5', 
                        'true',
                        1, 1, 1, 
                        'Lazylead::Task::AssigneeAlert',
                        '{"sql":"filter=222", "cc":"<youremail.com>", "subject":"[LL] Expired due dates", "template":"lib/messages/due_date_expired.erb", "postman":"Lazylead::Exchange"}');
     
     ```
-    Yes, for task scheduling we are using [cron](https://crontab.guru).
+    Yes, for task scheduling we are using [cron](https://crontab.guru) here, but you may use other scheduling types from [rufus-scheduler](https://github.com/jmettraux/rufus-scheduler).
 
 4.  Once you changed `./ll.db`, please restart the container using `docker-compose -f .github/tasks.yml restart`
     ```bash

data/.docs/propagate_down.md

@@ -58,16 +58,16 @@ For simplicity, we are using [docker-compose](https://docs.docker.com/compose/):
                values (1, 'Dream team with lazylead', '{}');
     insert into systems(id, properties)    
                values (1,'{"type":"Lazylead::Jira", "username":"${jira_user}", "password":"${jira_password}", "site":"${jira_url}", "context_path":""}');
-    insert into tasks (name, cron, enabled, id, system, team_id, action, properties)
+    insert into tasks (name, schedule, enabled, id, system, team_id, action, properties)
                values ('Propagate customfield_1 (External ID) to sub-tasks', 
-                       '0 8 * * 1-5', 
+                       'cron:0 8 * * 1-5', 
                        'true',
                        1, 1, 1, 
                        'Lazylead::Task::PropagateDown',
                        '{"jql":"filter=222", "propagate":"customfield_1"}');
     
     ```
-    Yes, for task scheduling we are using [cron](https://crontab.guru).
+    Yes, for task scheduling we are using [cron](https://crontab.guru) here, but you may use other scheduling types from [rufus-scheduler](https://github.com/jmettraux/rufus-scheduler).
 
 4.  Once you changed `./ll.db`, please restart the container using `docker-compose -f .github/tasks.yml restart`
     ```bash

data/.gitattributes

@@ -7,3 +7,4 @@
 *.xml ident
 *.png binary
 *.pdf binary
+*.db binary

data/Rakefile

@@ -127,4 +127,6 @@ task :docker do
   system "docker-compose -f .docker/docker-compose.yml build "\
           " --build-arg release_tags='latest 1.0'"\
           " --build-arg version=1.0"
+  system "docker-compose -f .docker/docker-compose.yml rm --force -s lazylead"
+  system "docker-compose -f .docker/docker-compose.yml up"
 end

data/bin/lazylead

@@ -82,7 +82,7 @@ log.debug("Memory footprint at start is #{Lazylead::Allocated.new}")
 cmd = lambda do
   Lazylead::CLI::App.new(
     log,
-    Lazylead::Schedule.new(log),
+    Lazylead::Schedule.new(log: log),
     Lazylead::Smtp.new(
       log, Lazylead::Salt.new("smtp_salt"),
       smtp_host: ENV["smtp_host"],

data/lazylead.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |s|
   s.rubygems_version = "2.2"
   s.required_ruby_version = ">=2.6.5"
   s.name = "lazylead"
-  s.version = "0.4.3"
+  s.version = "0.5.0"
   s.license = "MIT"
   s.summary = "Eliminate the annoying work within bug-trackers."
   s.description = "Ticketing systems (Github, Jira, etc.) are strongly
@@ -45,7 +45,7 @@ tasks instead of solving technical problems."
   s.authors = ["Yurii Dubinka"]
   s.email = "yurii.dubinka@gmail.com"
   s.homepage = "http://github.com/dgroup/lazylead"
-  s.post_install_message = "Thanks for installing Lazylead v0.4.3!
+  s.post_install_message = "Thanks for installing Lazylead v0.5.0!
   Read our blog posts: https://lazylead.org
   Stay in touch with the community in Telegram: https://t.me/lazylead
   Follow us on Twitter: https://twitter.com/lazylead

data/lib/lazylead/exchange.rb

@@ -54,19 +54,26 @@ module Lazylead
     def send(opts)
       to = opts["to"] || opts[:to]
       to = [to] unless to.is_a? Array
-      html = make_body(opts)
-      msg = {
-        subject: opts["subject"],
-        body: html,
-        body_type: "HTML",
-        to_recipients: to
-      }
+      if to.reject { |e| e.nil? || e.blank? }.empty?
+        @log.warn "Email can't be sent to '#{to}, more: '#{opts}'"
+        return
+      end
+      msg = make_msg(to, opts)
       msg.update(cc_recipients: opts["cc"]) if opts.key? "cc"
       add_attachments(msg, opts)
       cli.send_message msg
       close_attachments msg
       @log.debug "Email was generated from #{opts} and send by #{__FILE__}. " \
-                 "Here is the body: #{html}"
+                 "Here is the body: '#{msg[:body]}'"
+    end
+
+    def make_msg(to, opts)
+      {
+        subject: opts["subject"],
+        body: make_body(opts),
+        body_type: "HTML",
+        to_recipients: to
+      }
     end
 
     def add_attachments(msg, opts)

data/lib/lazylead/model.rb

@@ -94,6 +94,7 @@ module Lazylead
       belongs_to :team, foreign_key: "team_id"
       belongs_to :system, foreign_key: "system"
 
+      # Execute task
       def exec
         sys = system.connect
         opts = props
@@ -101,6 +102,25 @@ module Lazylead
         action.constantize.new.run(sys, postman, opts)
       end
 
+      # Scheduling type.
+      # Current implementation is based on 'rufus-scheduler' gem and supports
+      #  the following types: 'cron', 'interval', 'in', 'at', 'every'
+      def type
+        trigger.first
+      end
+
+      # Scheduling unit.
+      # Current implementation is based on 'rufus-scheduler' gem thus each
+      # scheduling type has own arguments:
+      #  1. Scheduling type 'cron' has 'unit' = '00 09 * * *'
+      #  2. Scheduling type 'interval' has 'unit' = '2h'
+      #  3. Scheduling type 'every' has 'unit' = '3h'
+      #  4. Scheduling type 'in' has 'unit' = '10d'
+      #  5. Scheduling type 'at' has 'unit' = '2014/12/24 2000'
+      def unit
+        trigger.last
+      end
+
       def detect_cc(sys)
         opts = props
         opts["cc"] = CC.new.detect(opts["cc"], sys)
@@ -125,13 +145,27 @@ module Lazylead
           Postman.new
         end
       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
+      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_delegators :@orig, :id, :name, :team, :to_s, :inspect, :props, :type,
+                     :unit
 
       def initialize(orig, log = Log.new)
         @orig = orig

data/lib/lazylead/opts.rb

@@ -23,6 +23,7 @@
 # OR OTHER DEALINGS IN THE SOFTWARE.
 
 require "forwardable"
+require_relative "salt"
 
 module Lazylead
   #
@@ -64,5 +65,16 @@ module Lazylead
     def jira_fields
       to_h.fetch("fields", "").split(",").map(&:to_sym)
     end
+
+    # Decrypt particular option using cryptography salt
+    # @param key option to be decrypted
+    # @param sid the name of the salt to be used for the description
+    # @see Lazylead::Salt
+    def decrypt(key, sid)
+      text = to_h[key]
+      return text if text.blank? || text.nil?
+      return Salt.new(sid).decrypt(text) if ENV.key? sid
+      text
+    end
   end
 end

data/lib/lazylead/schedule.rb

@@ -34,23 +34,18 @@ module Lazylead
   # Copyright:: Copyright (c) 2019-2020 Yurii Dubinka
   # License:: MIT
   class Schedule
-    # @todo #/DEV New scheduling types like 'at', 'once' is required.
-    #  The minimum time period for cron is 1 minute and it's not suitable for
-    #  unit testing, thus its better to introduce new types which allows to
-    #  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.new, cling = true)
+    def initialize(log: Log.new, cling: true, trigger: Rufus::Scheduler.new)
       @log = log
       @cling = cling
-      @trigger = Rufus::Scheduler.new
+      @trigger = trigger
     end
 
-    # @todo #/DEV error code is required for reach 'raise' statement within the
-    #  application.
+    # @todo #/DEV error code is required for each 'raise' statement within the
+    #  application. Align the naming of existing one, the error code should be
+    #  like ll-xxx.
     def register(task)
       raise "ll-002: task can't be a null" if task.nil?
-      @trigger.cron task.cron do
+      @trigger.method(task.type).call(task.unit) do
         ActiveRecord::Base.connection_pool.with_connection do
           ORM::VerboseTask.new(task, @log).exec
         end
@@ -60,7 +55,9 @@ module Lazylead
 
     # @todo #/DEV inspect the current execution status. This method should
     #  support several format for output, by default is `json`.
-    def ps; end
+    def ps
+      @log.debug "#{self}#ps"
+    end
 
     def join
       @trigger.join if @cling
@@ -80,11 +77,15 @@ module Lazylead
     end
 
     def register(task)
-      @log.debug("Task registered: #{task}")
+      @log.debug "Task registered: #{task}"
     end
 
-    def ps; end
+    def ps
+      @log.debug "#{self}#ps"
+    end
 
-    def join; end
+    def join
+      @log.debug "#{self}#join"
+    end
   end
 end

data/lib/lazylead/system/jira.rb

@@ -150,6 +150,11 @@ module Lazylead
       @issue.key
     end
 
+    def description
+      return "" if @issue.description.nil?
+      @issue.description
+    end
+
     def summary
       fields["summary"]
     end
@@ -175,9 +180,24 @@ module Lazylead
     end
 
     def fields
+      return {} if @issue.nil?
+      return {} unless @issue.respond_to? :fields
+      return {} if @issue.fields.nil?
+      return {} unless @issue.fields.respond_to? :[]
       @issue.fields
     end
 
+    def [](name)
+      return "" if fields[name].nil? || fields[name].blank?
+      fields[name]
+    end
+
+    def components
+      return [] unless @issue.respond_to? :components
+      return [] if @issue.components.nil?
+      @issue.components.map(&:name)
+    end
+
     def history
       return [] unless @issue.respond_to? :changelog
       return [] if @issue.changelog == nil? || @issue.changelog.empty?
@@ -206,6 +226,25 @@ module Lazylead
     def post(markdown)
       @issue.comments.build.save!(body: markdown)
     end
+
+    def remote_links
+      @issue.remotelink.all
+    end
+
+    def attachments
+      @issue.attachments
+    end
+
+    def add_label(label, *more)
+      labels = @issue.labels
+      labels << label
+      labels += more if more.size.positive?
+      save!("fields" => { "labels" => labels.uniq })
+    end
+
+    def save!(opts)
+      @issue.save(opts)
+    end
   end
 
   # The jira issue comments

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

@@ -43,7 +43,7 @@ module Lazylead
       end
 
       def run(sys, postman, opts)
-        require_rules
+        Dir[File.join(__dir__, "*.rb")].sort.each { |f| require f }
         rules = opts.slice("rules", ",")
                     .map(&:constantize)
                     .map(&:new)
@@ -53,12 +53,6 @@ module Lazylead
                     .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
 
@@ -85,7 +79,9 @@ module Lazylead
 
     # Post the comment with score and accuracy to the ticket.
     def post
-      @issue.post(comment) unless @opts.key? "silent"
+      return if @opts.key? "silent"
+      @issue.post comment
+      @issue.add_label "LL.accuracy", "#{(@accuracy / 10) * 10}%"
     end
 
     # The jira comment in markdown format

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

@@ -22,22 +22,18 @@
 # ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
 # OR OTHER DEALINGS IN THE SOFTWARE.
 
-require_relative "../../log"
-require_relative "../../email"
-require_relative "../../version"
-require_relative "../../postman"
 require_relative "requirement"
 
 module Lazylead
   # A requirement that Jira field "Affects Version/s" provided by the reporter.
-  class RequirementAffectedBuild < Requirement
+  class AffectedBuild < Requirement
     def initialize(score = 0.5)
       super "Affected build", score, "Affects Version/s"
     end
 
     # @return true if an issue has non-empty "Affects Version/s" field
     def passed(issue)
-      !issue.fields["versions"].nil? && !issue.fields["versions"].empty?
+      non_blank? issue, "versions"
     end
   end
 end

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

@@ -0,0 +1,44 @@
+# 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 "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
+
+    # Check a single attachment from ticket.
+    # Potential extension point for custom verification logic.
+    def matching(attachment)
+      !attachment.nil?
+    end
+  end
+end