mirror of
https://github.com/azaion/satellite-provider.git
synced 2026-06-21 10:31:14 +00:00
[AZ-284] Autodev baseline + testability refactor
Phase A baseline outputs from /autodev (Steps 1-5): - Problem & solution docs (_docs/00_problem, _docs/01_solution) - Codebase documentation (_docs/02_document) incl. architecture, module-layout, glossary, system-flows, baseline compliance scan - Test specs (blackbox, performance, resilience, security, resource, traceability matrix) - Test task decomposition (_docs/02_tasks/todo): AZ-285..AZ-290 - Testability refactor (_docs/04_refactoring/01-testability-refactoring): - TC-01 Move DownloadedTileInfoV2 + new ExistingTileInfo to Common.DTO - TC-02 Replace dead ISatelliteDownloader API with real signatures - TC-03 GoogleMapsDownloaderV2 implements ISatelliteDownloader - TC-04 TileService depends on ISatelliteDownloader (mockable) - TC-05 DI + endpoints use ISatelliteDownloader - Test runner scripts (scripts/run-tests.sh, run-performance-tests.sh) - Autodev state pointer (_docs/_autodev_state.md) Prepares the codebase for AZ-285..AZ-290 unit/integration test work. Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
Oleksandr Bezdieniezhnykh
@@ -0,0 +1,208 @@
|
||||
# Codebase Discovery
|
||||
|
||||
## Directory Tree
|
||||
|
||||
```
|
||||
satellite-provider/
|
||||
├── SatelliteProvider.sln
|
||||
├── global.json
|
||||
├── docker-compose.yml
|
||||
├── docker-compose.tests.yml
|
||||
├── goal.md
|
||||
├── README.md
|
||||
├── AGENTS.md
|
||||
├── .woodpecker/
|
||||
│ ├── 01-test.yml
|
||||
│ └── 02-build-push.yml
|
||||
├── SatelliteProvider.Api/
|
||||
│ ├── Dockerfile
|
||||
│ ├── Program.cs
|
||||
│ ├── SatelliteProvider.Api.csproj
|
||||
│ ├── Properties/launchSettings.json
|
||||
│ ├── appsettings.json
|
||||
│ └── appsettings.Development.json
|
||||
├── SatelliteProvider.Common/
|
||||
│ ├── SatelliteProvider.Common.csproj
|
||||
│ ├── Configs/
|
||||
│ │ ├── DatabaseConfig.cs
|
||||
│ │ ├── MapConfig.cs
|
||||
│ │ ├── ProcessingConfig.cs
|
||||
│ │ └── StorageConfig.cs
|
||||
│ ├── DTO/
|
||||
│ │ ├── CreateRouteRequest.cs
|
||||
│ │ ├── Direction.cs
|
||||
│ │ ├── GeoPoint.cs
|
||||
│ │ ├── GeofencePolygon.cs
|
||||
│ │ ├── RegionRequest.cs
|
||||
│ │ ├── RegionStatus.cs
|
||||
│ │ ├── RoutePoint.cs
|
||||
│ │ ├── RoutePointDto.cs
|
||||
│ │ ├── RouteResponse.cs
|
||||
│ │ ├── SatTile.cs
|
||||
│ │ └── TileMetadata.cs
|
||||
│ ├── Interfaces/
|
||||
│ │ ├── IRegionRequestQueue.cs
|
||||
│ │ ├── IRegionService.cs
|
||||
│ │ ├── IRouteService.cs
|
||||
│ │ ├── ISatelliteDownloader.cs
|
||||
│ │ └── ITileService.cs
|
||||
│ └── Utils/
|
||||
│ └── GeoUtils.cs
|
||||
├── SatelliteProvider.DataAccess/
|
||||
│ ├── SatelliteProvider.DataAccess.csproj
|
||||
│ ├── DatabaseMigrator.cs
|
||||
│ ├── Migrations/
|
||||
│ │ ├── 001_CreateTilesTable.sql
|
||||
│ │ ├── 002_CreateRegionsTable.sql
|
||||
│ │ ├── 003_CreateIndexes.sql
|
||||
│ │ ├── 004_AddVersionColumn.sql
|
||||
│ │ ├── 005_CreateRoutesTables.sql
|
||||
│ │ ├── 006_AddStitchTilesToRegions.sql
|
||||
│ │ ├── 007_AddRouteMapFields.sql
|
||||
│ │ ├── 008_AddGeofenceFlagToRouteRegions.sql
|
||||
│ │ ├── 009_AddGeofencePolygonIndex.sql
|
||||
│ │ ├── 010_AddTilesZipToRoutes.sql
|
||||
│ │ └── 011_AddTileCoordinates.sql
|
||||
│ ├── Models/
|
||||
│ │ ├── RegionEntity.cs
|
||||
│ │ ├── RouteEntity.cs
|
||||
│ │ ├── RoutePointEntity.cs
|
||||
│ │ └── TileEntity.cs
|
||||
│ └── Repositories/
|
||||
│ ├── IRegionRepository.cs
|
||||
│ ├── IRouteRepository.cs
|
||||
│ ├── ITileRepository.cs
|
||||
│ ├── RegionRepository.cs
|
||||
│ ├── RouteRepository.cs
|
||||
│ └── TileRepository.cs
|
||||
├── SatelliteProvider.Services/
|
||||
│ ├── SatelliteProvider.Services.csproj
|
||||
│ ├── GoogleMapsDownloaderV2.cs
|
||||
│ ├── RegionProcessingService.cs
|
||||
│ ├── RegionRequestQueue.cs
|
||||
│ ├── RegionService.cs
|
||||
│ ├── RouteProcessingService.cs
|
||||
│ ├── RouteService.cs
|
||||
│ └── TileService.cs
|
||||
├── SatelliteProvider.Tests/
|
||||
│ ├── SatelliteProvider.Tests.csproj
|
||||
│ ├── GoogleMapsDownloaderTests.cs
|
||||
│ └── appsettings.json
|
||||
└── SatelliteProvider.IntegrationTests/
|
||||
├── SatelliteProvider.IntegrationTests.csproj
|
||||
├── Dockerfile
|
||||
├── Program.cs
|
||||
├── Models.cs
|
||||
├── BasicRouteTests.cs
|
||||
├── ComplexRouteTests.cs
|
||||
├── ExtendedRouteTests.cs
|
||||
├── RegionTests.cs
|
||||
├── TileTests.cs
|
||||
└── RouteTestHelpers.cs
|
||||
```
|
||||
|
||||
## Tech Stack
|
||||
|
||||
| Category | Technology | Version |
|
||||
|----------|-----------|---------|
|
||||
| Language | C# | 12 (.NET 8.0) |
|
||||
| Framework | ASP.NET Core (Minimal API) | 8.0 |
|
||||
| Database | PostgreSQL | 16 (Docker image) |
|
||||
| ORM/Data Access | Dapper | 2.1.35 |
|
||||
| DB Migrations | DbUp (PostgreSQL) | 6.0.3 |
|
||||
| Logging | Serilog (Console + File) | 8.0.3 |
|
||||
| Image Processing | SixLabors.ImageSharp | 3.1.11 |
|
||||
| JSON Serialization | Newtonsoft.Json + System.Text.Json | 13.0.4 |
|
||||
| API Docs | Swagger / Swashbuckle | 6.6.2 |
|
||||
| HTTP Client | IHttpClientFactory | built-in |
|
||||
| Containerization | Docker (multi-stage) | - |
|
||||
| Orchestration | Docker Compose | - |
|
||||
| CI/CD | Woodpecker CI | - |
|
||||
| Unit Testing | xUnit + Moq + FluentAssertions | 2.5.3 / 4.20.72 / 8.8.0 |
|
||||
| Integration Testing | Console app (custom harness) | - |
|
||||
| SDK | .NET 8.0 (latestMinor rollForward) | 8.0.0+ |
|
||||
|
||||
## Dependency Graph
|
||||
|
||||
### Project References
|
||||
|
||||
```
|
||||
SatelliteProvider.Common (leaf — no project references)
|
||||
SatelliteProvider.DataAccess (leaf — no project references; NuGet: Dapper, Npgsql, DbUp)
|
||||
SatelliteProvider.Services → Common, DataAccess
|
||||
SatelliteProvider.Api → Common, DataAccess, Services
|
||||
SatelliteProvider.Tests → Services, Common
|
||||
SatelliteProvider.IntegrationTests (standalone console app, no project references)
|
||||
```
|
||||
|
||||
### Mermaid Dependency Diagram
|
||||
|
||||
```mermaid
|
||||
graph TD
|
||||
Api[SatelliteProvider.Api] --> Services[SatelliteProvider.Services]
|
||||
Api --> DataAccess[SatelliteProvider.DataAccess]
|
||||
Api --> Common[SatelliteProvider.Common]
|
||||
Services --> DataAccess
|
||||
Services --> Common
|
||||
Tests[SatelliteProvider.Tests] --> Services
|
||||
Tests --> Common
|
||||
IntTests[SatelliteProvider.IntegrationTests] -.->|HTTP calls| Api
|
||||
```
|
||||
|
||||
## Topological Processing Order
|
||||
|
||||
Leaf modules first, then dependent modules:
|
||||
|
||||
1. **SatelliteProvider.Common** — DTOs, interfaces, configs, geo utilities (no internal dependencies)
|
||||
2. **SatelliteProvider.DataAccess** — entities, repositories, migrations (no project dependencies)
|
||||
3. **SatelliteProvider.Services** — business logic (depends on Common + DataAccess)
|
||||
4. **SatelliteProvider.Api** — web layer, DI, endpoints (depends on all above)
|
||||
5. **SatelliteProvider.Tests** — unit tests (depends on Services + Common)
|
||||
6. **SatelliteProvider.IntegrationTests** — integration tests via HTTP (standalone)
|
||||
|
||||
## Entry Points
|
||||
|
||||
- **Application entry**: `SatelliteProvider.Api/Program.cs` — minimal API startup, DI registration, DB migration, endpoint mapping
|
||||
- **Background services**: `RegionProcessingService` (queue consumer), `RouteProcessingService` (polling loop)
|
||||
- **Integration test entry**: `SatelliteProvider.IntegrationTests/Program.cs`
|
||||
|
||||
## Leaf Modules
|
||||
|
||||
- `SatelliteProvider.Common/Configs/*` — configuration POCOs
|
||||
- `SatelliteProvider.Common/DTO/*` — data transfer objects
|
||||
- `SatelliteProvider.Common/Interfaces/*` — service contracts
|
||||
- `SatelliteProvider.Common/Utils/GeoUtils.cs` — static geo math utilities
|
||||
- `SatelliteProvider.DataAccess/Models/*` — database entity classes
|
||||
- `SatelliteProvider.DataAccess/Migrations/*` — SQL migration scripts
|
||||
|
||||
## Cycles
|
||||
|
||||
No dependency cycles detected. The dependency graph is a clean DAG.
|
||||
|
||||
## External Integrations
|
||||
|
||||
| Integration | Module | Protocol |
|
||||
|-------------|--------|----------|
|
||||
| Google Maps Tile API | GoogleMapsDownloaderV2 | HTTPS (tile.googleapis.com, mt*.google.com) |
|
||||
| PostgreSQL | All repositories | TCP (Npgsql, port 5432) |
|
||||
| File system (tiles) | StorageConfig, TileService, GoogleMapsDownloaderV2 | Local FS (./tiles/) |
|
||||
| File system (output) | RegionService, RouteProcessingService | Local FS (./ready/) |
|
||||
| File system (logs) | Serilog | Local FS (./logs/) |
|
||||
|
||||
## Existing Documentation
|
||||
|
||||
- `README.md` — comprehensive API docs, architecture overview, configuration guide
|
||||
- `AGENTS.md` — agent-oriented documentation with architecture details and conventions
|
||||
- `goal.md` — original requirements and TODO items
|
||||
- Swagger/OpenAPI — auto-generated at runtime (`/swagger`)
|
||||
|
||||
## Test Structure
|
||||
|
||||
- **Unit tests**: `SatelliteProvider.Tests/` — xUnit, currently contains only a dummy test (`DummyTests.Dummy_ShouldWork`)
|
||||
- **Integration tests**: `SatelliteProvider.IntegrationTests/` — console app that runs against a live API+DB instance in Docker. Tests cover tile downloads, region requests, route creation with intermediate points, geofencing, extended routes with map requests.
|
||||
|
||||
## CI/CD
|
||||
|
||||
- **Woodpecker CI** pipelines in `.woodpecker/`:
|
||||
- `01-test.yml`: runs `dotnet restore` + `dotnet test` on push/PR to dev/stage/main (ARM64)
|
||||
- `02-build-push.yml`: builds Docker image and pushes to private registry (depends on 01-test, ARM64 matrix with AMD64 slot commented out)
|
||||
Reference in New Issue
Block a user