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

Verification

A verification container can be used to verify the results of a Cicada test run.

The verification container can load a JSON state file from a local path or S3 and returns an exit code 0 if all tests ran successfully, or 1 otherwise.

To run the verification container, run:

docker run --rm -v /path/to/reports:/input cicadatesting/cicada-verification

By default, This will run verification against the state.final.json file outputted by the cicada engine to a reports directory.

Verify Tests

state-file

Option to override the state file to verify.

Example:

docker run ... cicadatesting/cicada-verification --state-file s3://reports/state.final.json

This will load the state file from S3 at s3://reports/state.final.json

Currently, this supports the following formats:

  • File path: file:///absolute/path/to/state/file
  • S3 path: s3://path/to/state/file

Defaults to file:///input/state.final.json

timeout

Option to override retry time for state file to be loaded

Example:

docker run ... cicadatesting/cicada-verification --timeout 300

This will override the timeout to wait 300 seconds before stopping if the file can't be found

Defaults to 120 seconds (with 5 seconds between polls)

Environment variables

S3_ENDPOINT

S3 endpoint of server to connect to

S3_REGION

Region S3 server is located

S3_ACCESS_KEY_ID

Access key to use when connecting to S3 server

S3_SECRET_ACCESS_KEY

Secret access key to use with access key ID for connecting to S3 server

USE_SSL

Flag to use SSL when downloading. Defaults to true

← Test EngineREST Runner →
  • Verify Tests
    • state-file
    • timeout
  • Environment variables
    • S3_ENDPOINT
    • S3_REGION
    • S3_ACCESS_KEY_ID
    • S3_SECRET_ACCESS_KEY
    • USE_SSL
Cicada
Docs
Getting StartedAPI Reference
More
GitHubStar
Copyright © 2021 Cicada