Verify your integration

"""Checks a test recording against GET /testresult. Start it right after the recording stops:
    python3 check_integration.py <device ID> [YYYY-MM-DD], with the key in TRUEMETRICS_API_KEY
Waits 20 minutes, then checks every 5 minutes until 45 minutes after the stop.
Exit code: 0 passed, 1 failed, 2 the check could not run, 3 wrong key or request.
Needs Python 3.8 or newer, nothing else.
"""

import datetime
import json
import os
import sys
import time
import urllib.error
import urllib.parse
import urllib.request

URL = "https://geodata.truemetrics.cloud/V1/testresult"


def utc_now():
    return datetime.datetime.now(datetime.timezone.utc)


def test_objects(result):
    """Metadata entries that carry both test fields."""
    return sum(
        1
        for entry in result.get("customer_metadata") or []
        if {"test_run_id", "test_index"} <= set(entry.get("fields") or [])
    )


def summary(result, names):
    """The given fields of a result, plus its number of test objects."""
    shown = {name: result.get(name) for name in names}
    shown["test_objects"] = test_objects(result)
    return json.dumps(shown, indent=2)


def fetch(url, key):
    """One request: the HTTP status (0 for no answer) and the body."""
    request = urllib.request.Request(url, headers={"x-api-key": key})
    try:
        with urllib.request.urlopen(request, timeout=60) as response:
            return response.status, json.load(response)
    except urllib.error.HTTPError as error:
        return error.code, error.read().decode(errors="replace")
    except (urllib.error.URLError, OSError, ValueError) as error:
        return 0, str(getattr(error, "reason", error))


def main():
    key = os.environ.get("TRUEMETRICS_API_KEY")
    if len(sys.argv) not in (2, 3) or not key:
        print("usage:", __doc__.splitlines()[1].strip(), file=sys.stderr)
        return 3
    device_id = sys.argv[1]
    # The recording's UTC day, fixed before the wait.
    day = sys.argv[2] if len(sys.argv) == 3 else utc_now().date().isoformat()
    query = urllib.parse.urlencode({"id_device": device_id, "date": day})
    print(f"Checking device {device_id} for {day} (UTC).", flush=True)

    time.sleep(int(os.environ.get("WAIT_SECONDS", "1200")))
    last = None
    for check in range(1, 7):
        if check > 1:
            time.sleep(300)
        status, body = fetch(f"{URL}?{query}", key)
        answer = f"HTTP {status}" if status else f"no answer ({body})"
        print(f"{utc_now():%H:%M} UTC, check {check} of 6: {answer}", flush=True)
        if status == 200:
            ok = body.get("status") == "ok" and body.get("config") == "device"
            if ok and test_objects(body) >= 3:
                print("PASSED", summary(body, ("counts", "recording_minutes")), sep="\n")
                return 0
            last = body
        elif status in (400, 403):
            print(body)
            if status == 403:
                print("Wrong API key, or the key is not enabled for this check: ask truemetrics.")
            return 3

    if last is not None:
        print("FAILED", summary(last, ("status", "reasons", "config", "counts")), sep="\n")
        return 1
    print("The check could not run: this is not a test result. Try again later.")
    return 2


if __name__ == "__main__":
    sys.exit(main())