conformance

module
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 2, 2021 License: Apache-2.0

README

CloudEvents Conformance Testing

cloudevents is a tool for testing CloudEvents receivers.

GoDoc Go Report Card

Work in progress.

Installation

cloudevents can be installed via:

go get github.com/cloudevents/conformance/cmd/cloudevents

To update your installation:

go get -u github.com/cloudevents/conformance/cmd/cloudevents

Usage

cloudevents has three commands at the moment: send, invoke and listen.

Send

send will do a one-off creation of a cloudevent and send to a given target.

cloudevents send http://localhost:8080 --id abc-123 --source cloudevents.conformance.tool --type foo.bar
Invoke

invoke will read yaml files, convert them to http and send them to the given target.

cloudevents invoke http://localhost:8080 -f ./yaml/v0.3
Listen

listen will accept http request and write the converted yaml to stdout.

cloudevents listen -v > got.yaml

Optionally, you can forward the incoming request to a target.

cloudevents listen -v -t http://localhost:8181 > got.yaml

Advanced Usage

If you would like to produce a pre-produced event yaml file, you can use listen to collect requests. This works with both running event producers that can be directed at the listen port or directly with send.

TODO

Feature requests:

  • Add a yaml command that allows the same format of send but direct to yaml.
  • Add a --yaml flag to send that outputs what the definition of the sent event would look like in yaml.
  • Add -f - support for reading from STDIN as the file for yaml, this allows for send | invoke chaining.
  • Add format support to send to select binary or structured.

Directories

Path Synopsis
cmd
cloudevents command
pkg

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL