liblinphone_tester.h 17.7 KB
Newer Older
jehan's avatar
jehan committed
1
/*
2 3
	liblinphone_tester - liblinphone test suite
	Copyright (C) 2013  Belledonne Communications SARL
jehan's avatar
jehan committed
4

5 6 7 8
	This program 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 2 of the License, or
	(at your option) any later version.
jehan's avatar
jehan committed
9

10 11 12 13
	This program 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.
jehan's avatar
jehan committed
14

15 16
	You should have received a copy of the GNU General Public License
	along with this program.  If not, see <http://www.gnu.org/licenses/>.
jehan's avatar
jehan committed
17 18
*/

Simon Morlat's avatar
Simon Morlat committed
19

jehan's avatar
jehan committed
20 21 22 23 24
#ifndef LIBLINPHONE_TESTER_H_
#define LIBLINPHONE_TESTER_H_



25
#include <bctoolbox/tester.h>
Sylvain Berfini's avatar
Sylvain Berfini committed
26
#include "linphonecore.h"
27
#include <mediastreamer2/msutils.h>
28 29 30
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
31

32 33 34 35 36 37

#ifdef _MSC_VER
#define popen _popen
#define pclose _pclose
#endif

38 39 40 41 42 43 44
#ifdef __cplusplus
extern "C" {
#endif

extern test_suite_t setup_test_suite;
extern test_suite_t register_test_suite;
extern test_suite_t call_test_suite;
45
extern test_suite_t call_video_test_suite;
46 47
extern test_suite_t message_test_suite;
extern test_suite_t presence_test_suite;
48
extern test_suite_t presence_server_test_suite;
Yann Diorcet's avatar
Yann Diorcet committed
49
extern test_suite_t upnp_test_suite;
50
extern test_suite_t event_test_suite;
Simon Morlat's avatar
Simon Morlat committed
51
extern test_suite_t flexisip_test_suite;
52
extern test_suite_t stun_test_suite;
53
extern test_suite_t remote_provisioning_test_suite;
54
extern test_suite_t quality_reporting_test_suite;
55
extern test_suite_t log_collection_test_suite;
56
extern test_suite_t tunnel_test_suite;
57
extern test_suite_t player_test_suite;
58
extern test_suite_t dtmf_test_suite;
59
extern test_suite_t offeranswer_test_suite;
60
extern test_suite_t video_test_suite;
jehan's avatar
jehan committed
61
extern test_suite_t multicast_call_test_suite;
62
extern test_suite_t multi_call_test_suite;
63
extern test_suite_t proxy_config_test_suite;
64
#ifdef VCARD_ENABLED
65
extern test_suite_t vcard_test_suite;
66
#endif
67
extern test_suite_t audio_bypass_suite;
jehan's avatar
jehan committed
68 69 70
#if HAVE_SIPP
extern test_suite_t complex_sip_call_test_suite;
#endif
71
extern int manager_count;
72

Simon Morlat's avatar
Simon Morlat committed
73
extern int liblinphone_tester_ipv6_available(void);
74
extern int liblinphone_tester_ipv4_available(void);
75

76 77 78
/**
 * @brief Tells the tester whether or not to clean the accounts it has created between runs.
 * @details Setting this to 1 will not clear the list of created accounts between successive
79
 * calls to liblinphone_run_tests(). Some testing APIs call this function for *each* test,
80
 * in which case we should keep the accounts that were created for further testing.
81 82
 *
 * You are supposed to manually call liblinphone_tester_clear_account when all the tests are
83
 * finished.
84
 *
85 86 87 88
 * @param keep 1 to keep the accounts in-between runs, 0 to clear them after each run.
 */
extern void liblinphone_tester_keep_accounts( int keep );

89 90 91 92 93 94
/**
 * @brief Tells the test whether to not remove recorded audio/video files after the tests.
 * @details By default recorded files are erased after the test, unless the test is failed.
**/
void liblinphone_tester_keep_recorded_files(int keep);

95 96 97 98 99 100
/**
 * @brief Disable the automatic object leak detection. This is useful because the object leak detector prevents valgrind from seeing the leaks.
 * @details By default object leak detector is enabled.
**/
void liblinphone_tester_disable_leak_detector(int disabled);

101 102 103 104 105
/**
 * @brief Clears the created accounts during the testing session.
 */
extern void liblinphone_tester_clear_accounts(void);

106

107 108 109 110 111
extern const char* test_domain;
extern const char* auth_domain;
extern const char* test_username;
extern const char* test_password;
extern const char* test_route;
112
extern const char* userhostsfile;
113
extern bool_t liblinphonetester_ipv6;
jehan's avatar
jehan committed
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141

typedef struct _stats {
	int number_of_LinphoneRegistrationNone;
	int number_of_LinphoneRegistrationProgress ;
	int number_of_LinphoneRegistrationOk ;
	int number_of_LinphoneRegistrationCleared ;
	int number_of_LinphoneRegistrationFailed ;
	int number_of_auth_info_requested ;


	int number_of_LinphoneCallIncomingReceived;
	int number_of_LinphoneCallOutgoingInit;
	int number_of_LinphoneCallOutgoingProgress;
	int number_of_LinphoneCallOutgoingRinging;
	int number_of_LinphoneCallOutgoingEarlyMedia;
	int number_of_LinphoneCallConnected;
	int number_of_LinphoneCallStreamsRunning;
	int number_of_LinphoneCallPausing;
	int number_of_LinphoneCallPaused;
	int number_of_LinphoneCallResuming;
	int number_of_LinphoneCallRefered;
	int number_of_LinphoneCallError;
	int number_of_LinphoneCallEnd;
	int number_of_LinphoneCallPausedByRemote;
	int number_of_LinphoneCallUpdatedByRemote;
	int number_of_LinphoneCallIncomingEarlyMedia;
	int number_of_LinphoneCallUpdating;
	int number_of_LinphoneCallReleased;
142 143
	int number_of_LinphoneCallEarlyUpdatedByRemote;
	int number_of_LinphoneCallEarlyUpdating;
jehan's avatar
jehan committed
144

jehan's avatar
jehan committed
145
	int number_of_LinphoneTransferCallOutgoingInit;
146 147 148 149 150
	int number_of_LinphoneTransferCallOutgoingProgress;
	int number_of_LinphoneTransferCallOutgoingRinging;
	int number_of_LinphoneTransferCallOutgoingEarlyMedia;
	int number_of_LinphoneTransferCallConnected;
	int number_of_LinphoneTransferCallStreamsRunning;
151
	int number_of_LinphoneTransferCallError;
jehan's avatar
jehan committed
152

jehan's avatar
jehan committed
153
	int number_of_LinphoneMessageReceived;
jehan's avatar
jehan committed
154
	int number_of_LinphoneMessageReceivedWithFile;
155 156 157 158 159
	int number_of_LinphoneMessageReceivedLegacy;
	int number_of_LinphoneMessageExtBodyReceived;
	int number_of_LinphoneMessageInProgress;
	int number_of_LinphoneMessageDelivered;
	int number_of_LinphoneMessageNotDelivered;
Simon Morlat's avatar
Simon Morlat committed
160
	int number_of_LinphoneMessageFileTransferDone;
161 162
	int number_of_LinphoneIsComposingActiveReceived;
	int number_of_LinphoneIsComposingIdleReceived;
163
	int progress_of_LinphoneFileTransfer;
164

jehan's avatar
jehan committed
165
	int number_of_IframeDecoded;
jehan's avatar
jehan committed
166 167 168

	int number_of_NewSubscriptionRequest;
	int number_of_NotifyReceived;
Ghislain MARY's avatar
Ghislain MARY committed
169
	int number_of_NotifyPresenceReceived;
170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198
	int number_of_LinphonePresenceActivityOffline;
	int number_of_LinphonePresenceActivityOnline;
	int number_of_LinphonePresenceActivityAppointment;
	int number_of_LinphonePresenceActivityAway;
	int number_of_LinphonePresenceActivityBreakfast;
	int number_of_LinphonePresenceActivityBusy;
	int number_of_LinphonePresenceActivityDinner;
	int number_of_LinphonePresenceActivityHoliday;
	int number_of_LinphonePresenceActivityInTransit;
	int number_of_LinphonePresenceActivityLookingForWork;
	int number_of_LinphonePresenceActivityLunch;
	int number_of_LinphonePresenceActivityMeal;
	int number_of_LinphonePresenceActivityMeeting;
	int number_of_LinphonePresenceActivityOnThePhone;
	int number_of_LinphonePresenceActivityOther;
	int number_of_LinphonePresenceActivityPerformance;
	int number_of_LinphonePresenceActivityPermanentAbsence;
	int number_of_LinphonePresenceActivityPlaying;
	int number_of_LinphonePresenceActivityPresentation;
	int number_of_LinphonePresenceActivityShopping;
	int number_of_LinphonePresenceActivitySleeping;
	int number_of_LinphonePresenceActivitySpectator;
	int number_of_LinphonePresenceActivitySteering;
	int number_of_LinphonePresenceActivityTravel;
	int number_of_LinphonePresenceActivityTV;
	int number_of_LinphonePresenceActivityUnknown;
	int number_of_LinphonePresenceActivityVacation;
	int number_of_LinphonePresenceActivityWorking;
	int number_of_LinphonePresenceActivityWorship;
199
	const LinphonePresenceModel *last_received_presence;
200

201 202
	int number_of_LinphonePresenceBasicStatusOpen;
	int number_of_LinphonePresenceBasicStatusClosed;
203

204
	int number_of_inforeceived;
205
	LinphoneInfoMessage* last_received_info_message;
jehan's avatar
jehan committed
206

207 208 209 210 211 212
	int number_of_LinphoneSubscriptionIncomingReceived;
	int number_of_LinphoneSubscriptionOutgoingInit;
	int number_of_LinphoneSubscriptionPending;
	int number_of_LinphoneSubscriptionActive;
	int number_of_LinphoneSubscriptionTerminated;
	int number_of_LinphoneSubscriptionError;
213
	int number_of_LinphoneSubscriptionExpiring;
jehan's avatar
jehan committed
214

215 216 217 218 219
	int number_of_LinphonePublishProgress;
	int number_of_LinphonePublishOk;
	int number_of_LinphonePublishExpiring;
	int number_of_LinphonePublishError;
	int number_of_LinphonePublishCleared;
220

221 222 223
	int number_of_LinphoneConfiguringSkipped;
	int number_of_LinphoneConfiguringFailed;
	int number_of_LinphoneConfiguringSuccessful;
224 225 226

	int number_of_LinphoneCallEncryptedOn;
	int number_of_LinphoneCallEncryptedOff;
227 228
	int number_of_NetworkReachableTrue;
	int number_of_NetworkReachableFalse;
229
	int number_of_player_eof;
jehan's avatar
jehan committed
230
	LinphoneChatMessage* last_received_chat_message;
231 232

	char * dtmf_list_received;
233
	int dtmf_count;
234

235
	int number_of_LinphoneCallStatsUpdated;
236
	int number_of_rtcp_sent;
237 238
	int number_of_rtcp_received; /*total number of rtcp packet received */
	int number_of_rtcp_received_via_mux;/*number of rtcp packet received in rtcp-mux mode*/
239

240
	int number_of_video_windows_created;
241

242
	int number_of_LinphoneFileTransferDownloadSuccessful;
243 244 245
	int number_of_LinphoneCoreLogCollectionUploadStateDelivered;
	int number_of_LinphoneCoreLogCollectionUploadStateNotDelivered;
	int number_of_LinphoneCoreLogCollectionUploadStateInProgress;
246 247 248 249 250
	int audio_download_bandwidth[3];
	int audio_upload_bandwidth[3];

	int video_download_bandwidth[3];
	int video_upload_bandwidth[3];
251
	int current_bandwidth_index[2] /*audio and video only*/;
252

253
	int number_of_rtcp_generic_nack;
jehan's avatar
jehan committed
254
}stats;
255

256

jehan's avatar
jehan committed
257 258 259 260 261
typedef struct _LinphoneCoreManager {
	LinphoneCoreVTable v_table;
	LinphoneCore* lc;
	stats stat;
	LinphoneAddress* identity;
262 263
	LinphoneEvent *lev;
	bool_t decline_subscribe;
264
	int number_of_cunit_error_at_creation;
jehan's avatar
jehan committed
265 266
} LinphoneCoreManager;

267 268 269 270
typedef struct _LinphoneConferenceServer {
	LinphoneCoreManager base;
	LinphoneCall *first_call;
	LinphoneCoreVTable *vtable;
271
	LinphoneRegistrationState reg_state;
272 273
} LinphoneConferenceServer;

274 275 276
typedef struct _LinphoneCallTestParams {
	LinphoneCallParams *base;
	bool_t sdp_removal;
277
	bool_t sdp_simulate_error;
278 279
} LinphoneCallTestParams;

280

281
void liblinphone_tester_add_suites(void);
282

283 284
void linphone_core_manager_init(LinphoneCoreManager *mgr, const char* rc_file);
void linphone_core_manager_start(LinphoneCoreManager *mgr, int check_for_proxies);
Simon Morlat's avatar
Simon Morlat committed
285 286
LinphoneCoreManager* linphone_core_manager_new2(const char* rc_file, int check_for_proxies);
LinphoneCoreManager* linphone_core_manager_new(const char* rc_file);
287
void linphone_core_manager_stop(LinphoneCoreManager *mgr);
288
void linphone_core_manager_uninit(LinphoneCoreManager *mgr);
jehan's avatar
jehan committed
289 290 291 292 293
void linphone_core_manager_destroy(LinphoneCoreManager* mgr);

void reset_counters( stats* counters);

void registration_state_changed(struct _LinphoneCore *lc, LinphoneProxyConfig *cfg, LinphoneRegistrationState cstate, const char *message);
jehan's avatar
jehan committed
294
void call_state_changed(LinphoneCore *lc, LinphoneCall *call, LinphoneCallState cstate, const char *msg);
jehan's avatar
jehan committed
295
void linphone_transfer_state_changed(LinphoneCore *lc, LinphoneCall *transfered, LinphoneCallState new_call_state);
jehan's avatar
jehan committed
296 297
void notify_presence_received(LinphoneCore *lc, LinphoneFriend * lf);
void text_message_received(LinphoneCore *lc, LinphoneChatRoom *room, const LinphoneAddress *from_address, const char *message);
298
void message_received(LinphoneCore *lc, LinphoneChatRoom *room, LinphoneChatMessage* message);
Ghislain MARY's avatar
Ghislain MARY committed
299
void file_transfer_received(LinphoneChatMessage *message, const LinphoneContent* content, const LinphoneBuffer *buffer);
300 301
LinphoneBuffer * tester_file_transfer_send(LinphoneChatMessage *message, const LinphoneContent* content, size_t offset, size_t size);
LinphoneBuffer * tester_memory_file_transfer_send(LinphoneChatMessage *message, const LinphoneContent* content, size_t offset, size_t size);
302
void file_transfer_progress_indication(LinphoneChatMessage *message, const LinphoneContent* content, size_t offset, size_t total);
303
void is_composing_received(LinphoneCore *lc, LinphoneChatRoom *room);
304
void info_message_received(LinphoneCore *lc, LinphoneCall *call, const LinphoneInfoMessage *msg);
305
void new_subscription_requested(LinphoneCore *lc, LinphoneFriend *lf, const char *url);
306
void linphone_subscription_state_change(LinphoneCore *lc, LinphoneEvent *ev, LinphoneSubscriptionState state);
307
void linphone_publish_state_changed(LinphoneCore *lc, LinphoneEvent *ev, LinphonePublishState state);
308
void linphone_notify_received(LinphoneCore *lc, LinphoneEvent *lev, const char *eventname, const LinphoneContent *content);
309
void linphone_configuration_status(LinphoneCore *lc, LinphoneConfiguringState status, const char *message);
310
void linphone_call_encryption_changed(LinphoneCore *lc, LinphoneCall *call, bool_t on, const char *authentication_token);
311
void dtmf_received(LinphoneCore *lc, LinphoneCall *call, int dtmf);
312
void call_stats_updated(LinphoneCore *lc, LinphoneCall *call, const LinphoneCallStats *stats);
313

jehan's avatar
jehan committed
314 315
LinphoneAddress * create_linphone_address(const char * domain);
bool_t wait_for(LinphoneCore* lc_1, LinphoneCore* lc_2,int* counter,int value);
jehan's avatar
jehan committed
316
bool_t wait_for_list(MSList* lcs,int* counter,int value,int timeout_ms);
jehan's avatar
jehan committed
317
bool_t wait_for_until(LinphoneCore* lc_1, LinphoneCore* lc_2,int* counter,int value,int timout_ms);
318

319 320 321 322
bool_t call_with_params(LinphoneCoreManager* caller_mgr
						,LinphoneCoreManager* callee_mgr
						, const LinphoneCallParams *caller_params
						, const LinphoneCallParams *callee_params);
323 324 325 326
bool_t call_with_test_params(LinphoneCoreManager* caller_mgr
				,LinphoneCoreManager* callee_mgr
				,const LinphoneCallTestParams *caller_test_params
				,const LinphoneCallTestParams *callee_test_params);
327 328 329 330 331
bool_t call_with_params2(LinphoneCoreManager* caller_mgr
						,LinphoneCoreManager* callee_mgr
						, const LinphoneCallTestParams *caller_test_params
						, const LinphoneCallTestParams *callee_test_params
						, bool_t build_callee_params);
332

jehan's avatar
jehan committed
333
bool_t call(LinphoneCoreManager* caller_mgr,LinphoneCoreManager* callee_mgr);
334
bool_t add_video(LinphoneCoreManager* caller,LinphoneCoreManager* callee, bool_t change_video_policy);
335
void end_call(LinphoneCoreManager *m1, LinphoneCoreManager *m2);
336
void disable_all_audio_codecs_except_one(LinphoneCore *lc, const char *mime, int rate);
337
void disable_all_video_codecs_except_one(LinphoneCore *lc, const char *mime);
338
void disable_all_codecs(const MSList* elem, LinphoneCoreManager* call);
339
stats * get_stats(LinphoneCore *lc);
340
bool_t transport_supported(LinphoneTransportType transport);
341
LinphoneCoreManager *get_manager(LinphoneCore *lc);
Simon Morlat's avatar
Simon Morlat committed
342 343 344
const char *liblinphone_tester_get_subscribe_content(void);
const char *liblinphone_tester_get_notify_content(void);
void liblinphone_tester_chat_message_state_change(LinphoneChatMessage* msg,LinphoneChatMessageState state,void* ud);
345
void liblinphone_tester_chat_message_msg_state_changed(LinphoneChatMessage *msg, LinphoneChatMessageState state);
Simon Morlat's avatar
Simon Morlat committed
346
void liblinphone_tester_check_rtcp(LinphoneCoreManager* caller, LinphoneCoreManager* callee);
347
void liblinphone_tester_clock_start(MSTimeSpec *start);
348
bool_t liblinphone_tester_clock_elapsed(const MSTimeSpec *start, int value_ms);
349 350 351
void linphone_core_manager_check_accounts(LinphoneCoreManager *m);
void account_manager_destroy(void);
LinphoneCore* configure_lc_from(LinphoneCoreVTable* v_table, const char* path, const char* file, void* user_data);
352

Simon Morlat's avatar
Simon Morlat committed
353
void linphone_call_iframe_decoded_cb(LinphoneCall *call,void * user_data);
354
void call_paused_resumed_base(bool_t multicast,bool_t with_losses);
jehan's avatar
jehan committed
355
void simple_call_base(bool_t enable_multicast_recv_side);
356
void call_base_with_configfile(LinphoneMediaEncryption mode, bool_t enable_video,bool_t enable_relay,LinphoneFirewallPolicy policy,bool_t enable_tunnel, const char *marie_rc, const char *pauline_rc);
jehan's avatar
jehan committed
357
void call_base(LinphoneMediaEncryption mode, bool_t enable_video,bool_t enable_relay,LinphoneFirewallPolicy policy,bool_t enable_tunnel);
358 359
bool_t call_with_caller_params(LinphoneCoreManager* caller_mgr,LinphoneCoreManager* callee_mgr, const LinphoneCallParams *params);
bool_t pause_call_1(LinphoneCoreManager* mgr_1,LinphoneCall* call_1,LinphoneCoreManager* mgr_2,LinphoneCall* call_2);
360
void compare_files(const char *path1, const char *path2);
361
void check_media_direction(LinphoneCoreManager* mgr, LinphoneCall *call, MSList* lcs,LinphoneMediaDirection audio_dir, LinphoneMediaDirection video_dir);
362 363 364
void _call_with_ice_base(LinphoneCoreManager* pauline,LinphoneCoreManager* marie, bool_t caller_with_ice, bool_t callee_with_ice, bool_t random_ports, bool_t forced_relay);
void check_nb_media_starts(LinphoneCoreManager *caller, LinphoneCoreManager *callee, unsigned int caller_nb_media_starts, unsigned int callee_nb_media_starts);
void record_call(const char *filename, bool_t enableVideo, const char *video_codec);
365

366
extern const MSAudioDiffParams audio_cmp_params;
367

368 369 370 371
/*
 * this function return max value in the last 3 seconds*/
int linphone_core_manager_get_max_audio_down_bw(const LinphoneCoreManager *mgr);
int linphone_core_manager_get_max_audio_up_bw(const LinphoneCoreManager *mgr);
372 373 374
int linphone_core_manager_get_mean_audio_down_bw(const LinphoneCoreManager *mgr);
int linphone_core_manager_get_mean_audio_up_bw(const LinphoneCoreManager *mgr);

375
void video_call_base_2(LinphoneCoreManager* pauline,LinphoneCoreManager* marie, bool_t using_policy,LinphoneMediaEncryption mode, bool_t callee_video_enabled, bool_t caller_video_enabled);
376

377
void liblinphone_tester_before_each(void);
378
int liblinphone_tester_after_each(void);
379 380
void liblinphone_tester_init(void(*ftester_printf)(int level, const char *fmt, va_list args));
void liblinphone_tester_uninit(void);
381
int liblinphone_tester_set_log_file(const char *filename);
382
bool_t check_ice(LinphoneCoreManager* caller, LinphoneCoreManager* callee, LinphoneIceState state);
Ghislain MARY's avatar
Ghislain MARY committed
383
void check_nb_media_starts(LinphoneCoreManager *caller, LinphoneCoreManager *callee, unsigned int caller_nb_media_starts, unsigned int callee_nb_media_starts);
384

385
LinphoneConferenceServer* linphone_conference_server_new(const char *rc_file, bool_t do_registration);
386 387
void linphone_conference_server_destroy(LinphoneConferenceServer *conf_srv);

388
extern const char *liblinphone_tester_mire_id;
389

390 391
LinphoneAddress * linphone_core_manager_resolve(LinphoneCoreManager *mgr, const LinphoneAddress *source);
FILE *sip_start(const char *senario, const char* dest_username, const char *passwd, LinphoneAddress* dest_addres);
jehan's avatar
jehan committed
392

393
void early_media_without_sdp_in_200_base( bool_t use_video, bool_t use_ice );
jehan's avatar
jehan committed
394

395 396 397 398

#ifdef __cplusplus
};
#endif
399 400

#endif /* LIBLINPHONE_TESTER_H_ */