tests: add tests on modifier hook

ChangeLog.adoc

@@ -31,6 +31,10 @@ Bug fixes::
   * api: fix memory leak in function string_split
   * scripts: fix duplicated lines in output of script eval (python, perl, ruby, lua and guile)
 
+Tests::
+
+  * unit: add tests on line and hook functions
+
 [[v2.2]]
 == Version 2.2 (2018-07-14)
 

tests/CMakeLists.txt

@@ -29,6 +29,7 @@ set(LIB_WEECHAT_UNIT_TESTS_SRC
   unit/core/test-eval.cpp
   unit/core/test-hashtable.cpp
   unit/core/test-hdata.cpp
+  unit/core/test-hook.cpp
   unit/core/test-infolist.cpp
   unit/core/test-list.cpp
   unit/core/test-string.cpp

tests/Makefile.am

@@ -26,6 +26,7 @@ lib_weechat_unit_tests_a_SOURCES = unit/test-plugins.cpp \
                                    unit/core/test-eval.cpp \
                                    unit/core/test-hashtable.cpp \
                                    unit/core/test-hdata.cpp \
+                                   unit/core/test-hook.cpp \
                                    unit/core/test-infolist.cpp \
                                    unit/core/test-list.cpp \
                                    unit/core/test-string.cpp \

tests/tests.cpp

@@ -59,6 +59,7 @@ IMPORT_TEST_GROUP(CoreArraylist);
 IMPORT_TEST_GROUP(CoreEval);
 IMPORT_TEST_GROUP(CoreHashtable);
 IMPORT_TEST_GROUP(CoreHdata);
+IMPORT_TEST_GROUP(CoreHook);
 IMPORT_TEST_GROUP(CoreInfolist);
 IMPORT_TEST_GROUP(CoreList);
 IMPORT_TEST_GROUP(CoreString);
@@ -105,6 +106,10 @@ test_print_cb (const void *pointer, void *data, struct t_gui_buffer *buffer,
     (void) displayed;
     (void) highlight;
 
+    /* keep only messages displayed on core buffer */
+    if (strcmp (gui_buffer_get_string (buffer, "full_name"), "core.weechat") != 0)
+        return WEECHAT_RC_OK;
+
     printf ("%s%s%s\n",  /* with color: "\33[34m%s%s%s\33[0m\n" */
             (prefix && prefix[0]) ? prefix : "",
             (prefix && prefix[0]) ? " " : "",

tests/unit/core/test-hook.cpp

@@ -0,0 +1,389 @@
+/*
+ * test-hook.cpp - test hook functions
+ *
+ * Copyright (C) 2018 Sébastien Helleu <flashcode@flashtux.org>
+ *
+ * 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 <http://www.gnu.org/licenses/>.
+ */
+
+#include "CppUTest/TestHarness.h"
+
+extern "C"
+{
+#include <string.h>
+#include "src/core/wee-hook.h"
+#include "src/core/wee-string.h"
+#include "src/gui/gui-buffer.h"
+#include "src/gui/gui-chat.h"
+#include "src/gui/gui-line.h"
+}
+
+#define TEST_BUFFER_NAME "test"
+
+TEST_GROUP(CoreHook)
+{
+};
+
+/*
+ * Tests functions:
+ *   hook_command_run
+ */
+
+TEST(CoreHook, CommandRun)
+{
+    /* TODO: write tests */
+}
+
+/*
+ * Tests functions:
+ *   hook_command
+ */
+
+TEST(CoreHook, Command)
+{
+    /* TODO: write tests */
+}
+
+/*
+ * Tests functions:
+ *   hook_completion
+ */
+
+TEST(CoreHook, Completion)
+{
+    /* TODO: write tests */
+}
+
+/*
+ * Tests functions:
+ *   hook_config
+ */
+
+TEST(CoreHook, Config)
+{
+    /* TODO: write tests */
+}
+
+/*
+ * Tests functions:
+ *   hook_connect
+ */
+
+TEST(CoreHook, Connect)
+{
+    /* TODO: write tests */
+}
+
+/*
+ * Tests functions:
+ *   hook_fd
+ */
+
+TEST(CoreHook, Fd)
+{
+    /* TODO: write tests */
+}
+
+/*
+ * Tests functions:
+ *   hook_focus
+ */
+
+TEST(CoreHook, Focus)
+{
+    /* TODO: write tests */
+}
+
+/*
+ * Tests functions:
+ *   hook_hdata
+ */
+
+TEST(CoreHook, Hdata)
+{
+    /* TODO: write tests */
+}
+
+/*
+ * Tests functions:
+ *   hook_hsignal
+ */
+
+TEST(CoreHook, Hsignal)
+{
+    /* TODO: write tests */
+}
+
+/*
+ * Tests functions:
+ *   hook_info_hashtable
+ */
+
+TEST(CoreHook, InfoHashtable)
+{
+    /* TODO: write tests */
+}
+
+/*
+ * Tests functions:
+ *   hook_info
+ */
+
+TEST(CoreHook, Info)
+{
+    /* TODO: write tests */
+}
+
+/*
+ * Tests functions:
+ *   hook_infolist
+ */
+
+TEST(CoreHook, Infolist)
+{
+    /* TODO: write tests */
+}
+
+/*
+ * Tests functions:
+ *   hook_line
+ */
+
+TEST(CoreHook, Line)
+{
+    /* TODO: write tests */
+}
+
+char *
+test_modifier_cb (const void *pointer, void *data,
+                  const char *modifier, const char *modifier_data,
+                  const char *string)
+{
+    char **items, *new_string;
+    const char *ptr_plugin, *ptr_name, *ptr_tags, *ptr_msg;
+    int num_items, length;
+
+    /* make C++ compiler happy */
+    (void) pointer;
+    (void) data;
+    (void) modifier;
+
+    /* split modifier_data, which is: "plugin;name;tags" */
+    items = string_split (modifier_data, ";", 0, 3, &num_items);
+    if (num_items < 2)
+        return NULL;
+
+    ptr_plugin = items[0];
+    ptr_name = items[1];
+    ptr_tags = (num_items > 2) ? items[2] : NULL;
+
+    /* do nothing on a buffer different from "core.test" */
+    if ((strcmp (ptr_plugin, "core") != 0)
+        || (strcmp (ptr_name, TEST_BUFFER_NAME) != 0))
+    {
+        return NULL;
+    }
+
+    if (strncmp (string, "\t\t", 2) == 0)
+    {
+        ptr_msg = string + 2;
+    }
+    else
+    {
+        ptr_msg = strchr (string, '\t');
+        if (!ptr_msg)
+            return NULL;
+        ptr_msg++;
+    }
+
+    length = strlen (string) + 128;
+    new_string = (char *)malloc (length);
+    if (!new_string)
+        return NULL;
+    new_string[0] = '\0';
+
+    if (ptr_tags && strstr (ptr_tags, "add_prefix"))
+    {
+        /* add a prefix in message */
+        snprintf (new_string, length, "new prefix\t%s (modified)", ptr_msg);
+    }
+    else if (ptr_tags && strstr (ptr_tags, "add_date_prefix"))
+    {
+        /* add a date/prefix in message */
+        snprintf (new_string, length, "new prefix\t%s (modified)", ptr_msg);
+    }
+    else if (ptr_tags && strstr (ptr_tags, "update_prefix"))
+    {
+        /* update the prefix */
+        snprintf (new_string, length, "new prefix\t%s (modified)", ptr_msg);
+    }
+    else if (ptr_tags && strstr (ptr_tags, "remove_prefix"))
+    {
+        /* remove the prefix */
+        snprintf (new_string, length, " \t%s (modified)", ptr_msg);
+    }
+    else if (ptr_tags && strstr (ptr_tags, "remove_date_prefix"))
+    {
+        /* remove the date/prefix */
+        snprintf (new_string, length, "\t\t%s (modified)", ptr_msg);
+    }
+
+    if (!new_string[0])
+    {
+        /* default message returned: just add " (modified)" to the string */
+        snprintf (new_string, length, "%s (modified)", string);
+    }
+
+    return new_string;
+}
+
+/*
+ * Tests functions:
+ *   hook_modifier
+ */
+
+TEST(CoreHook, Modifier)
+{
+    struct t_gui_buffer *test_buffer;
+    struct t_gui_line *ptr_line;
+    struct t_hook *hook;
+
+    /* create/open a test buffer */
+    test_buffer = gui_buffer_new (NULL, TEST_BUFFER_NAME,
+                                  NULL, NULL, NULL,
+                                  NULL, NULL, NULL);
+    CHECK(test_buffer);
+
+    hook = hook_modifier (NULL, "weechat_print", &test_modifier_cb, NULL, NULL);
+
+    /* check hook contents */
+    CHECK(hook);
+    POINTERS_EQUAL(NULL, hook->plugin);
+    POINTERS_EQUAL(NULL, hook->subplugin);
+    LONGS_EQUAL(HOOK_TYPE_MODIFIER, hook->type);
+    LONGS_EQUAL(0, hook->deleted);
+    LONGS_EQUAL(0, hook->running);
+    LONGS_EQUAL(HOOK_PRIORITY_DEFAULT, hook->priority);
+    POINTERS_EQUAL(NULL, hook->callback_pointer);
+    POINTERS_EQUAL(NULL, hook->callback_data);
+    CHECK(hook->hook_data);
+    POINTERS_EQUAL(&test_modifier_cb, HOOK_MODIFIER(hook, callback));
+    STRCMP_EQUAL("weechat_print", HOOK_MODIFIER(hook, modifier));
+
+    /* message without prefix: unchanged */
+    gui_chat_printf_date_tags (test_buffer, 0, NULL, " \tmessage");
+    ptr_line = test_buffer->own_lines->last_line;
+    CHECK(ptr_line->data->date > 0);
+    STRCMP_EQUAL("", ptr_line->data->prefix);
+    STRCMP_EQUAL("message (modified)", ptr_line->data->message);
+
+    /* message without prefix: add a prefix */
+    gui_chat_printf_date_tags (test_buffer, 0, "add_prefix", " \tmessage");
+    ptr_line = test_buffer->own_lines->last_line;
+    CHECK(ptr_line->data->date > 0);
+    STRCMP_EQUAL("new prefix", ptr_line->data->prefix);
+    STRCMP_EQUAL("message (modified)", ptr_line->data->message);
+
+    /* message without date: unchanged */
+    gui_chat_printf_date_tags (test_buffer, 0, NULL, "\t\tmessage");
+    ptr_line = test_buffer->own_lines->last_line;
+    LONGS_EQUAL(0, ptr_line->data->date);
+    POINTERS_EQUAL(NULL, ptr_line->data->prefix);
+    STRCMP_EQUAL("message (modified)", ptr_line->data->message);
+
+    /* message without date: add a date/prefix */
+    gui_chat_printf_date_tags (test_buffer, 0, "add_date_prefix",
+                               "\t\tmessage");
+    ptr_line = test_buffer->own_lines->last_line;
+    CHECK(ptr_line->data->date > 0);
+    STRCMP_EQUAL("new prefix", ptr_line->data->prefix);
+    STRCMP_EQUAL("message (modified)", ptr_line->data->message);
+
+    /* standard message: unchanged */
+    gui_chat_printf_date_tags (test_buffer, 0, NULL, "prefix\tmessage");
+    ptr_line = test_buffer->own_lines->last_line;
+    CHECK(ptr_line->data->date > 0);
+    STRCMP_EQUAL("prefix", ptr_line->data->prefix);
+    STRCMP_EQUAL("message (modified)", ptr_line->data->message);
+
+    /* standard message: update the prefix */
+    gui_chat_printf_date_tags (test_buffer, 0, "update_prefix",
+                               "prefix\tmessage");
+    ptr_line = test_buffer->own_lines->last_line;
+    CHECK(ptr_line->data->date > 0);
+    STRCMP_EQUAL("new prefix", ptr_line->data->prefix);
+    STRCMP_EQUAL("message (modified)", ptr_line->data->message);
+
+    /* standard message: remove the prefix */
+    gui_chat_printf_date_tags (test_buffer, 0, "remove_prefix",
+                               "prefix\tmessage");
+    ptr_line = test_buffer->own_lines->last_line;
+    CHECK(ptr_line->data->date > 0);
+    STRCMP_EQUAL("", ptr_line->data->prefix);
+    STRCMP_EQUAL("message (modified)", ptr_line->data->message);
+
+    /* standard message: remove the date/prefix */
+    gui_chat_printf_date_tags (test_buffer, 0, "remove_date_prefix",
+                               "prefix\tmessage");
+    ptr_line = test_buffer->own_lines->last_line;
+    LONGS_EQUAL(0, ptr_line->data->date);
+    POINTERS_EQUAL(NULL, ptr_line->data->prefix);
+    STRCMP_EQUAL("message (modified)", ptr_line->data->message);
+
+    /* close the test buffer */
+    gui_buffer_close (test_buffer);
+}
+
+/*
+ * Tests functions:
+ *   hook_print
+ */
+
+TEST(CoreHook, Print)
+{
+    /* TODO: write tests */
+}
+
+/*
+ * Tests functions:
+ *   hook_process
+ *   hook_process_hashtable
+ */
+
+TEST(CoreHook, Process)
+{
+    /* TODO: write tests */
+}
+
+/*
+ * Tests functions:
+ *   hook_signal
+ */
+
+TEST(CoreHook, Signal)
+{
+    /* TODO: write tests */
+}
+
+/*
+ * Tests functions:
+ *   hook_timer
+ */
+
+TEST(CoreHook, Timer)
+{
+    /* TODO: write tests */
+}