chores: update markdown expectations, regenerate ruby symbols, enable nvim-treesitter main testing (#323)

Slotos · web-flow · commit 21e335861764 · 2023-11-09T21:17:09.000-08:00
* chore: Fix markdown tests Recent update to nvim-treesitter breaks aerial.nvim tests. Specifically: - nvim-treesitter/nvim-treesitter@96f55f30433 - tree-sitter-grammars/tree-sitter-markdown@cd705f15912 Manually poking around, the behaviour remains the same * chore: Regenerate ruby symbol snapshots Prior version held a bunch of data written by hand. This commit updates it to avoid false alarms when generating symbols for new or updated queries. Expectations are not changed, only the order of keys in individual tables was updated. * chore: Option to run tests on nvim-treesitter main While nvim-treesitter is not a strict requirement for aerial.nvim, it is used to install parsers and it updates nvim default language to parser assignments with practical values. This commit adds an ability to run tests against `main` branch by providing `--test-main` option to `run_tests.sh`. * chore: Add neorg parser config to main branch Use C++14 compatible compiler when running tests with `--test-main`, otherwise parser compilation will fail.
diff --git a/run_tests.sh b/run_tests.sh
@@ -1,14 +1,26 @@
 #!/bin/bash
 set -e
 
-if [ "$1" = "--update" ]; then
+NVIM_TREESITTER_BRANCH='master'
+
+for arg in "$@"; do
   shift
-  export UPDATE_SYMBOLS=1
-  if ! command -v jq >/dev/null; then
-    echo "jq is required for --update. Please install jq"
-    exit 1
-  fi
-fi
+  case "$arg" in
+    '--update')
+      export UPDATE_SYMBOLS=1
+      if ! command -v jq >/dev/null; then
+        echo "jq is required for --update. Please install jq"
+        exit 1
+      fi
+      ;;
+    '--test-main')
+      NVIM_TREESITTER_BRANCH='main'
+      ;;
+    *)
+      set -- "$@" "$arg"
+      ;;
+  esac
+done
 
 mkdir -p ".testenv/config/nvim"
 mkdir -p ".testenv/data/nvim"
@@ -19,21 +31,20 @@ PLUGINS=".testenv/data/nvim/site/pack/plugins/start"
 
 if [ ! -e "$PLUGINS/plenary.nvim" ]; then
   git clone --depth=1 https://github.com/nvim-lua/plenary.nvim.git "$PLUGINS/plenary.nvim"
-else
-  (cd "$PLUGINS/plenary.nvim" && git pull)
 fi
 if [ ! -e "$PLUGINS/nvim-treesitter" ]; then
-  git clone --depth=1 https://github.com/nvim-treesitter/nvim-treesitter.git "$PLUGINS/nvim-treesitter"
-else
-  (cd "$PLUGINS/nvim-treesitter" && git pull)
+  git clone --depth=1 --no-single-branch https://github.com/nvim-treesitter/nvim-treesitter.git "$PLUGINS/nvim-treesitter"
 fi
 
-XDG_CONFIG_HOME=".testenv/config" \
-  XDG_DATA_HOME=".testenv/data" \
-  XDG_STATE_HOME=".testenv/state" \
-  XDG_RUNTIME_DIR=".testenv/run" \
-  XDG_CACHE_HOME=".testenv/cache" \
-  nvim --headless -u tests/minimal_init.lua \
-  -c "TSUpdateSync" \
-  -c "PlenaryBustedDirectory ${1-tests} { minimal_init = './tests/minimal_init.lua' }"
+(cd "$PLUGINS/plenary.nvim" && git pull)
+(cd "$PLUGINS/nvim-treesitter" && git checkout ${NVIM_TREESITTER_BRANCH} && git pull)
+
+export XDG_CONFIG_HOME=".testenv/config"
+export XDG_DATA_HOME=".testenv/data"
+export XDG_STATE_HOME=".testenv/state"
+export XDG_RUNTIME_DIR=".testenv/run"
+export XDG_CACHE_HOME=".testenv/cache"
+
+nvim --headless -u tests/minimal_init.lua \
+  -c "RunTests ${1-tests}"
 echo "Success"
diff --git a/tests/minimal_init.lua b/tests/minimal_init.lua
@@ -20,9 +20,52 @@ for lang, _ in vim.fs.dir("queries") do
     table.insert(langs, lang)
   end
 end
-require("nvim-treesitter.configs").setup({
-  ensure_installed = langs,
-  sync_install = true,
-})
--- this needs to be run a second time to make tests behave
-require("nvim-treesitter").setup()
+local master_nvim_ts, configs = pcall(require, "nvim-treesitter.configs")
+if master_nvim_ts then
+  configs.setup({
+    ensure_installed = langs,
+    sync_install = true,
+  })
+  -- this needs to be run a second time to make tests behave
+  require("nvim-treesitter").setup()
+
+  vim.api.nvim_create_user_command("RunTests", function(opts)
+    local path = opts.fargs[1] or "tests"
+    require("plenary.test_harness").test_directory(
+      path,
+      { minimal_init = "./tests/minimal_init.lua" }
+    )
+  end, { nargs = "?" })
+else
+  -- Use compiler that includes c++14 features by default
+  -- If `cc` doesn't implement those, override it for tests run with
+  -- `CC=gcc-13 ./run_tests.sh`
+  local parser_config = require("nvim-treesitter.parsers").configs
+  parser_config.norg = {
+    install_info = {
+      url = "https://github.com/nvim-neorg/tree-sitter-norg",
+      files = { "src/parser.c", "src/scanner.cc" },
+      branch = "main",
+    },
+    tier = 3,
+  }
+
+  vim.api.nvim_create_user_command("RunTests", function(opts)
+    local path = opts.fargs[1] or "tests"
+    require("nvim-treesitter.install").install(langs, { skip = { installed = true } }, function()
+      vim.schedule(function()
+        require("plenary.test_harness").test_directory(
+          path,
+          -- nvim-treesitter `main` sets up some useful filetype mappings
+          -- as a plugin, which doesn't get executed by plenary buster
+          -- when running with `minimal_init`
+          --
+          -- While this can be circumvented by setting all the associations
+          -- in the init, for some reason they don't get picked up by the
+          -- time a spec gets executed, leading to false negatives
+          { init = "./tests/minimal_init.lua" }
+        )
+      end)
+    end)
+  end, { nargs = "?" })
+end
diff --git a/tests/navigation_spec.lua b/tests/navigation_spec.lua
@@ -53,7 +53,7 @@ a.describe("navigation", function()
       vim.api.nvim_win_set_cursor(0, { 1, 0 })
       aerial.select({ index = 2 })
       local cursor = vim.api.nvim_win_get_cursor(0)
-      assert.are.same({ 3, 1 }, cursor)
+      assert.are.same({ 3, 2 }, cursor)
     end)
 
     a.it("in aerial window jumps to location", function()
@@ -63,7 +63,7 @@ a.describe("navigation", function()
       assert.equals("aerial", vim.bo.filetype)
       aerial.select({ index = 2 })
       local cursor = vim.api.nvim_win_get_cursor(0)
-      assert.are.same({ 3, 1 }, cursor)
+      assert.are.same({ 3, 2 }, cursor)
     end)
 
     a.it("in aerial window uses cursor position as index", function()
@@ -75,7 +75,7 @@ a.describe("navigation", function()
       vim.api.nvim_win_set_cursor(0, { 3, 0 })
       aerial.select()
       local cursor = vim.api.nvim_win_get_cursor(0)
-      assert.are.same({ 5, 1 }, cursor)
+      assert.are.same({ 5, 2 }, cursor)
     end)
 
     a.it("doesn't have to jump", function()
@@ -92,7 +92,7 @@ a.describe("navigation", function()
       assert.equals("aerial", vim.bo.filetype)
       -- The source window cursor should be updated
       local cursor = vim.api.nvim_win_get_cursor(winid)
-      assert.are.same({ 5, 1 }, cursor)
+      assert.are.same({ 5, 2 }, cursor)
     end)
 
     a.it("can open a new split when jumping", function()
@@ -111,7 +111,7 @@ a.describe("navigation", function()
       -- Source window cursor should be the same
       assert.are.same({ 1, 0 }, vim.api.nvim_win_get_cursor(winid))
       -- Split window cursor should be updated
-      assert.are.same({ 5, 1 }, vim.api.nvim_win_get_cursor(0))
+      assert.are.same({ 5, 2 }, vim.api.nvim_win_get_cursor(0))
     end)
   end)
 
@@ -121,47 +121,47 @@ a.describe("navigation", function()
       vim.api.nvim_win_set_cursor(0, { 1, 2 })
       window.update_position() -- Not sure why the CursorMoved autocmd doesn't fire
       aerial.next()
-      assert.are.same({ 3, 2 }, vim.api.nvim_win_get_cursor(0))
+      assert.are.same({ 3, 3 }, vim.api.nvim_win_get_cursor(0))
     end)
 
     a.it("can go to next N symbol", function()
       create_md_buf(markdown_nested_content)
       vim.api.nvim_win_set_cursor(0, { 1, 2 })
       window.update_position() -- Not sure why the CursorMoved autocmd doesn't fire
       aerial.next(2)
-      assert.are.same({ 5, 2 }, vim.api.nvim_win_get_cursor(0))
+      assert.are.same({ 5, 3 }, vim.api.nvim_win_get_cursor(0))
     end)
 
     a.it("can go to prev symbol", function()
       create_md_buf(markdown_nested_content)
       vim.api.nvim_win_set_cursor(0, { 3, 2 })
       window.update_position() -- Not sure why the CursorMoved autocmd doesn't fire
       aerial.prev()
-      assert.are.same({ 1, 1 }, vim.api.nvim_win_get_cursor(0))
+      assert.are.same({ 1, 2 }, vim.api.nvim_win_get_cursor(0))
     end)
 
     a.it("can go to prev N symbol", function()
       create_md_buf(markdown_nested_content)
       vim.api.nvim_win_set_cursor(0, { 5, 2 })
       window.update_position() -- Not sure why the CursorMoved autocmd doesn't fire
       aerial.prev(2)
-      assert.are.same({ 1, 1 }, vim.api.nvim_win_get_cursor(0))
+      assert.are.same({ 1, 2 }, vim.api.nvim_win_get_cursor(0))
     end)
 
     a.it("can go up and backwards in the tree", function()
       create_md_buf(markdown_nested_content)
       vim.api.nvim_win_set_cursor(0, { 5, 2 })
       window.update_position() -- Not sure why the CursorMoved autocmd doesn't fire
       aerial.prev_up()
-      assert.are.same({ 1, 1 }, vim.api.nvim_win_get_cursor(0))
+      assert.are.same({ 1, 2 }, vim.api.nvim_win_get_cursor(0))
     end)
 
     a.it("can go up and forwards in the tree", function()
       create_md_buf(markdown_nested_content)
       vim.api.nvim_win_set_cursor(0, { 3, 2 })
       window.update_position() -- Not sure why the CursorMoved autocmd doesn't fire
       aerial.next_up()
-      assert.are.same({ 7, 1 }, vim.api.nvim_win_get_cursor(0))
+      assert.are.same({ 7, 2 }, vim.api.nvim_win_get_cursor(0))
     end)
   end)
 end)
diff --git a/tests/symbols/markdown_test.json b/tests/symbols/markdown_test.json
@@ -10,7 +10,7 @@
         "lnum": 3,
         "name": "Title 2",
         "selection_range": {
-          "col": 2,
+          "col": 3,
           "end_col": 10,
           "end_lnum": 3,
           "lnum": 3
@@ -25,7 +25,7 @@
     "lnum": 1,
     "name": "Title 1",
     "selection_range": {
-      "col": 1,
+      "col": 2,
       "end_col": 9,
       "end_lnum": 1,
       "lnum": 1
@@ -44,7 +44,7 @@
             "lnum": 13,
             "name": "Title 5",
             "selection_range": {
-              "col": 4,
+              "col": 5,
               "end_col": 12,
               "end_lnum": 13,
               "lnum": 13
@@ -59,7 +59,7 @@
         "lnum": 7,
         "name": "Title 4",
         "selection_range": {
-          "col": 3,
+          "col": 4,
           "end_col": 11,
           "end_lnum": 7,
           "lnum": 7
@@ -74,7 +74,7 @@
     "lnum": 5,
     "name": "Title 3",
     "selection_range": {
-      "col": 1,
+      "col": 2,
       "end_col": 9,
       "end_lnum": 5,
       "lnum": 5
diff --git a/tests/symbols/ruby_test.json b/tests/symbols/ruby_test.json
