conduwuit/docs/development/testing.md

# 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, you can:

* Run `./bin/complement "$COMPLEMENT_SRC" ./path/to/logs.jsonl
./path/to/results.jsonl` 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]

[ci-workflows]: https://github.com/girlbossceo/conduwuit/actions/workflows/ci.yml?query=event%3Apush+is%3Asuccess+actor%3Agirlbossceo
[complement]: https://github.com/matrix-org/complement
use `lib.makeScope` and files to organize packages Some of the improvements here include: * rocksdb can actually use jemalloc now instead of just pulling in a second rocksdb for no reason * "complement-runtime" factored back out into shell file * complement image no longer uses `mkDerivation` for `copyToRoot` because that's what `buildEnv` is for * complement image no longer sets `SERVER_NAME`, complement already does that * all packages were factored out into `callPackage`-able files for use with a custom `lib.makeScope pkgs.newScope` * new version of `mkPackage` has options that are easier to use and override such as `features` 2024-04-21 22:28:35 +00:00			`# Testing`

			`## Complement`

			`Have a look at [Complement's repository][complement] for an explanation of what`
			`it is.`

docs: ignore development.md and contributing.md from lychee and update 2 other nix references Signed-off-by: strawberry <strawberry@puppygock.gay> Signed-off-by: morguldir <morguldir@protonmail.com> 2024-09-08 14:24:38 +00:00			`To test against Complement, with Nix (or [Lix](https://lix.systems) and direnv installed`
			`and set up, you can:`
use `lib.makeScope` and files to organize packages Some of the improvements here include: * rocksdb can actually use jemalloc now instead of just pulling in a second rocksdb for no reason * "complement-runtime" factored back out into shell file * complement image no longer uses `mkDerivation` for `copyToRoot` because that's what `buildEnv` is for * complement image no longer sets `SERVER_NAME`, complement already does that * all packages were factored out into `callPackage`-able files for use with a custom `lib.makeScope pkgs.newScope` * new version of `mkPackage` has options that are easier to use and override such as `features` 2024-04-21 22:28:35 +00:00
reformat: make markdown files wrap at 80 chars 2024-08-24 03:13:43 +00:00			* Run `./bin/complement "$COMPLEMENT_SRC" ./path/to/logs.jsonl
			./path/to/results.jsonl` 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`
use `lib.makeScope` and files to organize packages Some of the improvements here include: * rocksdb can actually use jemalloc now instead of just pulling in a second rocksdb for no reason * "complement-runtime" factored back out into shell file * complement image no longer uses `mkDerivation` for `copyToRoot` because that's what `buildEnv` is for * complement image no longer sets `SERVER_NAME`, complement already does that * all packages were factored out into `callPackage`-able files for use with a custom `lib.makeScope pkgs.newScope` * new version of `mkPackage` has options that are easier to use and override such as `features` 2024-04-21 22:28:35 +00:00			* Run `nix build .#complement` from the root of the repository to just build a
reformat: make markdown files wrap at 80 chars 2024-08-24 03:13:43 +00:00			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]`
use `lib.makeScope` and files to organize packages Some of the improvements here include: * rocksdb can actually use jemalloc now instead of just pulling in a second rocksdb for no reason * "complement-runtime" factored back out into shell file * complement image no longer uses `mkDerivation` for `copyToRoot` because that's what `buildEnv` is for * complement image no longer sets `SERVER_NAME`, complement already does that * all packages were factored out into `callPackage`-able files for use with a custom `lib.makeScope pkgs.newScope` * new version of `mkPackage` has options that are easier to use and override such as `features` 2024-04-21 22:28:35 +00:00
upload complement OCI image from CI, document where it can be found, use `main` instead of `dev` for tag Signed-off-by: strawberry <strawberry@puppygock.gay> 2024-05-12 04:22:10 +00:00			`[ci-workflows]: https://github.com/girlbossceo/conduwuit/actions/workflows/ci.yml?query=event%3Apush+is%3Asuccess+actor%3Agirlbossceo`
use `lib.makeScope` and files to organize packages Some of the improvements here include: * rocksdb can actually use jemalloc now instead of just pulling in a second rocksdb for no reason * "complement-runtime" factored back out into shell file * complement image no longer uses `mkDerivation` for `copyToRoot` because that's what `buildEnv` is for * complement image no longer sets `SERVER_NAME`, complement already does that * all packages were factored out into `callPackage`-able files for use with a custom `lib.makeScope pkgs.newScope` * new version of `mkPackage` has options that are easier to use and override such as `features` 2024-04-21 22:28:35 +00:00			`[complement]: https://github.com/matrix-org/complement`