From 74e48ffefe5f68a2b065d8e970448ba38514185f Mon Sep 17 00:00:00 2001
From: David Levine <david.levine@gonift.com>
Date: Sat, 26 Mar 2016 19:05:10 -0400
Subject: [PATCH] Migrated the oauth tests to start_test()/finish_test() so
 that they don't have any output on success, but do report the particular test
 on failure.

---
 test/oauth/test-inc     | 11 ++++++-----
 test/oauth/test-mhlogin | 25 ++++++++++++------------
 test/oauth/test-send    | 43 +++++++++++++++++++++--------------------
 test/oauth/test-share   |  9 +++++----
 4 files changed, 46 insertions(+), 42 deletions(-)

diff --git a/test/oauth/test-inc b/test/oauth/test-inc
index 16b55b58..6fa5892a 100755
--- a/test/oauth/test-inc
+++ b/test/oauth/test-inc
@@ -17,7 +17,7 @@ setup_pop
 #
 
 # TEST
-echo 'access token ready, pop server accepts message'
+start_test 'access token ready, pop server accepts message'
 
 fake_creds <<EOF
 access: test-access
@@ -29,7 +29,7 @@ start_pop_xoauth
 test_inc_success
 
 # TEST
-echo 'expired access token, refresh works, pop server accepts message'
+start_test 'expired access token, refresh works, pop server accepts message'
 
 fake_creds <<EOF
 access: old-access
@@ -59,7 +59,7 @@ check_http_req
 #
 
 # TEST
-echo 'refresh gets proper error from http'
+start_test 'refresh gets proper error from http'
 
 fake_creds <<EOF
 access: test-access
@@ -84,7 +84,7 @@ inc: bad OAuth request; re-run with -snoop and send REDACTED output to nmh-worke
 check_http_req
 
 # TEST
-echo 'pop server rejects token'
+start_test 'pop server rejects token'
 
 fake_creds <<EOF
 access: wrong-access
@@ -96,7 +96,7 @@ start_pop_xoauth
 test_inc 'inc: -ERR [AUTH] Invalid credentials.'
 
 # TEST
-echo "pop server doesn't support oauth"
+start_test "pop server doesn't support oauth"
 
 fake_creds <<EOF
 access: test-access
@@ -108,5 +108,6 @@ start_pop testuser testpass
 test_inc 'inc: POP server does not support SASL'
 
 clean_fakehttp
+finish_test
 
 exit ${failed:-0}
diff --git a/test/oauth/test-mhlogin b/test/oauth/test-mhlogin
index c6c02618..7f2bcc4a 100755
--- a/test/oauth/test-mhlogin
+++ b/test/oauth/test-mhlogin
@@ -39,7 +39,7 @@ mhlogin: invalid response'
 #
 
 # TEST
-echo 'mhlogin receives access and expiration'
+start_test 'mhlogin receives access and expiration'
 
 expect_http_post_code
 
@@ -59,7 +59,7 @@ EOF
 test_mhlogin
 
 # TEST
-echo 'mhlogin receives access and refresh'
+start_test 'mhlogin receives access and refresh'
 
 expect_http_post_code
 
@@ -77,7 +77,7 @@ EOF
 test_mhlogin
 
 # TEST
-echo 'mhlogin receives access, expiration, and refresh'
+start_test 'mhlogin receives access, expiration, and refresh'
 
 expect_http_post_code
 
@@ -99,7 +99,7 @@ EOF
 test_mhlogin
 
 # TEST
-echo 'mhlogin receives refresh only'
+start_test 'mhlogin receives refresh only'
 
 expect_http_post_code
 
@@ -117,7 +117,7 @@ EOF
 test_mhlogin
 
 # TEST
-echo 'mhlogin receives token_type only'
+start_test 'mhlogin receives token_type only'
 
 expect_http_post_code
 
@@ -132,7 +132,7 @@ expect_no_creds
 test_mhlogin_invalid_response
 
 # TEST
-echo 'mhlogin ignores extra bits in successful response JSON'
+start_test 'mhlogin ignores extra bits in successful response JSON'
 
 expect_http_post_code
 
@@ -160,7 +160,7 @@ EOF
 test_mhlogin
 
 # TEST
-echo 'mhlogin user enters bad code'
+start_test 'mhlogin user enters bad code'
 
 expect_http_post_code
 
@@ -181,7 +181,7 @@ test_mhlogin 'Code rejected; try again? '
 #
 
 # TEST
-echo 'mhlogin response has no content-type'
+start_test 'mhlogin response has no content-type'
 
 expect_http_post_code
 
@@ -199,7 +199,7 @@ expect_no_creds
 test_mhlogin_invalid_response
 
 # TEST
-echo 'mhlogin JSON array'
+start_test 'mhlogin JSON array'
 
 expect_http_post_code
 
@@ -212,7 +212,7 @@ expect_no_creds
 test_mhlogin_invalid_response
 
 # TEST
-echo 'mhlogin JSON empty object'
+start_test 'mhlogin JSON empty object'
 
 expect_http_post_code
 
@@ -225,7 +225,7 @@ expect_no_creds
 test_mhlogin_invalid_response
 
 # TEST
-echo 'mhlogin empty response body'
+start_test 'mhlogin empty response body'
 
 expect_http_post_code
 
@@ -237,7 +237,7 @@ expect_no_creds
 test_mhlogin_invalid_response
 
 # TEST
-echo 'mhlogin gets proper error from http'
+start_test 'mhlogin gets proper error from http'
 
 expect_http_post_code
 
@@ -255,5 +255,6 @@ test_mhlogin 'mhlogin: error exchanging code for OAuth2 token
 mhlogin: bad OAuth request; re-run with -snoop and send REDACTED output to nmh-workers'
 
 clean_fakehttp
+finish_test
 
 exit ${failed:-0}
diff --git a/test/oauth/test-send b/test/oauth/test-send
index 363debc6..4c7a335c 100755
--- a/test/oauth/test-send
+++ b/test/oauth/test-send
@@ -24,7 +24,7 @@ export XOAUTH
 XOAUTH='dXNlcj1ub2JvZHlAZXhhbXBsZS5jb20BYXV0aD1CZWFyZXIgdGVzdC1hY2Nlc3MBAQ=='
 
 # TEST
-echo 'access token ready, smtp server accepts message'
+start_test 'access token ready, smtp server accepts message'
 
 setup_draft
 
@@ -38,7 +38,7 @@ start_fakesmtp
 run_test "send -draft -server 127.0.0.1 -port ${smtp_port} -saslmech xoauth2 -authservice test -user nobody@example.com"
 
 # TEST
-echo 'expired access token, refresh works, smtp server accepts message'
+start_test 'expired access token, refresh works, smtp server accepts message'
 
 setup_draft
 
@@ -70,7 +70,7 @@ check_creds_private
 check_creds
 
 # TEST
-echo 'expired access token, refresh works and gets updated, smtp server accepts message'
+start_test 'expired access token, refresh works and gets updated, smtp server accepts message'
 
 setup_draft
 
@@ -100,7 +100,7 @@ test_send
 check_creds
 
 # TEST
-echo 'access token has no expiration, refresh works, smtp server accepts message'
+start_test 'access token has no expiration, refresh works, smtp server accepts message'
 
 setup_draft
 
@@ -128,7 +128,7 @@ test_send
 check_creds
 
 # TEST
-echo 'no access token, refresh works, smtp server accepts message'
+start_test 'no access token, refresh works, smtp server accepts message'
 
 setup_draft
 
@@ -161,26 +161,26 @@ check_creds
 setup_draft
 
 # TEST
-echo 'no service definition'
+start_test 'no service definition'
 
 run_test "send -draft -server 127.0.0.1 -port ${smtp_port} -saslmech xoauth2 -authservice bogus -user nobody@example.com" 'send: incomplete OAuth2 service definition: scope is missing'
 
 # TEST
-echo 'no creds file -- should tell user to mhlogin'
+start_test 'no creds file -- should tell user to mhlogin'
 
 rm -f "${MHTMPDIR}/oauth-test"
 
 test_send_no_servers 'send: no credentials -- run mhlogin -saslmech xoauth2 -authservice test'
 
 # TEST
-echo 'empty creds file -- should tell user to mhlogin'
+start_test 'empty creds file -- should tell user to mhlogin'
 
 fake_creds < /dev/null
 
 test_send_no_servers 'send: no valid credentials -- run mhlogin -saslmech xoauth2 -authservice test'
 
 # TEST
-echo 'garbage creds file'
+start_test 'garbage creds file'
 
 echo bork | fake_creds
 
@@ -188,7 +188,7 @@ test_send_no_servers 'send: eof encountered in field "bork"
 send: error loading cred file'
 
 # TEST
-echo 'unexpected field in creds file'
+start_test 'unexpected field in creds file'
 
 fake_creds <<EOF
 bork: bork
@@ -198,7 +198,7 @@ EOF
 test_send_no_servers 'send: error loading cred file: unexpected field'
 
 # TEST
-echo 'garbage expiration time'
+start_test 'garbage expiration time'
 
 fake_creds <<EOF
 access: test-access
@@ -208,7 +208,7 @@ EOF
 test_send_no_servers 'send: error loading cred file: invalid expiration time'
 
 # TEST
-echo 'refresh response has no access token'
+start_test 'refresh response has no access token'
 
 fake_creds <<EOF
 refresh: test-refresh
@@ -227,7 +227,7 @@ test_send_only_fakehttp 'send: error refreshing OAuth2 token
 send: invalid response: no access token'
 
 # TEST
-echo 'expired access token, no refresh token -- tell user to mhlogin'
+start_test 'expired access token, no refresh token -- tell user to mhlogin'
 
 fake_creds <<EOF
 access: test-access
@@ -237,7 +237,7 @@ EOF
 test_send_no_servers 'send: no valid credentials -- run mhlogin -saslmech xoauth2 -authservice test'
 
 # TEST
-echo 'access token has no expiration, no refresh token -- tell user to mhlogin'
+start_test 'access token has no expiration, no refresh token -- tell user to mhlogin'
 
 fake_creds <<EOF
 access: test-access
@@ -246,7 +246,7 @@ EOF
 test_send_no_servers 'send: no valid credentials -- run mhlogin -saslmech xoauth2 -authservice test'
 
 # TEST
-echo 'refresh finds no http server'
+start_test 'refresh finds no http server'
 
 fake_creds <<EOF
 access: test-access
@@ -269,7 +269,7 @@ check "$f".clean "${testname}.expected-send-output"
 rm "$f"
 
 # TEST
-echo 'refresh gets bogus 200 response from http server'
+start_test 'refresh gets bogus 200 response from http server'
 
 expect_http_post_refresh
 
@@ -283,7 +283,7 @@ test_send_only_fakehttp 'send: error refreshing OAuth2 token
 send: invalid response'
 
 # TEST
-echo 'refresh gets 500 response from http server'
+start_test 'refresh gets 500 response from http server'
 
 expect_http_post_refresh
 
@@ -297,7 +297,7 @@ test_send_only_fakehttp 'send: error refreshing OAuth2 token
 send: invalid response'
 
 # TEST
-echo 'refresh gets proper error from http'
+start_test 'refresh gets proper error from http'
 
 expect_http_post_refresh
 
@@ -312,7 +312,7 @@ EOF
 test_send_only_fakehttp 'send: credentials rejected -- run mhlogin -saslmech xoauth2 -authservice test'
 
 # TEST
-echo 'refresh gets response too big'
+start_test 'refresh gets response too big'
 
 fake_creds <<EOF
 refresh: test-refresh
@@ -335,7 +335,7 @@ test_send_only_fakehttp 'send: error refreshing OAuth2 token
 send: refusing to process response body larger than 8192 bytes'
 
 # TEST
-echo 'smtp server rejects token'
+start_test 'smtp server rejects token'
 
 XOAUTH='not-that-one'
 
@@ -348,7 +348,7 @@ test_send_only_fakesmtp 'post: problem initializing server; [BHST] Not no way, n
 send: message not delivered to anyone'
 
 # TEST
-echo "smtp server doesn't support oauth"
+start_test "smtp server doesn't support oauth"
 
 unset XOAUTH
 
@@ -357,5 +357,6 @@ send: message not delivered to anyone'
 
 clean_fakesmtp
 clean_fakehttp
+finish_test
 
 exit ${failed:-0}
diff --git a/test/oauth/test-share b/test/oauth/test-share
index cf5fca36..76b0d3e2 100755
--- a/test/oauth/test-share
+++ b/test/oauth/test-share
@@ -16,7 +16,7 @@ export XOAUTH
 XOAUTH='dXNlcj1ub2JvZHlAZXhhbXBsZS5jb20BYXV0aD1CZWFyZXIgdGVzdC1hY2Nlc3MBAQ=='
 
 # TEST
-echo 'mhlogin then all run with no refresh'
+start_test 'mhlogin then all run with no refresh'
 
 expect_http_post_code
 
@@ -51,7 +51,7 @@ setup_draft
 test_send_only_fakesmtp
 
 # TEST
-echo 'inc refreshes'
+start_test 'inc refreshes'
 
 fake_creds <<EOF
 access: old-access
@@ -80,7 +80,7 @@ setup_draft
 test_send_only_fakesmtp
 
 # TEST
-echo 'msgchck refreshes'
+start_test 'msgchck refreshes'
 
 fake_creds <<EOF
 access: old-access
@@ -109,7 +109,7 @@ setup_draft
 test_send_only_fakesmtp
 
 # TEST
-echo 'send refreshes'
+start_test 'send refreshes'
 
 fake_creds <<EOF
 access: old-access
@@ -138,5 +138,6 @@ test_inc_success
 
 clean_fakesmtp
 clean_fakehttp
+finish_test
 
 exit ${failed:-0}
-- 
2.56.0