lazylead 0.2.0 → 0.4.2

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

@@ -0,0 +1,43 @@
+# 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 "../../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
+    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?
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+# 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.
+
+module Lazylead
+  # An single requirement regarding ticket format.
+  class Requirement
+    attr_reader :score, :desc, :field
+
+    def initialize(desc, score, field)
+      @desc = desc
+      @score = score
+      @field = field
+    end
+
+    def passed(_)
+      true
+    end
+  end
+end

data/lib/lazylead/task/alert.rb

@@ -23,6 +23,7 @@
 # OR OTHER DEALINGS IN THE SOFTWARE.
 
 require_relative "../log"
+require_relative "../opts"
 require_relative "../email"
 require_relative "../version"
 require_relative "../postman"
@@ -43,12 +44,13 @@ module Lazylead
     #  - prepare email based on predefined template (*.erb)
     #  - send the required notifications pre-defined "addressee".
     class Alert
-      def initialize(log = Log::NOTHING)
+      def initialize(log = Log.new)
         @log = log
       end
 
       def run(sys, postman, opts)
-        postman.send opts.merge(tickets: sys.issues(opts["sql"]))
+        tickets = sys.issues(opts["sql"], opts.jira_defaults)
+        postman.send opts.merge(tickets: tickets) unless tickets.empty?
       end
     end
 
@@ -64,12 +66,12 @@ module Lazylead
     # The email message is sending to the assignee regarding all his/her issues,
     #  not like one email per each issue.
     class AssigneeAlert
-      def initialize(log = Log::NOTHING)
+      def initialize(log = Log.new)
         @log = log
       end
 
       def run(sys, postman, opts)
-        sys.issues(opts["sql"])
+        sys.issues(opts["sql"], opts.jira_defaults)
            .group_by(&:assignee)
            .each do |a, t|
           postman.send opts.merge(to: a.email, addressee: a.name, tickets: t)
@@ -89,12 +91,12 @@ module Lazylead
     # The email message is sending to the assignee regarding all his/her issues,
     #  not like one email per each issue.
     class ReporterAlert
-      def initialize(log = Log::NOTHING)
+      def initialize(log = Log.new)
         @log = log
       end
 
       def run(sys, postman, opts)
-        sys.issues(opts["sql"])
+        sys.issues(opts["sql"], opts.jira_defaults)
            .group_by(&:reporter)
            .each do |a, t|
           postman.send opts.merge(to: a.email, addressee: a.name, tickets: t)

data/lib/lazylead/task/confluence_ref.rb

@@ -26,6 +26,7 @@ require "json"
 require "faraday"
 require_relative "../system/jira"
 require_relative "../log"
+require_relative "../opts"
 require_relative "../confluence"
 
 module Lazylead
@@ -35,14 +36,14 @@ module Lazylead
     # @todo #/DEV Support sub-task for link search. Potentially, the issue
     #  might have sub-tasks where discussion ongoing.
     class ConfluenceRef
-      def initialize(log = Log::NOTHING)
+      def initialize(log = Log.new)
         @log = log
       end
 
       def run(sys, _, opts)
         confluences = confluences(opts)
         return if confluences.empty?
-        sys.issues(opts["jql"])
+        sys.issues(opts["jql"], opts.jira_defaults)
            .map { |i| Link.new(i, sys, confluences) }
            .each(&:fetch_links)
            .select(&:need_link?)
@@ -50,7 +51,7 @@ module Lazylead
       end
 
       def confluences(opts)
-        return [] if opts["confluences"].nil? || opts["confluences"].blank?
+        return [] if opts.blank? "confluences"
         JSON.parse(opts["confluences"], object_class: OpenStruct)
             .map { |c| Confluence.new(c) }
       end

data/lib/lazylead/task/echo.rb

@@ -30,6 +30,10 @@ module Lazylead
     # Copyright:: Copyright (c) 2019-2020 Yurii Dubinka
     # License:: MIT
     class Echo
+      def initialize(log = Log.new)
+        @log = log
+      end
+
       def run(_, _, _)
         self.class.to_s
       end

data/lib/lazylead/task/fix_version.rb

@@ -23,24 +23,28 @@
 # OR OTHER DEALINGS IN THE SOFTWARE.
 
 require "date"
-require_relative "../system/jira"
 require_relative "../log"
+require_relative "../opts"
+require_relative "../system/jira"
 
 module Lazylead
   module Task
     # @todo #/DEV Each task should verify input arguments.
     #  The common API should be provided for each task.
     class FixVersion
-      def initialize(log = Log::NOTHING)
+      def initialize(log = Log.new)
         @log = log
       end
 
       def run(sys, postman, opts)
-        allowed = opts["allowed"].split(",").map(&:strip).reject(&:blank?)
+        allowed = opts.slice("allowed", ",")
+        issues = sys.issues(
+          opts["jql"], opts.jira_defaults.merge(expand: "changelog")
+        )
+        return if issues.empty?
         postman.send opts.merge(
-          versions: sys.issues(opts["jql"], expand: "changelog")
-                       .map { |i| Version.new(i, allowed) }
-                       .select(&:changed?)
+          versions: issues.map { |i| Version.new(i, allowed) }
+                          .select(&:changed?)
         )
       end
     end

data/lib/lazylead/task/missing_comment.rb

@@ -23,6 +23,7 @@
 # OR OTHER DEALINGS IN THE SOFTWARE.
 
 require_relative "../log"
+require_relative "../opts"
 require_relative "../postman"
 
 module Lazylead
@@ -36,16 +37,17 @@ module Lazylead
     #  nobody mentioned in comment the ftp location for recorded session.
     # Such cases needs to be reported.
     class MissingComment
-      def initialize(log = Log::NOTHING)
+      def initialize(log = Log.new)
         @log = log
       end
 
       def run(sys, postman, opts)
-        opts["details"] = "text '#{opts['text']}'" if opts["details"].blank?
+        opts["details"] = "text '#{opts['text']}'" if opts.blank? "details"
+        issues = sys.issues(opts["jql"], opts.jira_defaults)
+        return if issues.empty?
         postman.send opts.merge(
-          comments: sys.issues(opts["jql"])
-                       .map { |i| Comments.new(i, sys) }
-                       .reject { |c| c.body? opts["text"] }
+          comments: issues.map { |i| Comments.new(i, sys) }
+                          .reject { |c| c.body? opts["text"] }
         )
       end
     end

data/lib/lazylead/task/propagate_down.rb

@@ -0,0 +1,126 @@
+# 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 "../version"
+require_relative "../system/jira"
+
+module Lazylead
+  module Task
+    #
+    # Propagate particular JIRA fields from parent ticket to sub-tasks.
+    #
+    # The task algorithm:
+    #  - fetch parent issues from remote ticketing system by JQL
+    #  - reject issues without sub-tasks
+    #  - fetch sub-tasks details
+    #  - make a diff for pre-defined fields provided by the user
+    #  - apply diff to sub-tasks
+    #  - make a comment to sub-task with clarification.
+    class PropagateDown
+      def initialize(log = Log.new)
+        @log = log
+      end
+
+      # @todo #/DEV Define a new module Lazylead::Task with basic methods like
+      #  split, groupBy(assignee, reporter, etc), blank?
+      def run(sys, _, opts)
+        fields = opts.slice("propagate", ",")
+        sys.issues(
+          opts["jql"],
+          {
+            expand: "changelog",
+            max_results: opts.fetch("max_results", 50),
+            fields: ["subtasks"] + opts.jira_fields
+          }
+        )
+           .map { |i| Parent.new(i, sys, fields) }
+           .select(&:subtasks?)
+           .each(&:fetch)
+           .each(&:propagate)
+      end
+    end
+
+    # The parent ticket as a source for propagation to children.
+    class Parent
+      def initialize(issue, sys, fields)
+        @issue = issue
+        @sys = sys
+        @fields = fields
+      end
+
+      # Ensure that parent ticket has sub-tasks.
+      def subtasks?
+        !@issue.fields["subtasks"].empty?
+      end
+
+      # Take sub-tasks with their fields from external JIRA system.
+      def fetch
+        @subtasks = @issue.fields["subtasks"]
+                          .map do |sub|
+          @sys.raw { |j| j.Issue.find(sub["id"]) }
+        end
+      end
+
+      # Fill pre-defined fields for sub-tasks from parent ticket
+      #  and post comment to ticket with clarification.
+      def propagate
+        expected = Hash[@fields.collect { |f| [f, @issue.fields[f]] }]
+        @subtasks.each do |subtask|
+          actual = Hash[@fields.collect { |f| [f, subtask.fields[f]] }]
+          diff = diff(expected, actual)
+          next if diff.empty?
+          subtask.save(fields: diff)
+          subtask.comments.build.save!(body: comment(diff))
+        end
+      end
+
+      # Detect difference between fields in parent ticket and sub-task.
+      # The sub-tasks expected be updated by this diff.
+      def diff(expected, actual)
+        diff = {}
+        actual.each_with_object(diff) do |a, d|
+          k = a.first
+          v = a.last
+          d[k] = expected[k] if v.nil? || v.blank?
+          next if v.nil?
+          d[k] = v + "," + expected[k] unless v.to_s.include? expected[k]
+        end
+      end
+
+      # Build a jira comment in markdown(*.md) format with diff table.
+      def comment(diff)
+        markdown = [
+          "The following fields were propagated from #{@issue.key}:",
+          "||Field||Value||"
+        ]
+        diff.each { |k, v| markdown << "|#{k}|#{v}|" }
+        markdown << "Posted by [lazylead v#{Lazylead::VERSION}|" \
+                    "https://bit.ly/2NjdndS]"
+        markdown.join("\r\n")
+      end
+    end
+  end
+end

data/lib/lazylead/task/savepoint.rb

@@ -0,0 +1,58 @@
+# 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 "../home"
+require_relative "../email"
+require_relative "../version"
+require_relative "../postman"
+
+module Lazylead
+  module Task
+    #
+    # Send current configuration to admin user.
+    #
+    class Savepoint
+      def initialize(log = Log.new)
+        @log = log
+      end
+
+      def run(_, postman, opts)
+        opts["max_size"] = "25" unless opts.key? "max_size"
+        path = File.join(
+          Lazylead::Home.new.dir,
+          ARGV[ARGV.find_index("--sqlite") + 1]
+        )
+        return unless File.file?(path) && less_mb(path, opts["max_size"])
+        postman.send opts.merge("attachments" => [path])
+      end
+
+      private
+
+      def less_mb(path, megabytes)
+        (File.size(path).to_f / 2**20).round(2) < megabytes.to_i
+      end
+    end
+  end
+end

data/lib/lazylead/task/touch.rb

@@ -0,0 +1,102 @@
+# 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 "nokogiri"
+require "active_support/core_ext/hash/conversions"
+require_relative "../salt"
+require_relative "../opts"
+
+module Lazylead
+  module Task
+    #
+    # Send notification about modification of critical files in svn repo.
+    #
+    class SvnTouch
+      def initialize(log = Log.new)
+        @log = log
+      end
+
+      def run(_, postman, opts)
+        files = opts.slice("files", ",")
+        commits = touch(files, opts)
+        postman.send(opts.merge(entries: commits)) unless commits.empty?
+      end
+
+      # Return all svn commits for a particular date range, which are touching
+      #  somehow the critical files within the svn repo.
+      def touch(files, opts)
+        xpath = files.map { |f| "contains(text(),\"#{f}\")" }.join(" or ")
+        svn_log(opts).xpath("//logentry[paths/path[#{xpath}]]")
+                     .map(&method(:to_entry))
+                     .each do |e|
+          if e.paths.path.respond_to? :delete_if
+            e.paths.path.delete_if { |p| files.none? { |f| p.include? f } }
+          end
+        end
+      end
+
+      # Return all svn commits for particular date range in repo
+      def svn_log(opts)
+        url = opts["svn_url"]
+        usr = decrypt(opts["svn_user"])
+        psw = decrypt(opts["svn_password"])
+        now = if opts.key? "now"
+                DateTime.parse(opts["now"])
+              else
+                DateTime.now
+              end
+        start = (now.to_time - opts["period"].to_i).to_datetime
+        raw = `svn log --no-auth-cache --username #{usr} --password #{psw}
+                --xml -v -r {#{start}}:{#{now}} #{url}`
+        Nokogiri.XML(raw, nil, "UTF-8")
+      end
+
+      # Decrypt text using cryptography salt
+      def decrypt(text, sid = "svn_salt")
+        return Salt.new(sid).decrypt(text) if ENV.key? sid
+        text
+      end
+
+      # Convert single revision(XML text) to entry object.
+      # Entry object is a simple ruby struct object.
+      def to_entry(xml)
+        e = to_struct(Hash.from_xml(xml.to_s.strip)).logentry
+        if e.paths.path.respond_to? :each
+          e.paths.path.each(&:strip!)
+        else
+          e.paths.path.strip!
+        end
+        e
+      end
+
+      # Make a simple ruby struct object from hash hierarchically,
+      #  considering nested hash(es) (if applicable)
+      def to_struct(hsh)
+        OpenStruct.new(
+          hsh.transform_values { |v| v.is_a?(Hash) ? to_struct(v) : v }
+        )
+      end
+    end
+  end
+end