Enforced new rules for braces in conditional and loop bodies in style checker.

Tools/Scripts/webkitpy/style/checkers/cpp_unittest.py

 # -*- coding: utf-8; -*-
 #
 # Copyright (C) 2011 Google Inc. All rights reserved.
 # Copyright (C) 2009 Torch Mobile Inc.
 # Copyright (C) 2009 Apple Inc. All rights reserved.
 # Copyright (C) 2010 Chris Jerdonek (cjerdonek@webkit.org)
 #
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are
 # met:
@@ skipping 2048 matching lines @@
             'public:\n'
             '    enum Bar {\n'
             '        Alpha,\n'
             '        Beta,\n'
             '#if ENABLED_BETZ\n'
             '        Charlie,\n'
             '#endif\n'
             '    };\n'
             '};',
             '')
+        self.assert_multi_line_lint(
+            'if (true) {\n'
+            '    myFunction(reallyLongParam1, reallyLongParam2,\n'
+            '               reallyLongParam3);\n'
+            '}\n',
+            'Weird number of spaces at line-start.  Are you using a 4-space indent?  [whitespace/indent] [3]')
+
+        self.assert_multi_line_lint(
+            'if (true) {\n'
+            '    myFunction(reallyLongParam1, reallyLongParam2,\n'
+            '            reallyLongParam3);\n'
+            '}\n',
+            'When wrapping a line, only indent 4 spaces.  [whitespace/indent] [3]')
+
 
     def test_not_alabel(self):
         self.assert_lint('MyVeryLongNamespace::MyVeryLongClassName::', '')
 
     def test_tab(self):
         self.assert_lint('\tint a;',
                          'Tab found; better to use spaces  [whitespace/tab] [1]')
         self.assert_lint('int a = 5;\t// set a to 5',
                          'Tab found; better to use spaces  [whitespace/tab] [1]')
 
@@ skipping 1921 matching lines @@
             '    doSomethingElseAgain();\n'
             '}\n',
             '')
         self.assert_multi_line_lint(
             'if (condition)\n'
             '    doSomething();\n'
             'else\n'
             '    doSomethingElse();\n',
             '')
         self.assert_multi_line_lint(
-            'if (condition)\n'
+            'if (condition) {\n'
             '    doSomething();\n'
-            'else {\n'
+            '} else {\n'
             '    doSomethingElse();\n'
             '    doSomethingElseAgain();\n'
             '}\n',
             '')
         self.assert_multi_line_lint(
             '#define TEST_ASSERT(expression) do { if (!(expression)) { TestsController::shared().testFailed(__FILE__, __LINE__, #expression); return; } } while (0)\n',
             '')
         self.assert_multi_line_lint(
             '#define TEST_ASSERT(expression) do { if ( !(expression)) { TestsController::shared().testFailed(__FILE__, __LINE__, #expression); return; } } while (0)\n',
             'Extra space after ( in if  [whitespace/parens] [5]')
@@ skipping 17 matching lines @@
         self.assert_multi_line_lint(
             'if (condition) doSomething(); else doSomethingElse();\n',
             ['More than one command on the same line  [whitespace/newline] [4]',
              'Else clause should never be on same line as else (use 2 lines)  [whitespace/newline] [4]',
              'More than one command on the same line in if  [whitespace/parens] [4]'])
         self.assert_multi_line_lint(
             'if (condition) doSomething(); else {\n'
             '    doSomethingElse();\n'
             '}\n',
             ['More than one command on the same line in if  [whitespace/parens] [4]',
-             'One line control clauses should not use braces.  [whitespace/braces] [4]'])
-        self.assert_multi_line_lint(
-            'if (condition)\n'
-            '    doSomething();\n'
-            'else {\n'
-            '    doSomethingElse();\n'
-            '}\n',
-            'One line control clauses should not use braces.  [whitespace/braces] [4]')
-        self.assert_multi_line_lint(
-            'if (condition) {\n'
-            '    doSomething1();\n'
-            '    doSomething2();\n'
-            '} else {\n'
-            '    doSomethingElse();\n'
-            '}\n',
-            'One line control clauses should not use braces.  [whitespace/braces] [4]')
+             'If one part of an if-else statement uses curly braces, the other part must too.  [whitespace/braces] [4]'])
         self.assert_multi_line_lint(
             'void func()\n'
             '{\n'
             '    while (condition) { }\n'
             '    return 0;\n'
             '}\n',
             '')
         self.assert_multi_line_lint(
             'void func()\n'
             '{\n'
             '    for (i = 0; i < 42; i++) { foobar(); }\n'
             '    return 0;\n'
             '}\n',
             'More than one command on the same line in for  [whitespace/parens] [4]')
 
         # 3. An else if statement should be written as an if statement
         #    when the prior if concludes with a return statement.
         self.assert_multi_line_lint(
             'if (motivated) {\n'
             '    if (liquid)\n'
             '        return money;\n'
-            '} else if (tired)\n'
-            '    break;\n',
+            '} else if (tired) {\n'
+            '    break;\n'
+            '}',
             '')
         self.assert_multi_line_lint(
             'if (condition)\n'
             '    doSomething();\n'
             'else if (otherCondition)\n'
             '    doSomethingElse();\n',
             '')
         self.assert_multi_line_lint(
             'if (condition)\n'
             '    doSomething();\n'
@@ skipping 32 matching lines @@
             '}\n',
             'An else if statement should be written as an if statement when the '
             'prior "if" concludes with a return, break, continue or goto statement.'
             '  [readability/control_flow] [4]')
         self.assert_multi_line_lint(
             '    if (stupid) {\n'
             'infiniteLoop:\n'
             '        goto infiniteLoop;\n'
             '    } else if (evil)\n'
             '        goto hell;\n',
-            'An else if statement should be written as an if statement when the '
-            'prior "if" concludes with a return, break, continue or goto statement.'
-            '  [readability/control_flow] [4]')
+            ['If one part of an if-else statement uses curly braces, the other part must too.  [whitespace/braces] [4]',
+             'An else if statement should be written as an if statement when the '
+             'prior "if" concludes with a return, break, continue or goto statement.'
+             '  [readability/control_flow] [4]'])
         self.assert_multi_line_lint(
             'if (liquid)\n'
             '{\n'
             '    prepare();\n'
             '    return money;\n'
             '}\n'
             'else if (greedy)\n'
             '    keep();\n',
-            ['This { should be at the end of the previous line  [whitespace/braces] [4]',
-            'An else should appear on the same line as the preceding }  [whitespace/newline] [4]',
-            'An else if statement should be written as an if statement when the '
-            'prior "if" concludes with a return, break, continue or goto statement.'
-            '  [readability/control_flow] [4]'])
+            ['If one part of an if-else statement uses curly braces, the other part must too.  [whitespace/braces] [4]',
+             'This { should be at the end of the previous line  [whitespace/braces] [4]',
+             'An else should appear on the same line as the preceding }  [whitespace/newline] [4]',
+             'An else if statement should be written as an if statement when the '
+             'prior "if" concludes with a return, break, continue or goto statement.'
+             '  [readability/control_flow] [4]'])
         self.assert_multi_line_lint(
             'if (gone)\n'
             '    return;\n'
             'else if (here)\n'
             '    go();\n',
             'An else if statement should be written as an if statement when the '
             'prior "if" concludes with a return, break, continue or goto statement.'
             '  [readability/control_flow] [4]')
         self.assert_multi_line_lint(
             'if (gone)\n'
@@ skipping 14 matching lines @@
             'An else statement can be removed when the prior "if" concludes '
             'with a return, break, continue or goto statement.'
             '  [readability/control_flow] [4]')
         self.assert_multi_line_lint(
             'if (tired)\n'
             '    break;\n'
             'else {\n'
             '    prepare();\n'
             '    continue;\n'
             '}\n',
-            'An else statement can be removed when the prior "if" concludes '
-            'with a return, break, continue or goto statement.'
-            '  [readability/control_flow] [4]')
+            ['If one part of an if-else statement uses curly braces, the other part must too.  [whitespace/braces] [4]',
+             'An else statement can be removed when the prior "if" concludes '
+             'with a return, break, continue or goto statement.'
+             '  [readability/control_flow] [4]'])
 
     def test_braces(self):
         # 1. Function definitions: place each brace on its own line.
         self.assert_multi_line_lint(
             'int main()\n'
             '{\n'
             '    doSomething();\n'
             '}\n',
             '')
         self.assert_multi_line_lint(
@@ skipping 79 matching lines @@
             'case foo: return;\n'
             '}\n',
             'This { should be at the end of the previous line  [whitespace/braces] [4]')
         self.assert_multi_line_lint(
             'else if (type)\n'
             '{\n'
             'case foo: return;\n'
             '}\n',
             'This { should be at the end of the previous line  [whitespace/braces] [4]')
 
-        # 3. One-line control clauses should not use braces unless
-        #    comments are included or a single statement spans multiple
-        #    lines.
-        self.assert_multi_line_lint(
-            'if (true) {\n'
-            '    int foo;\n'
-            '}\n',
-            'One line control clauses should not use braces.  [whitespace/braces] [4]')
+        # 3. Curly braces are not required for single-line conditionals and
+        #    loop bodies, but are required for single-statement bodies that
+        #    span multiple lines.
+
+        #
+        # Positive tests
+        #
+        self.assert_multi_line_lint(
+            'if (condition1)\n'
+            '    statement1();\n'
+            'else\n'
+            '    statement2();\n',
+            '')
+
+        self.assert_multi_line_lint(
+            'if (condition1)\n'
+            '    statement1();\n'
+            'else if (condition2)\n'
+            '    statement2();\n',
+            '')
+
+        self.assert_multi_line_lint(
+            'if (condition1)\n'
+            '    statement1();\n'
+            'else if (condition2)\n'
+            '    statement2();\n'
+            'else\n'
+            '    statement3();\n',
+            '')
+
+        self.assert_multi_line_lint(
+            'for (; foo; bar)\n'
+            '    int foo;\n',
+            '')
 
         self.assert_multi_line_lint(
             'for (; foo; bar) {\n'
             '    int foo;\n'
             '}\n',
-            'One line control clauses should not use braces.  [whitespace/braces] [4]')
+            '')
 
         self.assert_multi_line_lint(
             'foreach (foo, foos) {\n'
             '    int bar;\n'
             '}\n',
-            'One line control clauses should not use braces.  [whitespace/braces] [4]')
+            '')
+
+        self.assert_multi_line_lint(
+            'foreach (foo, foos)\n'
+            '    int bar;\n',
+            '')
 
         self.assert_multi_line_lint(
             'while (true) {\n'
             '    int foo;\n'
             '}\n',
-            'One line control clauses should not use braces.  [whitespace/braces] [4]')
-
-        self.assert_multi_line_lint(
-            'if (true)\n'
+            '')
+
+        self.assert_multi_line_lint(
+            'while (true)\n'
+            '    int foo;\n',
+            '')
+
+        self.assert_multi_line_lint(
+            'if (condition1) {\n'
+            '    statement1();\n'
+            '} else {\n'
+            '    statement2();\n'
+            '}\n',
+            '')
+
+        self.assert_multi_line_lint(
+            'if (condition1) {\n'
+            '    statement1();\n'
+            '} else if (condition2) {\n'
+            '    statement2();\n'
+            '}\n',
+            '')
+
+        self.assert_multi_line_lint(
+            'if (condition1) {\n'
+            '    statement1();\n'
+            '} else if (condition2) {\n'
+            '    statement2();\n'
+            '} else {\n'
+            '    statement3();\n'
+            '}\n',
+            '')
+
+        self.assert_multi_line_lint(
+            'if (condition1) {\n'
+            '    statement1();\n'
+            '    statement1_2();\n'
+            '} else if (condition2) {\n'
+            '    statement2();\n'
+            '    statement2_2();\n'
+            '}\n',
+            '')
+
+        self.assert_multi_line_lint(
+            'if (condition1) {\n'
+            '    statement1();\n'
+            '    statement1_2();\n'
+            '} else if (condition2) {\n'
+            '    statement2();\n'
+            '    statement2_2();\n'
+            '} else {\n'
+            '    statement3();\n'
+            '    statement3_2();\n'
+            '}\n',
+            '')
+
+        #
+        # Negative tests
+        #
+
+        self.assert_multi_line_lint(
+            'if (condition)\n'
+            '    doSomething(\n'
+            '        spanningMultipleLines);\n',
+            'A conditional or loop body must use braces if the statement is more than one line long.  [whitespace/braces] [4]')
+
+        self.assert_multi_line_lint(
+            'if (condition)\n'
+            '    // Single-line comment\n'
+            '    doSomething();\n',
+            'A conditional or loop body must use braces if the statement is more than one line long.  [whitespace/braces] [4]')
+
+        self.assert_multi_line_lint(
+            'if (condition1)\n'
+            '    statement1();\n'
+            'else if (condition2)\n'
+            '    // Single-line comment\n'
+            '    statement2();\n',
+            'A conditional or loop body must use braces if the statement is more than one line long.  [whitespace/braces] [4]')
+
+        self.assert_multi_line_lint(
+            'if (condition1)\n'
+            '    statement1();\n'
+            'else if (condition2)\n'
+            '    statement2();\n'
+            'else\n'
+            '    // Single-line comment\n'
+            '    statement3();\n',
+            'A conditional or loop body must use braces if the statement is more than one line long.  [whitespace/braces] [4]')
+
+        self.assert_multi_line_lint(
+            'for (; foo; bar)\n'
+            '    // Single-line comment\n'
+            '    int foo;\n',
+            'A conditional or loop body must use braces if the statement is more than one line long.  [whitespace/braces] [4]')
+
+        self.assert_multi_line_lint(
+            'foreach (foo, foos)\n'
+            '    // Single-line comment\n'
+            '    int bar;\n',
+            'A conditional or loop body must use braces if the statement is more than one line long.  [whitespace/braces] [4]')
+
+        self.assert_multi_line_lint(
+            'while (true)\n'
+            '    // Single-line comment\n'
             '    int foo;\n'
+            '\n',
+            'A conditional or loop body must use braces if the statement is more than one line long.  [whitespace/braces] [4]')
+
+        # 4. If one part of an if-else statement uses curly braces, the
+        #    other part must too.
+
+        self.assert_multi_line_lint(
+            'if (condition1) {\n'
+            '    doSomething1();\n'
+            '    doSomething1_2();\n'
+            '} else if (condition2)\n'
+            '    doSomething2();\n'
+            'else\n'
+            '    doSomething3();\n',
+            'If one part of an if-else statement uses curly braces, the other part must too.  [whitespace/braces] [4]')
+
+        self.assert_multi_line_lint(
+            'if (condition1)\n'
+            '    doSomething1();\n'
+            'else if (condition2) {\n'
+            '    doSomething2();\n'
+            '    doSomething2_2();\n'
+            '} else\n'
+            '    doSomething3();\n',
+            'If one part of an if-else statement uses curly braces, the other part must too.  [whitespace/braces] [4]')
+
+        self.assert_multi_line_lint(
+            'if (condition1) {\n'
+            '    doSomething1();\n'
+            '} else if (condition2) {\n'
+            '    doSomething2();\n'
+            '    doSomething2_2();\n'
+            '} else\n'
+            '    doSomething3();\n',
+            'If one part of an if-else statement uses curly braces, the other part must too.  [whitespace/braces] [4]')
+
+        self.assert_multi_line_lint(
+            'if (condition1)\n'
+            '    doSomething1();\n'
+            'else if (condition2)\n'
+            '    doSomething2();\n'
             'else {\n'
-            '    int foo;\n'
-            '}\n',
-            'One line control clauses should not use braces.  [whitespace/braces] [4]')
-
-        self.assert_multi_line_lint(
-            'if (true) {\n'
-            '    int foo;\n'
-            '} else\n'
-            '    int foo;\n',
-            'One line control clauses should not use braces.  [whitespace/braces] [4]')
-
-        self.assert_multi_line_lint(
-            'if (true) {\n'
-            '    // Some comment\n'
-            '    int foo;\n'
-            '}\n',
-            '')
-
-        self.assert_multi_line_lint(
-            'if (true) {\n'
-            '    myFunction(reallyLongParam1, reallyLongParam2,\n'
-            '               reallyLongParam3);\n'
-            '}\n',
-            'Weird number of spaces at line-start.  Are you using a 4-space indent?  [whitespace/indent] [3]')
-
-        self.assert_multi_line_lint(
-            'if (true) {\n'
-            '    myFunction(reallyLongParam1, reallyLongParam2,\n'
-            '            reallyLongParam3);\n'
-            '}\n',
-            'When wrapping a line, only indent 4 spaces.  [whitespace/indent] [3]')
-
-        # 4. Control clauses without a body should use empty braces.
+            '    doSomething3();\n'
+            '    doSomething3_2();\n'
+            '}\n',
+            'If one part of an if-else statement uses curly braces, the other part must too.  [whitespace/braces] [4]')
+
+        self.assert_multi_line_lint(
+            'if (condition1) {\n'
+            '    doSomething1();\n'
+            '    doSomething1_2();\n'
+            '} else if (condition2)\n'
+            '    doSomething2();\n'
+            'else {\n'
+            '    doSomething3();\n'
+            '    doSomething3_2();\n'
+            '}\n',
+            'If one part of an if-else statement uses curly braces, the other part must too.  [whitespace/braces] [4]')
+
+        self.assert_multi_line_lint(
+            'if (condition1)\n'
+            '    doSomething1();\n'
+            'else if (condition2) {\n'
+            '    doSomething2();\n'
+            '    doSomething2_2();\n'
+            '} else {\n'
+            '    doSomething3();\n'
+            '    doSomething3_2();\n'
+            '}\n',
+            'If one part of an if-else statement uses curly braces, the other part must too.  [whitespace/braces] [4]')
+
+
+        # 5. Control clauses without a body should use empty braces.
         self.assert_multi_line_lint(
             'for ( ; current; current = current->next) { }\n',
             '')
         self.assert_multi_line_lint(
             'for ( ; current;\n'
             '     current = current->next) { }\n',
             'Weird number of spaces at line-start.  Are you using a 4-space indent?  [whitespace/indent] [3]')
         self.assert_multi_line_lint(
             'for ( ; current; current = current->next);\n',
             'Semicolon defining empty statement for this loop. Use { } instead.  [whitespace/semicolon] [5]')
@@ skipping 597 matching lines @@
     def test_ne(self):
         """Test __ne__ inequality function."""
         checker1 = self._checker()
         checker2 = self._checker()
 
         # != calls __ne__.
         # By default, __ne__ always returns true on different objects.
         # Thus, just check the distinguishing case to verify that the
         # code defines __ne__.
         self.assertFalse(checker1 != checker2)