Record Class Scenario

java.lang.Object
java.lang.Record
codes.grow.packages.betterstack.testing.Scenario
Record Components:
id - scenario id, e.g. secrets.roundtrip
category - core, secrets, logging or tracing
description - human description
requires - capabilities the target must declare
steps - the steps in order
raw - the original JSON document

public record Scenario(String id, String category, String description, List<String> requires, List<Scenario.Step> steps, com.fasterxml.jackson.databind.JsonNode raw) extends Record
A parsed conformance scenario (conformance/scenarios/*.json).
  • Constructor Details

    • Scenario

      public Scenario(String id, String category, String description, List<String> requires, List<Scenario.Step> steps, com.fasterxml.jackson.databind.JsonNode raw)
      Creates a scenario; lists are copied.
      Parameters:
      id - scenario id
      category - category
      description - description
      requires - capabilities
      steps - steps
      raw - original JSON
  • Method Details

    • batchOptions

      public Optional<com.fasterxml.jackson.databind.JsonNode> batchOptions()
      Returns the batchOptions object of a logging scenario.
      Returns:
      the options, or empty
    • parse

      public static Scenario parse(com.fasterxml.jackson.databind.JsonNode node)
      Parses a scenario document.
      Parameters:
      node - scenario JSON
      Returns:
      the scenario
      Throws:
      IllegalArgumentException - when required fields are missing
    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object
    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object
    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.
    • id

      public String id()
      Returns the value of the id record component.
      Returns:
      the value of the id record component
    • category

      public String category()
      Returns the value of the category record component.
      Returns:
      the value of the category record component
    • description

      public String description()
      Returns the value of the description record component.
      Returns:
      the value of the description record component
    • requires

      public List<String> requires()
      Returns the value of the requires record component.
      Returns:
      the value of the requires record component
    • steps

      public List<Scenario.Step> steps()
      Returns the value of the steps record component.
      Returns:
      the value of the steps record component
    • raw

      public com.fasterxml.jackson.databind.JsonNode raw()
      Returns the value of the raw record component.
      Returns:
      the value of the raw record component