Enforce API key and backend check in SDK e2e tests

Author: brandonkachen

sdk/e2e/README.md

@@ -96,26 +96,24 @@ bun run test:e2e && bun run test:integration && bun run test:unit:e2e
 ## Prerequisites
 
 - **API Key**: Set `CODEBUFF_API_KEY` environment variable for E2E and integration tests
-- Tests skip gracefully if API key is not set
+- Tests require the API key and will fail fast if it is not set.
 
 ## Writing Tests
 
 ### E2E Test Pattern
 ```typescript
 import { describe, test, expect, beforeAll } from 'bun:test'
 import { CodebuffClient } from '../../src/client'
-import { EventCollector, getApiKey, skipIfNoApiKey, isAuthError, DEFAULT_AGENT, DEFAULT_TIMEOUT } from '../utils'
+import { EventCollector, getApiKey, isAuthError, DEFAULT_AGENT, DEFAULT_TIMEOUT } from '../utils'
 
 describe('E2E: My Test', () => {
   let client: CodebuffClient
 
   beforeAll(() => {
-    if (skipIfNoApiKey()) return
     client = new CodebuffClient({ apiKey: getApiKey() })
   })
 
   test('does something', async () => {
-    if (skipIfNoApiKey()) return
     const collector = new EventCollector()
 
     const result = await client.run({

sdk/e2e/custom-agents/api-integration-agent.e2e.test.ts

@@ -4,11 +4,17 @@
  * Agent that fetches from external APIs demonstrating API integration patterns.
  */
 
-import { describe, test, expect, beforeAll } from 'bun:test'
+import { describe, test, expect, beforeAll, beforeEach } from 'bun:test'
 import { z } from 'zod/v4'
 
 import { CodebuffClient, getCustomToolDefinition } from '../../src'
-import { EventCollector, getApiKey, skipIfNoApiKey, isAuthError, DEFAULT_TIMEOUT } from '../utils'
+import {
+  EventCollector,
+  getApiKey,
+  isAuthError,
+  ensureBackendConnection,
+  DEFAULT_TIMEOUT,
+} from '../utils'
 
 import type { AgentDefinition } from '../../src'
 
@@ -87,14 +93,16 @@ Summarize the response data clearly.`,
   })
 
   beforeAll(() => {
-    if (skipIfNoApiKey()) return
     client = new CodebuffClient({ apiKey: getApiKey() })
   })
 
+  beforeEach(async () => {
+    await ensureBackendConnection()
+  })
+
   test(
     'fetches mock API data and summarizes response',
     async () => {
-      if (skipIfNoApiKey()) return
 
       const collector = new EventCollector()
 
@@ -121,7 +129,6 @@ Summarize the response data clearly.`,
   test(
     'handles API errors gracefully',
     async () => {
-      if (skipIfNoApiKey()) return
 
       const collector = new EventCollector()
 

sdk/e2e/custom-agents/database-query-agent.e2e.test.ts

@@ -4,11 +4,18 @@
  * Agent with mock SQL execution tool demonstrating database integration patterns.
  */
 
-import { describe, test, expect, beforeAll } from 'bun:test'
+import { describe, test, expect, beforeAll, beforeEach } from 'bun:test'
 import { z } from 'zod/v4'
 
 import { CodebuffClient, getCustomToolDefinition } from '../../src'
-import { EventCollector, getApiKey, skipIfNoApiKey, isAuthError, MOCK_DATABASE, DEFAULT_TIMEOUT } from '../utils'
+import {
+  EventCollector,
+  getApiKey,
+  isAuthError,
+  ensureBackendConnection,
+  MOCK_DATABASE,
+  DEFAULT_TIMEOUT,
+} from '../utils'
 
 import type { AgentDefinition } from '../../src'
 
@@ -57,14 +64,16 @@ Always format query results in a readable way.`,
   })
 
   beforeAll(() => {
-    if (skipIfNoApiKey()) return
     client = new CodebuffClient({ apiKey: getApiKey() })
   })
 
+  beforeEach(async () => {
+    await ensureBackendConnection()
+  })
+
   test(
     'executes SELECT query and returns results',
     async () => {
-      if (skipIfNoApiKey()) return
 
       const collector = new EventCollector()
 
@@ -96,7 +105,6 @@ Always format query results in a readable way.`,
   test(
     'handles query with WHERE clause',
     async () => {
-      if (skipIfNoApiKey()) return
 
       const collector = new EventCollector()
 

sdk/e2e/custom-agents/weather-agent.e2e.test.ts

@@ -4,11 +4,18 @@
  * Custom agent with a get_weather custom tool demonstrating custom tool integration.
  */
 
-import { describe, test, expect, beforeAll } from 'bun:test'
+import { describe, test, expect, beforeAll, beforeEach } from 'bun:test'
 import { z } from 'zod/v4'
 
 import { CodebuffClient, getCustomToolDefinition } from '../../src'
-import { EventCollector, getApiKey, skipIfNoApiKey, isAuthError, MOCK_WEATHER_DATA, DEFAULT_TIMEOUT } from '../utils'
+import {
+  EventCollector,
+  getApiKey,
+  isAuthError,
+  ensureBackendConnection,
+  MOCK_WEATHER_DATA,
+  DEFAULT_TIMEOUT,
+} from '../utils'
 
 import type { AgentDefinition } from '../../src'
 
@@ -49,14 +56,16 @@ Always report the temperature and conditions clearly.`,
   })
 
   beforeAll(() => {
-    if (skipIfNoApiKey()) return
     client = new CodebuffClient({ apiKey: getApiKey() })
   })
 
+  beforeEach(async () => {
+    await ensureBackendConnection()
+  })
+
   test(
     'custom weather tool is called and returns data',
     async () => {
-      if (skipIfNoApiKey()) return
 
       const collector = new EventCollector()
 
@@ -93,7 +102,6 @@ Always report the temperature and conditions clearly.`,
   test(
     'custom tool handles unknown city gracefully',
     async () => {
-      if (skipIfNoApiKey()) return
 
       const collector = new EventCollector()
 

sdk/e2e/features/knowledge-files.e2e.test.ts

@@ -4,23 +4,32 @@
  * Tests knowledgeFiles injection for providing context to the agent.
  */
 
-import { describe, test, expect, beforeAll } from 'bun:test'
+import { describe, test, expect, beforeAll, beforeEach } from 'bun:test'
 
 import { CodebuffClient } from '../../src/client'
-import { EventCollector, getApiKey, skipIfNoApiKey, isAuthError, DEFAULT_AGENT, DEFAULT_TIMEOUT } from '../utils'
+import {
+  EventCollector,
+  getApiKey,
+  isAuthError,
+  ensureBackendConnection,
+  DEFAULT_AGENT,
+  DEFAULT_TIMEOUT,
+} from '../utils'
 
 describe('Features: Knowledge Files', () => {
   let client: CodebuffClient
 
   beforeAll(() => {
-    if (skipIfNoApiKey()) return
     client = new CodebuffClient({ apiKey: getApiKey() })
   })
 
+  beforeEach(async () => {
+    await ensureBackendConnection()
+  })
+
   test(
     'agent uses injected knowledge files',
     async () => {
-      if (skipIfNoApiKey()) return
 
       const collector = new EventCollector()
 
@@ -46,7 +55,6 @@ describe('Features: Knowledge Files', () => {
   test(
     'multiple knowledge files are accessible',
     async () => {
-      if (skipIfNoApiKey()) return
 
       const collector = new EventCollector()
 

sdk/e2e/features/max-agent-steps.e2e.test.ts

@@ -4,23 +4,32 @@
  * Tests the maxAgentSteps option for limiting agent execution.
  */
 
-import { describe, test, expect, beforeAll } from 'bun:test'
+import { describe, test, expect, beforeAll, beforeEach } from 'bun:test'
 
 import { CodebuffClient } from '../../src/client'
-import { EventCollector, getApiKey, skipIfNoApiKey, isAuthError, DEFAULT_AGENT, DEFAULT_TIMEOUT } from '../utils'
+import {
+  EventCollector,
+  getApiKey,
+  isAuthError,
+  ensureBackendConnection,
+  DEFAULT_AGENT,
+  DEFAULT_TIMEOUT,
+} from '../utils'
 
 describe('Features: Max Agent Steps', () => {
   let client: CodebuffClient
 
   beforeAll(() => {
-    if (skipIfNoApiKey()) return
     client = new CodebuffClient({ apiKey: getApiKey() })
   })
 
+  beforeEach(async () => {
+    await ensureBackendConnection()
+  })
+
   test(
     'run completes with maxAgentSteps set',
     async () => {
-      if (skipIfNoApiKey()) return
 
       const collector = new EventCollector()
 
@@ -42,7 +51,6 @@ describe('Features: Max Agent Steps', () => {
   test(
     'low maxAgentSteps still allows simple responses',
     async () => {
-      if (skipIfNoApiKey()) return
 
       const collector = new EventCollector()
 

sdk/e2e/features/project-files.e2e.test.ts

@@ -4,14 +4,14 @@
  * Tests projectFiles injection for providing file context to the agent.
  */
 
-import { describe, test, expect, beforeAll } from 'bun:test'
+import { describe, test, expect, beforeAll, beforeEach } from 'bun:test'
 
 import { CodebuffClient } from '../../src/client'
 import {
   EventCollector,
   getApiKey,
-  skipIfNoApiKey,
   isAuthError,
+  ensureBackendConnection,
   SAMPLE_PROJECT_FILES,
   DEFAULT_AGENT,
   DEFAULT_TIMEOUT,
@@ -21,14 +21,16 @@ describe('Features: Project Files', () => {
   let client: CodebuffClient
 
   beforeAll(() => {
-    if (skipIfNoApiKey()) return
     client = new CodebuffClient({ apiKey: getApiKey() })
   })
 
+  beforeEach(async () => {
+    await ensureBackendConnection()
+  })
+
   test(
     'agent can reference injected project files',
     async () => {
-      if (skipIfNoApiKey()) return
 
       const collector = new EventCollector()
 
@@ -58,7 +60,6 @@ describe('Features: Project Files', () => {
   test(
     'agent can analyze content of project files',
     async () => {
-      if (skipIfNoApiKey()) return
 
       const collector = new EventCollector()
 

sdk/e2e/integration/connection-check.integration.test.ts

@@ -4,28 +4,29 @@
  * Tests the checkConnection() method of CodebuffClient.
  */
 
-import { describe, test, expect, beforeAll } from 'bun:test'
+import { describe, test, expect, beforeAll, beforeEach } from 'bun:test'
 
 import { CodebuffClient } from '../../src/client'
-import { getApiKey, skipIfNoApiKey } from '../utils'
+import { getApiKey, ensureBackendConnection } from '../utils'
 
 describe('Integration: Connection Check', () => {
   let client: CodebuffClient
 
   beforeAll(() => {
-    if (skipIfNoApiKey()) return
     client = new CodebuffClient({ apiKey: getApiKey() })
   })
 
+  beforeEach(async () => {
+    await ensureBackendConnection()
+  })
+
   test('checkConnection returns true when backend is reachable', async () => {
-    if (skipIfNoApiKey()) return
 
     const isConnected = await client.checkConnection()
     expect(isConnected).toBe(true)
   })
 
   test('checkConnection returns boolean', async () => {
-    if (skipIfNoApiKey()) return
 
     const result = await client.checkConnection()
     expect(typeof result).toBe('boolean')