Naming Test Methods (Given/When/Then)

TL;DR

Explanation

Good test naming patterns: (1) Given/When/Then: givenExpiredToken_whenValidating_thenThrowsException. (2) Should: shouldThrowWhenTokenExpired. (3) Behaviour description: calculatesDiscountForPremiumUsers. Bad patterns: test1, testMethod, testCalculate. PHPUnit: method name is the test name in output. Use @test annotation or prefix test. Name should read as a specification — failing tests produce meaningful error messages. The name should say what the test verifies, not how. BDD frameworks (Behat, Pest) formalise this with descriptive strings.

Common Misconception

Why It Matters

Common Mistakes

• Using generic names: test1, testMethod, testSuccess.
• Naming after implementation: testCallsDiscountService instead of testAppliesDiscountForPremiumUsers.
• Not including the expected outcome in the name.

Code Examples

public function testCalculate(): void { }
public function testCalculate2(): void { }
public function testUserService(): void { }

// PHPUnit:
public function test_givenPremiumUser_whenCalculatingTotal_appliesDiscount(): void {}
public function test_givenExpiredCoupon_whenCheckingOut_throwsException(): void {}

// Pest:
it('applies discount for premium users', function() {});
it('throws when coupon is expired', function() {});

References

• ↗ https://phpunit.de/documentation.html

Tags

Related Terms