@Order for execution order in JUnit - Build an Automation Script

Verify test methods execute in specified order using @Order annotation

Preconditions (2)

Step 1: Create a test class annotated with @TestMethodOrder(OrderAnnotation.class)

Step 2: Add three test methods annotated with @Test and @Order with values 1, 2, and 3 respectively

Step 3: Inside each test method, print or log a unique message indicating its execution

Step 4: Run the test class

Step 5: Observe the order of test execution in the test report or console output

✅ Expected Result: Test methods execute in the order defined by their @Order values: method with @Order(1) runs first, then @Order(2), then @Order(3)

Automation Requirements - JUnit 5

Assertions Needed:

Verify that test methods run in the order specified by their @Order annotation

Best Practices:

Use @TestMethodOrder(OrderAnnotation.class) at class level

Use @Order annotation on each test method with unique integer values

Avoid relying on default test execution order

Keep test methods independent and idempotent

Automated Solution

JUnit

import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.Order;
import org.junit.jupiter.api.TestMethodOrder;
import org.junit.jupiter.api.MethodOrderer.OrderAnnotation;
import static org.junit.jupiter.api.Assertions.assertTrue;

@TestMethodOrder(OrderAnnotation.class)
public class OrderedTests {

    private static final StringBuilder executionOrder = new StringBuilder();

    @Test
    @Order(1)
    void firstTest() {
        executionOrder.append("1");
        assertTrue(true);
    }

    @Test
    @Order(2)
    void secondTest() {
        executionOrder.append("2");
        assertTrue(true);
    }

    @Test
    @Order(3)
    void thirdTest() {
        executionOrder.append("3");
        assertTrue(true);
        // Verify the order after all tests run
        String order = executionOrder.toString();
        assertTrue(order.equals("123"), "Tests did not run in order 1,2,3 but in order: " + order);
    }
}

This test class uses @TestMethodOrder(OrderAnnotation.class) to specify that test methods run in the order defined by their @Order annotations.

Each test method appends its order number to a shared StringBuilder. The last test method asserts that the combined execution order string is "123", confirming the tests ran in the correct sequence.

Assertions inside each test ensure the test runs and the final assertion verifies the execution order.

Common Mistakes - 4 Pitfalls

Not annotating the class with @TestMethodOrder(OrderAnnotation.class)

Using duplicate @Order values on multiple test methods

{'mistake': 'Relying on test execution order without explicit @Order annotations', 'why_bad': "JUnit's default order is not guaranteed and can change, causing flaky tests.", 'correct_approach': 'Use @Order annotations with @TestMethodOrder to explicitly control execution order.'}

Making tests dependent on execution order for correctness

Bonus Challenge

Now add data-driven testing with 3 different sets of inputs and verify the order of execution for each data set

Show Hint

Practice

1. What does the @Order annotation do in JUnit testing?

easy

A. It sets the order in which test methods are executed.

B. It skips the annotated test method during execution.

C. It marks a test method as disabled.

D. It repeats the test method multiple times.

Solution

1. Step 1: Understand the purpose of @Order

   The @Order annotation is used to specify the sequence in which test methods run.

2. Step 2: Compare with other options

   Skipping, disabling, or repeating tests are done by other annotations like @Disabled or loops, not @Order.

3. Final Answer:

   It sets the order in which test methods are executed. -> Option A

4. Quick Check:

   @Order controls test execution order [OK]

Hint: Remember: @Order controls test run sequence [OK]

Common Mistakes:

• Confusing @Order with @Disabled
• Thinking @Order repeats tests
• Assuming @Order skips tests

2. Which annotation must be added to a JUnit test class to enable @Order annotations on its methods?

easy

A. @TestMethodOrder(OrderAnnotation.class)

B. @TestOrder

C. @OrderEnabled

D. @EnableOrder

Solution

1. Step 1: Recall the class-level annotation for ordering

   JUnit requires @TestMethodOrder(OrderAnnotation.class) on the test class to activate @Order on methods.

2. Step 2: Verify other options

   Options B, C, and D are not valid JUnit annotations.

3. Final Answer:

   @TestMethodOrder(OrderAnnotation.class) -> Option A

4. Quick Check:

   Enable ordering with @TestMethodOrder(OrderAnnotation.class) [OK]

Hint: Use @TestMethodOrder(OrderAnnotation.class) to activate @Order [OK]

Common Mistakes:

• Using non-existent annotations like @TestOrder
• Forgetting to add @TestMethodOrder on class
• Confusing method-level and class-level annotations

3. Given the following JUnit test class, in what order will the test methods run?

@TestMethodOrder(OrderAnnotation.class)
class SampleTest {
  @Test
  @Order(2)
  void testB() {}

  @Test
  @Order(1)
  void testA() {}

  @Test
  @Order(3)
  void testC() {}
}

medium

A. testB, testC, testA

B. testA, testB, testC

C. testC, testB, testA

D. testB, testA, testC

Solution

1. Step 1: Identify the order values

   testA has @Order(1), testB has @Order(2), testC has @Order(3).

2. Step 2: Arrange tests by ascending order

   Tests run from lowest to highest order number: testA, testB, then testC.

3. Final Answer:

   testA, testB, testC -> Option B

4. Quick Check:

   Lower @Order number runs first [OK]

Hint: Lower @Order number runs before higher [OK]

Common Mistakes:

• Assuming declaration order matters over @Order
• Mixing up ascending and descending order
• Ignoring @TestMethodOrder annotation

4. What is wrong with this JUnit test class if the tests do not run in the expected order?

class MyTests {
  @Test
  @Order(1)
  void firstTest() {}

  @Test
  @Order(2)
  void secondTest() {}
}

medium

A. @Order values must start from 0, not 1.

B. Test methods must be static to use @Order.

C. @Order annotation cannot be used with @Test.

D. Missing @TestMethodOrder(OrderAnnotation.class) on the class.

Solution

1. Step 1: Check class-level annotation

   The class lacks @TestMethodOrder(OrderAnnotation.class), so @Order annotations are ignored.

2. Step 2: Verify other options

   @Order values can start at 1, @Order works with @Test, and test methods do not need to be static.

3. Final Answer:

   Missing @TestMethodOrder(OrderAnnotation.class) on the class. -> Option D

4. Quick Check:

   Class must have @TestMethodOrder to enable @Order [OK]

Hint: Add @TestMethodOrder(OrderAnnotation.class) on class to enable ordering [OK]

Common Mistakes:

• Forgetting class-level @TestMethodOrder annotation
• Thinking @Order needs static methods
• Believing @Order values must start at zero

5. You have a JUnit test class with methods annotated with @Order values 1, 2, and 2. What will happen when you run the tests with @TestMethodOrder(OrderAnnotation.class)?

hard

A. Tests with duplicate order values are skipped.

B. JUnit throws a runtime error due to duplicate order values.

C. Tests with the same order value run in declaration order among themselves.

D. Tests run in random order ignoring the duplicate values.

Solution

1. Step 1: Understand behavior with duplicate @Order values

   JUnit allows duplicate order values; tests with the same order run in the order they appear in the code.

2. Step 2: Check other options

   JUnit does not throw errors or skip tests due to duplicate order values, nor does it randomize them.

3. Final Answer:

   Tests with the same order value run in declaration order among themselves. -> Option C

4. Quick Check:

   Duplicate @Order runs in code order [OK]

Hint: Duplicate @Order runs in source code order [OK]

Common Mistakes:

• Expecting errors on duplicate @Order values
• Assuming tests with same order run randomly
• Thinking duplicates cause tests to skip