testing

Testing Rules

Testing Principles

What to Test

ALWAYS test:

• ✅ Helper/utility functions (in Utils/)
• ✅ Pure functions (no side effects)
• ✅ Complex calculation logic
• ✅ Validations and edge cases
• ✅ Critical gameplay functions

Don't need to test:

• ❌ Simple Getters/Setters
• ❌ Simple wrappers of Unreal API
• ❌ Automatically generated code

Test Structure (AAA Pattern)

Arrange - Prepare data and context Act - Execute the function being tested Assert - Verify the result

TEST(ComponentHelpers, FindCharacterDataComponent_WithValidOwner_ReturnsComponent)
{
    // Arrange
    AActor* TestActor = NewObject<AActor>();
    UCharacterDataComponent* ExpectedComponent = NewObject<UCharacterDataComponent>(TestActor);
    TestActor->AddComponent(ExpectedComponent);

    // Act
    UCharacterDataComponent* Result = ComponentHelpers::FindCharacterDataComponent(TestActor);

    // Assert
    EXPECT_NE(Result, nullptr);
    EXPECT_EQ(Result, ExpectedComponent);
}

Test Naming

Format

TEST(<TestSuite>, <TestName>)

TestSuite

Name of the class/function being tested:

• ComponentHelpers - For ComponentHelpers namespace functions
• CharacterSheetComponent - For class methods
• CharacterDataComponent - For class methods

TestName

Format: <Scenario>_<Condition>_<ExpectedResult>

Examples:

• FindCharacterDataComponent_WithValidOwner_ReturnsComponent
• FindCharacterDataComponent_WithNullOwner_ReturnsNullptr
• FindCharacterDataComponent_WithoutComponent_ReturnsNullptr
• CalculateFinalAttributes_WithBaseAttributes_CalculatesCorrectly

Mandatory Test Cases

For Helper Functions

ALWAYS test:

1. Valid case/happy path

   TEST(ComponentHelpers, FindCharacterDataComponent_WithValidOwner_ReturnsComponent)
   

2. Nullptr/null input

   TEST(ComponentHelpers, FindCharacterDataComponent_WithNullOwner_ReturnsNullptr)
   

3. Not found case

   TEST(ComponentHelpers, FindCharacterDataComponent_WithoutComponent_ReturnsNullptr)