Test classes and naming in JUnit - Build an Automation Script

Verify correct naming and structure of JUnit test class

Preconditions (2)

Step 1: Create a test class named CalculatorTest in the test source folder

Step 2: Inside CalculatorTest, write a test method named testAdd that calls add(2, 3)

Step 3: Assert that the result of add(2, 3) is 5

Step 4: Run the test class using JUnit

✅ Expected Result: The test class CalculatorTest runs successfully and the testAdd method passes, confirming correct naming and structure

Automation Requirements - JUnit 5

Assertions Needed:

Assert that Calculator.add(2, 3) returns 5

Best Practices:

Test class name should be the class under test name plus 'Test' suffix

Test methods should be annotated with @Test

Use meaningful test method names

Keep test methods small and focused

Automated Solution

JUnit

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

public class CalculatorTest {

    @Test
    void testAdd() {
        Calculator calculator = new Calculator();
        int result = calculator.add(2, 3);
        assertEquals(5, result, "2 + 3 should equal 5");
    }
}

// Simple Calculator class for reference
class Calculator {
    public int add(int a, int b) {
        return a + b;
    }
}

This test class is named CalculatorTest following the convention of appending 'Test' to the class under test name.

The test method testAdd is annotated with @Test so JUnit knows to run it.

Inside the test method, we create an instance of Calculator and call the add method with inputs 2 and 3.

We use assertEquals to check that the result is 5, which is the expected sum.

This structure and naming make the test clear, focused, and easy to understand.

Common Mistakes - 4 Pitfalls

{'mistake': "Naming the test class without 'Test' suffix", 'why_bad': 'JUnit and many tools expect test classes to follow naming conventions to detect and run tests automatically.', 'correct_approach': "Name the test class as the class under test plus 'Test', e.g., CalculatorTest."}

{'mistake': 'Not annotating test methods with @Test', 'why_bad': "JUnit will not recognize methods as tests without the @Test annotation, so tests won't run.", 'correct_approach': 'Always add @Test annotation to each test method.'}

{'mistake': "Using vague test method names like 'test1' or 'check'", 'why_bad': 'Unclear names make it hard to understand what the test verifies.', 'correct_approach': 'Use descriptive names like testAdd or addTwoNumbersReturnsSum.'}

Writing multiple assertions testing different features in one test method

Bonus Challenge

Now add data-driven testing to verify add method with three different input pairs

Show Hint

Practice

1. Which of the following is the best practice for naming a JUnit test class?

easy

A. Use all uppercase letters for the class name

B. Start the class name with Test and end with Class

C. Use the suffix Test at the end of the class name

D. Name the class with random characters to avoid conflicts

Solution

1. Step 1: Understand naming conventions for test classes

   JUnit test classes should be named clearly to indicate they contain tests. The common convention is to add the suffix Test to the class name being tested.

2. Step 2: Evaluate the options

   Use the suffix Test at the end of the class name follows the standard convention by using the suffix Test. Options B, C, and D do not follow common or recommended practices.

3. Final Answer:

   Use the suffix Test at the end of the class name -> Option C

4. Quick Check:

   Test class suffix = Test [OK]

Hint: Test classes end with 'Test' suffix for clarity [OK]

Common Mistakes:

• Starting class name with 'Test' instead of suffix
• Using uppercase only names
• Using unclear or random names

2. Which of the following is a correct JUnit test class declaration in Java?

easy

A. public class calculator_test { }

B. class TestCalculator { }

C. public test class Calculator { }

D. public class CalculatorTest { }

Solution

1. Step 1: Check Java class declaration syntax

   Java classes must be declared with the keyword class and the class name should follow Java naming conventions (PascalCase). The class should be public if accessed externally.

2. Step 2: Validate each option

   public class CalculatorTest { } is syntactically correct and follows naming conventions. class TestCalculator { } misses the public modifier but is valid Java; however, the name does not end with Test. public test class Calculator { } uses an invalid keyword test. public class calculator_test { } uses underscores and lowercase which is against Java class naming conventions.

3. Final Answer:

   public class CalculatorTest { } -> Option D

4. Quick Check:

   Correct Java class syntax = public class CalculatorTest { } [OK]

Hint: Use 'public class ClassNameTest' for test classes [OK]

Common Mistakes:

• Using invalid keywords like 'test'
• Using underscores in class names
• Not using PascalCase for class names

3. Given the following test class, what will be the output when running the tests?

public class MathUtilsTest {
    @org.junit.jupiter.api.Test
    void testAdd() {
        int result = 2 + 3;
        org.junit.jupiter.api.Assertions.assertEquals(5, result);
    }

    @org.junit.jupiter.api.Test
    void testSubtract() {
        int result = 5 - 3;
        org.junit.jupiter.api.Assertions.assertEquals(1, result);
    }
}

medium

A. Both tests pass

B. One test passes, one test fails

C. Both tests fail

D. Compilation error due to missing imports

Solution

1. Step 1: Analyze the testAdd method

   The testAdd method calculates 2 + 3 = 5 and asserts it equals 5. This assertion passes.

2. Step 2: Analyze the testSubtract method

   The testSubtract method calculates 5 - 3 = 2 but asserts it equals 1. This assertion fails.

3. Final Answer:

   One test passes, one test fails -> Option B

4. Quick Check:

   Assertions: testAdd=pass, testSubtract=fail [OK]

Hint: Check assertion values carefully to spot failures [OK]

Common Mistakes:

• Assuming both tests pass without checking values
• Ignoring assertion expected vs actual values
• Confusing compilation errors with assertion failures

4. Identify the error in the following JUnit test class:

public class StringUtilsTest {
    @Test
    public void testIsEmpty() {
        boolean result = StringUtils.isEmpty("");
        assertTrue(result);
    }
}

medium

A. Missing import for @Test annotation

B. Method name should start with 'should'

C. assertTrue is not a valid assertion method

D. Class name should not end with 'Test'

Solution

1. Step 1: Check for missing imports

   The code uses @Test annotation and assertTrue method but does not show imports. Without importing org.junit.jupiter.api.Test and org.junit.jupiter.api.Assertions.assertTrue, this code will not compile.

2. Step 2: Validate other options

   Method naming conventions are flexible; starting with 'should' is not mandatory. assertTrue is a valid assertion method. Class name ending with 'Test' is correct.

3. Final Answer:

   Missing import for @Test annotation -> Option A

4. Quick Check:

   Missing imports cause compilation errors [OK]

Hint: Always import @Test and assertion methods [OK]

Common Mistakes:

• Assuming method names must start with 'should'
• Confusing assertion method names
• Ignoring missing imports causing errors

5. You have a class named OrderProcessor. Which of the following is the best name for its JUnit test class and a test method that checks if an order is processed successfully?

hard

A. Class: OrderProcessorTest, Method: testProcessOrderSuccess

B. Class: TestOrderProcessor, Method: processOrder

C. Class: OrderProcessorTests, Method: checkOrder

D. Class: OrderProcessor_Test, Method: orderSuccessTest

Solution

1. Step 1: Choose the correct test class naming

   The best practice is to name the test class by adding Test suffix to the class under test. Class: OrderProcessorTest, Method: testProcessOrderSuccess uses OrderProcessorTest, which is correct. Class: TestOrderProcessor, Method: processOrder prefixes with 'Test', which is less common. Class: OrderProcessorTests, Method: checkOrder uses plural 'Tests', which is acceptable but less standard. Class: OrderProcessor_Test, Method: orderSuccessTest uses underscore, which is not recommended.

2. Step 2: Choose the best test method name

   Test method names should describe the behavior tested clearly. Class: OrderProcessorTest, Method: testProcessOrderSuccess's testProcessOrderSuccess clearly states the test purpose. Other options are less descriptive or ambiguous.

3. Final Answer:

   Class: OrderProcessorTest, Method: testProcessOrderSuccess -> Option A

4. Quick Check:

   Test class suffix + descriptive method name = Class: OrderProcessorTest, Method: testProcessOrderSuccess [OK]

Hint: Use ClassNameTest and descriptive test method names [OK]

Common Mistakes:

• Using underscores in class names
• Using vague test method names
• Prefixing class names with 'Test' instead of suffix