Module: SharedAudits Private

Extended by:
Utils::Curl
Includes:
Utils::Curl
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.

Class Method Summary collapse

Methods included from Utils::Curl

curl, curl_args, curl_check_http_content, curl_download, curl_executable, curl_http_content_headers_and_checksum, curl_output, curl_with_workarounds, http_status_ok?, parse_headers, url_protected_by_cloudflare?, url_protected_by_incapsula?

Class Method Details

.bitbucket(user, repo) ⇒ Object

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.



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
# File 'utils/shared_audits.rb', line 121

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

   = JSON.parse(out)
  return if .nil?

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

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

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

  forks_out, _, forks_status= curl_output("--request", "GET", "#{api_url}/forks")
  return unless forks_status.success?

  watcher_out, _, watcher_status= curl_output("--request", "GET", "#{api_url}/watchers")
  return unless watcher_status.success?

   = JSON.parse(forks_out)
  return if .nil?

   = JSON.parse(watcher_out)
  return if .nil?

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

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

.github(user, repo) ⇒ Object

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.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
# File 'utils/shared_audits.rb', line 89

def github(user, repo)
   = github_repo_data(user, repo)

  return if .nil?

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

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

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

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

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

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.



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
# File 'utils/shared_audits.rb', line 35

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

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

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

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

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

.github_release_data(user, repo, tag) ⇒ Object

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.



24
25
26
27
28
29
30
31
32
33
# File 'utils/shared_audits.rb', line 24

def github_release_data(user, repo, tag)
  id = "#{user}/#{repo}/#{tag}"
  url = "#{GitHub::API_URL}/repos/#{user}/#{repo}/releases/tags/#{tag}"
  @github_release_data ||= {}
  @github_release_data[id] ||= GitHub::API.open_rest(url)

  @github_release_data[id]
rescue GitHub::API::HTTPNotFoundError
  nil
end

.github_repo_data(user, repo) ⇒ Object

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.



15
16
17
18
19
20
21
22
# File 'utils/shared_audits.rb', line 15

def github_repo_data(user, repo)
  @github_repo_data ||= {}
  @github_repo_data["#{user}/#{repo}"] ||= GitHub.repository(user, repo)

  @github_repo_data["#{user}/#{repo}"]
rescue GitHub::API::HTTPNotFoundError
  nil
end

.github_tag_from_url(url) ⇒ Object

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.



152
153
154
155
156
157
158
159
160
161
# File 'utils/shared_audits.rb', line 152

def github_tag_from_url(url)
  url = url.to_s
  tag = url.match(%r{^https://github\.com/[\w-]+/[\w-]+/archive/([^/]+)\.(tar\.gz|zip)$})
           .to_a
           .second
  tag ||= url.match(%r{^https://github\.com/[\w-]+/[\w-]+/releases/download/([^/]+)/})
             .to_a
             .second
  tag
end

.gitlab(user, repo) ⇒ Object

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.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
# File 'utils/shared_audits.rb', line 106

def gitlab(user, repo)
   = gitlab_repo_data(user, repo)

  return if .nil?

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

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

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

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

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.



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
# File 'utils/shared_audits.rb', line 73

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

  return if Date.parse(release["released_at"]) <= Date.today

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

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

.gitlab_release_data(user, repo, tag) ⇒ Object

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.



62
63
64
65
66
67
68
69
70
71
# File 'utils/shared_audits.rb', line 62

def gitlab_release_data(user, repo, tag)
  id = "#{user}/#{repo}/#{tag}"
  @gitlab_release_data ||= {}
  @gitlab_release_data[id] ||= begin
    out, _, status = curl_output(
      "https://gitlab.com/api/v4/projects/#{user}%2F#{repo}/releases/#{tag}", "--fail"
    )
    JSON.parse(out) if status.success?
  end
end

.gitlab_repo_data(user, repo) ⇒ Object

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.



54
55
56
57
58
59
60
# File 'utils/shared_audits.rb', line 54

def gitlab_repo_data(user, repo)
  @gitlab_repo_data ||= {}
  @gitlab_repo_data["#{user}/#{repo}"] ||= begin
    out, _, status = curl_output("https://gitlab.com/api/v4/projects/#{user}%2F#{repo}")
    JSON.parse(out) if status.success?
  end
end

.gitlab_tag_from_url(url) ⇒ Object

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.



163
164
165
166
167
168
# File 'utils/shared_audits.rb', line 163

def gitlab_tag_from_url(url)
  url = url.to_s
  url.match(%r{^https://gitlab\.com/[\w-]+/[\w-]+/-/archive/([^/]+)/})
     .to_a
     .second
end

.tap_audit_exception(list, tap, formula_or_cask, value = nil) ⇒ Object

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.



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
# File 'utils/shared_audits.rb', line 170

def tap_audit_exception(list, tap, formula_or_cask, value = nil)
  return false if tap.audit_exceptions.blank?
  return false unless tap.audit_exceptions.key? list

  list = tap.audit_exceptions[list]

  case list
  when Array
    list.include? formula_or_cask
  when Hash
    return false if list.exclude? formula_or_cask
    return list[formula_or_cask] if value.blank?

    list[formula_or_cask] == value
  end
end