| 1 |
/* |
| 2 |
* SPDX-FileCopyrightText: (C) 2013 Red Hat, Inc. (www.redhat.com) |
| 3 |
* SPDX-FileContributor: Fabiano FidĂȘncio <[email protected]> |
| 4 |
* SPDX-FileContributor: Philip Withnall <[email protected]> |
| 5 |
* SPDX-FileContributor: Vadim Rutkovsky <[email protected]> |
| 6 |
* SPDX-License-Identifier: LGPL-2.1-or-later |
| 7 |
*/ |
| 8 |
|
| 9 |
#include "evolution-ews-config.h" |
| 10 |
|
| 11 |
#include <string.h> |
| 12 |
|
| 13 |
#include "ews-test-common.h" |
| 14 |
|
| 15 |
/* declaration of debug handler */ |
| 16 |
static void ews_test_debug_handler (const gchar *log_domain, |
| 17 |
GLogLevelFlags log_level, |
| 18 |
const gchar *message, |
| 19 |
gpointer user_data); |
| 20 |
|
| 21 |
/* Directory to output network trace files to, if trace output is enabled. (NULL otherwise.) */ |
| 22 |
static const GFile *trace_dir = NULL; |
| 23 |
|
| 24 |
/* |
| 25 |
* TRUE if tests should be run and a trace file written for each; |
| 26 |
* FALSE if tests should run offline against existing trace files. |
| 27 |
*/ |
| 28 |
static gboolean write_traces = FALSE; |
| 29 |
|
| 30 |
/* Global mock server instance used by all tests */ |
| 31 |
static UhmServer *mock_server = NULL; |
| 32 |
|
| 33 |
static GList *etds = NULL; |
| 34 |
|
| 35 |
static gboolean no_interactive = FALSE; |
| 36 |
|
| 37 |
static void |
| 38 |
prepare_fake_data (guint *number, |
| 39 |
GList **fake_versions, |
| 40 |
GList **fake_hostnames, |
| 41 |
GList **fake_server_uris) |
| 42 |
{ |
| 43 |
/* Underscores cannot be used in the host name (A disallowed SNI server name has been received). |
| 44 |
See https://gitlab.com/uhttpmock/uhttpmock/-/issues/5 */ |
| 45 |
struct _supported_versions { |
| 46 |
const gchar *hostname; |
| 47 |
const gchar *version; |
| 48 |
} supported_versions[] = { |
| 49 |
{ "2007SP1", "2007_SP1" }, |
| 50 |
{ "2010SP2", "2010_SP2" } |
| 51 |
}; |
| 52 |
guint ii; |
| 53 |
|
| 54 |
for (ii = 0; ii < G_N_ELEMENTS (supported_versions); ii++) { |
| 55 |
*fake_versions = g_list_append ( |
| 56 |
*fake_versions, |
| 57 |
g_strdup_printf ("Exchange%s", supported_versions[ii].version)); |
| 58 |
*fake_hostnames = g_list_append ( |
| 59 |
*fake_hostnames, |
| 60 |
g_strdup_printf ("exchange%s.server.com", supported_versions[ii].hostname)); |
| 61 |
*fake_server_uris = g_list_append ( |
| 62 |
*fake_server_uris, |
| 63 |
g_strdup_printf ("https://exchange%s.server.com:PORT/EWS/Exchange.asmx", supported_versions[ii].hostname)); |
| 64 |
} |
| 65 |
|
| 66 |
*number = ii; |
| 67 |
} |
| 68 |
|
| 69 |
static void |
| 70 |
help (gchar *program) |
| 71 |
{ |
| 72 |
/* We have to override --help in order to document --no-interactive and the trace flags. */ |
| 73 |
g_print ("Usage:\n" |
| 74 |
" %s [OPTION...]\n\n" |
| 75 |
"Help Options:\n" |
| 76 |
" -?, --help Show help options\n" |
| 77 |
"Test Options:\n" |
| 78 |
" -l List test cases available in a test executable\n" |
| 79 |
" -seed=RANDOMSEED Provide a random seed to reproduce test\n" |
| 80 |
" runs using random numbers\n" |
| 81 |
" --verbose Run tests verbosely\n" |
| 82 |
" -q, --quiet Run tests quietly\n" |
| 83 |
" -p TESTPATH Execute all tests matching TESTPATH\n" |
| 84 |
" -m {perf|slow|thorough|quick} Execute tests according modes\n" |
| 85 |
" --debug-log Debug test logging output\n" |
| 86 |
" -i, --no-interactive Only execute tests which don't require user interaction\n" |
| 87 |
" -t, --trace-dir [directory] Read/Write trace files in the specified directory\n" |
| 88 |
" -w, --write-traces Work online and write trace files to --trace-dir\n" |
| 89 |
" -c, --config In the format: key=value, where valid keys are:\n" |
| 90 |
" version, server-uri, username, password\n", |
| 91 |
program); |
| 92 |
} |
| 93 |
|
| 94 |
gint |
| 95 |
ews_test_init (gint argc, |
| 96 |
gchar **argv) |
| 97 |
{ |
| 98 |
guint ret = 0; |
| 99 |
guint number = 0; |
| 100 |
guint i; |
| 101 |
GList *versions = NULL; |
| 102 |
GList *server_uris = NULL; |
| 103 |
GList *usernames = NULL; |
| 104 |
GList *passwords = NULL; |
| 105 |
GList *fake_versions = NULL; |
| 106 |
GList *fake_hostnames = NULL; |
| 107 |
GList *fake_server_uris = NULL; |
| 108 |
|
| 109 |
#if !GLIB_CHECK_VERSION (2, 35, 0) |
| 110 |
g_type_init (); |
| 111 |
#endif |
| 112 |
|
| 113 |
/* Parse the custom options */ |
| 114 |
for (i = 1; i < argc; i++) { |
| 115 |
if (g_strcmp0 ("--no-interactive", argv[i]) == 0 || g_strcmp0 ("-i", argv[i]) == 0) { |
| 116 |
no_interactive = TRUE; |
| 117 |
argv[i] = (char *) ""; |
| 118 |
} else if (g_strcmp0 ("--trace-dir", argv[i]) == 0 || g_strcmp0 ("-t", argv[i]) == 0) { |
| 119 |
if (i >= argc - 1) { |
| 120 |
g_list_free_full (versions, g_free); |
| 121 |
g_list_free_full (server_uris, g_free); |
| 122 |
g_list_free_full (usernames, g_free); |
| 123 |
g_list_free_full (passwords, g_free); |
| 124 |
|
| 125 |
g_error ("Error: Missing directory for --trace-dir option.\n"); |
| 126 |
} |
| 127 |
|
| 128 |
trace_dir = g_file_new_for_path (argv[i + 1]); |
| 129 |
|
| 130 |
argv[i] = (char *) ""; |
| 131 |
argv[i + 1] = (char *) ""; |
| 132 |
i += 2; |
| 133 |
} else if (g_strcmp0 ("--config", argv[i]) == 0 || g_strcmp0 ("-c", argv[i]) == 0) { |
| 134 |
const gchar *val; |
| 135 |
const gchar *value; |
| 136 |
gchar *key; |
| 137 |
gsize len; |
| 138 |
|
| 139 |
if (i >= argc - 1) { |
| 140 |
g_list_free_full (versions, g_free); |
| 141 |
g_list_free_full (server_uris, g_free); |
| 142 |
g_list_free_full (usernames, g_free); |
| 143 |
g_list_free_full (passwords, g_free); |
| 144 |
|
| 145 |
g_error ("Error: Missing arguments for --config option.\n" |
| 146 |
" Expected: --config key=value, with valid these valid keys:\n" |
| 147 |
" version, server-uri, username, password\n"); |
| 148 |
} |
| 149 |
|
| 150 |
value = argv[i + 1]; |
| 151 |
|
| 152 |
if (!(val = strchr (value, '='))) { |
| 153 |
g_list_free_full (versions, g_free); |
| 154 |
g_list_free_full (server_uris, g_free); |
| 155 |
g_list_free_full (usernames, g_free); |
| 156 |
g_list_free_full (passwords, g_free); |
| 157 |
|
| 158 |
g_error ("Error: Missing arguments for --config option.\n" |
| 159 |
" Expected: --config key=value, with valid these valid keys:\n" |
| 160 |
" version, server-uri, username, password\n"); |
| 161 |
} |
| 162 |
|
| 163 |
len = val - value; |
| 164 |
val++; |
| 165 |
key = g_strndup (value, len); |
| 166 |
|
| 167 |
if (g_strcmp0 (key, "number") == 0) |
| 168 |
number = g_ascii_strtoll (val, NULL, 0); |
| 169 |
else if (g_strcmp0 (key, "version") == 0) |
| 170 |
versions = g_list_append (versions, g_strdup (val)); |
| 171 |
else if (g_strcmp0 (key, "server-uri") == 0) |
| 172 |
server_uris = g_list_append (server_uris, g_strdup (val)); |
| 173 |
else if (g_strcmp0 (key, "username") == 0) |
| 174 |
usernames = g_list_append (usernames, g_strdup (val)); |
| 175 |
else if (g_strcmp0 (key, "password") == 0) |
| 176 |
passwords = g_list_append (passwords, g_strdup (val)); |
| 177 |
|
| 178 |
g_free (key); |
| 179 |
|
| 180 |
argv[i] = (char *) ""; |
| 181 |
argv[i + 1] = (char *) ""; |
| 182 |
i++; |
| 183 |
} else if (g_strcmp0 ("--write-traces", argv[i]) == 0 || g_strcmp0 ("-w", argv[i]) == 0) { |
| 184 |
write_traces = TRUE; |
| 185 |
argv[i] = (char *) ""; |
| 186 |
} else if (g_strcmp0 ("-?", argv[i]) == 0 || g_strcmp0 ("--help", argv[i]) == 0 || g_strcmp0 ("-h" , argv[i]) == 0) { |
| 187 |
help (argv[0]); |
| 188 |
|
| 189 |
exit (0); |
| 190 |
} |
| 191 |
} |
| 192 |
|
| 193 |
if ((number == 0 && write_traces) || |
| 194 |
(number > 0 && |
| 195 |
(number != g_list_length (versions) || |
| 196 |
number != g_list_length (server_uris) || |
| 197 |
number != g_list_length (usernames) || |
| 198 |
number != g_list_length (passwords)))) { |
| 199 |
g_printerr ("Error while parsing options\n"); |
| 200 |
help (argv[0]); |
| 201 |
|
| 202 |
g_list_free_full (versions, g_free); |
| 203 |
g_list_free_full (server_uris, g_free); |
| 204 |
g_list_free_full (usernames, g_free); |
| 205 |
g_list_free_full (passwords, g_free); |
| 206 |
|
| 207 |
exit (1); |
| 208 |
} |
| 209 |
|
| 210 |
g_test_init (&argc, &argv, NULL); |
| 211 |
g_test_bug_base ("http://bugzilla.gnome.org/show_bug.cgi?id="); |
| 212 |
|
| 213 |
g_setenv ("EWS_DEBUG", "4", TRUE); |
| 214 |
g_setenv ("EWS_TEST_WINDOWS_ZONES_XML_PATH", TEST_FILE_DIR "/../src/EWS/calendar/", TRUE); |
| 215 |
|
| 216 |
mock_server = uhm_server_new (); |
| 217 |
uhm_server_set_default_tls_certificate (mock_server); |
| 218 |
uhm_server_set_enable_logging (mock_server, write_traces); |
| 219 |
uhm_server_set_enable_online (mock_server, write_traces); |
| 220 |
|
| 221 |
/* Set handler of debug information */ |
| 222 |
g_log_set_handler ("libeews", G_LOG_LEVEL_DEBUG, ews_test_debug_handler, mock_server); |
| 223 |
|
| 224 |
if (number == 0) |
| 225 |
prepare_fake_data (&number, &fake_versions, &fake_hostnames, &fake_server_uris); |
| 226 |
|
| 227 |
for (i = 0; i < number; i++) { |
| 228 |
EwsTestData *etd; |
| 229 |
|
| 230 |
etd = g_new0 (EwsTestData, 1); |
| 231 |
if (write_traces) { |
| 232 |
CamelEwsSettings *settings = NULL; |
| 233 |
|
| 234 |
settings = g_object_new ( |
| 235 |
CAMEL_TYPE_EWS_SETTINGS, |
| 236 |
"user", g_list_nth_data (usernames, i), |
| 237 |
NULL); |
| 238 |
|
| 239 |
etd->version = g_list_nth_data (versions, i); |
| 240 |
etd->connection = e_ews_connection_new (NULL, g_list_nth_data (server_uris, i), settings); |
| 241 |
e_ews_connection_set_testing_sources (etd->connection, TRUE); |
| 242 |
e_ews_connection_set_password (etd->connection, g_list_nth_data (passwords, i)); |
| 243 |
e_ews_connection_set_server_version_from_string (etd->connection, etd->version); |
| 244 |
|
| 245 |
g_object_unref (settings); |
| 246 |
} else { |
| 247 |
etd->version = g_list_nth_data (fake_versions, i); |
| 248 |
etd->server_uri = g_list_nth_data (fake_server_uris, i); |
| 249 |
etd->hostname = g_list_nth_data (fake_hostnames, i); |
| 250 |
} |
| 251 |
|
| 252 |
etds = g_list_append (etds, etd); |
| 253 |
} |
| 254 |
|
| 255 |
g_list_free (versions); |
| 256 |
g_list_free (usernames); |
| 257 |
g_list_free (server_uris); |
| 258 |
g_list_free (passwords); |
| 259 |
g_list_free (fake_versions); |
| 260 |
g_list_free (fake_server_uris); |
| 261 |
g_list_free (fake_hostnames); |
| 262 |
return ret; |
| 263 |
} |
| 264 |
|
| 265 |
UhmServer * |
| 266 |
ews_test_get_mock_server (void) |
| 267 |
{ |
| 268 |
return mock_server; |
| 269 |
} |
| 270 |
|
| 271 |
GList * /* EwsTestData */ |
| 272 |
ews_test_get_test_data_list (void) |
| 273 |
{ |
| 274 |
return etds; |
| 275 |
} |
| 276 |
|
| 277 |
static void |
| 278 |
ews_test_data_free (EwsTestData *etd) |
| 279 |
{ |
| 280 |
if (etd != NULL) { |
| 281 |
if (etd->connection != NULL) |
| 282 |
g_object_unref (etd->connection); |
| 283 |
|
| 284 |
g_free (etd->hostname); |
| 285 |
g_free (etd->version); |
| 286 |
g_free (etd->server_uri); |
| 287 |
g_free (etd); |
| 288 |
} |
| 289 |
} |
| 290 |
|
| 291 |
void |
| 292 |
ews_test_cleanup (void) |
| 293 |
{ |
| 294 |
g_list_free_full (ews_test_get_test_data_list (), (GDestroyNotify) ews_test_data_free); |
| 295 |
g_object_unref (ews_test_get_mock_server ()); |
| 296 |
} |
| 297 |
|
| 298 |
static void |
| 299 |
ews_test_set_https_port (UhmServer *server, |
| 300 |
EwsTestData *etd) |
| 301 |
{ |
| 302 |
CamelEwsSettings *ews_settings; |
| 303 |
guint16 port; |
| 304 |
gchar *uri; |
| 305 |
gchar **tokens; |
| 306 |
|
| 307 |
port = uhm_server_get_port (server); |
| 308 |
|
| 309 |
tokens = g_strsplit (etd->server_uri, "PORT", 0); |
| 310 |
uri = g_strdup_printf ("%s%d%s", tokens[0], port, tokens[1]); |
| 311 |
|
| 312 |
ews_settings = g_object_new ( |
| 313 |
CAMEL_TYPE_EWS_SETTINGS, |
| 314 |
"user", "foo", |
| 315 |
NULL); |
| 316 |
|
| 317 |
etd->connection = e_ews_connection_new (NULL, uri, ews_settings); |
| 318 |
e_ews_connection_set_testing_sources (etd->connection, TRUE); |
| 319 |
e_ews_connection_set_password (etd->connection, "bar"); |
| 320 |
e_ews_connection_set_server_version_from_string (etd->connection, etd->version); |
| 321 |
|
| 322 |
g_free (uri); |
| 323 |
g_strfreev (tokens); |
| 324 |
g_object_unref (ews_settings); |
| 325 |
} |
| 326 |
|
| 327 |
void |
| 328 |
ews_test_server_start_trace (UhmServer *server, |
| 329 |
EwsTestData *etd, |
| 330 |
const gchar *trace_filename, |
| 331 |
GError **error) |
| 332 |
{ |
| 333 |
uhm_server_start_trace (server, trace_filename, error); |
| 334 |
if (!uhm_server_get_enable_online (server)) |
| 335 |
ews_test_set_https_port (server, etd); |
| 336 |
} |
| 337 |
|
| 338 |
void |
| 339 |
ews_test_server_set_trace_directory (UhmServer *server, |
| 340 |
const gchar *version, |
| 341 |
const gchar *tests) |
| 342 |
{ |
| 343 |
gchar *path; |
| 344 |
GFile *trace_directory; |
| 345 |
|
| 346 |
path = g_strdup_printf (TEST_FILE_DIR "/traces/%s/%s", version, tests); |
| 347 |
trace_directory = g_file_new_for_path (path); |
| 348 |
g_free (path); |
| 349 |
uhm_server_set_trace_directory (server, trace_directory); |
| 350 |
g_object_unref (trace_directory); |
| 351 |
} |
| 352 |
|
| 353 |
static void |
| 354 |
ews_test_debug_handler (const gchar *log_domain, |
| 355 |
GLogLevelFlags log_level, |
| 356 |
const gchar *message, |
| 357 |
gpointer user_data) |
| 358 |
{ |
| 359 |
UhmServer *server = user_data; |
| 360 |
|
| 361 |
if (message != NULL && |
| 362 |
(*message == '<' || *message == '>' || *message == ' ') && |
| 363 |
*(message + 1) == ' ') { |
| 364 |
uhm_server_received_message_chunk (server, message, strlen (message), NULL); |
| 365 |
} |
| 366 |
} |