Suppress IDEA's "malformed declaration" warning for TestCase classes

junit-team · Oct 10, 2024 · 1210901 · 1210901
1 parent 43c8341
commit 1210901
Show file tree

Hide file tree

Showing 89 changed files with 371 additions and 8 deletions.
diff --git a/documentation/src/test/java/example/TempDirectoryDemo.java b/documentation/src/test/java/example/TempDirectoryDemo.java
@@ -63,6 +63,7 @@ void copyFileFromSourceToTarget(@TempDir Path source, @TempDir Path target) thro
 	}
 	// end::user_guide_multiple_directories[]
 
+	@SuppressWarnings("JUnitMalformedDeclaration")
 	static
 	// tag::user_guide_field_injection[]
 	class SharedTempDirectoryDemo {
@@ -87,6 +88,7 @@ void anotherTestThatUsesTheSameTempDir() {
 	}
 	// end::user_guide_field_injection[]
 
+	@SuppressWarnings("JUnitMalformedDeclaration")
 	static
 	// tag::user_guide_cleanup_mode[]
 	class CleanupModeDemo {
@@ -99,6 +101,7 @@ void fileTest(@TempDir(cleanup = ON_SUCCESS) Path tempDir) {
 	}
 	// end::user_guide_cleanup_mode[]
 
+	@SuppressWarnings("JUnitMalformedDeclaration")
 	static
 	// tag::user_guide_factory_name_prefix[]
 	class TempDirFactoryDemo {
@@ -121,6 +124,7 @@ public Path createTempDirectory(AnnotatedElementContext elementContext, Extensio
 	}
 	// end::user_guide_factory_name_prefix[]
 
+	@SuppressWarnings("JUnitMalformedDeclaration")
 	static
 	// tag::user_guide_factory_jimfs[]
 	class InMemoryTempDirDemo {
@@ -158,6 +162,7 @@ public void close() throws IOException {
 	}
 	// end::user_guide_composed_annotation[]
 
+	@SuppressWarnings("JUnitMalformedDeclaration")
 	static
 	// tag::user_guide_composed_annotation_usage[]
 	class JimfsTempDirAnnotationDemo {

diff --git a/...ntage-engine/src/test/java/org/junit/vintage/engine/discovery/VintageDiscovererTests.java b/...ntage-engine/src/test/java/org/junit/vintage/engine/discovery/VintageDiscovererTests.java
@@ -125,6 +125,7 @@ private TestDescriptor discover(EngineDiscoveryRequest request) {
 		return new VintageDiscoverer().discover(request, engineId());
 	}
 
+	@SuppressWarnings("JUnitMalformedDeclaration")
 	public static class Foo {
 
 		@org.junit.Test
@@ -133,6 +134,7 @@ public void test() {
 
 	}
 
+	@SuppressWarnings("JUnitMalformedDeclaration")
 	public static class Bar {
 
 		@org.junit.Test

diff --git a/...xtures/java/org/junit/vintage/engine/samples/junit3/JUnit3ParallelSuiteWithSubsuites.java b/...xtures/java/org/junit/vintage/engine/samples/junit3/JUnit3ParallelSuiteWithSubsuites.java
@@ -14,6 +14,7 @@
 import junit.framework.TestCase;
 import junit.framework.TestSuite;
 
+@SuppressWarnings("JUnitMalformedDeclaration")
 public class JUnit3ParallelSuiteWithSubsuites extends TestCase {
 	private final String arg;
 

diff --git a/...c/testFixtures/java/org/junit/vintage/engine/samples/junit3/JUnit3SuiteWithSubsuites.java b/...c/testFixtures/java/org/junit/vintage/engine/samples/junit3/JUnit3SuiteWithSubsuites.java
@@ -13,6 +13,7 @@
 import junit.framework.TestCase;
 import junit.framework.TestSuite;
 
+@SuppressWarnings("JUnitMalformedDeclaration")
 public class JUnit3SuiteWithSubsuites extends TestCase {
 	private final String arg;
 

diff --git a/...r-tests/src/test/java/org/junit/jupiter/api/DisplayNameGenerationInheritanceTestCase.java b/...r-tests/src/test/java/org/junit/jupiter/api/DisplayNameGenerationInheritanceTestCase.java
@@ -26,6 +26,7 @@ void this_is_a_test() {
 		}
 	}
 
+	@SuppressWarnings("JUnitMalformedDeclaration")
 	static class StaticNestedTestCase {
 
 		@Test

diff --git a/jupiter-tests/src/test/java/org/junit/jupiter/api/DisplayNameGenerationTests.java b/jupiter-tests/src/test/java/org/junit/jupiter/api/DisplayNameGenerationTests.java
@@ -287,6 +287,7 @@ static class UnderscoreStyleInheritedFromSuperClassTestCase extends UnderscoreSt
 
 	// -------------------------------------------------------------------
 
+	@SuppressWarnings("JUnitMalformedDeclaration")
 	@DisplayName("A stack")
 	@DisplayNameGeneration(DisplayNameGenerator.ReplaceUnderscores.class)
 	static class StackTestCase {
@@ -353,6 +354,7 @@ void peek_returns_that_element_without_removing_it_from_the_stack() {
 
 	// -------------------------------------------------------------------
 
+	@SuppressWarnings("JUnitMalformedDeclaration")
 	@DisplayName("A stack")
 	@IndicativeSentencesGeneration(generator = DisplayNameGenerator.ReplaceUnderscores.class)
 	static class IndicativeGeneratorTestCase {
@@ -397,6 +399,7 @@ void is_no_longer_empty() {
 
 	// -------------------------------------------------------------------
 
+	@SuppressWarnings("JUnitMalformedDeclaration")
 	@DisplayName("A stack")
 	@IndicativeSentencesGeneration(separator = " >> ", generator = DisplayNameGenerator.ReplaceUnderscores.class)
 	static class IndicativeGeneratorWithCustomSeparatorTestCase {

diff --git a/...src/test/java/org/junit/jupiter/api/IndicativeSentencesGenerationInheritanceTestCase.java b/...src/test/java/org/junit/jupiter/api/IndicativeSentencesGenerationInheritanceTestCase.java
@@ -26,6 +26,7 @@ void this_is_a_test() {
 		}
 	}
 
+	@SuppressWarnings("JUnitMalformedDeclaration")
 	static class StaticNestedTestCase {
 
 		@Test

diff --git a/...ests/src/test/java/org/junit/jupiter/api/extension/CloseableResourceIntegrationTests.java b/...ests/src/test/java/org/junit/jupiter/api/extension/CloseableResourceIntegrationTests.java
@@ -35,6 +35,7 @@ void closesCloseableResourcesInReverseInsertOrder() {
 					reportEntry(Map.of("1", "closed")));
 	}
 
+	@SuppressWarnings("JUnitMalformedDeclaration")
 	@ExtendWith(ExtensionContextParameterResolver.class)
 	static class TestCase {
 		@Test
@@ -64,6 +65,7 @@ void exceptionsDuringCloseAreReportedAsSuppressed() {
 						))));
 	}
 
+	@SuppressWarnings("JUnitMalformedDeclaration")
 	@ExtendWith(ThrowingOnCloseExtension.class)
 	static class ExceptionInCloseableResourceTestCase {
 

diff --git a/...ests/src/test/java/org/junit/jupiter/api/extension/ExecutableInvokerIntegrationTests.java b/...ests/src/test/java/org/junit/jupiter/api/extension/ExecutableInvokerIntegrationTests.java
@@ -39,11 +39,13 @@ void invokeMethodViaExtensionContext() {
 		assertEquals(2, ExecuteTestsTwiceTestCase.testInvocations);
 	}
 
+	@SuppressWarnings("JUnitMalformedDeclaration")
 	@ExtendWith(ExecuteTestsTwiceExtension.class)
 	static class ExecuteTestsTwiceTestCase {
 
 		static int testInvocations = 0;
 
+		@SuppressWarnings("JUnitMalformedDeclaration")
 		@Test
 		void testWithResolvedParameter(TestInfo testInfo,
 				@ExtendWith(ExtensionContextParameterResolver.class) ExtensionContext extensionContext) {
@@ -54,6 +56,7 @@ void testWithResolvedParameter(TestInfo testInfo,
 
 	}
 
+	@SuppressWarnings("JUnitMalformedDeclaration")
 	@ExtendWith(ExecuteConstructorTwiceExtension.class)
 	static class ExecuteConstructorTwiceTestCase {
 

diff --git a/...s/src/test/java/org/junit/jupiter/engine/BeforeAllAndAfterAllComposedAnnotationTests.java b/...s/src/test/java/org/junit/jupiter/engine/BeforeAllAndAfterAllComposedAnnotationTests.java
@@ -39,6 +39,7 @@ void beforeAllAndAfterAllAsMetaAnnotations() {
 		assertThat(methodsInvoked).containsExactly("beforeAll", "test", "afterAll");
 	}
 
+	@SuppressWarnings("JUnitMalformedDeclaration")
 	static class TestCase {
 
 		@CustomBeforeAll

diff --git a/...src/test/java/org/junit/jupiter/engine/BeforeEachAndAfterEachComposedAnnotationTests.java b/...src/test/java/org/junit/jupiter/engine/BeforeEachAndAfterEachComposedAnnotationTests.java
@@ -39,6 +39,7 @@ void beforeEachAndAfterEachAsMetaAnnotations() {
 		assertThat(methodsInvoked).containsExactly("beforeEach", "test", "afterEach");
 	}
 
+	@SuppressWarnings("JUnitMalformedDeclaration")
 	static class TestCase {
 
 		@CustomBeforeEach

diff --git a/jupiter-tests/src/test/java/org/junit/jupiter/engine/DefaultExecutionModeTests.java b/jupiter-tests/src/test/java/org/junit/jupiter/engine/DefaultExecutionModeTests.java
@@ -126,6 +126,7 @@ private <T extends TestDescriptor> T firstChild(TestDescriptor engineDescriptor,
 				.orElseGet(() -> fail("No child of type " + testDescriptorClass + " found"));
 	}
 
+	@SuppressWarnings("JUnitMalformedDeclaration")
 	static class TestCase {
 
 		@Test
@@ -155,6 +156,7 @@ static class ConcurrentTestCase extends TestCase {
 	static class SameThreadTestCase extends TestCase {
 	}
 
+	@SuppressWarnings("JUnitMalformedDeclaration")
 	static class OuterTestCase {
 		@Nested
 		class LevelOne {

diff --git a/jupiter-tests/src/test/java/org/junit/jupiter/engine/DefaultMethodTests.java b/jupiter-tests/src/test/java/org/junit/jupiter/engine/DefaultMethodTests.java
@@ -200,6 +200,7 @@ default void afterAll() {
 
 	}
 
+	@SuppressWarnings("JUnitMalformedDeclaration")
 	static class GenericTestCaseWithDefaultMethod implements GenericTestInterface<Long> {
 
 		@Test
@@ -210,6 +211,7 @@ void test(Double number) {
 
 	}
 
+	@SuppressWarnings("JUnitMalformedDeclaration")
 	static class GenericTestCaseWithOverriddenDefaultMethod implements GenericTestInterface<Long> {
 
 		@Test

diff --git a/jupiter-tests/src/test/java/org/junit/jupiter/engine/DisabledTests.java b/jupiter-tests/src/test/java/org/junit/jupiter/engine/DisabledTests.java
@@ -50,6 +50,7 @@ void executeTestsWithDisabledTestMethods() throws Exception {
 
 	// -------------------------------------------------------------------
 
+	@SuppressWarnings("JUnitMalformedDeclaration")
 	@Disabled
 	static class DisabledTestClassTestCase {
 
@@ -59,6 +60,7 @@ void disabledTest() {
 		}
 	}
 
+	@SuppressWarnings("JUnitMalformedDeclaration")
 	static class DisabledTestMethodsTestCase {
 
 		@Test

diff --git a/jupiter-tests/src/test/java/org/junit/jupiter/engine/ExceptionHandlingTests.java b/jupiter-tests/src/test/java/org/junit/jupiter/engine/ExceptionHandlingTests.java
@@ -248,6 +248,7 @@ void cleanUpExceptions() {
 
 	// -------------------------------------------------------------------------
 
+	@SuppressWarnings("JUnitMalformedDeclaration")
 	static class FailureTestCase {
 
 		static Optional<Throwable> exceptionToThrowInBeforeAll = Optional.empty();
@@ -309,6 +310,7 @@ void abortedTest() {
 
 	}
 
+	@SuppressWarnings("JUnitMalformedDeclaration")
 	@TestInstance(PER_METHOD)
 	@ExtendWith(ThrowingAfterAllCallback.class)
 	static class TestCaseWithInvalidConstructorAndThrowingAfterAllCallbackAndPerMethodLifecycle {
@@ -322,6 +324,7 @@ void test() {
 
 	}
 
+	@SuppressWarnings("JUnitMalformedDeclaration")
 	@TestInstance(PER_CLASS)
 	@ExtendWith(ThrowingAfterAllCallback.class)
 	static class TestCaseWithInvalidConstructorAndThrowingAfterAllCallbackAndPerClassLifecycle {
@@ -334,6 +337,7 @@ void test() {
 		}
 	}
 
+	@SuppressWarnings("JUnitMalformedDeclaration")
 	@ExtendWith(ThrowingBeforeAllCallback.class)
 	@ExtendWith(ThrowingAfterAllCallback.class)
 	static class TestCaseWithThrowingBeforeAllAndAfterAllCallbacks {

diff --git a/jupiter-tests/src/test/java/org/junit/jupiter/engine/FailedAssumptionsTests.java b/jupiter-tests/src/test/java/org/junit/jupiter/engine/FailedAssumptionsTests.java
@@ -42,6 +42,7 @@ void assumptionViolatedExceptionInBeforeAll() {
 
 	// -------------------------------------------------------------------
 
+	@SuppressWarnings("JUnitMalformedDeclaration")
 	static class TestAbortedExceptionInBeforeAllTestCase {
 
 		@BeforeAll
@@ -54,6 +55,7 @@ void test() {
 		}
 	}
 
+	@SuppressWarnings("JUnitMalformedDeclaration")
 	static class AssumptionViolatedExceptionInBeforeAllTestCase {
 
 		@BeforeAll

diff --git a/...ests/src/test/java/org/junit/jupiter/engine/InvalidLifecycleMethodConfigurationTests.java b/...ests/src/test/java/org/junit/jupiter/engine/InvalidLifecycleMethodConfigurationTests.java
@@ -73,16 +73,19 @@ private void assertContainerFailed(Class<?> invalidTestClass) {
 
 	// -------------------------------------------------------------------------
 
+	@SuppressWarnings("JUnitMalformedDeclaration")
 	static class TestCase {
 
 		@Test
 		void test() {
 		}
 	}
 
+	@SuppressWarnings("JUnitMalformedDeclaration")
 	static class TestCaseWithInvalidNonStaticBeforeAllMethod {
 
 		// must be static
+		@SuppressWarnings("JUnitMalformedDeclaration")
 		@BeforeAll
 		void beforeAll() {
 		}
@@ -92,9 +95,11 @@ void test() {
 		}
 	}
 
+	@SuppressWarnings("JUnitMalformedDeclaration")
 	static class TestCaseWithInvalidNonStaticAfterAllMethod {
 
 		// must be static
+		@SuppressWarnings("JUnitMalformedDeclaration")
 		@AfterAll
 		void afterAll() {
 		}
@@ -104,9 +109,11 @@ void test() {
 		}
 	}
 
+	@SuppressWarnings("JUnitMalformedDeclaration")
 	static class TestCaseWithInvalidStaticBeforeEachMethod {
 
 		// must NOT be static
+		@SuppressWarnings("JUnitMalformedDeclaration")
 		@BeforeEach
 		static void beforeEach() {
 		}
@@ -116,9 +123,11 @@ void test() {
 		}
 	}
 
+	@SuppressWarnings("JUnitMalformedDeclaration")
 	static class TestCaseWithInvalidStaticAfterEachMethod {
 
 		// must NOT be static
+		@SuppressWarnings("JUnitMalformedDeclaration")
 		@AfterEach
 		static void afterEach() {
 		}

diff --git a/jupiter-tests/src/test/java/org/junit/jupiter/engine/MultipleTestableAnnotationsTests.java b/jupiter-tests/src/test/java/org/junit/jupiter/engine/MultipleTestableAnnotationsTests.java
@@ -42,8 +42,10 @@ void testAndRepeatedTest(@TrackLogRecords LogRecordListener listener) {
 		// @formatter:on
 	}
 
+	@SuppressWarnings("JUnitMalformedDeclaration")
 	static class TestCase {
 
+		@SuppressWarnings("JUnitMalformedDeclaration")
 		@Test
 		@RepeatedTest(1)
 		void testAndRepeatedTest(RepetitionInfo repetitionInfo) {

diff --git a/jupiter-tests/src/test/java/org/junit/jupiter/engine/NestedTestClassesTests.java b/jupiter-tests/src/test/java/org/junit/jupiter/engine/NestedTestClassesTests.java
@@ -190,6 +190,7 @@ private void assertNestedCycle(Class<?> start, Class<?> from, Class<?> to) {
 
 	// -------------------------------------------------------------------
 
+	@SuppressWarnings("JUnitMalformedDeclaration")
 	static class TestCaseWithNesting {
 
 		@Test
@@ -210,6 +211,7 @@ void failing() {
 		}
 	}
 
+	@SuppressWarnings("JUnitMalformedDeclaration")
 	static class TestCaseWithDoubleNesting {
 
 		static int beforeTopCount = 0;
@@ -283,6 +285,7 @@ void failing() {
 
 	interface InterfaceWithNestedClass {
 
+		@SuppressWarnings("JUnitMalformedDeclaration")
 		@Nested
 		class NestedInInterface {
 
@@ -334,6 +337,7 @@ class ConcreteInner2 extends AbstractSuperClass {
 	static class AbstractOuterClass {
 	}
 
+	@SuppressWarnings("JUnitMalformedDeclaration")
 	static class OuterClass extends AbstractOuterClass {
 
 		@Test

diff --git a/...r-tests/src/test/java/org/junit/jupiter/engine/NonVoidTestableMethodIntegrationTests.java b/...r-tests/src/test/java/org/junit/jupiter/engine/NonVoidTestableMethodIntegrationTests.java
@@ -21,12 +21,14 @@ class NonVoidTestableMethodIntegrationTests {
 	void valid() {
 	}
 
+	@SuppressWarnings("JUnitMalformedDeclaration")
 	@Test
 	int invalidMethodReturningPrimitive() {
 		fail("This method should never have been called.");
 		return 1;
 	}
 
+	@SuppressWarnings("JUnitMalformedDeclaration")
 	@Test
 	String invalidMethodReturningObject() {
 		fail("This method should never have been called.");

diff --git a/jupiter-tests/src/test/java/org/junit/jupiter/engine/OverloadedTestMethodTests.java b/jupiter-tests/src/test/java/org/junit/jupiter/engine/OverloadedTestMethodTests.java
@@ -64,6 +64,7 @@ void executeTestCaseWithOverloadedMethodsWithSingleMethodThatAcceptsArgumentsSel
 		assertTrue(first.isPresent());
 	}
 
+	@SuppressWarnings("JUnitMalformedDeclaration")
 	static class TestCase {
 
 		@Test

diff --git a/jupiter-tests/src/test/java/org/junit/jupiter/engine/RecordTests.java b/jupiter-tests/src/test/java/org/junit/jupiter/engine/RecordTests.java
@@ -23,6 +23,7 @@ void recordsAreTestClasses() {
 				.assertStatistics(stats -> stats.finished(2).succeeded(1).failed(1));
 	}
 
+	@SuppressWarnings("JUnitMalformedDeclaration")
 	record TestCase() {
 
 		@Test

diff --git a/jupiter-tests/src/test/java/org/junit/jupiter/engine/ReportingTests.java b/jupiter-tests/src/test/java/org/junit/jupiter/engine/ReportingTests.java
@@ -36,6 +36,7 @@ void reportEntriesArePublished() {
 				.reportingEntryPublished(7));
 	}
 
+	@SuppressWarnings("JUnitMalformedDeclaration")
 	static class MyReportingTestCase {
 
 		@BeforeEach
-Original file line number
+Diff line change
@@ Expand Up / @@ -26,6 +26,7 @@ void this_is_a_test() { @@
     		}
     	}
+    	@SuppressWarnings("JUnitMalformedDeclaration")
     	static class StaticNestedTestCase {
     		@Test
@@ Expand Down @@