1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
|
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 ()
-- Roughly a port of scansion/scripts/pubsub_createdelete.scs
local service = pubsub.new();
describe("#create", function ()
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 ()
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 ()
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("#issue1082", function ()
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);
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.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.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.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"));
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"));
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);
end);
end);
|
