README
U
Attachable
U
CaseHookCtx
U
Cells
U
Column
U
Columns
U
Ctx
U
DataTable
U
DocString
U
FeatureResult
U
FeatureSource
U
HookError
U
HookHandler
U
HookRegistry
U
HookResult
U
HookType
U
MoonspecError
U
PendingAttachment
U
RegisteredHook
U
Row
U
Rows
U
RunHookCtx
U
RunOptions
U
RunResult
U
RunSummary
U
ScenarioInfo
U
ScenarioResult
U
ScenarioStatus
U
Setup
U
StepArg
U
StepDef
U
StepHookCtx
U
StepInfo
U
StepKeyword
U
StepLibrary
U
StepMatchResult
U
StepRegistry
U
StepResult
U
StepSource
U
StepStatus
U
StepValue
U
World
V
run
V
run_or_fail

moonspec

BDD test framework for MoonBit with Gherkin and Cucumber Expressions

bdd

cucumber

gherkin

testing

moonbit

Download zip

Author

moonrockz

Version

0.3.0

License

Apache-2.0

Repository

github.com/moonrockz/moonspec

Last updated

8 months ago

Downloads

#moonspec

BDD test framework for MoonBit with Gherkin and Cucumber Expressions.

#Installation

moon add moonrockz/moonspec

#Quick Start

Define a World struct, implement step definitions, and run:

struct CalcWorld {
  mut result : Int
} derive(Default)

impl @moonspec.World for CalcWorld with configure(self, setup) {
  setup.given("a calculator", fn(_ctx) { self.result = 0 })
  setup.when("I add {int} and {int}", fn(ctx) {
    match (ctx[0], ctx[1]) {
      ({ value: @moonspec.StepValue::IntVal(a), .. }, { value: @moonspec.StepValue::IntVal(b), .. }) =>
        self.result = a + b
      _ => ()
    }
  })
  setup.then("the result should be {int}", fn(ctx) raise {
    match ctx[0] {
      { value: @moonspec.StepValue::IntVal(expected), .. } => assert_eq(self.result, expected)
      _ => ()
    }
  })
}

async test "calculator" {
  let feature =
    #|Feature: Calculator
    #|
    #|  Scenario: Addition
    #|    Given a calculator
    #|    When I add 2 and 3
    #|    Then the result should be 5
  @moonspec.run_or_fail(
    CalcWorld::default,
    @moonspec.RunOptions::new([@moonspec.FeatureSource::Text("test://calculator", feature)]),
  )
  |> ignore
}

Each scenario gets a fresh World instance via derive(Default) for state isolation.

#Features

World trait -- per-scenario state isolation following cucumber-rs patterns
StepLibrary trait -- composable, reusable step definition groups
StepDef type -- first-class step definitions you can inspect, test, and pass around
Structured errors -- MoonspecError hierarchy with run_or_fail throwing variant
Undefined step diagnostics -- copy-paste snippets and "did you mean?" suggestions
Lifecycle hooks -- before_test_case, after_test_case, before_test_step, after_test_step, before_test_run, after_test_run
Gherkin parsing -- Feature, Scenario, Scenario Outline, Background, Rules, Data Tables, Doc Strings
Cucumber Expressions -- type-safe step matching with 11 built-in types ({int}, {float}, {double}, {long}, {byte}, {short}, {bigdecimal}, {biginteger}, {string}, {word}) plus custom parameter types with transformers
Tag filtering -- boolean tag expressions (@smoke and not @slow)
Scenario Outline expansion -- parameterized scenarios from Examples tables
Background steps -- shared Given setup across scenarios
Async/parallel execution -- concurrent feature processing with bounded concurrency
Codegen -- generate _test.mbt runner tests from .feature files
Formatters -- Pretty (console), Cucumber Messages (NDJSON), JUnit XML (CI)

#Packages

Package	Description
moonrockz/moonspec	Top-level facade -- World, Setup, Ctx, RunOptions, run, run_or_fail
moonrockz/moonspec/core	World trait, Setup facade, HookRegistry, StepRegistry, Ctx types
moonrockz/moonspec/runner	Feature/scenario executor with tag filtering and parallel support
moonrockz/moonspec/format	Formatter trait + Pretty, Messages, JUnit implementations
moonrockz/moonspec/codegen	Generate test files from Gherkin features

#Documentation

Full documentation with CLI reference, architecture, and examples: github.com/moonrockz/moonspec

#License

Apache-2.0

Attachable

source

using @moonrockz/moonspec/core {trait moonrockz/moonspec/core}

moonspec — BDD test framework for MoonBit.

Re-exports core types and runner functions so users import just moonrockz/moonspec and use @moonspec.World, @moonspec.run, etc.

CaseHookCtx

source

using @moonrockz/moonspec/core {type moonrockz/moonspec/core}

moonspec — BDD test framework for MoonBit.

Re-exports core types and runner functions so users import just moonrockz/moonspec and use @moonspec.World, @moonspec.run, etc.

Cells

source

using @moonrockz/moonspec/core {type moonrockz/moonspec/core}

moonspec — BDD test framework for MoonBit.

Re-exports core types and runner functions so users import just moonrockz/moonspec and use @moonspec.World, @moonspec.run, etc.

Column

source

using @moonrockz/moonspec/core {type moonrockz/moonspec/core}

moonspec — BDD test framework for MoonBit.

Re-exports core types and runner functions so users import just moonrockz/moonspec and use @moonspec.World, @moonspec.run, etc.

Columns

source

using @moonrockz/moonspec/core {type moonrockz/moonspec/core}

moonspec — BDD test framework for MoonBit.

Re-exports core types and runner functions so users import just moonrockz/moonspec and use @moonspec.World, @moonspec.run, etc.

Ctx

source

using @moonrockz/moonspec/core {type moonrockz/moonspec/core}

moonspec — BDD test framework for MoonBit.

Re-exports core types and runner functions so users import just moonrockz/moonspec and use @moonspec.World, @moonspec.run, etc.

DataTable

source

using @moonrockz/moonspec/core {type moonrockz/moonspec/core}

moonspec — BDD test framework for MoonBit.

Re-exports core types and runner functions so users import just moonrockz/moonspec and use @moonspec.World, @moonspec.run, etc.

DocString

source

using @moonrockz/moonspec/core {type moonrockz/moonspec/core}

moonspec — BDD test framework for MoonBit.

Re-exports core types and runner functions so users import just moonrockz/moonspec and use @moonspec.World, @moonspec.run, etc.

FeatureResult

source

using @moonrockz/moonspec/runner {type moonrockz/moonspec/runner}

Result of executing a feature.

FeatureSource

source

using @moonrockz/moonspec/runner {type moonrockz/moonspec/runner}

Input source for a feature to be loaded into the cache.

HookError

source

using @moonrockz/moonspec/core {type moonrockz/moonspec/core}

moonspec — BDD test framework for MoonBit.

Re-exports core types and runner functions so users import just moonrockz/moonspec and use @moonspec.World, @moonspec.run, etc.

HookHandler

source

using @moonrockz/moonspec/core {type moonrockz/moonspec/core}

moonspec — BDD test framework for MoonBit.

Re-exports core types and runner functions so users import just moonrockz/moonspec and use @moonspec.World, @moonspec.run, etc.

HookRegistry

source

using @moonrockz/moonspec/core {type moonrockz/moonspec/core}

moonspec — BDD test framework for MoonBit.

Re-exports core types and runner functions so users import just moonrockz/moonspec and use @moonspec.World, @moonspec.run, etc.

HookResult

source

using @moonrockz/moonspec/core {type moonrockz/moonspec/core}

moonspec — BDD test framework for MoonBit.

Re-exports core types and runner functions so users import just moonrockz/moonspec and use @moonspec.World, @moonspec.run, etc.

HookType

source

using @moonrockz/moonspec/core {type moonrockz/moonspec/core}

moonspec — BDD test framework for MoonBit.

Re-exports core types and runner functions so users import just moonrockz/moonspec and use @moonspec.World, @moonspec.run, etc.

MoonspecError

source

using @moonrockz/moonspec/core {type moonrockz/moonspec/core}

moonspec — BDD test framework for MoonBit.

Re-exports core types and runner functions so users import just moonrockz/moonspec and use @moonspec.World, @moonspec.run, etc.

PendingAttachment

source

using @moonrockz/moonspec/core {type moonrockz/moonspec/core}

moonspec — BDD test framework for MoonBit.

Re-exports core types and runner functions so users import just moonrockz/moonspec and use @moonspec.World, @moonspec.run, etc.

RegisteredHook

source

using @moonrockz/moonspec/core {type moonrockz/moonspec/core}

moonspec — BDD test framework for MoonBit.

Re-exports core types and runner functions so users import just moonrockz/moonspec and use @moonspec.World, @moonspec.run, etc.

Row

source

using @moonrockz/moonspec/core {type moonrockz/moonspec/core}

moonspec — BDD test framework for MoonBit.

Re-exports core types and runner functions so users import just moonrockz/moonspec and use @moonspec.World, @moonspec.run, etc.

Rows

source

using @moonrockz/moonspec/core {type moonrockz/moonspec/core}

moonspec — BDD test framework for MoonBit.

Re-exports core types and runner functions so users import just moonrockz/moonspec and use @moonspec.World, @moonspec.run, etc.

RunHookCtx

source

using @moonrockz/moonspec/core {type moonrockz/moonspec/core}

moonspec — BDD test framework for MoonBit.

Re-exports core types and runner functions so users import just moonrockz/moonspec and use @moonspec.World, @moonspec.run, etc.

RunOptions

source

using @moonrockz/moonspec/runner {type moonrockz/moonspec/runner}

Options for configuring a test run.

RunResult

source

using @moonrockz/moonspec/runner {type moonrockz/moonspec/runner}

Complete result of a test run.

RunSummary

source

using @moonrockz/moonspec/runner {type moonrockz/moonspec/runner}

Summary of an entire run.

The retried field counts scenarios that required more than one attempt, regardless of their final outcome. A scenario that fails on the first attempt but passes on retry is counted as both passed and retried.

ScenarioInfo

source

using @moonrockz/moonspec/core {type moonrockz/moonspec/core}

moonspec — BDD test framework for MoonBit.

Re-exports core types and runner functions so users import just moonrockz/moonspec and use @moonspec.World, @moonspec.run, etc.

ScenarioResult

source

using @moonrockz/moonspec/runner {type moonrockz/moonspec/runner}

Result of executing a scenario.

ScenarioStatus

source

using @moonrockz/moonspec/runner {type moonrockz/moonspec/runner}

Aggregate status of a scenario.

Setup

source

using @moonrockz/moonspec/core {type moonrockz/moonspec/core}

moonspec — BDD test framework for MoonBit.

Re-exports core types and runner functions so users import just moonrockz/moonspec and use @moonspec.World, @moonspec.run, etc.

StepArg

source

using @moonrockz/moonspec/core {type moonrockz/moonspec/core}

moonspec — BDD test framework for MoonBit.

Re-exports core types and runner functions so users import just moonrockz/moonspec and use @moonspec.World, @moonspec.run, etc.

StepDef

source

using @moonrockz/moonspec/core {type moonrockz/moonspec/core}

moonspec — BDD test framework for MoonBit.

Re-exports core types and runner functions so users import just moonrockz/moonspec and use @moonspec.World, @moonspec.run, etc.

StepHookCtx

source

using @moonrockz/moonspec/core {type moonrockz/moonspec/core}

moonspec — BDD test framework for MoonBit.

Re-exports core types and runner functions so users import just moonrockz/moonspec and use @moonspec.World, @moonspec.run, etc.

StepInfo

source

using @moonrockz/moonspec/core {type moonrockz/moonspec/core}

moonspec — BDD test framework for MoonBit.

Re-exports core types and runner functions so users import just moonrockz/moonspec and use @moonspec.World, @moonspec.run, etc.

StepKeyword

source

using @moonrockz/moonspec/core {type moonrockz/moonspec/core}

moonspec — BDD test framework for MoonBit.

Re-exports core types and runner functions so users import just moonrockz/moonspec and use @moonspec.World, @moonspec.run, etc.

StepLibrary

source

using @moonrockz/moonspec/core {trait moonrockz/moonspec/core}

moonspec — BDD test framework for MoonBit.

Re-exports core types and runner functions so users import just moonrockz/moonspec and use @moonspec.World, @moonspec.run, etc.

StepMatchResult

source

using @moonrockz/moonspec/core {type moonrockz/moonspec/core}

moonspec — BDD test framework for MoonBit.

Re-exports core types and runner functions so users import just moonrockz/moonspec and use @moonspec.World, @moonspec.run, etc.

StepRegistry

source

using @moonrockz/moonspec/core {type moonrockz/moonspec/core}

moonspec — BDD test framework for MoonBit.

Re-exports core types and runner functions so users import just moonrockz/moonspec and use @moonspec.World, @moonspec.run, etc.

StepResult

source

using @moonrockz/moonspec/runner {type moonrockz/moonspec/runner}

Result of executing a single step.

StepSource

source

using @moonrockz/moonspec/core {type moonrockz/moonspec/core}

moonspec — BDD test framework for MoonBit.

Re-exports core types and runner functions so users import just moonrockz/moonspec and use @moonspec.World, @moonspec.run, etc.

StepStatus

source

using @moonrockz/moonspec/runner {type moonrockz/moonspec/runner}

Status of a single step execution.

StepValue

source

using @moonrockz/moonspec/core {type moonrockz/moonspec/core}

moonspec — BDD test framework for MoonBit.

Re-exports core types and runner functions so users import just moonrockz/moonspec and use @moonspec.World, @moonspec.run, etc.

World

source

using @moonrockz/moonspec/core {trait moonrockz/moonspec/core}

moonspec — BDD test framework for MoonBit.

Re-exports core types and runner functions so users import just moonrockz/moonspec and use @moonspec.World, @moonspec.run, etc.

run

source

async fn[W : @moonrockz/moonspec/core.World
World] run(factory : () -> W, options : @moonrockz/moonspec/runner.RunOptions
RunOptions) -> @moonrockz/moonspec/runner.RunResult
RunResult

Run all features and collect results.

A fresh world is created per scenario via factory() for isolation. When parallel is greater than 0, pickles are executed concurrently using @async.all() with bounded concurrency. Otherwise, pickles run sequentially. Lifecycle hooks registered via Setup are called automatically when present.

run_or_fail

source

async fn[W : @moonrockz/moonspec/core.World
World] run_or_fail(factory : () -> W, options : @moonrockz/moonspec/runner.RunOptions
RunOptions) -> @moonrockz/moonspec/runner.RunResult
RunResult

Run all features, raising MoonspecError on any failure.

This is the ergonomic test API. Use in generated tests and manual tests where you want structured error output instead of manual result inspection.

Source Files

lib.mbt

Site source Report issue Packages Build queue Skills Statistics

moonspec

#moonspec

#Installation

#Quick Start

#Features

#Packages

#Documentation

#License

#Attachable

#CaseHookCtx

#Cells

#Column

#Columns

#Ctx

#DataTable

#DocString

#FeatureResult

#FeatureSource

#HookError

#HookHandler

#HookRegistry

#HookResult

#HookType

#MoonspecError

#PendingAttachment

#RegisteredHook

#Row

#Rows

#RunHookCtx

#RunOptions

#RunResult

#RunSummary

#ScenarioInfo

#ScenarioResult

#ScenarioStatus

#Setup

#StepArg

#StepDef

#StepHookCtx

#StepInfo

#StepKeyword

#StepLibrary

#StepMatchResult

#StepRegistry

#StepResult

#StepSource

#StepStatus

#StepValue

#World

#run

#run_or_fail

Source Files

Attachable

CaseHookCtx

Cells

Column

Columns

Ctx

DataTable

DocString

FeatureResult

FeatureSource

HookError

HookHandler

HookRegistry

HookResult

HookType

MoonspecError

PendingAttachment

RegisteredHook

Row

Rows

RunHookCtx

RunOptions

RunResult

RunSummary

ScenarioInfo

ScenarioResult

ScenarioStatus

Setup

StepArg

StepDef

StepHookCtx

StepInfo

StepKeyword

StepLibrary

StepMatchResult

StepRegistry

StepResult

StepSource

StepStatus

StepValue

World

run

run_or_fail