37eaed5bb7
- There's a TODO on the "someday" list [1] to ensure that `head` Git URLs always specify a branch. - So I thought I'd automate this worry by adding an audit. - Since `resource` block URLs tend to be pinned to SHAs, if indeed they are Git URLs, this audit only applies to `head` URLs. [1]: https://github.com/orgs/Homebrew/projects/5?pane=issue&itemId=98789749
120 lines
3.2 KiB
Ruby
120 lines
3.2 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
require "rubocops/components_redundancy"
|
|
|
|
RSpec.describe RuboCop::Cop::FormulaAudit::ComponentsRedundancy do
|
|
subject(:cop) { described_class.new }
|
|
|
|
context "when auditing formula components" do
|
|
it "reports an offense if `url` is outside `stable` block" do
|
|
expect_offense(<<~RUBY)
|
|
class Foo < Formula
|
|
url "https://brew.sh/foo-1.0.tgz"
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ FormulaAudit/ComponentsRedundancy: `url` should be put inside `stable` block
|
|
stable do
|
|
# stuff
|
|
end
|
|
|
|
head do
|
|
# stuff
|
|
end
|
|
end
|
|
RUBY
|
|
end
|
|
|
|
it "reports an offense if both `head` and `head do` are present" do
|
|
expect_offense(<<~RUBY)
|
|
class Foo < Formula
|
|
head "https://brew.sh/foo.git", branch: "develop"
|
|
head do
|
|
^^^^^^^ FormulaAudit/ComponentsRedundancy: `head` and `head do` should not be simultaneously present
|
|
# stuff
|
|
end
|
|
end
|
|
RUBY
|
|
end
|
|
|
|
it "reports an offense if both `bottle :modifier` and `bottle do` are present" do
|
|
expect_offense(<<~RUBY)
|
|
class Foo < Formula
|
|
url "https://brew.sh/foo-1.0.tgz"
|
|
bottle do
|
|
^^^^^^^^^ FormulaAudit/ComponentsRedundancy: `bottle :modifier` and `bottle do` should not be simultaneously present
|
|
# bottles go here
|
|
end
|
|
bottle :unneeded
|
|
end
|
|
RUBY
|
|
end
|
|
|
|
it "reports no offenses if `stable do` is present with a `head` method" do
|
|
expect_no_offenses(<<~RUBY)
|
|
class Foo < Formula
|
|
head "https://brew.sh/foo.git", branch: "develop"
|
|
|
|
stable do
|
|
# stuff
|
|
end
|
|
end
|
|
RUBY
|
|
end
|
|
|
|
it "reports no offenses if `stable do` is present with a `head do` block" do
|
|
expect_no_offenses(<<~RUBY)
|
|
class Foo < Formula
|
|
stable do
|
|
# stuff
|
|
end
|
|
|
|
head do
|
|
# stuff
|
|
end
|
|
end
|
|
RUBY
|
|
end
|
|
|
|
it "reports an offense if `stable do` or `head do` is present with only `url`" do
|
|
expect_offense(<<~RUBY)
|
|
class Foo < Formula
|
|
stable do
|
|
^^^^^^^^^ FormulaAudit/ComponentsRedundancy: `stable do` should not be present with only url/sha256/mirror/version
|
|
url "https://brew.sh/foo-1.0.tgz"
|
|
end
|
|
|
|
head do
|
|
^^^^^^^ FormulaAudit/ComponentsRedundancy: `head do` should not be present with only `url`
|
|
url "https://brew.sh/foo.git"
|
|
end
|
|
end
|
|
RUBY
|
|
end
|
|
|
|
it "reports no offenses if `stable do` is present with `url` and `depends_on`" do
|
|
expect_no_offenses(<<~RUBY)
|
|
class Foo < Formula
|
|
head "https://brew.sh/foo.git", branch: "trunk"
|
|
|
|
stable do
|
|
url "https://brew.sh/foo-1.0.tgz"
|
|
depends_on "bar"
|
|
end
|
|
end
|
|
RUBY
|
|
end
|
|
|
|
it "reports no offenses if `head do` is present with `url` and `depends_on`" do
|
|
expect_no_offenses(<<~RUBY)
|
|
class Foo < Formula
|
|
url "https://brew.sh/foo-1.0.tgz"
|
|
|
|
head do
|
|
url "https://brew.sh/foo.git"
|
|
branch "develop"
|
|
depends_on "bar"
|
|
end
|
|
end
|
|
RUBY
|
|
end
|
|
end
|
|
end
|