Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,14 @@ def transformed_transition_evidence(
if not transitions_path.exists() and transitions_fallback.exists():
transitions_path = transitions_fallback

# Read gate thresholds outside the best-effort blocks below, so a mistyped
# value raises instead of silently dropping the gate entry.
date_min = _env_float("SBIR_ETL__TRANSITION__CONTRACTS__DATE_COVERAGE_MIN", 0.90)
id_min = _env_float("SBIR_ETL__TRANSITION__CONTRACTS__IDENT_COVERAGE_MIN", 0.60)
min_size = _env_int("SBIR_ETL__TRANSITION__CONTRACTS__SAMPLE_SIZE_MIN", 1000)
max_size = _env_int("SBIR_ETL__TRANSITION__CONTRACTS__SAMPLE_SIZE_MAX", 10000)
min_rate = _env_float("SBIR_ETL__TRANSITION__VENDOR_RESOLUTION__MIN_RATE", 0.60)

# Emit a lightweight validation summary for the MVP
try:
summary = {
Expand Down Expand Up @@ -140,11 +148,7 @@ def transformed_transition_evidence(
cs = json.load(fh)
date_cov = float(cs.get("coverage", {}).get("action_date", 0.0))
any_id_cov = float(cs.get("coverage", {}).get("any_identifier", 0.0))
date_min = _env_float("SBIR_ETL__TRANSITION__CONTRACTS__DATE_COVERAGE_MIN", 0.90)
id_min = _env_float("SBIR_ETL__TRANSITION__CONTRACTS__IDENT_COVERAGE_MIN", 0.60)
total_rows = int(cs.get("total_rows", 0))
min_size = _env_int("SBIR_ETL__TRANSITION__CONTRACTS__SAMPLE_SIZE_MIN", 1000)
max_size = _env_int("SBIR_ETL__TRANSITION__CONTRACTS__SAMPLE_SIZE_MAX", 10000)
size_ok = (
(total_rows >= min_size) and (total_rows <= max_size)
if total_rows > 0
Expand Down Expand Up @@ -184,7 +188,6 @@ def transformed_transition_evidence(
with vr_checks_path.open("r", encoding="utf-8") as fh:
vr = json.load(fh)
res_rate = float(vr.get("stats", {}).get("resolution_rate", 0.0))
min_rate = _env_float("SBIR_ETL__TRANSITION__VENDOR_RESOLUTION__MIN_RATE", 0.60)
summary["gates"]["enriched_vendor_resolution"] = { # type: ignore[index]
"passed": res_rate >= min_rate,
"resolution_rate": res_rate,
Expand Down
16 changes: 2 additions & 14 deletions packages/sbir-analytics/sbir_analytics/assets/transition/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@
from loguru import logger

# Configuration and extractor imports (re-exported for use by other transition modules)
from sbir_etl.config.loader import env_float as _env_float
from sbir_etl.config.loader import env_int as _env_int
from sbir_etl.config.loader import get_config # noqa: F401
from sbir_etl.extractors.contract_extractor import ContractExtractor # noqa: F401
from sbir_etl.identity import CompanyNameProfile, normalize_company_name
Expand Down Expand Up @@ -138,20 +140,6 @@ def _norm_name(s: str | None) -> str:
return normalize_company_name(s, profile=CompanyNameProfile.LOWER_JOIN_V1)


def _env_float(key: str, default: float) -> float:
try:
return float(os.getenv(key, str(default)))
except Exception:
return default


def _env_int(key: str, default: int) -> int:
try:
return int(os.getenv(key, str(default)))
except Exception:
return default


def _env_bool(key: str, default: bool) -> bool:
v = os.getenv(key)
if v is None:
Expand Down
45 changes: 45 additions & 0 deletions sbir_etl/config/loader.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@

from __future__ import annotations

import math
import os
from functools import lru_cache
from pathlib import Path
Expand Down Expand Up @@ -90,6 +91,50 @@ def _convert_env_value(value: str) -> Any:
return value


def _env_number_text(key: str) -> str | None:
"""Return the stripped value of ``key``, or ``None`` when it is unset or blank."""
raw = os.getenv(key)
if raw is None or not raw.strip():
return None
return raw.strip()


def env_float(key: str, default: float) -> float:
"""Read a finite float from environment variable ``key``.

An unset, empty, or blank variable returns ``default``. A set value that is
not a finite number (for example ``"abc"``, ``"0,8"``, ``"nan"``, or ``"inf"``)
raises ``ValueError`` so that a mistyped threshold stops the run instead of
being replaced silently by the default.
"""
text = _env_number_text(key)
if text is None:
return default
try:
value = float(text)
except ValueError:
raise ValueError(f"Environment variable {key}={text!r} is not a valid number") from None
if not math.isfinite(value):
raise ValueError(f"Environment variable {key}={text!r} must be a finite number")
return value


def env_int(key: str, default: int) -> int:
"""Read an integer from environment variable ``key``.

An unset, empty, or blank variable returns ``default``. A set value that is
not a base-10 integer (for example ``"abc"``, ``"5.0"``, or ``"1e3"``) raises
``ValueError``.
"""
text = _env_number_text(key)
if text is None:
return default
try:
return int(text)
except ValueError:
raise ValueError(f"Environment variable {key}={text!r} is not a valid integer") from None


def _apply_env_overrides(config_dict: dict[str, Any], prefix: str = "SBIR_ETL") -> dict[str, Any]:
"""Apply environment variable overrides to configuration dictionary.

Expand Down
29 changes: 15 additions & 14 deletions scripts/ci/gate_check.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,10 @@
from __future__ import annotations

import json
import os
import sys
from pathlib import Path


def _env_float(key: str, default: float) -> float:
try:
return float(os.environ.get(key, str(default)))
except Exception:
return default
from sbir_etl.config.loader import env_float


def _get_nested(data: dict, *keys: str, default=None):
Expand All @@ -40,6 +34,7 @@ def _get_nested(data: dict, *keys: str, default=None):
# Gate definitions
# ---------------------------------------------------------------------------


def gate_transition_validation() -> int:
"""Gate: transition MVP validation summary."""
path = Path("reports/validation/transition_mvp.json")
Expand Down Expand Up @@ -109,15 +104,21 @@ def gate_transition_analytics() -> int:
denom_ok = (a_den > 0) and (c_den > 0)
rate_bounds_ok = (0.0 <= a_rate <= 1.0) and (0.0 <= c_rate <= 1.0)

min_award_rate = _env_float("SBIR_ETL__TRANSITION__ANALYTICS__MIN_AWARD_RATE", 0.0)
min_company_rate = _env_float("SBIR_ETL__TRANSITION__ANALYTICS__MIN_COMPANY_RATE", 0.0)
min_award_rate = env_float("SBIR_ETL__TRANSITION__ANALYTICS__MIN_AWARD_RATE", 0.0)
min_company_rate = env_float("SBIR_ETL__TRANSITION__ANALYTICS__MIN_COMPANY_RATE", 0.0)
min_ok = (a_rate >= min_award_rate) and (c_rate >= min_company_rate)

print("Analytics checks:", json.dumps({
"award": {"denominator": a_den, "rate": a_rate, "min_rate": min_award_rate},
"company": {"denominator": c_den, "rate": c_rate, "min_rate": min_company_rate},
"sanity": {"denominators_positive": denom_ok, "rates_within_0_1": rate_bounds_ok},
}, indent=2))
print(
"Analytics checks:",
json.dumps(
{
"award": {"denominator": a_den, "rate": a_rate, "min_rate": min_award_rate},
"company": {"denominator": c_den, "rate": c_rate, "min_rate": min_company_rate},
"sanity": {"denominators_positive": denom_ok, "rates_within_0_1": rate_bounds_ok},
},
indent=2,
),
)

if not denom_ok:
print("::error::Analytics gate failed: zero denominators.")
Expand Down
52 changes: 52 additions & 0 deletions tests/unit/assets/test_transition_env_thresholds.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
"""A mistyped transition quality-gate threshold must stop the check, not be ignored."""

import json

import pandas as pd
import pytest
from dagster import build_asset_context

from sbir_analytics.assets.transition.checks import contracts_sample_quality_check
from sbir_analytics.assets.transition.evidence import transformed_transition_evidence


pytestmark = pytest.mark.unit


def _sample() -> pd.DataFrame:
return pd.DataFrame({"action_date": ["2024-01-01"], "vendor_uei": ["ABC123DEF456"]})


@pytest.mark.parametrize(
("key", "raw"),
[
("SBIR_ETL__TRANSITION__CONTRACTS__DATE_COVERAGE_MIN", "0,8"),
("SBIR_ETL__TRANSITION__CONTRACTS__DATE_COVERAGE_MIN", "abc"),
("SBIR_ETL__TRANSITION__CONTRACTS__SAMPLE_SIZE_MIN", "1e3"),
],
)
def test_contracts_sample_check_raises_on_bad_threshold(monkeypatch, key, raw):
monkeypatch.setenv(key, raw)
with pytest.raises(ValueError, match=key):
contracts_sample_quality_check(_sample())


def test_contracts_sample_check_uses_valid_threshold(monkeypatch):
monkeypatch.setenv("SBIR_ETL__TRANSITION__CONTRACTS__DATE_COVERAGE_MIN", " 0.5 ")
result = contracts_sample_quality_check(_sample())
assert result.metadata["thresholds"].value["action_date_min"] == "50.00%"


def test_evidence_validation_summary_raises_on_bad_threshold(monkeypatch, tmp_path):
monkeypatch.chdir(tmp_path)
checks = tmp_path / "data/processed/contracts_sample.checks.json"
checks.parent.mkdir(parents=True)
checks.write_text(json.dumps({"coverage": {"action_date": 1.0, "any_identifier": 1.0}}))
key = "SBIR_ETL__TRANSITION__CONTRACTS__DATE_COVERAGE_MIN"
monkeypatch.setenv(key, "0,8")
scores = pd.DataFrame(
{"award_id": ["A1"], "contract_id": ["C1"], "score": [0.9], "method": ["uei"]}
)
contracts = pd.DataFrame({"contract_id": ["C1"], "action_date": ["2024-01-01"]})
with pytest.raises(ValueError, match=key):
transformed_transition_evidence(build_asset_context(), scores, contracts)
58 changes: 58 additions & 0 deletions tests/unit/config/test_env_numbers.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
"""Tests for the numeric environment-variable readers in ``sbir_etl.config.loader``."""

import pytest

from sbir_etl.config.loader import env_float, env_int


pytestmark = pytest.mark.unit

KEY = "SBIR_ETL__TEST__ENV_NUMBER"


@pytest.mark.parametrize(("reader", "default"), [(env_float, 0.6), (env_int, 1000)])
def test_unset_returns_default(monkeypatch, reader, default):
monkeypatch.delenv(KEY, raising=False)
assert reader(KEY, default) == default


@pytest.mark.parametrize("raw", ["", " ", "\t\n"])
@pytest.mark.parametrize(("reader", "default"), [(env_float, 0.6), (env_int, 1000)])
def test_empty_or_blank_returns_default(monkeypatch, reader, default, raw):
monkeypatch.setenv(KEY, raw)
assert reader(KEY, default) == default


@pytest.mark.parametrize(
("raw", "expected"),
[("0.8", 0.8), (" 0.8 ", 0.8), ("1", 1.0), ("-0.25", -0.25), ("1e-3", 0.001)],
)
def test_env_float_valid(monkeypatch, raw, expected):
monkeypatch.setenv(KEY, raw)
assert env_float(KEY, 0.6) == pytest.approx(expected)


@pytest.mark.parametrize(("raw", "expected"), [("5000", 5000), (" 42\n", 42), ("-1", -1), ("0", 0)])
def test_env_int_valid(monkeypatch, raw, expected):
monkeypatch.setenv(KEY, raw)
assert env_int(KEY, 1000) == expected


@pytest.mark.parametrize("raw", ["abc", "0,8", "1e", "nan", "NaN", "inf", "-inf", "80%"])
def test_env_float_rejects_unparseable_or_non_finite(monkeypatch, raw):
monkeypatch.setenv(KEY, raw)
with pytest.raises(ValueError) as excinfo:
env_float(KEY, 0.6)
message = str(excinfo.value)
assert KEY in message
assert repr(raw) in message


@pytest.mark.parametrize("raw", ["abc", "0,8", "1e", "5.0", "1e3", "10,000"])
def test_env_int_rejects_unparseable(monkeypatch, raw):
monkeypatch.setenv(KEY, raw)
with pytest.raises(ValueError) as excinfo:
env_int(KEY, 1000)
message = str(excinfo.value)
assert KEY in message
assert repr(raw) in message
45 changes: 45 additions & 0 deletions tests/unit/scripts/test_gate_check.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
"""The CI analytics gate must reject a mistyped minimum rate, not ignore it."""

import json

import pytest

from scripts.ci import gate_check


pytestmark = pytest.mark.unit


def _write_analytics_checks(tmp_path):
path = tmp_path / "data/processed/transition_analytics.checks.json"
path.parent.mkdir(parents=True)
path.write_text(
json.dumps(
{
"award_transition_rate": {"denominator": 10, "rate": 0.5},
"company_transition_rate": {"denominator": 5, "rate": 0.4},
}
)
)


@pytest.mark.parametrize(
"key",
[
"SBIR_ETL__TRANSITION__ANALYTICS__MIN_AWARD_RATE",
"SBIR_ETL__TRANSITION__ANALYTICS__MIN_COMPANY_RATE",
],
)
def test_analytics_gate_raises_on_bad_min_rate(monkeypatch, tmp_path, key):
monkeypatch.chdir(tmp_path)
_write_analytics_checks(tmp_path)
monkeypatch.setenv(key, "0,9")
with pytest.raises(ValueError, match=key):
gate_check.gate_transition_analytics()


def test_analytics_gate_applies_valid_min_rate(monkeypatch, tmp_path):
monkeypatch.chdir(tmp_path)
_write_analytics_checks(tmp_path)
monkeypatch.setenv("SBIR_ETL__TRANSITION__ANALYTICS__MIN_AWARD_RATE", "0.6")
assert gate_check.gate_transition_analytics() == 1
Loading