Documentation Index
Fetch the complete documentation index at: https://mintlify.com/rifandani/be-monorepo/llms.txt
Use this file to discover all available pages before exploring further.
Testing
The BE Monorepo uses Bun’s built-in test runner for fast, integrated testing.
Test Setup
Test Framework
Tests use Bun’s native test APIs with a Jest-like syntax:
import { describe, expect, it } from "bun:test";
Test Location
Tests for the Hono app are located in:
apps/hono/tests/
├── llms.test.ts
├── llms-auth.test.ts
├── llms-docs.test.ts
└── util.ts
Environment Configuration
Tests run with development environment variables automatically loaded:
bun test --env-file=.env.dev
Running Tests
From Repository Root
Run tests for the Hono app:
This executes bun test in the @workspace/hono workspace with the development environment file.
From App Directory
Navigate to the app and run tests directly:
cd apps/hono
bun run test
Watch Mode
Run tests in watch mode for continuous testing during development:
cd apps/hono
bun test --watch
Filtering Tests
Run specific test files:
Run tests matching a pattern:
bun test --test-name-pattern="should return"
Test Patterns
API Endpoint Testing
Tests validate HTTP endpoints by making requests to the Hono app instance:
import { describe, expect, it } from "bun:test";
import { app } from "@/app.js";
describe("/llms.txt endpoint", () => {
it("should return the OpenAPI docs and have Server-Timing with total duration under 1s", async () => {
const res = await app.request("/llms.txt");
const text = await res.text();
const serverTiming = res.headers.get("Server-Timing");
expect(res.status).toBe(200);
expect(text).toMatch(/# Hono API - Development/);
expect(serverTiming).not.toBeNull();
});
});
Testing Utilities
Common test utilities are shared in tests/util.ts:
/**
* Parse the Server-Timing header and return the total duration
*/
export function parseServerTimingHeader(header: string | null): number | null {
const m = header?.match(/total;dur=([\d.]+)/);
return m ? Number(m[1]) : null;
}
import { parseServerTimingHeader } from "./util.js";
const serverTiming = res.headers.get("Server-Timing");
const dur = parseServerTimingHeader(serverTiming);
expect(dur).toBeLessThan(1000);
Server-Timing header:
it("should respond quickly", async () => {
const res = await app.request("/endpoint");
const serverTiming = res.headers.get("Server-Timing");
const dur = parseServerTimingHeader(serverTiming);
expect(dur).not.toBeNull();
expect(dur!).toBeLessThan(1000); // Under 1 second
});
Authentication Testing
Tests for authenticated endpoints are in tests/llms-auth.test.ts.
Documentation Testing
Tests for documentation endpoints are in tests/llms-docs.test.ts.
Test Structure
Organizing Tests
- One test file per feature/route: Keep tests focused and maintainable
- Shared utilities: Place common helpers in
tests/util.ts
- Descriptive names: Use clear
describe and it blocks
Example Test Structure
import { describe, expect, it } from "bun:test";
import { app } from "@/app.js";
describe("Feature Name", () => {
describe("GET /endpoint", () => {
it("should return success for valid request", async () => {
// Arrange
const params = { id: "123" };
// Act
const res = await app.request("/endpoint?id=123");
const json = await res.json();
// Assert
expect(res.status).toBe(200);
expect(json).toMatchObject({ success: true });
});
it("should return error for invalid request", async () => {
const res = await app.request("/endpoint");
expect(res.status).toBe(400);
});
});
});
Best Practices
Test Independence
- Each test should be independent and not rely on other tests
- Clean up resources after tests if needed
- Use fresh data for each test
Environment Variables
Tests use .env.dev for configuration. Ensure sensitive values are not committed:
# .env.dev is gitignored
bun test --env-file=.env.dev
Testing Workflow
When making changes:
- Write or update tests
- Run tests locally:
bun run hono:test
- Ensure all tests pass before committing
- CI will run tests automatically
Continuous Integration
Tests run automatically in CI as part of the lint-typecheck workflow:
bun run lint-typecheck
bun run hono:test
Debugging Tests
Verbose Output
Run tests with detailed output:
Single Test File
Focus on a specific test file:
bun test tests/llms.test.ts
Using Console Logs
Add debugging output in tests:
it("should debug issue", async () => {
const res = await app.request("/endpoint");
console.log("Response:", await res.text());
expect(res.status).toBe(200);
});
Coverage
Bun provides built-in coverage support:
This generates coverage reports showing which code paths are tested.
