Generating Apex Tests
Generate production-ready Apex test classes and run disciplined test-fix loops with coverage analysis.
Core Principles
- One behavior per method — each test method validates a single scenario. Separate positive, negative, and bulk tests. NEVER combine related-but-distinct inputs (e.g., null and empty) in one method — create
_NullInput_ and _EmptyInput_ as separate test methods
- Bulkify tests — test with 251+ records to cross the 200-record trigger batch boundary. Batch Apex exception: in test context only one
execute() invocation runs, so set batchSize >= testRecordCount. See references/async-testing.md
- Isolate test data — every
@TestSetup must delegate record creation to a TestDataFactory class. If none exists, create one first. Never build record lists inline in @TestSetup. Never rely on org data (SeeAllData=false) or hardcoded IDs. For duplicate rule handling, see references/test-data-factory.md
- Assert meaningfully — use exact expected values computed from test data setup. NEVER use range assertions or approximate counts when the value is deterministic. Always include failure messages. See references/assertion-patterns.md
- Use
Assert class only — Assert.areEqual, Assert.isTrue, Assert.fail, etc. Never use legacy System.assert, System.assertEquals, or System.assertNotEquals
- Mock external boundaries — use
HttpCalloutMock for callouts, Test.setFixedSearchResults for SOSL, DML mock classes for database isolation. Design for testability via constructor injection. See references/mocking-patterns.md
- Test negative paths — validate error handling and exception scenarios, not just happy paths
- Wrap with start/stop — pair
Test.startTest() with Test.stopTest() to reset governor limits and force async execution
Test.startTest() / Test.stopTest()
Always wrap the code under test in Test.startTest() / Test.stopTest():
- Resets governor limits so the test measures only the code under test
- Executes async operations synchronously (queueables, batch, future methods)
- Fires scheduled jobs immediately
Test Code Anti-Patterns
| Anti-Pattern |
Fix |
| SOQL/DML inside loops |
Query once before the loop; use Map<Id, SObject> for lookups |
| Magic numbers in assertions |
Derive expected values from setup constants |
| God test class (>500 lines) |
Split into multiple test classes by behavior area |
| Long test methods (>30 lines) |
Extract Given/When/Then into helper methods |
Generic Exception catch |
Catch the specific expected type (e.g., DmlException) |
Workflow
Step 1 — Gather Context
Before generating or fixing tests, identify:
- the target production class(es) under test
- existing test classes, test data factories, and setup helpers
- desired test scope (single class, specific methods, suite, or local tests)
- coverage threshold (75% minimum for deploy, 90%+ recommended)
- org alias when running tests against an org
Step 2 — Generate the Test Class
Apply the structure, naming conventions, and patterns from the asset templates and reference docs.
MANDATORY — File Deliverables: For every test class, create BOTH files:
{ClassName}Test.cls — the test class (use assets/test-class-template.cls as starting point)
{ClassName}Test.cls-meta.xml — the metadata file:
<?xml version="1.0" encoding="UTF-8"?>
<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
<apiVersion>66.0</apiVersion>
<status>Active</status>
</ApexClass>
If no TestDataFactory exists in the project, create TestDataFactory.cls + TestDataFactory.cls-meta.xml using assets/test-data-factory-template.cls.
@TestSetup Example
@TestSetup
static void setupTestData() {
List<Account> accounts = TestDataFactory.createAccounts(251, true);
}
Test Method Structure
Use Given/When/Then:
@isTest
static void shouldUpdateStatus_WhenValidInput() {
// Given
List<Account> accounts = [SELECT Id FROM Account];
// When
Test.startTest();
MyService.processAccounts(accounts);
Test.stopTest();
// Then
List<Account> updated = [SELECT Id, Status__c FROM Account];
Assert.areEqual(251, updated.size(), 'All accounts should be processed');
}
Negative Test — Exception Pattern
Use try/catch with Assert.fail to verify expected exceptions:
@isTest
static void shouldThrowException_WhenInvalidInput() {
// Given
List<Account> emptyList = new List<Account>();
// When/Then
Test.startTest();
try {
MyService.processAccounts(emptyList);
Assert.fail('Expected MyCustomException to be thrown');
} catch (MyCustomException e) {
Assert.isTrue(e.getMessage().contains('cannot be empty'),
'Exception message should indicate empty input');
}
Test.stopTest();
}
Naming Convention
should[ExpectedResult]_When[Scenario]: shouldSendNotification_WhenOpportunityClosedWon
[SubjectOrAction]_[Scenario]_[ExpectedResult]: AccountUpdate_ChangeName_Success
Step 3 — Run Tests
Start narrow when debugging; widen after the fix is stable.
# Single test class
sf apex run test --class-names MyServiceTest --result-format human --code-coverage --target-org <alias>
# Specific test methods
sf apex run test --tests MyServiceTest.shouldUpdateStatus_WhenValidInput --result-format human --target-org <alias>
# All local tests
sf apex run test --test-level RunLocalTests --result-format human --code-coverage --target-org <alias>
Step 4 — Analyze Results
Focus on:
- failing methods — exception types and stack traces
- uncovered lines and weak coverage areas
- whether failures indicate bad test data, brittle assertions, or broken production logic
Step 5 — Fix Loop
When tests fail, run a disciplined fix loop (max 3 iterations — stop and surface root cause if still failing):
- Read the failing test class and the class under test
- Identify root cause from error messages and stack traces
- Apply fix — adjust test data or assertions for test-side issues; delegate production code issues to the
platform-apex-generate skill
- Rerun the focused test before broader regression
- Repeat until all tests pass, iteration limit reached, or root cause requires design change
Step 6 — Validate Coverage
| Level |
Coverage |
Purpose |
| Production deploy |
75% minimum |
Required by Salesforce |
| Recommended |
90%+ |
Best practice target |
| Critical paths |
100% |
Business-critical code |
Cover all paths: positive, negative/exception, bulk (251+ records), callout/async.
What to Test by Component
| Component |
Key Test Scenarios |
| Trigger |
Bulk insert/update/delete, recursion guard, field change detection |
| Service |
Valid/invalid inputs, bulk operations, exception handling |
| Controller |
Page load, action methods, view state |
| Batch |
start/execute/finish, scope matching (batch size >= record count), Database.Stateful tracking, error handling, chaining (separate methods — finish() calling Database.executeBatch() throws UnexpectedException) |
| Queueable |
Chaining (only first job runs in tests), bulkification, error handling, callout mocks before Test.startTest() |
| Callout |
Success response, error response, timeout |
| Selector |
Valid/null/empty inputs, bulk (251+), field population, sort order, WITH USER_MODE via System.runAs |
| Scheduled |
Direct execution via execute(null), CRON registration via CronTrigger query |
| Platform Event |
Test.enableChangeDataCapture(), Test.getEventBus().deliver(), verify subscriber side effects |
Output Expectations
Deliverables per test class:
{ClassName}Test.cls + {ClassName}Test.cls-meta.xml (match API version of class under test; default 66.0)
TestDataFactory.cls + TestDataFactory.cls-meta.xml (if not already present)
Reference Files
Load on demand for detailed patterns:
| Reference |
When to use |
| references/test-data-factory.md |
TestDataFactory patterns, field overrides, duplicate rule handling |
| references/assertion-patterns.md |
Assertion best practices, anti-patterns, common pitfalls |
| references/mocking-patterns.md |
HttpCalloutMock, DML mocking, StubProvider, SOSL, Email, Platform Events |
| references/async-testing.md |
Batch, Queueable, Future, Scheduled job testing |
1---2name: platform-apex-test-generate3description: Generate and validate Apex test classes with TestDataFactory patterns, bulk testing (251+ records), mocking strategies, assertion best practices, and disciplined test-fix loops. Use this skill when creating new Apex test classes, improving test coverage, debugging and fixing failing Apex tests, running test execution and coverage analysis, or implementing testing patterns for triggers, services, controllers, batch jobs, queueables, and integrations. Triggers on *Test.cls, *_Test.cls files, sf apex run test workflows, coverage reports, test-fix loops. Do NOT trigger for production Apex code (use platform-apex-generate) or Jest/LWC tests.4---56# Generating Apex Tests78Generate production-ready Apex test classes and run disciplined test-fix loops with coverage analysis.910## Core Principles11121. **One behavior per method** — each test method validates a single scenario. Separate positive, negative, and bulk tests. NEVER combine related-but-distinct inputs (e.g., null and empty) in one method — create `_NullInput_` and `_EmptyInput_` as separate test methods132. **Bulkify tests** — test with 251+ records to cross the 200-record trigger batch boundary. **Batch Apex exception:** in test context only one `execute()` invocation runs, so set `batchSize >= testRecordCount`. See [references/async-testing.md](references/async-testing.md)143. **Isolate test data** — every `@TestSetup` must delegate record creation to a `TestDataFactory` class. If none exists, create one first. Never build record lists inline in `@TestSetup`. Never rely on org data (`SeeAllData=false`) or hardcoded IDs. For duplicate rule handling, see [references/test-data-factory.md](references/test-data-factory.md)154. **Assert meaningfully** — use exact expected values computed from test data setup. NEVER use range assertions or approximate counts when the value is deterministic. Always include failure messages. See [references/assertion-patterns.md](references/assertion-patterns.md)165. **Use `Assert` class only** — `Assert.areEqual`, `Assert.isTrue`, `Assert.fail`, etc. Never use legacy `System.assert`, `System.assertEquals`, or `System.assertNotEquals`176. **Mock external boundaries** — use `HttpCalloutMock` for callouts, `Test.setFixedSearchResults` for SOSL, DML mock classes for database isolation. Design for testability via constructor injection. See [references/mocking-patterns.md](references/mocking-patterns.md)187. **Test negative paths** — validate error handling and exception scenarios, not just happy paths198. **Wrap with start/stop** — pair `Test.startTest()` with `Test.stopTest()` to reset governor limits and force async execution2021## Test.startTest() / Test.stopTest()2223Always wrap the code under test in `Test.startTest()` / `Test.stopTest()`:2425- Resets governor limits so the test measures only the code under test26- Executes async operations synchronously (queueables, batch, future methods)27- Fires scheduled jobs immediately2829## Test Code Anti-Patterns3031| Anti-Pattern | Fix |32|---|---|33| SOQL/DML inside loops | Query once before the loop; use `Map<Id, SObject>` for lookups |34| Magic numbers in assertions | Derive expected values from setup constants |35| God test class (>500 lines) | Split into multiple test classes by behavior area |36| Long test methods (>30 lines) | Extract Given/When/Then into helper methods |37| Generic `Exception` catch | Catch the specific expected type (e.g., `DmlException`) |3839## Workflow4041### Step 1 — Gather Context4243Before generating or fixing tests, identify:4445- the target production class(es) under test46- existing test classes, test data factories, and setup helpers47- desired test scope (single class, specific methods, suite, or local tests)48- coverage threshold (75% minimum for deploy, 90%+ recommended)49- org alias when running tests against an org5051### Step 2 — Generate the Test Class5253Apply the structure, naming conventions, and patterns from the asset templates and reference docs.5455**MANDATORY — File Deliverables:** For every test class, create BOTH files:561. `{ClassName}Test.cls` — the test class (use [assets/test-class-template.cls](assets/test-class-template.cls) as starting point)572. `{ClassName}Test.cls-meta.xml` — the metadata file:5859```xml60<?xml version="1.0" encoding="UTF-8"?>61<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">62 <apiVersion>66.0</apiVersion>63 <status>Active</status>64</ApexClass>65```6667If no `TestDataFactory` exists in the project, create `TestDataFactory.cls` + `TestDataFactory.cls-meta.xml` using [assets/test-data-factory-template.cls](assets/test-data-factory-template.cls).6869#### @TestSetup Example7071```apex72@TestSetup73static void setupTestData() {74 List<Account> accounts = TestDataFactory.createAccounts(251, true);75}76```7778#### Test Method Structure7980Use Given/When/Then:8182```apex83@isTest84static void shouldUpdateStatus_WhenValidInput() {85 // Given86 List<Account> accounts = [SELECT Id FROM Account];8788 // When89 Test.startTest();90 MyService.processAccounts(accounts);91 Test.stopTest();9293 // Then94 List<Account> updated = [SELECT Id, Status__c FROM Account];95 Assert.areEqual(251, updated.size(), 'All accounts should be processed');96}97```9899#### Negative Test — Exception Pattern100101Use try/catch with `Assert.fail` to verify expected exceptions:102103```apex104@isTest105static void shouldThrowException_WhenInvalidInput() {106 // Given107 List<Account> emptyList = new List<Account>();108109 // When/Then110 Test.startTest();111 try {112 MyService.processAccounts(emptyList);113 Assert.fail('Expected MyCustomException to be thrown');114 } catch (MyCustomException e) {115 Assert.isTrue(e.getMessage().contains('cannot be empty'),116 'Exception message should indicate empty input');117 }118 Test.stopTest();119}120```121122#### Naming Convention123124- `should[ExpectedResult]_When[Scenario]`: `shouldSendNotification_WhenOpportunityClosedWon`125- `[SubjectOrAction]_[Scenario]_[ExpectedResult]`: `AccountUpdate_ChangeName_Success`126127### Step 3 — Run Tests128129Start narrow when debugging; widen after the fix is stable.130131```bash132# Single test class133sf apex run test --class-names MyServiceTest --result-format human --code-coverage --target-org <alias>134135# Specific test methods136sf apex run test --tests MyServiceTest.shouldUpdateStatus_WhenValidInput --result-format human --target-org <alias>137138# All local tests139sf apex run test --test-level RunLocalTests --result-format human --code-coverage --target-org <alias>140```141142### Step 4 — Analyze Results143144Focus on:145146- failing methods — exception types and stack traces147- uncovered lines and weak coverage areas148- whether failures indicate bad test data, brittle assertions, or broken production logic149150### Step 5 — Fix Loop151152When tests fail, run a disciplined fix loop (max 3 iterations — stop and surface root cause if still failing):1531541. Read the failing test class and the class under test1552. Identify root cause from error messages and stack traces1563. Apply fix — adjust test data or assertions for test-side issues; delegate production code issues to the `platform-apex-generate` skill1574. Rerun the focused test before broader regression1585. Repeat until all tests pass, iteration limit reached, or root cause requires design change159160### Step 6 — Validate Coverage161162| Level | Coverage | Purpose |163|-------|----------|---------|164| Production deploy | 75% minimum | Required by Salesforce |165| Recommended | 90%+ | Best practice target |166| Critical paths | 100% | Business-critical code |167168Cover all paths: positive, negative/exception, bulk (251+ records), callout/async.169170## What to Test by Component171172| Component | Key Test Scenarios |173|-----------|-------------------|174| Trigger | Bulk insert/update/delete, recursion guard, field change detection |175| Service | Valid/invalid inputs, bulk operations, exception handling |176| Controller | Page load, action methods, view state |177| Batch | start/execute/finish, scope matching (batch size >= record count), `Database.Stateful` tracking, error handling, chaining (separate methods — `finish()` calling `Database.executeBatch()` throws `UnexpectedException`) |178| Queueable | Chaining (only first job runs in tests), bulkification, error handling, callout mocks before `Test.startTest()` |179| Callout | Success response, error response, timeout |180| Selector | Valid/null/empty inputs, bulk (251+), field population, sort order, `WITH USER_MODE` via `System.runAs` |181| Scheduled | Direct execution via `execute(null)`, CRON registration via `CronTrigger` query |182| Platform Event | `Test.enableChangeDataCapture()`, `Test.getEventBus().deliver()`, verify subscriber side effects |183184## Output Expectations185186Deliverables per test class:187- `{ClassName}Test.cls` + `{ClassName}Test.cls-meta.xml` (match API version of class under test; default `66.0`)188- `TestDataFactory.cls` + `TestDataFactory.cls-meta.xml` (if not already present)189190## Reference Files191192Load on demand for detailed patterns:193194| Reference | When to use |195|-----------|-------------|196| [references/test-data-factory.md](references/test-data-factory.md) | TestDataFactory patterns, field overrides, duplicate rule handling |197| [references/assertion-patterns.md](references/assertion-patterns.md) | Assertion best practices, anti-patterns, common pitfalls |198| [references/mocking-patterns.md](references/mocking-patterns.md) | HttpCalloutMock, DML mocking, StubProvider, SOSL, Email, Platform Events |199| [references/async-testing.md](references/async-testing.md) | Batch, Queueable, Future, Scheduled job testing |