https://github.com/matrix-org/patience

Full stack integration testing for Matrix clients and servers
https://github.com/matrix-org/patience

client integration matrix server testing

Last synced: about 2 months ago
JSON representation

Full stack integration testing for Matrix clients and servers

• Host: GitHub
• URL: https://github.com/matrix-org/patience
• Owner: matrix-org
• License: apache-2.0
• Created: 2021-08-05T13:26:25.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2021-12-06T17:50:12.000Z (almost 3 years ago)
• Last Synced: 2024-05-20T19:09:49.068Z (4 months ago)
• Topics: client, integration, matrix, server, testing
• Language: TypeScript
• Homepage:
• Size: 1.19 MB
• Stars: 18
• Watchers: 6
• Forks: 3
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-matrix - Patience - Full stack integration (Testing / 2016)

README

        
# Patience

[![CI](https://github.com/matrix-org/patience/actions/workflows/ci.yml/badge.svg)](https://github.com/matrix-org/patience/actions/workflows/ci.yml)

[![Matrix](https://img.shields.io/matrix/matrix-patience:matrix.org?label=%23matrix-patience%3Amatrix.org&logo=matrix)](https://matrix.to/#/#matrix-patience:matrix.org)

Full stack integration testing for Matrix clients and servers

![](example.png)

## Features

* Any permutation of supported clients can be tested together

* Client specifics are hidden by default (but still accessible) so tests can

  target many clients without modification

* Tests written in TypeScript

* Report mode gives a quick summary of results in your terminal

* Interactive mode allows you to try out and debug the clients in your browser

* Builds on top of [Complement's `homerunner` API](https://github.com/matrix-org/complement/tree/master/cmd/homerunner)

* Test harness displays all clients together on one page

## Supported environments

Patience aims to support testing different combinations of Matrix clients and

servers in a unified environment.

Element Web and Hydrogen are the currently supported clients. Anything that fits

in an `iframe` should be easy to add. Tools such as

[Appetize](https://appetize.io/) could be used to add mobile clients.

Synapse and Dendrite are the currently supported homeservers.

## Usage

Setup is currently a bit manual, as this project is just getting started. If you

have suggestions on how to improve setup, please file an issue.

To get started with Patience in your project, first collect the following bits

and bobs:

- Docker

- Go

- Node.js

- `homerunner` from [Complement](https://github.com/matrix-org/complement)

  - `go install github.com/matrix-org/complement/cmd/homerunner@latest`

- One or more Complement-ready [homeserver

  images](https://github.com/matrix-org/complement#running-against-dendrite)

- Chrome

  - We plan to switch to Playwright in the future to support additional browsers

Create a directory to hold your tests and add Patience:

`npm add @matrix-org/patience --save-dev`

Add a test, perhaps by copying [`hello.ts`](./examples/hello.ts). At a minimum,

you should call `orchestrate` to set up servers, clients, and rooms for your

test. Most likely you'll want to actually test something too.

To run your tests in reporting mode:

`npx patience '*.ts'`

You should see:

```

Finished running tests, all tests passed! 🎉

```

To run your tests in interactive mode:

`npx patience '*.ts' -- --manual`

This will start a server at `localhost:8000` which you can navigate to in your

browser. Click on one of listed test files to watch the test run. You can

interact with the clients, timeline, etc. The clients remain after for

exploration until you stop the server.