pkgs/applications/editors/neovim/tests/default.nix

   1 /*
   2 run tests with `nix-build -A neovim.tests`
   3
   4 The attrset exposes both the wrapped neovim and the associated test for easier debugging
   5
   6 Here are some common neovim flags used in the tests:
   7 -e runs neovim in `:h Ex-mode` which returns an exit code != 0 when hitting an error
   8 -i NONE  gets rid of shada warnings
   9
  10 */
  11 { vimUtils, writeText, neovim, vimPlugins
  12 , neovimUtils, wrapNeovimUnstable
  13 , neovim-unwrapped
  14 , fetchFromGitLab
  15 , runCommandLocal
  16 , pkgs
  17 }:
  18 let
  19   inherit (neovimUtils) makeNeovimConfig;
  20
  21   plugins = with vimPlugins; [
  22     {
  23       plugin = vim-obsession;
  24       config = ''
  25         map <Leader>$ <Cmd>Obsession<CR>
  26       '';
  27     }
  28   ];
  29
  30   packagesWithSingleLineConfigs = with vimPlugins; [
  31     {
  32       plugin = vim-obsession;
  33       config = ''map <Leader>$ <Cmd>Obsession<CR>'';
  34     }
  35     {
  36       plugin = trouble-nvim;
  37       config = ''" placeholder config'';
  38     }
  39   ];
  40
  41   nvimConfSingleLines = makeNeovimConfig {
  42     plugins = packagesWithSingleLineConfigs;
  43     customRC = ''
  44       " just a comment
  45     '';
  46   };
  47
  48   nvimConfNix = makeNeovimConfig {
  49     inherit plugins;
  50     customRC = ''
  51       " just a comment
  52     '';
  53   };
  54
  55   nvim-with-luasnip = wrapNeovim2 "-with-luasnip" (makeNeovimConfig {
  56     plugins = [ {
  57         plugin = vimPlugins.luasnip;
  58       }
  59     ];
  60   });
  61
  62   # build should fail with a wrong
  63   nvim-run-failing-check = (wrapNeovimUnstable neovim-unwrapped {
  64     luaRcContent = "this is an invalid lua statement to break the build";
  65   }).overrideAttrs({
  66     doCheck = true;
  67   });
  68
  69   nvimAutoDisableWrap = makeNeovimConfig { };
  70
  71   wrapNeovim2 = suffix: config:
  72     wrapNeovimUnstable neovim-unwrapped (config // {
  73       extraName = suffix;
  74     });
  75
  76   nmt = fetchFromGitLab {
  77     owner = "rycee";
  78     repo = "nmt";
  79     rev = "d2cc8c1042b1c2511f68f40e2790a8c0e29eeb42";
  80     sha256 = "1ykcvyx82nhdq167kbnpgwkgjib8ii7c92y3427v986n2s5lsskc";
  81   };
  82
  83   /* neovim-drv must be a wrapped neovim
  84     - exposes lua config in $luarcGeneric
  85     - exposes vim config in $vimrcGeneric
  86
  87   */
  88
  89   runTest = neovim-drv: buildCommand:
  90     runCommandLocal "test-${neovim-drv.name}" ({
  91       nativeBuildInputs = [ ];
  92       meta.platforms = neovim-drv.meta.platforms;
  93     }) (''
  94       source ${nmt}/bash-lib/assertions.sh
  95       vimrc="${writeText "test-${neovim-drv.name}-init.vim" neovim-drv.initRc}"
  96       luarc="${writeText "test-${neovim-drv.name}-init.lua" neovim-drv.luaRcContent}"
  97       luarcGeneric="$out/patched.lua"
  98       vimrcGeneric="$out/patched.vim"
  99       mkdir $out
 100       export HOME=$TMPDIR
 101       ${pkgs.perl}/bin/perl -pe "s|\Q$NIX_STORE\E/[a-z0-9]{32}-|$NIX_STORE/eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee-|g" < "$vimrc" > "$vimrcGeneric"
 102       ${pkgs.perl}/bin/perl -pe "s|\Q$NIX_STORE\E/[a-z0-9]{32}-|$NIX_STORE/eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee-|g" < "$luarc" > "$luarcGeneric"
 103     '' + buildCommand);
 104
 105 in
 106   pkgs.recurseIntoAttrs (rec {
 107
 108   inherit nmt;
 109
 110   # Disabled because of https://github.com/NixOS/nixpkgs/pull/352727
 111   # failed_check = pkgs.testers.testBuildFailure nvim-run-failing-check;
 112
 113   vim_empty_config = vimUtils.vimrcFile { beforePlugins = ""; customRC = ""; };
 114
 115   ### neovim tests
 116   ##################
 117   nvim_with_plugins = wrapNeovim2 "-with-plugins" nvimConfNix;
 118   nvim_singlelines = wrapNeovim2 "-single-lines" nvimConfSingleLines;
 119
 120   # test that passthru.initRc hasn't changed
 121   passthruInitRc = runTest nvim_singlelines ''
 122     INITRC=${pkgs.writeTextFile { name = "initrc"; text = nvim_singlelines.passthru.initRc; }}
 123     assertFileContent \
 124       $INITRC \
 125       "${./init-single-lines.vim}"
 126   '';
 127
 128   # test single line concatenation
 129   singlelinesconfig = runTest nvim_singlelines ''
 130       assertFileContains \
 131         "$luarcGeneric" \
 132         "vim.cmd.source \"/nix/store/eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee-init.vim"
 133       assertFileContent \
 134         "$vimrcGeneric" \
 135         "${./init-single-lines.vim}"
 136   '';
 137
 138   nvim_via_override = neovim.override {
 139     extraName = "-via-override";
 140     configure = {
 141       packages.foo.start = [ vimPlugins.ale ];
 142       customRC = ''
 143         :help ale
 144       '';
 145     };
 146   };
 147
 148   nvim_with_aliases = neovim.override {
 149     extraName = "-with-aliases";
 150     vimAlias = true;
 151     viAlias = true;
 152   };
 153
 154   # test it still works with vim-plug
 155   nvim_with_plug = neovim.override {
 156     extraName = "-with-plug";
 157     configure.packages.plugins = with pkgs.vimPlugins; {
 158       start = [
 159         (base16-vim.overrideAttrs(old: { pname = old.pname + "-unique-for-tests-please-dont-use"; }))
 160       ];
 161     };
 162     configure.customRC = ''
 163       color base16-tomorrow-night
 164       set background=dark
 165     '';
 166   };
 167
 168   run_nvim_with_plug = runTest nvim_with_plug ''
 169     ${nvim_with_plug}/bin/nvim -V3log.txt -i NONE -c 'color base16-tomorrow-night'  +quit! -e
 170   '';
 171
 172   nvim_with_autoconfigure = pkgs.neovim.overrideAttrs(oa: {
 173     plugins = [ vimPlugins.unicode-vim ];
 174     autoconfigure = true;
 175     # legacy wrapper sets it to false
 176     wrapRc = true;
 177   });
 178
 179   nvim_with_ftplugin = let
 180     # this plugin checks that it's ftplugin/vim.tex is loaded before $VIMRUNTIME/ftplugin/vim.tex
 181     # $VIMRUNTIME/ftplugin/vim.tex sources $VIMRUNTIME/ftplugin/initex.vim which sets b:did_ftplugin
 182     # we save b:did_ftplugin's value in a `plugin_was_loaded_too_late` file
 183     texFtplugin = (pkgs.runCommandLocal "tex-ftplugin" {} ''
 184       mkdir -p $out/ftplugin
 185       echo 'call system("echo ". exists("b:did_ftplugin") . " > plugin_was_loaded_too_late")' >> $out/ftplugin/tex.vim
 186       echo ':q!' >> $out/ftplugin/tex.vim
 187     '') // { pname = "test-ftplugin"; };
 188     in
 189
 190     neovim.override {
 191     extraName = "-with-ftplugin";
 192     configure.packages.plugins = {
 193       start = [
 194         texFtplugin
 195       ];
 196     };
 197   };
 198
 199   # regression test that ftplugin files from plugins are loaded before the ftplugin
 200   # files from $VIMRUNTIME
 201   run_nvim_with_ftplugin = runTest nvim_with_ftplugin ''
 202     echo '\documentclass{article}' > main.tex
 203
 204     ${nvim_with_ftplugin}/bin/nvim -i NONE -V3log.txt main.tex -c "set ft?" -c quit
 205     ls -l $TMPDIR
 206     # check the saved value b:did_ftplugin then our plugin has been loaded instead of neovim's
 207     result="$(cat plugin_was_loaded_too_late)"
 208     echo $result
 209     [ "$result" = 0 ]
 210   '';
 211
 212
 213   # check that the vim-doc hook correctly generates the tag
 214   # we know for a fact packer has a doc folder
 215   checkForTags = vimPlugins.packer-nvim.overrideAttrs(oldAttrs: {
 216     doInstallCheck = true;
 217     installCheckPhase = ''
 218       [ -f $out/doc/tags ]
 219     '';
 220   });
 221
 222   # check that the vim-doc hook correctly generates the tag
 223   # for neovim packages from luaPackages
 224   # we know for a fact gitsigns-nvim has a doc folder and comes from luaPackages
 225   checkForTagsLuaPackages = vimPlugins.gitsigns-nvim.overrideAttrs(oldAttrs: {
 226     doInstallCheck = true;
 227     installCheckPhase = ''
 228       [ -f $out/doc/tags ]
 229     '';
 230   });
 231
 232   nvim_with_gitsigns_plugin = neovim.override {
 233     extraName = "-with-gitsigns-plugin";
 234     configure.packages.plugins = {
 235       start = [
 236         vimPlugins.gitsigns-nvim
 237       ];
 238     };
 239   };
 240
 241   checkHelpLuaPackages = runTest nvim_with_gitsigns_plugin ''
 242     ${nvim_with_gitsigns_plugin}/bin/nvim -i NONE -c 'help gitsigns' +quitall! -e
 243   '';
 244
 245   # nixpkgs should detect that no wrapping is necessary
 246   nvimShouldntWrap = wrapNeovim2 "-should-not-wrap" nvimAutoDisableWrap;
 247
 248   # this will generate a neovimRc content but we disable wrapping
 249   nvimDontWrap = wrapNeovim2 "-forced-nowrap" (makeNeovimConfig {
 250     wrapRc = false;
 251     customRC = ''
 252       " this shouldn't trigger the creation of an init.vim
 253     '';
 254   });
 255
 256   force-nowrap = runTest nvimDontWrap ''
 257       ! grep -F -- ' -u' ${nvimDontWrap}/bin/nvim
 258   '';
 259
 260   nvim_via_override-test = runTest nvim_via_override ''
 261       assertFileContent \
 262         "$vimrcGeneric" \
 263         "${./init-override.vim}"
 264   '';
 265
 266
 267   checkAliases = runTest nvim_with_aliases ''
 268       folder=${nvim_with_aliases}/bin
 269       assertFileIsExecutable "$folder/vi"
 270       assertFileIsExecutable "$folder/vim"
 271   '';
 272
 273   # having no RC generated should autodisable init.vim wrapping
 274   nvim_autowrap = runTest nvim_via_override ''
 275       ! grep ${nvimShouldntWrap}/bin/nvim
 276   '';
 277
 278
 279   # system remote plugin manifest should be generated, deoplete should be usable
 280   # without the user having to do `UpdateRemotePlugins`. To test, launch neovim
 281   # and do `:call deoplete#enable()`. It will print an error if the remote
 282   # plugin is not registered.
 283   test_nvim_with_remote_plugin = neovim.override {
 284     extraName = "-remote";
 285     configure.packages.foo.start = with vimPlugins; [ deoplete-nvim ];
 286   };
 287
 288   nvimWithLuaPackages = wrapNeovim2 "-with-lua-packages" (makeNeovimConfig {
 289     extraLuaPackages = ps: [ps.mpack];
 290     customRC = ''
 291       lua require("mpack")
 292     '';
 293   });
 294
 295   nvim_with_lua_packages = runTest nvimWithLuaPackages ''
 296     ${nvimWithLuaPackages}/bin/nvim -V3log.txt -i NONE --noplugin +quitall! -e
 297   '';
 298
 299   # nixpkgs should install optional packages in the opt folder
 300   nvim_with_opt_plugin = neovim.override {
 301     extraName = "-with-opt-plugin";
 302     configure.packages.opt-plugins = with pkgs.vimPlugins; {
 303       opt = [
 304         (dashboard-nvim.overrideAttrs(old: { pname = old.pname + "-unique-for-tests-please-dont-use-opt"; }))
 305       ];
 306     };
 307     configure.customRC = ''
 308       " Load all autoloaded plugins
 309       packloadall
 310
 311       " Try to run Dashboard, and throw if it succeeds
 312       try
 313         Dashboard
 314         echo "Dashboard found, throwing error"
 315         cquit 1
 316       catch /^Vim\%((\a\+)\)\=:E492/
 317         echo "Dashboard not found"
 318       endtry
 319
 320       " Load Dashboard as an optional
 321       packadd dashboard-nvim-unique-for-tests-please-dont-use-opt
 322
 323       " Try to run Dashboard again, and throw if it fails
 324       let res = exists(':Dashboard')
 325       if res == 0
 326         echo "Dashboard not found, throwing error"
 327         cquit 1
 328       endif
 329       cquit 0
 330     '';
 331   };
 332
 333   run_nvim_with_opt_plugin = runTest nvim_with_opt_plugin ''
 334     ${nvim_with_opt_plugin}/bin/nvim -i NONE +quit! -e
 335   '';
 336
 337   inherit nvim-with-luasnip;
 338
 339   autoconfigure = runTest nvim_with_autoconfigure ''
 340       assertFileContains \
 341         "$luarc" \
 342         '${vimPlugins.unicode-vim.passthru.initLua}'
 343   '';
 344
 345   # check that bringing in one plugin with lua deps makes those deps visible from wrapper
 346   # for instance luasnip has a dependency on jsregexp
 347   can_require_transitive_deps =
 348     runTest nvim-with-luasnip ''
 349     cat ${nvim-with-luasnip}/bin/nvim
 350     ${nvim-with-luasnip}/bin/nvim -i NONE --cmd "lua require'jsregexp'" -e +quitall!
 351   '';
 352
 353 })