Change ast_hangup() to return void and be NULL safe.

Since ast_hangup() is effectively a channel destructor, it should be a
void function.

* Make the few silly callers checking the return value no longer do so.
Only the CDR and CEL unit tests checked the return value.

* Make all callers take advantage of the NULL safe change and remove the
NULL check before the call.


git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@394623 65c4cc65-6c06-0410-ace0-fbb531ad65f3

5 files changed, 28 insertions, 60 deletions

diff --git a/tests/test_app.c b/tests/test_app.c
index 0bb43aaee..f47b052e5 100644
--- a/tests/test_app.c
+++ b/tests/test_app.c
@@ -212,18 +212,10 @@ AST_TEST_DEFINE(app_group)
 	}
 
 exit_group_test:
-	if (test_channel1) {
-		ast_hangup(test_channel1);
-	}
-	if (test_channel2) {
-		ast_hangup(test_channel2);
-	}
-	if (test_channel3) {
-		ast_hangup(test_channel3);
-	}
-	if (test_channel4) {
-		ast_hangup(test_channel4);
-	}
+	ast_hangup(test_channel1);
+	ast_hangup(test_channel2);
+	ast_hangup(test_channel3);
+	ast_hangup(test_channel4);
 	return res;
 }
 
diff --git a/tests/test_cdr.c b/tests/test_cdr.c
index a60f78e2c..670334c13 100644
--- a/tests/test_cdr.c
+++ b/tests/test_cdr.c
@@ -278,11 +278,12 @@ static void clear_mock_cdr_backend(void)
 	} while (0)
 
 /*! \brief Hang up a test channel safely */
-#define HANGUP_CHANNEL(channel, cause) do { \
-	ast_channel_hangupcause_set((channel), (cause)); \
-	if (!ast_hangup((channel))) { \
+#define HANGUP_CHANNEL(channel, cause) \
+	do { \
+		ast_channel_hangupcause_set((channel), (cause)); \
+		ast_hangup(channel); \
 		channel = NULL; \
-	} } while (0)
+	} while (0)
 
 static enum ast_test_result_state verify_mock_cdr_record(struct ast_test *test, struct ast_cdr *expected, int record)
 {
@@ -2201,9 +2202,8 @@ AST_TEST_DEFINE(test_cdr_fields)
 
 	/* Hang up and verify */
 	ast_channel_hangupcause_set(chan, AST_CAUSE_NORMAL);
-	if (!ast_hangup(chan)) {
-		chan = NULL;
-	}
+	ast_hangup(chan);
+	chan = NULL;
 	result = verify_mock_cdr_record(test, expected, 3);
 
 	return result;
@@ -2272,9 +2272,8 @@ AST_TEST_DEFINE(test_cdr_no_reset_cdr)
 	ast_test_validate(test, ast_cdr_fork(ast_channel_name(chan), &fork_options) == 0);
 
 	ast_channel_hangupcause_set(chan, AST_CAUSE_NORMAL);
-	if (!ast_hangup(chan)) {
-		chan = NULL;
-	}
+	ast_hangup(chan);
+	chan = NULL;
 	result = verify_mock_cdr_record(test, &expected, 1);
 
 	return result;
@@ -2395,9 +2394,8 @@ AST_TEST_DEFINE(test_cdr_fork_cdr)
 	ast_test_validate(test, strcmp(fork_answer_time, answer_time) != 0);
 
 	ast_channel_hangupcause_set(chan, AST_CAUSE_NORMAL);
-	if (!ast_hangup(chan)) {
-		chan = NULL;
-	}
+	ast_hangup(chan);
+	chan = NULL;
 	result = verify_mock_cdr_record(test, expected, 3);
 
 	return result;
diff --git a/tests/test_cel.c b/tests/test_cel.c
index d785ef1f1..c29b2e786 100644
--- a/tests/test_cel.c
+++ b/tests/test_cel.c
@@ -139,23 +139,17 @@ static void do_sleep(void)
 	} while (0)
 
 /*! \brief Hang up a test channel safely */
-#define HANGUP_CHANNEL(channel, cause, hangup_extra) do { \
-	ast_channel_hangupcause_set((channel), (cause)); \
-	ao2_ref(channel, +1); \
-	if (!ast_hangup((channel))) { \
+#define HANGUP_CHANNEL(channel, cause, hangup_extra) \
+	do { \
+		ast_channel_hangupcause_set((channel), (cause)); \
+		ao2_ref(channel, +1); \
+		ast_hangup(channel); \
 		APPEND_EVENT(channel, AST_CEL_HANGUP, NULL, hangup_extra, NULL); \
 		APPEND_EVENT(channel, AST_CEL_CHANNEL_END, NULL, NULL, NULL); \
 		ao2_cleanup(stasis_cache_get_extended(ast_channel_topic_all_cached(), \
 			ast_channel_snapshot_type(), ast_channel_uniqueid(channel), 1)); \
 		ao2_cleanup(channel); \
 		channel = NULL; \
-	} else { \
-		APPEND_EVENT(channel, AST_CEL_HANGUP, NULL, hangup_extra, NULL); \
-		APPEND_EVENT(channel, AST_CEL_CHANNEL_END, NULL, NULL, NULL); \
-		ao2_cleanup(stasis_cache_get_extended(ast_channel_topic_all_cached(), \
-			ast_channel_snapshot_type(), ast_channel_uniqueid(channel), 1)); \
-		ao2_cleanup(channel); \
-	} \
 	} while (0)
 
 static int append_expected_event(
diff --git a/tests/test_stasis_endpoints.c b/tests/test_stasis_endpoints.c
index c6cafd6ad..9fe3ecfad 100644
--- a/tests/test_stasis_endpoints.c
+++ b/tests/test_stasis_endpoints.c
@@ -45,14 +45,6 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
 
 static const char *test_category = "/stasis/endpoints/";
 
-static void safe_channel_hangup(struct ast_channel *chan)
-{
-	if (!chan) {
-		return;
-	}
-	ast_hangup(chan);
-}
-
 /*! \brief Message matcher looking for cache update messages */
 static int cache_update(struct stasis_message *msg, const void *data) {
 	struct stasis_cache_update *update;
@@ -79,7 +71,7 @@ static int cache_update(struct stasis_message *msg, const void *data) {
 AST_TEST_DEFINE(state_changes)
 {
 	RAII_VAR(struct ast_endpoint *, uut, NULL, ast_endpoint_shutdown);
-	RAII_VAR(struct ast_channel *, chan, NULL, safe_channel_hangup);
+	RAII_VAR(struct ast_channel *, chan, NULL, ast_hangup);
 	RAII_VAR(struct stasis_message_sink *, sink, NULL, ao2_cleanup);
 	RAII_VAR(struct stasis_subscription *, sub, NULL, stasis_unsubscribe);
 	struct stasis_message *msg;
@@ -135,7 +127,7 @@ AST_TEST_DEFINE(state_changes)
 AST_TEST_DEFINE(cache_clear)
 {
 	RAII_VAR(struct ast_endpoint *, uut, NULL, ast_endpoint_shutdown);
-	RAII_VAR(struct ast_channel *, chan, NULL, safe_channel_hangup);
+	RAII_VAR(struct ast_channel *, chan, NULL, ast_hangup);
 	RAII_VAR(struct stasis_message_sink *, sink, NULL, ao2_cleanup);
 	RAII_VAR(struct stasis_subscription *, sub, NULL, stasis_unsubscribe);
 	struct stasis_message *msg;
@@ -211,7 +203,7 @@ AST_TEST_DEFINE(cache_clear)
 AST_TEST_DEFINE(channel_messages)
 {
 	RAII_VAR(struct ast_endpoint *, uut, NULL, ast_endpoint_shutdown);
-	RAII_VAR(struct ast_channel *, chan, NULL, safe_channel_hangup);
+	RAII_VAR(struct ast_channel *, chan, NULL, ast_hangup);
 	RAII_VAR(struct stasis_message_sink *, sink, NULL, ao2_cleanup);
 	RAII_VAR(struct stasis_subscription *, sub, NULL, stasis_unsubscribe);
 	struct stasis_message *msg;
@@ -261,7 +253,7 @@ AST_TEST_DEFINE(channel_messages)
 	actual_snapshot = stasis_message_data(msg);
 	ast_test_validate(test, 1 == actual_snapshot->num_channels);
 
-	safe_channel_hangup(chan);
+	ast_hangup(chan);
 	chan = NULL;
 
 	actual_count = stasis_message_sink_wait_for_count(sink, 5,
diff --git a/tests/test_voicemail_api.c b/tests/test_voicemail_api.c
index 30f6f11e0..a0dc2400b 100644
--- a/tests/test_voicemail_api.c
+++ b/tests/test_voicemail_api.c
@@ -229,9 +229,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
 #define VM_API_PLAYBACK_MESSAGE(channel, mailbox, context, folder, message, callback_fn) do { \
 	if (ast_vm_msg_play((channel), (mailbox), (context), (folder), (message), (callback_fn))) { \
 		ast_test_status_update(test, "Failed nominal playback message test\n"); \
-		if (test_channel) { \
-			ast_hangup(test_channel); \
-		} \
+		ast_hangup(test_channel); \
 		VM_API_TEST_CLEANUP; \
 		return AST_TEST_FAIL; \
 	} } while (0)
@@ -241,9 +239,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
 #define VM_API_PLAYBACK_MESSAGE_OFF_NOMINAL(channel, mailbox, context, folder, message, callback_fn) do { \
 	if (!ast_vm_msg_play((channel), (mailbox), (context), (folder), (message), (callback_fn))) { \
 		ast_test_status_update(test, "Succeeded in playing back of message when expected result was to fail\n"); \
-		if (test_channel) { \
-			ast_hangup(test_channel); \
-		} \
+		ast_hangup(test_channel); \
 		VM_API_TEST_CLEANUP; \
 		return AST_TEST_FAIL; \
 	} } while (0)
@@ -1322,9 +1318,7 @@ AST_TEST_DEFINE(voicemail_api_nominal_msg_playback)
 	VM_API_INT_VERIFY(test_mbox_snapshot->total_msg_num, 2);
 	test_mbox_snapshot = ast_vm_mailbox_snapshot_destroy(test_mbox_snapshot);
 
-	if (test_channel) {
-		ast_hangup(test_channel);
-	}
+	ast_hangup(test_channel);
 	VM_API_TEST_CLEANUP;
 
 	return AST_TEST_PASS;
@@ -1382,9 +1376,7 @@ AST_TEST_DEFINE(voicemail_api_off_nominal_msg_playback)
 
 	ast_test_status_update(test, "Playing back message with NULL message specifier\n");
 	VM_API_PLAYBACK_MESSAGE_OFF_NOMINAL(test_channel, "test_vm_api_1234", "default", "INBOX", NULL, NULL);
-	if (test_channel) {
-		ast_hangup(test_channel);
-	}
+	ast_hangup(test_channel);
 	VM_API_TEST_CLEANUP;
 
 	return AST_TEST_PASS;