🥮 mooncakes.io

    cucumber-messages

    Cucumber Messages protocol types for MoonBit with JSON serialization and NDJSON streaming

    cucumber
    messages
    bdd
    testing
    protocol
    Download zip
    Author
    Version
    0.5.0
    License
    Apache-2.0
    Repository
    Last updated
    1 hour ago
    Downloads
    1K

    Dependencies

    #moonrockz/cucumber-messages

    Cucumber Messages protocol types for MoonBit. Defines the standardized message types used by Cucumber for representing test execution results.

    #Installation

    moon add moonrockz/cucumber-messages

    #What are Cucumber Messages?

    Cucumber Messages is a message protocol for representing the results of running Cucumber tests. Messages are exchanged as NDJSON (newline-delimited JSON) streams -- one JSON object per line, each wrapped in an Envelope.

    This decouples Gherkin parsing from test execution, enables real-time result processing, and reduces memory consumption compared to traditional JSON/XML formats.

    #Message Types

    The protocol defines message types wrapped in an Envelope discriminated union:

    CategoryMessage Types
    Source & ParsingSource, GherkinDocument, ParseError
    Test CompilationPickle
    Glue DefinitionsStepDefinition, Hook, ParameterType
    Test Run LifecycleTestRunStarted, TestRunFinished
    Test Case LifecycleTestCase, TestCaseStarted, TestCaseFinished
    Step LifecycleTestStepStarted, TestStepFinished
    Hook LifecycleTestRunHookStarted, TestRunHookFinished
    ArtifactsAttachment, ExternalAttachment
    MetadataMeta, Suggestion, UndefinedParameterType

    #Usage

    // Deserialize a message from JSON (this example imports the package as @cm)
    let json = @json.parse(
      "{\"meta\": {\"protocolVersion\": \"34.2.1\", \"implementation\": {\"name\": \"cucumber-moonbit\"}, \"runtime\": {\"name\": \"moonbit\"}, \"os\": {\"name\": \"linux\"}, \"cpu\": {\"name\": \"amd64\"}}}"
    ) catch { _ => panic() }
    let envelope : @cm.Envelope = @json.from_json(json) catch { _ => panic() }

    // Serialize a message to JSON
    let json_value = envelope.to_json()

    // NDJSON streaming: parse multiple messages from newline-delimited JSON
    let envelopes = @cm.parse_ndjson(ndjson_string) catch { _ => panic() }

    // Serialize envelopes to NDJSON
    let ndjson = @cm.envelopes_to_ndjson(envelopes)

    #Compatibility

    This library targets Cucumber Messages protocol v34.2.1 (see @cm.protocol_version). It is designed to interoperate with other Cucumber implementations (Java, JavaScript, Ruby, Python, Go, etc.) via the shared NDJSON format.

    Every sample of the Cucumber Compatibility Kit v31.0.0 is parsed and serialized back to identical JSON in the test suite.

    #Streaming

    For long runs, read and write one envelope at a time:

    // Read: feed chunks of any size; a partial last line waits for the next chunk.
    let reader = @cm.NdjsonReader::new()
    for chunk in chunks {
      for envelope in reader.feed(chunk) catch { e => { println(e); [] } } {
        handle(envelope)
      }
    }
    // Parse a last line that has no trailing newline.
    let last = reader.finish() catch { _ => None }
    if last is Some(envelope) {
      handle(envelope)
    }

    // Or read one line at a time; blank lines give None.
    let envelope = reader.read_line(line) catch { _ => None }

    // Write: one line per envelope to any &Logger (for example StringBuilder).
    envelope.write_ndjson(out)

    #Parsing rules

    • Unknown message types (for example a message added by a newer protocol version) decode as Envelope::UnknownMessage(key, value) and serialize back to the same JSON.
    • Unknown fields inside a known message are ignored on parse and are not written back. The protocol only adds optional fields, so a reader can skip them safely.
    • null on an optional field decodes as None. Serialization omits None fields.
    • Validation: an envelope must hold exactly one message. Integers must have no fractional part, and values outside the schema ranges (for example nanos outside 0..999999999) raise an error.
    • parse_ndjson raises NdjsonParseError with the 1-based line number of the bad line. envelopes_to_ndjson ends every line with \n.

    #Related Projects

    #License

    Apache-2.0

    NdjsonParseError

    source
    pub suberror NdjsonParseError {
      NdjsonParseError(line~ : Int, cause~ : Error)
    }

    Error raised by parse_ndjson when one line of the input is not a valid envelope. line is the 1-based line number in the input.

    NdjsonParseError::output

    source
    fn NdjsonParseError::output(self : NdjsonParseError, logger : &Logger) -> Unit

    NdjsonParseError::to_string

    source
    fn NdjsonParseError::to_string(self : NdjsonParseError) -> String

    Attachment

    source
    pub struct Attachment {
      body : String
      contentEncoding : AttachmentContentEncoding
      mediaType : String
      fileName : String?
      source : Source?
      testCaseStartedId : String?
      testStepId : String?
      url : String?
      testRunStartedId : String?
      testRunHookStartedId : String?
      timestamp : Timestamp?
    } derive(ToJson, 
    FromJson    )

    Attachment: embedded test artifact.

    Attachment::to_json

    source
    fn Attachment::to_json(Attachment) -> Json

    AttachmentContentEncoding

    source
    pub enum AttachmentContentEncoding {
      Identity
      Base64
    }

    AttachmentContentEncoding: encoding of attachment body.

    AttachmentContentEncoding::to_json

    source

    Background

    source
    pub struct Background {
      location : Location
      keyword : String
      name : String
      description : String
      steps : Array[Step]
      id : String
    } derive(ToJson, 
    FromJson    )

    Background: a background in a feature or rule.

    Background::to_json

    source
    fn Background::to_json(Background) -> Json

    pub struct Ci {
      name : String
      url : String?
      buildNumber : String?
      git : Git?
    } derive(ToJson, 
    FromJson    )

    Ci: CI environment (Meta sub-type).

    Ci::to_json

    source
    fn Ci::to_json(Ci) -> Json

    Comment

    source
    pub struct Comment {
      location : Location
      text : String
    } derive(ToJson, 
    FromJson    )

    Comment: a comment in a Gherkin document.

    Comment::to_json

    source
    fn Comment::to_json(Comment) -> Json

    DataTable

    source
    pub struct DataTable {
      location : Location
      rows : Array[TableRow]
    } derive(ToJson, 
    FromJson    )

    DataTable: a data table in a step.

    DataTable::to_json

    source
    fn DataTable::to_json(DataTable) -> Json

    DocString

    source
    pub struct DocString {
      location : Location
      content : String
      delimiter : String
      mediaType : String?
    } derive(ToJson, 
    FromJson    )

    DocString: a doc string in a step.

    DocString::to_json

    source
    fn DocString::to_json(DocString) -> Json

    Duration

    source
    pub struct Duration {
      seconds : Int64
      nanos : Int
    }

    Duration: seconds + nanos (0..999_999_999).
    impl ToJson for Duration

    Duration::to_json

    source
    fn Duration::to_json(self : Duration) -> Json

    Envelope

    source
    pub enum Envelope {
      Meta(Meta)
      Source(Source)
      ParseError(ParseError)
      TestRunStarted(TestRunStarted)
      TestRunFinished(TestRunFinished)
      UndefinedParameterType(UndefinedParameterType)
      TestCaseStarted(TestCaseStarted)
      TestCaseFinished(TestCaseFinished)
      TestStepStarted(TestStepStarted)
      TestStepFinished(TestStepFinished)
      Attachment(Attachment)
      ExternalAttachment(ExternalAttachment)
      Hook(Hook)
      StepDefinition(StepDefinition)
      ParameterType(ParameterType)
      Suggestion(Suggestion)
      TestRunHookStarted(TestRunHookStarted)
      TestRunHookFinished(TestRunHookFinished)
      GherkinDocument(GherkinDocument)
      Pickle(Pickle)
      TestCase(TestCase)
      UnknownMessage(String, Json)
    }

    Envelope: exactly one message variant per JSON object.
    impl ToJson for Envelope

    Envelope::to_json

    source
    fn Envelope::to_json(self : Envelope) -> Json

    Envelope::to_ndjson_line

    source
    fn Envelope::to_ndjson_line(self : Envelope) -> String

    Serialize an Envelope to a single NDJSON line (no trailing newline).

    Envelope::write_ndjson

    source
    fn Envelope::write_ndjson(self : Envelope, logger : &Logger) -> Unit

    Write this envelope as one NDJSON line, ending with \n.

    Examples

    source
    pub struct Examples {
      location : Location
      tags : Array[Tag]
      keyword : String
      name : String
      description : String
      tableHeader : TableRow?
      tableBody : Array[TableRow]
      id : String
    } derive(ToJson, 
    FromJson    )

    Examples: examples table for a scenario outline.

    Examples::to_json

    source
    fn Examples::to_json(Examples) -> Json

    Exception

    source
    pub struct Exception {
      type_ : String
      message : String?
      stackTrace : String?
    }

    Exception: simplified exception (type, optional message and stackTrace).
    impl ToJson for Exception

    Exception::to_json

    source
    fn Exception::to_json(self : Exception) -> Json

    ExternalAttachment

    source
    pub struct ExternalAttachment {
      url : String
      mediaType : String
      testCaseStartedId : String?
      testStepId : String?
      testRunHookStartedId : String?
      timestamp : Timestamp?
    } derive(ToJson, 
    FromJson    )

    ExternalAttachment: linked test artifact.

    ExternalAttachment::to_json

    source

    Feature

    source
    pub struct Feature {
      location : Location
      tags : Array[Tag]
      language : String
      keyword : String
      name : String
      description : String
      children : Array[FeatureChild]
    } derive(ToJson, 
    FromJson    )

    Feature: a feature in a Gherkin document.

    Feature::to_json

    source
    fn Feature::to_json(Feature) -> Json

    FeatureChild

    source
    pub struct FeatureChild {
      rule : Rule?
      background : Background?
      scenario : Scenario?
    } derive(ToJson, 
    FromJson    )

    FeatureChild: a child of a Feature (rule, background, or scenario).

    FeatureChild::to_json

    source

    GherkinDocument

    source
    pub struct GherkinDocument {
      uri : String?
      feature : Feature?
      comments : Array[Comment]
    } derive(ToJson, 
    FromJson    )

    GherkinDocument: parsed Gherkin AST.

    GherkinDocument::to_json

    source

    Git

    source
    pub struct Git {
      remote : String
      revision : String
      branch : String?
      tag : String?
    } derive(ToJson, 
    FromJson    )

    Git: remote, revision, optional branch and tag (Meta sub-type).

    Git::to_json

    source
    fn Git::to_json(Git) -> Json

    Group

    source
    pub struct Group {
      children : Array[Group]?
      start : Int?
      value : String?
    } derive(ToJson)

    Group: capture group from step matching.
    impl FromJson for Group

    Group::to_json

    source
    fn Group::to_json(Group) -> Json

    Hook

    source
    pub struct Hook {
      id : String
      sourceReference : SourceReference
      name : String?
      tagExpression : String?
      type_ : HookType?
    }

    Hook: before/after hook definition. Note: JSON key is "type" (not "hookType") to match upstream schema.
    impl ToJson for Hook
    impl FromJson for Hook

    Hook::to_json

    source
    fn Hook::to_json(self : Hook) -> Json

    HookType

    source
    pub enum HookType {
      BeforeTestRun
      AfterTestRun
      BeforeTestCase
      AfterTestCase
      BeforeTestStep
      AfterTestStep
    }

    HookType: lifecycle hook type.
    impl ToJson for HookType

    HookType::to_json

    source
    fn HookType::to_json(self : HookType) -> Json

    JavaMethod

    source
    pub struct JavaMethod {
      className : String
      methodName : String
      methodParameterTypes : Array[String]
    } derive(ToJson, 
    FromJson    )

    JavaMethod: for SourceReference (Java glue).

    JavaMethod::to_json

    source
    fn JavaMethod::to_json(JavaMethod) -> Json

    JavaStackTraceElement

    source
    pub struct JavaStackTraceElement {
      className : String
      fileName : String
      methodName : String
    } derive(ToJson, 
    FromJson    )

    JavaStackTraceElement: for SourceReference.

    JavaStackTraceElement::to_json

    source

    KeywordType

    source
    pub enum KeywordType {
      Unknown
      Context
      Action
      Outcome
      Conjunction
    }

    KeywordType: keyword type for a step.

    KeywordType::to_json

    source
    fn KeywordType::to_json(self : KeywordType) -> Json

    Location

    source
    pub struct Location {
      line : Int
      column : Int?
    } derive(ToJson)

    Location: line and optional column in a text file (Cucumber Messages).

    Location::to_json

    source
    fn Location::to_json(Location) -> Json

    Meta

    source
    pub struct Meta {
      protocolVersion : String
      implementation : Product
      runtime : Product
      os : Product
      cpu : Product
      ci : Ci?
    } derive(ToJson, 
    FromJson    )

    Meta: protocol metadata (protocolVersion, implementation, runtime, os, cpu, optional ci).

    Meta::to_json

    source
    fn Meta::to_json(Meta) -> Json

    NdjsonReader

    source
    pub struct NdjsonReader {
      // private fields
    }

    Incremental NDJSON reader. Give it input one line at a time with read_line, or in chunks of any size with feed; it keeps track of line numbers so errors name the bad line.

    NdjsonReader::feed

    source
    fn NdjsonReader::feed(self : NdjsonReader, chunk : String) -> Array[Envelope] raise NdjsonParseError

    Parse every complete line in chunk. A partial last line is kept until the next feed or finish.

    NdjsonReader::finish

    source
    fn NdjsonReader::finish(self : NdjsonReader) -> Envelope? raise NdjsonParseError

    Parse the last line when the input does not end with \n.

    NdjsonReader::line_number

    source
    fn NdjsonReader::line_number(self : NdjsonReader) -> Int

    Number of lines read so far.

    NdjsonReader::new

    source

    Create a reader positioned before line 1.

    NdjsonReader::read_line

    source
    fn NdjsonReader::read_line(self : NdjsonReader, line : StringView) -> Envelope? raise NdjsonParseError

    Parse the next line of input (without its \n). A blank line gives None. A bad line raises NdjsonParseError with its line number.

    ParameterType

    source
    pub struct ParameterType {
      id : String
      name : String
      preferForRegularExpressionMatch : Bool
      regularExpressions : Array[String]
      useForSnippets : Bool
      sourceReference : SourceReference?
    } derive(ToJson)

    ParameterType: custom parameter type for step expressions.

    ParameterType::to_json

    source

    ParseError

    source
    pub struct ParseError {
      source : SourceReference
      message : String
    } derive(ToJson, 
    FromJson    )

    ParseError: parse error with source reference and message.

    ParseError::to_json

    source
    fn ParseError::to_json(ParseError) -> Json

    Pickle

    source
    pub(all) struct Pickle {
      id : String
      uri : String
      name : String
      language : String
      steps : Array[PickleStep]
      tags : Array[PickleTag]
      astNodeIds : Array[String]
      location : Location?
    } derive(ToJson)

    Pickle: compiled test case from a scenario.
    impl FromJson for Pickle

    Pickle::to_json

    source
    fn Pickle::to_json(Pickle) -> Json

    PickleDocString

    source
    pub(all) struct PickleDocString {
      argumentIndex : Int?
      mediaType : String?
      content : String
    } derive(ToJson)

    PickleDocString: a doc string in a pickle step.

    PickleDocString::to_json

    source

    PickleStep

    source
    pub(all) struct PickleStep {
      id : String
      text : String
      astNodeIds : Array[String]
      type_ : PickleStepType?
      argument : PickleStepArgument?
    }

    PickleStep: a step in a pickle. Note: JSON key is "type" (not "pickleStepType") to match upstream schema.

    PickleStep::to_json

    source
    fn PickleStep::to_json(self : PickleStep) -> Json

    PickleStepArgument

    source
    pub(all) struct PickleStepArgument {
      docString : PickleDocString?
      dataTable : PickleTable?
    } derive(ToJson, 
    FromJson    )

    PickleStepArgument: argument for a pickle step.

    PickleStepArgument::to_json

    source

    PickleStepType

    source
    pub(all) enum PickleStepType {
      Unknown
      Context
      Action
      Outcome
    }

    PickleStepType: type of a pickle step.

    PickleStepType::to_json

    source
    fn PickleStepType::to_json(self : PickleStepType) -> Json

    PickleTable

    source
    pub(all) struct PickleTable {
      argumentIndex : Int?
      rows : Array[PickleTableRow]
    } derive(ToJson)

    PickleTable: a data table in a pickle step.

    PickleTable::to_json

    source
    fn PickleTable::to_json(PickleTable) -> Json

    PickleTableCell

    source
    pub(all) struct PickleTableCell {
      value : String
    } derive(ToJson, 
    FromJson    )

    PickleTableCell: a cell in a pickle data table.

    PickleTableCell::to_json

    source

    PickleTableRow

    source
    pub(all) struct PickleTableRow {
      cells : Array[PickleTableCell]
    } derive(ToJson)

    PickleTableRow: a row in a pickle data table.

    PickleTableRow::to_json

    source

    PickleTag

    source
    pub(all) struct PickleTag {
      name : String
      astNodeId : String
    } derive(ToJson, 
    FromJson    )

    PickleTag: a tag in a pickle.

    PickleTag::to_json

    source
    fn PickleTag::to_json(PickleTag) -> Json

    Product

    source
    pub struct Product {
      name : String
      version : String?
    } derive(ToJson, 
    FromJson    )

    Product: name and optional version (Meta sub-type).

    Product::to_json

    source
    fn Product::to_json(Product) -> Json

    Rule

    source
    pub struct Rule {
      location : Location
      tags : Array[Tag]
      keyword : String
      name : String
      description : String
      children : Array[RuleChild]
      id : String
    } derive(ToJson, 
    FromJson    )

    Rule: a rule grouping scenarios in a feature.

    Rule::to_json

    source
    fn Rule::to_json(Rule) -> Json

    RuleChild

    source
    pub struct RuleChild {
      background : Background?
      scenario : Scenario?
    } derive(ToJson, 
    FromJson    )

    RuleChild: a child of a Rule (background or scenario).

    RuleChild::to_json

    source
    fn RuleChild::to_json(RuleChild) -> Json

    Scenario

    source
    pub struct Scenario {
      location : Location
      tags : Array[Tag]
      keyword : String
      name : String
      description : String
      steps : Array[Step]
      examples : Array[Examples]
      id : String
    } derive(ToJson, 
    FromJson    )

    Scenario: a scenario in a feature or rule.

    Scenario::to_json

    source
    fn Scenario::to_json(Scenario) -> Json

    Snippet

    source
    pub struct Snippet {
      language : String
      code : String
    } derive(ToJson, 
    FromJson    )

    Snippet: code snippet for a suggestion.

    Snippet::to_json

    source
    fn Snippet::to_json(Snippet) -> Json

    Source

    source
    pub struct Source {
      uri : String
      data : String
      mediaType : SourceMediaType
    } derive(ToJson, 
    FromJson    )

    Source: a source file (uri, data, mediaType).

    Source::to_json

    source
    fn Source::to_json(Source) -> Json

    SourceMediaType

    source
    pub enum SourceMediaType {
      GherkinPlain
      GherkinMarkdown
    }

    Source media type for Source.mediaType.

    SourceMediaType::to_json

    source
    fn SourceMediaType::to_json(self : SourceMediaType) -> Json

    SourceReference

    source
    pub struct SourceReference {
      uri : String?
      javaMethod : JavaMethod?
      javaStackTraceElement : JavaStackTraceElement?
      location : Location?
    } derive(ToJson, 
    FromJson    )

    SourceReference: points to a Source and optional Location (or Java method/stack).

    SourceReference::to_json

    source

    Step

    source
    pub struct Step {
      location : Location
      keyword : String
      text : String
      id : String
      keywordType : KeywordType?
      docString : DocString?
      dataTable : DataTable?
    } derive(ToJson, 
    FromJson    )

    Step: a step in a scenario or background.

    Step::to_json

    source
    fn Step::to_json(Step) -> Json

    StepDefinition

    source
    pub struct StepDefinition {
      id : String
      pattern : StepDefinitionPattern
      sourceReference : SourceReference
    } derive(ToJson, 
    FromJson    )

    StepDefinition: step definition with pattern and source reference.

    StepDefinition::to_json

    source

    StepDefinitionPattern

    source
    pub struct StepDefinitionPattern {
      source : String
      type_ : StepDefinitionPatternType
    }

    StepDefinitionPattern: pattern for a step definition. Note: JSON key is "type" (not "patternType") to match upstream schema.

    StepDefinitionPattern::to_json

    source

    StepDefinitionPatternType

    source
    pub enum StepDefinitionPatternType {
      CucumberExpression
      RegularExpression
    }

    StepDefinitionPatternType: pattern type for step definitions.

    StepDefinitionPatternType::to_json

    source

    StepMatchArgument

    source
    pub struct StepMatchArgument {
      group : Group
      parameterTypeName : String?
    } derive(ToJson, 
    FromJson    )

    StepMatchArgument: argument from step matching.

    StepMatchArgument::to_json

    source

    StepMatchArgumentsList

    source
    pub struct StepMatchArgumentsList {
      stepMatchArguments : Array[StepMatchArgument]
    } derive(ToJson, 
    FromJson    )

    StepMatchArgumentsList: list of step match arguments.

    StepMatchArgumentsList::to_json

    source

    Suggestion

    source
    pub struct Suggestion {
      id : String
      pickleStepId : String
      snippets : Array[Snippet]
    } derive(ToJson)

    Suggestion: snippet suggestion for an undefined step.

    Suggestion::to_json

    source
    fn Suggestion::to_json(Suggestion) -> Json

    TableCell

    source
    pub struct TableCell {
      location : Location
      value : String
    } derive(ToJson, 
    FromJson    )

    TableCell: a cell in a data table row.

    TableCell::to_json

    source
    fn TableCell::to_json(TableCell) -> Json

    TableRow

    source
    pub struct TableRow {
      location : Location
      cells : Array[TableCell]
      id : String
    } derive(ToJson, 
    FromJson    )

    TableRow: a row in a data table.

    TableRow::to_json

    source
    fn TableRow::to_json(TableRow) -> Json

    Tag

    source
    pub struct Tag {
      location : Location
      name : String
      id : String
    } derive(ToJson, 
    FromJson    )

    Tag: a tag in a Gherkin document.

    Tag::to_json

    source
    fn Tag::to_json(Tag) -> Json

    TestCase

    source
    pub struct TestCase {
      id : String
      pickleId : String
      testSteps : Array[TestStep]
      testRunStartedId : String?
    } derive(ToJson, 
    FromJson    )

    TestCase: a test case (compiled from a pickle).

    TestCase::to_json

    source
    fn TestCase::to_json(TestCase) -> Json

    TestCaseFinished

    source
    pub struct TestCaseFinished {
      testCaseStartedId : String
      timestamp : Timestamp
      willBeRetried : Bool
    } derive(ToJson, 
    FromJson    )

    TestCaseFinished: test case attempt finished.

    TestCaseFinished::to_json

    source

    TestCaseStarted

    source
    pub struct TestCaseStarted {
      attempt : Int
      id : String
      testCaseId : String
      workerId : String?
      timestamp : Timestamp
    } derive(ToJson)

    TestCaseStarted: test case attempt started.

    TestCaseStarted::to_json

    source

    TestRunFinished

    source
    pub struct TestRunFinished {
      message : String?
      success : Bool
      timestamp : Timestamp
      exception : Exception?
      testRunStartedId : String?
    } derive(ToJson, 
    FromJson    )

    TestRunFinished: test run finished (success, timestamp, optional message, exception, testRunStartedId).

    TestRunFinished::to_json

    source

    TestRunHookFinished

    source
    pub struct TestRunHookFinished {
      testRunHookStartedId : String
      result : TestStepResult
      timestamp : Timestamp
    } derive(ToJson, 
    FromJson    )

    TestRunHookFinished: hook execution finished.

    TestRunHookFinished::to_json

    source

    TestRunHookStarted

    source
    pub struct TestRunHookStarted {
      id : String
      testRunStartedId : String
      hookId : String
      timestamp : Timestamp
      workerId : String?
    } derive(ToJson, 
    FromJson    )

    TestRunHookStarted: hook execution lifecycle.

    TestRunHookStarted::to_json

    source

    TestRunStarted

    source
    pub struct TestRunStarted {
      timestamp : Timestamp
      id : String?
    } derive(ToJson, 
    FromJson    )

    TestRunStarted: test run lifecycle.

    TestRunStarted::to_json

    source

    TestStep

    source
    pub struct TestStep {
      id : String
      hookId : String?
      pickleStepId : String?
      stepDefinitionIds : Array[String]?
      stepMatchArgumentsLists : Array[StepMatchArgumentsList]?
    } derive(ToJson, 
    FromJson    )

    TestStep: a step in a test case.

    TestStep::to_json

    source
    fn TestStep::to_json(TestStep) -> Json

    TestStepFinished

    source
    pub struct TestStepFinished {
      testCaseStartedId : String
      testStepId : String
      testStepResult : TestStepResult
      timestamp : Timestamp
    } derive(ToJson, 
    FromJson    )

    TestStepFinished: step finished with result.

    TestStepFinished::to_json

    source

    TestStepResult

    source
    pub struct TestStepResult {
      duration : Duration
      status : TestStepResultStatus
      message : String?
      exception : Exception?
    } derive(ToJson, 
    FromJson    )

    TestStepResult: result of a step (duration, status, optional message and exception).

    TestStepResult::to_json

    source

    TestStepResultStatus

    source
    pub enum TestStepResultStatus {
      Unknown
      Passed
      Skipped
      Pending
      Undefined
      Ambiguous
      Failed
    }

    TestStepResultStatus: status of a step.

    TestStepResultStatus::to_json

    source

    TestStepStarted

    source
    pub struct TestStepStarted {
      testCaseStartedId : String
      testStepId : String
      timestamp : Timestamp
    } derive(ToJson, 
    FromJson    )

    TestStepStarted: step lifecycle.

    TestStepStarted::to_json

    source

    Timestamp

    source
    pub struct Timestamp {
      seconds : Int64
      nanos : Int
    }

    Timestamp: seconds since Unix epoch + nanos (0..999_999_999). seconds is an Int64 so that dates after 2038-01-19 fit.
    impl ToJson for Timestamp

    Timestamp::to_json

    source
    fn Timestamp::to_json(self : Timestamp) -> Json

    UndefinedParameterType

    source
    pub struct UndefinedParameterType {
      expression : String
      name : String
    } derive(ToJson, 
    FromJson    )

    UndefinedParameterType: reports undefined parameter type.

    UndefinedParameterType::to_json

    source

    envelopes_to_ndjson

    source
    fn envelopes_to_ndjson(envelopes : Array[Envelope]) -> String

    Serialize an array of Envelopes to NDJSON: one JSON object per line, each line ending with \n.

    parse_ndjson

    source
    fn parse_ndjson(input : String) -> Array[Envelope] raise NdjsonParseError

    Parse an NDJSON string (multiple lines) into an array of Envelopes. Blank lines are skipped. A bad line raises NdjsonParseError.

    parse_ndjson_line

    source
    fn parse_ndjson_line(line : String) -> Envelope raise

    Parse a single NDJSON line into an Envelope.

    protocol_version

    source
    let protocol_version : String

    Cucumber Messages protocol version.

    Source Files

    Powered by MoonBit

    Site sourceReport issuePackagesBuild queueSkillsStatistics

    © 2026 mooncakes.io