diff options
| -rw-r--r-- | Library/Homebrew/test/test_cmd_audit.rb | 250 |
1 files changed, 250 insertions, 0 deletions
diff --git a/Library/Homebrew/test/test_cmd_audit.rb b/Library/Homebrew/test/test_cmd_audit.rb new file mode 100644 index 000000000..20df333ba --- /dev/null +++ b/Library/Homebrew/test/test_cmd_audit.rb @@ -0,0 +1,250 @@ +require "testing_env" +require "fileutils" +require "pathname" +require "formulary" +require "cmd/audit" + +class FormulaTextTests < Homebrew::TestCase + def setup + @dir = mktmpdir + end + + def teardown + FileUtils.rm_rf @dir + end + + def formula_text(name, text) + path = Pathname.new "#{@dir}/#{name}.rb" + path.open("w") { |f| f.write text } + FormulaText.new path + end + + def test_simple_valid_formula + ft = formula_text "valid", <<-EOS.undent + class Valid < Formula + url "http://www.example.com/valid-1.0.tar.gz" + end + EOS + + refute ft.has_DATA?, "The formula doesn't have DATA" + refute ft.has_END?, "The formula doesn't have __END__" + assert ft.has_trailing_newline?, "The formula have a trailing newline" + + assert ft =~ /\burl\b/, "The formula match 'url'" + assert_nil ft.line_number(/desc/), "The formula doesn't match 'desc'" + assert_equal 2, ft.line_number(/\burl\b/) + end + + def test_trailing_newline + ft = formula_text "newline", "class Newline < Formula; end" + refute ft.has_trailing_newline?, "The formula doesn't have a trailing newline" + end + + def test_has_data + ft = formula_text "data", <<-EOS.undent + class Data < Formula + patch :DATA + end + EOS + + assert ft.has_DATA?, "The formula has DATA" + end + + def test_has_end + ft = formula_text "end", <<-EOS.undent + class End < Formula + end + __END__ + a patch here + EOS + + assert ft.has_END?, "The formula has __END__" + assert_equal "class End < Formula\nend", ft.without_patch + end +end + +class FormulaAuditorTests < Homebrew::TestCase + def setup + @dir = mktmpdir + end + + def teardown + FileUtils.rm_rf @dir + end + + def formula_auditor(name, text, options = {}) + path = Pathname.new "#{@dir}/#{name}.rb" + path.open("w") { |f| f.write text } + FormulaAuditor.new Formulary.factory(path), options + end + + def test_init_no_problems + fa = formula_auditor "foo", <<-EOS.undent + class Foo < Formula + url "http://example.com/foo-1.0.tgz" + end + EOS + + assert_equal [], fa.problems + end + + def test_audit_file_permissions + File.stubs(:umask).returns 022 + fa = formula_auditor "foo", <<-EOS.undent + class Foo < Formula + url "http://example.com/foo-1.0.tgz" + end + EOS + + path = fa.formula.path + path.chmod 0400 + + fa.audit_file + assert_equal ["Incorrect file permissions (400): chmod 644 #{path}"], + fa.problems + end + + def test_audit_file_data_no_end + fa = formula_auditor "foo", <<-EOS.undent + class Foo < Formula + url "http://example.com/foo-1.0.tgz" + patch :DATA + end + EOS + fa.audit_file + assert_equal ["'DATA' was found, but no '__END__'"], fa.problems + end + + def test_audit_file_end_no_data + fa = formula_auditor "foo", <<-EOS.undent + class Foo < Formula + url "http://example.com/foo-1.0.tgz" + end + __END__ + a patch goes here + EOS + fa.audit_file + assert_equal ["'__END__' was found, but 'DATA' is not used"], fa.problems + end + + def test_audit_file_no_trailing_newline + fa = formula_auditor "foo", 'class Foo<Formula; url "file:///foo-1.0.tgz";end' + fa.audit_file + assert_equal ["File should end with a newline"], fa.problems + end + + def test_audit_file_not_strict_no_issue + fa = formula_auditor "foo", <<-EOS.undent + class Foo < Formula + url "http://example.com/foo-1.0.tgz" + homepage "http://example.com" + end + EOS + fa.audit_file + assert_equal [], fa.problems + end + + def test_audit_file_strict_ordering_issue + fa = formula_auditor "foo", <<-EOS.undent, :strict => true + class Foo < Formula + url "http://example.com/foo-1.0.tgz" + homepage "http://example.com" + end + EOS + fa.audit_file + assert_equal ["`homepage` (line 3) should be put before `url` (line 2)"], + fa.problems + end + + def test_audit_file_strict_url_outside_of_stable_block + fa = formula_auditor "foo", <<-EOS.undent, :strict => true + class Foo < Formula + url "http://example.com/foo-1.0.tgz" + stable do + # stuff + end + end + EOS + fa.audit_file + assert_equal ["`url` should be put inside `stable block`"], fa.problems + end + + def test_audit_file_strict_head_and_head_do + fa = formula_auditor "foo", <<-EOS.undent, :strict => true + class Foo < Formula + head "http://example.com/foo.git" + head do + # stuff + end + end + EOS + fa.audit_file + assert_equal ["Should not have both `head` and `head do`"], fa.problems + end + + def test_audit_file_strict_bottle_and_bottle_do + fa = formula_auditor "foo", <<-EOS.undent, :strict => true + class Foo < Formula + url "http://example.com/foo-1.0.tgz" + bottle do + # bottles go here + end + bottle :unneeded + end + EOS + fa.audit_file + assert_equal ["Should not have `bottle :unneeded/:disable` and `bottle do`"], + fa.problems + end + + def test_audit_class_no_test + fa = formula_auditor "foo", <<-EOS.undent + class Foo < Formula + url "http://example.com/foo-1.0.tgz" + end + EOS + fa.audit_class + assert_equal [], fa.problems + + fa = formula_auditor "foo", <<-EOS.undent, :strict => true + class Foo < Formula + url "http://example.com/foo-1.0.tgz" + end + EOS + fa.audit_class + assert_equal ["A `test do` test block should be added"], fa.problems + end + + def test_audit_class_github_gist_formula + fa = formula_auditor "foo", <<-EOS.undent + class Foo < GithubGistFormula + url "http://example.com/foo-1.0.tgz" + end + EOS + fa.audit_class + assert_equal ["GithubGistFormula is deprecated, use Formula instead"], + fa.problems + end + + def test_audit_class_script_file_formula + fa = formula_auditor "foo", <<-EOS.undent + class Foo < ScriptFileFormula + url "http://example.com/foo-1.0.tgz" + end + EOS + fa.audit_class + assert_equal ["ScriptFileFormula is deprecated, use Formula instead"], + fa.problems + end + + def test_audit_class_aws_formula + fa = formula_auditor "foo", <<-EOS.undent + class Foo < AmazonWebServicesFormula + url "http://example.com/foo-1.0.tgz" + end + EOS + fa.audit_class + assert_equal ["AmazonWebServicesFormula is deprecated, use Formula instead"], + fa.problems + end +end |