cornichon-docs
API
Generated with
cornichon-docs/com.github.agourlay.cornichon/CornichonFeature

CornichonFeature

com.github.agourlay.cornichon.CornichonFeature
trait CornichonFeature extends CornichonBaseFeature, HttpDsl, JsonDsl, CheckDsl

Attributes

Graph
Supertypes
trait CheckDsl
trait JsonDsl
trait HttpDsl
trait HttpDslOps
trait CoreDsl
trait BaseFeature
class Object
trait Matchable
class Any
Show all

Members list

Type members

Inherited classlikes

case object And extends Starters

Attributes

Inherited from:
CoreDsl
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait Starters
trait Dynamic
class Object
trait Matchable
class Any
Show all
case object Given extends Starters

Attributes

Inherited from:
CoreDsl
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait Starters
trait Dynamic
class Object
trait Matchable
class Any
Show all
sealed trait Starters extends Dynamic

Attributes

Inherited from:
CoreDsl
Supertypes
trait Dynamic
class Object
trait Matchable
class Any
Known subtypes
object And
object Given
object Then
object When
case object Then extends Starters

Attributes

Inherited from:
CoreDsl
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait Starters
trait Dynamic
class Object
trait Matchable
class Any
Show all
case object When extends Starters

Attributes

Inherited from:
CoreDsl
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait Starters
trait Dynamic
class Object
trait Matchable
class Any
Show all

Value members

Inherited methods

def Attach: BodyElementCollector[Step, Step]

Attributes

Inherited from:
CoreDsl
def AttachAs(title: String): BodyElementCollector[Step, Step]

Attributes

Inherited from:
CoreDsl
def Concurrently(maxTime: FiniteDuration): BodyElementCollector[Step, Step]

Attributes

Inherited from:
CoreDsl
def Eventually(maxDuration: FiniteDuration, interval: FiniteDuration): BodyElementCollector[Step, Step]

Attributes

Inherited from:
CoreDsl
def Feature(name: String): FeatureBuilder

Attributes

Inherited from:
CoreDsl
def LogDuration(label: String): BodyElementCollector[Step, Step]

Attributes

Inherited from:
CoreDsl
def Repeat(times: Int, index: String): BodyElementCollector[Step, Step]

Attributes

Inherited from:
CoreDsl
def Repeat(times: Int): BodyElementCollector[Step, Step]

Attributes

Inherited from:
CoreDsl
def RepeatConcurrently(times: Int, parallelism: Int, maxTime: FiniteDuration): BodyElementCollector[Step, Step]

Attributes

Inherited from:
CoreDsl
def RepeatDuring(duration: FiniteDuration): BodyElementCollector[Step, Step]

Attributes

Inherited from:
CoreDsl
def RepeatFrom[A](elements: Iterable[ContainerType[A, Show]])(index: String): BodyElementCollector[Step, Step]

Attributes

Inherited from:
CoreDsl
def RepeatWith(elements: ContainerType[Any, Show]*)(index: String): BodyElementCollector[Step, Step]

Attributes

Inherited from:
CoreDsl
def RetryMax(limit: Int): BodyElementCollector[Step, Step]

Attributes

Inherited from:
CoreDsl
def Scenario(name: String): ScenarioBuilder

Attributes

Inherited from:
CoreDsl
def WithBasicAuth(userName: String, password: String): BodyElementCollector[Step, Seq[Step]]

Attributes

Inherited from:
HttpDsl
def WithDataInputs(where: String): BodyElementCollector[Step, Step]

Attributes

Inherited from:
CoreDsl
def WithHeaders(headers: (String, String)*): BodyElementCollector[Step, Seq[Step]]

Attributes

Inherited from:
HttpDsl
def WithJsonDataInputs(where: String): BodyElementCollector[Step, Step]

Attributes

Inherited from:
CoreDsl
def WithResource(resource: Resource): BodyElementCollector[Step, Step]

Attributes

Inherited from:
CoreDsl
def Within(maxDuration: FiniteDuration): BodyElementCollector[Step, Step]

Attributes

Inherited from:
CoreDsl
def addToWithHeaders(name: String, value: String)(s: Session): Either[CornichonError, Session]

Attributes

Inherited from:
HttpDslOps
def afterEachScenario(step: Step): Unit

Attributes

Inherited from:
BaseFeature
def afterFeature(after: => Unit): Unit

Attributes

Inherited from:
BaseFeature
def beforeEachScenario(step: Step): Unit

Attributes

Inherited from:
BaseFeature
def beforeFeature(before: => Unit): Unit

Attributes

Inherited from:
BaseFeature
def body: JsonStepBuilder

Attributes

Inherited from:
HttpDsl
def body_raw: SessionStepBuilder

Attributes

Inherited from:
HttpDsl
def check_model[A, B, C, D, E, F](maxNumberOfRuns: Int, maxNumberOfTransitions: Int)(modelRunner: ModelRunner[A, B, C, D, E, F]): Step

Attributes

Inherited from:
CheckDsl
def delete(url: String): HttpRequest[String]

Attributes

Inherited from:
HttpRequestsDsl
def for_all[A, B, C, D, E, F](description: String, maxNumberOfRuns: Int, ga: RandomContext => Generator[A], gb: RandomContext => Generator[B], gc: RandomContext => Generator[C], gd: RandomContext => Generator[D], ge: RandomContext => Generator[E], gf: RandomContext => Generator[F])(builder: A => B => C => D => E => F => Step): Step

Attributes

Inherited from:
CheckDsl
def for_all[A, B, C, D, E](description: String, maxNumberOfRuns: Int, ga: RandomContext => Generator[A], gb: RandomContext => Generator[B], gc: RandomContext => Generator[C], gd: RandomContext => Generator[D], ge: RandomContext => Generator[E])(builder: A => B => C => D => E => Step): Step

Attributes

Inherited from:
CheckDsl
def for_all[A, B, C, D](description: String, maxNumberOfRuns: Int, ga: RandomContext => Generator[A], gb: RandomContext => Generator[B], gc: RandomContext => Generator[C], gd: RandomContext => Generator[D])(builder: A => B => C => D => Step): Step

Attributes

Inherited from:
CheckDsl
def for_all[A, B, C](description: String, maxNumberOfRuns: Int, ga: RandomContext => Generator[A], gb: RandomContext => Generator[B], gc: RandomContext => Generator[C])(builder: A => B => C => Step): Step

Attributes

Inherited from:
CheckDsl
def for_all[A, B](description: String, maxNumberOfRuns: Int, ga: RandomContext => Generator[A], gb: RandomContext => Generator[B])(builder: A => B => Step): Step

Attributes

Inherited from:
CheckDsl
def for_all[A](description: String, maxNumberOfRuns: Int, ga: RandomContext => Generator[A])(builder: A => Step): Step

Attributes

Inherited from:
CheckDsl
def get(url: String): HttpRequest[String]

Attributes

Inherited from:
HttpRequestsDsl
def head(url: String): HttpRequest[String]

Attributes

Inherited from:
HttpRequestsDsl
def headers: HeadersStepBuilder.type

Attributes

Inherited from:
HttpDsl
def httpServiceByURL(baseUrl: String, timeout: FiniteDuration): HttpService

Attributes

Inherited from:
HttpDsl
def open_sse(url: String, takeWithin: FiniteDuration): HttpStreamedRequest

Attributes

Inherited from:
HttpDsl
def options(url: String): HttpRequest[String]

Attributes

Inherited from:
HttpRequestsDsl
def patch(url: String): HttpRequest[String]

Attributes

Inherited from:
HttpRequestsDsl
def post(url: String): HttpRequest[String]

Attributes

Inherited from:
HttpRequestsDsl
def put(url: String): HttpRequest[String]

Attributes

Inherited from:
HttpRequestsDsl
def query_gql(url: String): QueryGQL

Attributes

Inherited from:
HttpDsl
def registerExtractors: Map[String, Mapper]

Attributes

Inherited from:
BaseFeature
def registerMatchers: List[Matcher]

Attributes

Inherited from:
BaseFeature
def remove(key: String): Step

Attributes

Inherited from:
CoreDsl
def removeFromWithHeaders(name: String)(s: Session): Either[CornichonError, Session]

Attributes

Inherited from:
HttpDslOps
def rollback(key: String, show: Boolean): Step

Attributes

Inherited from:
CoreDsl
def save(input: (String, String), show: Boolean): Step

Save value into session

Save value into session

Value parameters

input

tuple (sessionKey, value)

show

whether to show this step in the debug output

Attributes

Returns

a Step

Inherited from:
CoreDsl
def save_body(target: String): Step

Attributes

Inherited from:
HttpDsl
def save_body_path(args: (String, String)*): Step

Save part of the body into the session

Save part of the body into the session

Value parameters

args

variadic tuples with (jsonPath, targetSessionKey)

Attributes

Returns

a Step

Inherited from:
HttpDsl
def save_header_value(args: (String, String)*): Step

Attributes

Inherited from:
HttpDsl
def session_history(key: String): SessionHistoryStepBuilder

Attributes

Inherited from:
CoreDsl
def session_value(key: String): SessionStepBuilder

Attributes

Inherited from:
CoreDsl
def session_values(k1: String, k2: String): SessionValuesStepBuilder

Attributes

Inherited from:
CoreDsl
def show_key_as_json(key: String, index: Option[Int]): Step

Attributes

Inherited from:
JsonDsl
def show_last_body: Step

Attributes

Inherited from:
HttpDsl
def show_last_body_json: Step

Attributes

Inherited from:
HttpDsl
def show_last_headers: Step

Attributes

Inherited from:
HttpDsl
def show_last_response: Step

Attributes

Inherited from:
HttpDsl
def show_last_response_json: Step

Attributes

Inherited from:
HttpDsl
def show_last_status: Step

Attributes

Inherited from:
HttpDsl
def show_session(key: String, index: Option[Int], transform: String => Either[CornichonError, String]): DebugStep

Attributes

Inherited from:
CoreDsl
def show_session: Step

Attributes

Inherited from:
CoreDsl
def show_with_headers: Step

Attributes

Inherited from:
HttpDsl
def status: StatusStepBuilder.type

Attributes

Inherited from:
HttpDsl
def transform_session(key: String)(map: String => String): Step

Attributes

Inherited from:
CoreDsl
def wait(duration: FiniteDuration): Step

Attributes

Inherited from:
CoreDsl

Inherited and Abstract methods

def feature: FeatureDef

Attributes

Inherited from:
BaseFeature

Inherited fields

lazy val baseUrl: String

Attributes

Inherited from:
HttpDsl
lazy val executeScenariosInParallel: Boolean

Attributes

Inherited from:
BaseFeature
lazy val http: HttpService

Attributes

Inherited from:
HttpDsl
lazy val requestTimeout: FiniteDuration

Attributes

Inherited from:
HttpDsl
lazy val seed: Option[Long]

Attributes

Inherited from:
BaseFeature

Implicits

Inherited implicits

final implicit def featureBuilder(f: FeatureBuilder): BodyElementCollector[Scenario, FeatureDef]

Attributes

Inherited from:
CoreDsl
implicit def httpRequestToStep[A : Encoder](request: HttpRequest[A]): Step

Attributes

Inherited from:
HttpDsl
implicit def httpStreamedRequestToStep(request: HttpStreamedRequest): Step

Attributes

Inherited from:
HttpDsl
implicit def queryGqlToHttpRequest(queryGQL: QueryGQL): HttpRequest[String]

Attributes

Inherited from:
HttpDsl
implicit def queryGqlToStep(queryGQL: QueryGQL): Step

Attributes

Inherited from:
HttpDsl
final implicit def scenarioBuilder(s: ScenarioBuilder): BodyElementCollector[Step, Scenario]

Attributes

Inherited from:
CoreDsl
Generated with