lazylead 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4564fa672731c29fe8e9dc32d2f09c56bf0b9245fce2900b4335c49442d08fb2
-  data.tar.gz: 58ff724cc12437d3106978913f0c2ef12a189f2e80b87ec07a2202bcd0f90267
+  metadata.gz: d8f6929a5583f40fca08c1d1293b77cf2f19ea22b1844eb9888a860b79c86b7c
+  data.tar.gz: 07b70000fe7e00aeb7c33b321d1f35c99dccb8220f477650b90a693ea8688c0c
 SHA512:
-  metadata.gz: e7b23097dca908102e6863d5527769bfe3d5405003cbab920da7ee6fd7f4118b554eb3d3a5f1170830dfdbf8fb08f752e6276fae4157f919f6e39ec070a91089
-  data.tar.gz: be8745b87907ab9ad30e9e4eb67f0ebf44ae0dcc01dcdbedefd79ab480e1222bbdc8835a397d465b5e491e995ee7ceaf685464385d7d87c0f0014900325d38ac
+  metadata.gz: 1699bbdc2484d6a77715b11bb0f666e70e18e3bc5927d79ee02cee3bfcc4e6bf6d848a74a5c287990e56d059f669f07dc9e450f7af6992b63881288f481e062e
+  data.tar.gz: 0c471418e7ed2a92d740d0e362c0bcd9ce37eca1538272eab8abe0eff4fb3b01df1559b5f16d7af9ed3dfa52d06ebb5ff1c6a10cb897df7aeab3e119f8fe63c3

data/.0pdd.yml

@@ -1,5 +1,8 @@
 errors:
   - yurii.dubinka@gmail.com
-
+alerts:
+  suppress:
+    - on-found-puzzle
+    - on-lost-puzzle
 tags:
   - pdd

data/.docs/accuracy.md

@@ -0,0 +1,107 @@
+## Give the score for the format of each incoming ticket to your team
+#### Why?
+When you have a pipeline between several teams, there should be criteria on how to pass a task between groups.
+Without this, you may get the delays for your task because your team members have to do the work that is not their business, or they even don't have the skills to do it properly.
+As a result, it may cause task delays or quality decreasing.
+
+Even if you define the criteria for passing tasks between teams, it's tough to monitor that those criteria aren't violating. To hire a well-paid additional manager who will check each ticket and send emails its expensive unless you work for a bloody reach company.
+
+This rule periodically checks the format of the ticket, post score results to the ticket, and raise email (one email per bunch of tickets) to you with details.
+
+#### How to use lazylead for this
+Let's assume that 
+1.  Your team is working in Jira
+2.  You want daily to check the format of incoming defects to your team
+3.  [JQL](https://www.atlassian.com/blog/jira-software/jql-the-most-flexible-way-to-search-jira-14) for incoming defects: `project='PRJ' and type=Defect and created < -2h and created > -26h`.
+    This `< -2h` and `> -26h` gives reporter 2h to fill the ticket correctly, and, after that, the task will evaluate the ticket score.
+4.  you've saved this [JQL](https://www.atlassian.com/blog/jira-software/jql-the-most-flexible-way-to-search-jira-14) as jira filter with id `222`. 
+
+For simplicity, we are using [docker-compose](https://docs.docker.com/compose/):
+1.  Define yml file with `docker-compose` configuration in `lazylead.yml`
+    ```yml
+    version: '2.3'
+    services:
+      lazylead:
+        image: dgroup/lazylead:latest
+        container_name: lazylead
+        mem_limit: 128m
+        environment:
+          # The jira server details.
+          # Please ensure that your jira filter(s) grants this user to see issues.
+          # Sometimes jira filter(s) may be created with restricted visibility, thus
+          #  lazylead can't find the issues. 
+          jira_url: https://your.jira.com
+          jira_user: theuser
+          jira_password: thepass
+        volumes:
+          - ./:/lazylead/db
+        # db/ll.db is sqlite file with jira related annoying tasks
+        entrypoint: bin/lazylead --sqlite db/ll.db --trace --verbose
+    ```
+    
+2.  Create a container, using `docker-compose -f lazylead.yml up`
+    The container will stop as there were no tasks provided:
+    ```bash
+    ll > docker-compose -f lazylead.yml up                                                         
+    Creating lazylead ... done
+    Attaching to lazylead
+    lazylead    | [2020-08-09T06:17:32] DEBUG [main] Version: 0.4.0
+    lazylead    | [2020-08-09T06:17:32] DEBUG [main] Memory footprint at start is 52MB
+    lazylead    | [2020-08-09T06:17:32] DEBUG [main] Database: '/lazylead/db/ll.db', sql migration dir: '/lazylead/upgrades/sqlite'
+    lazylead    | [2020-08-09T06:17:32] DEBUG [main] Migration applied to /lazylead/db/ll.db from /lazylead/upgrades/sqlite
+    lazylead    | [2020-08-09T06:17:32] DEBUG [main] Database connection established
+    lazylead    | [2020-08-09T06:17:32] DEBUG [main] SMTP connection established with {host} as {user}.
+    lazylead    | [2020-08-09T06:17:32] WARN  [main] ll-001: No tasks found.
+    lazylead    | [2020-08-09T06:17:32] DEBUG [main] Memory footprint at the end is 67MB
+    ll > 
+    ```
+
+3.  Define your team and tasks in database. 
+    The tables structure defined [here](../upgrades/sqlite/001-install-main-lazylead-tables.sql).
+    Modify you [sqlite](https://sqlite.com/index.html) file(`ll.db`) using [DB Browser](https://sqlitebrowser.org/) or any similar tool.
+    ```sql
+    insert into teams (id, name, properties) 
+               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)
+               values ('Post ticket score and accuracy to the tickets', 
+                       '0 8 * * 1-5', 
+                       'true',
+                       1, 1, 1, 
+                       'Lazylead::Task::Accuracy',
+                       '{
+                            "jql":    "filter=222", 
+                            "to":     "lead@fake.com",
+                            "rules":  "Lazylead::RequirementAffectedBuild",
+                            "colors": "{ "0": "#FF4F33", "35": "#FF9F33", "57": "#19DD1E", "90": "#0FA81A" }",
+                            "docs":         "https://github.com/dgroup/lazylead/blob/master/.github/ISSUE_TEMPLATE/bug_report.md",
+                            "max_results":  "200",
+                            "subject":      "[LL] Raised tickets",
+                            "template":     "lib/messages/accuracy.erb"
+                        }
+                       ');
+    ```
+    Yes, for task scheduling we are using [cron](https://crontab.guru).
+
+4.  Once you changed `./ll.db`, please restart the container using `docker-compose -f .github/tasks.yml restart`
+    ```bash
+    ll > docker-compose -f .github/tasks.yml restart
+    Restarting lazylead ... done
+    ```
+
+5.  Once task completed, please check your defects, they should have comment like
+    ![jira comment](accuracy_jira_comment.jpg)
+
+    and you'll get an email like
+    ![email](accuracy_email.jpg)
+    
+
+#### Where is the code?
+| Logic | Tests |
+| :-----: | :------: |
+| [accuracy.rb](../lib/lazylead/task/accuracy/accuracy.rb)| [accuracy_test.rb](../test/lazylead/task/accuracy/accuracy_test.rb) | 
+
+#### How can I add my own rules?
+The custom rules should extend `Lazylead::Requirement` class and placed it to the `lib/lazylead/task/accuracy` folder.
+After that, you need to mention your custom rules in `rules` option in the column `properties` from `tasks` table

data/.docs/propagate_down.md

@@ -64,7 +64,7 @@ For simplicity, we are using [docker-compose](https://docs.docker.com/compose/):
                        'true',
                        1, 1, 1, 
                        'Lazylead::Task::PropagateDown',
-                       '{"jql":"filter=222", "fields":"customfield_1"}');
+                       '{"jql":"filter=222", "propagate":"customfield_1"}');
     
     ```
     Yes, for task scheduling we are using [cron](https://crontab.guru).

data/.pdd

@@ -2,4 +2,4 @@
 --verbose
 --exclude target/**/*
 --exclude coverage/**/*
---rule min-words:5
+--rule min-words:7

data/.rubocop.yml

@@ -77,6 +77,12 @@ Style/HashTransformKeys:
 Style/HashTransformValues:
   Enabled: true
 
+# @todo #/DEV accuracy.rb is using % symbol in text message and rubocop
+#  complains about it. It's false-positive violation, thus, for now ignored for this file
+Style/FormatStringToken:
+  Exclude:
+    - "lib/lazylead/task/accuracy/accuracy.rb"
+
 Lint/RaiseException:
   Enabled: true
 

data/bin/lazylead

@@ -39,11 +39,14 @@ require_relative "../lib/lazylead/schedule"
 require_relative "../lib/lazylead/allocated"
 require_relative "../lib/lazylead/cli/app"
 
-log = Lazylead::Log::ERRORS
+log = Lazylead::Log.new
 Thread.current.name = "main"
+Logging.mdc["tid"] = Thread.current.name
 Encoding.default_external = Encoding::UTF_8
 Encoding.default_internal = Encoding::UTF_8
 
+# @todo #/DEV Decorate ARGV with custom methods in order to avoid code
+#  duplication, like { ARGV.include? "--trace" }
 opts = Slop.parse(ARGV, strict: false, suppress_errors: true) do |o|
   o.banner = "Usage: lazylead [options]
 Available options:"
@@ -67,7 +70,7 @@ Available options:"
          "Apply the database VCS migration with test data",
          default: false
   o.on "--verbose", "Enable extra logging information" do
-    log = Lazylead::Log::VERBOSE
+    log.verbose
   end
   o.on "-v", "--version", "Show current version" do
     log.debug Lazylead::VERSION
@@ -91,7 +94,7 @@ cmd = lambda do
   return 0
 rescue StandardError => e
   log.error("#{e.message} (#{e.class.name})")
-  log.error(Backtrace.new(e)) if opts["trace"]
+  log.error(Backtrace.new(e)) if ARGV.include? "--trace"
   return -1
 end
 code = 0

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.3.1"
+  s.version = "0.4.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.3.1!
+  s.post_install_message = "Thanks for installing Lazylead v0.4.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
@@ -60,7 +60,7 @@ tasks instead of solving technical problems."
   s.add_runtime_dependency "faraday", "1.0.1"
   s.add_runtime_dependency "get_process_mem", "0.2.5"
   s.add_runtime_dependency "jira-ruby", "1.7.1"
-  s.add_runtime_dependency "json", "2.2.0"
+  s.add_runtime_dependency "json", "2.3.0"
   s.add_runtime_dependency "logging", "2.2.2"
   s.add_runtime_dependency "mail", "2.7.1"
   s.add_runtime_dependency "memory_profiler", "0.9.13"
@@ -75,7 +75,7 @@ tasks instead of solving technical problems."
   s.add_runtime_dependency "tzinfo-data", "1.2019.3"
   s.add_runtime_dependency "vcs4sql", "0.1.0"
   s.add_runtime_dependency "viewpoint", "1.1.0"
-  s.add_development_dependency "codecov", "0.1.14"
+  s.add_development_dependency "codecov", "0.2.3"
   s.add_development_dependency "guard", "2.15.0"
   s.add_development_dependency "guard-minitest", "2.4.6"
   s.add_development_dependency "minitest", "5.11.3"

data/lib/lazylead/exchange.rb

@@ -42,7 +42,7 @@ module Lazylead
     include Emailing
 
     def initialize(
-      log = Log::NOTHING, salt = Salt.new("exchange_salt"), opts = ENV.to_h
+      log = Log.new, salt = Salt.new("exchange_salt"), opts = ENV.to_h
     )
       @log = log
       @salt = salt

data/lib/lazylead/log.rb

@@ -23,16 +23,38 @@
 # OR OTHER DEALINGS IN THE SOFTWARE.
 
 require "logging"
+require "forwardable"
 
 module Lazylead
-  # Loggers.
+  # The main application logger
+  class Log
+    extend Forwardable
+    def_delegators :@log, :debug, :info, :warn, :error
+
+    def initialize(log = Lazylead::Level::ERRORS)
+      @log = log
+      @log = Lazylead::Level::DEBUG if ARGV.include? "--trace"
+    end
+
+    def nothing
+      @log = Lazylead::Level::NOTHING
+      self
+    end
+
+    def verbose
+      @log = Lazylead::Level::DEBUG
+      self
+    end
+  end
+
+  # Predefined logging levels.
   #
   # There are 3 colored loggers so far:
   #  NOTHING - for cases when logging isn't required
   #  VERBOSE - all logging levels including debug
   #  ERRORS - for errors only which are critical for app.
   #
-  module Log
+  module Level
     # Coloring configuration for appender(s).
     Logging.color_scheme("bright",
                          levels: {
@@ -46,7 +68,7 @@ module Lazylead
     Logging.appenders.stdout(
       "stdout",
       layout: Logging.layouts.pattern(
-        pattern: "[%d] %-5l %m\n",
+        pattern: "[%d] %-5l [%X{tid}] %m\n",
         color_scheme: "bright"
       )
     )
@@ -57,12 +79,12 @@ module Lazylead
     NOTHING.freeze
 
     # All levels including debug
-    VERBOSE = Logging.logger["verbose"]
-    VERBOSE.level = :debug
-    VERBOSE.add_appenders "stdout"
-    VERBOSE.freeze
+    DEBUG = Logging.logger["debug"]
+    DEBUG.level = :debug
+    DEBUG.add_appenders "stdout"
+    DEBUG.freeze
 
-    # Alerts
+    # Alerts/errors
     ERRORS = Logging.logger["errors"]
     ERRORS.level = :error
     ERRORS.add_appenders "stdout"

data/lib/lazylead/model.rb

@@ -22,12 +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"
 
@@ -91,18 +94,11 @@ module Lazylead
       belongs_to :team, foreign_key: "team_id"
       belongs_to :system, foreign_key: "system"
 
-      # @todo #/DEV Add error handling for StandartError with support of
-      #  verbose key from ARGV like in /bin/lazylead. That will make error
-      #  messages more human readable. Maybe there is some integration between
-      #  Slop and ARGV in order to avoid logic duplication.
-      def exec(log = Log::NOTHING)
-        log.debug("Task ##{id} '#{name}' is started")
-        sys = system.connect(log)
-        pman = postman(log)
-        opts = props(log)
+      def exec
+        sys = system.connect
+        opts = props
         opts = detect_cc(sys) if opts.key? "cc"
-        action.constantize.new(log).run(sys, pman, opts)
-        log.debug("Task ##{id} '#{name}' is completed")
+        action.constantize.new(log).run(sys, postman, opts)
       end
 
       def detect_cc(sys)
@@ -112,33 +108,60 @@ module Lazylead
         opts
       end
 
-      def props(log = Log::NOTHING)
+      def props
         @props ||= begin
                      if team.nil?
-                       log.warn("Team for task #{id} isn't defined.")
-                       env(to_hash)
+                       Opts.new(env(to_hash))
                      else
-                       env(team.to_hash.merge(to_hash))
+                       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
+        @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."
@@ -146,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