Skip to content

Commit

Permalink
#430: Ensure that ticket has a link to external logs system like ELK,…
Browse files Browse the repository at this point in the history
… GrayLog, etc.
  • Loading branch information
dgroup committed Jul 6, 2021
1 parent 4430579 commit 5c3e473
Show file tree
Hide file tree
Showing 3 changed files with 103 additions and 0 deletions.
1 change: 1 addition & 0 deletions lib/lazylead/task/accuracy/attachment.rb
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ module Lazylead
# Check that ticket has an attachment.
class Attachment < Lazylead::Requirement
def passed(issue)
return false if issue.nil? || issue.attachments.nil?
issue.attachments.any? { |a| matches?(a) }
end

Expand Down
52 changes: 52 additions & 0 deletions lib/lazylead/task/accuracy/logs_link.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# frozen_string_literal: true

# The MIT License
#
# Copyright (c) 2019-2021 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 "logs"
require_relative "attachment"

module Lazylead
# Check that ticket has link/reference to log record(s) in another system like ELK, GrayLog, etc.
# or attachment with plain log file
class LogsLink < Lazylead::Logs
def initialize(link)
super
@link = link
end

def passed(issue)
super(issue) || link?(issue)
end

# Ensure that ticket has a link to external logs system like ELK, GrayLog, etc.
def link?(issue)
return false if issue.description.nil?
issue.description
.split("\n")
.reject(&:blank?)
.flat_map(&:split)
.reject(&:blank?)
.any? { |word| word.start_with? @link }
end
end
end
50 changes: 50 additions & 0 deletions test/lazylead/task/accuracy/logs_link_test.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# frozen_string_literal: true

# The MIT License
#
# Copyright (c) 2019-2021 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 "../../../test"
require_relative "../../../../lib/lazylead/task/accuracy/logs_link"

module Lazylead
class LogsLinkTest < Lazylead::Test
test "log file is present" do
assert LogsLink.new("https://mygraylog.com/log#5").passed(
OpenStruct.new(
attachments: [OpenStruct.new(attrs: { "size" => 10_241, "filename" => "catalina.log" })]
)
)
end

test "log file is absent but description has log reference" do
assert LogsLink.new("https://mygraylog.com").passed(
OpenStruct.new(description: "Here is the log for current ticket https://mygraylog.com/log#5")
)
end

test "log file is absent and link is absent" do
refute LogsLink.new("https://mygraylog.com").passed(
OpenStruct.new(attachments: [])
)
end
end
end

0 comments on commit 5c3e473

Please sign in to comment.