nixpkgs/doc/hooks/redis-test-hook.section.md

redisTestHook

This hook starts a Redis server during checkPhase. Example:

{
  stdenv,
  redis,
  redisTestHook,
}:
stdenv.mkDerivation {

  # ...

  nativeCheckInputs = [
    redisTestHook
  ];
}

If you use a custom checkPhase, remember to add the runHook calls:

{
  checkPhase = ''
    runHook preCheck

    # ... your tests

    runHook postCheck
  '';
}

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:

{
  stdenv,
  redis,
  redisTestHook,
}:
stdenv.mkDerivation {

  # ...

  nativeCheckInputs = [
    redisTestHook
  ];

  preCheck = ''
    redisTestPort=6390;
  '';
}