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   runTest = neovim-drv: buildCommand:
  85     runCommandLocal "test-${neovim-drv.name}" ({
  86       nativeBuildInputs = [ ];
  87       meta.platforms = neovim-drv.meta.platforms;
  88     }) (''
  89       source ${nmt}/bash-lib/assertions.sh
  90       vimrc="${writeText "test-${neovim-drv.name}-init.vim" neovim-drv.initRc}"
  91       luarc="${writeText "test-${neovim-drv.name}-init.lua" neovim-drv.luaRcContent}"
  92       luarcGeneric="$out/patched.lua"
  93       vimrcGeneric="$out/patched.vim"
  94       mkdir $out
  95       export HOME=$TMPDIR
  96       ${pkgs.perl}/bin/perl -pe "s|\Q$NIX_STORE\E/[a-z0-9]{32}-|$NIX_STORE/eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee-|g" < "$vimrc" > "$vimrcGeneric"
  97       ${pkgs.perl}/bin/perl -pe "s|\Q$NIX_STORE\E/[a-z0-9]{32}-|$NIX_STORE/eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee-|g" < "$luarc" > "$luarcGeneric"
  98     '' + buildCommand);
  99
 100 in
 101   pkgs.recurseIntoAttrs (rec {
 102
 103   inherit nmt;
 104
 105   # Disabled because of https://github.com/NixOS/nixpkgs/pull/352727
 106   # failed_check = pkgs.testers.testBuildFailure nvim-run-failing-check;
 107
 108   vim_empty_config = vimUtils.vimrcFile { beforePlugins = ""; customRC = ""; };
 109
 110   ### neovim tests
 111   ##################
 112   nvim_with_plugins = wrapNeovim2 "-with-plugins" nvimConfNix;
 113   nvim_singlelines = wrapNeovim2 "-single-lines" nvimConfSingleLines;
 114
 115   # test that passthru.initRc hasn't changed
 116   passthruInitRc = runTest nvim_singlelines ''
 117     INITRC=${pkgs.writeTextFile { name = "initrc"; text = nvim_singlelines.passthru.initRc; }}
 118     assertFileContent \
 119       $INITRC \
 120       "${./init-single-lines.vim}"
 121   '';
 122
 123   # test single line concatenation
 124   singlelinesconfig = runTest nvim_singlelines ''
 125       assertFileContains \
 126         "$luarcGeneric" \
 127         "vim.cmd.source \"/nix/store/eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee-init.vim"
 128       assertFileContent \
 129         "$vimrcGeneric" \
 130         "${./init-single-lines.vim}"
 131   '';
 132
 133   nvim_via_override = neovim.override {
 134     extraName = "-via-override";
 135     configure = {
 136       packages.foo.start = [ vimPlugins.ale ];
 137       customRC = ''
 138         :help ale
 139       '';
 140     };
 141   };
 142
 143   nvim_with_aliases = neovim.override {
 144     extraName = "-with-aliases";
 145     vimAlias = true;
 146     viAlias = true;
 147   };
 148
 149   # test it still works with vim-plug
 150   nvim_with_plug = neovim.override {
 151     extraName = "-with-plug";
 152     configure.packages.plugins = with pkgs.vimPlugins; {
 153       start = [
 154         (base16-vim.overrideAttrs(old: { pname = old.pname + "-unique-for-tests-please-dont-use"; }))
 155       ];
 156     };
 157     configure.customRC = ''
 158       color base16-tomorrow-night
 159       set background=dark
 160     '';
 161   };
 162
 163   run_nvim_with_plug = runTest nvim_with_plug ''
 164     ${nvim_with_plug}/bin/nvim -V3log.txt -i NONE -c 'color base16-tomorrow-night'  +quit! -e
 165   '';
 166
 167   nvim_with_ftplugin = let
 168     # this plugin checks that it's ftplugin/vim.tex is loaded before $VIMRUNTIME/ftplugin/vim.tex
 169     # $VIMRUNTIME/ftplugin/vim.tex sources $VIMRUNTIME/ftplugin/initex.vim which sets b:did_ftplugin
 170     # we save b:did_ftplugin's value in a `plugin_was_loaded_too_late` file
 171     texFtplugin = (pkgs.runCommandLocal "tex-ftplugin" {} ''
 172       mkdir -p $out/ftplugin
 173       echo 'call system("echo ". exists("b:did_ftplugin") . " > plugin_was_loaded_too_late")' >> $out/ftplugin/tex.vim
 174       echo ':q!' >> $out/ftplugin/tex.vim
 175     '') // { pname = "test-ftplugin"; };
 176     in
 177
 178     neovim.override {
 179     extraName = "-with-ftplugin";
 180     configure.packages.plugins = {
 181       start = [
 182         texFtplugin
 183       ];
 184     };
 185   };
 186
 187   # regression test that ftplugin files from plugins are loaded before the ftplugin
 188   # files from $VIMRUNTIME
 189   run_nvim_with_ftplugin = runTest nvim_with_ftplugin ''
 190     echo '\documentclass{article}' > main.tex
 191
 192     ${nvim_with_ftplugin}/bin/nvim -i NONE -V3log.txt main.tex -c "set ft?" -c quit
 193     ls -l $TMPDIR
 194     # check the saved value b:did_ftplugin then our plugin has been loaded instead of neovim's
 195     result="$(cat plugin_was_loaded_too_late)"
 196     echo $result
 197     [ "$result" = 0 ]
 198   '';
 199
 200
 201   # check that the vim-doc hook correctly generates the tag
 202   # we know for a fact packer has a doc folder
 203   checkForTags = vimPlugins.packer-nvim.overrideAttrs(oldAttrs: {
 204     doInstallCheck = true;
 205     installCheckPhase = ''
 206       [ -f $out/doc/tags ]
 207     '';
 208   });
 209
 210   # check that the vim-doc hook correctly generates the tag
 211   # for neovim packages from luaPackages
 212   # we know for a fact gitsigns-nvim has a doc folder and comes from luaPackages
 213   checkForTagsLuaPackages = vimPlugins.gitsigns-nvim.overrideAttrs(oldAttrs: {
 214     doInstallCheck = true;
 215     installCheckPhase = ''
 216       [ -f $out/doc/tags ]
 217     '';
 218   });
 219
 220   nvim_with_gitsigns_plugin = neovim.override {
 221     extraName = "-with-gitsigns-plugin";
 222     configure.packages.plugins = {
 223       start = [
 224         vimPlugins.gitsigns-nvim
 225       ];
 226     };
 227   };
 228
 229   checkHelpLuaPackages = runTest nvim_with_gitsigns_plugin ''
 230     ${nvim_with_gitsigns_plugin}/bin/nvim -i NONE -c 'help gitsigns' +quitall! -e
 231   '';
 232
 233   # nixpkgs should detect that no wrapping is necessary
 234   nvimShouldntWrap = wrapNeovim2 "-should-not-wrap" nvimAutoDisableWrap;
 235
 236   # this will generate a neovimRc content but we disable wrapping
 237   nvimDontWrap = wrapNeovim2 "-forced-nowrap" (makeNeovimConfig {
 238     wrapRc = false;
 239     customRC = ''
 240       " this shouldn't trigger the creation of an init.vim
 241     '';
 242   });
 243
 244   force-nowrap = runTest nvimDontWrap ''
 245       ! grep -F -- ' -u' ${nvimDontWrap}/bin/nvim
 246   '';
 247
 248   nvim_via_override-test = runTest nvim_via_override ''
 249       assertFileContent \
 250         "$vimrcGeneric" \
 251         "${./init-override.vim}"
 252   '';
 253
 254
 255   checkAliases = runTest nvim_with_aliases ''
 256       folder=${nvim_with_aliases}/bin
 257       assertFileIsExecutable "$folder/vi"
 258       assertFileIsExecutable "$folder/vim"
 259   '';
 260
 261   # having no RC generated should autodisable init.vim wrapping
 262   nvim_autowrap = runTest nvim_via_override ''
 263       ! grep ${nvimShouldntWrap}/bin/nvim
 264   '';
 265
 266
 267   # system remote plugin manifest should be generated, deoplete should be usable
 268   # without the user having to do `UpdateRemotePlugins`. To test, launch neovim
 269   # and do `:call deoplete#enable()`. It will print an error if the remote
 270   # plugin is not registered.
 271   test_nvim_with_remote_plugin = neovim.override {
 272     extraName = "-remote";
 273     configure.packages.foo.start = with vimPlugins; [ deoplete-nvim ];
 274   };
 275
 276   nvimWithLuaPackages = wrapNeovim2 "-with-lua-packages" (makeNeovimConfig {
 277     extraLuaPackages = ps: [ps.mpack];
 278     customRC = ''
 279       lua require("mpack")
 280     '';
 281   });
 282
 283   nvim_with_lua_packages = runTest nvimWithLuaPackages ''
 284     ${nvimWithLuaPackages}/bin/nvim -V3log.txt -i NONE --noplugin +quitall! -e
 285   '';
 286
 287   # nixpkgs should install optional packages in the opt folder
 288   nvim_with_opt_plugin = neovim.override {
 289     extraName = "-with-opt-plugin";
 290     configure.packages.opt-plugins = with pkgs.vimPlugins; {
 291       opt = [
 292         (dashboard-nvim.overrideAttrs(old: { pname = old.pname + "-unique-for-tests-please-dont-use-opt"; }))
 293       ];
 294     };
 295     configure.customRC = ''
 296       " Load all autoloaded plugins
 297       packloadall
 298
 299       " Try to run Dashboard, and throw if it succeeds
 300       try
 301         Dashboard
 302         echo "Dashboard found, throwing error"
 303         cquit 1
 304       catch /^Vim\%((\a\+)\)\=:E492/
 305         echo "Dashboard not found"
 306       endtry
 307
 308       " Load Dashboard as an optional
 309       packadd dashboard-nvim-unique-for-tests-please-dont-use-opt
 310
 311       " Try to run Dashboard again, and throw if it fails
 312       let res = exists(':Dashboard')
 313       if res == 0
 314         echo "Dashboard not found, throwing error"
 315         cquit 1
 316       endif
 317       cquit 0
 318     '';
 319   };
 320
 321   run_nvim_with_opt_plugin = runTest nvim_with_opt_plugin ''
 322     ${nvim_with_opt_plugin}/bin/nvim -i NONE +quit! -e
 323   '';
 324
 325   inherit nvim-with-luasnip;
 326
 327   # check that bringing in one plugin with lua deps makes those deps visible from wrapper
 328   # for instance luasnip has a dependency on jsregexp
 329   can_require_transitive_deps =
 330     runTest nvim-with-luasnip ''
 331     cat ${nvim-with-luasnip}/bin/nvim
 332     ${nvim-with-luasnip}/bin/nvim -i NONE --cmd "lua require'jsregexp'" -e +quitall!
 333   '';
 334
 335 })