annotate tests/plugin-plugin/main.cpp @ 550:64cb98dd8e9d

Irccd: finish custom IRC library, closes #581 Finally remove the lovely libircclient that has been used since the beginning of irccd back in 2013. Several issues made the choice of developing a custom IRC library: - libircclient requires select(2) system call and works in procedural paradigm which is incompatible with our Boost.Asio main loop, - there was no way in the libircclient to detect custom message like PING to handle dead servers, this required to bundle the library within the application, - the library use static output buffer which requires to keep an internal queue of commands that we flush at each iteration.
author David Demelier <markand@malikania.fr>
date Fri, 24 Nov 2017 20:05:15 +0100
parents e03521cf207b
children a5e1c91abb8e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
166
2380d476f987 Plugin plugin: add initial unit test
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 /*
2380d476f987 Plugin plugin: add initial unit test
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 * main.cpp -- test plugin plugin
2380d476f987 Plugin plugin: add initial unit test
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 *
394
c6fbb6e0e06d Happy new year!
David Demelier <markand@malikania.fr>
parents: 350
diff changeset
4 * Copyright (c) 2013-2017 David Demelier <markand@malikania.fr>
166
2380d476f987 Plugin plugin: add initial unit test
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 *
2380d476f987 Plugin plugin: add initial unit test
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 * Permission to use, copy, modify, and/or distribute this software for any
2380d476f987 Plugin plugin: add initial unit test
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 * purpose with or without fee is hereby granted, provided that the above
2380d476f987 Plugin plugin: add initial unit test
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 * copyright notice and this permission notice appear in all copies.
2380d476f987 Plugin plugin: add initial unit test
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 *
2380d476f987 Plugin plugin: add initial unit test
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
2380d476f987 Plugin plugin: add initial unit test
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
2380d476f987 Plugin plugin: add initial unit test
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
2380d476f987 Plugin plugin: add initial unit test
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
2380d476f987 Plugin plugin: add initial unit test
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
2380d476f987 Plugin plugin: add initial unit test
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
2380d476f987 Plugin plugin: add initial unit test
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
2380d476f987 Plugin plugin: add initial unit test
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 */
2380d476f987 Plugin plugin: add initial unit test
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
489
349fe29d86d5 Tests: switch to Boost, closes #680
David Demelier <markand@malikania.fr>
parents: 488
diff changeset
19 #define BOOST_TEST_MODULE "Plugin plugin"
349fe29d86d5 Tests: switch to Boost, closes #680
David Demelier <markand@malikania.fr>
parents: 488
diff changeset
20 #include <boost/test/unit_test.hpp>
166
2380d476f987 Plugin plugin: add initial unit test
David Demelier <markand@malikania.fr>
parents:
diff changeset
21
2380d476f987 Plugin plugin: add initial unit test
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 #include <irccd/irccd.hpp>
2380d476f987 Plugin plugin: add initial unit test
David Demelier <markand@malikania.fr>
parents:
diff changeset
23 #include <irccd/logger.hpp>
2380d476f987 Plugin plugin: add initial unit test
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 #include <irccd/server.hpp>
350
287e9ede5eef Tests: unbreak some
David Demelier <markand@malikania.fr>
parents: 256
diff changeset
25 #include <irccd/service.hpp>
521
e03521cf207b Common: split util.hpp into more appropriate files, closes #721
David Demelier <markand@malikania.fr>
parents: 494
diff changeset
26 #include <irccd/string_util.hpp>
350
287e9ede5eef Tests: unbreak some
David Demelier <markand@malikania.fr>
parents: 256
diff changeset
27
487
beb6c638b841 Tests: create plugin_test fixture, closes #677
David Demelier <markand@malikania.fr>
parents: 486
diff changeset
28 #include "plugin_test.hpp"
166
2380d476f987 Plugin plugin: add initial unit test
David Demelier <markand@malikania.fr>
parents:
diff changeset
29
489
349fe29d86d5 Tests: switch to Boost, closes #680
David Demelier <markand@malikania.fr>
parents: 488
diff changeset
30 namespace irccd {
166
2380d476f987 Plugin plugin: add initial unit test
David Demelier <markand@malikania.fr>
parents:
diff changeset
31
487
beb6c638b841 Tests: create plugin_test fixture, closes #677
David Demelier <markand@malikania.fr>
parents: 486
diff changeset
32 class fake_plugin : public plugin {
166
2380d476f987 Plugin plugin: add initial unit test
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 public:
487
beb6c638b841 Tests: create plugin_test fixture, closes #677
David Demelier <markand@malikania.fr>
parents: 486
diff changeset
34 fake_plugin()
beb6c638b841 Tests: create plugin_test fixture, closes #677
David Demelier <markand@malikania.fr>
parents: 486
diff changeset
35 : plugin("fake", "")
207
6635b9187d71 Irccd: switch to 4 spaces indent, #518
David Demelier <markand@malikania.fr>
parents: 166
diff changeset
36 {
487
beb6c638b841 Tests: create plugin_test fixture, closes #677
David Demelier <markand@malikania.fr>
parents: 486
diff changeset
37 set_author("jean");
beb6c638b841 Tests: create plugin_test fixture, closes #677
David Demelier <markand@malikania.fr>
parents: 486
diff changeset
38 set_version("0.0.0.0.0.1");
beb6c638b841 Tests: create plugin_test fixture, closes #677
David Demelier <markand@malikania.fr>
parents: 486
diff changeset
39 set_license("BEER");
beb6c638b841 Tests: create plugin_test fixture, closes #677
David Demelier <markand@malikania.fr>
parents: 486
diff changeset
40 set_summary("Fake White Beer 2000");
207
6635b9187d71 Irccd: switch to 4 spaces indent, #518
David Demelier <markand@malikania.fr>
parents: 166
diff changeset
41 }
166
2380d476f987 Plugin plugin: add initial unit test
David Demelier <markand@malikania.fr>
parents:
diff changeset
42 };
2380d476f987 Plugin plugin: add initial unit test
David Demelier <markand@malikania.fr>
parents:
diff changeset
43
489
349fe29d86d5 Tests: switch to Boost, closes #680
David Demelier <markand@malikania.fr>
parents: 488
diff changeset
44 class test_fixture : public plugin_test {
166
2380d476f987 Plugin plugin: add initial unit test
David Demelier <markand@malikania.fr>
parents:
diff changeset
45 public:
489
349fe29d86d5 Tests: switch to Boost, closes #680
David Demelier <markand@malikania.fr>
parents: 488
diff changeset
46 test_fixture()
487
beb6c638b841 Tests: create plugin_test fixture, closes #677
David Demelier <markand@malikania.fr>
parents: 486
diff changeset
47 : plugin_test(PLUGIN_NAME, PLUGIN_PATH)
207
6635b9187d71 Irccd: switch to 4 spaces indent, #518
David Demelier <markand@malikania.fr>
parents: 166
diff changeset
48 {
487
beb6c638b841 Tests: create plugin_test fixture, closes #677
David Demelier <markand@malikania.fr>
parents: 486
diff changeset
49 irccd_.plugins().add(std::make_shared<fake_plugin>());
beb6c638b841 Tests: create plugin_test fixture, closes #677
David Demelier <markand@malikania.fr>
parents: 486
diff changeset
50
beb6c638b841 Tests: create plugin_test fixture, closes #677
David Demelier <markand@malikania.fr>
parents: 486
diff changeset
51 plugin_->set_formats({
207
6635b9187d71 Irccd: switch to 4 spaces indent, #518
David Demelier <markand@malikania.fr>
parents: 166
diff changeset
52 { "usage", "usage=#{plugin}:#{command}:#{server}:#{channel}:#{origin}:#{nickname}" },
6635b9187d71 Irccd: switch to 4 spaces indent, #518
David Demelier <markand@malikania.fr>
parents: 166
diff changeset
53 { "info", "info=#{plugin}:#{command}:#{server}:#{channel}:#{origin}:#{nickname}:#{author}:#{license}:#{name}:#{summary}:#{version}" },
6635b9187d71 Irccd: switch to 4 spaces indent, #518
David Demelier <markand@malikania.fr>
parents: 166
diff changeset
54 { "not-found", "not-found=#{plugin}:#{command}:#{server}:#{channel}:#{origin}:#{nickname}:#{name}" },
6635b9187d71 Irccd: switch to 4 spaces indent, #518
David Demelier <markand@malikania.fr>
parents: 166
diff changeset
55 { "too-long", "too-long=#{plugin}:#{command}:#{server}:#{channel}:#{origin}:#{nickname}" }
6635b9187d71 Irccd: switch to 4 spaces indent, #518
David Demelier <markand@malikania.fr>
parents: 166
diff changeset
56 });
487
beb6c638b841 Tests: create plugin_test fixture, closes #677
David Demelier <markand@malikania.fr>
parents: 486
diff changeset
57 plugin_->on_load(irccd_);
207
6635b9187d71 Irccd: switch to 4 spaces indent, #518
David Demelier <markand@malikania.fr>
parents: 166
diff changeset
58 }
166
2380d476f987 Plugin plugin: add initial unit test
David Demelier <markand@malikania.fr>
parents:
diff changeset
59 };
2380d476f987 Plugin plugin: add initial unit test
David Demelier <markand@malikania.fr>
parents:
diff changeset
60
489
349fe29d86d5 Tests: switch to Boost, closes #680
David Demelier <markand@malikania.fr>
parents: 488
diff changeset
61 BOOST_FIXTURE_TEST_SUITE(test_fixture_suite, test_fixture)
349fe29d86d5 Tests: switch to Boost, closes #680
David Demelier <markand@malikania.fr>
parents: 488
diff changeset
62
349fe29d86d5 Tests: switch to Boost, closes #680
David Demelier <markand@malikania.fr>
parents: 488
diff changeset
63 BOOST_AUTO_TEST_CASE(format_usage)
166
2380d476f987 Plugin plugin: add initial unit test
David Demelier <markand@malikania.fr>
parents:
diff changeset
64 {
489
349fe29d86d5 Tests: switch to Boost, closes #680
David Demelier <markand@malikania.fr>
parents: 488
diff changeset
65 nlohmann::json cmd;
349fe29d86d5 Tests: switch to Boost, closes #680
David Demelier <markand@malikania.fr>
parents: 488
diff changeset
66
488
7e273b7f4f92 Irccd: new coding style, closes #576
David Demelier <markand@malikania.fr>
parents: 487
diff changeset
67 plugin_->on_command(irccd_, {server_, "jean!jean@localhost", "#staff", ""});
489
349fe29d86d5 Tests: switch to Boost, closes #680
David Demelier <markand@malikania.fr>
parents: 488
diff changeset
68 cmd = server_->cqueue().front();
349fe29d86d5 Tests: switch to Boost, closes #680
David Demelier <markand@malikania.fr>
parents: 488
diff changeset
69
349fe29d86d5 Tests: switch to Boost, closes #680
David Demelier <markand@malikania.fr>
parents: 488
diff changeset
70 BOOST_REQUIRE_EQUAL(cmd["command"].get<std::string>(), "message");
349fe29d86d5 Tests: switch to Boost, closes #680
David Demelier <markand@malikania.fr>
parents: 488
diff changeset
71 BOOST_REQUIRE_EQUAL(cmd["target"].get<std::string>(), "#staff");
349fe29d86d5 Tests: switch to Boost, closes #680
David Demelier <markand@malikania.fr>
parents: 488
diff changeset
72 BOOST_REQUIRE_EQUAL(cmd["message"].get<std::string>(), "usage=plugin:!plugin:test:#staff:jean!jean@localhost:jean");
166
2380d476f987 Plugin plugin: add initial unit test
David Demelier <markand@malikania.fr>
parents:
diff changeset
73
488
7e273b7f4f92 Irccd: new coding style, closes #576
David Demelier <markand@malikania.fr>
parents: 487
diff changeset
74 plugin_->on_command(irccd_, {server_, "jean!jean@localhost", "#staff", "fail"});
489
349fe29d86d5 Tests: switch to Boost, closes #680
David Demelier <markand@malikania.fr>
parents: 488
diff changeset
75 cmd = server_->cqueue().front();
349fe29d86d5 Tests: switch to Boost, closes #680
David Demelier <markand@malikania.fr>
parents: 488
diff changeset
76
349fe29d86d5 Tests: switch to Boost, closes #680
David Demelier <markand@malikania.fr>
parents: 488
diff changeset
77 BOOST_REQUIRE_EQUAL(cmd["command"].get<std::string>(), "message");
349fe29d86d5 Tests: switch to Boost, closes #680
David Demelier <markand@malikania.fr>
parents: 488
diff changeset
78 BOOST_REQUIRE_EQUAL(cmd["target"].get<std::string>(), "#staff");
349fe29d86d5 Tests: switch to Boost, closes #680
David Demelier <markand@malikania.fr>
parents: 488
diff changeset
79 BOOST_REQUIRE_EQUAL(cmd["message"].get<std::string>(), "usage=plugin:!plugin:test:#staff:jean!jean@localhost:jean");
166
2380d476f987 Plugin plugin: add initial unit test
David Demelier <markand@malikania.fr>
parents:
diff changeset
80
488
7e273b7f4f92 Irccd: new coding style, closes #576
David Demelier <markand@malikania.fr>
parents: 487
diff changeset
81 plugin_->on_command(irccd_, {server_, "jean!jean@localhost", "#staff", "info"});
489
349fe29d86d5 Tests: switch to Boost, closes #680
David Demelier <markand@malikania.fr>
parents: 488
diff changeset
82 cmd = server_->cqueue().front();
349fe29d86d5 Tests: switch to Boost, closes #680
David Demelier <markand@malikania.fr>
parents: 488
diff changeset
83
349fe29d86d5 Tests: switch to Boost, closes #680
David Demelier <markand@malikania.fr>
parents: 488
diff changeset
84 BOOST_REQUIRE_EQUAL(cmd["command"].get<std::string>(), "message");
349fe29d86d5 Tests: switch to Boost, closes #680
David Demelier <markand@malikania.fr>
parents: 488
diff changeset
85 BOOST_REQUIRE_EQUAL(cmd["target"].get<std::string>(), "#staff");
349fe29d86d5 Tests: switch to Boost, closes #680
David Demelier <markand@malikania.fr>
parents: 488
diff changeset
86 BOOST_REQUIRE_EQUAL(cmd["message"].get<std::string>(), "usage=plugin:!plugin:test:#staff:jean!jean@localhost:jean");
166
2380d476f987 Plugin plugin: add initial unit test
David Demelier <markand@malikania.fr>
parents:
diff changeset
87 }
2380d476f987 Plugin plugin: add initial unit test
David Demelier <markand@malikania.fr>
parents:
diff changeset
88
489
349fe29d86d5 Tests: switch to Boost, closes #680
David Demelier <markand@malikania.fr>
parents: 488
diff changeset
89 BOOST_AUTO_TEST_CASE(format_info)
166
2380d476f987 Plugin plugin: add initial unit test
David Demelier <markand@malikania.fr>
parents:
diff changeset
90 {
488
7e273b7f4f92 Irccd: new coding style, closes #576
David Demelier <markand@malikania.fr>
parents: 487
diff changeset
91 plugin_->on_command(irccd_, {server_, "jean!jean@localhost", "#staff", "info fake"});
166
2380d476f987 Plugin plugin: add initial unit test
David Demelier <markand@malikania.fr>
parents:
diff changeset
92
489
349fe29d86d5 Tests: switch to Boost, closes #680
David Demelier <markand@malikania.fr>
parents: 488
diff changeset
93 auto cmd = server_->cqueue().front();
349fe29d86d5 Tests: switch to Boost, closes #680
David Demelier <markand@malikania.fr>
parents: 488
diff changeset
94
349fe29d86d5 Tests: switch to Boost, closes #680
David Demelier <markand@malikania.fr>
parents: 488
diff changeset
95 BOOST_REQUIRE_EQUAL(cmd["command"].get<std::string>(), "message");
349fe29d86d5 Tests: switch to Boost, closes #680
David Demelier <markand@malikania.fr>
parents: 488
diff changeset
96 BOOST_REQUIRE_EQUAL(cmd["target"].get<std::string>(), "#staff");
349fe29d86d5 Tests: switch to Boost, closes #680
David Demelier <markand@malikania.fr>
parents: 488
diff changeset
97 BOOST_REQUIRE_EQUAL(cmd["message"].get<std::string>(), "info=plugin:!plugin:test:#staff:jean!jean@localhost:jean:jean:BEER:fake:Fake White Beer 2000:0.0.0.0.0.1");
166
2380d476f987 Plugin plugin: add initial unit test
David Demelier <markand@malikania.fr>
parents:
diff changeset
98 }
2380d476f987 Plugin plugin: add initial unit test
David Demelier <markand@malikania.fr>
parents:
diff changeset
99
489
349fe29d86d5 Tests: switch to Boost, closes #680
David Demelier <markand@malikania.fr>
parents: 488
diff changeset
100 BOOST_AUTO_TEST_CASE(format_not_found)
166
2380d476f987 Plugin plugin: add initial unit test
David Demelier <markand@malikania.fr>
parents:
diff changeset
101 {
488
7e273b7f4f92 Irccd: new coding style, closes #576
David Demelier <markand@malikania.fr>
parents: 487
diff changeset
102 plugin_->on_command(irccd_, {server_, "jean!jean@localhost", "#staff", "info doesnotexistsihope"});
166
2380d476f987 Plugin plugin: add initial unit test
David Demelier <markand@malikania.fr>
parents:
diff changeset
103
489
349fe29d86d5 Tests: switch to Boost, closes #680
David Demelier <markand@malikania.fr>
parents: 488
diff changeset
104 auto cmd = server_->cqueue().front();
349fe29d86d5 Tests: switch to Boost, closes #680
David Demelier <markand@malikania.fr>
parents: 488
diff changeset
105
349fe29d86d5 Tests: switch to Boost, closes #680
David Demelier <markand@malikania.fr>
parents: 488
diff changeset
106 BOOST_REQUIRE_EQUAL(cmd["command"].get<std::string>(), "message");
349fe29d86d5 Tests: switch to Boost, closes #680
David Demelier <markand@malikania.fr>
parents: 488
diff changeset
107 BOOST_REQUIRE_EQUAL(cmd["target"].get<std::string>(), "#staff");
349fe29d86d5 Tests: switch to Boost, closes #680
David Demelier <markand@malikania.fr>
parents: 488
diff changeset
108 BOOST_REQUIRE_EQUAL(cmd["message"].get<std::string>(), "not-found=plugin:!plugin:test:#staff:jean!jean@localhost:jean:doesnotexistsihope");
166
2380d476f987 Plugin plugin: add initial unit test
David Demelier <markand@malikania.fr>
parents:
diff changeset
109 }
2380d476f987 Plugin plugin: add initial unit test
David Demelier <markand@malikania.fr>
parents:
diff changeset
110
489
349fe29d86d5 Tests: switch to Boost, closes #680
David Demelier <markand@malikania.fr>
parents: 488
diff changeset
111 BOOST_AUTO_TEST_CASE(format_too_long)
166
2380d476f987 Plugin plugin: add initial unit test
David Demelier <markand@malikania.fr>
parents:
diff changeset
112 {
207
6635b9187d71 Irccd: switch to 4 spaces indent, #518
David Demelier <markand@malikania.fr>
parents: 166
diff changeset
113 for (int i = 0; i < 100; ++i)
521
e03521cf207b Common: split util.hpp into more appropriate files, closes #721
David Demelier <markand@malikania.fr>
parents: 494
diff changeset
114 irccd_.plugins().add(std::make_shared<plugin>(string_util::sprintf("plugin-n-%d", i), ""));
166
2380d476f987 Plugin plugin: add initial unit test
David Demelier <markand@malikania.fr>
parents:
diff changeset
115
488
7e273b7f4f92 Irccd: new coding style, closes #576
David Demelier <markand@malikania.fr>
parents: 487
diff changeset
116 plugin_->on_command(irccd_, {server_, "jean!jean@localhost", "#staff", "list"});
166
2380d476f987 Plugin plugin: add initial unit test
David Demelier <markand@malikania.fr>
parents:
diff changeset
117
489
349fe29d86d5 Tests: switch to Boost, closes #680
David Demelier <markand@malikania.fr>
parents: 488
diff changeset
118 auto cmd = server_->cqueue().front();
349fe29d86d5 Tests: switch to Boost, closes #680
David Demelier <markand@malikania.fr>
parents: 488
diff changeset
119
349fe29d86d5 Tests: switch to Boost, closes #680
David Demelier <markand@malikania.fr>
parents: 488
diff changeset
120 BOOST_REQUIRE_EQUAL(cmd["command"].get<std::string>(), "message");
349fe29d86d5 Tests: switch to Boost, closes #680
David Demelier <markand@malikania.fr>
parents: 488
diff changeset
121 BOOST_REQUIRE_EQUAL(cmd["target"].get<std::string>(), "#staff");
349fe29d86d5 Tests: switch to Boost, closes #680
David Demelier <markand@malikania.fr>
parents: 488
diff changeset
122 BOOST_REQUIRE_EQUAL(cmd["message"].get<std::string>(), "too-long=plugin:!plugin:test:#staff:jean!jean@localhost:jean");
166
2380d476f987 Plugin plugin: add initial unit test
David Demelier <markand@malikania.fr>
parents:
diff changeset
123 }
2380d476f987 Plugin plugin: add initial unit test
David Demelier <markand@malikania.fr>
parents:
diff changeset
124
489
349fe29d86d5 Tests: switch to Boost, closes #680
David Demelier <markand@malikania.fr>
parents: 488
diff changeset
125 BOOST_AUTO_TEST_SUITE_END()
166
2380d476f987 Plugin plugin: add initial unit test
David Demelier <markand@malikania.fr>
parents:
diff changeset
126
489
349fe29d86d5 Tests: switch to Boost, closes #680
David Demelier <markand@malikania.fr>
parents: 488
diff changeset
127 } // !irccd