gitlab-dangerfiles 0.8.1 → 2.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.yardopts +5 -0
- data/Gemfile +1 -0
- data/LICENSE.txt +1 -1
- data/README.md +46 -6
- data/gitlab-dangerfiles.gemspec +4 -4
- data/lib/danger/plugins/helper.rb +417 -0
- data/lib/danger/{roulette.rb → plugins/roulette.rb} +83 -64
- data/lib/danger/rules/changes_size/Dangerfile +10 -0
- data/lib/gitlab/dangerfiles.rb +81 -2
- data/lib/gitlab/dangerfiles/changes.rb +22 -0
- data/lib/gitlab/dangerfiles/commit_linter.rb +1 -1
- data/lib/gitlab/dangerfiles/config.rb +17 -0
- data/lib/gitlab/dangerfiles/emoji_checker.rb +1 -0
- data/lib/gitlab/dangerfiles/spec_helper.rb +51 -5
- data/lib/gitlab/dangerfiles/teammate.rb +2 -0
- data/lib/gitlab/dangerfiles/version.rb +1 -1
- data/lib/gitlab/dangerfiles/weightage.rb +1 -0
- data/lib/gitlab/dangerfiles/weightage/maintainers.rb +1 -0
- data/lib/gitlab/dangerfiles/weightage/reviewers.rb +1 -0
- metadata +12 -9
- data/lib/danger/helper.rb +0 -257
@@ -101,6 +101,8 @@ module Gitlab
|
|
101
101
|
return true if capabilities(project).include?("#{kind} engineering_productivity")
|
102
102
|
|
103
103
|
capabilities(project).include?("#{kind} backend")
|
104
|
+
when nil
|
105
|
+
capabilities(project).include?("#{kind}")
|
104
106
|
else
|
105
107
|
capabilities(project).include?("#{kind} #{category}")
|
106
108
|
end
|
@@ -18,6 +18,7 @@ module Gitlab
|
|
18
18
|
# | hungry traintainer | 8 |
|
19
19
|
# +------------------------------+--------------------------------+
|
20
20
|
#
|
21
|
+
# @api private
|
21
22
|
class Reviewers
|
22
23
|
DEFAULT_REVIEWER_WEIGHT = Gitlab::Dangerfiles::Weightage::CAPACITY_MULTIPLIER * Gitlab::Dangerfiles::Weightage::BASE_REVIEWER_WEIGHT
|
23
24
|
TRAINTAINER_WEIGHT = 3
|
metadata
CHANGED
@@ -1,17 +1,17 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: gitlab-dangerfiles
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 2.0.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
|
-
-
|
7
|
+
- GitLab
|
8
8
|
autorequire:
|
9
9
|
bindir: exe
|
10
10
|
cert_chain: []
|
11
|
-
date: 2021-
|
11
|
+
date: 2021-04-27 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
|
-
name: danger
|
14
|
+
name: danger-gitlab
|
15
15
|
requirement: !ruby/object:Gem::Requirement
|
16
16
|
requirements:
|
17
17
|
- - ">="
|
@@ -110,7 +110,7 @@ dependencies:
|
|
110
110
|
version: '0'
|
111
111
|
description: This gem provides common Dangerfile and plugins for GitLab projects.
|
112
112
|
email:
|
113
|
-
-
|
113
|
+
- gitlab_rubygems@gitlab.com
|
114
114
|
executables: []
|
115
115
|
extensions: []
|
116
116
|
extra_rdoc_files: []
|
@@ -119,6 +119,7 @@ files:
|
|
119
119
|
- ".gitlab-ci.yml"
|
120
120
|
- ".gitlab/merge_request_templates/Release.md"
|
121
121
|
- ".rspec"
|
122
|
+
- ".yardopts"
|
122
123
|
- CODE_OF_CONDUCT.md
|
123
124
|
- Gemfile
|
124
125
|
- Guardfile
|
@@ -130,14 +131,16 @@ files:
|
|
130
131
|
- fixtures/emojis/aliases.json
|
131
132
|
- fixtures/emojis/digests.json
|
132
133
|
- gitlab-dangerfiles.gemspec
|
133
|
-
- lib/danger/helper.rb
|
134
|
-
- lib/danger/roulette.rb
|
134
|
+
- lib/danger/plugins/helper.rb
|
135
|
+
- lib/danger/plugins/roulette.rb
|
136
|
+
- lib/danger/rules/changes_size/Dangerfile
|
135
137
|
- lib/gitlab-dangerfiles.rb
|
136
138
|
- lib/gitlab/Dangerfile
|
137
139
|
- lib/gitlab/dangerfiles.rb
|
138
140
|
- lib/gitlab/dangerfiles/base_linter.rb
|
139
141
|
- lib/gitlab/dangerfiles/changes.rb
|
140
142
|
- lib/gitlab/dangerfiles/commit_linter.rb
|
143
|
+
- lib/gitlab/dangerfiles/config.rb
|
141
144
|
- lib/gitlab/dangerfiles/emoji_checker.rb
|
142
145
|
- lib/gitlab/dangerfiles/merge_request_linter.rb
|
143
146
|
- lib/gitlab/dangerfiles/spec_helper.rb
|
@@ -154,7 +157,7 @@ metadata:
|
|
154
157
|
allowed_push_host: https://rubygems.org
|
155
158
|
homepage_uri: https://gitlab.com/gitlab-org/gitlab-dangerfiles
|
156
159
|
source_code_uri: https://gitlab.com/gitlab-org/gitlab-dangerfiles
|
157
|
-
changelog_uri: https://gitlab.com/gitlab-org/gitlab-dangerfiles
|
160
|
+
changelog_uri: https://gitlab.com/gitlab-org/gitlab-dangerfiles/-/releases
|
158
161
|
post_install_message:
|
159
162
|
rdoc_options: []
|
160
163
|
require_paths:
|
@@ -170,7 +173,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
170
173
|
- !ruby/object:Gem::Version
|
171
174
|
version: '0'
|
172
175
|
requirements: []
|
173
|
-
rubygems_version: 3.1.
|
176
|
+
rubygems_version: 3.1.6
|
174
177
|
signing_key:
|
175
178
|
specification_version: 4
|
176
179
|
summary: This gem provides common Dangerfile and plugins for GitLab projects.
|
data/lib/danger/helper.rb
DELETED
@@ -1,257 +0,0 @@
|
|
1
|
-
# frozen_string_literal: true
|
2
|
-
|
3
|
-
require "net/http"
|
4
|
-
require "json"
|
5
|
-
require "danger"
|
6
|
-
require_relative "../gitlab/dangerfiles/changes"
|
7
|
-
require_relative "../gitlab/dangerfiles/teammate"
|
8
|
-
require_relative "../gitlab/dangerfiles/title_linting"
|
9
|
-
|
10
|
-
module Danger
|
11
|
-
# Common helper functions for our danger scripts.
|
12
|
-
class Helper < Danger::Plugin
|
13
|
-
RELEASE_TOOLS_BOT = "gitlab-release-tools-bot"
|
14
|
-
DRAFT_REGEX = /\A*#{Regexp.union(/(?i)(\[WIP\]\s*|WIP:\s*|WIP$)/, /(?i)(\[draft\]|\(draft\)|draft:|draft\s\-\s|draft$)/)}+\s*/i.freeze
|
15
|
-
CATEGORY_LABELS = {
|
16
|
-
docs: "~documentation", # Docs are reviewed along DevOps stages, so don't need roulette for now.
|
17
|
-
none: "",
|
18
|
-
qa: "~QA",
|
19
|
-
test: "~test ~Quality for `spec/features/*`",
|
20
|
-
engineering_productivity: '~"Engineering Productivity" for CI, Danger',
|
21
|
-
ci_template: '~"ci::templates"',
|
22
|
-
}.freeze
|
23
|
-
|
24
|
-
HTTPError = Class.new(StandardError)
|
25
|
-
|
26
|
-
def gitlab_helper
|
27
|
-
# Unfortunately the following does not work:
|
28
|
-
# - respond_to?(:gitlab)
|
29
|
-
# - respond_to?(:gitlab, true)
|
30
|
-
gitlab
|
31
|
-
rescue NoMethodError
|
32
|
-
nil
|
33
|
-
end
|
34
|
-
|
35
|
-
def html_link(str)
|
36
|
-
ci? ? gitlab_helper.html_link(str) : str
|
37
|
-
end
|
38
|
-
|
39
|
-
def ci?
|
40
|
-
!gitlab_helper.nil?
|
41
|
-
end
|
42
|
-
|
43
|
-
# @param [String] url
|
44
|
-
def http_get_json(url)
|
45
|
-
rsp = Net::HTTP.get_response(URI.parse(url))
|
46
|
-
|
47
|
-
unless rsp.is_a?(Net::HTTPOK)
|
48
|
-
raise HTTPError, "Failed to read #{url}: #{rsp.code} #{rsp.message}"
|
49
|
-
end
|
50
|
-
|
51
|
-
JSON.parse(rsp.body)
|
52
|
-
end
|
53
|
-
|
54
|
-
# Returns a list of all files that have been added, modified or renamed.
|
55
|
-
# `git.modified_files` might contain paths that already have been renamed,
|
56
|
-
# so we need to remove them from the list.
|
57
|
-
#
|
58
|
-
# Considering these changes:
|
59
|
-
#
|
60
|
-
# - A new_file.rb
|
61
|
-
# - D deleted_file.rb
|
62
|
-
# - M modified_file.rb
|
63
|
-
# - R renamed_file_before.rb -> renamed_file_after.rb
|
64
|
-
#
|
65
|
-
# it will return
|
66
|
-
# ```
|
67
|
-
# [ 'new_file.rb', 'modified_file.rb', 'renamed_file_after.rb' ]
|
68
|
-
# ```
|
69
|
-
#
|
70
|
-
# @return [Array<String>]
|
71
|
-
def all_changed_files
|
72
|
-
Set.new
|
73
|
-
.merge(git.added_files.to_a)
|
74
|
-
.merge(git.modified_files.to_a)
|
75
|
-
.merge(git.renamed_files.map { |x| x[:after] })
|
76
|
-
.subtract(git.renamed_files.map { |x| x[:before] })
|
77
|
-
.to_a
|
78
|
-
.sort
|
79
|
-
end
|
80
|
-
|
81
|
-
# Returns a string containing changed lines as git diff
|
82
|
-
#
|
83
|
-
# Considering changing a line in lib/gitlab/usage_data.rb it will return:
|
84
|
-
#
|
85
|
-
# [ "--- a/lib/gitlab/usage_data.rb",
|
86
|
-
# "+++ b/lib/gitlab/usage_data.rb",
|
87
|
-
# "+ # Test change",
|
88
|
-
# "- # Old change" ]
|
89
|
-
def changed_lines(changed_file)
|
90
|
-
diff = git.diff_for_file(changed_file)
|
91
|
-
return [] unless diff
|
92
|
-
|
93
|
-
diff.patch.split("\n").select { |line| %r{^[+-]}.match?(line) }
|
94
|
-
end
|
95
|
-
|
96
|
-
def release_automation?
|
97
|
-
gitlab_helper&.mr_author == RELEASE_TOOLS_BOT
|
98
|
-
end
|
99
|
-
|
100
|
-
def markdown_list(items)
|
101
|
-
list = items.map { |item| "* `#{item}`" }.join("\n")
|
102
|
-
|
103
|
-
if items.size > 10
|
104
|
-
"\n<details>\n\n#{list}\n\n</details>\n"
|
105
|
-
else
|
106
|
-
list
|
107
|
-
end
|
108
|
-
end
|
109
|
-
|
110
|
-
# @return [Hash<Symbol,Array<String>>]
|
111
|
-
def changes_by_category(categories)
|
112
|
-
all_changed_files.each_with_object(Hash.new { |h, k| h[k] = [] }) do |file, hash|
|
113
|
-
categories_for_file(file, categories).each { |category| hash[category] << file }
|
114
|
-
end
|
115
|
-
end
|
116
|
-
|
117
|
-
# @return [Gitlab::Dangerfiles::Changes]
|
118
|
-
def changes(categories)
|
119
|
-
Gitlab::Dangerfiles::Changes.new([]).tap do |changes|
|
120
|
-
git.added_files.each do |file|
|
121
|
-
categories_for_file(file, categories).each { |category| changes << Gitlab::Dangerfiles::Change.new(file, :added, category) }
|
122
|
-
end
|
123
|
-
|
124
|
-
git.modified_files.each do |file|
|
125
|
-
categories_for_file(file, categories).each { |category| changes << Gitlab::Dangerfiles::Change.new(file, :modified, category) }
|
126
|
-
end
|
127
|
-
|
128
|
-
git.deleted_files.each do |file|
|
129
|
-
categories_for_file(file, categories).each { |category| changes << Gitlab::Dangerfiles::Change.new(file, :deleted, category) }
|
130
|
-
end
|
131
|
-
|
132
|
-
git.renamed_files.map { |x| x[:before] }.each do |file|
|
133
|
-
categories_for_file(file, categories).each { |category| changes << Gitlab::Dangerfiles::Change.new(file, :renamed_before, category) }
|
134
|
-
end
|
135
|
-
|
136
|
-
git.renamed_files.map { |x| x[:after] }.each do |file|
|
137
|
-
categories_for_file(file, categories).each { |category| changes << Gitlab::Dangerfiles::Change.new(file, :renamed_after, category) }
|
138
|
-
end
|
139
|
-
end
|
140
|
-
end
|
141
|
-
|
142
|
-
# Determines the categories a file is in, e.g., `[:frontend]`, `[:backend]`, or `%i[frontend engineering_productivity]`
|
143
|
-
# using filename regex and specific change regex if given.
|
144
|
-
#
|
145
|
-
# @return Array<Symbol>
|
146
|
-
def categories_for_file(file, categories)
|
147
|
-
_, categories = categories.find do |key, _|
|
148
|
-
filename_regex, changes_regex = Array(key)
|
149
|
-
|
150
|
-
found = filename_regex.match?(file)
|
151
|
-
found &&= changed_lines(file).any? { |changed_line| changes_regex.match?(changed_line) } if changes_regex
|
152
|
-
|
153
|
-
found
|
154
|
-
end
|
155
|
-
|
156
|
-
Array(categories || :unknown)
|
157
|
-
end
|
158
|
-
|
159
|
-
# Returns the GFM for a category label, making its best guess if it's not
|
160
|
-
# a category we know about.
|
161
|
-
#
|
162
|
-
# @return[String]
|
163
|
-
def label_for_category(category)
|
164
|
-
CATEGORY_LABELS.fetch(category, "~#{category}")
|
165
|
-
end
|
166
|
-
|
167
|
-
def new_teammates(usernames)
|
168
|
-
usernames.map { |u| Gitlab::Dangerfiles::Teammate.new("username" => u) }
|
169
|
-
end
|
170
|
-
|
171
|
-
def mr_iid
|
172
|
-
return "" unless gitlab_helper
|
173
|
-
|
174
|
-
gitlab_helper.mr_json["iid"]
|
175
|
-
end
|
176
|
-
|
177
|
-
def mr_title
|
178
|
-
return "" unless gitlab_helper
|
179
|
-
|
180
|
-
gitlab_helper.mr_json["title"]
|
181
|
-
end
|
182
|
-
|
183
|
-
def mr_web_url
|
184
|
-
return "" unless gitlab_helper
|
185
|
-
|
186
|
-
gitlab_helper.mr_json["web_url"]
|
187
|
-
end
|
188
|
-
|
189
|
-
def mr_labels
|
190
|
-
return [] unless gitlab_helper
|
191
|
-
|
192
|
-
gitlab_helper.mr_labels
|
193
|
-
end
|
194
|
-
|
195
|
-
def mr_target_branch
|
196
|
-
return "" unless gitlab_helper
|
197
|
-
|
198
|
-
gitlab_helper.mr_json["target_branch"]
|
199
|
-
end
|
200
|
-
|
201
|
-
def draft_mr?
|
202
|
-
Gitlab::Dangerfiles::TitleLinting.has_draft_flag?(mr_title)
|
203
|
-
end
|
204
|
-
|
205
|
-
def security_mr?
|
206
|
-
mr_web_url.include?("/gitlab-org/security/")
|
207
|
-
end
|
208
|
-
|
209
|
-
def cherry_pick_mr?
|
210
|
-
Gitlab::Dangerfiles::TitleLinting.has_cherry_pick_flag?(mr_title)
|
211
|
-
end
|
212
|
-
|
213
|
-
def run_all_rspec_mr?
|
214
|
-
Gitlab::Dangerfiles::TitleLinting.has_run_all_rspec_flag?(mr_title)
|
215
|
-
end
|
216
|
-
|
217
|
-
def run_as_if_foss_mr?
|
218
|
-
Gitlab::Dangerfiles::TitleLinting.has_run_as_if_foss_flag?(mr_title)
|
219
|
-
end
|
220
|
-
|
221
|
-
def stable_branch?
|
222
|
-
/\A\d+-\d+-stable-ee/i.match?(mr_target_branch)
|
223
|
-
end
|
224
|
-
|
225
|
-
def mr_has_labels?(*labels)
|
226
|
-
labels = labels.flatten.uniq
|
227
|
-
|
228
|
-
(labels & mr_labels) == labels
|
229
|
-
end
|
230
|
-
|
231
|
-
def labels_list(labels, sep: ", ")
|
232
|
-
labels.map { |label| %Q{~"#{label}"} }.join(sep)
|
233
|
-
end
|
234
|
-
|
235
|
-
def prepare_labels_for_mr(labels)
|
236
|
-
return "" unless labels.any?
|
237
|
-
|
238
|
-
"/label #{labels_list(labels, sep: " ")}"
|
239
|
-
end
|
240
|
-
|
241
|
-
def changed_files(regex)
|
242
|
-
all_changed_files.grep(regex)
|
243
|
-
end
|
244
|
-
|
245
|
-
def has_database_scoped_labels?(current_mr_labels)
|
246
|
-
current_mr_labels.any? { |label| label.start_with?("database::") }
|
247
|
-
end
|
248
|
-
|
249
|
-
def has_ci_changes?
|
250
|
-
changed_files(%r{\A(\.gitlab-ci\.yml|\.gitlab/ci/)}).any?
|
251
|
-
end
|
252
|
-
|
253
|
-
def group_label(labels)
|
254
|
-
labels.find { |label| label.start_with?("group::") }
|
255
|
-
end
|
256
|
-
end
|
257
|
-
end
|