Skip to content

Commit

Permalink
Merge pull request #6214 from zbeekman/add-MPI-cop
Browse files Browse the repository at this point in the history
Add MPICH cop and test
  • Loading branch information
MikeMcQuaid authored Jun 7, 2019
2 parents e9adaaa + 11de7de commit c95cf90
Show file tree
Hide file tree
Showing 4 changed files with 66 additions and 1 deletion.
18 changes: 18 additions & 0 deletions Library/Homebrew/rubocops/lines.rb
Original file line number Diff line number Diff line change
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
Original file line number Diff line number Diff line change
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
Original file line number Diff line number Diff line change
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
Original file line number Diff line number Diff line change
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

0 comments on commit c95cf90

Please sign in to comment.