lazylead 0.3.1 → 0.5.0

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,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.
+
+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 '10KB'
+    def matching(attachment)
+      attachment.attrs["size"].to_i > 10_240 &&
+        File.extname(attachment.attrs["filename"]).downcase.start_with?(".log")
+    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]
+    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

@@ -0,0 +1,49 @@
+# 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
+
+    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.start_with?("http://", "https://") }
+           .any? { |u| @envs.any? { |e| u.match? e } }
+    end
+  end
+end

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

@@ -0,0 +1,63 @@
+# 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
+  # Java stacktrace or Oracle errors in {noformat} section
+  class Stacktrace < Lazylead::Requirement
+    def initialize(score = 3)
+      super "Stacktrace/errors in *\\{noformat\\}* for JIRA indexing", score,
+            "Description"
+    end
+
+    def passed(issue)
+      return false if issue.description.nil?
+      !frames(issue.description).select { |f| oracle?(f) || java?(f) }.empty?
+    end
+
+    # Detect all {noformat} frames in description field
+    def frames(description)
+      description.enum_for(:scan, /(?={noformat})/)
+                 .map { Regexp.last_match.offset(0).first }
+                 .each_slice(2).map do |f|
+        description[f.first, f.last - f.first + "{noformat}".size]
+      end
+    end
+
+    # @return true if frame has few lines with java stack frames
+    def java?(frame)
+      allowed = ["at ", "Caused by:"]
+      frame.split("\n")
+           .map(&:strip)
+           .count { |l| allowed.any? { |a| l.start_with? a } } > 3
+    end
+
+    # @return true if frame has Oracle error
+    # @see https://docs.oracle.com/pls/db92/db92.error_search
+    def oracle?(frame)
+      frame.match?(/\WORA-\d{5}:/)
+    end
+  end
+end

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

@@ -0,0 +1,75 @@
+# 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 the 'Description' field that ticket has mandatory details like
+  #  - test case (TC)
+  #  - actual result (AR)
+  #  - expected result (ER)
+  class Testcase < Lazylead::Requirement
+    def initialize(score = 4)
+      super "Test case with AR/ER", score, "Description"
+    end
+
+    def passed(issue)
+      return false if issue.description.nil?
+      @tc = @ar = @er = -1
+      issue.description.split("\n").reject(&:blank?).each_with_index do |l, i|
+        line = l.gsub(/[^a-zA-Z(:|=)]/, "").downcase
+        detect_tc line, i
+        detect_ar line, i
+        detect_er line, i
+        break if with_tc_ar_er?
+      end
+      with_tc_ar_er?
+    end
+
+    # @return true if description has test case, AR and ER
+    def with_tc_ar_er?
+      (@tc.zero? || @tc.positive?) && @ar.positive? && @er.positive?
+    end
+
+    # Detect index of line with test case
+    def detect_tc(line, index)
+      return unless @tc.negative?
+      @tc = index if %w[testcase: tc: teststeps: teststeps].any? do |e|
+        e.eql? line
+      end
+    end
+
+    # Detect index of line with actual result
+    def detect_ar(line, index)
+      return unless @ar.negative? && index > @tc
+      @ar = index if %w[ar: actualresult: ar=].any? { |e| line.start_with? e }
+    end
+
+    # Detect index of line with expected result
+    def detect_er(line, index)
+      return unless @er.negative? && index > @tc
+      @er = index if %w[er: expectedresult: er=].any? { |e| line.start_with? e }
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+# 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 a remote link to external system with relationship
+  #  type = "Wiki Page".
+  class Wiki < Lazylead::Requirement
+    def initialize(score = 2, relationship = "Wiki Page")
+      super "Reference to design specification", score, "Ticket Links (Wiki)"
+      @relationship = relationship
+    end
+
+    def passed(issue)
+      return false if issue.remote_links.nil? || issue.remote_links.empty?
+      issue.remote_links.any? { |l| @relationship.eql? l.attrs["relationship"] }
+    end
+  end
+end