lazylead 0.4.2 → 0.6.0

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
 
@@ -150,6 +167,11 @@ module Lazylead
       @issue.key
     end
 
+    def description
+      return "" if @issue.description.nil?
+      @issue.description
+    end
+
     def summary
       fields["summary"]
     end
@@ -175,9 +197,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 +243,30 @@ 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)
+      lbl = labels
+      lbl = [] if lbl.nil?
+      lbl << label
+      lbl += more if more.size.positive?
+      save!("fields" => { "labels" => lbl.uniq })
+    end
+
+    def labels
+      fields["labels"]
+    end
+
+    def save!(opts)
+      @issue.save(opts)
+    end
   end
 
   # The jira issue comments
@@ -281,7 +342,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

@@ -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", "#{grade(@accuracy)}%"
     end
 
     # The jira comment in markdown format
@@ -136,5 +132,14 @@ module Lazylead
                         .sort_by { |e| e[0] }
                   end
     end
+
+    # Calculate grade for accuracy
+    # For example,
+    #  grade(7.5)   => 0
+    #  grade(12)    => 10
+    #  grade(25.5)  => 20
+    def grade(value)
+      (value / 10).floor * 10
+    end
   end
 end

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

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

@@ -0,0 +1,39 @@
+# 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
+  # A requirement that Jira field "Environment" provided by the reporter.
+  class Environment < Requirement
+    def initialize(score = 0.5)
+      super "Environment details (URL, patches)", score, "Environment"
+    end
+
+    # @return true if an issue has non-empty "Environment" field
+    def passed(issue)
+      non_blank? issue, "environment"
+    end
+  end
+end

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

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

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

@@ -0,0 +1,45 @@
+# 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 "attachment"
+
+module Lazylead
+  # Check that ticket has video record(s) with reproducing results.
+  class Records < Lazylead::Attachment
+    def initialize(ext = [])
+      super("Recorded internal reproducing results", 5, "Attachments")
+      @ext = ext
+      return unless @ext.empty?
+      @ext = %w[.webm .mkv .flv .flv .vob .ogv .ogg .drc .gif .gifv .mng .avi
+                .mts .m2ts .ts .mov .qt .wmv .yuv .rm .rmvb .viv .asf .amv .mp4
+                .m4p .m4v .mpg .mp2 .mpeg .mpe .mpv .mpg .mpeg .m2v .m4v .svi
+                .3gp .3g2 .mxf .roq .nsv .flv .f4v .f4p .f4a .f4b .gif]
+    end
+
+    # Ensure that ticket has an attachment with video-file extension
+    def matching(attach)
+      @ext.any? { |e| e.eql? File.extname(attach.attrs["filename"]).downcase }
+    end
+  end
+end

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

@@ -36,5 +36,14 @@ module Lazylead
     def passed(_)
       true
     end
+
+    def blank?(issue, field)
+      return false if issue.nil?
+      issue.fields[field].nil? || issue.fields[field].blank?
+    end
+
+    def non_blank?(issue, field)
+      !blank? issue, field
+    end
   end
 end

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

@@ -0,0 +1,50 @@
+# 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 expected links to failed entities on dedicated
+  #  servers.
+  class Servers < Lazylead::Requirement
+    #
+    # @param envs regexp expressions to match servers in description.
+    #
+    def initialize(score: 2, envs: [], desc: "Internal reproducing results")
+      super desc, score, "Description/Environment"
+      @envs = envs
+    end
+
+    def passed(issue)
+      return true if @envs.empty?
+      lines = issue["environment"].to_s + "\n" + issue.description
+      lines.split("\n")
+           .reject(&:blank?)
+           .map(&:strip)
+           .flat_map { |l| l.split(" ").map(&:strip) }
+           .select { |w| w.include?("http://") || w.include?("https://") }
+           .any? { |u| @envs.any? { |e| u.match? e } }
+    end
+  end
+end