web_dev_style: add presubmit for superfluous </include> tags.

chrome/browser/test_presubmit.py

 #!/usr/bin/env python
 # Copyright (c) 2012 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 """Unit tests for Web Development Style Guide checker."""
 
 import os
 import re
 import sys
 import unittest
 
 test_dir = os.path.dirname(os.path.abspath(__file__))
 sys.path.extend([
     os.path.normpath(os.path.join(test_dir, '..', '..', 'tools')),
     os.path.join(test_dir),
 ])
 
 import find_depot_tools # pylint: disable=W0611
 from testing_support.super_mox import SuperMoxTestBase
-from web_dev_style import css_checker, js_checker # pylint: disable=F0401
+from web_dev_style import resource_checker, css_checker, js_checker # pylint: disable=F0401
+
+
+def GetHighlight(line, error):
+  """Returns the substring of |line| that is highlighted in |error|."""
+  error_lines = error.split('\n')
+  highlight = error_lines[error_lines.index(line) + 1]
+  return ''.join(ch1 for (ch1, ch2) in zip(line, highlight) if ch2 == '^')
+
+
+class ResourceStyleGuideTest(SuperMoxTestBase):
+  def setUp(self):
+    SuperMoxTestBase.setUp(self)
+
+    input_api = self.mox.CreateMockAnything()
+    input_api.re = re
+    output_api = self.mox.CreateMockAnything()
+    self.checker = resource_checker.ResourceChecker(input_api, output_api)
+
+  def ShouldFailIncludeCheck(self, line):
+    """Checks that the '</include>' checker flags |line| as a style error."""
+    error = self.checker.IncludeCheck(1, line)
+    self.assertNotEqual('', error,
+        'Should be flagged as style error: ' + line)
+    self.assertEqual(GetHighlight(line, error), '</include>')
+
+  def ShouldPassIncludeCheck(self, line):
+    """Checks that the '</include>' checker doesn't flag |line| as an error."""
+    self.assertEqual('', self.checker.IncludeCheck(1, line),
+        'Should not be flagged as style error: ' + line)
+
+  def testIncludeFails(self):
+    lines = [
+        "</include>   ",
+        "    </include>",
+        "    </include>   ",
+    ]
+    for line in lines:
+      self.ShouldFailIncludeCheck(line)
+
+  def testIncludePasses(self):
+    lines = [
+        '<include src="assert.js">',
+        "<include src='../../assert.js'>",
+        "<i>include src='blah'</i>",
+        "</i>nclude",
+        "</i>include",
+    ]
+    for line in lines:
+      self.ShouldPassIncludeCheck(line)
 
 
 class JsStyleGuideTest(SuperMoxTestBase):
   def setUp(self):
     SuperMoxTestBase.setUp(self)
 
     input_api = self.mox.CreateMockAnything()
     input_api.re = re
     output_api = self.mox.CreateMockAnything()
     self.checker = js_checker.JSChecker(input_api, output_api)
 
-  def GetHighlight(self, line, error):
-    """Returns the substring of |line| that is highlighted in |error|."""
-    error_lines = error.split('\n')
-    highlight = error_lines[error_lines.index(line) + 1]
-    return ''.join(ch1 for (ch1, ch2) in zip(line, highlight) if ch2 == '^')
-
   def ShouldFailConstCheck(self, line):
     """Checks that the 'const' checker flags |line| as a style error."""
     error = self.checker.ConstCheck(1, line)
     self.assertNotEqual('', error,
         'Should be flagged as style error: ' + line)
-    self.assertEqual(self.GetHighlight(line, error), 'const')
+    self.assertEqual(GetHighlight(line, error), 'const')
 
   def ShouldPassConstCheck(self, line):
     """Checks that the 'const' checker doesn't flag |line| as a style error."""
     self.assertEqual('', self.checker.ConstCheck(1, line),
         'Should not be flagged as style error: ' + line)
 
   def testConstFails(self):
     lines = [
         "const foo = 'bar';",
         "    const bar = 'foo';",
@@ skipping 38 matching lines @@
         #"var str = 'a const in the middle';",
     ]
     for line in lines:
       self.ShouldPassConstCheck(line)
 
   def ShouldFailChromeSendCheck(self, line):
     """Checks that the 'chrome.send' checker flags |line| as a style error."""
     error = self.checker.ChromeSendCheck(1, line)
     self.assertNotEqual('', error,
         'Should be flagged as style error: ' + line)
-    self.assertEqual(self.GetHighlight(line, error), ', []')
+    self.assertEqual(GetHighlight(line, error), ', []')
 
   def ShouldPassChromeSendCheck(self, line):
     """Checks that the 'chrome.send' checker doesn't flag |line| as a style
        error.
     """
     self.assertEqual('', self.checker.ChromeSendCheck(1, line),
         'Should not be flagged as style error: ' + line)
 
   def testChromeSendFails(self):
     lines = [
@@ skipping 11 matching lines @@
         "  chrome.send('message', constructArgs([]));",
     ]
     for line in lines:
       self.ShouldPassChromeSendCheck(line)
 
   def ShouldFailEndJsDocCommentCheck(self, line):
     """Checks that the **/ checker flags |line| as a style error."""
     error = self.checker.EndJsDocCommentCheck(1, line)
     self.assertNotEqual('', error,
         'Should be flagged as style error: ' + line)
-    self.assertEqual(self.GetHighlight(line, error), '**/')
+    self.assertEqual(GetHighlight(line, error), '**/')
 
   def ShouldPassEndJsDocCommentCheck(self, line):
     """Checks that the **/ checker doesn't flag |line| as a style error."""
     self.assertEqual('', self.checker.EndJsDocCommentCheck(1, line),
         'Should not be flagged as style error: ' + line)
 
   def testEndJsDocCommentFails(self):
     lines = [
         "/** @override **/",
         "/** @type {number} @const **/",
@@ skipping 14 matching lines @@
     for line in lines:
       self.ShouldPassEndJsDocCommentCheck(line)
 
   def ShouldFailGetElementByIdCheck(self, line):
     """Checks that the 'getElementById' checker flags |line| as a style
        error.
     """
     error = self.checker.GetElementByIdCheck(1, line)
     self.assertNotEqual('', error,
         'Should be flagged as style error: ' + line)
-    self.assertEqual(self.GetHighlight(line, error), 'document.getElementById')
+    self.assertEqual(GetHighlight(line, error), 'document.getElementById')
 
   def ShouldPassGetElementByIdCheck(self, line):
     """Checks that the 'getElementById' checker doesn't flag |line| as a style
        error.
     """
     self.assertEqual('', self.checker.GetElementByIdCheck(1, line),
         'Should not be flagged as style error: ' + line)
 
   def testGetElementByIdFails(self):
     lines = [
@@ skipping 19 matching lines @@
         "if (doc.getElementById('foo').hidden) {",
     ]
     for line in lines:
       self.ShouldPassGetElementByIdCheck(line)
 
   def ShouldFailInheritDocCheck(self, line):
     """Checks that the '@inheritDoc' checker flags |line| as a style error."""
     error = self.checker.InheritDocCheck(1, line)
     self.assertNotEqual('', error,
         msg='Should be flagged as style error: ' + line)
-    self.assertEqual(self.GetHighlight(line, error), '@inheritDoc')
+    self.assertEqual(GetHighlight(line, error), '@inheritDoc')
 
   def ShouldPassInheritDocCheck(self, line):
     """Checks that the '@inheritDoc' checker doesn't flag |line| as a style
        error.
     """
     self.assertEqual('', self.checker.InheritDocCheck(1, line),
         msg='Should not be flagged as style error: ' + line)
 
   def testInheritDocFails(self):
     lines = [
@@ skipping 13 matching lines @@
     for line in lines:
       self.ShouldPassInheritDocCheck(line)
 
   def ShouldFailWrapperTypeCheck(self, line):
     """Checks that the use of wrapper types (i.e. new Number(), @type {Number})
        is a style error.
     """
     error = self.checker.WrapperTypeCheck(1, line)
     self.assertNotEqual('', error,
         msg='Should be flagged as style error: ' + line)
-    highlight = self.GetHighlight(line, error)
+    highlight = GetHighlight(line, error)
     self.assertTrue(highlight in ('Boolean', 'Number', 'String'))
 
   def ShouldPassWrapperTypeCheck(self, line):
     """Checks that the wrapper type checker doesn't flag |line| as a style
        error.
     """
     self.assertEqual('', self.checker.WrapperTypeCheck(1, line),
         msg='Should not be flagged as style error: ' + line)
 
   def testWrapperTypePasses(self):
@@ skipping 21 matching lines @@
         " * @param {number|String}",
     ]
     for line in lines:
       self.ShouldFailWrapperTypeCheck(line)
 
   def ShouldFailVarNameCheck(self, line):
     """Checks that var unix_hacker, $dollar are style errors."""
     error = self.checker.VarNameCheck(1, line)
     self.assertNotEqual('', error,
         msg='Should be flagged as style error: ' + line)
-    highlight = self.GetHighlight(line, error)
+    highlight = GetHighlight(line, error)
     self.assertFalse('var ' in highlight);
 
   def ShouldPassVarNameCheck(self, line):
     """Checks that variableNamesLikeThis aren't style errors."""
     self.assertEqual('', self.checker.VarNameCheck(1, line),
         msg='Should not be flagged as style error: ' + line)
 
   def testVarNameFails(self):
     lines = [
         "var private_;",
@@ skipping 360 matching lines @@
     opacity: .0;
     opacity: 0.0;
     opacity: 0.;
     border-width: 0mm;
     height: 0cm;
     width: 0in;
 """)
 
 if __name__ == '__main__':
   unittest.main()