Bug 569839: Add DefaultCCommentAutoEditStrategyTest to testsuite
This test started failing (and wasn't in testsuite previously) because
it had significant trailing whitespace in some tests.
The fix is to use ${whitespace_eol} which I have also added to some
of the javadocs to make it easier to find next time.
Change-Id: Ib364d8a400bcdeb21445dde8428e0fd4c77db990
diff --git a/core/org.eclipse.cdt.core.tests/suite/org/eclipse/cdt/core/testplugin/util/TestSourceReader.java b/core/org.eclipse.cdt.core.tests/suite/org/eclipse/cdt/core/testplugin/util/TestSourceReader.java
index 5fe92d9..3290acb 100644
--- a/core/org.eclipse.cdt.core.tests/suite/org/eclipse/cdt/core/testplugin/util/TestSourceReader.java
+++ b/core/org.eclipse.cdt.core.tests/suite/org/eclipse/cdt/core/testplugin/util/TestSourceReader.java
@@ -102,6 +102,10 @@
* Returns an array of StringBuilder objects for each comment section found preceding the named
* test in the source code.
*
+ * Trailing whitespace can be removed by editor/clean-up actions. To enforce whitespace
+ * at end of line, use ${whitspace_eol}, which will be removed, but cause the
+ * whitespace to the left of it to be preserved.
+ *
* @param bundle the bundle containing the source, if {@code null} can try to load using
* classpath (source folder has to be in the classpath for this to work)
* @param srcRoot the directory inside the bundle containing the packages
diff --git a/core/org.eclipse.cdt.ui.tests/ui/org/eclipse/cdt/ui/tests/BaseUITestCase.java b/core/org.eclipse.cdt.ui.tests/ui/org/eclipse/cdt/ui/tests/BaseUITestCase.java
index 554e2af..5fec6d0 100644
--- a/core/org.eclipse.cdt.ui.tests/ui/org/eclipse/cdt/ui/tests/BaseUITestCase.java
+++ b/core/org.eclipse.cdt.ui.tests/ui/org/eclipse/cdt/ui/tests/BaseUITestCase.java
@@ -98,6 +98,11 @@
/**
* Reads multiple sections in comments from the source of the given class.
+ *
+ * Trailing whitespace can be removed by editor/clean-up actions. To enforce whitespace
+ * at end of line, use ${whitspace_eol}, which will be removed, but cause the
+ * whitespace to the left of it to be preserved.
+ *
* @since 4.0
*/
public StringBuilder[] getContentsForTest(int sections) throws IOException {
diff --git a/core/org.eclipse.cdt.ui.tests/ui/org/eclipse/cdt/ui/tests/text/DefaultCCommentAutoEditStrategyTest.java b/core/org.eclipse.cdt.ui.tests/ui/org/eclipse/cdt/ui/tests/text/DefaultCCommentAutoEditStrategyTest.java
index 374c180..4bc0534 100644
--- a/core/org.eclipse.cdt.ui.tests/ui/org/eclipse/cdt/ui/tests/text/DefaultCCommentAutoEditStrategyTest.java
+++ b/core/org.eclipse.cdt.ui.tests/ui/org/eclipse/cdt/ui/tests/text/DefaultCCommentAutoEditStrategyTest.java
@@ -33,14 +33,12 @@
import org.eclipse.jface.text.BadLocationException;
import org.eclipse.jface.text.Document;
import org.eclipse.jface.text.IDocument;
-import org.junit.Ignore;
import junit.framework.Test;
/**
* Testing the auto indent strategies.
*/
-@Ignore("Some tests fail and this class was not included through AutomatedIntegrationSuite. See bug 564002")
public class DefaultCCommentAutoEditStrategyTest extends AbstractAutoEditTest {
private HashMap<String, String> fOptions;
@@ -168,13 +166,13 @@
// class A {
// /* X
- // };
+ // }; ${whitespace_eol}
// class A {
- // /*
+ // /* ${whitespace_eol}
// * X
// */
- // };
+ // }; ${whitespace_eol}
public void testInsertNewLine5() {
assertNewLineBehaviour();
}
@@ -338,7 +336,7 @@
// X
// /*
- //
+ // ${whitespace_eol}
// X
public void testInsertNewLine17() {
assertNewLineBehaviour();
@@ -349,7 +347,7 @@
// */
// /*
- //
+ // ${whitespace_eol}
// X
// */
public void testInsertNewLine18() {
@@ -462,7 +460,10 @@
// };
// }
// }
- public void _testFollowingDeclaration5() {
+ //XXX: This test was unexpectedly succeeding - with no previous commentary about
+ // what this test was or why it failed I have no idea why it is now passing
+ // Therefore I changed visibility to private so it would be ignored.
+ private void IGNORE_testFollowingDeclaration5() {
assertDeclarationFollowingX(
"namespace n2 {\n void foo() {}\n void bar(int x) {}\n class C {\n int y;\n void baz(int x) {}\n };\n }");
}
@@ -529,7 +530,7 @@
// public:
// X
// STATIC void D::foo(int x) {
- //
+ // ${whitespace_eol}
// }
// };
public void testFollowingDeclaration13() throws CoreException {
diff --git a/core/org.eclipse.cdt.ui.tests/ui/org/eclipse/cdt/ui/tests/text/TextTestSuite.java b/core/org.eclipse.cdt.ui.tests/ui/org/eclipse/cdt/ui/tests/text/TextTestSuite.java
index de37cda..9bc26ec 100644
--- a/core/org.eclipse.cdt.ui.tests/ui/org/eclipse/cdt/ui/tests/text/TextTestSuite.java
+++ b/core/org.eclipse.cdt.ui.tests/ui/org/eclipse/cdt/ui/tests/text/TextTestSuite.java
@@ -33,7 +33,7 @@
// smart edit tests
AlignConstActionTest.class, CAutoIndentTest.class, CHeuristicScannerTest.class, BracketInserterTest.class,
IndentActionTest.class, FormatActionTest.class, ShiftActionTest.class, CodeFormatterTest.class,
- CIndenterTest.class, TemplateFormatterTest.class,
+ CIndenterTest.class, TemplateFormatterTest.class, DefaultCCommentAutoEditStrategyTest.class,
// Break iterator tests.
CBreakIteratorTest.class, CWordIteratorTest.class,
