continuwuity/tests/complement/README.md

# Complement

## What's that?

Have a look at [its repository](https://github.com/matrix-org/complement).

## How do I use it with Conduit?

The script at [`../bin/complement`](../bin/complement) has automation for this.
It takes a few command line arguments:

- Path to Complement's source code
- A `.jsonl` file to write test logs to
- A `.jsonl` file to write test results to

Example: `./bin/complement "../complement" "logs.jsonl" "results.jsonl"`
make complement (mostly) work again Well, kinda. It crashed on me after 10 minutes because the tests timed out like in <https://github.com/matrix-org/complement/issues/394>. Sounds like this means it's a them problem though. I want to use Nix to build this image instead in the future but this will at least make it work for now and give me a reference for while I'm porting it. I also want to make Conduit natively understand Complement's requirements instead of `sed`ing a bunch of stuff and needing a reverse proxy in the container. Should be more reliable that way. I'm not making this run in CI until the above stuff is addressed and until I can decide on a way to pin the revision of Complement being tested against. from: https://gitlab.com/famedly/conduit/-/merge_requests/575 Signed-off-by: strawberry <strawberry@puppygock.gay> 2024-01-28 18:53:27 -05:00			`# Complement`
add little readme 2023-01-26 18:28:33 +01:00
make complement (mostly) work again Well, kinda. It crashed on me after 10 minutes because the tests timed out like in <https://github.com/matrix-org/complement/issues/394>. Sounds like this means it's a them problem though. I want to use Nix to build this image instead in the future but this will at least make it work for now and give me a reference for while I'm porting it. I also want to make Conduit natively understand Complement's requirements instead of `sed`ing a bunch of stuff and needing a reverse proxy in the container. Should be more reliable that way. I'm not making this run in CI until the above stuff is addressed and until I can decide on a way to pin the revision of Complement being tested against. from: https://gitlab.com/famedly/conduit/-/merge_requests/575 Signed-off-by: strawberry <strawberry@puppygock.gay> 2024-01-28 18:53:27 -05:00			`## What's that?`
add little readme 2023-01-26 18:28:33 +01:00
make complement (mostly) work again Well, kinda. It crashed on me after 10 minutes because the tests timed out like in <https://github.com/matrix-org/complement/issues/394>. Sounds like this means it's a them problem though. I want to use Nix to build this image instead in the future but this will at least make it work for now and give me a reference for while I'm porting it. I also want to make Conduit natively understand Complement's requirements instead of `sed`ing a bunch of stuff and needing a reverse proxy in the container. Should be more reliable that way. I'm not making this run in CI until the above stuff is addressed and until I can decide on a way to pin the revision of Complement being tested against. from: https://gitlab.com/famedly/conduit/-/merge_requests/575 Signed-off-by: strawberry <strawberry@puppygock.gay> 2024-01-28 18:53:27 -05:00			`Have a look at [its repository](https://github.com/matrix-org/complement).`
add little readme 2023-01-26 18:28:33 +01:00
make complement (mostly) work again Well, kinda. It crashed on me after 10 minutes because the tests timed out like in <https://github.com/matrix-org/complement/issues/394>. Sounds like this means it's a them problem though. I want to use Nix to build this image instead in the future but this will at least make it work for now and give me a reference for while I'm porting it. I also want to make Conduit natively understand Complement's requirements instead of `sed`ing a bunch of stuff and needing a reverse proxy in the container. Should be more reliable that way. I'm not making this run in CI until the above stuff is addressed and until I can decide on a way to pin the revision of Complement being tested against. from: https://gitlab.com/famedly/conduit/-/merge_requests/575 Signed-off-by: strawberry <strawberry@puppygock.gay> 2024-01-28 18:53:27 -05:00			`## How do I use it with Conduit?`
add little readme 2023-01-26 18:28:33 +01:00
make complement (mostly) work again Well, kinda. It crashed on me after 10 minutes because the tests timed out like in <https://github.com/matrix-org/complement/issues/394>. Sounds like this means it's a them problem though. I want to use Nix to build this image instead in the future but this will at least make it work for now and give me a reference for while I'm porting it. I also want to make Conduit natively understand Complement's requirements instead of `sed`ing a bunch of stuff and needing a reverse proxy in the container. Should be more reliable that way. I'm not making this run in CI until the above stuff is addressed and until I can decide on a way to pin the revision of Complement being tested against. from: https://gitlab.com/famedly/conduit/-/merge_requests/575 Signed-off-by: strawberry <strawberry@puppygock.gay> 2024-01-28 18:53:27 -05:00			The script at [`../bin/complement`](../bin/complement) has automation for this.
document commandline args for complement Signed-off-by: strawberry <strawberry@puppygock.gay> 2024-04-13 20:35:32 -04:00			`It takes a few command line arguments:`
add little readme 2023-01-26 18:28:33 +01:00
document commandline args for complement Signed-off-by: strawberry <strawberry@puppygock.gay> 2024-04-13 20:35:32 -04:00			`- Path to Complement's source code`
			- A `.jsonl` file to write test logs to
			- A `.jsonl` file to write test results to

			Example: `./bin/complement "../complement" "logs.jsonl" "results.jsonl"`