markus-autotesting-core

markus-autotesting-core defines the data types for MarkUs autotester test settings. The types are msgspec structs, so one definition gives you both:

• validation: decoding settings JSON into typed objects, rejecting invalid settings
• a JSON schema: used by MarkUs to render the test settings form

Each tester (Python, Java, Haskell, …) defines its own settings by subclassing the base types here.

Installation

pip install markus-autotesting-core

Requires Python 3.11 or later.

Usage

Defining a tester's settings

Subclass BaseTestData for the settings of one test group, and BaseTesterSettings for the tester as a whole:

from typing import Annotated, Literal

from msgspec import Meta
from markus_autotesting_core.types import BaseTestData, BaseTesterSettings


class PyTestData(BaseTestData, kw_only=True):
    """The settings for one Python test group."""

    tester: Literal["pytest", "unittest"] = "pytest"


class PyTesterSettings(BaseTesterSettings):
    """The settings for the Python tester."""

    test_data: Annotated[list[PyTestData], Meta(title="Test Groups", min_length=1)]

BaseTestData provides the fields every test group has:

BaseTesterSettings is a tagged union on the tester_type field. A subclass's tag is its class name without the TesterSettings suffix, lowercased, so PyTesterSettings is "py". To use a different tag, pass tag=:

class CustomTesterSettings(BaseTesterSettings, tag="custom"): ...

Decoding settings

create_autotest_settings_class builds the type for a complete settings document from the tester classes you have:

import msgspec
from markus_autotesting_core.types import create_autotest_settings_class

AutotestSettings = create_autotest_settings_class([PyTesterSettings])

settings = msgspec.json.decode(
    b'{"testers": [{"tester_type": "py", "test_data": [{"category": ["instructor"], "script_files": ["test.py"]}]}]}',
    type=AutotestSettings,
)
settings.testers[0].tester_type  # "py"
settings.testers[0].test_data[0].timeout  # 30

Invalid settings raise msgspec.ValidationError, with the location of the problem:

msgspec.json.decode(
    b'{"testers": [{"tester_type": "py", "test_data": [{"category": [], "script_files": ["a.py", "a.py"]}]}]}',
    type=AutotestSettings,
)
# msgspec.ValidationError: `script_files` contains duplicate items: ['a.py'] - at `$.testers[0].test_data[0]`

msgspec.to_builtins(settings) converts decoded settings back to plain dicts and lists, with defaults filled in.

Generating the JSON schema

schema, components = msgspec.json.schema_components([PyTesterSettings])

Some values depend on the assignment, so the schema refers to definitions that the consumer (MarkUs) fills in before rendering the form:

msgspec's decoder doesn't check these definitions, or other keywords added with Meta(extra_json_schema=...). The one exception is uniqueItems, which BaseTestData checks when decoding.

Development

The project uses uv.

uv sync
uv run pytest

Linting and formatting use ruff, and run as pre-commit hooks:

uv run ruff check .
uv run ruff format .

Contributions are welcome: please open an issue or a pull request.

License

MIT. See LICENSE.