Module: SharedAudits Private

Defined in:
utils/shared_audits.rb

Overview

This module is part of a private API. This module may only be used in the Homebrew/brew repository. Third parties should avoid using this module if possible, as it may be removed or changed without warning.

Auditing functions for rules common to both casks and formulae.

Constant Summary collapse

URL_TYPE_HOMEPAGE =

This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning. 

"homepage URL"

Class Method Summary collapse

Class Method Details

.bitbucket(user, repo) ⇒ String?

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

Returns:



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'utils/shared_audits.rb', line 163

def self.bitbucket(user, repo)
  api_url = "https://api.bitbucket.org/2.0/repositories/#{user}/#{repo}"
  result = Utils::Curl.curl_output("--request", "GET", api_url)
  return unless result.status.success?

  metadata = JSON.parse(result.stdout)
  return if metadata.nil?

  return "Uses deprecated Mercurial support in Bitbucket" if metadata["scm"] == "hg"

  return "Bitbucket fork (not canonical repository)" unless metadata["parent"].nil?

  return "Bitbucket repository too new (<30 days old)" if Date.parse(metadata["created_on"]) >= (Date.today - 30)

  forks_result = Utils::Curl.curl_output("--request", "GET", "#{api_url}/forks")
  return unless forks_result.status.success?

  watcher_result = Utils::Curl.curl_output("--request", "GET", "#{api_url}/watchers")
  return unless watcher_result.status.success?

  forks_metadata = JSON.parse(forks_result.stdout)
  return if forks_metadata.nil?

  watcher_metadata = JSON.parse(watcher_result.stdout)
  return if watcher_metadata.nil?

  return if forks_metadata["size"] >= 30 || watcher_metadata["size"] >= 75

  "Bitbucket repository not notable enough (<30 forks and <75 watchers)"
end

.check_deprecate_disable_reason(formula_or_cask) ⇒ String?

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

Returns:



206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'utils/shared_audits.rb', line 206

def self.check_deprecate_disable_reason(formula_or_cask)
  return if !formula_or_cask.deprecated? && !formula_or_cask.disabled?

  reason = formula_or_cask.deprecated? ? formula_or_cask.deprecation_reason : formula_or_cask.disable_reason
  return unless reason.is_a?(Symbol)

  reasons = if formula_or_cask.is_a?(Formula)
    DeprecateDisable::FORMULA_DEPRECATE_DISABLE_REASONS
  else
    DeprecateDisable::CASK_DEPRECATE_DISABLE_REASONS
  end

  "#{reason} is not a valid deprecate! or disable! reason" unless reasons.include?(reason)
end

.eol_data(product, cycle) ⇒ Hash{String => T.untyped}?

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

Returns:



12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'utils/shared_audits.rb', line 12

def self.eol_data(product, cycle)
  @eol_data ||= T.let({}, T.nilable(T::Hash[String, T.untyped]))
  key = "#{product}/#{cycle}"
  return @eol_data[key] if @eol_data.key?(key)

  result = Utils::Curl.curl_output(
    "--location",
    "https://endoflife.date/api/v1/products/#{product}/releases/#{cycle}",
  )
  return unless result.status.success?

  @eol_data[key] = begin
    JSON.parse(result.stdout)
  rescue JSON::ParserError
    nil
  end
end

.github(user, repo) ⇒ String?

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

Returns:



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'utils/shared_audits.rb', line 129

def self.github(user, repo)
  metadata = github_repo_data(user, repo)

  return if metadata.nil?

  return "GitHub fork (not canonical repository)" if metadata["fork"]

  if (metadata["forks_count"] < 30) && (metadata["subscribers_count"] < 30) &&
     (metadata["stargazers_count"] < 75)
    return "GitHub repository not notable enough (<30 forks, <30 watchers and <75 stars)"
  end

  return if Date.parse(metadata["created_at"]) <= (Date.today - 30)

  "GitHub repository too new (<30 days old)"
end

.github_release(user, repo, tag, formula: nil, cask: nil) ⇒ String?

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

Returns:



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'utils/shared_audits.rb', line 63

def self.github_release(user, repo, tag, formula: nil, cask: nil)
  release = github_release_data(user, repo, tag)
  return unless release

  exception, name, version = if formula
    [formula.tap&.audit_exception(:github_prerelease_allowlist, formula.name), formula.name, formula.version]
  elsif cask
    [cask.tap&.audit_exception(:github_prerelease_allowlist, cask.token), cask.token, cask.version]
  end

  return "#{tag} is a GitHub pre-release." if release["prerelease"] && [version, "all", "any"].exclude?(exception)

  if !release["prerelease"] && exception && [version, "any"].exclude?(exception)
    return "#{tag} is not a GitHub pre-release but '#{name}' is in the GitHub prerelease allowlist."
  end

  "#{tag} is a GitHub draft." if release["draft"]
end

.github_repo_data(user, repo) ⇒ Hash{String => T.untyped}?

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

Returns:



31
32
33
34
35
36
37
38
39
40
 
# File 'utils/shared_audits.rb', line 31

def self.github_repo_data(user, repo)
  @github_repo_data ||= T.let({}, T.nilable(T::Hash[String, T.untyped]))
  @github_repo_data["#{user}/#{repo}"] ||= GitHub.repository(user, repo)

  @github_repo_data["#{user}/#{repo}"]
rescue GitHub::API::HTTPNotFoundError
  nil
rescue GitHub::API::AuthenticationFailedError => e
  raise unless e.message.match?(GitHub::API::GITHUB_IP_ALLOWLIST_ERROR)
end

.github_tag_from_url(url) ⇒ String?

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

Returns:



195
196
197
198
 
# File 'utils/shared_audits.rb', line 195

def self.github_tag_from_url(url)
  tag = url[%r{^https://github\.com/[\w-]+/[\w.-]+/archive/refs/tags/(.+)\.(tar\.gz|zip)$}, 1]
  tag || url[%r{^https://github\.com/[\w-]+/[\w.-]+/releases/download/([^/]+)/}, 1]
end

.gitlab(user, repo) ⇒ String?

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

Returns:



147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'utils/shared_audits.rb', line 147

def self.gitlab(user, repo)
  metadata = gitlab_repo_data(user, repo)

  return if metadata.nil?

  return "GitLab fork (not canonical repository)" if metadata["fork"]
  if (metadata["forks_count"] < 30) && (metadata["star_count"] < 75)
    return "GitLab repository not notable enough (<30 forks and <75 stars)"
  end

  return if Date.parse(metadata["created_at"]) <= (Date.today - 30)

  "GitLab repository too new (<30 days old)"
end

.gitlab_release(user, repo, tag, formula: nil, cask: nil) ⇒ String?

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

Returns:



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'utils/shared_audits.rb', line 112

def self.gitlab_release(user, repo, tag, formula: nil, cask: nil)
  release = gitlab_release_data(user, repo, tag)
  return unless release

  return if DateTime.parse(release["released_at"]) <= DateTime.now

  exception, version = if formula
    [formula.tap&.audit_exception(:gitlab_prerelease_allowlist, formula.name), formula.version]
  elsif cask
    [cask.tap&.audit_exception(:gitlab_prerelease_allowlist, cask.token), cask.version]
  end
  return if [version, "all"].include?(exception)

  "#{tag} is a GitLab pre-release."
end

.gitlab_repo_data(user, repo) ⇒ Hash{String => T.untyped}?

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

Returns:



83
84
85
86
87
88
89
90
91
 
# File 'utils/shared_audits.rb', line 83

def self.gitlab_repo_data(user, repo)
  @gitlab_repo_data ||= T.let({}, T.nilable(T::Hash[String, T.untyped]))
  @gitlab_repo_data["#{user}/#{repo}"] ||= begin
    result = Utils::Curl.curl_output("https://gitlab.com/api/v4/projects/#{user}%2F#{repo}")
    json = JSON.parse(result.stdout) if result.status.success?
    json = nil if json&.dig("message")&.include?("404 Project Not Found")
    json
  end
end

.gitlab_tag_from_url(url) ⇒ String?

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

Returns:



201
202
203
 
# File 'utils/shared_audits.rb', line 201

def self.gitlab_tag_from_url(url)
  url[%r{^https://gitlab\.com/(?:\w[\w.-]*/){2,}-/archive/([^/]+)/}, 1]
end

.no_autobump_new_package_message(message) ⇒ String?

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

Returns:



222
223
224
225
226
 
# File 'utils/shared_audits.rb', line 222

def self.no_autobump_new_package_message(message)
  return if message.is_a?(String) || message != :requires_manual_review

  "`:requires_manual_review` is a temporary reason intended for existing packages, use a different reason instead."
end