Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add MPICH cop and test #6214

Merged
merged 4 commits into from Jun 7, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
18 changes: 18 additions & 0 deletions Library/Homebrew/rubocops/lines.rb
Expand Up @@ -157,6 +157,24 @@ def unless_modifier?(node)
end
end

class MpiCheck < FormulaCop
def audit_formula(_node, _class_node, _parent_class_node, body_node)
# Enforce use of OpenMPI for MPI dependency in core
return unless formula_tap == "homebrew-core"

find_method_with_args(body_node, :depends_on, "mpich") do
problem "Use 'depends_on \"open-mpi\"' instead of '#{@offensive_node.source}'."
end
end

def autocorrect(node)
# The dependency nodes may need to be re-sorted because of this
lambda do |corrector|
corrector.replace(node.source_range, "depends_on \"open-mpi\"")
end
end
end

class Miscellaneous < FormulaCop
def audit_formula(_node, _class_node, _parent_class_node, body_node)
# FileUtils is included in Formula
Expand Down
2 changes: 1 addition & 1 deletion Library/Homebrew/rubocops/text.rb
Expand Up @@ -16,7 +16,7 @@ def audit_formula(_node, _class_node, _parent_class_node, body_node)
problem "Formulae should not depend on both OpenSSL and LibreSSL (even optionally)."
end

if depends_on?("veclibfort") || depends_on?("lapack")
if formula_tap == "homebrew-core" && (depends_on?("veclibfort") || depends_on?("lapack"))
problem "Formulae should use OpenBLAS as the default serial linear algebra library."
end

Expand Down
25 changes: 25 additions & 0 deletions Library/Homebrew/test/rubocops/lines_spec.rb
Expand Up @@ -279,6 +279,31 @@ def options
end
end

describe RuboCop::Cop::FormulaAudit::MpiCheck do
subject(:cop) { described_class.new }

context "When auditing formula" do
it "reports an offense when using depends_on \"mpich\"" do
expect_offense(<<~RUBY, "/homebrew-core/")
class Foo < Formula
desc "foo"
url 'https://brew.sh/foo-1.0.tgz'
depends_on "mpich"
^^^^^^^^^^^^^^^^^^ Use 'depends_on "open-mpi"' instead of 'depends_on "mpich"'.
end
RUBY

expect_correction(<<~RUBY)
class Foo < Formula
desc "foo"
url 'https://brew.sh/foo-1.0.tgz'
depends_on "open-mpi"
end
RUBY
end
end
end

describe RuboCop::Cop::FormulaAudit::Miscellaneous do
subject(:cop) { described_class.new }

Expand Down
22 changes: 22 additions & 0 deletions Library/Homebrew/test/rubocops/text_spec.rb
Expand Up @@ -32,6 +32,28 @@ class Foo < Formula
RUBY
end

it "when veclibfort is used instead of OpenBLAS" do
expect_offense(<<~RUBY, "/homebrew-core/")
class Foo < Formula
url "https://brew.sh/foo-1.0.tgz"
homepage "https://brew.sh"
depends_on "veclibfort"
^^^^^^^^^^^^^^^^^^^^^^^ Formulae should use OpenBLAS as the default serial linear algebra library.
end
RUBY
end

it "when lapack is used instead of OpenBLAS" do
expect_offense(<<~RUBY, "/homebrew-core/")
class Foo < Formula
url "https://brew.sh/foo-1.0.tgz"
homepage "https://brew.sh"
depends_on "lapack"
^^^^^^^^^^^^^^^^^^^ Formulae should use OpenBLAS as the default serial linear algebra library.
end
RUBY
end

it "When xcodebuild is called without SYMROOT" do
expect_offense(<<~RUBY)
class Foo < Formula
Expand Down