Files

Scott Idem 17a627a981 feat: Implement Event File Hosted Data Fix and API Guide Update

Address critical data visibility issues for Event Files and enhance frontend documentation.

This commit resolves the persistent problem where top-level hosted file convenience fields
(e.g., , , ) were
returning as  in V3 Event File API responses, even when .

Key changes include:
- Refactored  Pydantic model:
    - Removed redundant  definitions from top-level hosted file convenience fields,
      allowing direct mapping from SQL view columns.
    - Simplified  to focus solely on conditionally loading the nested
       object, as top-level fields are now populated directly by Pydantic
      from the  view.
    - Added comprehensive comments to clarify data flow, Pydantic's behavior, and the
      expected origin of these convenience fields from SQL views.
- Updated :
    - Introduced a new section detailing how to retrieve Event File data, including the
      use of  to get both top-level convenience fields and a nested
       object.
    - Clarified all ID references as random string IDs.
    - Renumbered the troubleshooting section.
- Copied updated guide to .
- Continued ID Vision compliance audit, ensuring consistent handling of random string IDs
  across various core and event models (Account, Address, Contact, DataStore, Event Badge Template).
- Consolidated ID Vision E2E tests and updated related documentation.
- Minor updates to  and
  to support Event File data retrieval with .

2026-02-19 15:22:17 -05:00

4.6 KiB

Raw Blame History

Aether API Test Suite

This directory contains the automated and manual test scripts for the Aether FastAPI backend. The suite is organized by execution environment and scope to ensure a reliable development workflow.

📁 Directory Structure

unit/: Isolated logic tests. These use heavy mocking to bypass database and network requirements. Fast and safe to run in any environment.
integration/: Local environment tests. These verify component interactions, often requiring a connection to the local MariaDB/Redis instance.
e2e/ (End-to-End): Network-based API tests. these use the requests library to call the live API endpoints at https://dev-api.oneskyit.com.
tools/: Utility scripts for administrative tasks like registry generation or Docker exploration.
archive/: Legacy or deprecated scripts kept for historical reference.

📜 Standardized E2E Suite (`tests/e2e/`)

These consolidated scripts are the primary verification tool for the V3 API.

Script	Description
`test_e2e_v3_search_engine.py`	Primary Search: Basic operators, Registry fields, Nested search, and Filter bypass.
`test_e2e_v3_security_audit.py`	Core Security: Verifies multi-tenant isolation, cross-account write blocking, and ID Vision compliance.
`test_e2e_v3_auth_security.py`	Primary Auth: Site bootstrap, Passcode-to-JWT, and permission boundaries.
`test_e2e_v3_actions_file_lifecycle.py`	Primary Actions: Upload, Download (ID/Hash/Streaming), and physical Deletion.
`test_e2e_v3_data_store_lookup.py`	V3 Parity: Verifies code-based lookups and latency simulation.
`test_e2e_redis_extensive.py`	Redis Stress: Benchmarks bidirectional ID caching across thousands of records.
`test_e2e_v3_event_vision_parity.py`	Vision ID: Verifies string-ID enforcement across event models.
`test_e2e_v3_cms_vision_parity.py`	Vision ID: Verifies string-ID enforcement across CMS (post/comment) models.
`test_e2e_v3_core_vision_parity.py`	Vision ID: Verifies string-ID and polymorphic resolution across core models (Account, Person, Address, Contact, DataStore).
`test_e2e_v3_demo_parity.py`	Demo Parity: Comprehensive check for Badge, Exhibit, Tracking, and nested Journal Entries.
`test_e2e_v3_action_event_file.py`	Event Actions: Specialized atomic upload and linking for event files.
`test_e2e_v3_action_zoom.py`	Zoom Integration: Verifies OAuth and ticket sync logic for Zoom Events.
`test_e2e_v3_accounts.py`	CRUD verification for the core Account object.
`test_e2e_v3_schema.py`	Network verification of the V3 metadata discovery endpoint.
`test_e2e_agent_bridge.py`	Verifies container diagnostics and log streaming routes.
`cleanup_test_files.py`	Utility to purge E2E artifacts from physical storage.

🛠️ Shared Helpers

mock_config_helper.py: A critical utility that mocks app.config.settings before other modules are imported. Use this in unit tests.

🧹 Maintenance Policy

Standardization: All E2E tests should use the standard Agent API Key (PMM4n50teUCaOMMTN8qOJA) and provide clean [✅ PASS] or [❌ FAIL] output.
Archiving: When a new specialized test is created, check if it can be combined into one of the "Primary" suites above. If so, combine and move the original to archive/.
Cleanup: Always use tests/e2e/cleanup_test_files.py after running file lifecycle tests.

🛠️ Standards & Patterns

To maintain a "nice" and readable test suite, follow these patterns in all new Python E2E scripts:

Helper Functions: Use a print_result(label, success, message="") helper to output standardized ✅ PASS and ❌ FAIL status lines.
Functional Isolation: Wrap test scenarios in descriptive functions (e.g., test_hierarchical_fallback()) rather than writing monolithic scripts.
Vision Compliance: Always verify that IDs in the response are strings (Random IDs) and not integers, to ensure "ID Vision" is working.
Performance Logging: Include a suite timer at the end of the if __name__ == "__main__": block to track execution speed.
Clean Environment: Do not leave temporary debug or local-only scripts in the e2e/ directory.

🚀 How to Run

Recommended: Use the project virtual environment

./environment/bin/python3 tests/e2e/test_e2e_v3_search_engine.py

Path Requirements

Always run test scripts from the project root directory. Most scripts include sys.path.append(os.getcwd()) to ensure local imports work correctly.

4.6 KiB Raw Blame History