mirror of
https://github.com/servo/servo.git
synced 2025-06-06 16:45:39 +00:00
04f8ae56db
tidy check for vim and emacs modelines See #10719. It skips *.webidl files for now since I am not sure where they come from and if they should be edited in tree or not. <!-- Reviewable:start --> --- This change is [<img src="https://reviewable.io/review_button.svg" height="35" align="absmiddle" alt="Reviewable"/>](https://reviewable.io/reviews/servo/servo/10786) <!-- Reviewable:end -->
103 lines
5.3 KiB
Python
103 lines
5.3 KiB
Python
# Copyright 2013 The Servo Project Developers. See the COPYRIGHT
|
|
# file at the top-level directory of this distribution.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
|
|
# http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
|
|
# <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
|
|
# option. This file may not be copied, modified, or distributed
|
|
# except according to those terms.
|
|
|
|
import os
|
|
import unittest
|
|
from servo_tidy import tidy
|
|
|
|
base_path = 'servo_tidy_tests/' if os.path.exists('servo_tidy_tests/') else 'python/tidy/servo_tidy_tests/'
|
|
|
|
|
|
def iterFile(name):
|
|
return iter([os.path.join(base_path, name)])
|
|
|
|
|
|
class CheckTidiness(unittest.TestCase):
|
|
def assertNoMoreErrors(self, errors):
|
|
with self.assertRaises(StopIteration):
|
|
errors.next()
|
|
|
|
def test_spaces_correctnes(self):
|
|
errors = tidy.collect_errors_for_files(iterFile('wrong_space.rs'), [], [tidy.check_by_line])
|
|
self.assertEqual('trailing whitespace', errors.next()[2])
|
|
self.assertEqual('no newline at EOF', errors.next()[2])
|
|
self.assertEqual('tab on line', errors.next()[2])
|
|
self.assertEqual('CR on line', errors.next()[2])
|
|
self.assertEqual('no newline at EOF', errors.next()[2])
|
|
self.assertNoMoreErrors(errors)
|
|
|
|
def test_long_line(self):
|
|
errors = tidy.collect_errors_for_files(iterFile('long_line.rs'), [], [tidy.check_by_line])
|
|
self.assertEqual('Line is longer than 120 characters', errors.next()[2])
|
|
self.assertNoMoreErrors(errors)
|
|
|
|
def test_whatwg_link(self):
|
|
errors = tidy.collect_errors_for_files(iterFile('whatwg_link.rs'), [], [tidy.check_by_line])
|
|
self.assertTrue('link to WHATWG may break in the future, use this format instead:' in errors.next()[2])
|
|
self.assertTrue('links to WHATWG single-page url, change to multi page:' in errors.next()[2])
|
|
self.assertNoMoreErrors(errors)
|
|
|
|
def test_licence(self):
|
|
errors = tidy.collect_errors_for_files(iterFile('incorrect_license.rs'), [], [tidy.check_license])
|
|
self.assertEqual('incorrect license', errors.next()[2])
|
|
self.assertNoMoreErrors(errors)
|
|
|
|
def test_rust(self):
|
|
errors = tidy.collect_errors_for_files(iterFile('rust_tidy.rs'), [], [tidy.check_rust])
|
|
self.assertEqual('use statement spans multiple lines', errors.next()[2])
|
|
self.assertEqual('missing space before }', errors.next()[2])
|
|
self.assertTrue('use statement is not in alphabetical order' in errors.next()[2])
|
|
self.assertEqual('encountered whitespace following a use statement', errors.next()[2])
|
|
self.assertTrue('mod declaration is not in alphabetical order' in errors.next()[2])
|
|
self.assertEqual('mod declaration spans multiple lines', errors.next()[2])
|
|
self.assertTrue('extern crate declaration is not in alphabetical order' in errors.next()[2])
|
|
self.assertEqual('missing space before ->', errors.next()[2])
|
|
self.assertEqual('missing space after ->', errors.next()[2])
|
|
self.assertEqual('missing space after :', errors.next()[2])
|
|
self.assertEqual('missing space before {', errors.next()[2])
|
|
self.assertEqual('missing space before =', errors.next()[2])
|
|
self.assertEqual('missing space after =', errors.next()[2])
|
|
self.assertEqual('missing space before -', errors.next()[2])
|
|
self.assertEqual('missing space before *', errors.next()[2])
|
|
self.assertEqual('missing space after =>', errors.next()[2])
|
|
self.assertEqual('extra space before :', errors.next()[2])
|
|
self.assertEqual('extra space before :', errors.next()[2])
|
|
self.assertEqual('use &[T] instead of &Vec<T>', errors.next()[2])
|
|
self.assertEqual('use &str instead of &String', errors.next()[2])
|
|
self.assertEqual('operators should go at the end of the first line', errors.next()[2])
|
|
self.assertNoMoreErrors(errors)
|
|
|
|
def test_spec_link(self):
|
|
tidy.spec_base_path = base_path
|
|
errors = tidy.collect_errors_for_files(iterFile('speclink.rs'), [], [tidy.check_spec])
|
|
self.assertEqual('method declared in webidl is missing a comment with a specification link', errors.next()[2])
|
|
self.assertNoMoreErrors(errors)
|
|
|
|
def test_webidl(self):
|
|
errors = tidy.collect_errors_for_files(iterFile('spec.webidl'), [tidy.check_webidl_spec], [])
|
|
self.assertEqual('No specification link found.', errors.next()[2])
|
|
self.assertNoMoreErrors(errors)
|
|
|
|
def test_toml(self):
|
|
errors = tidy.collect_errors_for_files(iterFile('test.toml'), [tidy.check_toml], [])
|
|
self.assertEqual('found asterisk instead of minimum version number', errors.next()[2])
|
|
self.assertNoMoreErrors(errors)
|
|
|
|
def test_modeline(self):
|
|
errors = tidy.collect_errors_for_files(iterFile('modeline.txt'), [], [tidy.check_modeline])
|
|
self.assertEqual('vi modeline present', errors.next()[2])
|
|
self.assertEqual('vi modeline present', errors.next()[2])
|
|
self.assertEqual('vi modeline present', errors.next()[2])
|
|
self.assertEqual('emacs file variables present', errors.next()[2])
|
|
self.assertEqual('emacs file variables present', errors.next()[2])
|
|
|
|
|
|
def do_tests():
|
|
suite = unittest.TestLoader().loadTestsFromTestCase(CheckTidiness)
|
|
unittest.TextTestRunner(verbosity=2).run(suite)
|