plax

package module

v0.8.14 Latest Latest Go to latest Published: Sep 16, 2021 License: Apache-2.0 Imports: 0 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/Comcast/plax

Links

Open Source Insights

README ¶

Plax: an engine for testing messaging systems

And with reference to the narrative of events, far from permitting myself to derive it from the first source that came to hand, I did not even trust my own impressions, but it rests partly on what I saw myself, partly on what others saw for me, the accuracy of the report being always tried by the most severe and detailed tests possible.

-- Thucydides, The History of the Peloponnesian War

Summary

Plax is a test automation engine for messaging systems. This engine is designed to perform integrated testing of MQTT messaging, Kinesis streams, SNS traffic, SQS trafic, Kafka I/O, HTTP APIs, subprocesses, mobile apps (via WebDriver), and more.

An author of a test specifies a sequence of input and expected outputs over a set of channels that are connected to external services. Execution of the test verifies that the expected output occurred.

Automated Build Status

Command-line tools in this repo

plax: The test engine (and probably the reason you are here). Documentation is here.
plaxrun: Tool to run lots of Plax tests with various configurations. Documentation is here.
plaxsubst: Utility to test/use parameter substitution independently from other Plax functionality. Related documenation is here.
yamlincl: YAML include processor utility. Documenation is here.

Usage

Clone this repo and install Go. Then:

(cd cmd/plax && go install)
# Run one simple test.
plax -test demos/mock.yaml -log debug
# Run several tests.
plax -dir demos -labels selftest

That last command runs all the example test specs that are labeled as selftest. basic.yaml is a good, small example of a test specification.

The language

See the main documentation and the examples.

References

Plax manual and the plaxrun manual
Sheens pattern matching and some examples
Sheens, which could be used to implement more complex tests and simulations
TCL "expect"

Documentation ¶

Overview ¶

Package Plax is an automation engine for messaging systems.

Source Files ¶

View all Source files

doc.go

Directories ¶

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

Path	Synopsis
chans Package chans provides a few channel types.	Package chans provides a few channel types.
cwl package cwl provides an AWS CloudWatch producer and consumer channel (type).	package cwl provides an AWS CloudWatch producer and consumer channel (type).
httpclient
httpserver
kds
mqtt
shell Package shell provides a 'cmd' channel type.	Package shell provides a 'cmd' channel type.
sqlc Package sqlc provides a Plax channel type for talking to a SQL database.	Package sqlc provides a Plax channel type for talking to a SQL database.
sqlc/mysql Package main exists to act as a Go plug-in for a MySQL driver for the Plax SQL channel type.	Package main exists to act as a Go plug-in for a MySQL driver for the Plax SQL channel type.
sqs
std Package std exists just to collect _ imports for the standard channel types implemented in this repo.	Package std exists just to collect _ imports for the standard channel types implemented in this repo.
cmd
plax Package main is the standard Plax command-line program.	Package main is the standard Plax command-line program.
plaxrun Package main is the 'plaxrun' command-line program for running many tests with various configurations.	Package main is the 'plaxrun' command-line program for running many tests with various configurations.
plaxrun/async
plaxrun/dsl * Copyright 2021 Comcast Cable Communications Management, LLC * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License.	* Copyright 2021 Comcast Cable Communications Management, LLC * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License.
plaxrun/plugins
plaxrun/plugins/report * Copyright 2021 Comcast Cable Communications Management, LLC * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License.	* Copyright 2021 Comcast Cable Communications Management, LLC * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License.
plaxsubst
yamlincl Package main is the command-line 'yamlincl' utilitiy.	Package main is the command-line 'yamlincl' utilitiy.
dsl Package dsl is the core Plax functionality.	Package dsl is the core Plax functionality.
invoke Package invoke provides gear supporting to facilitate running Plax tests in different environments (and configurations).	Package invoke provides gear supporting to facilitate running Plax tests in different environments (and configurations).
junit Package junit provides simplified structures for JUnit test reports.	Package junit provides simplified structures for JUnit test reports.
subst