scansion/objects/client.lua

Tue, 22 Sep 2015 12:16:26 +0200

author
Kim Alvefur <zash@zash.se>
date
Tue, 22 Sep 2015 12:16:26 +0200
changeset 34
946c7d13faac
parent 29
9dcdea04601c
child 37
b2036129ccd0
child 44
0dab1dc183c1
permissions
-rw-r--r--

client: Apply variable expansion recursively to child nodes

8
42b4e73c0d30 client: Wait for login to complete before continuing past the 'connects' action
Matthew Wild <mwild1@gmail.com>
parents: 6
diff changeset
1 local async = require "scansion.async";
4
c54194d8cc30 client: verse improvements
Matthew Wild <mwild1@gmail.com>
parents: 1
diff changeset
2 local verse = require "verse".init("client");
1
017c5809d537 client: Enable verse log output
Matthew Wild <mwild1@gmail.com>
parents: 0
diff changeset
3
0
2e31b584f8d9 It is better to write and run incomplete tests than not to run complete tests. -- Martin Fowler
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
4 local parse_xml = require "scansion.xml".parse;
6
0c94ea0cabec client: Implement send/receive, including new stanzacmp library
Matthew Wild <mwild1@gmail.com>
parents: 4
diff changeset
5
0c94ea0cabec client: Implement send/receive, including new stanzacmp library
Matthew Wild <mwild1@gmail.com>
parents: 4
diff changeset
6 local stanza_timeout = 5;
0c94ea0cabec client: Implement send/receive, including new stanzacmp library
Matthew Wild <mwild1@gmail.com>
parents: 4
diff changeset
7
0c94ea0cabec client: Implement send/receive, including new stanzacmp library
Matthew Wild <mwild1@gmail.com>
parents: 4
diff changeset
8 local stanzacmp = require "scansion.stanzacmp";
0c94ea0cabec client: Implement send/receive, including new stanzacmp library
Matthew Wild <mwild1@gmail.com>
parents: 4
diff changeset
9
16
59f176aa3465 client: Allow simple variable substitution in XML in scripts
Matthew Wild <mwild1@gmail.com>
parents: 15
diff changeset
10 local function fill_vars(script, stanza)
59f176aa3465 client: Allow simple variable substitution in XML in scripts
Matthew Wild <mwild1@gmail.com>
parents: 15
diff changeset
11 for k, v in pairs(stanza.attr) do
59f176aa3465 client: Allow simple variable substitution in XML in scripts
Matthew Wild <mwild1@gmail.com>
parents: 15
diff changeset
12 local expr = v:match("^%$%{(.+)%}$");
59f176aa3465 client: Allow simple variable substitution in XML in scripts
Matthew Wild <mwild1@gmail.com>
parents: 15
diff changeset
13 if expr then
59f176aa3465 client: Allow simple variable substitution in XML in scripts
Matthew Wild <mwild1@gmail.com>
parents: 15
diff changeset
14 local name, value_name = expr:match("^(.-)'s (.+)$");
59f176aa3465 client: Allow simple variable substitution in XML in scripts
Matthew Wild <mwild1@gmail.com>
parents: 15
diff changeset
15 assert(name, "Unable to parse expression: "..expr);
59f176aa3465 client: Allow simple variable substitution in XML in scripts
Matthew Wild <mwild1@gmail.com>
parents: 15
diff changeset
16 local key = value_name:lower():gsub(" ", "_");
59f176aa3465 client: Allow simple variable substitution in XML in scripts
Matthew Wild <mwild1@gmail.com>
parents: 15
diff changeset
17 assert(script.objects[name], "Unknown object called "..name);
59f176aa3465 client: Allow simple variable substitution in XML in scripts
Matthew Wild <mwild1@gmail.com>
parents: 15
diff changeset
18 local value = script.objects[name][key];
59f176aa3465 client: Allow simple variable substitution in XML in scripts
Matthew Wild <mwild1@gmail.com>
parents: 15
diff changeset
19 assert(value ~= nil, "Unknown attribute (of "..name.."): "..value_name);
59f176aa3465 client: Allow simple variable substitution in XML in scripts
Matthew Wild <mwild1@gmail.com>
parents: 15
diff changeset
20 stanza.attr[k] = value;
59f176aa3465 client: Allow simple variable substitution in XML in scripts
Matthew Wild <mwild1@gmail.com>
parents: 15
diff changeset
21 end
59f176aa3465 client: Allow simple variable substitution in XML in scripts
Matthew Wild <mwild1@gmail.com>
parents: 15
diff changeset
22 end
34
946c7d13faac client: Apply variable expansion recursively to child nodes
Kim Alvefur <zash@zash.se>
parents: 29
diff changeset
23 for _, child in ipairs(stanza.tags) do
946c7d13faac client: Apply variable expansion recursively to child nodes
Kim Alvefur <zash@zash.se>
parents: 29
diff changeset
24 fill_vars(script, child);
946c7d13faac client: Apply variable expansion recursively to child nodes
Kim Alvefur <zash@zash.se>
parents: 29
diff changeset
25 end
16
59f176aa3465 client: Allow simple variable substitution in XML in scripts
Matthew Wild <mwild1@gmail.com>
parents: 15
diff changeset
26 return stanza;
59f176aa3465 client: Allow simple variable substitution in XML in scripts
Matthew Wild <mwild1@gmail.com>
parents: 15
diff changeset
27 end
59f176aa3465 client: Allow simple variable substitution in XML in scripts
Matthew Wild <mwild1@gmail.com>
parents: 15
diff changeset
28
0
2e31b584f8d9 It is better to write and run incomplete tests than not to run complete tests. -- Martin Fowler
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
29 return {
2e31b584f8d9 It is better to write and run incomplete tests than not to run complete tests. -- Martin Fowler
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
30 _validate = function (client)
2e31b584f8d9 It is better to write and run incomplete tests than not to run complete tests. -- Martin Fowler
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
31 assert(client.jid, "No JID specified");
23
af7a51d78b7b client: Improve stream logging, now prefixed by client name (taken from script)
Matthew Wild <mwild1@gmail.com>
parents: 22
diff changeset
32 client.stream = verse.new(verse.new_logger(client.name));
af7a51d78b7b client: Improve stream logging, now prefixed by client name (taken from script)
Matthew Wild <mwild1@gmail.com>
parents: 22
diff changeset
33
af7a51d78b7b client: Improve stream logging, now prefixed by client name (taken from script)
Matthew Wild <mwild1@gmail.com>
parents: 22
diff changeset
34 function client.log(fmt, ...)
af7a51d78b7b client: Improve stream logging, now prefixed by client name (taken from script)
Matthew Wild <mwild1@gmail.com>
parents: 22
diff changeset
35 return client.stream:info(fmt, ...);
af7a51d78b7b client: Improve stream logging, now prefixed by client name (taken from script)
Matthew Wild <mwild1@gmail.com>
parents: 22
diff changeset
36 end
10
75bf4c021461 client: ALL the debugging on
Matthew Wild <mwild1@gmail.com>
parents: 8
diff changeset
37
75bf4c021461 client: ALL the debugging on
Matthew Wild <mwild1@gmail.com>
parents: 8
diff changeset
38 -- This one prints all received data
23
af7a51d78b7b client: Improve stream logging, now prefixed by client name (taken from script)
Matthew Wild <mwild1@gmail.com>
parents: 22
diff changeset
39 client.stream:hook("incoming-raw", function (s) client.log("Data in: %s", s); end, 1000);
af7a51d78b7b client: Improve stream logging, now prefixed by client name (taken from script)
Matthew Wild <mwild1@gmail.com>
parents: 22
diff changeset
40 client.stream:hook("outgoing-raw", function (s) client.log("Data out: %s", s); end, 1000);
af7a51d78b7b client: Improve stream logging, now prefixed by client name (taken from script)
Matthew Wild <mwild1@gmail.com>
parents: 22
diff changeset
41 -- And incoming, parsed, stanzas
af7a51d78b7b client: Improve stream logging, now prefixed by client name (taken from script)
Matthew Wild <mwild1@gmail.com>
parents: 22
diff changeset
42 client.stream:hook("stanza", function (s) client.log("Stanza: %s", s) end);
0
2e31b584f8d9 It is better to write and run incomplete tests than not to run complete tests. -- Martin Fowler
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
43 end;
2e31b584f8d9 It is better to write and run incomplete tests than not to run complete tests. -- Martin Fowler
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
44
2e31b584f8d9 It is better to write and run incomplete tests than not to run complete tests. -- Martin Fowler
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
45 connects = function (client)
8
42b4e73c0d30 client: Wait for login to complete before continuing past the 'connects' action
Matthew Wild <mwild1@gmail.com>
parents: 6
diff changeset
46 local wait, done = async.waiter();
23
af7a51d78b7b client: Improve stream logging, now prefixed by client name (taken from script)
Matthew Wild <mwild1@gmail.com>
parents: 22
diff changeset
47 client.stream:hook("ready", function () client.log"ready" done() client.log("ready done") end);
4
c54194d8cc30 client: verse improvements
Matthew Wild <mwild1@gmail.com>
parents: 1
diff changeset
48 client.stream:connect_client(client.jid, client.password);
8
42b4e73c0d30 client: Wait for login to complete before continuing past the 'connects' action
Matthew Wild <mwild1@gmail.com>
parents: 6
diff changeset
49 wait();
15
0441673df075 client: Add full JID as property of clients
Matthew Wild <mwild1@gmail.com>
parents: 10
diff changeset
50 client.full_jid = client.stream.jid;
0
2e31b584f8d9 It is better to write and run incomplete tests than not to run complete tests. -- Martin Fowler
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
51 end;
2e31b584f8d9 It is better to write and run incomplete tests than not to run complete tests. -- Martin Fowler
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
52
2e31b584f8d9 It is better to write and run incomplete tests than not to run complete tests. -- Martin Fowler
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
53 sends = function (client, data)
24
3c572d238d9e client: More flexible handling of whitespace in stanzas in script
Matthew Wild <mwild1@gmail.com>
parents: 23
diff changeset
54 local stanza = fill_vars(client.script, assert(parse_xml((table.concat(data):gsub("\t", " ")))));
6
0c94ea0cabec client: Implement send/receive, including new stanzacmp library
Matthew Wild <mwild1@gmail.com>
parents: 4
diff changeset
55 client.stream:send(stanza);
0
2e31b584f8d9 It is better to write and run incomplete tests than not to run complete tests. -- Martin Fowler
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
56 end;
2e31b584f8d9 It is better to write and run incomplete tests than not to run complete tests. -- Martin Fowler
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
57
2e31b584f8d9 It is better to write and run incomplete tests than not to run complete tests. -- Martin Fowler
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
58 receives = function (client, data)
26
c32334d33438 client: Wait for received stanzas using async waiter
Matthew Wild <mwild1@gmail.com>
parents: 25
diff changeset
59 local wait, done = async.waiter();
24
3c572d238d9e client: More flexible handling of whitespace in stanzas in script
Matthew Wild <mwild1@gmail.com>
parents: 23
diff changeset
60 local expected_stanza = fill_vars(client.script, assert(parse_xml((table.concat(data):gsub("\t", " ")))));
6
0c94ea0cabec client: Implement send/receive, including new stanzacmp library
Matthew Wild <mwild1@gmail.com>
parents: 4
diff changeset
61 local function stanza_handler(received_stanza)
0c94ea0cabec client: Implement send/receive, including new stanzacmp library
Matthew Wild <mwild1@gmail.com>
parents: 4
diff changeset
62 if not stanzacmp.stanzas_match(expected_stanza, received_stanza) then
23
af7a51d78b7b client: Improve stream logging, now prefixed by client name (taken from script)
Matthew Wild <mwild1@gmail.com>
parents: 22
diff changeset
63 client.log("NOT IT!")
af7a51d78b7b client: Improve stream logging, now prefixed by client name (taken from script)
Matthew Wild <mwild1@gmail.com>
parents: 22
diff changeset
64 client.log("Expected: %s", expected_stanza);
af7a51d78b7b client: Improve stream logging, now prefixed by client name (taken from script)
Matthew Wild <mwild1@gmail.com>
parents: 22
diff changeset
65 client.log("Received: %s", received_stanza);
25
9f8166238993 client: Error out when test fails, instead of directly calling verse.quit()
Matthew Wild <mwild1@gmail.com>
parents: 24
diff changeset
66 error("Received unexpected stanza");
6
0c94ea0cabec client: Implement send/receive, including new stanzacmp library
Matthew Wild <mwild1@gmail.com>
parents: 4
diff changeset
67 else
23
af7a51d78b7b client: Improve stream logging, now prefixed by client name (taken from script)
Matthew Wild <mwild1@gmail.com>
parents: 22
diff changeset
68 client.log("YES! %s", expected_stanza)
6
0c94ea0cabec client: Implement send/receive, including new stanzacmp library
Matthew Wild <mwild1@gmail.com>
parents: 4
diff changeset
69 end
0c94ea0cabec client: Implement send/receive, including new stanzacmp library
Matthew Wild <mwild1@gmail.com>
parents: 4
diff changeset
70 expected_stanza = nil;
27
34d405303242 client: Remove stanza handler when stanza comes in
Matthew Wild <mwild1@gmail.com>
parents: 26
diff changeset
71 client.stream:unhook("stanza", stanza_handler);
26
c32334d33438 client: Wait for received stanzas using async waiter
Matthew Wild <mwild1@gmail.com>
parents: 25
diff changeset
72 done();
6
0c94ea0cabec client: Implement send/receive, including new stanzacmp library
Matthew Wild <mwild1@gmail.com>
parents: 4
diff changeset
73 end
0c94ea0cabec client: Implement send/receive, including new stanzacmp library
Matthew Wild <mwild1@gmail.com>
parents: 4
diff changeset
74 client.stream:hook("stanza", stanza_handler, 100);
0c94ea0cabec client: Implement send/receive, including new stanzacmp library
Matthew Wild <mwild1@gmail.com>
parents: 4
diff changeset
75 verse.add_task(stanza_timeout, function ()
28
2dd867c31214 client: Add comment
Matthew Wild <mwild1@gmail.com>
parents: 27
diff changeset
76 if not expected_stanza then return; end -- Stanza already received
23
af7a51d78b7b client: Improve stream logging, now prefixed by client name (taken from script)
Matthew Wild <mwild1@gmail.com>
parents: 22
diff changeset
77 client.log("TIMEOUT waiting for %s", expected_stanza)
25
9f8166238993 client: Error out when test fails, instead of directly calling verse.quit()
Matthew Wild <mwild1@gmail.com>
parents: 24
diff changeset
78 error("Timed out waiting for stanza");
26
c32334d33438 client: Wait for received stanzas using async waiter
Matthew Wild <mwild1@gmail.com>
parents: 25
diff changeset
79 done();
6
0c94ea0cabec client: Implement send/receive, including new stanzacmp library
Matthew Wild <mwild1@gmail.com>
parents: 4
diff changeset
80 end);
26
c32334d33438 client: Wait for received stanzas using async waiter
Matthew Wild <mwild1@gmail.com>
parents: 25
diff changeset
81 wait();
0
2e31b584f8d9 It is better to write and run incomplete tests than not to run complete tests. -- Martin Fowler
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
82 end;
2e31b584f8d9 It is better to write and run incomplete tests than not to run complete tests. -- Martin Fowler
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
83
2e31b584f8d9 It is better to write and run incomplete tests than not to run complete tests. -- Martin Fowler
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
84 disconnects = function (client)
29
9dcdea04601c client: Implement 'disconnects' action
Matthew Wild <mwild1@gmail.com>
parents: 28
diff changeset
85 client.stream:close();
0
2e31b584f8d9 It is better to write and run incomplete tests than not to run complete tests. -- Martin Fowler
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
86 end;
2e31b584f8d9 It is better to write and run incomplete tests than not to run complete tests. -- Martin Fowler
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
87 }

mercurial