Merge "ari: Implement 'debug all' and request/response logging"
[asterisk/asterisk.git] / tests / test_cel.c
index 017c48b..c9ceaf9 100644 (file)
@@ -31,8 +31,6 @@
 
 #include "asterisk.h"
 
-ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
-
 #include <math.h>
 #include "asterisk/module.h"
 #include "asterisk/test.h"
@@ -206,9 +204,23 @@ static void do_sleep(void)
 /*! \brief David's Caller ID */
 #define DAVID_CALLERID { .id.name.str = "David", .id.name.valid = 1, .id.number.str = "400", .id.number.valid = 1, }
 
+/*! \brief Set ulaw format on channel */
+#define SET_FORMATS(chan) do {\
+       struct ast_format_cap *caps;\
+       caps = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT);\
+       ast_format_cap_append(caps, ast_format_ulaw, 0);\
+       ast_channel_nativeformats_set((chan), caps);\
+       ast_channel_set_writeformat((chan), ast_format_ulaw);\
+       ast_channel_set_rawwriteformat((chan), ast_format_ulaw);\
+       ast_channel_set_readformat((chan), ast_format_ulaw);\
+       ast_channel_set_rawreadformat((chan), ast_format_ulaw);\
+       ao2_ref(caps, -1);\
+} while (0)
+
 /*! \brief Create a \ref test_cel_chan_tech for Alice. */
 #define CREATE_ALICE_CHANNEL(channel_var, caller_id) do { \
        (channel_var) = ast_channel_alloc(0, AST_STATE_DOWN, (caller_id)->id.number.str, (caller_id)->id.name.str, "100", "100", "default", NULL, NULL, 0, CHANNEL_TECH_NAME "/Alice"); \
+       SET_FORMATS((channel_var));\
        APPEND_EVENT(channel_var, AST_CEL_CHANNEL_START, NULL, NULL); \
        ast_channel_unlock((channel_var)); \
        } while (0)
@@ -216,6 +228,7 @@ static void do_sleep(void)
 /*! \brief Create a \ref test_cel_chan_tech for Bob. */
 #define CREATE_BOB_CHANNEL(channel_var, caller_id) do { \
        (channel_var) = ast_channel_alloc(0, AST_STATE_DOWN, (caller_id)->id.number.str, (caller_id)->id.name.str, "200", "200", "default", NULL, NULL, 0, CHANNEL_TECH_NAME "/Bob"); \
+       SET_FORMATS((channel_var));\
        APPEND_EVENT(channel_var, AST_CEL_CHANNEL_START, NULL, NULL); \
        ast_channel_unlock((channel_var)); \
        } while (0)
@@ -223,6 +236,7 @@ static void do_sleep(void)
 /*! \brief Create a \ref test_cel_chan_tech for Charlie. */
 #define CREATE_CHARLIE_CHANNEL(channel_var, caller_id) do { \
        (channel_var) = ast_channel_alloc(0, AST_STATE_DOWN, (caller_id)->id.number.str, (caller_id)->id.name.str, "300", "300", "default", NULL, NULL, 0, CHANNEL_TECH_NAME "/Charlie"); \
+       SET_FORMATS((channel_var));\
        APPEND_EVENT(channel_var, AST_CEL_CHANNEL_START, NULL, NULL); \
        ast_channel_unlock((channel_var)); \
        } while (0)
@@ -230,6 +244,7 @@ static void do_sleep(void)
 /*! \brief Create a \ref test_cel_chan_tech for David. */
 #define CREATE_DAVID_CHANNEL(channel_var, caller_id) do { \
        (channel_var) = ast_channel_alloc(0, AST_STATE_DOWN, (caller_id)->id.number.str, (caller_id)->id.name.str, "400", "400", "default", NULL, NULL, 0, CHANNEL_TECH_NAME "/David"); \
+       SET_FORMATS((channel_var));\
        APPEND_EVENT(channel_var, AST_CEL_CHANNEL_START, NULL, NULL); \
        ast_channel_unlock((channel_var)); \
        } while (0)
@@ -293,7 +308,9 @@ static int append_expected_event_snapshot(
        struct ast_json *extra,
        const char *peer);
 
+#ifdef RACEY_TESTS
 static int append_dummy_event(void);
+#endif
 
 static struct ast_str *__test_cel_generate_peer_str(struct ast_channel_snapshot *chan, struct ast_bridge_snapshot *bridge)
 {
@@ -411,7 +428,7 @@ AST_TEST_DEFINE(test_cel_unanswered_inbound_call)
                info->description =
                        "Test CEL records for a call that is\n"
                        "inbound to Asterisk, executes some dialplan, but\n"
-                       "is never answered.\n";
+                       "is never answered.";
                return AST_TEST_NOT_RUN;
        case TEST_EXECUTE:
                break;
@@ -442,7 +459,7 @@ AST_TEST_DEFINE(test_cel_unanswered_outbound_call)
                info->summary = "Test outbound unanswered calls";
                info->description =
                        "Test CEL records for a call that is\n"
-                       "outbound to Asterisk but is never answered.\n";
+                       "outbound to Asterisk but is never answered.";
                return AST_TEST_NOT_RUN;
        case TEST_EXECUTE:
                break;
@@ -471,7 +488,7 @@ AST_TEST_DEFINE(test_cel_single_party)
                info->summary = "Test CEL for a single party";
                info->description =
                        "Test CEL records for a call that is\n"
-                       "answered, but only involves a single channel\n";
+                       "answered, but only involves a single channel";
                return AST_TEST_NOT_RUN;
        case TEST_EXECUTE:
                break;
@@ -500,7 +517,7 @@ AST_TEST_DEFINE(test_cel_single_bridge)
                info->summary = "Test CEL for a single party entering/leaving a bridge";
                info->description =
                        "Test CEL records for a call that is\n"
-                       "answered, enters a bridge, and leaves it.\n";
+                       "answered, enters a bridge, and leaves it.";
                return AST_TEST_NOT_RUN;
        case TEST_EXECUTE:
                break;
@@ -538,7 +555,7 @@ AST_TEST_DEFINE(test_cel_single_bridge_continue)
                info->summary = "Test CEL for a single party entering/leaving a bridge";
                info->description =
                        "Test CEL records for a call that is\n"
-                       "answered, enters a bridge, and leaves it.\n";
+                       "answered, enters a bridge, and leaves it.";
                return AST_TEST_NOT_RUN;
        case TEST_EXECUTE:
                break;
@@ -582,7 +599,7 @@ AST_TEST_DEFINE(test_cel_single_twoparty_bridge_a)
                info->description =
                        "Test CEL records for a call that is\n"
                        "answered, enters a bridge, and leaves it. In this scenario, the\n"
-                       "Party A should answer the bridge first.\n";
+                       "Party A should answer the bridge first.";
                return AST_TEST_NOT_RUN;
        case TEST_EXECUTE:
                break;
@@ -630,7 +647,7 @@ AST_TEST_DEFINE(test_cel_single_twoparty_bridge_b)
                info->description =
                        "Test CEL records for a call that is\n"
                        "answered, enters a bridge, and leaves it. In this scenario, the\n"
-                       "Party B should answer the bridge first.\n";
+                       "Party B should answer the bridge first.";
                return AST_TEST_NOT_RUN;
        case TEST_EXECUTE:
                break;
@@ -684,7 +701,7 @@ AST_TEST_DEFINE(test_cel_single_multiparty_bridge)
                info->description =
                        "Test CEL records for a call that is\n"
                        "answered, enters a bridge, and leaves it. A total of three\n"
-                       "parties perform this action.\n";
+                       "parties perform this action.";
                return AST_TEST_NOT_RUN;
        case TEST_EXECUTE:
                break;
@@ -738,6 +755,7 @@ AST_TEST_DEFINE(test_cel_single_multiparty_bridge)
 
 #define START_DIALED_FULL(caller, callee, number, name) do { \
        callee = ast_channel_alloc(0, AST_STATE_DOWN, NULL, NULL, number, NULL, NULL, NULL, caller, 0, CHANNEL_TECH_NAME "/" name); \
+       SET_FORMATS(callee);\
        ast_channel_unlock(callee); \
        if (append_expected_event(callee, AST_CEL_CHANNEL_START, NULL, NULL, NULL)) { \
                return AST_TEST_FAIL; \
@@ -760,7 +778,7 @@ AST_TEST_DEFINE(test_cel_dial_unanswered)
                info->summary = "Test CEL for a dial that isn't answered";
                info->description =
                        "Test CEL records for a channel that\n"
-                       "performs a dial operation that isn't answered\n";
+                       "performs a dial operation that isn't answered";
                return AST_TEST_NOT_RUN;
        case TEST_EXECUTE:
                break;
@@ -794,7 +812,7 @@ AST_TEST_DEFINE(test_cel_dial_unanswered_filter)
                info->summary = "Test CEL for a dial that isn't answered";
                info->description =
                        "Test CEL records for a channel that\n"
-                       "performs a dial operation that isn't answered\n";
+                       "performs a dial operation that isn't answered";
                return AST_TEST_NOT_RUN;
        case TEST_EXECUTE:
                break;
@@ -829,7 +847,7 @@ AST_TEST_DEFINE(test_cel_dial_busy)
                info->summary = "Test CEL for a dial that results in a busy";
                info->description =
                        "Test CEL records for a channel that\n"
-                       "performs a dial operation to an endpoint that's busy\n";
+                       "performs a dial operation to an endpoint that's busy";
                return AST_TEST_NOT_RUN;
        case TEST_EXECUTE:
                break;
@@ -863,7 +881,7 @@ AST_TEST_DEFINE(test_cel_dial_congestion)
                info->summary = "Test CEL for a dial that results in congestion";
                info->description =
                        "Test CEL records for a channel that\n"
-                       "performs a dial operation to an endpoint that's congested\n";
+                       "performs a dial operation to an endpoint that's congested";
                return AST_TEST_NOT_RUN;
        case TEST_EXECUTE:
                break;
@@ -897,7 +915,7 @@ AST_TEST_DEFINE(test_cel_dial_unavailable)
                info->summary = "Test CEL for a dial that results in unavailable";
                info->description =
                        "Test CEL records for a channel that\n"
-                       "performs a dial operation to an endpoint that's unavailable\n";
+                       "performs a dial operation to an endpoint that's unavailable";
                return AST_TEST_NOT_RUN;
        case TEST_EXECUTE:
                break;
@@ -932,7 +950,7 @@ AST_TEST_DEFINE(test_cel_dial_caller_cancel)
                info->description =
                        "Test CEL records for a channel that\n"
                        "performs a dial operation to an endpoint but then decides\n"
-                       "to hang up, cancelling the dial\n";
+                       "to hang up, cancelling the dial";
                return AST_TEST_NOT_RUN;
        case TEST_EXECUTE:
                break;
@@ -969,7 +987,7 @@ AST_TEST_DEFINE(test_cel_dial_parallel_failed)
                info->description =
                        "This tests dialing three parties: Bob, Charlie, David. Charlie\n"
                        "returns BUSY; David returns CONGESTION; Bob fails to answer and\n"
-                       "Alice hangs up. Three records are created for Alice as a result.\n";
+                       "Alice hangs up. Three records are created for Alice as a result.";
                return AST_TEST_NOT_RUN;
        case TEST_EXECUTE:
                break;
@@ -1022,7 +1040,7 @@ AST_TEST_DEFINE(test_cel_dial_answer_no_bridge)
                        "a dial, then bounce both channels to different priorities and\n"
                        "never have them enter a bridge together. Ew. This makes sure that\n"
                        "when we answer, we get a CEL, it gets ended at that point, and\n"
-                       "that it gets finalized appropriately.\n";
+                       "that it gets finalized appropriately.";
                return AST_TEST_NOT_RUN;
        case TEST_EXECUTE:
                break;
@@ -1063,7 +1081,7 @@ AST_TEST_DEFINE(test_cel_dial_answer_twoparty_bridge_a)
                info->category = TEST_CATEGORY;
                info->summary = "Test dialing, answering, and going into a 2-party bridge";
                info->description =
-                       "The most 'basic' of scenarios\n";
+                       "The most 'basic' of scenarios";
                return AST_TEST_NOT_RUN;
        case TEST_EXECUTE:
                break;
@@ -1110,7 +1128,7 @@ AST_TEST_DEFINE(test_cel_dial_answer_twoparty_bridge_b)
                info->category = TEST_CATEGORY;
                info->summary = "Test dialing, answering, and going into a 2-party bridge";
                info->description =
-                       "The most 'basic' of scenarios\n";
+                       "The most 'basic' of scenarios";
                return AST_TEST_NOT_RUN;
        case TEST_EXECUTE:
                break;
@@ -1160,7 +1178,7 @@ AST_TEST_DEFINE(test_cel_dial_answer_multiparty)
                info->category = TEST_CATEGORY;
                info->summary = "Test dialing, answering, and going into a multi-party bridge";
                info->description =
-                       "A little tricky to get to do, but possible with some redirects.\n";
+                       "A little tricky to get to do, but possible with some redirects.";
                return AST_TEST_NOT_RUN;
        case TEST_EXECUTE:
                break;
@@ -1225,9 +1243,9 @@ AST_TEST_DEFINE(test_cel_blind_transfer)
        RAII_VAR(struct ast_channel *, chan_alice, NULL, safe_channel_release);
        RAII_VAR(struct ast_channel *, chan_bob, NULL, safe_channel_release);
        RAII_VAR(struct ast_bridge *, bridge, NULL, safe_bridge_destroy);
+       RAII_VAR(struct ast_blind_transfer_message *, transfer_msg, NULL, ao2_cleanup);
        struct ast_party_caller alice_caller = ALICE_CALLERID;
        struct ast_party_caller bob_caller = BOB_CALLERID;
-       struct ast_bridge_channel_pair pair;
 
        switch (cmd) {
        case TEST_INIT:
@@ -1236,7 +1254,7 @@ AST_TEST_DEFINE(test_cel_blind_transfer)
                info->summary = "Test blind transfers to an extension";
                info->description =
                        "This test creates two channels, bridges them, and then"
-                       " blind transfers the bridge to an extension.\n";
+                       " blind transfers the bridge to an extension.";
                return AST_TEST_NOT_RUN;
        case TEST_EXECUTE:
                break;
@@ -1253,12 +1271,23 @@ AST_TEST_DEFINE(test_cel_blind_transfer)
        BRIDGE_ENTER(chan_bob, bridge);
        BRIDGE_ENTER(chan_alice, bridge);
 
-       pair.bridge = bridge;
-       pair.channel = chan_alice;
        ast_bridge_lock(bridge);
-       ast_bridge_publish_blind_transfer(1, AST_BRIDGE_TRANSFER_SUCCESS,
-               &pair, "transfer_context", "transfer_extension", NULL, NULL);
+       transfer_msg = ast_blind_transfer_message_create(1, chan_alice,
+                       "transfer_extension", "transfer_context");
+       if (!transfer_msg) {
+               ast_bridge_unlock(bridge);
+               ast_test_status_update(test, "Failed to create transfer Stasis message\n");
+               return AST_TEST_FAIL;
+       }
+       transfer_msg->bridge = ast_bridge_snapshot_create(bridge);
+       if (!transfer_msg->bridge) {
+               ast_bridge_unlock(bridge);
+               ast_test_status_update(test, "Failed to create bridge snapshot\n");
+               return AST_TEST_FAIL;
+       }
        ast_bridge_unlock(bridge);
+       transfer_msg->result = AST_BRIDGE_TRANSFER_SUCCESS;
+       ast_bridge_publish_blind_transfer(transfer_msg);
        BLINDTRANSFER_EVENT(chan_alice, bridge, "transfer_extension", "transfer_context");
 
        BRIDGE_EXIT(chan_alice, bridge);
@@ -1271,6 +1300,10 @@ AST_TEST_DEFINE(test_cel_blind_transfer)
        return AST_TEST_PASS;
 }
 
+/* XXX Validation needs to take into account the BRIDGE_EXIT for Alice and the
+ * ATTENDEDTRANSFER message are not guaranteed to be ordered
+ */
+#ifdef RACEY_TESTS
 AST_TEST_DEFINE(test_cel_attended_transfer_bridges_swap)
 {
        RAII_VAR(struct ast_channel *, chan_alice, NULL, safe_channel_release);
@@ -1292,7 +1325,7 @@ AST_TEST_DEFINE(test_cel_attended_transfer_bridges_swap)
                info->description =
                        "This test creates four channels, places each pair in"
                        " a bridge, and then attended transfers the bridges"
-                       " together.\n";
+                       " together.";
                return AST_TEST_NOT_RUN;
        case TEST_EXECUTE:
                break;
@@ -1333,8 +1366,8 @@ AST_TEST_DEFINE(test_cel_attended_transfer_bridges_swap)
        BRIDGE_ENTER_EVENT_PEER(chan_bob, bridge2, "CELTestChannel/David,CELTestChannel/Charlie");
 
        BRIDGE_EXIT_EVENT(chan_david, bridge2);
-       ATTENDEDTRANSFER_BRIDGE(chan_alice, bridge1, chan_david, bridge2, chan_charlie, chan_bob);
        BRIDGE_EXIT_EVENT(chan_alice, bridge1);
+       ATTENDEDTRANSFER_BRIDGE(chan_alice, bridge1, chan_david, bridge2, chan_charlie, chan_bob);
 
        do_sleep();
        BRIDGE_EXIT(chan_bob, bridge2);
@@ -1350,6 +1383,7 @@ AST_TEST_DEFINE(test_cel_attended_transfer_bridges_swap)
 
        return AST_TEST_PASS;
 }
+#endif
 
 AST_TEST_DEFINE(test_cel_attended_transfer_bridges_merge)
 {
@@ -1373,7 +1407,7 @@ AST_TEST_DEFINE(test_cel_attended_transfer_bridges_merge)
                info->description =
                        "This test creates four channels, places each pair"
                        " in a bridge, and then attended transfers the bridges"
-                       " together causing a bridge merge.\n";
+                       " together causing a bridge merge.";
                return AST_TEST_NOT_RUN;
        case TEST_EXECUTE:
                break;
@@ -1435,6 +1469,10 @@ AST_TEST_DEFINE(test_cel_attended_transfer_bridges_merge)
        return AST_TEST_PASS;
 }
 
+/* XXX Validation needs to take into account the BRIDGE_EXIT for David and the
+ * ATTENDEDTRANSFER message are not guaranteed to be ordered
+ */
+#ifdef RACEY_TESTS
 AST_TEST_DEFINE(test_cel_attended_transfer_bridges_link)
 {
        RAII_VAR(struct ast_channel *, chan_alice, NULL, safe_channel_release);
@@ -1457,7 +1495,7 @@ AST_TEST_DEFINE(test_cel_attended_transfer_bridges_link)
                info->description =
                        "This test creates four channels, places each pair"
                        " in a bridge, and then attended transfers the bridges"
-                       " together causing a bridge link.\n";
+                       " together causing a bridge link.";
                return AST_TEST_NOT_RUN;
        case TEST_EXECUTE:
                break;
@@ -1495,24 +1533,11 @@ AST_TEST_DEFINE(test_cel_attended_transfer_bridges_link)
        BRIDGE_ENTER(chan_david, bridge2);
 
        /* Perform attended transfer */
-
-       /* The following events can not be matched directly since nothing is known
-        * about the linking local channel.
-        * ;1 and ;2 CHAN_START and ;2 ANSWER */
-       APPEND_DUMMY_EVENT();
-       APPEND_DUMMY_EVENT();
-       APPEND_DUMMY_EVENT();
-
        ATTENDEDTRANSFER_BRIDGE(chan_alice, bridge1, chan_david, bridge2, chan_charlie, chan_bob);
 
        ast_bridge_transfer_attended(chan_alice, chan_david);
        do_sleep();
 
-       /* ;1 and ;2 BRIDGE_ENTER and ;1 ANSWER */
-       APPEND_DUMMY_EVENT();
-       APPEND_DUMMY_EVENT();
-       APPEND_DUMMY_EVENT();
-
        /* BRIDGE_EXIT alice and david */
        APPEND_DUMMY_EVENT();
        APPEND_DUMMY_EVENT();
@@ -1530,16 +1555,9 @@ AST_TEST_DEFINE(test_cel_attended_transfer_bridges_link)
        HANGUP_CHANNEL(chan_charlie, AST_CAUSE_NORMAL, "");
        do_sleep();
 
-       /* ;1 and ;2 BRIDGE_EXIT, HANGUP, and CHAN_END */
-       APPEND_DUMMY_EVENT();
-       APPEND_DUMMY_EVENT();
-       APPEND_DUMMY_EVENT();
-       APPEND_DUMMY_EVENT();
-       APPEND_DUMMY_EVENT();
-       APPEND_DUMMY_EVENT();
-
        return AST_TEST_PASS;
 }
+#endif
 
 AST_TEST_DEFINE(test_cel_dial_pickup)
 {
@@ -1557,7 +1575,7 @@ AST_TEST_DEFINE(test_cel_dial_pickup)
                info->description =
                        "Test CEL records for a call that is\n"
                        "inbound to Asterisk, executes some dialplan, and\n"
-                       "is picked up.\n";
+                       "is picked up.";
                return AST_TEST_NOT_RUN;
        case TEST_EXECUTE:
                break;
@@ -1617,7 +1635,7 @@ AST_TEST_DEFINE(test_cel_local_optimize)
                info->description =
                        "Test CEL records for two local channels being optimized\n"
                        "out by sending a messages indicating local optimization\n"
-                       "begin and end\n";
+                       "begin and end";
                return AST_TEST_NOT_RUN;
        case TEST_EXECUTE:
                break;
@@ -1721,6 +1739,7 @@ static int append_event(struct ast_event *ev)
        return 0;
 }
 
+#ifdef RACEY_TESTS
 static int append_dummy_event(void)
 {
        RAII_VAR(struct ast_event *, ev, NULL, ast_free);
@@ -1733,6 +1752,7 @@ static int append_dummy_event(void)
 
        return append_event(ev);
 }
+#endif
 
 static int append_expected_event_snapshot(
        struct ast_channel_snapshot *snapshot,
@@ -1771,12 +1791,18 @@ static int append_expected_event(
 static void test_sub(struct ast_event *event)
 {
        struct ast_event *event_dup = ao2_dup_event(event);
+       const char *chan_name;
        SCOPED_MUTEX(mid_test_lock, &mid_test_sync_lock);
 
        if (!event_dup) {
                return;
        }
 
+       chan_name = ast_event_get_ie_str(event_dup, AST_EVENT_IE_CEL_CHANNAME);
+       if (chan_name && strncmp(chan_name, CHANNEL_TECH_NAME, 14)) {
+               return;
+       }
+
        /* save the event for later processing */
        ao2_link(cel_received_events, event_dup);
 
@@ -2101,12 +2127,12 @@ static int unload_module(void)
        AST_TEST_UNREGISTER(test_cel_dial_answer_twoparty_bridge_b);
 #ifdef RACEY_TESTS
        AST_TEST_UNREGISTER(test_cel_dial_answer_multiparty);
+       AST_TEST_UNREGISTER(test_cel_attended_transfer_bridges_swap);
+       AST_TEST_UNREGISTER(test_cel_attended_transfer_bridges_link);
 #endif
 
        AST_TEST_UNREGISTER(test_cel_blind_transfer);
-       AST_TEST_UNREGISTER(test_cel_attended_transfer_bridges_swap);
        AST_TEST_UNREGISTER(test_cel_attended_transfer_bridges_merge);
-       AST_TEST_UNREGISTER(test_cel_attended_transfer_bridges_link);
 
        AST_TEST_UNREGISTER(test_cel_dial_pickup);
 
@@ -2176,12 +2202,12 @@ static int load_module(void)
        AST_TEST_REGISTER(test_cel_dial_answer_twoparty_bridge_b);
 #ifdef RACEY_TESTS
        AST_TEST_REGISTER(test_cel_dial_answer_multiparty);
+       AST_TEST_REGISTER(test_cel_attended_transfer_bridges_swap);
+       AST_TEST_REGISTER(test_cel_attended_transfer_bridges_link);
 #endif
 
        AST_TEST_REGISTER(test_cel_blind_transfer);
-       AST_TEST_REGISTER(test_cel_attended_transfer_bridges_swap);
        AST_TEST_REGISTER(test_cel_attended_transfer_bridges_merge);
-       AST_TEST_REGISTER(test_cel_attended_transfer_bridges_link);
 
        AST_TEST_REGISTER(test_cel_dial_pickup);