assertTimeout for performance in JUnit - Framework Patterns

Framework Mode - assertTimeout for performance

Folder Structure

src/
└── test/
    └── java/
        └── com/
            └── example/
                ├── pages/
                │   └── LoginPage.java
                ├── tests/
                │   └── PerformanceTests.java
                ├── utils/
                │   └── TestUtils.java
                └── config/
                    └── TestConfig.java

Test Framework Layers

• Driver Layer: Manages WebDriver setup and teardown for browser control.
• Page Objects: Encapsulate UI elements and actions for each page (e.g., LoginPage).
• Tests: Contains test classes using JUnit, including performance tests with assertTimeout.
• Utilities: Helper methods for common tasks like waits, data generation, or logging.
• Configuration: Holds environment settings, browser options, and credentials.

Configuration Patterns

• Environment Properties: Use TestConfig.java or application.properties to define URLs, timeouts, and credentials.
• Browser Settings: Configure browser type and options in setup methods or config files.
• Timeout Settings: Define default and maximum allowed durations for performance tests.
• Credentials Management: Store sensitive data securely, e.g., environment variables or encrypted files.

Test Reporting and CI/CD Integration

• Use JUnit reports (XML) for test results including performance assertions.
• Integrate with CI tools like Jenkins, GitHub Actions, or GitLab CI to run tests on each commit.
• Fail builds automatically if assertTimeout performance tests exceed limits.
• Use plugins or tools (e.g., Allure) for detailed test reports with timing info.

Best Practices for Using assertTimeout in JUnit

1. Set realistic timeout values: Base time limits on actual acceptable performance, not arbitrary numbers.
2. Isolate performance tests: Keep performance assertions in dedicated test methods or classes.
3. Use descriptive messages: Provide clear failure messages to understand timeout causes.
4. Combine with setup/teardown: Ensure environment is stable to avoid false timeouts.
5. Run performance tests regularly: Integrate into CI to catch regressions early.

Self Check

Where in this folder structure would you add a new performance test that uses assertTimeout to check page load speed?

Key Result

Use assertTimeout in JUnit tests within a structured framework to verify performance limits reliably.

Practice

1. What is the main purpose of assertTimeout in JUnit testing?

easy

A. To test if exceptions are thrown correctly

B. To check if a block of code finishes execution within a specified time limit

C. To verify the correctness of output values

D. To compare two objects for equality

Solution

1. Step 1: Understand the role of assertTimeout

   assertTimeout is used to ensure that a piece of code completes within a given time limit.

2. Step 2: Differentiate from other assertions

   Other assertions check correctness or exceptions, but assertTimeout focuses on performance timing.

3. Final Answer:

   To check if a block of code finishes execution within a specified time limit -> Option B

4. Quick Check:

   assertTimeout checks execution time = C [OK]

Hint: assertTimeout checks speed, not correctness or exceptions [OK]

Common Mistakes:

• Confusing assertTimeout with assertEquals
• Thinking assertTimeout checks output correctness
• Assuming assertTimeout tests exception throwing

2. Which of the following is the correct syntax to use assertTimeout in JUnit 5 to test a method processData() with a 2-second limit?

easy

A. assertTimeout(Duration.ofSeconds(2), () -> processData());

B. assertTimeout(2, processData());

C. assertTimeout(2000, () -> processData());

D. assertTimeout(Duration.seconds(2), processData());

Solution

1. Step 1: Recall correct Duration usage

   JUnit 5 uses Duration.ofSeconds(2) to specify 2 seconds.

2. Step 2: Confirm lambda syntax

   The code block must be passed as a lambda: () -> processData().

3. Final Answer:

   assertTimeout(Duration.ofSeconds(2), () -> processData()); -> Option A

4. Quick Check:

   Duration.ofSeconds + lambda = A [OK]

Hint: Use Duration.ofSeconds and lambda for assertTimeout [OK]

Common Mistakes:

• Passing method call directly instead of lambda
• Using integer instead of Duration object
• Wrong Duration method like Duration.seconds

3. Given the code below, what will be the test result?

assertTimeout(Duration.ofMillis(500), () -> {
    Thread.sleep(300);
    Thread.sleep(250);
});

medium

A. Test passes because total sleep is 550ms which is less than 500ms

B. Test passes because each sleep is less than 500ms

C. Test fails because total sleep is 550ms which exceeds 500ms

D. Test fails due to syntax error in lambda

Solution

1. Step 1: Calculate total sleep time

   Thread sleeps 300ms + 250ms = 550ms total.

2. Step 2: Compare with timeout limit

   Timeout is 500ms, so 550ms exceeds the limit causing failure.

3. Final Answer:

   Test fails because total sleep is 550ms which exceeds 500ms -> Option C

4. Quick Check:

   Total sleep 550ms > 500ms timeout = B [OK]

Hint: Sum all delays and compare to timeout [OK]

Common Mistakes:

• Ignoring cumulative sleep time
• Assuming each sleep is checked separately
• Thinking test passes if individual sleeps are under limit

4. Identify the error in this JUnit 5 test using assertTimeout:

assertTimeout(Duration.ofSeconds(1), processData());

medium

A. processData() must return a boolean

B. Duration.ofSeconds should be Duration.seconds

C. assertTimeout requires a timeout in milliseconds

D. Missing lambda expression to defer execution

Solution

1. Step 1: Check how code block is passed

   assertTimeout expects a lambda or executable to delay running until assertion.

2. Step 2: Identify missing lambda

   Here, processData() is called immediately, not deferred by lambda.

3. Final Answer:

   Missing lambda expression to defer execution -> Option D

4. Quick Check:

   assertTimeout needs lambda to delay execution = A [OK]

Hint: Always wrap code in lambda for assertTimeout [OK]

Common Mistakes:

• Calling method directly instead of lambda
• Using wrong Duration method
• Expecting assertTimeout to accept milliseconds as int

5. You want to test a method calculate() that sometimes takes longer but should not exceed 3 seconds. Which approach correctly uses assertTimeout to fail the test if calculate() exceeds 3 seconds, and also returns the method's result for further checks?

hard

A. var result = assertTimeout(Duration.ofSeconds(3), () -> { return calculate(); });

B. assertTimeout(Duration.ofSeconds(3), () -> { calculate(); });

C. assertTimeout(Duration.ofSeconds(3), () -> { return calculate(); });

D. var result = assertTimeout(Duration.ofSeconds(3), calculate());

Solution

1. Step 1: Understand assertTimeout return value

   assertTimeout returns the value from the lambda if it completes in time.

2. Step 2: Use lambda with return and assign result

   To capture calculate() result, lambda must return it and assign to a variable.

3. Step 3: Check syntax correctness

   var result = assertTimeout(Duration.ofSeconds(3), () -> { return calculate(); }); uses lambda with return and assigns to result, matching requirements.

4. Final Answer:

   var result = assertTimeout(Duration.ofSeconds(3), () -> { return calculate(); }); -> Option A

5. Quick Check:

   Return value + assign result + timeout = D [OK]

Hint: Use lambda with return and assign to capture result [OK]

Common Mistakes:

• Not returning value inside lambda
• Not assigning assertTimeout result
• Using lambda without return for non-void methods