continuwuity/docs/development/testing.md
Jade Ellis beee996f72
Some checks failed
Release Docker Image / define-variables (pull_request) Successful in 1s
Documentation / Build and Deploy Documentation (pull_request) Successful in 35s
Release Docker Image / build-image (linux/arm64, linux-arm64) (pull_request) Successful in 17m16s
Release Docker Image / build-image (linux/amd64, linux-amd64) (pull_request) Failing after 1h32m49s
Release Docker Image / merge (pull_request) Has been cancelled
Release Docker Image / define-variables (push) Successful in 12s
Documentation / Build and Deploy Documentation (push) Successful in 58s
Release Docker Image / build-image (linux/arm64, linux-arm64) (push) Successful in 19m7s
Release Docker Image / build-image (linux/amd64, linux-amd64) (push) Successful in 1h37m14s
Release Docker Image / merge (push) Successful in 21s
docs: Rename conduwuit to continuwuity in more places
2025-05-10 20:37:08 +01:00

32 lines
1.4 KiB
Markdown

# Testing
## Complement
Have a look at [Complement's repository][complement] for an explanation of what
it is.
To test against Complement, with Nix (or [Lix](https://lix.systems) and
[direnv installed and set up][direnv] (run `direnv allow` after setting up the hook), you can:
* Run `./bin/complement "$COMPLEMENT_SRC"` to build a Complement image, run
the tests, and output the logs and results to the specified paths. This will also output the OCI image
at `result`
* Run `nix build .#complement` from the root of the repository to just build a
Complement OCI image outputted to `result` (it's a `.tar.gz` file)
* Or download the latest Complement OCI image from the CI workflow artifacts
output from the commit/revision you want to test (e.g. from main)
[here][ci-workflows]
If you want to use your own prebuilt OCI image (such as from our CI) without needing
Nix installed, put the image at `complement_oci_image.tar.gz` in the root of the repo
and run the script.
If you're on macOS and need to build an image, run `nix build .#linux-complement`.
We have a Complement fork as some tests have needed to be fixed. This can be found
at: <https://forgejo.ellis.link/continuwuation/complement>
[ci-workflows]:
https://forgejo.ellis.link/continuwuation/continuwuity/actions/?workflow=ci.yml&actor=0&status=1
[complement]: https://github.com/matrix-org/complement
[direnv]: https://direnv.net/docs/hook.html