libpurple/tests/test_saved_presence.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>

#define G_SETTINGS_ENABLE_BACKEND
#include <gio/gsettingsbackend.h>

#include <purple.h>

#define SCHEMA_ID "im.pidgin.Purple.SavedPresence"

/******************************************************************************
 * Tests
 *****************************************************************************/
static void
test_purple_saved_presence_properties(void) {
	PurpleSavedPresence *presence = NULL;
	PurplePresencePrimitive primitive;
	GDateTime *last_used = NULL;
	GDateTime *last_used1 = NULL;
	guint64 expected_use_count = 123;
	guint64 use_count;
	char *id = NULL;
	char *name = NULL;
	char *message = NULL;
	char *emoji = NULL;

	last_used = g_date_time_new_now_local();

	/* Use g_object_new so we can test setting properties by name. All of them
	 * call the setter methods, so by doing it this way we exercise more of the
	 * code.
	 */
	presence = g_object_new(
		PURPLE_TYPE_SAVED_PRESENCE,
		"last-used", last_used,
		"use-count", expected_use_count,
		"id", "leeloo dallas multipass",
		"name", "my saved status",
		"primitive", PURPLE_PRESENCE_PRIMITIVE_STREAMING,
		"message", "I'm live on twitch at https://twitch.tv/rw_grim/",
		"emoji", "💀",
		NULL);

	/* Now use g_object_get to read all of the properties. */
	g_object_get(
		presence,
		"last-used", &last_used1,
		"use-count", &use_count,
		"id", &id,
		"name", &name,
		"primitive", &primitive,
		"message", &message,
		"emoji", &emoji,
		NULL);

	/* Compare all the things. */
	g_assert_nonnull(last_used1);
	g_assert_true(g_date_time_equal(last_used, last_used1));
	g_clear_pointer(&last_used1, g_date_time_unref);

	g_assert_cmpuint(use_count, ==, expected_use_count);

	g_assert_cmpstr(id, ==, "leeloo dallas multipass");
	g_clear_pointer(&id, g_free);

	g_assert_cmpstr(name, ==, "my saved status");
	g_clear_pointer(&name, g_free);

	g_assert_cmpint(primitive, ==, PURPLE_PRESENCE_PRIMITIVE_STREAMING);

	g_assert_cmpstr(message, ==,
	                "I'm live on twitch at https://twitch.tv/rw_grim/");
	g_clear_pointer(&message, g_free);

	g_assert_cmpstr(emoji, ==, "💀");
	g_clear_pointer(&emoji, g_free);

	g_clear_pointer(&last_used, g_date_time_unref);
	g_clear_object(&presence);
}

static void
test_purple_saved_presence_generates_id(void) {
	PurpleSavedPresence *presence = NULL;
	const char *id = NULL;

	presence = g_object_new(PURPLE_TYPE_SAVED_PRESENCE, NULL);

	id = purple_saved_presence_get_id(presence);
	g_assert_nonnull(id);
	g_assert_cmpstr(id, !=, "");

	g_clear_object(&presence);
}

static void
test_purple_saved_presence_set_settings(void) {
	PurpleSavedPresence *presence = NULL;
	PurplePresencePrimitive primitive = PURPLE_PRESENCE_PRIMITIVE_OFFLINE;
	GSettingsBackend *backend = NULL;
	GSettings *settings = NULL;
	GDateTime *last_used = NULL;
	guint64 use_count = 0;
	const char *name = NULL;
	const char *message = NULL;
	const char *emoji = NULL;
	char *timestamp = NULL;

	backend = g_memory_settings_backend_new();
	settings = g_settings_new_with_backend(SCHEMA_ID, backend);

	presence = g_object_new(
		PURPLE_TYPE_SAVED_PRESENCE,
		"settings", settings,
		NULL);

	/* Set each setting and verify that the property matches what we set. */
	g_settings_set_string(settings, "last-used", "2023-07-06T05:32:24Z");
	last_used = purple_saved_presence_get_last_used(presence);
	g_assert_nonnull(last_used);
	timestamp = g_date_time_format_iso8601(last_used);
	g_assert_cmpstr(timestamp, ==, "2023-07-06T05:32:24Z");
	g_free(timestamp);

	g_settings_set_uint64(settings, "use-count", 42);
	use_count = purple_saved_presence_get_use_count(presence);
	g_assert_cmpuint(use_count, ==, 42);

	g_settings_set_string(settings, "name", "brb");
	name = purple_saved_presence_get_name(presence);
	g_assert_cmpstr(name, ==, "brb");

	g_settings_set_enum(settings, "primitive", PURPLE_PRESENCE_PRIMITIVE_AWAY);
	primitive = purple_saved_presence_get_primitive(presence);
	g_assert_cmpuint(primitive, ==, PURPLE_PRESENCE_PRIMITIVE_AWAY);

	g_settings_set_string(settings, "message", "message in a bottle");
	message = purple_saved_presence_get_message(presence);
	g_assert_cmpstr(message, ==, "message in a bottle");

	g_settings_set_string(settings, "emoji", "🍾");
	emoji = purple_saved_presence_get_emoji(presence);
	g_assert_cmpstr(emoji, ==, "🍾");

	g_clear_object(&presence);
	g_clear_object(&settings);
	g_clear_object(&backend);
}

static void
test_purple_saved_presence_set_properties(void) {
	PurpleSavedPresence *presence = NULL;
	PurplePresencePrimitive primitive = PURPLE_PRESENCE_PRIMITIVE_OFFLINE;
	GSettingsBackend *backend = NULL;
	GSettings *settings = NULL;
	GDateTime *last_used = NULL;
	guint64 use_count = 0;
	char *name = NULL;
	char *message = NULL;
	char *emoji = NULL;
	char *timestamp = NULL;

	backend = g_memory_settings_backend_new();
	settings = g_settings_new_with_backend(SCHEMA_ID, backend);

	presence = g_object_new(
		PURPLE_TYPE_SAVED_PRESENCE,
		"settings", settings,
		NULL);

	/* Set each setting and verify that the property matches what we set. */
	last_used = g_date_time_new_from_iso8601("2023-07-06T05:32:24Z", NULL);
	purple_saved_presence_set_last_used(presence, last_used);
	g_date_time_unref(last_used);
	timestamp = g_settings_get_string(settings, "last-used");
	g_assert_cmpstr(timestamp, ==, "2023-07-06T05:32:24Z");
	g_free(timestamp);

	purple_saved_presence_set_use_count(presence, 42);
	use_count = g_settings_get_uint64(settings, "use-count");
	g_assert_cmpuint(use_count, ==, 42);

	purple_saved_presence_set_name(presence, "brb");
	name = g_settings_get_string(settings, "name");
	g_assert_cmpstr(name, ==, "brb");
	g_free(name);

	purple_saved_presence_set_primitive(presence,
	                                    PURPLE_PRESENCE_PRIMITIVE_AWAY);
	primitive = g_settings_get_enum(settings, "primitive");
	g_assert_cmpuint(primitive, ==, PURPLE_PRESENCE_PRIMITIVE_AWAY);

	purple_saved_presence_set_message(presence, "message in a bottle");
	message = g_settings_get_string(settings, "message");
	g_assert_cmpstr(message, ==, "message in a bottle");
	g_free(message);

	purple_saved_presence_set_emoji(presence, "🍾");
	emoji = g_settings_get_string(settings, "emoji");
	g_assert_cmpstr(emoji, ==, "🍾");
	g_free(emoji);

	g_clear_object(&presence);
	g_clear_object(&settings);
	g_clear_object(&backend);
}

static void
test_purple_saved_presence_equal_null_null(void) {
	g_assert_true(purple_saved_presence_equal(NULL, NULL));
}

static void
test_purple_saved_presence_equal_null_a(void) {
	PurpleSavedPresence *b = g_object_new(PURPLE_TYPE_SAVED_PRESENCE, NULL);

	g_assert_false(purple_saved_presence_equal(NULL, b));

	g_clear_object(&b);
}

static void
test_purple_saved_presence_equal_null_b(void) {
	PurpleSavedPresence *a = g_object_new(PURPLE_TYPE_SAVED_PRESENCE, NULL);

	g_assert_false(purple_saved_presence_equal(a, NULL));

	g_clear_object(&a);
}

static void
test_purple_saved_presence_equal_default(void) {
	PurpleSavedPresence *a = g_object_new(PURPLE_TYPE_SAVED_PRESENCE, NULL);
	PurpleSavedPresence *b = g_object_new(PURPLE_TYPE_SAVED_PRESENCE, NULL);

	g_assert_true(purple_saved_presence_equal(a, b));

	g_clear_object(&a);
	g_clear_object(&b);
}

static void
test_purple_saved_presence_equal_last_used(void) {
	PurpleSavedPresence *a = g_object_new(PURPLE_TYPE_SAVED_PRESENCE, NULL);
	PurpleSavedPresence *b = g_object_new(PURPLE_TYPE_SAVED_PRESENCE, NULL);
	GDateTime *now = g_date_time_new_now_utc();
	GDateTime *yesterday = g_date_time_add_days(now, -1);

	/* Set the last used time for a but not b. */
	purple_saved_presence_set_last_used(a, now);
	g_assert_false(purple_saved_presence_equal(a, b));

	/* Set the last used time for b to the same as a. */
	purple_saved_presence_set_last_used(b, now);
	g_assert_true(purple_saved_presence_equal(a, b));

	/* Set the last used time for b to yesterday. */
	purple_saved_presence_set_last_used(b, yesterday);
	g_assert_false(purple_saved_presence_equal(a, b));

	/* Set the last used time for a to NULL. */
	purple_saved_presence_set_last_used(a, NULL);
	g_assert_false(purple_saved_presence_equal(a, b));

	/* Set the last used time for b to NULL. */
	purple_saved_presence_set_last_used(b, NULL);
	g_assert_true(purple_saved_presence_equal(a, b));

	g_clear_object(&a);
	g_clear_object(&b);
	g_clear_pointer(&now, g_date_time_unref);
	g_clear_pointer(&yesterday, g_date_time_unref);
}

static void
test_purple_saved_presence_equal_use_count(void) {
	PurpleSavedPresence *a = g_object_new(PURPLE_TYPE_SAVED_PRESENCE, NULL);
	PurpleSavedPresence *b = g_object_new(PURPLE_TYPE_SAVED_PRESENCE, NULL);

	/* Set the use-count of a to 100. */
	purple_saved_presence_set_use_count(a, 100);
	g_assert_false(purple_saved_presence_equal(a, b));

	/* Check an explicit value is equal. */
	purple_saved_presence_set_use_count(b, 100);
	g_assert_true(purple_saved_presence_equal(a, b));

	/* Set the use-count of b to 101. */
	purple_saved_presence_set_use_count(b, 101);
	g_assert_false(purple_saved_presence_equal(a, b));

	g_clear_object(&a);
	g_clear_object(&b);
}

static void
test_purple_saved_presence_equal_name(void) {
	PurpleSavedPresence *a = g_object_new(PURPLE_TYPE_SAVED_PRESENCE, NULL);
	PurpleSavedPresence *b = g_object_new(PURPLE_TYPE_SAVED_PRESENCE, NULL);

	/* Set the name of a. */
	purple_saved_presence_set_name(a, "present");
	g_assert_false(purple_saved_presence_equal(a, b));

	/* Set the name of b to the same as a. */
	purple_saved_presence_set_name(b, "present");
	g_assert_true(purple_saved_presence_equal(a, b));

	/* Set the name of b to something else. */
	purple_saved_presence_set_name(b, "future");
	g_assert_false(purple_saved_presence_equal(a, b));

	/* Set the name of a to NULL. */
	purple_saved_presence_set_name(a, NULL);
	g_assert_false(purple_saved_presence_equal(a, b));

	g_clear_object(&a);
	g_clear_object(&b);
}

static void
test_purple_saved_presence_equal_primitive(void) {
	PurpleSavedPresence *a = g_object_new(PURPLE_TYPE_SAVED_PRESENCE, NULL);
	PurpleSavedPresence *b = g_object_new(PURPLE_TYPE_SAVED_PRESENCE, NULL);

	/* Set the primitive of a to streaming. */
	purple_saved_presence_set_primitive(a,
	                                    PURPLE_PRESENCE_PRIMITIVE_STREAMING);
	g_assert_false(purple_saved_presence_equal(a, b));

	/* Set the primitive of b to idle. */
	purple_saved_presence_set_primitive(b, PURPLE_PRESENCE_PRIMITIVE_IDLE);
	g_assert_false(purple_saved_presence_equal(a, b));

	/* Set the primitives to the same value. */
	purple_saved_presence_set_primitive(b,
	                                    PURPLE_PRESENCE_PRIMITIVE_STREAMING);
	g_assert_true(purple_saved_presence_equal(a, b));

	g_clear_object(&a);
	g_clear_object(&b);
}

static void
test_purple_saved_presence_equal_message(void) {
	PurpleSavedPresence *a = g_object_new(PURPLE_TYPE_SAVED_PRESENCE, NULL);
	PurpleSavedPresence *b = g_object_new(PURPLE_TYPE_SAVED_PRESENCE, NULL);

	/* Set the message for a. */
	purple_saved_presence_set_message(a, "sleeping...");
	g_assert_false(purple_saved_presence_equal(a, b));

	/* Set the message for b. */
	purple_saved_presence_set_message(b, "working!");
	g_assert_false(purple_saved_presence_equal(a, b));

	/* Set the messages to the same. */
	purple_saved_presence_set_message(a, "working!");
	g_assert_true(purple_saved_presence_equal(a, b));

	g_clear_object(&a);
	g_clear_object(&b);
}

static void
test_purple_saved_presence_equal_emoji(void) {
	PurpleSavedPresence *a = g_object_new(PURPLE_TYPE_SAVED_PRESENCE, NULL);
	PurpleSavedPresence *b = g_object_new(PURPLE_TYPE_SAVED_PRESENCE, NULL);

	/* Set the emoji for a. */
	purple_saved_presence_set_emoji(a, "💤");
	g_assert_false(purple_saved_presence_equal(a, b));

	/* Set the emoji for b. */
	purple_saved_presence_set_emoji(b, "🏢");
	g_assert_false(purple_saved_presence_equal(a, b));

	/* Set the emoji to the same. */
	purple_saved_presence_set_emoji(a, "🏢");
	g_assert_true(purple_saved_presence_equal(a, b));

	g_clear_object(&a);
	g_clear_object(&b);
}

static void
test_purple_saved_presence_matches_accepts_null(void) {
	PurpleSavedPresence *presence = NULL;

	presence = g_object_new(PURPLE_TYPE_SAVED_PRESENCE, NULL);
	g_assert_true(purple_saved_presence_matches(presence, NULL));

	g_assert_finalize_object(presence);
}

static void
test_purple_saved_presence_matches_empty_string(void) {
	PurpleSavedPresence *presence = NULL;

	presence = g_object_new(PURPLE_TYPE_SAVED_PRESENCE, NULL);
	g_assert_true(purple_saved_presence_matches(presence, ""));

	g_assert_finalize_object(presence);
}

static void
test_purple_saved_presence_matches_name(void) {
	PurpleSavedPresence *presence = NULL;

	presence = g_object_new(PURPLE_TYPE_SAVED_PRESENCE,
	                        "name", "getting pidgy with it",
	                        NULL);
	g_assert_true(purple_saved_presence_matches(presence, "pidgy"));

	g_assert_finalize_object(presence);
}

static void
test_purple_saved_presence_matches_message(void) {
	PurpleSavedPresence *presence = NULL;

	/* This message came from a Twitch viewer while I was writing this code.
	 * Previously I typoed purple as purpel and started making jokes with it.
	 */
	presence = g_object_new(PURPLE_TYPE_SAVED_PRESENCE,
	                        "message", "Uro666: purpelling to new heights",
	                        NULL);
	g_assert_true(purple_saved_presence_matches(presence, "purpel"));

	g_assert_finalize_object(presence);
}

static void
test_purple_saved_presence_matches_emoji(void) {
	PurpleSavedPresence *presence = NULL;

	presence = g_object_new(PURPLE_TYPE_SAVED_PRESENCE,
	                        "emoji", "😴",
	                        NULL);
	g_assert_true(purple_saved_presence_matches(presence, "😴"));

	g_assert_finalize_object(presence);
}

static void
test_purple_saved_presence_matches_none(void) {
	PurpleSavedPresence *presence = NULL;

	presence = g_object_new(PURPLE_TYPE_SAVED_PRESENCE, NULL);
	g_assert_false(purple_saved_presence_matches(presence, "away"));

	g_assert_finalize_object(presence);
}

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

	g_test_add_func("/saved-presence/properties",
	                test_purple_saved_presence_properties);

	g_test_add_func("/saved-presence/generates-id",
	                test_purple_saved_presence_generates_id);

	g_test_add_func("/saved-presence/settings/set-settings",
	                test_purple_saved_presence_set_settings);
	g_test_add_func("/saved-presence/settings/set-properties",
	                test_purple_saved_presence_set_properties);

	g_test_add_func("/saved-presence/equal/null_null",
	                test_purple_saved_presence_equal_null_null);
	g_test_add_func("/saved-presence/equal/null_a",
	                test_purple_saved_presence_equal_null_a);
	g_test_add_func("/saved-presence/equal/null_b",
	                test_purple_saved_presence_equal_null_b);
	g_test_add_func("/saved-presence/equal/default",
	                test_purple_saved_presence_equal_default);

	g_test_add_func("/saved-presence/equal/last-used",
	                test_purple_saved_presence_equal_last_used);
	g_test_add_func("/saved-presence/equal/use-count",
	                test_purple_saved_presence_equal_use_count);
	g_test_add_func("/saved-presence/equal/name",
	                test_purple_saved_presence_equal_name);
	g_test_add_func("/saved-presence/equal/primitive",
	                test_purple_saved_presence_equal_primitive);
	g_test_add_func("/saved-presence/equal/message",
	                test_purple_saved_presence_equal_message);
	g_test_add_func("/saved-presence/equal/emoji",
	                test_purple_saved_presence_equal_emoji);

	g_test_add_func("/saved-presence/matches/accepts_null",
	                test_purple_saved_presence_matches_accepts_null);
	g_test_add_func("/saved-presence/matches/empty_string",
	                test_purple_saved_presence_matches_empty_string);
	g_test_add_func("/saved-presence/matches/name",
	                test_purple_saved_presence_matches_name);
	g_test_add_func("/saved-presence/matches/message",
	                test_purple_saved_presence_matches_message);
	g_test_add_func("/saved-presence/matches/emoji",
	                test_purple_saved_presence_matches_emoji);
	g_test_add_func("/saved-presence/matches/none",
	                test_purple_saved_presence_matches_none);

	return g_test_run();
}