mirror of
https://github.com/NixOS/nixpkgs.git
synced 2025-06-10 03:23:29 +03:00
61 lines
884 B
Markdown
61 lines
884 B
Markdown
![]() |
|
||
|
# `redisTestHook` {#sec-redisTestHook}
|
||
|
|
||
|
This hook starts a Redis server during `checkPhase`. Example:
|
||
|
|
||
|
```nix
|
||
|
{
|
||
|
stdenv,
|
||
|
redis,
|
||
|
redisTestHook
|
||
|
}:
|
||
|
stdenv.mkDerivation {
|
||
|
|
||
|
# ...
|
||
|
|
||
|
nativeCheckInputs = [
|
||
|
redisTestHook
|
||
|
];
|
||
|
}
|
||
|
```
|
||
|
|
||
|
If you use a custom `checkPhase`, remember to add the `runHook` calls:
|
||
|
```nix
|
||
|
checkPhase ''
|
||
|
runHook preCheck
|
||
|
|
||
|
# ... your tests
|
||
|
|
||
|
runHook postCheck
|
||
|
''
|
||
|
```
|
||
|
|
||
|
## Variables {#sec-redisTestHook-variables}
|
||
|
|
||
|
The hook logic will read the following variables and set them to a default value if unset or empty.
|
||
|
|
||
|
Exported variables:
|
||
|
|
||
|
- `REDIS_SOCKET`: UNIX domain socket path
|
||
|
|
||
|
Bash-only variables:
|
||
|
|
||
|
- `redisTestPort`: Port to use by Redis. Defaults to `6379`
|
||
|
|
||
|
Example usage:
|
||
|
|
||
|
```nix
|
||
|
{ stdenv, redis, redisTestHook }:
|
||
|
stdenv.mkDerivation {
|
||
|
|
||
|
# ...
|
||
|
|
||
|
nativeCheckInputs = [
|
||
|
redisTestHook
|
||
|
];
|
||
|
|
||
|
preCheck = ''
|
||
|
redisTestPort=6390
|
||
|
''
|
||
|
}
|