/* * test-irc-protocol.cpp - test IRC protocol functions * * Copyright (C) 2019-2020 Sébastien Helleu * * This file is part of WeeChat, the extensible chat client. * * WeeChat is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 3 of the License, or * (at your option) any later version. * * WeeChat is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with WeeChat. If not, see . */ #include "CppUTest/TestHarness.h" extern "C" { #include "src/core/wee-config-file.h" #include "src/core/wee-hashtable.h" #include "src/gui/gui-color.h" #include "src/plugins/irc/irc-protocol.h" #include "src/plugins/irc/irc-channel.h" #include "src/plugins/irc/irc-config.h" #include "src/plugins/irc/irc-nick.h" #include "src/plugins/irc/irc-server.h" extern int irc_protocol_is_numeric_command (const char *str); extern int irc_protocol_log_level_for_command (const char *command); extern const char *irc_protocol_nick_address (struct t_irc_server *server, int server_message, struct t_irc_nick *nick, const char *nickname, const char *address); } #include "tests/tests.h" #define IRC_FAKE_SERVER "fake" #define IRC_MSG_005 "PREFIX=(ohv)@%+ MAXLIST=bqeI:100 MODES=4 " \ "NETWORK=StaticBox STATUSMSG=@+ CALLERID=g " \ "CASEMAPPING=strict-rfc1459 NICKLEN=30 MAXNICKLEN=31 " \ "USERLEN=16 HOSTLEN=32 CHANNELLEN=50 TOPICLEN=390 DEAF=D " \ "CHANTYPES=# CHANMODES=eIbq,k,flj,CFLMPQScgimnprstuz " \ "MONITOR=100" struct t_irc_server *ptr_server; TEST_GROUP(IrcProtocol) { }; /* * Tests functions: * irc_protocol_is_numeric_command */ TEST(IrcProtocol, IsNumericCommand) { LONGS_EQUAL(0, irc_protocol_is_numeric_command (NULL)); LONGS_EQUAL(0, irc_protocol_is_numeric_command ("")); LONGS_EQUAL(0, irc_protocol_is_numeric_command ("abc")); LONGS_EQUAL(1, irc_protocol_is_numeric_command ("0")); LONGS_EQUAL(1, irc_protocol_is_numeric_command ("1")); LONGS_EQUAL(1, irc_protocol_is_numeric_command ("12")); LONGS_EQUAL(1, irc_protocol_is_numeric_command ("123")); } /* * Tests functions: * irc_protocol_log_level_for_command */ TEST(IrcProtocol, LogLevelForCommand) { LONGS_EQUAL(0, irc_protocol_log_level_for_command (NULL)); LONGS_EQUAL(0, irc_protocol_log_level_for_command ("")); LONGS_EQUAL(1, irc_protocol_log_level_for_command ("privmsg")); LONGS_EQUAL(1, irc_protocol_log_level_for_command ("notice")); LONGS_EQUAL(2, irc_protocol_log_level_for_command ("nick")); LONGS_EQUAL(4, irc_protocol_log_level_for_command ("join")); LONGS_EQUAL(4, irc_protocol_log_level_for_command ("part")); LONGS_EQUAL(4, irc_protocol_log_level_for_command ("quit")); LONGS_EQUAL(4, irc_protocol_log_level_for_command ("nick_back")); LONGS_EQUAL(3, irc_protocol_log_level_for_command ("001")); LONGS_EQUAL(3, irc_protocol_log_level_for_command ("away")); LONGS_EQUAL(3, irc_protocol_log_level_for_command ("kick")); LONGS_EQUAL(3, irc_protocol_log_level_for_command ("topic")); } /* * Tests functions: * irc_protocol_tags */ TEST(IrcProtocol, Tags) { POINTERS_EQUAL(NULL, irc_protocol_tags (NULL, NULL, NULL, NULL)); /* command */ STRCMP_EQUAL("irc_privmsg,log1", irc_protocol_tags ("privmsg", NULL, NULL, NULL)); STRCMP_EQUAL("irc_join,log4", irc_protocol_tags ("join", NULL, NULL, NULL)); /* command and empty tags */ STRCMP_EQUAL("irc_privmsg,log1", irc_protocol_tags ("privmsg", "", NULL, NULL)); STRCMP_EQUAL("irc_join,log4", irc_protocol_tags ("join", "", NULL, NULL)); /* command and tags */ STRCMP_EQUAL("irc_privmsg,tag1,tag2,log1", irc_protocol_tags ("privmsg", "tag1,tag2", NULL, NULL)); STRCMP_EQUAL("irc_join,tag1,tag2,log4", irc_protocol_tags ("join", "tag1,tag2", NULL, NULL)); /* command, tags and empty nick */ STRCMP_EQUAL("irc_privmsg,tag1,tag2,log1", irc_protocol_tags ("privmsg", "tag1,tag2", "", NULL)); STRCMP_EQUAL("irc_join,tag1,tag2,log4", irc_protocol_tags ("join", "tag1,tag2", "", NULL)); /* command, tags and nick */ STRCMP_EQUAL("irc_privmsg,tag1,tag2,nick_alice,log1", irc_protocol_tags ("privmsg", "tag1,tag2", "alice", NULL)); STRCMP_EQUAL("irc_join,tag1,tag2,nick_bob,log4", irc_protocol_tags ("join", "tag1,tag2", "bob", NULL)); /* command, tags, nick and empty address */ STRCMP_EQUAL("irc_privmsg,tag1,tag2,nick_alice,log1", irc_protocol_tags ("privmsg", "tag1,tag2", "alice", "")); STRCMP_EQUAL("irc_join,tag1,tag2,nick_bob,log4", irc_protocol_tags ("join", "tag1,tag2", "bob", "")); /* command, tags, nick and address */ STRCMP_EQUAL("irc_privmsg,tag1,tag2,nick_alice,host_example.com,log1", irc_protocol_tags ("privmsg", "tag1,tag2", "alice", "example.com")); STRCMP_EQUAL("irc_join,tag1,tag2,nick_bob,host_example.com,log4", irc_protocol_tags ("join", "tag1,tag2", "bob", "example.com")); } /* * Tests functions: * irc_protocol_parse_time */ TEST(IrcProtocol, ParseTime) { /* invalid time formats */ LONGS_EQUAL(0, irc_protocol_parse_time (NULL)); LONGS_EQUAL(0, irc_protocol_parse_time ("")); LONGS_EQUAL(0, irc_protocol_parse_time ("invalid")); /* incomplete time formats */ LONGS_EQUAL(0, irc_protocol_parse_time ("2019-01")); LONGS_EQUAL(0, irc_protocol_parse_time ("2019-01-13")); LONGS_EQUAL(0, irc_protocol_parse_time ("2019-01-13T14")); LONGS_EQUAL(0, irc_protocol_parse_time ("2019-01-13T14:37")); /* valid time with ISO 8601 format*/ LONGS_EQUAL(1547386699, irc_protocol_parse_time ("2019-01-13T13:38:19.123Z")); LONGS_EQUAL(1547386699, irc_protocol_parse_time ("2019-01-13T13:38:19.123")); LONGS_EQUAL(1547386699, irc_protocol_parse_time ("2019-01-13T13:38:19")); /* valid time as timestamp */ LONGS_EQUAL(1547386699, irc_protocol_parse_time ("1547386699.123")); LONGS_EQUAL(1547386699, irc_protocol_parse_time ("1547386699")); } TEST_GROUP(IrcProtocolWithServer) { void run_cmd_server (const char *command) { char str_command[4096]; snprintf (str_command, sizeof (str_command), "/command -buffer irc.server." IRC_FAKE_SERVER " irc %s", command); run_cmd (str_command); } void setup () { printf ("\n"); /* create a fake server (no I/O) */ run_cmd ("/server add " IRC_FAKE_SERVER " fake:127.0.0.1 " "-nicks=nick1,nick2,nick3"); /* connect to the fake server */ run_cmd ("/connect " IRC_FAKE_SERVER); /* get the server pointer */ ptr_server = irc_server_search (IRC_FAKE_SERVER); } void teardown () { /* disconnect and delete the fake server */ run_cmd ("/disconnect " IRC_FAKE_SERVER); run_cmd ("/server del " IRC_FAKE_SERVER); ptr_server = NULL; } }; /* * Tests functions: * irc_protocol_nick_address */ TEST(IrcProtocolWithServer, NickAddress) { struct t_irc_nick *ptr_nick; char result[1024]; run_cmd_server ("/server fakerecv :server 001 alice"); run_cmd ("/command -buffer irc.server." IRC_FAKE_SERVER " irc " "/server fakerecv :alice!user@host JOIN #test"); ptr_nick = ptr_server->channels->nicks; STRCMP_EQUAL("", irc_protocol_nick_address (NULL, 0, NULL, NULL, NULL)); STRCMP_EQUAL("", irc_protocol_nick_address (ptr_server, 0, NULL, NULL, NULL)); STRCMP_EQUAL("", irc_protocol_nick_address (ptr_server, 0, ptr_nick, NULL, NULL)); STRCMP_EQUAL("", irc_protocol_nick_address (ptr_server, 0, ptr_nick, NULL, NULL)); snprintf (result, sizeof (result), "%s%s%s", ptr_nick->color, "alice", gui_color_get_custom ("reset")); STRCMP_EQUAL(result, irc_protocol_nick_address (ptr_server, 0, ptr_nick, "alice", NULL)); snprintf (result, sizeof (result), "%s%s %s(%s%s%s)%s", ptr_nick->color, "alice", gui_color_search_config ("chat_delimiters"), gui_color_search_config ("chat_host"), "example.com", gui_color_search_config ("chat_delimiters"), gui_color_get_custom ("reset")); STRCMP_EQUAL(result, irc_protocol_nick_address (ptr_server, 0, ptr_nick, "alice", "example.com")); config_file_option_set (irc_config_look_color_nicks_in_server_messages, "off", 1); snprintf (result, sizeof (result), "%s%s %s(%s%s%s)%s", ptr_nick->color, "alice", gui_color_search_config ("chat_delimiters"), gui_color_search_config ("chat_host"), "example.com", gui_color_search_config ("chat_delimiters"), gui_color_get_custom ("reset")); STRCMP_EQUAL(result, irc_protocol_nick_address (ptr_server, 0, ptr_nick, "alice", "example.com")); snprintf (result, sizeof (result), "%s%s %s(%s%s%s)%s", gui_color_search_config ("chat_nick"), "alice", gui_color_search_config ("chat_delimiters"), gui_color_search_config ("chat_host"), "example.com", gui_color_search_config ("chat_delimiters"), gui_color_get_custom ("reset")); STRCMP_EQUAL(result, irc_protocol_nick_address (ptr_server, 1, ptr_nick, "alice", "example.com")); config_file_option_reset (irc_config_look_color_nicks_in_server_messages, 0); } /* * Tests functions: * irc_protocol_cb_account (without account-notify capability) */ TEST(IrcProtocolWithServer, account_without_account_notify_cap) { struct t_irc_nick *ptr_nick; run_cmd_server ("/server fakerecv :server 001 alice"); run_cmd ("/command -buffer irc.server." IRC_FAKE_SERVER " irc " "/server fakerecv :alice!user@host JOIN #test"); ptr_nick = ptr_server->channels->nicks; POINTERS_EQUAL(NULL, ptr_nick->account); run_cmd_server ("/server fakerecv :alice!user@host ACCOUNT *"); POINTERS_EQUAL(NULL, ptr_nick->account); run_cmd_server ("/server fakerecv :alice!user@host ACCOUNT new_account"); POINTERS_EQUAL(NULL, ptr_nick->account); } /* * Tests functions: * irc_protocol_cb_account (with account-notify capability) */ TEST(IrcProtocolWithServer, account_with_account_notify_cap) { struct t_irc_nick *ptr_nick; /* assume "account-notify" capability is enabled in server */ hashtable_set (ptr_server->cap_list, "account-notify", NULL); run_cmd_server ("/server fakerecv :server 001 alice"); run_cmd ("/command -buffer irc.server." IRC_FAKE_SERVER " irc " "/server fakerecv :alice!user@host JOIN #test"); ptr_nick = ptr_server->channels->nicks; POINTERS_EQUAL(NULL, ptr_nick->account); run_cmd_server ("/server fakerecv :alice!user@host ACCOUNT new_account"); STRCMP_EQUAL("new_account", ptr_nick->account); run_cmd_server ("/server fakerecv :alice!user@host ACCOUNT new_account2"); STRCMP_EQUAL("new_account2", ptr_nick->account); run_cmd_server ("/server fakerecv :alice!user@host ACCOUNT *"); POINTERS_EQUAL(NULL, ptr_nick->account); } /* * Tests functions: * irc_protocol_cb_away */ TEST(IrcProtocolWithServer, away) { struct t_irc_nick *ptr_nick; run_cmd_server ("/server fakerecv :server 001 alice"); run_cmd ("/command -buffer irc.server." IRC_FAKE_SERVER " irc " "/server fakerecv :alice!user@host JOIN #test"); ptr_nick = ptr_server->channels->nicks; LONGS_EQUAL(0, ptr_nick->away); run_cmd_server ("/server fakerecv :alice!user@host AWAY :Holidays!"); LONGS_EQUAL(1, ptr_nick->away); } /* * Tests functions: * irc_protocol_cb_001 (empty) */ TEST(IrcProtocolWithServer, 001_empty) { LONGS_EQUAL(0, ptr_server->is_connected); STRCMP_EQUAL("nick1", ptr_server->nick); run_cmd_server ("/server fakerecv :server 001 alice"); LONGS_EQUAL(1, ptr_server->is_connected); STRCMP_EQUAL("alice", ptr_server->nick); } /* * Tests functions: * irc_protocol_cb_001 (welcome) */ TEST(IrcProtocolWithServer, 001_welcome) { run_cmd ("/set irc.server." IRC_FAKE_SERVER ".autojoin \"#autojoin1\""); run_cmd ("/set irc.server." IRC_FAKE_SERVER ".command " "\"/join #test1;/join #test2;/query remote_nick\""); LONGS_EQUAL(0, ptr_server->is_connected); STRCMP_EQUAL("nick1", ptr_server->nick); run_cmd_server ("/server fakerecv :server 001 alice " ":Welcome on this server!"); LONGS_EQUAL(1, ptr_server->is_connected); STRCMP_EQUAL("alice", ptr_server->nick); CHECK(ptr_server->channels); STRCMP_EQUAL("remote_nick", ptr_server->channels->name); } /* * Tests functions: * irc_protocol_cb_005 (empty) */ TEST(IrcProtocolWithServer, 005_empty) { run_cmd_server ("/server fakerecv :server 001 alice"); POINTERS_EQUAL(NULL, ptr_server->prefix_modes); POINTERS_EQUAL(NULL, ptr_server->prefix_chars); run_cmd_server ("/server fakerecv :server 005 alice TEST=A"); POINTERS_EQUAL(NULL, ptr_server->prefix_modes); POINTERS_EQUAL(NULL, ptr_server->prefix_chars); } /* * Tests functions: * irc_protocol_cb_005 (full) */ TEST(IrcProtocolWithServer, 005_full) { run_cmd_server ("/server fakerecv :server 001 alice"); POINTERS_EQUAL(NULL, ptr_server->prefix_modes); POINTERS_EQUAL(NULL, ptr_server->prefix_chars); LONGS_EQUAL(0, ptr_server->nick_max_length); LONGS_EQUAL(0, ptr_server->user_max_length); LONGS_EQUAL(0, ptr_server->host_max_length); LONGS_EQUAL(0, ptr_server->casemapping); POINTERS_EQUAL(NULL, ptr_server->chantypes); POINTERS_EQUAL(NULL, ptr_server->chanmodes); LONGS_EQUAL(0, ptr_server->monitor); POINTERS_EQUAL(NULL, ptr_server->isupport); run_cmd_server ("/server fakerecv :server 005 alice " IRC_MSG_005 " " ":are supported by this server"); STRCMP_EQUAL("ohv", ptr_server->prefix_modes); STRCMP_EQUAL("@%+", ptr_server->prefix_chars); LONGS_EQUAL(30, ptr_server->nick_max_length); LONGS_EQUAL(16, ptr_server->user_max_length); LONGS_EQUAL(32, ptr_server->host_max_length); LONGS_EQUAL(1, ptr_server->casemapping); STRCMP_EQUAL("#", ptr_server->chantypes); STRCMP_EQUAL("eIbq,k,flj,CFLMPQScgimnprstuz", ptr_server->chanmodes); LONGS_EQUAL(100, ptr_server->monitor); CHECK(ptr_server->isupport[0] == ' '); STRCMP_EQUAL(IRC_MSG_005, ptr_server->isupport + 1); } /* * Tests functions: * irc_protocol_cb_005 (multiple messages) */ TEST(IrcProtocolWithServer, 005_multiple_messages) { run_cmd_server ("/server fakerecv :server 001 alice"); POINTERS_EQUAL(NULL, ptr_server->prefix_modes); POINTERS_EQUAL(NULL, ptr_server->prefix_chars); LONGS_EQUAL(0, ptr_server->host_max_length); POINTERS_EQUAL(NULL, ptr_server->isupport); run_cmd_server ("/server fakerecv :server 005 alice " "PREFIX=(ohv)@%+ " ":are supported by this server"); run_cmd_server ("/server fakerecv :server 005 alice " "HOSTLEN=24 " ":are supported by this server"); STRCMP_EQUAL("ohv", ptr_server->prefix_modes); STRCMP_EQUAL("@%+", ptr_server->prefix_chars); LONGS_EQUAL(24, ptr_server->host_max_length); STRCMP_EQUAL(" PREFIX=(ohv)@%+ HOSTLEN=24", ptr_server->isupport); }