Updating data_download_exception test case to gracefully handle timeouts.

Author: stgates

Release/tests/functional/http/client/authentication_tests.cpp

@@ -50,36 +50,6 @@ using namespace tests::functional::http::utilities;
 
 namespace tests { namespace functional { namespace http { namespace client {
 
-// helper function to check if failure is due to timeout.
-bool is_timeout(const std::string &msg)
-{
-    if (msg.find("The operation timed out") != std::string::npos /* WinHTTP */ ||
-        msg.find("The operation was timed out") != std::string::npos /* IXmlHttpRequest2 */)
-    {
-        return true;
-    }
-    return false;
-}
-
-template <typename Func>
-void handle_timeout(const Func &f)
-{
-    try
-    {
-        f();
-    }
-    catch (const http_exception &e)
-    {
-        if (is_timeout(e.what()))
-        {
-            // Since this test depends on an outside server sometimes it sporadically can fail due to timeouts
-            // especially on our build machines.
-            return;
-        }
-        throw;
-    }
-}
-
 SUITE(authentication_tests)
 {
 

Release/tests/functional/http/client/outside_tests.cpp

@@ -45,36 +45,6 @@ namespace tests { namespace functional { namespace http { namespace client {
 SUITE(outside_tests)
 {
 
-// helper function to check if failure is due to timeout.
-bool is_timeout(const std::string &msg)
-{
-    if (msg.find("The operation timed out") != std::string::npos /* WinHTTP */ ||
-        msg.find("The operation was timed out") != std::string::npos /* IXmlHttpRequest2 */)
-    {
-        return true;
-    }
-    return false;
-}
-
-template <typename Func>
-void handle_timeout(const Func &f)
-{
-    try
-    {
-        f();
-    }
-    catch (const http_exception &e)
-    {
-        if (is_timeout(e.what()))
-        {
-            // Since this test depends on an outside server sometimes it sporadically can fail due to timeouts
-            // especially on our build machines.
-            return;
-        }
-        throw;
-    }
-}
-
 TEST_FIXTURE(uri_address, outside_cnn_dot_com)
 {
     handle_timeout([]

Release/tests/functional/http/client/progress_handler_tests.cpp

@@ -245,20 +245,20 @@ TEST_FIXTURE(uri_address, set_progress_handler_open_failure)
     const size_t repeats = 5500;
     for (size_t i = 0; i < repeats; ++i)
         data.append(U("abcdefghihklmnopqrstuvwxyz"));
-    
+
     utility::size64_t upsize = 4711u, downsize = 4711u;
     int calls = 0;
 
     http_request msg(mtd);
     // We should never see this handler called.
     msg.set_progress_handler(
-        [&](message_direction::direction direction, utility::size64_t so_far) 
-        { 
+        [&](message_direction::direction direction, utility::size64_t so_far)
+        {
             calls += 1;
-            if (direction == message_direction::upload) 
-                upsize = so_far; 
-            else 
-                downsize = so_far; 
+            if (direction == message_direction::upload)
+                upsize = so_far;
+            else
+                downsize = so_far;
         });
 
     msg.set_body(data);
@@ -406,12 +406,6 @@ TEST_FIXTURE(uri_address, data_download_exception)
     int numCalls = 0;
     msg.set_progress_handler([&](message_direction::direction, utility::size64_t)
     {
-        // TODO stgates - adding some debugging information to help with hard to reproduce
-        // sporadic failure.
-#if (defined(_MSC_VER) && (_MSC_VER >= 1800))
-        printf("In progress handler, numCalls:%i\n", numCalls);
-#endif
-
         if(++numCalls == 2)
         {
             // 2rd is for data download
@@ -421,22 +415,15 @@ TEST_FIXTURE(uri_address, data_download_exception)
 
     try
     {
-        client.request(msg).get().content_ready().get();
-    }
-    catch (http_exception const &e)
-    {
-        printf("http_exception:%s\n", e.what());
-        VERIFY_IS_TRUE(false);
+        handle_timeout([&]
+        {
+            client.request(msg).get().content_ready().get();
+        });
     }
     catch (std::invalid_argument const &)
     {
-        printf("std::invalid_argument\n");
-    }
-    catch (std::exception const &e)
-    {
-        printf("std::exception:%s\n", e.what());
+        // Expected.
     }
-    //VERIFY_THROWS(client.request(msg).get().content_ready().get(), std::invalid_argument);
 }
 
 }

Release/tests/functional/http/client/proxy_tests.cpp

@@ -1,12 +1,12 @@
 /***
 * ==++==
 *
-* Copyright (c) Microsoft Corporation. All rights reserved. 
+* Copyright (c) Microsoft Corporation. All rights reserved.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * http://www.apache.org/licenses/LICENSE-2.0
-* 
+*
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

Release/tests/functional/http/client/stdafx.h

@@ -34,3 +34,4 @@
 #include "http_test_utilities.h"
 #include "unittestpp.h"
 #include "os_utilities.h"
+#include "timeout_handler.h"

Release/tests/functional/http/client/timeout_handler.h

@@ -0,0 +1,60 @@
+/***
+* ==++==
+*
+* Copyright (c) Microsoft Corporation. All rights reserved.
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+* http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*
+* ==--==
+* =+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+
+*
+* Simple utility for handling timeouts with http client test cases.
+*
+* =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
+****/
+
+#pragma once
+
+#include "cpprest/http_client.h"
+
+namespace tests { namespace functional { namespace http { namespace client {
+
+// helper function to check if failure is due to timeout.
+bool is_timeout(const std::string &msg)
+{
+    if (msg.find("The operation timed out") != std::string::npos /* WinHTTP */ ||
+        msg.find("The operation was timed out") != std::string::npos /* IXmlHttpRequest2 */)
+    {
+        return true;
+    }
+    return false;
+}
+
+template <typename Func>
+void handle_timeout(const Func &f)
+{
+    try
+    {
+        f();
+    }
+    catch (const web::http::http_exception &e)
+    {
+        if (is_timeout(e.what()))
+        {
+            // Since this test depends on an outside server sometimes it sporadically can fail due to timeouts
+            // especially on our build machines.
+            return;
+        }
+        throw;
+    }
+}
+
+}}}}