nix-unit

Run nix-unit tests in checks.

See also the complete example / template.

Installation

To use these options, add to your flake inputs:

nix-unit.url = "github:nix-community/nix-unit";

and inside the mkFlake:

imports = [
  inputs.nix-unit.modules.flake.default
];

Run nix flake lock and you're set.

Options

flake.tests

A nix-unit test suite; as introduced in the manual.

Type: lazy attribute set of raw value

Default: { }

Example:

{
  "test integer equality is reflexive" = {
    expr = "123";
    expected = "123";
  };
  "frobnicator" = {
    "testFoo" = {
      expr = "foo";
      expected = "foo";
    };
  }
}

Declared by:

• nix-unit/lib/modules/flake/tests-output.nix

perSystem.nix-unit.enableSystemAgnostic

Copy system-agnostic tests from the flake.tests attribute into this system’s tests.

This ensures that the tests that are not defined in the system-specific tests are still run in nix flake check.

Type: boolean

Default: true

Declared by:

• nix-unit/lib/modules/flake/system-agnostic.nix

perSystem.nix-unit.package

The nix-unit package to use.

Type: package

Default: package from the nix-unit flake, using that flake’s inputs.nixpkgs (except for follows, etc)

Declared by:

• nix-unit/lib/modules/flake/system.nix
• [nix-unit/lib/modules.nix, via option flake.modules.flake.default](https://github.com/nix-community/nix-unit/blob/main/lib/modules.nix, via option flake.modules.flake.default)

perSystem.nix-unit.allowNetwork

Whether to allow network access in the nix-unit tests. This is useful for tests that depend on fetched sources, as is often the case with flake inputs. nix-unit.inputs may also be a solution, and tends to perform better. Both solutions can be combined.

Type: boolean

Default: false

Declared by:

• nix-unit/lib/modules/flake/system.nix

perSystem.nix-unit.inputs

Input overrides to pass to nix-unit.

Since nix-unit will be invoked in the nix sandbox, any flake inputs that are required for the tests must be passed here.

This prevents the need to download these inputs for each run.

Type: attribute set of path

Default: { }

Example:

{
  inherit (inputs) nixpkgs flake-parts;
}

Declared by:

• nix-unit/lib/modules/flake/system.nix

perSystem.nix-unit.tests

A nix-unit test suite; as introduced in the manual.

Type: lazy attribute set of raw value

Default: { }

Example:

{
  "test integer equality is reflexive" = {
    expr = "123";
    expected = "123";
  };
  "frobnicator" = {
    "testFoo" = {
      expr = "foo";
      expected = "foo";
    };
  }
}

Declared by:

• nix-unit/lib/modules/flake/system.nix