Deterministic tests in JUnit - Framework Patterns

Framework Mode - Deterministic tests

Folder Structure

my-junit-project/
├── src/
│   ├── main/
│   │   └── java/
│   │       └── com/example/app/       # Application source code
│   └── test/
│       └── java/
│           └── com/example/tests/    # Test classes
│               ├── pages/             # Page Object classes
│               ├── utils/             # Utility classes (helpers, data providers)
│               └── tests/             # JUnit test classes
├── resources/
│   └── testdata/                      # Test data files (JSON, CSV)
├── build.gradle or pom.xml            # Build and dependency management
└── junit-platform.properties          # JUnit configuration

Test Framework Layers

• Driver Layer: Manages WebDriver setup and teardown for browser control.
• Page Objects: Encapsulate UI elements and actions for each page to keep tests clean and reusable.
• Tests: JUnit test classes that contain deterministic test methods with fixed inputs and expected outputs.
• Utilities: Helper classes for common functions like data loading, waits, and assertions.
• Configuration: Central place for environment variables, browser settings, and credentials.

Configuration Patterns

Use property files or environment variables to manage configurations:

• Environment Profiles: Separate configs for dev, test, prod environments (e.g., application-test.properties).
• Browser Settings: Define browser type and options in config to run tests on different browsers.
• Credentials: Store sensitive data securely using environment variables or encrypted files, never hard-coded.
• JUnit Platform Properties: Use junit-platform.properties to configure test execution behavior.

Test Reporting and CI/CD Integration

• JUnit Reports: Generate XML reports automatically after test runs for CI tools.
• HTML Reports: Use plugins like Surefire or Allure to create readable HTML reports.
• CI/CD Integration: Integrate with Jenkins, GitHub Actions, or GitLab CI to run tests on every commit or pull request.
• Deterministic Test Runs: Ensure tests produce the same results every run to avoid flaky failures in CI.

Best Practices for Deterministic Tests

• Fixed Test Data: Use static or mocked data to avoid variability.
• Isolate Tests: Each test should run independently without relying on others.
• Explicit Waits: Use explicit waits to handle timing issues instead of arbitrary sleeps.
• Clean State: Reset application state before each test to avoid side effects.
• Consistent Environment: Run tests in a controlled environment with stable dependencies.

Self Check

Where in this folder structure would you add a new utility class to help mock external API responses for deterministic tests?

Key Result

Organize JUnit tests with clear layers and fixed data to ensure tests always produce the same results.

Practice

1. What does it mean for a JUnit test to be deterministic?

easy

A. It always produces the same result given the same input

B. It runs faster than other tests

C. It uses random data each time it runs

D. It depends on external services to pass

Solution

1. Step 1: Understand the meaning of deterministic

   Deterministic means something behaves the same way every time under the same conditions.

2. Step 2: Apply this to JUnit tests

   A deterministic test always gives the same result when run with the same input and environment.

3. Final Answer:

   It always produces the same result given the same input -> Option A

4. Quick Check:

   Deterministic = Same result every time [OK]

Hint: Deterministic means repeatable results every run [OK]

Common Mistakes:

• Confusing deterministic with fast execution
• Thinking random data makes tests deterministic
• Assuming external services guarantee determinism

2. Which of the following is the correct way to write a deterministic assertion in JUnit 5?

easy

A. assertNull(getRandomObject());

B. assertTrue(random.nextBoolean());

C. assertFalse(externalServiceCall());

D. assertEquals(expected, actual);

Solution

1. Step 1: Identify deterministic assertions

   Deterministic assertions compare known expected values to actual results.

2. Step 2: Check each option

   assertEquals(expected, actual); compares expected and actual values directly, which is deterministic. Options A, B, and D depend on random or external calls, which are not deterministic.

3. Final Answer:

   assertEquals(expected, actual); -> Option D

4. Quick Check:

   Deterministic assertions compare fixed expected and actual values [OK]

Hint: Use fixed expected values in assertions for determinism [OK]

Common Mistakes:

• Using random values inside assertions
• Calling external services in assertions
• Assuming assertNull is always deterministic

3. Consider this JUnit test snippet:

int result = calculator.add(2, 3);
assertEquals(5, result);

What will be the test result if the add method always returns the sum of its inputs?

medium

A. Test will fail because 2 + 3 is not 5

B. Test will pass because the result matches expected

C. Test will fail due to syntax error

D. Test will be flaky and sometimes pass

Solution

1. Step 1: Understand the add method behavior

   The add method returns the sum of inputs, so add(2, 3) returns 5.

2. Step 2: Check the assertion

   The assertion expects 5 and the actual result is 5, so the assertion passes.

3. Final Answer:

   Test will pass because the result matches expected -> Option B

4. Quick Check:

   Expected 5, got 5 = pass [OK]

Hint: If expected equals actual, test passes [OK]

Common Mistakes:

• Thinking 2 + 3 is not 5
• Assuming syntax error without checking code
• Believing test is flaky without randomness

4. This JUnit test sometimes fails:

@Test
void testRandomNumber() {
  int num = new Random().nextInt(10);
  assertTrue(num == 0);
}

What is the main reason this test is not deterministic?

medium

A. The test depends on random values causing different results

B. The test uses a new Random object each time

C. The assertion condition is incorrect

D. The test method is missing @BeforeEach annotation

Solution

1. Step 1: Identify randomness in the test

   The test generates a random number each run, so output varies.

2. Step 2: Understand impact on determinism

   Because the number changes, the test result can vary, making it non-deterministic.

3. Final Answer:

   The test depends on random values causing different results -> Option A

4. Quick Check:

   Random values cause non-determinism [OK]

Hint: Random values cause flaky tests, avoid them [OK]

Common Mistakes:

• Thinking assertion condition is wrong
• Believing new Random() fixes determinism
• Confusing test annotations with determinism

5. You want to make this test deterministic:

@Test
void testCurrentTime() {
  long time = System.currentTimeMillis();
  assertTrue(time > 0);
}

Which approach best ensures determinism?

hard

A. Remove the assertion to avoid failures

B. Add Thread.sleep(1000) before assertion

C. Replace System.currentTimeMillis() with a fixed mock time value

D. Run the test multiple times and average results

Solution

1. Step 1: Identify non-deterministic part

   System.currentTimeMillis() returns changing time, causing test to vary.

2. Step 2: Apply mocking for fixed value

   Replacing it with a fixed mock value makes the test produce the same result every run.

3. Final Answer:

   Replace System.currentTimeMillis() with a fixed mock time value -> Option C

4. Quick Check:

   Fixed mock values ensure determinism [OK]

Hint: Mock changing values to fixed ones for deterministic tests [OK]

Common Mistakes:

• Using sleep does not fix changing values
• Removing assertions hides problems, not fix determinism
• Averaging results does not guarantee same output