tests: Introduce a way to disable options when running in tests (#1095)

In our basic template we used to provide a check based on
`mkTestDerivationFromNvim`. The issue with this check (that is handled
correctly internally) is that some plugins _can't_ be used in the test
environment, for example image.nvim like in #1085.

This commit introduces a new function to generate such checks,
`mkTestDerivationFromNixvimModule`, that wraps a nixvim configuration
instead of a built nvim instance.

Then a configuration can rely on the newly added
`helpers.enableExceptInTests` attribute to disable parts of the
configuration depending if it is evaluated in tests or in a real final
configuration.

Resolves #1085
This commit is contained in:
traxys 2024-02-15 14:27:45 +01:00 committed by GitHub
parent 0cef34c889
commit 6d7e429537
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
15 changed files with 92 additions and 20 deletions

View file

@ -1,6 +1,7 @@
{
pkgs,
makeNixvim,
makeNixvimWithModule,
}: let
# Create a nix derivation from a nixvim executable.
# The build phase simply consists in running the provided nvim binary.
@ -40,6 +41,21 @@
'';
};
mkTestDerivationFromNixvimModule = {
name ? "nixvim-check",
pkgs,
module,
extraSpecialArgs ? {},
}: let
nvim = makeNixvimWithModule {
inherit pkgs module extraSpecialArgs;
_nixvimTests = true;
};
in
mkTestDerivationFromNvim {
inherit name nvim;
};
# Create a nix derivation from a nixvim configuration.
# The build phase simply consists in running neovim with the given configuration.
mkTestDerivation = name: config: let
@ -56,5 +72,5 @@
inherit (testAttributes) dontRun;
};
in {
inherit mkTestDerivation mkTestDerivationFromNvim;
inherit mkTestDerivation mkTestDerivationFromNvim mkTestDerivationFromNixvimModule;
}