Cicada

Cicada

  • Docs
  • Guides
  • API
  • Runners
  • Help

›API

Introduction

  • Quickstart
  • Tests
  • State
  • Actions and Asserts
  • Runners
  • Reports

Guides

  • REST API Guide
  • Async App Guide
  • gRPC Server Guide
  • Kubernetes Guide

API

  • Test
  • Action
  • Assert
  • Config
  • Test Engine
  • Verification

Runners

  • REST Runner
  • SQL Runner
  • Kafka Runner
  • S3 Runner
  • gRPC Runner

Config

Environment variables that can be provided to the engine

CONTAINER_NETWORK

Docker network to attach containers to.

Defaults to cicada

CREATE_NETWORK

Create CONTAINER_NETWORK if set to true, y, or yes

Defaults to true

ERROR_CODE_OVERRIDE

Overrides error code generated at end of Cicada run.

By default, this is unset. Will exit with code 1 if no remaining asserts and errored runs. Exits 0 otherwise.

HEALTHCHECK_INITIAL_WAIT

Time in seconds to wait before checking runner for first time before entering exponential backoff

Defaults to 2 seconds

HEALTHCHECK_MAX_RETRIES

Amount of times to try healthchecking runner

Defaults to 5 tries

INITIAL_STATE_FILE

Path to JSON state file to use as the inital state data to provide to tests. Must also be mounted to engine in a volume.

POD_NAMESPACE

Namespace to run pods in (kubernetes only)

Defaults to default

POD_SERVICE_ACCOUNT

Service account to give to runners inside pods if specified (kubernetes only)

Defaults to default

REPORTS_FOLDER

Path in engine to write reports files to.

Defaults to /reports

TASK_TYPE

Container platform to use for runners.

Defaults to docker. Alternate value is kube (for kubernetes)

TESTS_FOLDER

Path in engine to load test files from.

Defaults to /tests

← AssertTest Engine →
  • CONTAINER_NETWORK
  • CREATE_NETWORK
  • ERROR_CODE_OVERRIDE
  • HEALTHCHECK_INITIAL_WAIT
  • HEALTHCHECK_MAX_RETRIES
  • INITIAL_STATE_FILE
  • POD_NAMESPACE
  • POD_SERVICE_ACCOUNT
  • REPORTS_FOLDER
  • TASK_TYPE
  • TESTS_FOLDER
Cicada
Docs
Getting StartedAPI Reference
More
GitHubStar
Copyright © 2021 Cicada