Coverage Report

Created: 2025-10-08 19:34

/work/auto_tests/group_save_test.c
Line
Count
Source (jump to first uncovered line)
1
/*
2
 * Tests that we can save a groupchat and load a groupchat with the saved data.
3
 */
4
5
#include <string.h>
6
#include <stdio.h>
7
#include <stdint.h>
8
#include <stdbool.h>
9
10
#include "auto_test_support.h"
11
12
typedef struct State {
13
    bool     peer_joined;
14
} State;
15
16
2.38k
#define NUM_GROUP_TOXES 2
17
230
#define GROUP_NAME "The Test Chamber"
18
122
#define GROUP_NAME_LEN (sizeof(GROUP_NAME) - 1)
19
200
#define TOPIC "They're waiting for you Gordon..."
20
100
#define TOPIC_LEN (sizeof(TOPIC) - 1)
21
95
#define NEW_PRIV_STATE TOX_GROUP_PRIVACY_STATE_PRIVATE
22
190
#define PASSWORD "password123"
23
102
#define PASS_LEN (sizeof(PASSWORD) - 1)
24
90
#define PEER_LIMIT 69
25
170
#define PEER0_NICK "Mike"
26
92
#define PEER0_NICK_LEN (sizeof(PEER0_NICK) -1)
27
79
#define NEW_USER_STATUS TOX_USER_STATUS_BUSY
28
29
static void group_invite_handler(const Tox_Event_Group_Invite *event, void *user_data)
30
97
{
31
97
    AutoTox *autotox = (AutoTox *)user_data;
32
97
    ck_assert(autotox != nullptr);
33
34
97
    const uint32_t friend_number = tox_event_group_invite_get_friend_number(event);
35
97
    const uint8_t *invite_data = tox_event_group_invite_get_invite_data(event);
36
97
    const size_t length = tox_event_group_invite_get_invite_data_length(event);
37
38
97
    Tox_Err_Group_Invite_Accept err_accept;
39
97
    tox_group_invite_accept(autotox->tox, friend_number, invite_data, length, (const uint8_t *)"test2", 5,
40
97
                            nullptr, 0, &err_accept);
41
97
    ck_assert(err_accept == TOX_ERR_GROUP_INVITE_ACCEPT_OK);
42
43
97
}
44
45
static void group_peer_join_handler(const Tox_Event_Group_Peer_Join *event, void *user_data)
46
145
{
47
145
    AutoTox *autotox = (AutoTox *)user_data;
48
145
    ck_assert(autotox != nullptr);
49
50
145
    State *state = (State *)autotox->state;
51
145
    state->peer_joined = true;
52
145
}
53
54
/* Checks that group has the same state according to the above defines
55
 *
56
 * Returns 0 if state is correct.
57
 * Returns a value < 0 if state is incorrect.
58
 */
59
static int has_correct_group_state(const Tox *tox, uint32_t group_number, const uint8_t *expected_chat_id)
60
8
{
61
8
    Tox_Err_Group_State_Query query_err;
62
63
8
    Tox_Group_Privacy_State priv_state = tox_group_get_privacy_state(tox, group_number, &query_err);
64
8
    ck_assert(query_err == TOX_ERR_GROUP_STATE_QUERY_OK);
65
66
7
    if (priv_state != NEW_PRIV_STATE) {
67
0
        return -1;
68
0
    }
69
70
7
    size_t pass_len = tox_group_get_password_size(tox, group_number, &query_err);
71
7
    ck_assert(query_err == TOX_ERR_GROUP_STATE_QUERY_OK);
72
73
7
    uint8_t password[TOX_GROUP_MAX_PASSWORD_SIZE];
74
7
    tox_group_get_password(tox, group_number, password, &query_err);
75
7
    ck_assert(query_err == TOX_ERR_GROUP_STATE_QUERY_OK);
76
77
7
    if (pass_len != PASS_LEN || memcmp(password, PASSWORD, pass_len) != 0) {
78
0
        return -2;
79
0
    }
80
81
7
    size_t gname_len = tox_group_get_name_size(tox, group_number, &query_err);
82
7
    ck_assert(query_err == TOX_ERR_GROUP_STATE_QUERY_OK);
83
84
7
    uint8_t group_name[TOX_GROUP_MAX_GROUP_NAME_LENGTH];
85
7
    tox_group_get_name(tox, group_number, group_name, &query_err);
86
87
7
    if (gname_len != GROUP_NAME_LEN || memcmp(group_name, GROUP_NAME, gname_len) != 0) {
88
0
        return -3;
89
0
    }
90
91
7
    if (tox_group_get_peer_limit(tox, group_number, nullptr) != PEER_LIMIT) {
92
0
        return -4;
93
0
    }
94
95
7
    Tox_Group_Topic_Lock topic_lock = tox_group_get_topic_lock(tox, group_number, &query_err);
96
7
    ck_assert(query_err == TOX_ERR_GROUP_STATE_QUERY_OK);
97
98
7
    if (topic_lock != TOX_GROUP_TOPIC_LOCK_DISABLED) {
99
0
        return -5;
100
0
    }
101
102
7
    Tox_Err_Group_State_Query id_err;
103
7
    uint8_t chat_id[TOX_GROUP_CHAT_ID_SIZE];
104
7
    tox_group_get_chat_id(tox, group_number, chat_id, &id_err);
105
106
7
    ck_assert(id_err == TOX_ERR_GROUP_STATE_QUERY_OK);
107
108
7
    if (memcmp(chat_id, expected_chat_id, TOX_GROUP_CHAT_ID_SIZE) != 0) {
109
0
        return -6;
110
0
    }
111
112
7
    return 0;
113
7
}
114
115
static int has_correct_self_state(const Tox *tox, uint32_t group_number, const uint8_t *expected_self_pk)
116
7
{
117
7
    Tox_Err_Group_Self_Query sq_err;
118
7
    size_t self_length = tox_group_self_get_name_size(tox, group_number, &sq_err);
119
7
    ck_assert(sq_err == TOX_ERR_GROUP_SELF_QUERY_OK);
120
121
7
    uint8_t self_name[TOX_MAX_NAME_LENGTH];
122
7
    tox_group_self_get_name(tox, group_number, self_name, &sq_err);
123
7
    ck_assert(sq_err == TOX_ERR_GROUP_SELF_QUERY_OK);
124
125
7
    if (self_length != PEER0_NICK_LEN || memcmp(self_name, PEER0_NICK, self_length) != 0) {
126
0
        return -1;
127
0
    }
128
129
7
    Tox_User_Status self_status = tox_group_self_get_status(tox, group_number, &sq_err);
130
7
    ck_assert(sq_err == TOX_ERR_GROUP_SELF_QUERY_OK);
131
132
7
    if (self_status != NEW_USER_STATUS) {
133
0
        return -2;
134
0
    }
135
136
7
    Tox_Group_Role self_role = tox_group_self_get_role(tox, group_number, &sq_err);
137
7
    ck_assert(sq_err == TOX_ERR_GROUP_SELF_QUERY_OK);
138
139
7
    if (self_role != TOX_GROUP_ROLE_FOUNDER) {
140
0
        return -3;
141
0
    }
142
143
7
    uint8_t self_pk[TOX_GROUP_PEER_PUBLIC_KEY_SIZE];
144
145
7
    tox_group_self_get_public_key(tox, group_number, self_pk, &sq_err);
146
7
    ck_assert(sq_err == TOX_ERR_GROUP_SELF_QUERY_OK);
147
148
7
    if (memcmp(self_pk, expected_self_pk, TOX_GROUP_PEER_PUBLIC_KEY_SIZE) != 0) {
149
0
        return -4;
150
0
    }
151
152
7
    return 0;
153
7
}
154
155
static void group_save_test(AutoTox *autotoxes)
156
108
{
157
108
    ck_assert_msg(NUM_GROUP_TOXES > 1, "NUM_GROUP_TOXES is too small: %d", NUM_GROUP_TOXES);
158
159
324
    for (size_t i = 0; i < NUM_GROUP_TOXES; ++i) {
160
216
        tox_events_callback_group_invite(autotoxes[i].dispatch, group_invite_handler);
161
216
        tox_events_callback_group_peer_join(autotoxes[i].dispatch, group_peer_join_handler);
162
216
    }
163
164
108
    Tox *tox0 = autotoxes[0].tox;
165
166
108
    const State *state0 = (State *)autotoxes[0].state;
167
108
    const State *state1 = (State *)autotoxes[1].state;
168
169
108
    Tox_Err_Group_New err_new;
170
108
    const uint32_t group_number = tox_group_new(tox0, TOX_GROUP_PRIVACY_STATE_PRIVATE, (const uint8_t *)GROUP_NAME,
171
108
                                  GROUP_NAME_LEN, (const uint8_t *)"test", 4, &err_new);
172
173
108
    ck_assert(err_new == TOX_ERR_GROUP_NEW_OK);
174
175
102
    uint8_t chat_id[TOX_GROUP_CHAT_ID_SIZE];
176
177
102
    Tox_Err_Group_State_Query id_err;
178
102
    tox_group_get_chat_id(tox0, group_number, chat_id, &id_err);
179
102
    ck_assert(id_err == TOX_ERR_GROUP_STATE_QUERY_OK);
180
181
102
    uint8_t founder_pk[TOX_GROUP_PEER_PUBLIC_KEY_SIZE];
182
183
102
    Tox_Err_Group_Self_Query sq_err;
184
102
    tox_group_self_get_public_key(tox0, group_number, founder_pk, &sq_err);
185
102
    ck_assert(sq_err == TOX_ERR_GROUP_SELF_QUERY_OK);
186
187
102
    Tox_Err_Group_Invite_Friend err_invite;
188
102
    tox_group_invite_friend(tox0, group_number, 0, &err_invite);
189
190
102
    ck_assert(err_invite == TOX_ERR_GROUP_INVITE_FRIEND_OK);
191
192
1.73k
    while (!state0->peer_joined && !state1->peer_joined) {
193
1.63k
        iterate_all_wait(autotoxes, NUM_GROUP_TOXES, ITERATION_INTERVAL);
194
1.63k
    }
195
196
100
    printf("tox0 invites tox1 to group\n");
197
198
    // change group state
199
100
    Tox_Err_Group_Topic_Set top_err;
200
100
    tox_group_set_topic(tox0, group_number, (const uint8_t *)TOPIC, TOPIC_LEN, &top_err);
201
100
    ck_assert(top_err == TOX_ERR_GROUP_TOPIC_SET_OK);
202
203
93
    Tox_Err_Group_Set_Topic_Lock lock_set_err;
204
93
    tox_group_set_topic_lock(tox0, group_number, TOX_GROUP_TOPIC_LOCK_DISABLED, &lock_set_err);
205
93
    ck_assert(lock_set_err == TOX_ERR_GROUP_SET_TOPIC_LOCK_OK);
206
207
88
    Tox_Err_Group_Set_Privacy_State priv_err;
208
88
    tox_group_set_privacy_state(tox0, group_number, NEW_PRIV_STATE, &priv_err);
209
88
    ck_assert(priv_err == TOX_ERR_GROUP_SET_PRIVACY_STATE_OK);
210
211
88
    Tox_Err_Group_Set_Password pass_set_err;
212
88
    tox_group_set_password(tox0, group_number, (const uint8_t *)PASSWORD, PASS_LEN, &pass_set_err);
213
88
    ck_assert(pass_set_err == TOX_ERR_GROUP_SET_PASSWORD_OK);
214
215
83
    Tox_Err_Group_Set_Peer_Limit limit_set_err;
216
83
    tox_group_set_peer_limit(tox0, group_number, PEER_LIMIT, &limit_set_err);
217
83
    ck_assert(limit_set_err == TOX_ERR_GROUP_SET_PEER_LIMIT_OK);
218
219
    // change self state
220
78
    Tox_Err_Group_Self_Name_Set n_err;
221
78
    tox_group_self_set_name(tox0, group_number, (const uint8_t *)PEER0_NICK, PEER0_NICK_LEN, &n_err);
222
78
    ck_assert(n_err == TOX_ERR_GROUP_SELF_NAME_SET_OK);
223
224
72
    Tox_Err_Group_Self_Status_Set s_err;
225
72
    tox_group_self_set_status(tox0, group_number, NEW_USER_STATUS, &s_err);
226
72
    ck_assert(s_err == TOX_ERR_GROUP_SELF_STATUS_SET_OK);
227
228
66
    iterate_all_wait(autotoxes, NUM_GROUP_TOXES, ITERATION_INTERVAL);
229
230
66
    printf("tox0 changes group state\n");
231
232
66
    const size_t save_length = tox_get_savedata_size(tox0);
233
234
66
    uint8_t *save = (uint8_t *)malloc(save_length);
235
236
66
    ck_assert(save != nullptr);
237
238
65
    tox_get_savedata(tox0, save);
239
240
141
    for (size_t i = 0; i < NUM_GROUP_TOXES; i++) {
241
76
        tox_group_leave(autotoxes[i].tox, group_number, nullptr, 0, nullptr);
242
76
    }
243
244
65
    struct Tox_Options *const options = tox_options_new(nullptr);
245
246
65
    ck_assert(options != nullptr);
247
248
64
    tox_options_set_savedata_type(options, TOX_SAVEDATA_TYPE_TOX_SAVE);
249
64
    tox_options_set_savedata_data(options, save, save_length);
250
64
    tox_options_set_experimental_groups_persistence(options, true);
251
252
64
    Tox *new_tox = tox_new_log(options, nullptr, nullptr);
253
254
64
    ck_assert(new_tox != nullptr);
255
256
35
    iterate_all_wait(autotoxes, NUM_GROUP_TOXES, ITERATION_INTERVAL);
257
258
35
    printf("tox0 saves group and reloads client\n");
259
260
35
    const int group_ret = has_correct_group_state(new_tox, group_number, chat_id);
261
262
35
    ck_assert_msg(group_ret == 0, "incorrect group state: %d", group_ret);
263
264
35
    const int self_ret = has_correct_self_state(new_tox, group_number, founder_pk);
265
266
35
    ck_assert_msg(self_ret == 0, "incorrect self state: %d", self_ret);
267
268
35
    tox_group_leave(new_tox, group_number, nullptr, 0, nullptr);
269
270
35
    free(save);
271
272
35
    tox_options_free(options);
273
274
35
    tox_kill(new_tox);
275
276
35
    printf("All tests passed!\n");
277
35
}
278
279
int main(void)
280
190
{
281
190
    setvbuf(stdout, nullptr, _IONBF, 0);
282
283
190
    Run_Auto_Options autotest_opts = default_run_auto_options();
284
190
    autotest_opts.graph = GRAPH_COMPLETE;
285
286
190
    Tox_Options *opts = tox_options_new(nullptr);
287
190
    ck_assert(opts != nullptr);
288
190
    tox_options_set_experimental_groups_persistence(opts, true);
289
190
    run_auto_test(opts, NUM_GROUP_TOXES, group_save_test, sizeof(State), &autotest_opts);
290
190
    tox_options_free(opts);
291
292
190
    return 0;
293
190
}
294
295
#undef NUM_GROUP_TOXES
296
#undef GROUP_NAME
297
#undef GROUP_NAME_LEN
298
#undef TOPIC
299
#undef TOPIC_LEN
300
#undef NEW_PRIV_STATE
301
#undef PASSWORD
302
#undef PASS_LEN
303
#undef PEER_LIMIT
304
#undef PEER0_NICK
305
#undef PEER0_NICK_LEN
306
#undef NEW_USER_STATUS