{"id":18131519,"url":"https://github.com/comcast/plax","last_synced_at":"2025-04-15T23:03:13.637Z","repository":{"id":38298597,"uuid":"318534079","full_name":"Comcast/plax","owner":"Comcast","description":"A test automation engine for messaging systems","archived":false,"fork":false,"pushed_at":"2024-02-21T20:27:14.000Z","size":22982,"stargazers_count":7,"open_issues_count":42,"forks_count":14,"subscribers_count":8,"default_branch":"main","last_synced_at":"2025-03-29T02:21:49.440Z","etag":null,"topics":["automation","mqtt","testing"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Comcast.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGES.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-12-04T14:03:46.000Z","updated_at":"2023-11-11T03:09:04.000Z","dependencies_parsed_at":"2022-09-08T07:33:47.655Z","dependency_job_id":"9b44ad90-9372-41b7-95bc-1b0674ef69ec","html_url":"https://github.com/Comcast/plax","commit_stats":null,"previous_names":[],"tags_count":48,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Comcast%2Fplax","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Comcast%2Fplax/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Comcast%2Fplax/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Comcast%2Fplax/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Comcast","download_url":"https://codeload.github.com/Comcast/plax/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246363604,"owners_count":20765319,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["automation","mqtt","testing"],"created_at":"2024-11-01T12:07:49.396Z","updated_at":"2025-03-30T18:31:18.347Z","avatar_url":"https://github.com/Comcast.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Plax: an engine for testing messaging systems\n\n[![Go Reference](https://pkg.go.dev/badge/github.com/Comcast/plax.svg)](https://pkg.go.dev/github.com/Comcast/plax)\n[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0)\n[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v1.4%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md)\n\n\n\u003e And with reference to the narrative of events, far from permitting\n\u003e myself to derive it from the first source that came to hand, I did\n\u003e not even trust my own impressions, but it rests partly on what I saw\n\u003e myself, partly on what others saw for me, **the accuracy of the\n\u003e report being always tried by the most severe and detailed tests\n\u003e possible**.\n\n-- [Thucydides, _The History of the Peloponnesian\nWar_](http://classics.mit.edu/Thucydides/pelopwar.1.first.html)\n\n\n## Summary\n\nPlax is a test automation engine for messaging systems.  This engine\nis [designed](chans) to perform integrated testing of MQTT messaging,\nKinesis streams, SNS traffic, SQS [trafic](demos/sqs.yaml), Kafka I/O,\nHTTP APIs, [subprocesses](demos/shell.yaml), mobile\n[apps](demos/webdriver.yaml) (via\n[WebDriver](https://www.w3.org/TR/webdriver/)), and more.\n\nAn author of a test specifies a sequence of input and expected outputs\nover a set of channels that are connected to external services.\nExecution of the test verifies that the expected output occurred.\n\n## Automated Build Status\n[![Test](https://github.com/Comcast/plax/actions/workflows/test.yml/badge.svg)](https://github.com/Comcast/plax/actions/workflows/test.yml)\n[![Tag](https://github.com/Comcast/plax/actions/workflows/tag.yml/badge.svg)](https://github.com/Comcast/plax/actions/workflows/tag.yml)\n[![Release](https://github.com/Comcast/plax/actions/workflows/release.yml/badge.svg)](https://github.com/Comcast/plax/actions/workflows/release.yml)\n\n## Command-line tools in this repo\n\n1. [`plax`](cmd/plax): The test engine (and probably the reason you\n   are here).  Documentation is [here](doc/manual.md).\n1. [`plaxrun`](cmd/plaxrun): Tool to run lots of Plax tests with\n   various configurations.  Documentation is [here](doc/plaxrun.md).\n1. [`plaxsubst`](cmd/plaxsubst): Utility to test/use parameter\n   substitution independently from other Plax functionality.  Related\n   documenation is [here](subst/README.md).\n1. [`yamlincl`](cmd/yamlincl): YAML include processor utility.\n   Documenation is [here](doc/manual.md#including-yaml-in-other-yaml).\n\n\n## Usage\n\nClone this repo and [install Go](https://golang.org/doc/install).\nThen:\n\n```Shell\n(cd cmd/plax \u0026\u0026 go install)\n# Run one simple test.\nplax -test demos/mock.yaml -log debug\n# Run several tests.\nplax -dir demos -labels selftest\n```\n\nThat last command runs all the [example test specs](demos) that are\nlabeled as `selftest`. [`basic.yaml`](demos/basic.yaml) is a good,\nsmall example of a test specification.\n\n## Plugins\n1. [Octane plugin](doc/octane_plugin.md)\n\n## The language\n\nSee the [main documentation](doc/manual.md) and the [examples](demos).\n\n## References\n\n1. [Plax manual](doc/manual.md) and the [`plaxrun`\n   manual](doc/plaxrun.md)\n1. [Sheens pattern\n   matching](https://github.com/Comcast/sheens#pattern-matching) and\n   some\n   [examples](https://github.com/Comcast/sheens/blob/master/match/match.md)\n1. [Sheens](https://github.com/Comcast/sheens), which could be\n   [used](https://github.com/Comcast/sheens/tree/master/sio/siomq) to\n   implement more complex tests and simulations\n1. [TCL \"expect\"](https://en.wikipedia.org/wiki/Expect)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcomcast%2Fplax","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcomcast%2Fplax","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcomcast%2Fplax/lists"}