Files
calminer/tests/test_repositories.py
zwitschi 795a9f99f4 feat: Enhance currency handling and validation across scenarios
- Updated form template to prefill currency input with default value and added help text for clarity.
- Modified integration tests to assert more descriptive error messages for invalid currency codes.
- Introduced new tests for currency normalization and validation in various scenarios, including imports and exports.
- Added comprehensive tests for pricing calculations, ensuring defaults are respected and overrides function correctly.
- Implemented unit tests for pricing settings repository, ensuring CRUD operations and default settings are handled properly.
- Enhanced scenario pricing evaluation tests to validate currency handling and metadata defaults.
- Added simulation tests to ensure Monte Carlo runs are accurate and handle various distribution scenarios.
2025-11-11 18:29:59 +01:00

429 lines
14 KiB
Python

from __future__ import annotations
from collections.abc import Iterator
from datetime import date, datetime, timezone
import pytest
from sqlalchemy import create_engine
from sqlalchemy.orm import Session, sessionmaker
from config.database import Base
from models import (
DistributionType,
FinancialCategory,
FinancialInput,
MiningOperationType,
PricingSettings,
Project,
Scenario,
ScenarioStatus,
ResourceType,
SimulationParameter,
StochasticVariable,
)
from services.repositories import (
FinancialInputRepository,
ProjectRepository,
ScenarioRepository,
SimulationParameterRepository,
)
from services.export_query import ProjectExportFilters, ScenarioExportFilters
from services.unit_of_work import UnitOfWork
@pytest.fixture()
def engine():
engine = create_engine("sqlite:///:memory:", future=True)
Base.metadata.create_all(bind=engine)
try:
yield engine
finally:
Base.metadata.drop_all(bind=engine)
@pytest.fixture()
def session(engine) -> Iterator[Session]:
TestingSession = sessionmaker(bind=engine, expire_on_commit=False, future=True)
session = TestingSession()
try:
yield session
finally:
session.close()
def test_project_repository_create_and_list(session: Session) -> None:
repo = ProjectRepository(session)
project = Project(name="Project Alpha", operation_type=MiningOperationType.OPEN_PIT)
repo.create(project)
projects = repo.list()
assert len(projects) == 1
assert projects[0].name == "Project Alpha"
def test_scenario_repository_get_with_children(session: Session) -> None:
project = Project(name="Project Beta", operation_type=MiningOperationType.UNDERGROUND)
scenario = Scenario(name="Scenario 1", project=project, status=ScenarioStatus.ACTIVE)
scenario.financial_inputs.append(
FinancialInput(
name="Lease Payment",
category=FinancialCategory.OPERATING_EXPENDITURE,
amount=10000,
currency="usd",
)
)
scenario.simulation_parameters.append(
SimulationParameter(
name="Copper Price",
distribution=DistributionType.NORMAL,
mean_value=3.5,
variable=StochasticVariable.METAL_PRICE,
)
)
session.add(project)
session.flush()
repo = ScenarioRepository(session)
retrieved = repo.get(scenario.id, with_children=True)
assert retrieved.project.name == "Project Beta"
assert len(retrieved.financial_inputs) == 1
assert retrieved.financial_inputs[0].currency == "USD"
assert len(retrieved.simulation_parameters) == 1
assert (
retrieved.simulation_parameters[0].variable
== StochasticVariable.METAL_PRICE
)
param_repo = SimulationParameterRepository(session)
params = param_repo.list_for_scenario(scenario.id)
assert len(params) == 1
def test_financial_input_repository_bulk_upsert(session: Session) -> None:
project = Project(name="Project Gamma", operation_type=MiningOperationType.QUARRY)
scenario = Scenario(name="Scenario Bulk", project=project)
session.add(project)
session.flush()
repo = FinancialInputRepository(session)
created = repo.bulk_upsert(
[
FinancialInput(
scenario_id=scenario.id,
name="Explosives",
category=FinancialCategory.OPERATING_EXPENDITURE,
amount=5000,
currency="cad",
),
FinancialInput(
scenario_id=scenario.id,
name="Equipment Lease",
category=FinancialCategory.OPERATING_EXPENDITURE,
amount=12000,
currency="cad",
),
]
)
assert len(created) == 2
stored = repo.list_for_scenario(scenario.id)
assert len(stored) == 2
assert all(item.currency == "CAD" for item in stored)
def test_unit_of_work_commit_and_rollback(engine) -> None:
TestingSession = sessionmaker(bind=engine, expire_on_commit=False, future=True)
# Commit path
with UnitOfWork(session_factory=TestingSession) as uow:
assert uow.projects is not None
uow.projects.create(
Project(name="Project Delta", operation_type=MiningOperationType.PLACER)
)
with TestingSession() as session:
projects = ProjectRepository(session).list()
assert len(projects) == 1
def test_unit_of_work_set_project_pricing_settings(engine) -> None:
TestingSession = sessionmaker(bind=engine, expire_on_commit=False, future=True)
with UnitOfWork(session_factory=TestingSession) as uow:
assert uow.projects is not None and uow.pricing_settings is not None
project = Project(name="Project Pricing", operation_type=MiningOperationType.OTHER)
uow.projects.create(project)
pricing_settings = PricingSettings(
name="Default Pricing",
slug="default",
default_currency="usd",
default_payable_pct=100.0,
moisture_threshold_pct=8.0,
moisture_penalty_per_pct=0.0,
)
uow.pricing_settings.create(pricing_settings)
uow.set_project_pricing_settings(project, pricing_settings)
with TestingSession() as session:
repo = ProjectRepository(session)
stored = repo.get(1, with_pricing=True)
assert stored.pricing_settings is not None
assert stored.pricing_settings.slug == "default"
# Rollback path
with pytest.raises(RuntimeError):
with UnitOfWork(session_factory=TestingSession) as uow:
assert uow.projects is not None
uow.projects.create(
Project(name="Project Epsilon", operation_type=MiningOperationType.OTHER)
)
raise RuntimeError("trigger rollback")
with TestingSession() as session:
projects = ProjectRepository(session).list()
assert len(projects) == 1
def test_project_repository_count_and_recent(session: Session) -> None:
repo = ProjectRepository(session)
project_alpha = Project(name="Alpha", operation_type=MiningOperationType.OPEN_PIT)
project_bravo = Project(name="Bravo", operation_type=MiningOperationType.UNDERGROUND)
repo.create(project_alpha)
repo.create(project_bravo)
project_alpha.updated_at = datetime(2025, 1, 1, tzinfo=timezone.utc)
project_bravo.updated_at = datetime(2025, 1, 2, tzinfo=timezone.utc)
session.flush()
assert repo.count() == 2
recent = repo.recent(limit=1)
assert len(recent) == 1
assert recent[0].name == "Bravo"
def test_scenario_repository_counts_and_filters(session: Session) -> None:
project = Project(name="Project", operation_type=MiningOperationType.PLACER)
session.add(project)
session.flush()
repo = ScenarioRepository(session)
draft = Scenario(name="Draft", project_id=project.id,
status=ScenarioStatus.DRAFT)
active = Scenario(name="Active", project_id=project.id,
status=ScenarioStatus.ACTIVE)
repo.create(draft)
repo.create(active)
draft.updated_at = datetime(2025, 1, 1, tzinfo=timezone.utc)
active.updated_at = datetime(2025, 1, 3, tzinfo=timezone.utc)
session.flush()
assert repo.count() == 2
assert repo.count_by_status(ScenarioStatus.ACTIVE) == 1
recent = repo.recent(limit=1, with_project=True)
assert len(recent) == 1
assert recent[0].name == "Active"
assert recent[0].project.name == "Project"
drafts = repo.list_by_status(ScenarioStatus.DRAFT, limit=2, with_project=True)
assert len(drafts) == 1
assert drafts[0].name == "Draft"
assert drafts[0].project_id == project.id
def test_financial_input_repository_latest_created_at(session: Session) -> None:
project = Project(name="Project FI", operation_type=MiningOperationType.OTHER)
scenario = Scenario(name="Scenario FI", project=project)
session.add(project)
session.flush()
repo = FinancialInputRepository(session)
old_timestamp = datetime(2024, 12, 31, 15, 0)
new_timestamp = datetime(2025, 1, 2, 8, 30)
repo.bulk_upsert(
[
FinancialInput(
scenario_id=scenario.id,
name="Legacy Entry",
category=FinancialCategory.OPERATING_EXPENDITURE,
amount=1000,
currency="usd",
created_at=old_timestamp,
updated_at=old_timestamp,
),
FinancialInput(
scenario_id=scenario.id,
name="New Entry",
category=FinancialCategory.OPERATING_EXPENDITURE,
amount=2000,
currency="usd",
created_at=new_timestamp,
updated_at=new_timestamp,
),
]
)
latest = repo.latest_created_at()
assert latest == new_timestamp
def test_project_repository_filtered_for_export(session: Session) -> None:
repo = ProjectRepository(session)
alpha_created = datetime(2025, 1, 1, 9, 30, tzinfo=timezone.utc)
alpha_updated = datetime(2025, 1, 2, 12, 0, tzinfo=timezone.utc)
bravo_created = datetime(2025, 2, 1, 9, 30, tzinfo=timezone.utc)
bravo_updated = datetime(2025, 2, 2, 12, 0, tzinfo=timezone.utc)
project_alpha = Project(
name="Alpha",
location="Nevada",
operation_type=MiningOperationType.OPEN_PIT,
description="Primary export candidate",
)
project_alpha.created_at = alpha_created
project_alpha.updated_at = alpha_updated
project_bravo = Project(
name="Bravo",
location="Ontario",
operation_type=MiningOperationType.UNDERGROUND,
description="Excluded project",
)
project_bravo.created_at = bravo_created
project_bravo.updated_at = bravo_updated
scenario_alpha = Scenario(
name="Alpha Scenario",
project=project_alpha,
status=ScenarioStatus.ACTIVE,
)
session.add_all([project_alpha, project_bravo, scenario_alpha])
session.flush()
filters = ProjectExportFilters(
ids=(project_alpha.id, project_alpha.id, -5),
names=("Alpha", " alpha ", ""),
name_contains="alp",
locations=(" nevada ", ""),
operation_types=(MiningOperationType.OPEN_PIT,),
created_from=alpha_created,
created_to=alpha_created,
updated_from=alpha_updated,
updated_to=alpha_updated,
)
results = repo.filtered_for_export(filters, include_scenarios=True)
assert [project.name for project in results] == ["Alpha"]
assert len(results[0].scenarios) == 1
assert results[0].scenarios[0].name == "Alpha Scenario"
def test_project_repository_with_pricing_settings(session: Session) -> None:
repo = ProjectRepository(session)
settings = PricingSettings(
name="Contract Core",
slug="contract-core",
default_currency="usd",
default_payable_pct=95.0,
moisture_threshold_pct=7.5,
moisture_penalty_per_pct=100.0,
)
project = Project(
name="Project Pricing",
operation_type=MiningOperationType.OPEN_PIT,
pricing_settings=settings,
)
session.add(project)
session.flush()
fetched = repo.get(project.id, with_pricing=True)
assert fetched.pricing_settings is not None
assert fetched.pricing_settings.slug == "contract-core"
assert fetched.pricing_settings.default_currency == "USD"
listed = repo.list(with_pricing=True)
assert listed[0].pricing_settings is not None
repo.set_pricing_settings(project, None)
session.refresh(project)
assert project.pricing_settings is None
repo.set_pricing_settings(project, settings)
session.refresh(project)
assert project.pricing_settings is settings
export_results = repo.filtered_for_export(None, include_pricing=True)
assert export_results[0].pricing_settings is not None
def test_scenario_repository_filtered_for_export(session: Session) -> None:
repo = ScenarioRepository(session)
project_export = Project(
name="Export Project",
operation_type=MiningOperationType.PLACER,
)
project_other = Project(
name="Other Project",
operation_type=MiningOperationType.OTHER,
)
scenario_match = Scenario(
name="Case Alpha",
project=project_export,
status=ScenarioStatus.ACTIVE,
start_date=date(2025, 1, 5),
end_date=date(2025, 2, 1),
discount_rate=7.5,
currency="usd",
primary_resource=ResourceType.EXPLOSIVES,
)
scenario_match.created_at = datetime(2025, 1, 6, tzinfo=timezone.utc)
scenario_match.updated_at = datetime(2025, 1, 16, tzinfo=timezone.utc)
scenario_other = Scenario(
name="Case Beta",
project=project_other,
status=ScenarioStatus.DRAFT,
start_date=date(2024, 12, 20),
end_date=date(2025, 3, 1),
currency="cad",
primary_resource=ResourceType.WATER,
)
scenario_other.created_at = datetime(2024, 12, 25, tzinfo=timezone.utc)
scenario_other.updated_at = datetime(2025, 3, 5, tzinfo=timezone.utc)
session.add_all([project_export, project_other, scenario_match, scenario_other])
session.flush()
filters = ScenarioExportFilters(
ids=(scenario_match.id, scenario_match.id, -1),
project_ids=(project_export.id, 0),
project_names=(" Export Project ", "EXPORT PROJECT"),
name_contains="case",
statuses=(ScenarioStatus.ACTIVE,),
start_date_from=date(2025, 1, 1),
start_date_to=date(2025, 1, 31),
end_date_from=date(2025, 1, 31),
end_date_to=date(2025, 2, 28),
created_from=datetime(2025, 1, 1, tzinfo=timezone.utc),
created_to=datetime(2025, 1, 31, tzinfo=timezone.utc),
updated_from=datetime(2025, 1, 10, tzinfo=timezone.utc),
updated_to=datetime(2025, 1, 31, tzinfo=timezone.utc),
currencies=(" usd ", "USD"),
primary_resources=(ResourceType.EXPLOSIVES,),
)
results = repo.filtered_for_export(filters, include_project=True)
assert [scenario.name for scenario in results] == ["Case Alpha"]
assert results[0].project.name == "Export Project"