util.startup: Abort before initialization of logging when started as root
Prevents creation of log files owned by the root user which could be
inaccessible once started correctly.
local pubsub;
setup(function ()
pubsub = require "util.pubsub";
end);
--[[TODO:
Retract
Purge
auto-create/auto-subscribe
Item store/node store
resize on max_items change
service creation config provides alternative node_defaults
get subscriptions
]]
describe("util.pubsub", function ()
describe("simple node creation and deletion", function ()
randomize(false); -- These tests are ordered
-- Roughly a port of scansion/scripts/pubsub_createdelete.scs
local service = pubsub.new();
describe("#create", function ()
randomize(false); -- These tests are ordered
it("creates a new node", function ()
assert.truthy(service:create("princely_musings", true));
end);
it("fails to create the same node again", function ()
assert.falsy(service:create("princely_musings", true));
end);
end);
describe("#delete", function ()
randomize(false); -- These tests are ordered
it("deletes the node", function ()
assert.truthy(service:delete("princely_musings", true));
end);
it("can't delete an already deleted node", function ()
assert.falsy(service:delete("princely_musings", true));
end);
end);
end);
describe("simple publishing", function ()
randomize(false); -- These tests are ordered
local notified;
local broadcaster = spy.new(function (notif_type, node_name, subscribers, item) -- luacheck: ignore 212
notified = subscribers;
end);
local service = pubsub.new({
broadcaster = broadcaster;
});
it("creates a node", function ()
assert.truthy(service:create("node", true));
end);
it("lets someone subscribe", function ()
assert.truthy(service:add_subscription("node", true, "someone"));
end);
it("publishes an item", function ()
assert.truthy(service:publish("node", true, "1", "item 1"));
assert.truthy(notified["someone"]);
end);
it("called the broadcaster", function ()
assert.spy(broadcaster).was_called();
end);
it("should return one item", function ()
local ok, ret = service:get_items("node", true);
assert.truthy(ok);
assert.same({ "1", ["1"] = "item 1" }, ret);
end);
it("lets someone unsubscribe", function ()
assert.truthy(service:remove_subscription("node", true, "someone"));
end);
it("does not send notifications after subscription is removed", function ()
assert.truthy(service:publish("node", true, "1", "item 1"));
assert.is_nil(notified["someone"]);
end);
end);
describe("publish with config", function ()
randomize(false); -- These tests are ordered
local broadcaster = spy.new(function (notif_type, node_name, subscribers, item) -- luacheck: ignore 212
end);
local service = pubsub.new({
broadcaster = broadcaster;
autocreate_on_publish = true;
});
it("automatically creates node with requested config", function ()
assert(service:publish("node", true, "1", "item 1", { myoption = true }));
local ok, config = assert(service:get_node_config("node", true));
assert.truthy(ok);
assert.equals(true, config.myoption);
end);
it("fails to publish to a node with differing config", function ()
local ok, err = service:publish("node", true, "1", "item 2", { myoption = false });
assert.falsy(ok);
assert.equals("precondition-not-met", err.pubsub_condition);
end);
it("allows to publish to a node with differing config when only defaults are suggested", function ()
assert(service:publish("node", true, "1", "item 2", { _defaults_only = true, myoption = false }));
end);
end);
describe("#issue1082", function ()
randomize(false); -- These tests are ordered
local service = pubsub.new();
it("creates a node with max_items = 1", function ()
assert.truthy(service:create("node", true, { max_items = 1 }));
end);
it("changes max_items to 2", function ()
assert.truthy(service:set_node_config("node", true, { max_items = 2 }));
end);
it("publishes one item", function ()
assert.truthy(service:publish("node", true, "1", "item 1"));
end);
it("should return one item", function ()
local ok, ret = service:get_items("node", true);
assert.truthy(ok);
assert.same({ "1", ["1"] = "item 1" }, ret);
end);
it("publishes another item", function ()
assert.truthy(service:publish("node", true, "2", "item 2"));
end);
it("should return two items", function ()
local ok, ret = service:get_items("node", true);
assert.truthy(ok);
assert.same({
"2",
"1",
["1"] = "item 1",
["2"] = "item 2",
}, ret);
end);
it("publishes yet another item", function ()
assert.truthy(service:publish("node", true, "3", "item 3"));
end);
it("should still return only two items", function ()
local ok, ret = service:get_items("node", true);
assert.truthy(ok);
assert.same({
"3",
"2",
["2"] = "item 2",
["3"] = "item 3",
}, ret);
end);
it("has a default max_items", function ()
assert.truthy(service.config.max_items);
end)
it("changes max_items to max", function ()
assert.truthy(service:set_node_config("node", true, { max_items = "max" }));
end);
it("publishes some more items", function()
for i = 4, service.config.max_items + 5 do
assert.truthy(service:publish("node", true, tostring(i), "item " .. tostring(i)));
end
end);
it("should still return only two items", function ()
local ok, ret = service:get_items("node", true);
assert.truthy(ok);
assert.same(service.config.max_items, #ret);
end);
end);
describe("the thing", function ()
randomize(false); -- These tests are ordered
local service = pubsub.new();
it("creates a node with some items", function ()
assert.truthy(service:create("node", true, { max_items = 3 }));
assert.truthy(service:publish("node", true, "1", "item 1"));
assert.truthy(service:publish("node", true, "2", "item 2"));
assert.truthy(service:publish("node", true, "3", "item 3"));
end);
it("should return the requested item", function ()
local ok, ret = service:get_items("node", true, "1");
assert.truthy(ok);
assert.same({ "1", ["1"] = "item 1" }, ret);
end);
it("should return multiple requested items", function ()
local ok, ret = service:get_items("node", true, { "1", "2" });
assert.truthy(ok);
assert.same({
"1",
"2",
["1"] = "item 1",
["2"] = "item 2",
}, ret);
end);
end);
describe("node config", function ()
local service;
before_each(function ()
service = pubsub.new();
service:create("test", true);
end);
it("access is forbidden for unaffiliated entities", function ()
local ok, err = service:get_node_config("test", "stranger");
assert.is_falsy(ok);
assert.equals("forbidden", err);
end);
it("returns an error for nodes that do not exist", function ()
local ok, err = service:get_node_config("nonexistent", true);
assert.is_falsy(ok);
assert.equals("item-not-found", err);
end);
end);
describe("access model", function ()
describe("open", function ()
local service;
before_each(function ()
service = pubsub.new();
-- Do not supply any config, 'open' should be default
service:create("test", true);
end);
it("should be the default", function ()
local ok, config = service:get_node_config("test", true);
assert.truthy(ok);
assert.equal("open", config.access_model);
end);
it("should allow anyone to subscribe", function ()
local ok = service:add_subscription("test", "stranger", "stranger");
assert.is_true(ok);
end);
it("should still reject outcast-affiliated entities", function ()
assert(service:set_affiliation("test", true, "enemy", "outcast"));
local ok, err = service:add_subscription("test", "enemy", "enemy");
assert.is_falsy(ok);
assert.equal("forbidden", err);
end);
end);
describe("whitelist", function ()
local service;
before_each(function ()
service = assert(pubsub.new());
assert.is_true(service:create("test", true, { access_model = "whitelist" }));
end);
it("should be present in the configuration", function ()
local ok, config = service:get_node_config("test", true);
assert.truthy(ok);
assert.equal("whitelist", config.access_model);
end);
it("should not allow anyone to subscribe", function ()
local ok, err = service:add_subscription("test", "stranger", "stranger");
assert.is_false(ok);
assert.equals("forbidden", err);
end);
end);
describe("change", function ()
local service;
before_each(function ()
service = pubsub.new();
service:create("test", true, { access_model = "open" });
end);
it("affects existing subscriptions", function ()
do
local ok = service:add_subscription("test", "stranger", "stranger");
assert.is_true(ok);
end
do
local ok, sub = service:get_subscription("test", "stranger", "stranger");
assert.is_true(ok);
assert.is_true(sub);
end
assert(service:set_node_config("test", true, { access_model = "whitelist" }));
do
local ok, sub = service:get_subscription("test", "stranger", "stranger");
assert.is_true(ok);
assert.is_nil(sub);
end
end);
end);
end);
describe("publish model", function ()
describe("publishers", function ()
local service;
before_each(function ()
service = pubsub.new();
-- Do not supply any config, 'publishers' should be default
service:create("test", true);
end);
it("should be the default", function ()
local ok, config = service:get_node_config("test", true);
assert.truthy(ok);
assert.equal("publishers", config.publish_model);
end);
it("should not allow anyone to publish", function ()
assert.is_true(service:add_subscription("test", "stranger", "stranger"));
local ok, err = service:publish("test", "stranger", "item1", "foo");
assert.is_falsy(ok);
assert.equals("forbidden", err);
end);
it("should allow publishers to publish", function ()
assert(service:set_affiliation("test", true, "mypublisher", "publisher"));
-- luacheck: ignore 211/err
local ok, err = service:publish("test", "mypublisher", "item1", "foo");
assert.is_true(ok);
end);
it("should allow owners to publish", function ()
assert(service:set_affiliation("test", true, "myowner", "owner"));
local ok = service:publish("test", "myowner", "item1", "foo");
assert.is_true(ok);
end);
end);
describe("open", function ()
local service;
before_each(function ()
service = pubsub.new();
service:create("test", true, { publish_model = "open" });
end);
it("should allow anyone to publish", function ()
local ok = service:publish("test", "stranger", "item1", "foo");
assert.is_true(ok);
end);
end);
describe("subscribers", function ()
local service;
before_each(function ()
service = pubsub.new();
service:create("test", true, { publish_model = "subscribers" });
end);
it("should not allow non-subscribers to publish", function ()
local ok, err = service:publish("test", "stranger", "item1", "foo");
assert.is_falsy(ok);
assert.equals("forbidden", err);
end);
it("should allow subscribers to publish without an affiliation", function ()
assert.is_true(service:add_subscription("test", "stranger", "stranger"));
local ok = service:publish("test", "stranger", "item1", "foo");
assert.is_true(ok);
end);
it("should allow publishers to publish without a subscription", function ()
assert(service:set_affiliation("test", true, "mypublisher", "publisher"));
-- luacheck: ignore 211/err
local ok, err = service:publish("test", "mypublisher", "item1", "foo");
assert.is_true(ok);
end);
it("should allow owners to publish without a subscription", function ()
assert(service:set_affiliation("test", true, "myowner", "owner"));
local ok = service:publish("test", "myowner", "item1", "foo");
assert.is_true(ok);
end);
end);
end);
describe("item API", function ()
local service;
before_each(function ()
service = pubsub.new();
service:create("test", true, { publish_model = "subscribers" });
end);
describe("get_last_item()", function ()
it("succeeds with nil on empty nodes", function ()
local ok, id, item = service:get_last_item("test", true);
assert.is_true(ok);
assert.is_nil(id);
assert.is_nil(item);
end);
it("succeeds and returns the last item", function ()
service:publish("test", true, "one", "hello world");
service:publish("test", true, "two", "hello again");
service:publish("test", true, "three", "hey");
service:publish("test", true, "one", "bye");
local ok, id, item = service:get_last_item("test", true);
assert.is_true(ok);
assert.equal("one", id);
assert.equal("bye", item);
end);
end);
describe("get_items()", function ()
it("fails on non-existent nodes", function ()
local ok, err = service:get_items("no-node", true);
assert.is_falsy(ok);
assert.equal("item-not-found", err);
end);
it("returns no items on an empty node", function ()
local ok, items = service:get_items("test", true);
assert.is_true(ok);
assert.equal(0, #items);
assert.is_nil(next(items));
end);
it("returns no items on an empty node", function ()
local ok, items = service:get_items("test", true);
assert.is_true(ok);
assert.equal(0, #items);
assert.is_nil((next(items)));
end);
it("returns all published items", function ()
service:publish("test", true, "one", "hello world");
service:publish("test", true, "two", "hello again");
service:publish("test", true, "three", "hey");
service:publish("test", true, "one", "bye");
local ok, items = service:get_items("test", true);
assert.is_true(ok);
assert.same({ "one", "three", "two", two = "hello again", three = "hey", one = "bye" }, items);
end);
end);
end);
describe("restoring data from nodestore", function ()
local nodestore = {
data = {
test = {
name = "test";
config = {};
affiliations = {};
subscribers = {
["someone"] = true;
};
}
}
};
function nodestore:users()
return pairs(self.data)
end
function nodestore:get(key)
return self.data[key];
end
local service = pubsub.new({
nodestore = nodestore;
});
it("subscriptions", function ()
local ok, ret = service:get_subscriptions(nil, true, nil)
assert.is_true(ok);
assert.same({ { node = "test", jid = "someone", subscription = true, } }, ret);
end);
end);
describe("node config checking", function ()
local service;
before_each(function ()
service = pubsub.new({
check_node_config = function (node, actor, config) -- luacheck: ignore 212
return config["max_items"] <= 20;
end;
});
end);
it("defaults, then configure", function ()
local ok, err = service:create("node", true);
assert.is_true(ok, err);
local ok, err = service:set_node_config("node", true, { max_items = 10 });
assert.is_true(ok, err);
local ok, err = service:set_node_config("node", true, { max_items = 100 });
assert.falsy(ok, err);
assert.equals(err, "not-acceptable");
end);
it("create with ok config, then configure", function ()
local ok, err = service:create("node", true, { max_items = 10 });
assert.is_true(ok, err);
local ok, err = service:set_node_config("node", true, { max_items = 100 });
assert.falsy(ok, err);
local ok, err = service:set_node_config("node", true, { max_items = 10 });
assert.is_true(ok, err);
end);
it("create with unacceptable config", function ()
local ok, err = service:create("node", true, { max_items = 100 });
assert.falsy(ok, err);
end);
end);
describe("subscriber filter", function ()
it("works", function ()
local filter = spy.new(function (subs) -- luacheck: ignore 212/subs
return {["modified"] = true};
end);
local broadcaster = spy.new(function (notif_type, node_name, subscribers, item) -- luacheck: ignore 212
end);
local service = pubsub.new({
subscriber_filter = filter;
broadcaster = broadcaster;
});
local ok = service:create("node", true);
assert.truthy(ok);
local ok = service:add_subscription("node", true, "someone");
assert.truthy(ok);
local ok = service:publish("node", true, "1", "item");
assert.truthy(ok);
-- TODO how to match table arguments?
assert.spy(filter).was_called();
assert.spy(broadcaster).was_called();
end);
end);
describe("persist_items", function()
it("can be disabled", function()
local broadcaster = spy.new(function(notif_type, node_name, subscribers, item) -- luacheck: ignore 212
end);
local service = pubsub.new { node_defaults = { persist_items = false }, broadcaster = broadcaster }
local ok = service:create("node", true)
assert.truthy(ok);
local ok = service:publish("node", true, "1", "item");
assert.truthy(ok);
assert.spy(broadcaster).was_called();
local ok, items = service:get_items("node", true);
assert.not_truthy(ok);
assert.equal(items, "persistent-items-unsupported");
end);
end)
describe("max_items", function ()
it("works", function ()
local service = pubsub.new { };
local ok = service:create("node", true)
assert.truthy(ok);
for i = 1, 20 do
assert.truthy(service:publish("node", true, "item"..tostring(i), "data"..tostring(i)));
end
do
local ok, items = service:get_items("node", true, nil, { max = 3 });
assert.truthy(ok, items);
assert.equal(3, #items);
assert.same({
"item20",
"item19",
"item18",
item20 = "data20",
item19 = "data19",
item18 = "data18",
}, items, "items should be ordered by oldest first");
end
do
local ok, items = service:get_items("node", true, nil, { max = 10 });
assert.truthy(ok, items);
assert.equal(10, #items);
assert.same({
"item20",
"item19",
"item18",
"item17",
"item16",
"item15",
"item14",
"item13",
"item12",
"item11",
item20 = "data20",
item19 = "data19",
item18 = "data18",
item17 = "data17",
item16 = "data16",
item15 = "data15",
item14 = "data14",
item13 = "data13",
item12 = "data12",
item11 = "data11",
}, items, "items should be ordered by oldest first");
end
end);
end)
end);