admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity

Merge pull request #7328 from MikeMcQuaid/keg_only_tweaks

Browse Source 
keg_only tweaks
This commit is contained in:
Mike McQuaid 2020-04-12 14:39:47 +01:00 committed by GitHub
commit 793407a2e0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
22 changed files with 163 additions and 110 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Library/Homebrew/cmd/link.rb
View File

@ -68,10 +68,10 @@ module Homebrew
if keg_only
if Homebrew.default_prefix?
f = keg.to_formula
if f.keg_only_reason.reason == :provided_by_macos
if f.keg_only_reason.reason.by_macos?
caveats = Caveats.new(f)
opoo <<~EOS
Refusing to link macOS-provided software: #{keg.name}
Refusing to link macOS provided/shadowed software: #{keg.name}
#{caveats.keg_only_text(skip_reason: true).strip}
EOS
next

132
Library/Homebrew/dev-cmd/audit.rb
View File

@ -364,6 +364,13 @@ module Homebrew
problem "Formula name conflicts with existing core formula."
end
USES_FROM_MACOS_WHITELIST = %w[
apr
apr-util
openblas
openssl@1.1
].freeze
def audit_deps
@specs.each do |spec|
# Check for things we don't like to depend on.
@ -396,9 +403,9 @@ module Homebrew
end
if @new_formula &&
dep_f.keg_only_reason&.reason == :provided_by_macos &&
dep_f.keg_only_reason.valid? &&
!%w[apr apr-util openblas openssl openssl@1.1].include?(dep.name)
dep_f.keg_only_reason.provided_by_macos? &&
dep_f.keg_only_reason.applicable? &&
!USES_FROM_MACOS_WHITELIST.include?(dep.name)
new_formula_problem(
"Dependency '#{dep.name}' is provided by macOS; " \
"please replace 'depends_on' with 'uses_from_macos'.",
@ -502,28 +509,28 @@ module Homebrew
end
end
VERSIONED_KEG_ONLY_WHITELIST = %w[
autoconf@2.13
bash-completion@2
gnupg@1.4
lua@5.1
numpy@1.16
libsigc++@2
].freeze
def audit_versioned_keg_only
return unless @versioned_formula
return unless @core_tap
if formula.keg_only?
return if formula.keg_only_reason.reason == :versioned_formula
return if formula.keg_only_reason.versioned_formula?
if formula.name.start_with?("openssl", "libressl") &&
formula.keg_only_reason.reason == :provided_by_macos
formula.keg_only_reason.provided_by_macos?
return
end
end
keg_only_whitelist = %w[
autoconf@2.13
bash-completion@2
gnupg@1.4
lua@5.1
numpy@1.16
libsigc++@2
].freeze
return if keg_only_whitelist.include?(formula.name) || formula.name.start_with?("gcc@")
return if VERSIONED_KEG_ONLY_WHITELIST.include?(formula.name) || formula.name.start_with?("gcc@")
problem "Versioned formulae in homebrew/core should use `keg_only :versioned_formula`"
end
@ -661,6 +668,47 @@ module Homebrew
[user, repo]
end
VERSIONED_HEAD_SPEC_WHITELIST = %w[
bash-completion@2
imagemagick@6
].freeze
THROTTLED_BLACKLIST = {
"aws-sdk-cpp" => "10",
"awscli@1" => "10",
"quicktype" => "10",
"vim" => "50",
}.freeze
UNSTABLE_WHITELIST = {
"aalib" => "1.4rc",
"automysqlbackup" => "3.0-rc",
"aview" => "1.3.0rc",
"elm-format" => "0.6.0-alpha",
"ftgl" => "2.1.3-rc",
"hidapi" => "0.8.0-rc",
"libcaca" => "0.99b",
"premake" => "4.4-beta",
"pwnat" => "0.3-beta",
"recode" => "3.7-beta",
"speexdsp" => "1.2rc",
"sqoop" => "1.4.",
"tcptraceroute" => "1.5beta",
"tiny-fugue" => "5.0b",
"vbindiff" => "3.0_beta",
}.freeze
GNOME_DEVEL_WHITELIST = {
"libart" => "2.3",
"gtk-mac-integration" => "2.1",
"gtk-doc" => "1.31",
"gcab" => "1.3",
"libepoxy" => "1.5",
}.freeze
# version_prefix = stable_version_string.sub(/\d+$/, "")
# version_prefix = stable_version_string.split(".")[0..1].join(".")
def audit_specs
problem "Head-only (no stable download)" if head_only?(formula)
problem "Devel-only (no stable download)" if devel_only?(formula)
@ -714,60 +762,18 @@ module Homebrew
if formula.head && @versioned_formula
head_spec_message = "Formulae should not have a `HEAD` spec"
versioned_head_spec = %w[
bash-completion@2
imagemagick@6
]
problem head_spec_message unless versioned_head_spec.include?(formula.name)
problem head_spec_message unless VERSIONED_HEAD_SPEC_WHITELIST.include?(formula.name)
end
throttled = %w[
aws-sdk-cpp 10
awscli@1 10
quicktype 10
vim 50
]
throttled.each_slice(2).to_a.map do |a, b|
THROTTLED_BLACKLIST.each do |f, v|
next if formula.stable.nil?
version = formula.stable.version.to_s.split(".").last.to_i
if a == formula.name && version.modulo(b.to_i).nonzero?
problem "should only be updated every #{b} releases on multiples of #{b}"
if f == formula.name && version.modulo(v.to_i).nonzero?
problem "should only be updated every #{v} releases on multiples of #{v}"
end
end
unstable_whitelist = %w[
aalib 1.4rc5
automysqlbackup 3.0-rc6
aview 1.3.0rc1
elm-format 0.6.0-alpha
ftgl 2.1.3-rc5
hidapi 0.8.0-rc1
libcaca 0.99b19
premake 4.4-beta5
pwnat 0.3-beta
recode 3.7-beta2
speexdsp 1.2rc3
sqoop 1.4.6
tcptraceroute 1.5beta7
tiny-fugue 5.0b8
vbindiff 3.0_beta4
].each_slice(2).to_a.map do |formula, version|
[formula, version.sub(/\d+$/, "")]
end
gnome_devel_whitelist = %w[
libart 2.3.21
pygtkglext 1.1.0
gtk-mac-integration 2.1.3
gtk-doc 1.31
gcab 1.3
libepoxy 1.5.4
].each_slice(2).to_a.map do |formula, version|
[formula, version.split(".")[0..1].join(".")]
end
stable = formula.stable
return unless stable
return unless stable.url
@ -782,12 +788,12 @@ module Homebrew
when /[\d\._-](alpha|beta|rc\d)/
matched = Regexp.last_match(1)
version_prefix = stable_version_string.sub(/\d+$/, "")
return if unstable_whitelist.include?([formula.name, version_prefix])
return if UNSTABLE_WHITELIST[formula.name] == version_prefix
problem "Stable version URLs should not contain #{matched}"
when %r{download\.gnome\.org/sources}, %r{ftp\.gnome\.org/pub/GNOME/sources}i
version_prefix = stable_version_string.split(".")[0..1].join(".")
return if gnome_devel_whitelist.include?([formula.name, version_prefix])
return if GNOME_DEVEL_WHITELIST[formula.name] == version_prefix
return if stable_url_version < Version.create("1.0")
return if stable_url_minor_version.even?

2
Library/Homebrew/extend/os/mac/formula_support.rb
View File

@ -1,7 +1,7 @@
# frozen_string_literal: true
class KegOnlyReason
def valid?
def applicable?
true
end
end

2
Library/Homebrew/formula.rb
View File

@ -1045,7 +1045,7 @@ class Formula
def keg_only?
return false unless keg_only_reason
keg_only_reason.valid?
keg_only_reason.applicable?
end
# @private

29
Library/Homebrew/formula_support.rb
View File

@ -13,24 +13,41 @@ class KegOnlyReason
@explanation = explanation
end
def valid?
![:provided_by_macos, :provided_by_osx, :shadowed_by_macos].include?(@reason)
def versioned_formula?
@reason == :versioned_formula
end
def provided_by_macos?
@reason == :provided_by_macos
end
def shadowed_by_macos?
@reason == :shadowed_by_macos
end
def by_macos?
provided_by_macos? || shadowed_by_macos?
end
def applicable?
# macOS reasons aren't applicable on other OSs
# (see extend/os/mac/formula_support for override on macOS)
!by_macos?
end
def to_s
return @explanation unless @explanation.empty?
case @reason
when :versioned_formula
if versioned_formula?
<<~EOS
this is an alternate version of another formula
EOS
when :provided_by_macos
elsif provided_by_macos?
<<~EOS
macOS already provides this software and installing another version in
parallel can cause all kinds of trouble
EOS
when :shadowed_by_macos
elsif shadowed_by_macos?
<<~EOS
macOS provides similar software and installing this software in
parallel can cause all kinds of trouble

6
Library/Homebrew/rubocops/class.rb
View File

@ -70,7 +70,7 @@ module RuboCop
end
end
module FormulaAuditStrict
module FormulaAudit
# - `test do ..end` should be meaningfully defined in the formula.
class Test < FormulaCop
def audit_formula(_node, _class_node, _parent_class_node, body_node)
@ -86,8 +86,8 @@ module RuboCop
return
end
return unless test.body.single_line? &&
test.body.source.to_s == "true"
return unless test.body.single_line?
return if test.body.source.to_s != "true"
problem "`test do` should contain a real test"
end

4
Library/Homebrew/rubocops/conflicts.rb
View File

@ -12,13 +12,13 @@ module RuboCop
"Use `keg_only :versioned_formula` instead."
WHITELIST = %w[
bash-completion@
bash-completion@2
].freeze
def audit_formula(_node, _class_node, _parent_class_node, body)
return unless versioned_formula?
problem MSG if !@formula_name.start_with?(*WHITELIST) &&
problem MSG if !WHITELIST.include?(@formula_name) &&
method_called_ever?(body, :conflicts_with)
end
end

2
Library/Homebrew/rubocops/formula_desc.rb
View File

@ -38,7 +38,7 @@ module RuboCop
end
end
module FormulaAuditStrict
module FormulaAudit
# This cop audits `desc` in Formulae.
#
# - Checks for leading/trailing whitespace in `desc`

40
Library/Homebrew/rubocops/lines.rb
View File

@ -196,6 +196,26 @@ module RuboCop
end
class Miscellaneous < FormulaCop
MAKE_CHECK_WHITELIST = %w[
beecrypt
ccrypt
git
gmp
gnupg
gnupg@1.4
google-sparsehash
jemalloc
jpeg-turbo
mpfr
nettle
open-mpi
openssl@1.1
pcre
protobuf
wolfssl
xz
].freeze
def audit_formula(_node, _class_node, _parent_class_node, body_node)
# FileUtils is included in Formula
# encfs modifies a file with this name, so check for some leading characters
@ -425,25 +445,7 @@ module RuboCop
# Avoid build-time checks in homebrew/core
find_every_method_call_by_name(body_node, :system).each do |method|
next if @formula_name.start_with?("lib")
next if %w[
beecrypt
ccrypt
git
gmp
gnupg
gnupg@1.4
google-sparsehash
jemalloc
jpeg-turbo
mpfr
nettle
open-mpi
openssl@1.1
pcre
protobuf
wolfssl
xz
].include?(@formula_name)
next if MAKE_CHECK_WHITELIST.include?(@formula_name)
params = parameters(method)
next unless node_equals?(params[0], "make")

2
Library/Homebrew/rubocops/options.rb
View File

@ -39,7 +39,7 @@ module RuboCop
" Migrate '--#{option}' with `deprecated_option`."
end
return unless formula_tap == "homebrew-core"
return if formula_tap != "homebrew-core"
problem DEP_OPTION if method_called_ever?(body_node, :deprecated_option)
problem OPTION if method_called_ever?(body_node, :option)

16
Library/Homebrew/rubocops/text.rb
View File

@ -12,7 +12,7 @@ module RuboCop
problem "Please set plist_options when using a formula-defined plist."
end
if depends_on?("openssl") && depends_on?("libressl")
if (depends_on?("openssl") || depends_on?("openssl@1.1")) && depends_on?("libressl")
problem "Formulae should not depend on both OpenSSL and LibreSSL (even optionally)."
end
@ -61,17 +61,19 @@ module RuboCop
find_method_with_args(body_node, :system, "cargo", "build") do
problem "use \"cargo\", \"install\", \"--root\", prefix, \"--path\", \".\""
end
end
end
end
module FormulaAuditStrict
class Text < FormulaCop
def audit_formula(_node, _class_node, _parent_class_node, body_node)
find_method_with_args(body_node, :go_resource) do
problem "`go_resource`s are deprecated. Please ask upstream to implement Go vendoring"
end
end
end
end
# Keep this (empty) module and class around in case we need it later to
# avoid deleting all the FormulaAuditStrict referencing logic.
module FormulaAuditStrict
class Text < FormulaCop
end
end
end
end

2
Library/Homebrew/rubocops/uses_from_macos.rb
View File

@ -26,7 +26,7 @@ module RuboCop
m4
ncurses
openldap
openssl
openssl@1.1
perl
php
ruby

7
Library/Homebrew/test/dev-cmd/audit_spec.rb
View File

@ -633,5 +633,12 @@ module Homebrew
expect(fa.problems).to eq([])
end
end
include_examples "formulae exist", described_class::VERSIONED_KEG_ONLY_WHITELIST
include_examples "formulae exist", described_class::VERSIONED_HEAD_SPEC_WHITELIST
include_examples "formulae exist", described_class::USES_FROM_MACOS_WHITELIST
include_examples "formulae exist", described_class::THROTTLED_BLACKLIST.keys
include_examples "formulae exist", described_class::UNSTABLE_WHITELIST.keys
include_examples "formulae exist", described_class::GNOME_DEVEL_WHITELIST.keys
end
end

2
Library/Homebrew/test/rubocops/class_spec.rb
View File

@ -105,7 +105,7 @@ describe RuboCop::Cop::FormulaAudit::TestCalls do
end
end
describe RuboCop::Cop::FormulaAuditStrict::Test do
describe RuboCop::Cop::FormulaAudit::Test do
subject(:cop) { described_class.new }
it "reports an offense when there is no test block" do

2
Library/Homebrew/test/rubocops/conflicts_spec.rb
View File

@ -26,4 +26,6 @@ describe RuboCop::Cop::FormulaAudit::Conflicts do
RUBY
end
end
include_examples "formulae exist", described_class::WHITELIST
end

2
Library/Homebrew/test/rubocops/formula_desc_spec.rb
View File

@ -48,7 +48,7 @@ describe RuboCop::Cop::FormulaAudit::DescLength do
end
end
describe RuboCop::Cop::FormulaAuditStrict::Desc do
describe RuboCop::Cop::FormulaAudit::Desc do
subject(:cop) { described_class.new }
context "When auditing formula desc" do

2
Library/Homebrew/test/rubocops/lines_spec.rb
View File

@ -860,4 +860,6 @@ describe RuboCop::Cop::FormulaAudit::Miscellaneous do
RUBY
end
end
include_examples "formulae exist", described_class::MAKE_CHECK_WHITELIST
end

2
Library/Homebrew/test/rubocops/urls_spec.rb
View File

@ -218,6 +218,8 @@ describe RuboCop::Cop::FormulaAudit::Urls do
RUBY
end
end
include_examples "formulae exist", described_class::BINARY_BOOTSTRAP_FORMULA_URLS_WHITELIST
end
describe RuboCop::Cop::FormulaAudit::PyPiUrls do

2
Library/Homebrew/test/rubocops/uses_from_macos_spec.rb
View File

@ -16,4 +16,6 @@ describe RuboCop::Cop::FormulaAudit::UsesFromMacos do
end
RUBY
end
include_examples "formulae exist", described_class::ALLOWED_USES_FROM_MACOS_DEPS
end

1
Library/Homebrew/test/spec_helper.rb
View File

@ -52,6 +52,7 @@ require "test/support/helper/output_as_tty"
require "test/support/helper/spec/shared_context/homebrew_cask" if OS.mac?
require "test/support/helper/spec/shared_context/integration_test"
require "test/support/helper/spec/shared_examples/formulae_exist"
TEST_DIRECTORIES = [
CoreTap.instance.path/"Formula",

10
Library/Homebrew/test/support/helper/spec/shared_examples/formulae_exist.rb Normal file
View File

@ -0,0 +1,10 @@
# frozen_string_literal: true
shared_examples "formulae exist" do |array|
array.each do |f|
it "#{f} formula exists" do
formula_path = Pathname("#{HOMEBREW_LIBRARY_PATH}/../Taps/homebrew/homebrew-core/Formula/#{f}.rb")
expect(formula_path.exist?).to be true
end
end
end

2
Library/Homebrew/test/support/lib/config.rb
View File

@ -17,7 +17,7 @@ TEST_TMPDIR = ENV.fetch("HOMEBREW_TEST_TMPDIR") do |k|
end.freeze
# Paths pointing into the Homebrew code base that persist across test runs
HOMEBREW_SHIMS_PATH = (HOMEBREW_LIBRARY_PATH.parent/"Homebrew/shims").freeze
HOMEBREW_SHIMS_PATH = (HOMEBREW_LIBRARY_PATH/"shims").freeze
require "extend/git_repository"