| name | tdd-workflow |
| description | Use this skill when writing new features, fixing bugs, or refactoring code. Enforces test-driven development with 80%+ coverage including unit, integration, and E2E tests. Supports TypeScript (Jest/Vitest/Playwright) and Kotlin (Kotest/MockK/Spring Boot Test). |
Test-Driven Development Workflow
This skill ensures all code development follows TDD principles with comprehensive test coverage.
When to Activate
- Writing new features or functionality
- Fixing bugs or issues
- Refactoring existing code
- Adding API endpoints
- Creating new components
Core Principles
1. Tests BEFORE Code
ALWAYS write tests first, then implement code to make tests pass.
2. Coverage Requirements
- Minimum 80% coverage (unit + integration + E2E)
- All edge cases covered
- Error scenarios tested
- Boundary conditions verified
3. Test Types
Unit Tests
- Individual functions and utilities
- Component logic
- Pure functions
- Helpers and utilities
Integration Tests
- API endpoints
- Database operations
- Service interactions
- External API calls
E2E Tests (Playwright)
- Critical user flows
- Complete workflows
- Browser automation
- UI interactions
Kotlin-Specific Test Types
| Test Style | Framework | Use Case |
|---|
BehaviorSpec | Kotest | Given/When/Then BDD-style tests |
FunSpec | Kotest | Simple function-level unit tests |
StringSpec | Kotest | One-liner concise tests |
@WebMvcTest | Spring Boot Test | Controller layer tests (MockMvc) |
@SpringBootTest | Spring Boot Test | Full integration tests (TestRestTemplate) |
@DataJpaTest | Spring Boot Test | Repository/JPA layer tests |
TDD Workflow Steps
Step 1: Write User Journeys
As a [role], I want to [action], so that [benefit]
Example:
As a user, I want to search for markets semantically,
so that I can find relevant markets even without exact keywords.
Step 2: Generate Test Cases
For each user journey, create comprehensive test cases:
describe('Semantic Search', () => {
it('returns relevant markets for query', async () => {
})
it('handles empty query gracefully', async () => {
})
it('falls back to substring search when Redis unavailable', async () => {
})
it('sorts results by similarity score', async () => {
})
})
Step 3: Run Tests (They Should Fail)
npm test
Step 4: Implement Code
Write minimal code to make tests pass:
export async function searchMarkets(query: string) {
}
Step 5: Run Tests Again
npm test
Step 6: Refactor
Improve code quality while keeping tests green:
- Remove duplication
- Improve naming
- Optimize performance
- Enhance readability
Step 7: Verify Coverage
npm run test:coverage
Kotlin TDD Workflow Steps
Step 1: Define Data Classes and Interfaces
data class MarketData(
val totalVolume: Double,
val bidAskSpread: Double,
val activeTraders: Int,
val lastTradeTime: java.time.Instant
)
interface LiquidityService {
fun calculate(marketId: Long): Double
}
Step 2: Write Failing Test (RED)
import io.kotest.core.spec.style.BehaviorSpec
import io.kotest.matchers.doubles.shouldBeGreaterThan
import io.kotest.matchers.shouldBe
import io.mockk.*
class LiquidityServiceTest : BehaviorSpec({
val repository = mockk<MarketRepository>()
val service = LiquidityServiceImpl(repository)
Given("a highly liquid market") {
every { repository.findById(1L) } returns Optional.of(
MarketEntity(id = 1L, totalVolume = 100_000.0, bidAskSpread = 0.01, activeTraders = 500)
)
When("calculating liquidity score") {
val score = service.calculate(1L)
Then("score should be above 80") {
score shouldBeGreaterThan 80.0
}
}
}
Given("a market with zero volume") {
every { repository.findById(2L) } returns Optional.of(
MarketEntity(id = 2L, totalVolume = 0.0, bidAskSpread = 0.0, activeTraders = 0)
)
When("calculating liquidity score") {
val score = service.calculate(2L)
Then("score should be zero") {
score shouldBe 0.0
}
}
}
})
Step 3: Run Tests (They Should Fail)
./gradlew test
Step 4: Implement Code (GREEN)
@Service
class LiquidityServiceImpl(
private val repository: MarketRepository
) : LiquidityService {
override fun calculate(marketId: Long): Double {
val market = repository.findById(marketId)
.orElseThrow { IllegalArgumentException("Market not found: $marketId") }
if (market.totalVolume == 0.0) return 0.0
val volumeScore = (market.totalVolume / 1000.0).coerceAtMost(100.0)
val spreadScore = (100.0 - market.bidAskSpread * 1000.0).coerceIn(0.0, 100.0)
val traderScore = (market.activeTraders / 10.0).coerceAtMost(100.0)
return (volumeScore * 0.4 + spreadScore * 0.3 + traderScore * 0.3)
.coerceIn(0.0, 100.0)
}
}
Step 5: Run Tests Again (PASS)
./gradlew test
Step 6: Refactor
@Service
class LiquidityServiceImpl(
private val repository: MarketRepository
) : LiquidityService {
companion object {
private const val VOLUME_SCALE = 1000.0
private const val SPREAD_SCALE = 1000.0
private const val TRADER_SCALE = 10.0
private const val MAX_SCORE = 100.0
}
override fun calculate(marketId: Long): Double {
val market = repository.findById(marketId)
.orElseThrow { IllegalArgumentException("Market not found: $marketId") }
if (market.totalVolume == 0.0) return 0.0
return weightedScore(
volumeScore = (market.totalVolume / VOLUME_SCALE).coerceAtMost(MAX_SCORE),
spreadScore = (MAX_SCORE - market.bidAskSpread * SPREAD_SCALE).coerceIn(0.0, MAX_SCORE),
traderScore = (market.activeTraders / TRADER_SCALE).coerceAtMost(MAX_SCORE)
)
}
private fun weightedScore(volumeScore: Double, spreadScore: Double, traderScore: Double): Double =
(volumeScore * 0.4 + spreadScore * 0.3 + traderScore * 0.3).coerceIn(0.0, MAX_SCORE)
}
Step 7: Verify Coverage
./gradlew test jacocoTestReport
Testing Patterns
Kotlin Unit Test Pattern (BehaviorSpec + MockK)
import io.kotest.core.spec.style.BehaviorSpec
import io.kotest.matchers.doubles.shouldBeGreaterThan
import io.kotest.matchers.doubles.shouldBeLessThan
import io.kotest.matchers.shouldBe
import io.mockk.*
class LiquidityServiceBehaviorTest : BehaviorSpec({
val repository = mockk<MarketRepository>()
val service = LiquidityServiceImpl(repository)
beforeEach { clearAllMocks() }
Given("a highly liquid market") {
val market = MarketEntity(
id = 1L, totalVolume = 100_000.0,
bidAskSpread = 0.01, activeTraders = 500
)
every { repository.findById(1L) } returns Optional.of(market)
When("calculating liquidity score") {
val score = service.calculate(1L)
Then("score should be above 80") {
score shouldBeGreaterThan 80.0
}
Then("repository should be called once") {
verify(exactly = 1) { repository.findById(1L) }
}
}
}
Given("a market with zero volume") {
val market = MarketEntity(
id = 2L, totalVolume = 0.0,
bidAskSpread = 0.0, activeTraders = 0
)
every { repository.findById(2L) } returns Optional.of(market)
When("calculating liquidity score") {
val score = service.calculate(2L)
Then("score should be zero") {
score shouldBe 0.0
}
}
}
})
Kotlin Unit Test Pattern (FunSpec)
import io.kotest.core.spec.style.FunSpec
import io.kotest.matchers.shouldBe
import io.kotest.matchers.doubles.shouldBeGreaterThan
class LiquidityCalculatorTest : FunSpec({
test("returns high score for liquid market") {
val data = MarketData(
totalVolume = 100_000.0,
bidAskSpread = 0.01,
activeTraders = 500,
lastTradeTime = java.time.Instant.now()
)
val score = LiquidityCalculator.calculate(data)
score shouldBeGreaterThan 80.0
}
test("returns 0 for zero volume market") {
val data = MarketData(
totalVolume = 0.0,
bidAskSpread = 0.0,
activeTraders = 0,
lastTradeTime = java.time.Instant.now()
)
LiquidityCalculator.calculate(data) shouldBe 0.0
}
test("clamps score between 0 and 100") {
val extremeData = MarketData(
totalVolume = 999_999_999.0,
bidAskSpread = 0.0001,
activeTraders = 10_000,
lastTradeTime = java.time.Instant.now()
)
val score = LiquidityCalculator.calculate(extremeData)
score shouldBe 100.0
}
})
Unit Test Pattern (Jest/Vitest)
import { render, screen, fireEvent } from '@testing-library/react'
import { Button } from './Button'
describe('Button Component', () => {
it('renders with correct text', () => {
render(<Button>Click me</Button>)
expect(screen.getByText('Click me')).toBeInTheDocument()
})
it('calls onClick when clicked', () => {
const handleClick = jest.fn()
render(<Button onClick={handleClick}>Click</Button>)
fireEvent.click(screen.getByRole('button'))
expect(handleClick).toHaveBeenCalledTimes(1)
})
it('is disabled when disabled prop is true', () => {
render(<Button disabled>Click</Button>)
expect(screen.getByRole('button')).toBeDisabled()
})
})
API Integration Test Pattern
import { NextRequest } from 'next/server'
import { GET } from './route'
describe('GET /api/markets', () => {
it('returns markets successfully', async () => {
const request = new NextRequest('http://localhost/api/markets')
const response = await GET(request)
const data = await response.json()
expect(response.status).toBe(200)
expect(data.success).toBe(true)
expect(Array.isArray(data.data)).toBe(true)
})
it('validates query parameters', async () => {
const request = new NextRequest('http://localhost/api/markets?limit=invalid')
const response = await GET(request)
expect(response.status).toBe(400)
})
it('handles database errors gracefully', async () => {
const request = new NextRequest('http://localhost/api/markets')
})
})
Kotlin Controller Test (@WebMvcTest)
import org.springframework.beans.factory.annotation.Autowired
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest
import org.springframework.test.web.servlet.MockMvc
import org.springframework.test.web.servlet.get
import org.springframework.test.web.servlet.post
import com.ninjasquad.springmockk.MockkBean
import io.mockk.every
@WebMvcTest(MarketController::class)
class MarketControllerTest @Autowired constructor(
val mockMvc: MockMvc
) {
@MockkBean lateinit var marketService: MarketService
@Test
fun `GET markets returns 200 with list`() {
every { marketService.findAll() } returns listOf(
MarketDto(id = 1, name = "Election 2024", score = 92.0),
MarketDto(id = 2, name = "Super Bowl", score = 78.0)
)
mockMvc.get("/api/markets")
.andExpect {
status { isOk() }
jsonPath("$.size()") { value(2) }
jsonPath("$[0].name") { value("Election 2024") }
}
}
@Test
fun `GET market by id returns 404 when not found`() {
every { marketService.findById(999) } returns null
mockMvc.get("/api/markets/999")
.andExpect {
status { isNotFound() }
}
}
@Test
fun `POST market with invalid body returns 400`() {
mockMvc.post("/api/markets") {
contentType = org.springframework.http.MediaType.APPLICATION_JSON
content = """{"name": ""}"""
}.andExpect {
status { isBadRequest() }
}
}
}
Kotlin Full Integration Test (@SpringBootTest)
import org.springframework.boot.test.context.SpringBootTest
import org.springframework.boot.test.web.client.TestRestTemplate
import org.springframework.boot.test.web.client.getForEntity
import org.springframework.http.HttpStatus
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
class MarketFlowIntegrationTest @Autowired constructor(
val restTemplate: TestRestTemplate
) {
@Test
fun `full market lifecycle - create, read, update, delete`() {
val createResponse = restTemplate.postForEntity(
"/api/markets",
CreateMarketRequest(name = "Test Market", description = "E2E test"),
MarketDto::class.java
)
createResponse.statusCode shouldBe HttpStatus.CREATED
val marketId = createResponse.body!!.id
val getResponse = restTemplate.getForEntity<MarketDto>("/api/markets/$marketId")
getResponse.statusCode shouldBe HttpStatus.OK
getResponse.body!!.name shouldBe "Test Market"
restTemplate.put("/api/markets/$marketId",
UpdateMarketRequest(name = "Updated Market"))
val updated = restTemplate.getForEntity<MarketDto>("/api/markets/$marketId")
updated.body!!.name shouldBe "Updated Market"
restTemplate.delete("/api/markets/$marketId")
val deleted = restTemplate.getForEntity<MarketDto>("/api/markets/$marketId")
deleted.statusCode shouldBe HttpStatus.NOT_FOUND
}
}
E2E Test Pattern (Playwright)
import { test, expect } from '@playwright/test'
test('user can search and filter markets', async ({ page }) => {
await page.goto('/')
await page.click('a[href="/markets"]')
await expect(page.locator('h1')).toContainText('Markets')
await page.fill('input[placeholder="Search markets"]', 'election')
await page.waitForTimeout(600)
const results = page.locator('[data-testid="market-card"]')
await expect(results).toHaveCount(5, { timeout: 5000 })
const firstResult = results.first()
await expect(firstResult).toContainText('election', { ignoreCase: true })
await page.click('button:has-text("Active")')
await expect(results).toHaveCount(3)
})
test('user can create a new market', async ({ page }) => {
await page.goto('/creator-dashboard')
await page.fill('input[name="name"]', 'Test Market')
await page.fill('textarea[name="description"]', 'Test description')
await page.fill('input[name="endDate"]', '2025-12-31')
await page.click('button[type="submit"]')
await expect(page.locator('text=Market created successfully')).toBeVisible()
await expect(page).toHaveURL(/\/markets\/test-market/)
})
Kotlin Test File Organization
project-root/
├── build.gradle.kts
├── src/
│ ├── main/kotlin/com/example/
│ │ ├── controller/
│ │ │ └── MarketController.kt
│ │ ├── service/
│ │ │ ├── LiquidityService.kt # Interface
│ │ │ └── LiquidityServiceImpl.kt # Implementation
│ │ ├── repository/
│ │ │ └── MarketRepository.kt
│ │ └── model/
│ │ ├── MarketData.kt # Data class
│ │ └── MarketEntity.kt
│ └── test/kotlin/com/example/
│ ├── unit/
│ │ └── service/
│ │ └── LiquidityServiceTest.kt # Kotest FunSpec/BehaviorSpec
│ ├── integration/
│ │ ├── controller/
│ │ │ └── MarketControllerTest.kt # @WebMvcTest
│ │ └── repository/
│ │ └── MarketRepositoryTest.kt # @DataJpaTest
│ └── e2e/
│ └── MarketFlowTest.kt # @SpringBootTest + TestRestTemplate
Test File Organization
src/
├── components/
│ ├── Button/
│ │ ├── Button.tsx
│ │ ├── Button.test.tsx # Unit tests
│ │ └── Button.stories.tsx # Storybook
│ └── MarketCard/
│ ├── MarketCard.tsx
│ └── MarketCard.test.tsx
├── app/
│ └── api/
│ └── markets/
│ ├── route.ts
│ └── route.test.ts # Integration tests
└── e2e/
├── markets.spec.ts # E2E tests
├── trading.spec.ts
└── auth.spec.ts
Kotlin Mocking with MockK
Service Mock
import io.mockk.*
class LiquidityServiceTest : FunSpec({
val repository = mockk<MarketRepository>()
val service = LiquidityServiceImpl(repository)
beforeEach { clearAllMocks() }
test("calculate returns weighted score") {
every { repository.findById(1L) } returns Optional.of(
MarketEntity(id = 1L, totalVolume = 100_000.0, bidAskSpread = 0.01)
)
val score = service.calculate(1L)
score shouldBeGreaterThan 80.0
verify(exactly = 1) { repository.findById(1L) }
confirmVerified(repository)
}
})
Coroutine Mock
import io.mockk.coEvery
import io.mockk.coVerify
class AsyncServiceTest : FunSpec({
val client = mockk<WebClient>()
test("fetches market data asynchronously") {
coEvery { client.fetchMarketData("BTC") } returns MarketData(
symbol = "BTC", price = 50000.0
)
val result = client.fetchMarketData("BTC")
result.symbol shouldBe "BTC"
coVerify { client.fetchMarketData("BTC") }
}
})
SpringMockK (@MockkBean)
import com.ninjasquad.springmockk.MockkBean
@WebMvcTest(MarketController::class)
class MarketControllerMockTest {
@Autowired lateinit var mockMvc: MockMvc
@MockkBean lateinit var marketService: MarketService
@Test
fun `returns market by id`() {
every { marketService.findById(1L) } returns MarketDto(
id = 1L, name = "Test Market", score = 85.0
)
mockMvc.get("/api/markets/1")
.andExpect {
status { isOk() }
jsonPath("$.name") { value("Test Market") }
}
verify { marketService.findById(1L) }
}
}
Mocking External Services
Supabase Mock
jest.mock('@/lib/supabase', () => ({
supabase: {
from: jest.fn(() => ({
select: jest.fn(() => ({
eq: jest.fn(() => Promise.resolve({
data: [{ id: 1, name: 'Test Market' }],
error: null
}))
}))
}))
}
}))
Redis Mock
jest.mock('@/lib/redis', () => ({
searchMarketsByVector: jest.fn(() => Promise.resolve([
{ slug: 'test-market', similarity_score: 0.95 }
])),
checkRedisHealth: jest.fn(() => Promise.resolve({ connected: true }))
}))
OpenAI Mock
jest.mock('@/lib/openai', () => ({
generateEmbedding: jest.fn(() => Promise.resolve(
new Array(1536).fill(0.1)
))
}))
Test Coverage Verification
Run Coverage Report
npm run test:coverage
Coverage Thresholds
{
"jest": {
"coverageThresholds": {
"global": {
"branches": 80,
"functions": 80,
"lines": 80,
"statements": 80
}
}
}
}
Kotlin Coverage (JaCoCo)
Run JaCoCo Coverage Report
./gradlew test jacocoTestReport
build.gradle.kts — JaCoCo Configuration
plugins {
jacoco
}
jacoco {
toolVersion = "0.8.11"
}
tasks.jacocoTestReport {
dependsOn(tasks.test)
reports {
xml.required.set(true)
html.required.set(true)
}
}
tasks.jacocoTestCoverageVerification {
violationRules {
rule {
limit {
minimum = "0.80".toBigDecimal()
}
}
rule {
element = "CLASS"
includes = listOf("com.example.service.*")
limit {
counter = "BRANCH"
minimum = "0.80".toBigDecimal()
}
}
}
}
Kotlin Test Dependencies (build.gradle.kts)
dependencies {
testImplementation("io.kotest:kotest-runner-junit5:5.8.0")
testImplementation("io.kotest:kotest-assertions-core:5.8.0")
testImplementation("io.kotest.extensions:kotest-extensions-spring:1.1.3")
testImplementation("io.mockk:mockk:1.13.9")
testImplementation("com.ninja-squad:springmockk:4.0.2")
testImplementation("org.springframework.boot:spring-boot-starter-test") {
exclude(group = "org.mockito")
}
}
tasks.withType<Test> {
useJUnitPlatform()
}
Kotlin Testing Mistakes to Avoid
❌ WRONG: Using Mockito Instead of MockK
@Mock lateinit var service: LiquidityService
✅ CORRECT: Use MockK for Kotlin
val service = mockk<LiquidityService>()
❌ WRONG: @SpringBootTest for Every Test
@SpringBootTest
class SimpleUtilTest { }
✅ CORRECT: Use Appropriate Test Slice
class SimpleUtilTest : FunSpec({ })
@WebMvcTest(MarketController::class)
class MarketControllerTest { }
@DataJpaTest
class MarketRepositoryTest { }
❌ WRONG: Not Cleaning Up MockK State
every { service.calculate(any()) } returns 95.0
✅ CORRECT: Use clearAllMocks or confirmVerified
afterEach {
clearAllMocks()
}
Common Testing Mistakes to Avoid
❌ WRONG: Testing Implementation Details
expect(component.state.count).toBe(5)
✅ CORRECT: Test User-Visible Behavior
expect(screen.getByText('Count: 5')).toBeInTheDocument()
❌ WRONG: Brittle Selectors
await page.click('.css-class-xyz')
✅ CORRECT: Semantic Selectors
await page.click('button:has-text("Submit")')
await page.click('[data-testid="submit-button"]')
❌ WRONG: No Test Isolation
test('creates user', () => { })
test('updates same user', () => { })
✅ CORRECT: Independent Tests
test('creates user', () => {
const user = createTestUser()
})
test('updates user', () => {
const user = createTestUser()
})
Continuous Testing
Watch Mode During Development
npm test -- --watch
Pre-Commit Hook
npm test && npm run lint
CI/CD Integration
- name: Run Tests
run: npm test -- --coverage
- name: Upload Coverage
uses: codecov/codecov-action@v3
Kotlin Continuous Testing
./gradlew test --continuous
./gradlew test --tests "com.example.service.LiquidityServiceTest"
./gradlew test --tests "*Liquidity*"
./gradlew ktlintCheck test
Kotlin CI/CD Integration (GitHub Actions)
name: Kotlin Tests
on: [push, pull_request]
jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-java@v4
with:
distribution: 'temurin'
java-version: '21'
- name: Run tests with coverage
run: ./gradlew test jacocoTestReport
- name: Check coverage threshold
run: ./gradlew jacocoTestCoverageVerification
- name: Upload coverage
uses: codecov/codecov-action@v4
with:
files: build/reports/jacoco/test/jacocoTestReport.xml
Best Practices
- Write Tests First - Always TDD
- One Assert Per Test - Focus on single behavior
- Descriptive Test Names - Explain what's tested
- Arrange-Act-Assert - Clear test structure
- Mock External Dependencies - Isolate unit tests
- Test Edge Cases - Null, undefined, empty, large
- Test Error Paths - Not just happy paths
- Keep Tests Fast - Unit tests < 50ms each
- Clean Up After Tests - No side effects
- Review Coverage Reports - Identify gaps
Success Metrics
- 80%+ code coverage achieved
- All tests passing (green)
- No skipped or disabled tests
- Fast test execution (< 30s for unit tests)
- E2E tests cover critical user flows
- Tests catch bugs before production
Remember: Tests are not optional. They are the safety net that enables confident refactoring, rapid development, and production reliability.