forked from 0xWheatyz/SPARC
Compare commits
1 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 44a162056d |
@@ -0,0 +1,224 @@
|
||||
"""Tests for export endpoints: CSV and PDF export of analysis results.
|
||||
|
||||
Covers issue #1655:
|
||||
- GET /export/{company_name} (CSV export)
|
||||
- GET /export/{company_name}/pdf (PDF export)
|
||||
|
||||
All tests mock the database layer and use JWT auth fixtures from test_auth patterns.
|
||||
"""
|
||||
|
||||
from datetime import datetime, timezone
|
||||
from unittest.mock import MagicMock, patch
|
||||
|
||||
import pytest
|
||||
from fastapi.testclient import TestClient
|
||||
|
||||
from SPARC.api import app
|
||||
from SPARC.auth import create_access_token
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def client():
|
||||
"""Create test client."""
|
||||
return TestClient(app)
|
||||
|
||||
|
||||
@pytest.fixture(autouse=True)
|
||||
def mock_db():
|
||||
"""Mock the database client used by export and auth endpoints."""
|
||||
db = MagicMock()
|
||||
|
||||
# Default: user exists for auth
|
||||
db.get_user_by_id.return_value = {
|
||||
"id": 1,
|
||||
"email": "user@test.com",
|
||||
"role": "user",
|
||||
"created_at": datetime(2025, 1, 1, tzinfo=timezone.utc),
|
||||
}
|
||||
|
||||
# Mock get_conn for export queries
|
||||
mock_cursor = MagicMock()
|
||||
mock_conn = MagicMock()
|
||||
mock_conn.cursor.return_value.__enter__ = MagicMock(return_value=mock_cursor)
|
||||
mock_conn.cursor.return_value.__exit__ = MagicMock(return_value=False)
|
||||
db.get_conn.return_value.__enter__ = MagicMock(return_value=mock_conn)
|
||||
db.get_conn.return_value.__exit__ = MagicMock(return_value=False)
|
||||
db._mock_cursor = mock_cursor
|
||||
|
||||
with patch("SPARC.api.get_db_client", return_value=db), \
|
||||
patch("SPARC.auth.get_db_client", return_value=db):
|
||||
yield db
|
||||
|
||||
|
||||
def _auth_header():
|
||||
"""Create an Authorization header with a valid access token."""
|
||||
token = create_access_token(1, "user@test.com", "user")
|
||||
return {"Authorization": f"Bearer {token}"}
|
||||
|
||||
|
||||
def _sample_rows():
|
||||
"""Return sample llm_messages rows as tuples (matching cursor.fetchall format)."""
|
||||
return [
|
||||
(
|
||||
"NVIDIA",
|
||||
"company_analysis",
|
||||
"anthropic/claude-3.5-sonnet",
|
||||
"Strong AI patent portfolio with focus on GPU architectures.",
|
||||
datetime(2025, 6, 15, 10, 30, 0),
|
||||
),
|
||||
(
|
||||
"NVIDIA",
|
||||
"patent_analysis",
|
||||
"openai/gpt-4o",
|
||||
"Patent US-12345678-B2 covers novel tensor core design.",
|
||||
datetime(2025, 6, 14, 9, 0, 0),
|
||||
),
|
||||
]
|
||||
|
||||
|
||||
class TestCSVExport:
|
||||
"""GET /export/{company_name} -- CSV export."""
|
||||
|
||||
def test_csv_export_success(self, client, mock_db):
|
||||
"""Valid company with results returns a CSV file."""
|
||||
mock_db._mock_cursor.fetchall.return_value = _sample_rows()
|
||||
|
||||
response = client.get("/export/NVIDIA", headers=_auth_header())
|
||||
|
||||
assert response.status_code == 200
|
||||
assert response.headers["content-type"].startswith("text/csv")
|
||||
assert "attachment" in response.headers.get("content-disposition", "")
|
||||
assert "sparc_nvidia_export.csv" in response.headers["content-disposition"]
|
||||
|
||||
# Verify CSV content (CSV uses \r\n line endings)
|
||||
lines = response.text.strip().split("\n")
|
||||
assert len(lines) == 3 # header + 2 data rows
|
||||
assert lines[0].strip() == "company_name,analysis_type,model,analysis,timestamp"
|
||||
assert "NVIDIA" in lines[1]
|
||||
assert "company_analysis" in lines[1]
|
||||
|
||||
def test_csv_export_no_results_returns_404(self, client, mock_db):
|
||||
"""Unknown company returns 404."""
|
||||
mock_db._mock_cursor.fetchall.return_value = []
|
||||
|
||||
response = client.get("/export/nonexistent", headers=_auth_header())
|
||||
|
||||
assert response.status_code == 404
|
||||
assert "No analysis results found" in response.json()["detail"]
|
||||
|
||||
def test_csv_export_unauthenticated_returns_401(self, client):
|
||||
"""Request without token returns 401."""
|
||||
response = client.get("/export/NVIDIA")
|
||||
assert response.status_code == 401
|
||||
|
||||
def test_csv_export_invalid_token_returns_401(self, client):
|
||||
"""Request with invalid token returns 401."""
|
||||
response = client.get(
|
||||
"/export/NVIDIA",
|
||||
headers={"Authorization": "Bearer invalid.token.here"},
|
||||
)
|
||||
assert response.status_code == 401
|
||||
|
||||
def test_csv_export_filename_sanitization(self, client, mock_db):
|
||||
"""Company names with spaces get sanitized in the filename."""
|
||||
mock_db._mock_cursor.fetchall.return_value = [
|
||||
(
|
||||
"Tesla Motors",
|
||||
"company_analysis",
|
||||
"anthropic/claude-3.5-sonnet",
|
||||
"EV patent portfolio analysis.",
|
||||
datetime(2025, 6, 15, 10, 0, 0),
|
||||
),
|
||||
]
|
||||
|
||||
response = client.get("/export/Tesla Motors", headers=_auth_header())
|
||||
|
||||
assert response.status_code == 200
|
||||
assert "tesla_motors" in response.headers["content-disposition"]
|
||||
|
||||
def test_csv_export_single_row(self, client, mock_db):
|
||||
"""Single analysis result produces valid CSV with one data row."""
|
||||
mock_db._mock_cursor.fetchall.return_value = [_sample_rows()[0]]
|
||||
|
||||
response = client.get("/export/NVIDIA", headers=_auth_header())
|
||||
|
||||
assert response.status_code == 200
|
||||
lines = response.text.strip().split("\n")
|
||||
assert len(lines) == 2 # header + 1 data row
|
||||
|
||||
|
||||
class TestPDFExport:
|
||||
"""GET /export/{company_name}/pdf -- PDF report export."""
|
||||
|
||||
def test_pdf_export_success(self, client, mock_db):
|
||||
"""Valid company with results returns a PDF file."""
|
||||
mock_db._mock_cursor.fetchall.return_value = _sample_rows()
|
||||
|
||||
response = client.get("/export/NVIDIA/pdf", headers=_auth_header())
|
||||
|
||||
assert response.status_code == 200
|
||||
assert response.headers["content-type"] == "application/pdf"
|
||||
assert "attachment" in response.headers.get("content-disposition", "")
|
||||
# PDF files start with %PDF
|
||||
assert response.content[:4] == b"%PDF"
|
||||
|
||||
def test_pdf_export_no_results_returns_404(self, client, mock_db):
|
||||
"""Unknown company returns 404."""
|
||||
mock_db._mock_cursor.fetchall.return_value = []
|
||||
|
||||
response = client.get("/export/nonexistent/pdf", headers=_auth_header())
|
||||
|
||||
assert response.status_code == 404
|
||||
assert "No analysis results found" in response.json()["detail"]
|
||||
|
||||
def test_pdf_export_unauthenticated_returns_401(self, client):
|
||||
"""Request without token returns 401."""
|
||||
response = client.get("/export/NVIDIA/pdf")
|
||||
assert response.status_code == 401
|
||||
|
||||
def test_pdf_export_invalid_token_returns_401(self, client):
|
||||
"""Request with invalid token returns 401."""
|
||||
response = client.get(
|
||||
"/export/NVIDIA/pdf",
|
||||
headers={"Authorization": "Bearer invalid.token.here"},
|
||||
)
|
||||
assert response.status_code == 401
|
||||
|
||||
def test_pdf_export_filename_contains_date(self, client, mock_db):
|
||||
"""PDF filename includes the analysis date."""
|
||||
mock_db._mock_cursor.fetchall.return_value = _sample_rows()
|
||||
|
||||
response = client.get("/export/NVIDIA/pdf", headers=_auth_header())
|
||||
|
||||
assert response.status_code == 200
|
||||
disposition = response.headers["content-disposition"]
|
||||
assert "nvidia-analysis-" in disposition
|
||||
assert ".pdf" in disposition
|
||||
|
||||
def test_pdf_export_special_chars_in_response(self, client, mock_db):
|
||||
"""Analysis text with XML-special chars (<, >, &) does not break PDF generation."""
|
||||
rows = [
|
||||
(
|
||||
"TestCo",
|
||||
"company_analysis",
|
||||
"anthropic/claude-3.5-sonnet",
|
||||
"Revenue > $1B & growth <20% for Q4. Test <html> escaping.",
|
||||
datetime(2025, 6, 15, 10, 0, 0),
|
||||
),
|
||||
]
|
||||
mock_db._mock_cursor.fetchall.return_value = rows
|
||||
|
||||
response = client.get("/export/TestCo/pdf", headers=_auth_header())
|
||||
|
||||
assert response.status_code == 200
|
||||
assert response.content[:4] == b"%PDF"
|
||||
|
||||
def test_pdf_export_multiple_analyses(self, client, mock_db):
|
||||
"""Multiple analysis records produce a valid PDF with content."""
|
||||
mock_db._mock_cursor.fetchall.return_value = _sample_rows()
|
||||
|
||||
response = client.get("/export/NVIDIA/pdf", headers=_auth_header())
|
||||
|
||||
assert response.status_code == 200
|
||||
# PDF should have reasonable size (more than just headers)
|
||||
assert len(response.content) > 500
|
||||
@@ -1,263 +0,0 @@
|
||||
"""Tests for S3/MinIO storage backend in storage.py.
|
||||
|
||||
Covers issue #1660:
|
||||
- S3StorageBackend read, write, exists, path_for
|
||||
- Error handling: NoSuchKey, generic S3 errors, bucket auto-creation
|
||||
- get_storage_backend() factory function
|
||||
- LocalStorageBackend (basic sanity checks)
|
||||
"""
|
||||
|
||||
from unittest.mock import MagicMock, patch
|
||||
|
||||
import pytest
|
||||
|
||||
from SPARC.storage import LocalStorageBackend, S3StorageBackend, get_storage_backend
|
||||
|
||||
|
||||
# ---------- S3StorageBackend ----------
|
||||
|
||||
class TestS3StorageBackend:
|
||||
"""Tests for the S3-compatible storage backend."""
|
||||
|
||||
@pytest.fixture
|
||||
def s3_backend(self):
|
||||
"""Create an S3StorageBackend with a fully mocked boto3 client."""
|
||||
with patch.dict("sys.modules", {"boto3": MagicMock()}):
|
||||
import boto3 as mock_boto
|
||||
mock_s3 = MagicMock()
|
||||
mock_boto.client.return_value = mock_s3
|
||||
mock_s3.head_bucket.return_value = {}
|
||||
|
||||
backend = S3StorageBackend(
|
||||
bucket="test-bucket",
|
||||
endpoint_url="http://minio:9000",
|
||||
access_key="minioadmin",
|
||||
secret_key="minioadmin",
|
||||
)
|
||||
# Expose mock for assertions
|
||||
backend._mock_s3 = mock_s3
|
||||
yield backend
|
||||
|
||||
def test_write_puts_object(self, s3_backend):
|
||||
"""write() calls put_object with correct bucket, key, and body."""
|
||||
s3_backend.write("US-12345678-B2.pdf", b"PDF content here")
|
||||
|
||||
s3_backend._mock_s3.put_object.assert_called_once_with(
|
||||
Bucket="test-bucket",
|
||||
Key="US-12345678-B2.pdf",
|
||||
Body=b"PDF content here",
|
||||
ContentType="application/pdf",
|
||||
)
|
||||
|
||||
def test_read_returns_body(self, s3_backend):
|
||||
"""read() returns the Body content from get_object."""
|
||||
mock_body = MagicMock()
|
||||
mock_body.read.return_value = b"PDF data"
|
||||
s3_backend._mock_s3.get_object.return_value = {"Body": mock_body}
|
||||
|
||||
result = s3_backend.read("US-12345678-B2.pdf")
|
||||
|
||||
assert result == b"PDF data"
|
||||
s3_backend._mock_s3.get_object.assert_called_once_with(
|
||||
Bucket="test-bucket",
|
||||
Key="US-12345678-B2.pdf",
|
||||
)
|
||||
|
||||
def test_read_nosuchkey_raises_file_not_found(self, s3_backend):
|
||||
"""read() raises FileNotFoundError when object does not exist."""
|
||||
# Create a NoSuchKey exception class on the mock
|
||||
nosuchkey = type("NoSuchKey", (Exception,), {})
|
||||
s3_backend._mock_s3.exceptions.NoSuchKey = nosuchkey
|
||||
s3_backend._mock_s3.get_object.side_effect = nosuchkey("not found")
|
||||
|
||||
# Reassign s3 to trigger the except branch
|
||||
s3_backend.s3 = s3_backend._mock_s3
|
||||
|
||||
with pytest.raises(FileNotFoundError, match="S3 object not found"):
|
||||
s3_backend.read("missing.pdf")
|
||||
|
||||
def test_read_generic_404_raises_file_not_found(self, s3_backend):
|
||||
"""read() handles generic 404 errors from S3-compatible APIs."""
|
||||
nosuchkey = type("NoSuchKey", (Exception,), {})
|
||||
s3_backend._mock_s3.exceptions.NoSuchKey = nosuchkey
|
||||
s3_backend.s3 = s3_backend._mock_s3
|
||||
s3_backend.s3.get_object.side_effect = Exception("An error occurred (404)")
|
||||
|
||||
with pytest.raises(FileNotFoundError, match="S3 object not found"):
|
||||
s3_backend.read("missing.pdf")
|
||||
|
||||
def test_read_other_error_re_raises(self, s3_backend):
|
||||
"""read() re-raises non-404 errors."""
|
||||
nosuchkey = type("NoSuchKey", (Exception,), {})
|
||||
s3_backend._mock_s3.exceptions.NoSuchKey = nosuchkey
|
||||
s3_backend.s3 = s3_backend._mock_s3
|
||||
s3_backend.s3.get_object.side_effect = Exception("Internal server error")
|
||||
|
||||
with pytest.raises(Exception, match="Internal server error"):
|
||||
s3_backend.read("some-file.pdf")
|
||||
|
||||
def test_exists_returns_true_for_existing_object(self, s3_backend):
|
||||
"""exists() returns True when head_object succeeds with content."""
|
||||
s3_backend._mock_s3.head_object.return_value = {"ContentLength": 1024}
|
||||
|
||||
assert s3_backend.exists("US-12345678-B2.pdf") is True
|
||||
|
||||
def test_exists_returns_false_for_missing_object(self, s3_backend):
|
||||
"""exists() returns False when head_object raises an exception."""
|
||||
s3_backend._mock_s3.head_object.side_effect = Exception("Not Found")
|
||||
|
||||
assert s3_backend.exists("missing.pdf") is False
|
||||
|
||||
def test_exists_returns_false_for_zero_length(self, s3_backend):
|
||||
"""exists() returns False when object has zero content length."""
|
||||
s3_backend._mock_s3.head_object.return_value = {"ContentLength": 0}
|
||||
|
||||
assert s3_backend.exists("empty.pdf") is False
|
||||
|
||||
def test_path_for_returns_s3_uri(self, s3_backend):
|
||||
"""path_for() returns an s3:// URI."""
|
||||
path = s3_backend.path_for("US-12345678-B2.pdf")
|
||||
|
||||
assert path == "s3://test-bucket/US-12345678-B2.pdf"
|
||||
|
||||
def test_constructor_creates_bucket_if_missing(self):
|
||||
"""Constructor creates the bucket if head_bucket fails."""
|
||||
with patch.dict("sys.modules", {"boto3": MagicMock()}):
|
||||
import boto3 as mock_boto
|
||||
mock_s3 = MagicMock()
|
||||
mock_boto.client.return_value = mock_s3
|
||||
mock_s3.head_bucket.side_effect = Exception("Bucket not found")
|
||||
|
||||
S3StorageBackend(
|
||||
bucket="new-bucket",
|
||||
endpoint_url="http://minio:9000",
|
||||
access_key="admin",
|
||||
secret_key="admin",
|
||||
)
|
||||
|
||||
mock_s3.create_bucket.assert_called_once_with(Bucket="new-bucket")
|
||||
|
||||
def test_constructor_handles_bucket_creation_failure(self):
|
||||
"""Constructor logs warning but does not crash if bucket creation fails."""
|
||||
with patch.dict("sys.modules", {"boto3": MagicMock()}):
|
||||
import boto3 as mock_boto
|
||||
mock_s3 = MagicMock()
|
||||
mock_boto.client.return_value = mock_s3
|
||||
mock_s3.head_bucket.side_effect = Exception("Bucket not found")
|
||||
mock_s3.create_bucket.side_effect = Exception("Permission denied")
|
||||
|
||||
# Should not raise
|
||||
backend = S3StorageBackend(
|
||||
bucket="locked-bucket",
|
||||
endpoint_url="http://minio:9000",
|
||||
access_key="admin",
|
||||
secret_key="admin",
|
||||
)
|
||||
assert backend.bucket == "locked-bucket"
|
||||
|
||||
def test_constructor_passes_endpoint_and_credentials(self):
|
||||
"""Constructor passes endpoint_url and credentials to boto3.client."""
|
||||
with patch.dict("sys.modules", {"boto3": MagicMock()}):
|
||||
import boto3 as mock_boto
|
||||
mock_s3 = MagicMock()
|
||||
mock_boto.client.return_value = mock_s3
|
||||
|
||||
S3StorageBackend(
|
||||
bucket="test",
|
||||
endpoint_url="http://minio:9000",
|
||||
access_key="mykey",
|
||||
secret_key="mysecret",
|
||||
)
|
||||
|
||||
mock_boto.client.assert_called_with(
|
||||
"s3",
|
||||
endpoint_url="http://minio:9000",
|
||||
aws_access_key_id="mykey",
|
||||
aws_secret_access_key="mysecret",
|
||||
)
|
||||
|
||||
|
||||
# ---------- LocalStorageBackend ----------
|
||||
|
||||
class TestLocalStorageBackend:
|
||||
"""Basic sanity checks for the local filesystem backend."""
|
||||
|
||||
def test_write_and_read(self, tmp_path):
|
||||
"""Write and read round-trip produces identical content."""
|
||||
backend = LocalStorageBackend(base_dir=str(tmp_path))
|
||||
backend.write("test.pdf", b"hello world")
|
||||
|
||||
result = backend.read("test.pdf")
|
||||
assert result == b"hello world"
|
||||
|
||||
def test_read_missing_file_raises(self, tmp_path):
|
||||
"""Reading a non-existent file raises FileNotFoundError."""
|
||||
backend = LocalStorageBackend(base_dir=str(tmp_path))
|
||||
|
||||
with pytest.raises(FileNotFoundError):
|
||||
backend.read("nonexistent.pdf")
|
||||
|
||||
def test_exists_true_for_written_file(self, tmp_path):
|
||||
"""exists() returns True after writing a file."""
|
||||
backend = LocalStorageBackend(base_dir=str(tmp_path))
|
||||
backend.write("test.pdf", b"data")
|
||||
|
||||
assert backend.exists("test.pdf") is True
|
||||
|
||||
def test_exists_false_for_missing_file(self, tmp_path):
|
||||
"""exists() returns False for non-existent file."""
|
||||
backend = LocalStorageBackend(base_dir=str(tmp_path))
|
||||
|
||||
assert backend.exists("missing.pdf") is False
|
||||
|
||||
def test_exists_false_for_empty_file(self, tmp_path):
|
||||
"""exists() returns False for zero-length file."""
|
||||
backend = LocalStorageBackend(base_dir=str(tmp_path))
|
||||
backend.write("empty.pdf", b"")
|
||||
|
||||
assert backend.exists("empty.pdf") is False
|
||||
|
||||
def test_path_for_returns_full_path(self, tmp_path):
|
||||
"""path_for() returns the full filesystem path."""
|
||||
backend = LocalStorageBackend(base_dir=str(tmp_path))
|
||||
path = backend.path_for("test.pdf")
|
||||
|
||||
assert path == str(tmp_path / "test.pdf")
|
||||
|
||||
|
||||
# ---------- get_storage_backend() factory ----------
|
||||
|
||||
class TestGetStorageBackend:
|
||||
"""Tests for the storage backend factory function."""
|
||||
|
||||
@patch("SPARC.storage.config")
|
||||
def test_returns_local_backend_by_default(self, mock_config):
|
||||
"""Default config returns LocalStorageBackend."""
|
||||
mock_config.storage_backend = "local"
|
||||
|
||||
backend = get_storage_backend()
|
||||
|
||||
assert isinstance(backend, LocalStorageBackend)
|
||||
|
||||
@patch("SPARC.storage.config")
|
||||
def test_returns_s3_backend_when_configured(self, mock_config):
|
||||
"""Setting storage_backend=s3 returns S3StorageBackend."""
|
||||
mock_config.storage_backend = "s3"
|
||||
mock_config.s3_bucket = "test-bucket"
|
||||
mock_config.s3_endpoint_url = "http://minio:9000"
|
||||
mock_config.s3_access_key = "key"
|
||||
mock_config.s3_secret_key = "secret"
|
||||
|
||||
with patch.dict("sys.modules", {"boto3": MagicMock()}):
|
||||
backend = get_storage_backend()
|
||||
|
||||
assert isinstance(backend, S3StorageBackend)
|
||||
|
||||
@patch("SPARC.storage.config")
|
||||
def test_case_insensitive_backend_selection(self, mock_config):
|
||||
"""Backend selection is case-insensitive."""
|
||||
mock_config.storage_backend = "LOCAL"
|
||||
|
||||
backend = get_storage_backend()
|
||||
|
||||
assert isinstance(backend, LocalStorageBackend)
|
||||
Reference in New Issue
Block a user