tests/harness.lua

-- Minimal harness for running verse against a live XMPP server.

-- Each test is a function(t) that calls t.done() on success; errors and

-- timeouts fail the test. Clients created through t.client() are closed

-- after the test finishes.

local verse = require "verse".init("client");

local timer = require "prosody.util.timer";

local harness = {};

harness.host = os.getenv("VERSE_TEST_HOST") or "localhost";

harness.port = tonumber(os.getenv("VERSE_TEST_PORT")) or 5222;

harness.domain = os.getenv("VERSE_TEST_DOMAIN") or "localhost";

harness.password = "secret";

harness.timeout = tonumber(os.getenv("VERSE_TEST_TIMEOUT")) or 10;

harness.verse = verse;

if (os.getenv("VERSE_TEST_DEBUG") or "") ~= "" then

	verse.set_log_handler(verse._default_log_handler);

end

local function run_loop_for(seconds)

	timer.add_task(seconds, function () verse.quit(); end);

	verse.loop();

end

-- Runs one test, returning true on success or false plus an error message.

function harness.run(test)

	local clients = {};

	local finished, failure;

	local t = {};

	function t.done()

		if finished then return; end

		finished = true;

		verse.quit();

	end

	function t.fail(err)

		if finished then return; end

		finished, failure = true, tostring(err);

		verse.quit();

	end

	-- Wrap a callback so an assertion failure inside it fails the test

	-- instead of being swallowed by verse's error handler.

	function t.cb(f)

		return function (...)

			local ok, err = pcall(f, ...);

			if not ok then t.fail(err); end

		end

	end

	-- Returns a new stream that connects and authenticates as `user`;

	-- `ready` is called once the resource is bound.

	function t.client(user, ready, opts)

		opts = opts or {};

		local c = verse.new();

		clients[#clients + 1] = c;

		c.connect_host, c.connect_port = harness.host, harness.port;

		for _, plugin in ipairs(opts.plugins or {}) do

			c:add_plugin(plugin);

		end

		c:hook("authentication-failure", function (err)

			if not opts.expect_failure then

				t.fail("authentication failed for "..user..": "..tostring(err.condition));

			end

		end);

		c:hook("disconnected", function (err)

			if not finished and not opts.expect_disconnect then

				t.fail("client "..user.." disconnected: "..tostring(err and err.reason));

			end

		end);

		if ready then

			c:hook("ready", t.cb(function () ready(c); end));

		end

		c:connect_client(user.."@"..harness.domain.."/"..(opts.resource or "verse-test"), opts.password or harness.password);

		return c;

	end

	local deadline = timer.add_task(harness.timeout, function ()

		t.fail("timed out after "..harness.timeout.."s");

	end);

	local ok, err = pcall(test, t);

	if not ok then

		t.fail(err);

	end

	if not finished then

		verse.loop();

	end

	timer.stop(deadline);

	-- Tear down: close any open streams and let the loop flush them

	finished = true;

	for _, c in ipairs(clients) do

		if c.conn then c:close(); end

	end

	run_loop_for(0.2);

	return failure == nil, failure;

end

return harness;