Test classes and naming in JUnit - Cheat Sheet & Quick Revision

Recall & Review

beginner

Why should test classes have clear and descriptive names?

Clear and descriptive test class names help quickly understand what functionality is being tested, making maintenance and debugging easier.

beginner

What is a common naming convention for JUnit test classes?

A common convention is to name the test class after the class it tests, followed by 'Test'. For example, for a class 'Calculator', the test class is 'CalculatorTest'.

intermediate

How should test methods be named inside test classes?

Test methods should have descriptive names that explain what behavior or scenario they test, often using a pattern like 'methodName_condition_expectedResult'.

intermediate

What is the benefit of grouping related tests into separate test classes?

Grouping related tests improves organization, makes tests easier to find, and helps isolate failures to specific areas of the code.

beginner

True or False: Test classes should be placed in the same package as the classes they test.

True. Placing test classes in the same package helps access package-private members and keeps tests organized alongside the code under test.

What suffix is commonly used for JUnit test classes?

A Verify

B Spec

C Check

D Test

The suffix 'Test' is the standard naming convention for JUnit test classes, e.g., 'UserServiceTest'.

Which of the following is the best test class name for testing a class named 'OrderProcessor'?

A OrderProcessorTest

B TestOrderProcessorClass

C ProcessorOrderTests

D OrderTestProcessor

The best practice is to use the class name followed by 'Test', so 'OrderProcessorTest' is clear and standard.

Why is it important to give descriptive names to test methods?

A To make test reports easier to understand

B To reduce the number of tests needed

C To make tests run faster

D To avoid writing assertions

Descriptive test method names help quickly identify what is being tested and make reports easier to read.

Where should test classes ideally be located in a Java project?

A Inside the main application package

B In the same package as the classes they test

C Only in the root source folder

D In a completely separate unrelated package

Test classes are usually placed in the same package as the classes they test to access package-private members and maintain organization.

What is a good practice when you have many tests for different features of a class?

A Put all tests in one large test class

B Write tests without any naming conventions

C Group related tests into separate test classes

D Avoid writing tests for minor features

Grouping related tests into separate classes improves clarity and maintainability.

Explain why naming test classes clearly is important and describe a common naming convention for JUnit test classes.

Think about how you find and understand tests when debugging.

Describe how you would organize test classes and test methods for a large class with many features.

Consider how to keep tests easy to read and maintain.

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