-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathe2e_github_reporter.rb
More file actions
180 lines (154 loc) · 5.5 KB
/
Copy pathe2e_github_reporter.rb
File metadata and controls
180 lines (154 loc) · 5.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
# frozen_string_literal: true
require "json"
require "net/http"
require "uri"
class E2EGitHubReporter
COMMENT_MARKER = "<!-- checkout-kit-e2e-report -->"
def initialize(results, repository:, sha:, pr_number:, token: nil)
@results = results
@repository = repository
@sha = sha
@pr_number = pr_number
@token = token
end
def publish!
commit_status_payloads.each { |payload| post_json("/repos/#{@repository}/statuses/#{@sha}", payload) }
post_json("/repos/#{@repository}/check-runs", check_run_payload)
sync_failure_comment
end
def markdown_summary
lines = []
lines << "## Checkout Kit E2E results"
lines << ""
lines << "| Run | Status | Target | Platform | OS track | Device | Suite |"
lines << "|---|---|---|---|---|---|---|"
@results.each do |result|
lines << "| `#{result.fetch("id")}` | #{status_icon(result)} #{result.fetch("status")} | #{result.fetch("target")} | #{result.fetch("platform")} | #{result.fetch("os_track")} | #{result.fetch("device_selector")} → #{result.fetch("resolved_device")} | `#{result.fetch("execute")}` |"
end
failure_lines = failed_results.flat_map { |result| failure_details(result) }
unless failure_lines.empty?
lines << ""
lines << "## Failures"
lines << ""
lines << "> BrowserStack artifacts require BrowserStack access. Sign in to [BrowserStack App Automate](https://app-automate.browserstack.com/dashboard/v2/builds) before opening artifact links."
lines.concat(failure_lines)
end
lines.join("\n")
end
def commit_status_payloads
@results.map do |result|
{
state: result.fetch("passed") ? "success" : "failure",
context: result.fetch("status_context"),
description: status_description(result),
target_url: browserstack_build_url(result)
}
end
end
def failure_comment_body
return nil if failed_results.empty?
[COMMENT_MARKER, markdown_summary].join("\n")
end
private
def check_run_payload
conclusion = failed_results.empty? ? "success" : "failure"
{
name: "Checkout Kit E2E",
head_sha: @sha,
status: "completed",
conclusion: conclusion,
output: {
title: "Checkout Kit E2E #{conclusion}",
summary: markdown_summary
}
}
end
def sync_failure_comment
body = failure_comment_body
existing = existing_failure_comment
if body
if existing
patch_json("/repos/#{@repository}/issues/comments/#{existing.fetch("id")}", {body: body})
else
post_json("/repos/#{@repository}/issues/#{@pr_number}/comments", {body: body})
end
elsif existing
patch_json("/repos/#{@repository}/issues/comments/#{existing.fetch("id")}", {body: "#{COMMENT_MARKER}\n✅ Checkout Kit E2E failures resolved."})
end
end
def existing_failure_comment
get_json("/repos/#{@repository}/issues/#{@pr_number}/comments").find do |comment|
comment.fetch("body", "").include?(COMMENT_MARKER)
end
end
def failed_results
@results.reject { |result| result.fetch("passed") }
end
def failure_details(result)
lines = []
lines << ""
lines << "### `#{result.fetch("id")}`"
lines << ""
lines << "- Device selector: `#{result.fetch("device_selector")}`"
lines << "- Resolved device: `#{result.fetch("resolved_device")}`"
lines << "- Suite: `#{result.fetch("execute")}`"
lines << "- BrowserStack build: [Open BrowserStack build](#{browserstack_build_url(result)})"
result.fetch("failed_tests", []).each do |testcase|
lines << "- Failed test: `#{testcase.fetch("name", "unknown")}` (`#{testcase.fetch("status", "unknown")}`)"
link_fields.each do |label, key|
value = testcase[key]
lines << " - #{label}: [Open #{link_text(label)}](#{value})" if value && !value.empty?
end
end
lines
end
def link_fields
{
"Video" => "video",
"Screenshot" => "screenshots",
"Maestro commands" => "maestro_commands",
"Maestro log" => "maestro_log",
"Device log" => "device_log",
"Network log" => "network_log"
}
end
def link_text(label)
label.start_with?("Maestro") ? label : label.downcase
end
def status_icon(result)
result.fetch("passed") ? "✅" : "❌"
end
def status_description(result)
description = result.fetch("passed") ? "passed" : "#{result.fetch("status")} on #{result.fetch("resolved_device")}"
description[0, 140]
end
def browserstack_build_url(result)
"https://app-automate.browserstack.com/dashboard/v2/builds/#{result.fetch("build_id")}"
end
def get_json(path)
execute_request(Net::HTTP::Get.new(path))
end
def post_json(path, body)
request = Net::HTTP::Post.new(path)
request.body = JSON.generate(body)
execute_json_request(request)
end
def patch_json(path, body)
request = Net::HTTP::Patch.new(path)
request.body = JSON.generate(body)
execute_json_request(request)
end
def execute_json_request(request)
request["Content-Type"] = "application/json"
execute_request(request)
end
def execute_request(request)
raise "GitHub token is required" unless @token
request["Accept"] = "application/vnd.github+json"
request["Authorization"] = "Bearer #{@token}"
response = Net::HTTP.start("api.github.com", 443, use_ssl: true) { |http| http.request(request) }
body = response.body.to_s.empty? ? {} : JSON.parse(response.body)
return body if response.is_a?(Net::HTTPSuccess)
raise "GitHub request failed #{response.code}: #{body}"
end
end