mz-platform-checks

name	mz-platform-checks
description	Create/modify/debug platform check. Trigger: "platform check", "platform-checks", "upgrade check", "restart check", or writing Check class testing feature survival across restarts/upgrades. Also edits in misc/python/materialize/checks/all_checks/.

Platform Checks

The Platform Checks framework is "write once, run everywhere" - a single test validates a feature across multiple scenarios (restarts, upgrades, etc.).

Key Concepts

• Check: A Python class that tests one feature via testdrive fragments.
• Scenario: The context (e.g., restart, upgrade) in which checks run.
• Action: An individual step within a scenario (e.g., stop a container).

Where Checks Live

All checks are in misc/python/materialize/checks/all_checks/. The __init__.py auto-discovers every .py file in that directory, so adding a new file is all that's needed for registration.

Anatomy of a Check

A check is a class that extends Check and implements three methods. Each returns a Testdrive object wrapping a testdrive fragment string.

from textwrap import dedent
from materialize.checks.actions import Testdrive
from materialize.checks.checks import Check

class MyFeature(Check):
    def initialize(self) -> Testdrive:
        
         Testdrive(dedent())

     () -> [Testdrive]:
        
         [
            Testdrive(dedent()),
            Testdrive(dedent()),
        ]

     () -> Testdrive:
        
         Testdrive(dedent())