Guard agent and SDK integrations when API key is missing

Author: brandonkachen

.agents/__tests__/editor-best-of-n.integration.test.ts

@@ -5,6 +5,22 @@ import { CodebuffClient } from '@codebuff/sdk'
 
 import type { PrintModeEvent } from '@codebuff/common/types/print-mode'
 
+function getApiKeyOrSkip(): string | null {
+  const apiKey = process.env[API_KEY_ENV_VAR]
+  const isPlaceholder = !apiKey || ['test-codebuff', 'dummy-token'].includes(apiKey)
+
+  if (!process.env.CI && isPlaceholder) {
+    console.warn('Skipping editor-best-of-n integration test: CODEBUFF_API_KEY missing or placeholder')
+    return null
+  }
+
+  if (!apiKey) {
+    throw new Error('API key not found')
+  }
+
+  return apiKey
+}
+
 /**
  * Integration tests for the editor-best-of-n-max agent.
  * These tests verify that the best-of-n editor workflow works correctly:
@@ -17,10 +33,8 @@ describe('Editor Best-of-N Max Agent Integration', () => {
   it(
     'should generate and select the best implementation for a simple edit',
     async () => {
-      const apiKey = process.env[API_KEY_ENV_VAR]
-      if (!apiKey) {
-        throw new Error('API key not found')
-      }
+      const apiKey = getApiKeyOrSkip()
+      if (!apiKey) return
 
       // Create mock project files with a simple TypeScript file to edit
       const projectFiles: Record<string, string> = {

.agents/__tests__/file-explorer.integration.test.ts

@@ -7,6 +7,22 @@ import fileListerDefinition from '../file-explorer/file-lister'
 
 import type { PrintModeEvent } from '@codebuff/common/types/print-mode'
 
+function getApiKeyOrSkip(): string | null {
+  const apiKey = process.env[API_KEY_ENV_VAR]
+  const isPlaceholder = !apiKey || ['test-codebuff', 'dummy-token'].includes(apiKey)
+
+  if (!process.env.CI && isPlaceholder) {
+    console.warn('Skipping file-explorer integration test: CODEBUFF_API_KEY missing or placeholder')
+    return null
+  }
+
+  if (!apiKey) {
+    throw new Error('API key not found')
+  }
+
+  return apiKey
+}
+
 /**
  * Integration tests for agents that use the read_subtree tool.
  * These tests verify that the SDK properly initializes the session state
@@ -22,10 +38,8 @@ describe('File Lister Agent Integration - read_subtree tool', () => {
   it(
     'should find relevant files using read_subtree tool',
     async () => {
-      const apiKey = process.env[API_KEY_ENV_VAR]
-      if (!apiKey) {
-        throw new Error('API key not found')
-      }
+      const apiKey = getApiKeyOrSkip()
+      if (!apiKey) return
 
       // Create mock project files that the file-lister should be able to find
       const projectFiles: Record<string, string> = {
@@ -142,10 +156,8 @@ export interface User {
   it(
     'should use the file tree from session state',
     async () => {
-      const apiKey = process.env[API_KEY_ENV_VAR]
-      if (!apiKey) {
-        throw new Error('API key not found')
-      }
+      const apiKey = getApiKeyOrSkip()
+      if (!apiKey) return
 
       // Create a different set of project files with a specific structure
       const projectFiles: Record<string, string> = {
@@ -196,10 +208,8 @@ export interface User {
   it(
     'should respect directories parameter',
     async () => {
-      const apiKey = process.env[API_KEY_ENV_VAR]
-      if (!apiKey) {
-        throw new Error('API key not found')
-      }
+      const apiKey = getApiKeyOrSkip()
+      if (!apiKey) return
 
       // Create project with multiple top-level directories
       const projectFiles: Record<string, string> = {

sdk/src/__tests__/run.integration.test.ts

@@ -3,6 +3,22 @@ import { describe, expect, it } from 'bun:test'
 
 import { CodebuffClient } from '../client'
 
+function getApiKeyOrSkip(): string | null {
+  const apiKey = process.env[API_KEY_ENV_VAR]
+  const isPlaceholder = !apiKey || ['test-codebuff', 'dummy-token'].includes(apiKey)
+
+  if (!process.env.CI && isPlaceholder) {
+    console.warn('Skipping SDK prompt caching integration: CODEBUFF_API_KEY missing or placeholder')
+    return null
+  }
+
+  if (!apiKey) {
+    throw new Error('API key not found')
+  }
+
+  return apiKey
+}
+
 describe('Prompt Caching', () => {
   it(
     'should be cheaper on second request',
@@ -12,10 +28,8 @@ describe('Prompt Caching', () => {
         'Ignore this text. This is just to make the prompt longer. '.repeat(500)
       const prompt = 'respond with "hi"'
 
-      const apiKey = process.env[API_KEY_ENV_VAR]
-      if (!apiKey) {
-        throw new Error('API key not found')
-      }
+      const apiKey = getApiKeyOrSkip()
+      if (!apiKey) return
 
       const client = new CodebuffClient({
         apiKey,