ci: add github workflows

Author: mxsdev

.github/workflows/workflow.yaml

@@ -0,0 +1,63 @@
+name: nvim-dap-ui Workflow
+on: [push]
+jobs:
+  style:
+    name: style
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: JohnnyMorganz/stylua-action@1.0.0
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          args: --check lua/ tests/
+
+  tests:
+    name: tests
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - run: date +%F > todays-date
+      - name: Restore cache for today's nightly.
+        uses: actions/cache@v2
+        with:
+          path: _neovim
+          key: ${{ runner.os }}-x64-${{ hashFiles('todays-date') }}
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16
+          cache: 'yarn'
+
+      - name: Prepare dependencies
+        run: |
+          npm install --global yarn
+          bash ./scripts/setup_tests
+
+      - name: Run tests
+        run: |
+          curl -OL https://raw.githubusercontent.com/norcalli/bot-ci/master/scripts/github-actions-setup.sh
+          source github-actions-setup.sh nightly-x64
+          bash ./scripts/test -t 30000
+
+  release:
+    name: release
+    if: ${{ github.ref == 'refs/heads/master' }}
+    needs: 
+      - style
+      - tests
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - name: Setup Node.js
+        uses: actions/setup-node@v1
+        with:
+          node-version: 16
+      - name: Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: npx semantic-release
+

lua/dap-vscode-js/session.lua

@@ -49,6 +49,10 @@ function M.unregister_session(session)
 	sessions[session] = nil
 end
 
+function M.is_session_registered(session)
+  return not not sessions[session]
+end
+
 local function get_breakpoints(pid)
 	breakpoints[pid] = breakpoints[pid] or {}
 	return breakpoints[pid]

scripts/test

@@ -1,9 +1,25 @@
 #!/bin/bash
 
+TIMEOUT=2000
+
+while getopts ":t:" options; do
+  case "${options}" in
+    t)
+      if [ -n "${OPTARG}" ]; then
+        TIMEOUT=${OPTARG}
+      fi
+      ;;
+  esac
+done
+
+export PLENARY_TEST_TIMEOUT=$TIMEOUT
+
+shift $(($OPTIND - 1))
+
 tempfile=".test_output.tmp"
 
 if [[ -n $1 ]]; then
-	nvim --headless --clean --noplugin -u tests/init.vim -c "PlenaryBustedFile $1 {sequential=true}" | tee "${tempfile}"
+	nvim --headless --clean --noplugin -u tests/init.vim -c "PlenaryBustedFile $1" | tee "${tempfile}"
 else
 	nvim --headless --clean --noplugin -u tests/init.vim -c "PlenaryBustedDirectory tests/ {minimal_init = 'tests/init.vim'}" | tee "${tempfile}"
 fi

tests/init.vim

@@ -6,7 +6,7 @@ set rtp+=./lib/nvim-dap
 set rtp+=./lib/nvim-dap-ui
 set rtp+=./tests
 
-let $PLENARY_TEST_TIMEOUT=2000 
+" let $PLENARY_TEST_TIMEOUT=60000 
 
 runtime! plugin/plenary.vim
 lua DEBUGGER_PATH="./lib/vscode-js-debug"

tests/integration/jest_spec.lua

@@ -2,6 +2,7 @@ local breakpoints = require("dap.breakpoints")
 local async = require("plenary.async.tests")
 local wrap = require("plenary.async.async").wrap
 local dapjs = require("dap-vscode-js")
+local js_session = require"dap-vscode-js.session"
 local dap = require("dap")
 local test_utils = require("__dap_js_test_util")
 local config = require("dap-vscode-js.config")
@@ -12,7 +13,7 @@ local launch_config = {
 	type = "pwa-node",
 	request = "launch",
 	name = "Debug Jest Tests",
-	trace = true,
+	-- trace = true,
 	runtimeExecutable = "node",
 	runtimeArgs = {
 		"./node_modules/jest/bin/jest.js",
@@ -34,38 +35,35 @@ describe("pwa-node jest", function()
 		async.it(
 			"receives stdout from terminal",
 			wrap(function(done)
-				local term_lines = {}
+        local terminated = false
 
-				local terminated = false
-				local cleanup
+        local lines_found = {
+          ["Tests:       1 failed, 1 passed, 2 total"] = false,
+          ["Ran all test suites."] = false,
+          ["Waiting for the debugger to disconnect..."] = false,
+        }
 
 				local function try_exit()
-					if terminated and #term_lines == 98 then
-						assert.equal(term_lines[92], "Tests:       1 failed, 1 passed, 2 total")
-
-						cleanup()
-						done()
-					end
+					if terminated and vim.tbl_count(lines_found) == 0 then
+            done()
+          end
 				end
 
-				cleanup = test_utils.get_terminal_remote(function(lines)
+				test_utils.get_terminal_remote(function(lines)
 					for _, line in ipairs(lines) do
-						table.insert(term_lines, line)
+            lines_found[line] = nil
 					end
 
 					try_exit()
 				end)
 
 				test_utils.open_test("jest/integration.test.ts")
 
-				test_utils.add_listener("before", "event_output", function(session, body)
-					print(body.output)
-				end)
+        test_utils.on_session_end(function ()
+          terminated = true
 
-				test_utils.add_listener("before", "event_terminated", function()
-					terminated = true
-					try_exit()
-				end)
+          try_exit()
+        end)
 
 				dap.run(launch_config)
 			end, 1)

tests/integration/node_spec.lua

@@ -23,6 +23,7 @@ describe("pwa-node", function()
 	end)
 
 	describe("typescript", function()
+
 		async.it(
 			"can be debugged with simple config",
 			wrap(function(done)
@@ -53,7 +54,7 @@ describe("pwa-node", function()
 					try_exit()
 				end)
 
-				test_utils.add_listener("after", "event_terminated", function(session, body)
+        test_utils.on_session_end(function ()
 					termination_happened = true
 
 					try_exit()
@@ -74,29 +75,32 @@ describe("pwa-node", function()
 				test_utils.add_listener("after", "event_stopped", function(session, body)
 					assert.equal(body.reason, "breakpoint")
 
-					vim.defer_fn(function()
-						local bps = breakpoints.get(bufexpr)[bufexpr]
+          local bps = breakpoints.get(bufexpr)[bufexpr]
+
+          assert.equal(#bps, 1)
 
-						assert.equal(#bps, 1)
+          local bp_signs = test_utils.get_breakpoint_signs(bufexpr)
 
-						local bp_signs = test_utils.get_breakpoint_signs(bufexpr)
+          assert.equal(#bp_signs, 1)
 
-						for _, bp in ipairs(bp_signs) do
-							for _, sign in ipairs(bp.signs) do
-								assert.equal(sign.name, "DapBreakpoint")
-							end
-						end
+          for _, bp in ipairs(bp_signs) do
+            assert.equal(#bp.signs, 1)
 
-						dap.continue()
-					end, 10)
+            for _, sign in ipairs(bp.signs) do
+              assert.equal(sign.name, "DapBreakpoint")
+            end
+          end
+
+          done()
 				end)
 
-				test_utils.add_listener("after", "event_terminated", function(session, body)
+        test_utils.on_session_end(function ()
 					done()
 				end)
 
 				dap.run(launch_config)
 			end, 1)
 		)
+
 	end)
 end)

tests/lua/__dap_js_test_util.lua

@@ -4,13 +4,15 @@ local dap = require("dap")
 local dap_bps = require("dap.breakpoints")
 local dapjs = require("dap-vscode-js")
 local dapjs_utils = require("dap-vscode-js.utils")
+local js_session = require("dap-vscode-js.session")
 
 local dap_ns = "dap_breakpoints"
 
 M.id = "___dap_js_test"
 local util_id = "___dap_js_test_utils"
 
-local current_session
+-- local current_session
+local current_sessions = { }
 
 function M.clear_listeners()
 	for _, time in ipairs({ "before", "after" }) do
@@ -32,6 +34,7 @@ function M.reset()
 	M.clear_listeners()
 	M.clear_config()
 	M.clear_breakpoints()
+  current_sessions = { }
 end
 
 function M.set_breakpoint(lnum, bufnr, opts)
@@ -40,21 +43,35 @@ end
 
 function M.add_listener(time, event_or_command, callback)
 	dap.listeners[time][event_or_command][M.id] = function(session, ...)
-		if session ~= current_session then
+		if not current_sessions[session] then
 			return
 		end
 
 		callback(session, ...)
 	end
 end
 
+function M.on_session_end(callback)
+  M.add_listener('after', 'event_terminated', function (session, ...)
+    current_sessions[session] = nil
+
+    local active_sessions = vim.tbl_filter(function (el)
+      return js_session.is_session_registered(el)
+    end, vim.tbl_keys(current_sessions))
+
+    if #active_sessions == 0 then
+      callback(session, ...)
+    end
+  end)
+end
+
 function M.setup_dapjs(config)
 	dapjs.setup(vim.tbl_extend("force", {
 		debugger_path = DEBUGGER_PATH,
 	}, config or {}))
 
 	dap.listeners.before["event_initialized"][util_id] = function(session)
-		current_session = session
+    current_sessions[session] = true
 	end
 end