libpurple/tests/test_protocol.c

/*
 * Purple - Internet Messaging Library
 * Copyright (C) Pidgin Developers <devel@pidgin.im>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, see <https://www.gnu.org/licenses/>.
 */

#include <glib.h>

#include <birb.h>

#include <purple.h>

#define TEST_PROTOCOL_DOMAIN (g_quark_from_static_string("test-protocol"))

/******************************************************************************
 * TestPurpleProtocol
 *****************************************************************************/
#define TEST_PURPLE_TYPE_PROTOCOL (test_purple_protocol_get_type())
G_DECLARE_FINAL_TYPE(TestPurpleProtocol,
                     test_purple_protocol,
                     TEST_PURPLE, PROTOCOL,
                     PurpleProtocol)

struct _TestPurpleProtocol {
	PurpleProtocol parent;

	gboolean result;
	GError *error;

	guint can_connect_async;
	guint can_connect_finish;

	guint generate_account_name;
};

G_DEFINE_FINAL_TYPE(TestPurpleProtocol, test_purple_protocol,
                    PURPLE_TYPE_PROTOCOL)

static void
test_purple_protocol_can_connect_async(PurpleProtocol *protocol,
                                       G_GNUC_UNUSED PurpleAccount *account,
                                       GCancellable *cancellable,
                                       GAsyncReadyCallback callback,
                                       gpointer data)
{
	TestPurpleProtocol *test_protocol = TEST_PURPLE_PROTOCOL(protocol);
	GTask *task = NULL;

	task = g_task_new(protocol, cancellable, callback, data);
	if(test_protocol->error != NULL) {
		g_task_return_error(task, g_error_copy(test_protocol->error));
	} else {
		g_task_return_boolean(task, test_protocol->result);
	}
	g_clear_object(&task);

	test_protocol->can_connect_async += 1;
}

static gboolean
test_purple_protocol_can_connect_finish(PurpleProtocol *protocol,
                                        GAsyncResult *result,
                                        GError **error)
{
	TestPurpleProtocol *test_protocol = TEST_PURPLE_PROTOCOL(protocol);

	test_protocol->can_connect_finish += 1;

	return g_task_propagate_boolean(G_TASK(result), error);
}

static char *
test_purple_protocol_generate_account_name(PurpleProtocol *protocol,
                                           PurpleAccount *account,
                                           guint n_accounts)
{
	TestPurpleProtocol *test_protocol = NULL;

	birb_assert_type(protocol, TEST_PURPLE_TYPE_PROTOCOL);
	birb_assert_type(account, PURPLE_TYPE_ACCOUNT);

	test_protocol = TEST_PURPLE_PROTOCOL(protocol);
	test_protocol->generate_account_name += 1;

	return g_strdup_printf("override %u", n_accounts + 1);
}

static BirbActionMenu *
test_purple_protocol_get_action_menu(PurpleProtocol *protocol,
                                     PurpleAccount *account)
{
	g_assert_true(PURPLE_IS_PROTOCOL(protocol));
	g_assert_true(PURPLE_IS_ACCOUNT(account));

	return birb_action_menu_new();
}

static void
test_purple_protocol_finalize(GObject *obj) {
	TestPurpleProtocol *protocol = TEST_PURPLE_PROTOCOL(obj);

	g_clear_error(&protocol->error);

	G_OBJECT_CLASS(test_purple_protocol_parent_class)->finalize(obj);
}

static void
test_purple_protocol_init(G_GNUC_UNUSED TestPurpleProtocol *protocol) {
}

static void
test_purple_protocol_class_init(TestPurpleProtocolClass *klass)
{
	GObjectClass *obj_class = G_OBJECT_CLASS(klass);
	PurpleProtocolClass *protocol_class = PURPLE_PROTOCOL_CLASS(klass);

	obj_class->finalize = test_purple_protocol_finalize;

	protocol_class->can_connect_async = test_purple_protocol_can_connect_async;
	protocol_class->can_connect_finish = test_purple_protocol_can_connect_finish;
	protocol_class->generate_account_name = test_purple_protocol_generate_account_name;
	protocol_class->get_action_menu = test_purple_protocol_get_action_menu;
}

static PurpleProtocol *
test_purple_protocol_new(void) {
	return g_object_new(
		TEST_PURPLE_TYPE_PROTOCOL,
		"id", "test-protocol",
		"name", "Test Protocol",
		NULL);
}

/******************************************************************************
 * General Tests
 *****************************************************************************/
static void
test_purple_protocol_properties(void) {
	PurpleProtocol *protocol = NULL;
	PurpleProtocolOptions options = 0;
	PurpleTags *tags = NULL;
	char *description = NULL;
	char *icon_name = NULL;
	char *icon_resource_path = NULL;
	char *icon_search_path = NULL;
	char *id = NULL;
	char *name = NULL;

	protocol = g_object_new(
		TEST_PURPLE_TYPE_PROTOCOL,
		"description", "This is a description",
		"icon-name", "icon-name",
		"icon-resource-path", "resource-path",
		"icon-search-path", "search-path",
		"id", "test-protocol",
		"name", "Test Protocol",
		"options", OPT_PROTO_NO_PASSWORD,
		NULL);

	birb_assert_type(protocol, TEST_PURPLE_TYPE_PROTOCOL);

	g_object_get(
		G_OBJECT(protocol),
		"description", &description,
		"icon-name", &icon_name,
		"icon-resource-path", &icon_resource_path,
		"icon-search-path", &icon_search_path,
		"id", &id,
		"name", &name,
		"options", &options,
		"tags", &tags,
		NULL);

	g_assert_cmpstr(description, ==, "This is a description");
	g_clear_pointer(&description, g_free);

	g_assert_cmpstr(icon_name, ==, "icon-name");
	g_clear_pointer(&icon_name, g_free);

	g_assert_cmpstr(icon_resource_path, ==, "resource-path");
	g_clear_pointer(&icon_resource_path, g_free);

	g_assert_cmpstr(icon_search_path, ==, "search-path");
	g_clear_pointer(&icon_search_path, g_free);

	g_assert_cmpstr(id, ==, "test-protocol");
	g_clear_pointer(&id, g_free);

	g_assert_cmpstr(name, ==, "Test Protocol");
	g_clear_pointer(&name, g_free);

	g_assert_cmphex(options, ==, OPT_PROTO_NO_PASSWORD);

	birb_assert_type(tags, PURPLE_TYPE_TAGS);
	g_clear_object(&tags);

	g_assert_finalize_object(protocol);
}

/******************************************************************************
 * TestPurpleProtocol->can_connect Tests
 *****************************************************************************/
static void
test_purple_protocol_can_connect_cb(GObject *obj, GAsyncResult *res,
                                    G_GNUC_UNUSED gpointer data)
{
	PurpleProtocol *protocol = PURPLE_PROTOCOL(obj);
	TestPurpleProtocol *test_protocol = TEST_PURPLE_PROTOCOL(protocol);
	GError *error = NULL;
	gboolean result = FALSE;

	result = purple_protocol_can_connect_finish(protocol, res, &error);

	if(test_protocol->error != NULL) {
		g_assert_error(error, TEST_PROTOCOL_DOMAIN, 0);
		g_clear_error(&error);
	} else {
		g_assert_no_error(error);
	}

	g_assert_true(result == test_protocol->result);
}

static void
test_purple_protocol_can_connect_error(void) {
	TestPurpleProtocol *test_protocol = NULL;
	PurpleProtocol *protocol = NULL;
	PurpleAccount *account = NULL;
	GError *error = NULL;

	error = g_error_new(TEST_PROTOCOL_DOMAIN, 0, "no network");
	protocol = test_purple_protocol_new();
	test_protocol = TEST_PURPLE_PROTOCOL(protocol);
	test_protocol->error = error;

	account = purple_account_new("test", "test");

	purple_protocol_can_connect_async(PURPLE_PROTOCOL(protocol), account, NULL,
	                                  test_purple_protocol_can_connect_cb,
	                                  NULL);

	g_main_context_iteration(NULL, FALSE);

	g_assert_cmpuint(test_protocol->can_connect_async, ==, 1);
	g_assert_cmpuint(test_protocol->can_connect_finish, ==, 1);

	g_assert_finalize_object(protocol);
	g_clear_object(&account);
}

static void
test_purple_protocol_can_connect_false(void) {
	TestPurpleProtocol *test_protocol = NULL;
	PurpleProtocol *protocol = NULL;
	PurpleAccount *account = NULL;

	protocol = test_purple_protocol_new();
	test_protocol = TEST_PURPLE_PROTOCOL(protocol);
	account = purple_account_new("test", "test");

	purple_protocol_can_connect_async(PURPLE_PROTOCOL(protocol), account, NULL,
	                                  test_purple_protocol_can_connect_cb,
	                                  NULL);

	g_main_context_iteration(NULL, FALSE);

	g_assert_cmpuint(test_protocol->can_connect_async, ==, 1);
	g_assert_cmpuint(test_protocol->can_connect_finish, ==, 1);

	g_assert_finalize_object(protocol);
	g_clear_object(&account);
}

static void
test_purple_protocol_can_connect_true(void) {
	TestPurpleProtocol *test_protocol = NULL;
	PurpleProtocol *protocol = NULL;
	PurpleAccount *account = NULL;

	protocol = test_purple_protocol_new();
	test_protocol = TEST_PURPLE_PROTOCOL(protocol);
	test_protocol->result = TRUE;
	account = purple_account_new("test", "test");

	purple_protocol_can_connect_async(PURPLE_PROTOCOL(protocol), account, NULL,
	                                  test_purple_protocol_can_connect_cb,
	                                  NULL);

	g_main_context_iteration(NULL, FALSE);

	g_assert_cmpuint(test_protocol->can_connect_async, ==, 1);
	g_assert_cmpuint(test_protocol->can_connect_finish, ==, 1);

	g_assert_finalize_object(protocol);
	g_clear_object(&account);
}

static void
test_purple_protocol_generate_account_name_default(void) {
	TestPurpleProtocol *test_protocol = NULL;
	PurpleAccount *account = NULL;
	PurpleProtocol *protocol = NULL;
	PurpleProtocolClass *klass = NULL;
	char *name = NULL;

	protocol = test_purple_protocol_new();
	test_protocol = TEST_PURPLE_PROTOCOL(protocol);
	klass = PURPLE_PROTOCOL_GET_CLASS(protocol);
	klass->generate_account_name = PURPLE_PROTOCOL_CLASS(test_purple_protocol_parent_class)->generate_account_name;

	account = purple_account_new("test", "test");

	name = purple_protocol_generate_account_name(protocol, account, 0);
	g_assert_cmpstr(name, ==, "Test Protocol 1");
	g_clear_pointer(&name, g_free);

	name = purple_protocol_generate_account_name(protocol, account, 9);
	g_assert_cmpstr(name, ==, "Test Protocol 10");
	g_clear_pointer(&name, g_free);

	g_assert_cmpuint(test_protocol->generate_account_name, ==, 0);

	g_assert_finalize_object(account);
	g_assert_finalize_object(protocol);
}

static void
test_purple_protocol_generate_account_name_override(void) {
	TestPurpleProtocol *test_protocol = NULL;
	PurpleAccount *account = NULL;
	PurpleProtocol *protocol = NULL;
	char *name = NULL;

	protocol = test_purple_protocol_new();
	test_protocol = TEST_PURPLE_PROTOCOL(protocol);

	account = purple_account_new("test", "test");

	name = purple_protocol_generate_account_name(protocol, account, 0);
	g_assert_cmpstr(name, ==, "override 1");
	g_clear_pointer(&name, g_free);

	name = purple_protocol_generate_account_name(protocol, account, 9);
	g_assert_cmpstr(name, ==, "override 10");
	g_clear_pointer(&name, g_free);

	g_assert_cmpuint(test_protocol->generate_account_name, ==, 2);

	g_assert_finalize_object(account);
	g_assert_finalize_object(protocol);
}

static void
test_purple_protocol_get_action_menu_valid(void) {
	PurpleProtocol *protocol = NULL;
	PurpleAccount *account = NULL;
	BirbActionMenu *action_menu = NULL;

	protocol = test_purple_protocol_new();
	account = purple_account_new("test", "test");

	action_menu = purple_protocol_get_action_menu(protocol, account);
	g_assert_true(BIRB_IS_ACTION_MENU(action_menu));
	g_clear_object(&action_menu);

	g_clear_object(&account);
	g_assert_finalize_object(protocol);
}

/******************************************************************************
 * Main
 *****************************************************************************/
int
main(int argc, char *argv[]) {
	g_test_init(&argc, &argv, NULL);
	g_test_set_nonfatal_assertions();

	g_test_add_func("/protocol/properties", test_purple_protocol_properties);

	g_test_add_func("/protocol/can-connect/error",
	                test_purple_protocol_can_connect_error);
	g_test_add_func("/protocol/can-connect/false",
	                test_purple_protocol_can_connect_false);
	g_test_add_func("/protocol/can-connect/true",
	                test_purple_protocol_can_connect_true);

	g_test_add_func("/protocol/generate-account-name/override",
	                test_purple_protocol_generate_account_name_override);
	g_test_add_func("/protocol/generate-account-name/default",
	                test_purple_protocol_generate_account_name_default);

	g_test_add_func("/protocol/get-action-menu/valid",
	                test_purple_protocol_get_action_menu_valid);

	return g_test_run();
}