Victor Dibia fe1feb3906
Enable Auth in AGS (#5928)
<!-- Thank you for your contribution! Please review
https://microsoft.github.io/autogen/docs/Contribute before opening a
pull request. -->

<!-- Please add a reviewer to the assignee section when you create a PR.
If you don't have the access to it, we will shortly find a reviewer and
assign them to your PR. -->

## Why are these changes needed?


https://github.com/user-attachments/assets/b649053b-c377-40c7-aa51-ee64af766fc2

<img width="100%" alt="image"
src="https://github.com/user-attachments/assets/03ba1df5-c9a2-4734-b6a2-0eb97ec0b0e0"
/>


## Authentication

This PR implements an experimental authentication feature to enable
personalized experiences (multiple users). Currently, only GitHub
authentication is supported. You can extend the base authentication
class to add support for other authentication methods.

By default authenticatio is disabled and only enabled when you pass in
the `--auth-config` argument when running the application.

### Enable GitHub Authentication

To enable GitHub authentication, create a `auth.yaml` file in your app
directory:

```yaml
type: github
jwt_secret: "your-secret-key"
token_expiry_minutes: 60
github:
  client_id: "your-github-client-id"
  client_secret: "your-github-client-secret"
  callback_url: "http://localhost:8081/api/auth/callback"
  scopes: ["user:email"]
```

Please see the documentation on [GitHub
OAuth](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app)
for more details on obtaining the `client_id` and `client_secret`.

To pass in this configuration you can use the `--auth-config` argument
when running the application:

```bash
autogenstudio ui --auth-config /path/to/auth.yaml
```

Or set the environment variable:

```bash
export AUTOGENSTUDIO_AUTH_CONFIG="/path/to/auth.yaml"
```

```{note}
- Authentication is currently experimental and may change in future releases
- User data is stored in your configured database
- When enabled, all API endpoints require authentication except for the authentication endpoints
- WebSocket connections require the token to be passed as a query parameter (`?token=your-jwt-token`)

```

## Related issue number

<!-- For example: "Closes #1234" -->
Closes #4350  

## Checks

- [ ] I've included any doc changes needed for
<https://microsoft.github.io/autogen/>. See
<https://github.com/microsoft/autogen/blob/main/CONTRIBUTING.md> to
build and test documentation locally.
- [ ] I've added tests (if relevant) corresponding to the changes
introduced in this PR.
- [ ] I've made sure all auto checks have passed.

---------

Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>
2025-03-14 15:02:05 -07:00

183 lines
6.8 KiB
Python

import asyncio
import pytest
from sqlmodel import Session, text, select
from typing import Generator
from autogenstudio.database import DatabaseManager
from autogen_agentchat.agents import AssistantAgent
from autogen_agentchat.teams import RoundRobinGroupChat
from autogen_ext.models.openai import OpenAIChatCompletionClient
from autogen_agentchat.conditions import TextMentionTermination
from autogenstudio.datamodel.db import Team, Session as SessionModel, Run, Message, RunStatus, MessageConfig
@pytest.fixture
def test_db(tmp_path) -> Generator[DatabaseManager, None, None]:
"""Fixture for test database using temporary paths"""
db_path = tmp_path / "test.db"
db = DatabaseManager(f"sqlite:///{db_path}", base_dir=tmp_path)
db.reset_db()
# Initialize database instead of create_db_and_tables
db.initialize_database(auto_upgrade=False)
yield db
# Clean up
asyncio.run(db.close())
db.reset_db()
# No need to manually remove files - tmp_path is cleaned up automatically
@pytest.fixture
def test_user() -> str:
return "test_user@example.com"
@pytest.fixture
def sample_team(test_user: str) -> Team:
"""Create a sample team with proper config"""
agent = AssistantAgent(
name="weather_agent",
model_client=OpenAIChatCompletionClient(
model="gpt-4",
),
)
agent_team = RoundRobinGroupChat([agent], termination_condition=TextMentionTermination("TERMINATE"))
team_component = agent_team.dump_component()
return Team(
user_id=test_user,
component=team_component.model_dump(),
)
class TestDatabaseOperations:
def test_basic_setup(self, test_db: DatabaseManager):
"""Test basic database setup and connection"""
with Session(test_db.engine) as session:
result = session.exec(text("SELECT 1")).first()
assert result[0] == 1
result = session.exec(select(1)).first()
assert result == 1
def test_basic_entity_creation(self, test_db: DatabaseManager, sample_team: Team):
"""Test creating all entity types with proper configs"""
# Use upsert instead of raw session
response = test_db.upsert(sample_team)
assert response.status is True
with Session(test_db.engine) as session:
saved_team = session.get(Team, sample_team.id)
assert saved_team is not None
def test_upsert_operations(self, test_db: DatabaseManager, sample_team: Team):
"""Test upsert for both create and update scenarios"""
# Test Create
response = test_db.upsert(sample_team)
assert response.status is True
assert "Created Successfully" in response.message
# Test Update
team_id = sample_team.id
sample_team.version = "0.0.2"
response = test_db.upsert(sample_team)
assert response.status is True
# Verify Update
result = test_db.get(Team, {"id": team_id})
assert result.status is True
assert result.data[0].version == "0.0.2"
def test_delete_operations(self, test_db: DatabaseManager, sample_team: Team):
"""Test delete with various filters"""
# First insert the model
response = test_db.upsert(sample_team)
assert response.status is True # Verify insert worked
# Get the ID that was actually saved
team_id = sample_team.id
# Test deletion by id
response = test_db.delete(Team, {"id": team_id})
assert response.status is True
assert "Deleted Successfully" in response.message
# Verify deletion
result = test_db.get(Team, {"id": team_id})
assert len(result.data) == 0
def test_cascade_delete(self, test_db: DatabaseManager, test_user: str):
"""Test all levels of cascade delete"""
# Enable foreign keys for SQLite (crucial for cascade delete)
with Session(test_db.engine) as session:
session.execute(text("PRAGMA foreign_keys=ON"))
session.commit()
# Test Run -> Message cascade
team1 = Team(user_id=test_user, component={"name": "Team1", "type": "team"})
test_db.upsert(team1)
session1 = SessionModel(user_id=test_user, team_id=team1.id, name="Session1")
test_db.upsert(session1)
run1_id = 1
test_db.upsert(Run(
id=run1_id,
user_id=test_user,
session_id=session1.id,
status=RunStatus.COMPLETE,
task=MessageConfig(content="Task1", source="user").model_dump()
))
test_db.upsert(Message(
user_id=test_user,
session_id=session1.id,
run_id=run1_id,
config=MessageConfig(content="Message1", source="assistant").model_dump()
))
test_db.delete(Run, {"id": run1_id})
assert len(test_db.get(Message, {"run_id": run1_id}).data) == 0, "Run->Message cascade failed"
# Test Session -> Run -> Message cascade
session2 = SessionModel(user_id=test_user, team_id=team1.id, name="Session2")
test_db.upsert(session2)
run2_id = 2
test_db.upsert(Run(
id=run2_id,
user_id=test_user,
session_id=session2.id,
status=RunStatus.COMPLETE,
task=MessageConfig(content="Task2", source="user").model_dump()
))
test_db.upsert(Message(
user_id=test_user,
session_id=session2.id,
run_id=run2_id,
config=MessageConfig(content="Message2", source="assistant").model_dump()
))
test_db.delete(SessionModel, {"id": session2.id})
assert len(test_db.get(Run, {"session_id": session2.id}).data) == 0, "Session->Run cascade failed"
assert len(test_db.get(Message, {"run_id": run2_id}).data) == 0, "Session->Run->Message cascade failed"
# Clean up
test_db.delete(Team, {"id": team1.id})
def test_initialize_database_scenarios(self, tmp_path, monkeypatch):
"""Test different initialize_database parameters"""
db_path = tmp_path / "test_init.db"
db = DatabaseManager(f"sqlite:///{db_path}", base_dir=tmp_path)
# Mock the schema manager's check_schema_status to avoid migration issues
monkeypatch.setattr(db.schema_manager, "check_schema_status", lambda: (False, None))
monkeypatch.setattr(db.schema_manager, "ensure_schema_up_to_date", lambda: True)
try:
# Test basic initialization
response = db.initialize_database()
assert response.status is True
# Test with auto_upgrade
response = db.initialize_database(auto_upgrade=True)
assert response.status is True
finally:
asyncio.run(db.close())
db.reset_db()