SGA-OIS conformance kit

Public, runnable offline, no network access, no SGA account.

Know you pass before you ever contact us. Passing the kit is the technical floor for certification. Trust levels — A1 and up — come from the partner agreement and signing, not from the kit (trust levels).

What the kit reads, and what it doesn't. It checks documents: your capability descriptor and, for a simulator, scorecards, round boundaries and the course document. It cannot see the frames you send live (record.shot, record.state); watch those with sgapoke or sgaengine -livedata (testing your integration).

Run it#

The kit is Python 3.10 or newer, with no virtualenv required, so it runs the same on a build server as on your bench.

# from sga-ois/conformance/
python -m sgaconform your-descriptor.json          # your device
python -m sgaconform your-scorecard.json --manifest m.json
python -m sgaconform --list-rules                  # every rule, by document kind
python -m pytest tests/ -q                         # the kit's own tests (maintainers)

Optional, for shape checking as well as semantics:

pip install jsonschema referencing

Without it, JSON Schema validation is skipped with a notice and the semantic rules still run. The semantic rules are the ones that catch real interoperability bugs, so the kit is useful either way.

Two passes#

What the rules cover#

Run python -m sgaconform --list-rules for the list your copy enforces.

The kit also refuses a descriptor that claims A2 or A3 without a signature (R040). It checks a claim; it cannot grant a level.

Severity is error, warning or info. Only error fails a run — warnings are for a human to look at, not a gate.

Some rules need context. R004 can only verify that a downgrade is a downgrade if it can see the declared provenance, so pass --manifest; without it the rule reports info rather than error instead of guessing.

Adding a rule#

One function with a decorator in sgaconform/rules.py (core) or rules_vendor.py (descriptor and vendor-specific rules):

@rule("R0NN", "shot-record")
def my_check(doc, ctx):
    """One line, shown by --list-rules."""
    if bad:
        yield Finding("R0NN", "error", "path.to.field", "what and why")

Read rules.py as the list of things you will be tested on. That is the point of shipping it rather than describing it.

Fixtures#

fixtures/valid/ must all pass. fixtures/invalid/ each fail on a specific rule, asserted by name in tests/, so a rule cannot silently stop working.

Vendor extensions are exercised deliberately: the shot-record fixture carries unknown x- fields, and a run that rejects them fails. Tier-1 extensions ship without permission and must never break another implementation.

License#

The conformance kit is Apache 2.0 — see ../LICENSE-CODE.txt. That differs from the specification itself, which is CC BY 4.0; ../LICENSE says which is which and why.