@Disabled for skipping tests in JUnit

Introduction

Sometimes you want to skip a test temporarily without deleting it. @Disabled helps you do that easily.

When a test is broken and you want to fix it later without failing the build.

When a feature is not ready but the test exists already.

When you want to skip a long-running test during quick checks.

When a test depends on an external system that is currently unavailable.

Syntax

JUnit

@Disabled("optional reason")
void testMethod() {
    // test code
}

You can add an optional reason inside the parentheses to explain why the test is disabled.

This annotation works on test methods or whole test classes.

Examples

Disables the test without giving a reason.

JUnit

@Disabled
@Test
void testFeature() {
    // test code
}

Disables the test and explains why.

JUnit

@Disabled("Waiting for bug fix #123")
@Test
void testLogin() {
    // test code
}

Disables all tests in the class.

JUnit

@Disabled
class OldTests {
    @Test
    void oldTest() {
        // test code
    }
}

Sample Program

This class has two tests. The subtractTest is skipped because of @Disabled. The addTest runs and passes.

JUnit

import org.junit.jupiter.api.Disabled;
import org.junit.jupiter.api.Test;
import static org.junit.jupiter.api.Assertions.assertEquals;

public class CalculatorTest {

    @Test
    void addTest() {
        assertEquals(5, 2 + 3);
    }

    @Disabled("Skipping subtraction test temporarily")
    @Test
    void subtractTest() {
        assertEquals(1, 3 - 2);
    }
}

Important Notes

Disabled tests do not run and do not affect test results.

Use @Disabled to keep your test code but skip running it temporarily.

Summary

@Disabled skips tests without deleting them.

You can add a reason to explain why the test is skipped.

It works on both test methods and classes.

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