@Disabled for skipping tests in JUnit - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the purpose of the @Disabled annotation in JUnit?

The <code>@Disabled</code> annotation is used to skip or ignore a test method or class temporarily. It prevents the test from running without deleting or commenting out the code.

beginner

How do you disable a single test method using JUnit?

Add the @Disabled annotation directly above the test method. For example:

@Disabled
@Test
void testExample() { ... }

intermediate

Can you disable an entire test class in JUnit? How?

Yes, by placing the <code>@Disabled</code> annotation above the class declaration, all tests inside that class will be skipped during execution.

intermediate

What happens to the test report when tests are skipped using @Disabled?

Skipped tests are reported as 'skipped' or 'ignored' in the test report. They do not count as passed or failed but are noted so you know they were intentionally not run.

beginner

Why might you want to use @Disabled instead of deleting a test?

Using @Disabled keeps the test code for future use or debugging. It allows you to temporarily skip tests that are flaky, incomplete, or dependent on external factors without losing the test logic.

What does the @Disabled annotation do in JUnit?

A Runs the test multiple times

B Marks the test as failed

C Enables the test to run only on weekends

D Skips the annotated test method or class

The @Disabled annotation tells JUnit to skip the test method or class during execution.

Where do you place the @Disabled annotation to skip a test method?

A In the test class constructor

B Inside the test method body

C Above the test method declaration

D Below the test method declaration

You place @Disabled directly above the test method declaration to skip that specific test.

If you want to skip all tests in a class, what should you do?

A Add <code>@Disabled</code> above the class declaration

B Add <code>@Disabled</code> to each test method

C Delete the test class

D Rename the test class

Adding @Disabled above the class disables all tests inside that class.

How are skipped tests shown in the test report?

A As failed tests

B As skipped or ignored tests

C As passed tests

D They are not shown at all

Skipped tests appear in the report as skipped or ignored, so you know they were intentionally not run.

Why is it better to use @Disabled instead of deleting a test?

A To keep the test code for future use

B To make the test run faster

C To automatically fix test errors

D To run the test on a different machine

@Disabled keeps the test code intact so you can enable it later or debug it.

Explain how and why you would use the @Disabled annotation in JUnit testing.

Think about situations when you want to skip tests without deleting them.

Describe the impact of using @Disabled on test reports and test suite results.

Consider how test reports show tests that were not executed.

Practice

1. What is the main purpose of the @Disabled annotation in JUnit?

easy

A. To run a test multiple times

B. To skip a test without deleting its code

C. To mark a test as passed automatically

D. To make a test run faster

Solution

1. Step 1: Understand the role of @Disabled

   The @Disabled annotation tells JUnit to skip running the test method or class.

2. Step 2: Compare with other options

   It does not mark tests as passed, run them multiple times, or affect speed.

3. Final Answer:

   To skip a test without deleting its code -> Option B

4. Quick Check:

   @Disabled skips tests = C [OK]

Hint: Remember: @Disabled means skip test, not delete it [OK]

Common Mistakes:

• Thinking @Disabled runs tests faster
• Confusing @Disabled with @Test
• Assuming @Disabled marks tests as passed

2. Which of the following is the correct syntax to disable a test method with a reason in JUnit?

easy

A. @Skip("Not ready yet")\npublic void testFeature() {}

B. @Disabled public void testFeature() {"Not ready yet"}

C. @Ignore("Not ready yet")\npublic void testFeature() {}

D. @Disabled("Not ready yet")\npublic void testFeature() {}

Solution

1. Step 1: Identify correct annotation and syntax

   JUnit uses @Disabled with an optional string reason in parentheses and quotes.

2. Step 2: Check each option

   @Disabled("Not ready yet")\npublic void testFeature() {} uses correct annotation and syntax. Options A and C use wrong annotations. @Disabled public void testFeature() {"Not ready yet"} places the reason incorrectly.

3. Final Answer:

   @Disabled("Not ready yet")\npublic void testFeature() {} -> Option D

4. Quick Check:

   @Disabled("reason") syntax = B [OK]

Hint: Use @Disabled("reason") with quotes and parentheses [OK]

Common Mistakes:

• Using @Skip or @Ignore instead of @Disabled
• Placing reason outside parentheses
• Missing quotes around reason

3. Consider the following JUnit test class:

@Disabled("Waiting for bug fix")
public class CalculatorTests {
    @Test
    public void testAdd() { /* test code */ }

    @Test
    public void testSubtract() { /* test code */ }
}

What will happen when this test class runs?

medium

A. Both testAdd and testSubtract will be skipped with reason shown

B. Only testAdd will be skipped, testSubtract will run

C. Both tests will run normally

D. Tests will fail due to syntax error

Solution

1. Step 1: Understand class-level @Disabled effect

   When @Disabled is on a class, all tests inside are skipped.

2. Step 2: Check test methods behavior

   Both testAdd and testSubtract will be skipped, and the reason "Waiting for bug fix" will be shown in reports.

3. Final Answer:

   Both testAdd and testSubtract will be skipped with reason shown -> Option A

4. Quick Check:

   Class-level @Disabled skips all tests = D [OK]

Hint: Class @Disabled skips all tests inside it [OK]

Common Mistakes:

• Thinking only first test is skipped
• Assuming tests run despite class @Disabled
• Confusing @Disabled with @Test

4. You wrote this test method:

@Disabled("Feature incomplete")
public void testFeature() {
    assertEquals(5, 2 + 3);
}

But when you run tests, this method still runs. What is the likely problem?

medium

A. The method is missing the @Test annotation

B. The @Disabled annotation is misspelled

C. The test method is private instead of public

D. JUnit does not support @Disabled on methods

Solution

1. Step 1: Check required annotations for test methods

   JUnit requires @Test annotation to recognize a method as a test.

2. Step 2: Analyze given code

   The method has @Disabled but lacks @Test, so JUnit ignores it as a test and does not skip it.

3. Final Answer:

   The method is missing the @Test annotation -> Option A

4. Quick Check:

   Missing @Test means method not recognized as test [OK]

Hint: Always add @Test to test methods even if @Disabled is present [OK]

Common Mistakes:

• Assuming @Disabled alone makes method a test
• Ignoring method visibility rules
• Thinking JUnit does not support @Disabled on methods

5. You want to temporarily disable some tests in a large test suite but still see the reason for skipping in reports. Which approach is best?

hard

A. Remove the @Test annotation from tests to skip

B. Comment out the test methods in the code

C. Add @Disabled("Reason") to each test method you want to skip

D. Use @Disabled on the whole test class without reasons

Solution

1. Step 1: Understand how to skip tests with reasons

   Using @Disabled("Reason") on test methods skips them and shows the reason in reports.

2. Step 2: Compare other options

   Commenting out or removing @Test hides tests but does not show skip reasons. Disabling whole class skips all tests without selective reasons.

3. Final Answer:

   Add @Disabled("Reason") to each test method you want to skip -> Option C

4. Quick Check:

   @Disabled with reason per method shows skip reason [OK]

Hint: Use @Disabled("reason") on methods to skip with explanation [OK]

Common Mistakes:

• Commenting out tests instead of disabling
• Removing @Test hides tests silently
• Disabling whole class loses selective control