Prase IDL files in common/extensions/api PRESUBMIT check.

Review URL: https://chromiumcodereview.appspot.com/23512007

git-svn-id: svn://svn.chromium.org/chrome/trunk/src@224709 0039d316-1c4b-4281-b951-d872f2087c98

chrome/common/extensions/api/PRESUBMIT.py

@@ -2,8 +2,9 @@
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
-def _GetJSONParseError(input_api, contents):
+def _GetJSONParseError(input_api, filename):
   try:
+    contents = input_api.ReadFile(filename)
     json_comment_eater = input_api.os_path.join(
         input_api.PresubmitLocalPath(),
         '..', '..', '..', '..', 'tools',
@@ -11,7 +12,8 @@ def _GetJSONParseError(input_api, contents):
     process = input_api.subprocess.Popen(
         [input_api.python_executable, json_comment_eater],
         stdin=input_api.subprocess.PIPE,
-        stdout=input_api.subprocess.PIPE)
+        stdout=input_api.subprocess.PIPE,
+        universal_newlines=True)
     (nommed, _) = process.communicate(input=contents)
     input_api.json.loads(nommed)
   except ValueError as e:
@@ -19,6 +21,20 @@ def _GetJSONParseError(input_api, contents):
   return None
 
 
+def _GetIDLParseError(input_api, filename):
+  idl_schema = input_api.os_path.join(
+      input_api.PresubmitLocalPath(),
+      '..', '..', '..', '..', 'tools',
+      'json_schema_compiler', 'idl_schema.py')
+  process = input_api.subprocess.Popen(
+      [input_api.python_executable, idl_schema, filename],
+      stdout=input_api.subprocess.PIPE,
+      stderr=input_api.subprocess.PIPE,
+      universal_newlines=True)
+  (_, error) = process.communicate()
+  return error or None
+
+
 def _GetParseErrors(input_api, output_api):
   # Run unit tests.
   results = []
@@ -27,17 +43,24 @@ def _GetParseErrors(input_api, output_api):
     results = input_api.canned_checks.RunUnitTestsInDirectory(
         input_api, output_api, '.', whitelist=[r'^PRESUBMIT_test\.py$'])
 
+  actions = {
+    '.idl': _GetIDLParseError,
+    '.json': _GetJSONParseError,
+  }
+
+  def get_action(affected_file):
+    filename = affected_file.LocalPath()
+    return actions.get(input_api.os_path.splitext(filename)[1])
+
   for affected_file in input_api.AffectedFiles(
-      file_filter=lambda f: f.LocalPath().endswith('.json'),
+      file_filter=
+          lambda f: "test_presubmit" not in f.LocalPath() and get_action(f),
       include_deletes=False):
-    filename = affected_file.AbsoluteLocalPath()
-    contents = input_api.ReadFile(filename)
-    parse_error = _GetJSONParseError(input_api, contents)
+    parse_error = get_action(affected_file)(input_api,
+                                            affected_file.AbsoluteLocalPath())
     if parse_error:
-      results.append(output_api.PresubmitError(
-          'Features file %s could not be parsed: %s' %
+      results.append(output_api.PresubmitError('%s could not be parsed: %s' %
           (affected_file.LocalPath(), parse_error)))
-    # TODO(yoz): Also ensure IDL files are parseable.
   return results
 
 

chrome/common/extensions/api/PRESUBMIT_test.py

@@ -3,6 +3,7 @@
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
+import glob
 import json
 import os
 import subprocess
@@ -22,40 +23,59 @@ class MockInputApi(object):
   def PresubmitLocalPath(self):
     return os.path.dirname(__file__)
 
+  def ReadFile(self, filename, mode='rU'):
+    with open(filename, mode=mode) as f:
+      return f.read()
+
 
 class JSONParsingTest(unittest.TestCase):
   def testSuccess(self):
     input_api = MockInputApi()
-    input_json = '''
-// This is a comment.
-{
-  "key1": ["value1", "value2"],
-  "key2": 3  // This is an inline comment.
-}
-'''
+    filename = 'test_presubmit/valid_json.json'
+    self.assertEqual(None,
+                     PRESUBMIT._GetJSONParseError(input_api, filename))
+
+  def testFailure(self):
+    input_api = MockInputApi()
+    expected_errors = [
+      'Expecting property name: line 8 column 3 (char 9)',
+      'Invalid control character at: line 8 column 19 (char 25)',
+      'Expecting property name: line 8 column 23 (char 29)',
+      'Expecting , delimiter: line 8 column 12 (char 18)',
+    ]
+    actual_errors = [
+      str(PRESUBMIT._GetJSONParseError(input_api, filename))
+      for filename in sorted(glob.glob('test_presubmit/invalid_*.json'))
+    ]
+    self.assertEqual(expected_errors, actual_errors)
+
+
+class IDLParsingTest(unittest.TestCase):
+  def testSuccess(self):
+    input_api = MockInputApi()
+    filename = 'test_presubmit/valid_idl_basics.idl'
     self.assertEqual(None,
-                     PRESUBMIT._GetJSONParseError(input_api, input_json))
+                     PRESUBMIT._GetIDLParseError(input_api, filename))
 
   def testFailure(self):
     input_api = MockInputApi()
-    input_json = '{ x }'
-    self.assertEqual('Expecting property name: line 1 column 2 (char 2)',
-                     str(PRESUBMIT._GetJSONParseError(input_api, input_json)))
-
-    input_json = '{ "hello": "world }'
-    self.assertEqual(
-        'Unterminated string starting at: line 1 column 11 (char 11)',
-        str(PRESUBMIT._GetJSONParseError(input_api, input_json)))
-
-    input_json = '{ "a": "b", "c": "d", }'
-    self.assertEqual(
-        'Expecting property name: line 1 column 22 (char 22)',
-        str(PRESUBMIT._GetJSONParseError(input_api, input_json)))
-
-    input_json = '{ "a": "b" "c": "d" }'
-    self.assertEqual(
-        'Expecting , delimiter: line 1 column 11 (char 11)',
-        str(PRESUBMIT._GetJSONParseError(input_api, input_json)))
+    expected_errors = [
+      'Unexpected "{" after keyword "dictionary".',
+      'Unexpected symbol DOMString after symbol a.',
+      'Unexpected symbol name2 after symbol name1.',
+      'Trailing comma in block.',
+      'Unexpected ";" after "(".',
+      'Unexpected ")" after symbol long.',
+      'Unexpected symbol Events after symbol interace.',
+      'Did not process Interface Interface(NotEvent)',
+      'Interface missing name.',
+    ]
+    actual_errors = [
+      PRESUBMIT._GetIDLParseError(input_api, filename)
+      for filename in sorted(glob.glob('test_presubmit/invalid_*.idl'))
+    ]
+    for (expected_error, actual_error) in zip(expected_errors, actual_errors):
+      self.assertTrue(expected_error in actual_error)
 
 
 if __name__ == "__main__":

chrome/common/extensions/api/test_presubmit/invalid_idl_1.idl

+// Copyright 2013 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.
+
+// Tests an invalid IDL file.
+
+namespace test {
+  // Unexpected "{" after keyword "dictionary".
+  dictionary {
+    DOMString s;
+  };
+};

chrome/common/extensions/api/test_presubmit/invalid_idl_2.idl

+// Copyright 2013 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.
+
+// Tests an invalid IDL file.
+
+namespace test {
+  // Unexpected symbol DOMString after symbol a.
+  dictionary MissingSemicolon {
+    DOMString a
+    DOMString b;
+  };
+};

chrome/common/extensions/api/test_presubmit/invalid_idl_3.idl

+// Copyright 2013 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.
+
+// Tests an invalid IDL file.
+
+namespace test {
+  // Unexpected symbol name2 after symbol name1.
+  enum MissingComma {
+    name1
+    name2
+  };
+};

chrome/common/extensions/api/test_presubmit/invalid_idl_4.idl

+// Copyright 2013 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.
+
+// Tests an invalid IDL file.
+
+namespace test {
+  // Trailing comma in block.
+  enum TrailingComma {
+    name1,
+    name2,
+  };
+};

chrome/common/extensions/api/test_presubmit/invalid_idl_5.idl

+// Copyright 2013 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.
+
+// Tests an invalid IDL file.
+
+namespace test {
+  // Unexpected ";" after "(".
+  callback Callback1 = void(;
+};

chrome/common/extensions/api/test_presubmit/invalid_idl_6.idl

+// Copyright 2013 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.
+
+// Tests an invalid IDL file.
+
+namespace test {
+  // Unexpected ")" after symbol long.
+  callback Callback1 = void(long );
+};

chrome/common/extensions/api/test_presubmit/invalid_idl_7.idl

+// Copyright 2013 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.
+
+// Tests an invalid IDL file.
+
+namespace test {
+  // Unexpected symbol Events after symbol interace.
+  interace Events {
+    static void onFoo1();
+  };
+};

chrome/common/extensions/api/test_presubmit/invalid_idl_8.idl

+// Copyright 2013 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.
+
+// Tests an invalid IDL file.
+
+namespace test {
+  // Did not process Interface Interface(NotEvent).
+  interface NotEvent {
+    static void onFoo1();
+  };
+};

chrome/common/extensions/api/test_presubmit/invalid_idl_9.idl

+// Copyright 2013 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.
+
+// Tests an invalid IDL file.
+
+namespace test {
+  // Interface missing name.
+  interface {
+    static void function1();
+  };
+};

chrome/common/extensions/api/test_presubmit/invalid_json_1.json

+// Copyright 2013 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.
+
+// Tests an invalid JSON file.
+
+// Expecting property name: line 8 column 3 (char 9).
+{ x }

chrome/common/extensions/api/test_presubmit/invalid_json_2.json

+// Copyright 2013 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.
+
+// Tests an invalid JSON file.
+
+// Invalid control character at: line 8 column 19 (char 25).
+{ "hello": "world }

chrome/common/extensions/api/test_presubmit/invalid_json_3.json

+// Copyright 2013 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.
+
+// Tests an invalid JSON file.
+
+// Expecting property name: line 8 column 23 (char 29).
+{ "a": "b", "c": "d", }

chrome/common/extensions/api/test_presubmit/invalid_json_4.json

+// Copyright 2013 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.
+
+// Tests an invalid JSON file.
+
+// Expecting , delimiter: line 8 column 12 (char 18).
+{ "a": "b" "c": "d" }

chrome/common/extensions/api/test_presubmit/valid_idl_basics.idl

+// Copyright 2013 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.
+
+// Tests a valid IDL file.
+
+namespace idl_basics {
+  enum EnumType {
+    name1,
+    name2
+  };
+
+  dictionary MyType1 {
+    DOMString a;
+  };
+
+  callback Callback1 = void();
+  callback Callback2 = void(long x);
+  callback Callback3 = void(MyType1 arg);
+  callback Callback4 = void(EnumType type);
+
+  interface Functions {
+    static void function1();
+    static void function2(long x);
+    static void function3(MyType1 arg);
+    static void function4(Callback1 cb);
+    static void function5(Callback2 cb);
+    static void function6(Callback3 cb);
+    static void function7(Callback4 cb);
+  };
+
+  interface Events {
+    static void onFoo1();
+    static void onFoo2(long x);
+    static void onFoo2(MyType1 arg);
+    static void onFoo3(EnumType type);
+  };
+};

chrome/common/extensions/api/test_presubmit/valid_json.json

+// Copyright 2013 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.
+
+// Tests a valid IDL file.
+
+// This is a comment.
+{
+  "key1": ["value1", "value2"],
+  "key2": 3  // This is an inline comment.
+}