DOCSEARCHbyAlgolia
Submit Docs

Maelstrom Documentation

repository·main·Indexed 20 days ago

https://github.com/maelstrom-software/maelstrom

A suite of tools for running tests in isolated, lightweight, rootless micro-containers. Maelstrom provides drop-in replacements for standard test runners including cargo-maelstrom (Rust), maelstrom-go-test (Go), and maelstrom-pytest (Python), supporting scaling from local standalone execution to large distributed clusters. The ecosystem includes core components such as the Maelstrom Broker, Maelstrom Worker, and Maelstrom Admin, as well as specialized libraries for WASM compatibility (maelstrom-base), OCI image management (maelstrom-container), and simulation exploration (SIMEX).

Tokens
198.4K
Snippets
604
Records
949
Agent score
71%

What's inside Maelstrom

  4. Overview of Maelstrom capabilities

    main

    Maelstrom is a suite of tools designed for running tests in isolated micro-containers. It can run locally on a single machine or be distributed across large clusters.

    Key features include:

    • Test Runners: Provides drop-in replacements for cargo test, go test, and pytest.
    • Isolation: Runs every test in its own lightweight, rootless container to eliminate inter-test dependencies.
    • Scalability: Supports cluster mode to increase test throughput by adding worker machines.
    • Low Overhead: Uses a custom Rust-based rootless container implementation (not relying on Docker or RunC).
    • General Purpose Execution: Beyond testing, it provides a CLI utility for arbitrary commands, a gRPC-based API, and Rust bindings for programmatic control.

    Platform Support: Currently Linux-only (x86 and ARM) due to its reliance on Linux namespaces for container implementation.

  5. Overview of Maelstrom Linux Syscalls

    main

    The maelstrom-linux library provides simple, non-allocating wrappers around essential Linux syscalls. It is designed specifically for use by maelstrom-worker and maelstrom-worker-child.

    Key characteristics:

    • no_std compatibility: The library does not rely on the Rust standard library, making it suitable for low-level environments.
    • Zero-allocation: It is designed to be non-allocating to ensure predictable behavior in worker processes.
    • Architecture emulation: For syscalls not natively available on all architectures, the library provides emulation similar to libc.

  7. Overview of Maelstrom

    main

    Maelstrom is a suite of tools designed for running tests in isolated micro-containers. It can run tests locally on a single machine or distributed across large clusters.

    Key features include:

    • Test Runner Replacements: Provides drop-in replacements for cargo test, go test, and pytest.
    • Isolation: Runs every test in its own lightweight, rootless container to eliminate inter-test dependencies.
    • Scalability: Supports cluster mode to increase test throughput by adding worker machines.
    • Low Overhead: Uses a custom Rust-based rootless container implementation that does not rely on Docker or RunC.
    • General Purpose Execution: Beyond testing, it includes a CLI for running arbitrary commands and provides a gRPC-based API and Rust bindings for programmatic control.

    Platform Support: Currently Linux-only (x86 and ARM) due to its reliance on Linux namespaces for container implementation.

  8. Overview of the Maelstrom Plot Library

    main
    The Maelstrom Plot Library is a specialized fork of the egui_plot crate. It is designed specifically for use within the Maelstrom ecosystem, providing enhanced functionality for stacked line plots. To maintain focus on these specific use cases, support for other plot types found in the original egui_plot has been removed.

  9. Overview of Maelstrom Client Library Base

    main

    The maelstrom-client-base library provides the shared core logic used by both the high-level Maelstrom client library and the Maelstrom client process. It serves as the foundational layer for client-side interactions within the Maelstrom ecosystem.

    For detailed API documentation and usage instructions, refer to the official maelstrom-client documentation.

  11. What is Maelstrom?

    main

    Maelstrom is a suite of tools designed to run tests in isolated micro-containers. It can run tests locally on a single machine or distribute them across large clusters.

    Key features include:

    • Drop-in Replacements: Provides replacements for cargo test, go test, and pytest with minimal configuration.
    • Isolation: Every test runs in its own lightweight, rootless container to prevent inter-test dependencies.
    • Scalability: Supports cluster mode to increase test throughput by adding worker machines.
    • Low Overhead: Uses a custom Rust-based rootless container implementation (not relying on Docker or RunC) optimized for speed.
    • General Purpose: Beyond testing, it includes a CLI for arbitrary commands, a gRPC-based API, and Rust bindings for programmatic control.

    Platform Support: Currently Linux-only (x86 and ARM) due to its reliance on Linux namespaces for container implementation.