test: e2e testing

Author: brunotvs

.busted

@@ -38,6 +38,10 @@ return {
 		ROOT = {'./test/integration/'},
 		pattern = '',  -- No fancy pattern for integration tests
 	},
+	e2e={
+		ROOT={'./test/e2e/'},
+		pattern='',
+	}
 }
 
 -- vim:ft=lua

makefile

@@ -33,6 +33,9 @@ unit-test:
 integration-test:
 	@./test/bin/busted --run integration
 
+end-to-end-test:
+	@./test/bin/nvim --headless -c "set loadplugins" -c "luafile ./scripts/e2e.lua"
+
 test: unit-test integration-test
 
 clean:

scripts/e2e.lua

@@ -0,0 +1,29 @@
+vim.cmd("edit .busted")
+vim.secure.trust({
+	action = "allow",
+	bufnr = 0,
+})
+
+local neotest = require("neotest")
+local nb = require("lua.neotest-busted")
+
+local function consumer(client)
+	client.listeners.results = function(_, results, partial)
+		if partial == false then
+			local has_errors = false
+			for _, result in pairs(results) do
+				for _, e in ipairs(result.errors or {}) do
+					has_errors = true
+					io.stdout:write(e.message .. "\n\n")
+				end
+			end
+			if has_errors then
+				vim.cmd("cq!")
+			end
+			io.stdout:write("All e2e tests passed!\n\n")
+			vim.cmd("qa!")
+		end
+	end
+end
+neotest.setup({ adapters = { nb }, consumers = { consumer } })
+neotest.run.run("./test/e2e/")

test/e2e/stdout.lua

@@ -0,0 +1,24 @@
+-- NOTE: tests tests should be run from within Neovim to make sure the plugin
+-- can handle text output from within a test.  Ideally this should be run as an
+-- end-to-end test, but I cannot figure out how to write these because Neotest
+-- runs everything asynchronously.
+
+local output_handler = require 'neotest-busted._output-handler'
+
+describe('Test which write to standard output', function()
+
+	it('Has an explicit line break', function()
+		print('Some text written to standard output\n')
+		assert.is_true(true)
+	end)
+
+	it('Has no explicit line break', function()
+		print('Some text written to standard output')
+		assert.is_true(true)
+	end)
+
+	it('Contains the result marker from the output handler', function()
+		print(string.format('%sThis could trip us up', output_handler.marker))
+		assert.is_true(true)
+	end)
+end)