PRESUBMIT_test.py 7.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163
  1. #!/usr/bin/env python
  2. # Copyright 2017 The Chromium Authors
  3. # Use of this source code is governed by a BSD-style license that can be
  4. # found in the LICENSE file.
  5. import os
  6. import sys
  7. import unittest
  8. import PRESUBMIT
  9. sys.path.append(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
  10. import PRESUBMIT_test_mocks
  11. class CheckARCCompilationGuardTest(unittest.TestCase):
  12. """Test the _CheckARCCompilationGuard presubmit check."""
  13. def testGoodImplementationFiles(self):
  14. """Test that .m and .mm files with a guard don't raise any errors."""
  15. lines = ["foobar"] + PRESUBMIT.ARC_COMPILE_GUARD
  16. mock_input = PRESUBMIT_test_mocks.MockInputApi()
  17. mock_input.files = [
  18. PRESUBMIT_test_mocks.MockFile('ios/path/foo_controller.mm', lines),
  19. PRESUBMIT_test_mocks.MockFile('ios/path/foo_controller.m', lines),
  20. ]
  21. mock_output = PRESUBMIT_test_mocks.MockOutputApi()
  22. errors = PRESUBMIT._CheckARCCompilationGuard(mock_input, mock_output)
  23. self.assertEqual(len(errors), 0)
  24. def testBadImplementationFiles(self):
  25. """Test that .m and .mm files without a guard raise an error."""
  26. lines = ["foobar"]
  27. mock_input = PRESUBMIT_test_mocks.MockInputApi()
  28. mock_input.files = [
  29. PRESUBMIT_test_mocks.MockFile('ios/path/foo_controller.mm', lines),
  30. PRESUBMIT_test_mocks.MockFile('ios/path/foo_controller.m', lines),
  31. ]
  32. mock_output = PRESUBMIT_test_mocks.MockOutputApi()
  33. errors = PRESUBMIT._CheckARCCompilationGuard(mock_input, mock_output)
  34. self.assertEqual(len(errors), 1)
  35. self.assertEqual('error', errors[0].type)
  36. self.assertTrue('ios/path/foo_controller.m' in errors[0].message)
  37. self.assertTrue('ios/path/foo_controller.mm' in errors[0].message)
  38. def testOtherFiles(self):
  39. """Test that other files without a guard don't raise errors."""
  40. lines = ["foobar"]
  41. mock_input = PRESUBMIT_test_mocks.MockInputApi()
  42. mock_input.files = [
  43. PRESUBMIT_test_mocks.MockFile('ios/path/foo_controller.h', lines),
  44. PRESUBMIT_test_mocks.MockFile('ios/path/foo_controller.cc', lines),
  45. PRESUBMIT_test_mocks.MockFile('ios/path/BUILD.gn', lines),
  46. ]
  47. mock_output = PRESUBMIT_test_mocks.MockOutputApi()
  48. errors = PRESUBMIT._CheckARCCompilationGuard(mock_input, mock_output)
  49. self.assertEqual(len(errors), 0)
  50. class CheckTODOFormatTest(unittest.TestCase):
  51. """Test the _CheckBugInToDo presubmit check."""
  52. def testTODOs(self):
  53. bad_lines = [
  54. 'TO'
  55. 'DO(ldap): fix this', 'TO'
  56. 'DO(ladp): see crbug.com/8675309', 'TO'
  57. 'DO(8675309): fix this', 'TO'
  58. 'DO(http://crbug.com/8675309): fix this', 'TO'
  59. 'DO( crbug.com/8675309): fix this', 'TO'
  60. 'DO(crbug/8675309): fix this', 'TO'
  61. 'DO(crbug.com): fix this'
  62. ]
  63. good_lines = [
  64. 'TO'
  65. 'DO(crbug.com/8675309): fix this', 'TO'
  66. 'DO(crbug.com/8675309): fix this (please)'
  67. ]
  68. mock_input = PRESUBMIT_test_mocks.MockInputApi()
  69. mock_input.files = [
  70. PRESUBMIT_test_mocks.MockFile('ios/path/foo_controller.mm',
  71. bad_lines + good_lines)
  72. ]
  73. mock_output = PRESUBMIT_test_mocks.MockOutputApi()
  74. errors = PRESUBMIT._CheckBugInToDo(mock_input, mock_output)
  75. self.assertEqual(len(errors), 1)
  76. self.assertEqual('error', errors[0].type)
  77. self.assertTrue('without bug numbers' in errors[0].message)
  78. error_lines = errors[0].message.split('\n')
  79. self.assertEqual(len(error_lines), len(bad_lines) + 2)
  80. class CheckHasNoIncludeDirectivesTest(unittest.TestCase):
  81. """Test the _CheckHasNoIncludeDirectives presubmit check."""
  82. def testFindsIncludeDirectives(self):
  83. good_lines = [
  84. '#import <system>', '#import "my/path/my/header.h"',
  85. '#import "my/path/my/source.mm"', '#import "my/path/my/source.m"'
  86. ]
  87. bad_lines = [
  88. '#include <system>', '#import <system>',
  89. '#include "my/path/my/header.h"',
  90. '#include "my/path/my/source.mm"', '#import "my/path/my/header.h"'
  91. '#include "my/path/my/source.m"'
  92. ]
  93. mock_input = PRESUBMIT_test_mocks.MockInputApi()
  94. mock_input.files = [
  95. PRESUBMIT_test_mocks.MockFile('ios/path/foo_controller.mm',
  96. bad_lines),
  97. PRESUBMIT_test_mocks.MockFile('ios/path/foo_controller_2.mm',
  98. good_lines),
  99. PRESUBMIT_test_mocks.MockFile('ios/path/bar_controller.h',
  100. bad_lines),
  101. PRESUBMIT_test_mocks.MockFile('ios/path/bar_controller.m',
  102. bad_lines),
  103. PRESUBMIT_test_mocks.MockFile('ios/path/bar_controller.cc',
  104. bad_lines),
  105. PRESUBMIT_test_mocks.MockFile('chrome/path/foo_controller.mm',
  106. bad_lines),
  107. ]
  108. mock_output = PRESUBMIT_test_mocks.MockOutputApi()
  109. errors = PRESUBMIT._CheckHasNoIncludeDirectives(
  110. mock_input, mock_output)
  111. self.assertEqual(len(errors), 1)
  112. self.assertEqual('error', errors[0].type)
  113. self.assertTrue('ios/path/foo_controller.mm:1' in errors[0].message)
  114. self.assertTrue('ios/path/foo_controller.mm:3' in errors[0].message)
  115. self.assertTrue('ios/path/foo_controller.mm:4' in errors[0].message)
  116. class CheckHasNoPipeInCommentTest(unittest.TestCase):
  117. """Test the _CheckHasNoPipeInComment presubmit check."""
  118. def testFindsIncludeDirectives(self):
  119. good_lines = [
  120. '#if !defined(__has_feature) || !__has_feature(objc_arc)',
  121. '// This does A || B', '// `MySymbol` is correct',
  122. 'bitVariable1 | bitVariable2'
  123. ]
  124. bad_lines = [
  125. '// |MySymbol| is wrong', '// What is wrong is: |MySymbol|'
  126. ]
  127. mock_input = PRESUBMIT_test_mocks.MockInputApi()
  128. mock_input.files = [
  129. PRESUBMIT_test_mocks.MockFile('ios/path/foo_controller.mm',
  130. good_lines + bad_lines),
  131. PRESUBMIT_test_mocks.MockFile('ios/path/foo_controller.h',
  132. bad_lines + good_lines),
  133. ]
  134. mock_output = PRESUBMIT_test_mocks.MockOutputApi()
  135. errors = PRESUBMIT._CheckHasNoPipeInComment(mock_input, mock_output)
  136. self.assertEqual(len(errors), 1)
  137. self.assertEqual('warning', errors[0].type)
  138. self.assertTrue('ios/path/foo_controller.mm:5' in errors[0].message)
  139. self.assertTrue('ios/path/foo_controller.mm:6' in errors[0].message)
  140. self.assertTrue('ios/path/foo_controller.h:1' in errors[0].message)
  141. self.assertTrue('ios/path/foo_controller.h:2' in errors[0].message)
  142. error_lines = errors[0].message.split('\n')
  143. self.assertEqual(len(error_lines), len(bad_lines) * 2 + 3)
  144. if __name__ == '__main__':
  145. unittest.main()