File size: 12,521 Bytes
aef804e | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 | """
API-first setup utilities for fast test initialization.
This module provides utilities for quickly setting up test data by calling
API endpoints directly, bypassing slow UI navigation (10-100x speedup).
Base URL: http://localhost:8001 (non-conflicting with dev backend on port 8000)
"""
import requests
from typing import Any, Dict, Optional
class APIClient:
"""
HTTP client for making API requests to the backend during tests.
Provides convenient methods for HTTP requests with JSON handling and
authentication header support.
"""
def __init__(self, base_url: str = "http://localhost:8001", token: Optional[str] = None):
"""
Initialize the API client.
Args:
base_url: Base URL of the backend API (default: http://localhost:8001)
token: Optional JWT authentication token
"""
self.base_url = base_url.rstrip("/")
self.token = token
self.session = requests.Session()
def _get_headers(self) -> Dict[str, str]:
"""
Get request headers with authentication if token is available.
Returns:
Dictionary of HTTP headers
"""
headers = {
"Content-Type": "application/json",
"Accept": "application/json"
}
if self.token:
headers["Authorization"] = f"Bearer {self.token}"
return headers
def get(self, path: str, params: Optional[Dict[str, Any]] = None) -> Dict[str, Any]:
"""
Make a GET request to the API.
Args:
path: API endpoint path (e.g., "/api/v1/users")
params: Optional query parameters
Returns:
JSON response data
Raises:
requests.HTTPError: If the request fails
"""
url = f"{self.base_url}{path}"
response = self.session.get(url, headers=self._get_headers(), params=params)
response.raise_for_status()
return response.json()
def post(self, path: str, data: Optional[Dict[str, Any]] = None, json: Optional[Dict[str, Any]] = None) -> Dict[str, Any]:
"""
Make a POST request to the API.
Args:
path: API endpoint path (e.g., "/api/v1/users")
data: Optional form data
json: Optional JSON data
Returns:
JSON response data
Raises:
requests.HTTPError: If the request fails
"""
url = f"{self.base_url}{path}"
response = self.session.post(url, headers=self._get_headers(), data=data, json=json)
response.raise_for_status()
return response.json()
def put(self, path: str, data: Optional[Dict[str, Any]] = None, json: Optional[Dict[str, Any]] = None) -> Dict[str, Any]:
"""
Make a PUT request to the API.
Args:
path: API endpoint path (e.g., "/api/v1/users/me")
data: Optional form data
json: Optional JSON data
Returns:
JSON response data
Raises:
requests.HTTPError: If the request fails
"""
url = f"{self.base_url}{path}"
response = self.session.put(url, headers=self._get_headers(), data=data, json=json)
response.raise_for_status()
return response.json()
def delete(self, path: str, params: Optional[Dict[str, Any]] = None) -> Dict[str, Any]:
"""
Make a DELETE request to the API.
Args:
path: API endpoint path (e.g., "/api/v1/projects/123")
params: Optional query parameters
Returns:
JSON response data
Raises:
requests.HTTPError: If the request fails
"""
url = f"{self.base_url}{path}"
response = self.session.delete(url, headers=self._get_headers(), params=params)
response.raise_for_status()
return response.json()
def set_token(self, token: str) -> None:
"""
Set the authentication token for subsequent requests.
Args:
token: JWT authentication token
"""
self.token = token
def clear_token(self) -> None:
"""Clear the authentication token."""
self.token = None
# ============================================================================
# User Setup Functions
# ============================================================================
def create_test_user(client: APIClient, email: str, password: str, first_name: str = "Test", last_name: str = "User") -> Dict[str, Any]:
"""
Create a test user via API.
Args:
client: APIClient instance
email: User email
password: User password
first_name: User first name (default: "Test")
last_name: User last name (default: "User")
Returns:
User data response from API
Raises:
requests.HTTPError: If user creation fails
"""
return client.post(
"/api/auth/register",
json={
"email": email,
"password": password,
"first_name": first_name,
"last_name": last_name
}
)
def authenticate_user(client: APIClient, email: str, password: str) -> Dict[str, Any]:
"""
Authenticate a user and get access token.
Args:
client: APIClient instance
email: User email
password: User password
Returns:
Authentication response with access_token
Raises:
requests.HTTPError: If authentication fails
"""
return client.post(
"/api/auth/login",
json={
"username": email,
"password": password
}
)
def get_test_user_token(client: APIClient, email: str, password: str) -> str:
"""
Get JWT token for a test user.
Args:
client: APIClient instance
email: User email
password: User password
Returns:
JWT access token
Raises:
requests.HTTPError: If authentication fails
"""
response = authenticate_user(client, email, password)
return response["access_token"]
def set_authenticated_session(page, token: str) -> None:
"""
Set JWT token in localStorage for Playwright page.
This authenticates the browser session without going through UI login.
Args:
page: Playwright Page object
token: JWT access token
"""
page.evaluate(f"localStorage.setItem('auth_token', '{token}')")
# ============================================================================
# Project Setup Functions
# ============================================================================
def create_test_project(client: APIClient, name: str, description: str = "", token: Optional[str] = None) -> Dict[str, Any]:
"""
Create a test project via API.
Args:
client: APIClient instance
name: Project name
description: Project description (default: "")
token: Optional JWT token (uses client token if not provided)
Returns:
Project data response from API
Raises:
requests.HTTPError: If project creation fails
"""
if token:
original_token = client.token
client.set_token(token)
try:
response = client.post(
"/api/v1/projects/",
json={
"name": name,
"description": description,
"color": "#3182CE"
}
)
finally:
client.token = original_token
else:
response = client.post(
"/api/v1/projects/",
json={
"name": name,
"description": description,
"color": "#3182CE"
}
)
return response
def get_test_projects(client: APIClient, token: Optional[str] = None) -> Dict[str, Any]:
"""
Get all test projects via API.
Args:
client: APIClient instance
token: Optional JWT token (uses client token if not provided)
Returns:
Projects data response from API
Raises:
requests.HTTPError: If request fails
"""
if token:
original_token = client.token
client.set_token(token)
try:
response = client.get("/api/v1/projects/")
finally:
client.token = original_token
else:
response = client.get("/api/v1/projects/")
return response
def delete_test_project(client: APIClient, project_id: str, token: Optional[str] = None) -> Dict[str, Any]:
"""
Delete a test project via API.
Note: This endpoint may not exist in the current implementation.
Projects are typically stored in memory and cleared between test runs.
Args:
client: APIClient instance
project_id: Project ID to delete
token: Optional JWT token (uses client token if not provided)
Returns:
Response data
Raises:
requests.HTTPError: If deletion fails
"""
if token:
original_token = client.token
client.set_token(token)
try:
response = client.delete(f"/api/v1/projects/{project_id}")
finally:
client.token = original_token
else:
response = client.delete(f"/api/v1/projects/{project_id}")
return response
# ============================================================================
# Skill Setup Functions
# ============================================================================
def install_test_skill(client: APIClient, skill_id: str, agent_id: str = "test-agent", token: Optional[str] = None) -> Dict[str, Any]:
"""
Install a test skill via API.
Args:
client: APIClient instance
skill_id: Skill ID to install
agent_id: Agent ID that will use the skill (default: "test-agent")
token: Optional JWT token (uses client token if not provided)
Returns:
Installation response data
Raises:
requests.HTTPError: If installation fails
"""
if token:
original_token = client.token
client.set_token(token)
try:
response = client.post(
f"/marketplace/skills/{skill_id}/install",
json={
"agent_id": agent_id,
"auto_install_deps": True
}
)
finally:
client.token = original_token
else:
response = client.post(
f"/marketplace/skills/{skill_id}/install",
json={
"agent_id": agent_id,
"auto_install_deps": True
}
)
return response
def get_installed_skills(client: APIClient, token: Optional[str] = None) -> Dict[str, Any]:
"""
Get installed skills via API.
Note: This endpoint may need to be implemented.
Currently, the marketplace provides search and installation endpoints.
Args:
client: APIClient instance
token: Optional JWT token (uses client token if not provided)
Returns:
Skills data response from API
Raises:
requests.HTTPError: If request fails
"""
if token:
original_token = client.token
client.set_token(token)
try:
# Search all marketplace skills
response = client.get("/marketplace/skills")
finally:
client.token = original_token
else:
response = client.get("/marketplace/skills")
return response
def uninstall_test_skill(client: APIClient, skill_id: str, token: Optional[str] = None) -> Dict[str, Any]:
"""
Uninstall a test skill via API.
Note: This endpoint may need to be implemented.
Skills are typically managed through the skill adapter service.
Args:
client: APIClient instance
skill_id: Skill ID to uninstall
token: Optional JWT token (uses client token if not provided)
Returns:
Response data
Raises:
requests.HTTPError: If uninstallation fails
"""
# Note: Uninstall endpoint may not exist in current implementation
# This is a placeholder for future implementation
if token:
original_token = client.token
client.set_token(token)
try:
response = client.delete(f"/marketplace/skills/{skill_id}")
finally:
client.token = original_token
else:
response = client.delete(f"/marketplace/skills/{skill_id}")
return response
|