Append '_Online' suffix to Unit test names that access external servers

Co-authored-by: Thomas Behn <Thomas.Behn@meinberg.de>

.github/workflows/test.yaml

@@ -26,7 +26,7 @@ jobs:
       run: brew install brotli
     - name: make
       if: matrix.os != 'windows-latest'
-      run: cd test && make
+      run: cd test && make -j2
     - name: check fuzz test target
       if: matrix.os == 'ubuntu-latest'
       run: cd test && make -f Makefile.fuzz_test

.gitignore

@@ -10,8 +10,11 @@ example/redirect
 example/sse*
 example/upload
 example/*.pem
+test/httplib.cc
+test/httplib.h
 test/test
 test/test_proxy
+test/test_split
 test/test.xcodeproj/xcuser*
 test/test.xcodeproj/*/xcuser*
 test/*.pem

README.md

@@ -256,6 +256,7 @@ svr.Post("/multipart", [&](const auto& req, auto& res) {
 svr.Post("/content_receiver",
   [&](const Request &req, Response &res, const ContentReader &content_reader) {
     if (req.is_multipart_form_data()) {
+      // NOTE: `content_reader` is blocking until every form data field is read
       MultipartFormDataItems files;
       content_reader(
         [&](const MultipartFormData &file) {
@@ -272,7 +273,6 @@ svr.Post("/content_receiver",
         body.append(data, data_length);
         return true;
       });
-      res.set_content(body, "text/plain");
     }
   });
 ```
@@ -749,10 +749,20 @@ res->body; // Compressed data
 Split httplib.h into .h and .cc
 -------------------------------
 
-```bash
-> python3 split.py
-> ls out
-httplib.h  httplib.cc
+```console
+$ ./split.py -h
+usage: split.py [-h] [-e EXTENSION] [-o OUT]
+
+This script splits httplib.h into .h and .cc parts.
+
+optional arguments:
+  -h, --help            show this help message and exit
+  -e EXTENSION, --extension EXTENSION
+                        extension of the implementation file (default: cc)
+  -o OUT, --out OUT     where to write the files (default: out)
+
+$ ./split.py
+Wrote out/httplib.h and out/httplib.cc
 ```
 
 NOTE

split.py

@@ -1,32 +1,47 @@
+#!/usr/bin/env python3
+
+"""This script splits httplib.h into .h and .cc parts."""
+
+import argparse
 import os
 import sys
 
 border = '// ----------------------------------------------------------------------------'
 
-PythonVersion = sys.version_info[0];
+args_parser = argparse.ArgumentParser(description=__doc__)
+args_parser.add_argument(
+    "-e", "--extension", help="extension of the implementation file (default: cc)",
+    default="cc"
+)
+args_parser.add_argument(
+    "-o", "--out", help="where to write the files (default: out)", default="out"
+)
+args = args_parser.parse_args()
 
-with open('httplib.h') as f:
+cur_dir = os.path.dirname(sys.argv[0])
+with open(cur_dir + '/httplib.h') as f:
     lines = f.readlines()
-    inImplementation = False
-    
-    if PythonVersion < 3:
-        os.makedirs('out')
-    else:
-        os.makedirs('out', exist_ok=True)
-        
-    with open('out/httplib.h', 'w') as fh:
-        with open('out/httplib.cc', 'w') as fc:
-            fc.write('#include "httplib.h"\n')
-            fc.write('namespace httplib {\n')
-            for line in lines:
-                isBorderLine = border in line
-                if isBorderLine:
-                    inImplementation = not inImplementation
-                else:
-                    if inImplementation:
-                        fc.write(line.replace('inline ', ''))
-                        pass
-                    else:
-                        fh.write(line)
-                        pass
-            fc.write('} // namespace httplib\n')
+
+python_version = sys.version_info[0]
+if python_version < 3:
+    os.makedirs(args.out)
+else:
+    os.makedirs(args.out, exist_ok=True)
+
+in_implementation = False
+h_out = args.out + '/httplib.h'
+cc_out = args.out + '/httplib.' + args.extension
+with open(h_out, 'w') as fh, open(cc_out, 'w') as fc:
+    fc.write('#include "httplib.h"\n')
+    fc.write('namespace httplib {\n')
+    for line in lines:
+        is_border_line = border in line
+        if is_border_line:
+            in_implementation = not in_implementation
+        elif in_implementation:
+            fc.write(line.replace('inline ', ''))
+        else:
+            fh.write(line)
+    fc.write('} // namespace httplib\n')
+
+print("Wrote {} and {}".format(h_out, cc_out))

test/Makefile

@@ -1,5 +1,5 @@
 #CXX = clang++
-CXXFLAGS = -g -std=c++11 -I.. -I. -Wall -Wextra -Wtype-limits -Wconversion #-fsanitize=address
+CXXFLAGS = -g -std=c++11 -I. -Wall -Wextra -Wtype-limits -Wconversion #-fsanitize=address
 
 OPENSSL_DIR = /usr/local/opt/openssl@1.1
 OPENSSL_SUPPORT = -DCPPHTTPLIB_OPENSSL_SUPPORT -I$(OPENSSL_DIR)/include -L$(OPENSSL_DIR)/lib -lssl -lcrypto
@@ -9,17 +9,27 @@ ZLIB_SUPPORT = -DCPPHTTPLIB_ZLIB_SUPPORT -lz
 BROTLI_DIR = /usr/local/opt/brotli
 BROTLI_SUPPORT = -DCPPHTTPLIB_BROTLI_SUPPORT -I$(BROTLI_DIR)/include -L$(BROTLI_DIR)/lib -lbrotlicommon -lbrotlienc -lbrotlidec
 
-all : test
+TEST_ARGS = gtest/gtest-all.cc gtest/gtest_main.cc $(OPENSSL_SUPPORT) $(ZLIB_SUPPORT) $(BROTLI_SUPPORT) -pthread
+
+all : test test_split
 	./test
+# Note: The intention of test_split is to verify that it works to compile and
+# link the split httplib.h, so there is normally no need to execute it.
 
 proxy : test_proxy
 	./test_proxy
 
-test : test.cc ../httplib.h Makefile cert.pem
-	$(CXX) -o test $(CXXFLAGS) test.cc gtest/gtest-all.cc gtest/gtest_main.cc $(OPENSSL_SUPPORT) $(ZLIB_SUPPORT) $(BROTLI_SUPPORT) -pthread
+test : test.cc include_httplib.cc ../httplib.h Makefile cert.pem
+	$(CXX) -o $@ -I.. $(CXXFLAGS) test.cc include_httplib.cc $(TEST_ARGS)
+
+test_split : test.cc ../httplib.h httplib.cc Makefile cert.pem
+	$(CXX) -o $@ $(CXXFLAGS) test.cc httplib.cc $(TEST_ARGS)
 
 test_proxy : test_proxy.cc ../httplib.h Makefile cert.pem
-	$(CXX) -o test_proxy $(CXXFLAGS) test_proxy.cc gtest/gtest-all.cc gtest/gtest_main.cc $(OPENSSL_SUPPORT) $(ZLIB_SUPPORT) $(BROTLI_SUPPORT) -pthread
+	$(CXX) -o $@ -I.. $(CXXFLAGS) test_proxy.cc $(TEST_ARGS)
+
+httplib.cc : ../httplib.h
+	python3 ../split.py -o .
 
 cert.pem:
 	openssl genrsa 2048 > key.pem
@@ -32,4 +42,4 @@ cert.pem:
 	#c_rehash .
 
 clean:
-	rm -f test test_proxy pem *.0 *.1 *.srl
+	rm -f test test_proxy pem *.0 *.1 *.srl httplib.h httplib.cc

test/include_httplib.cc

@@ -0,0 +1,5 @@
+// The sole purpose of this file is to include httplib.h in a separate
+// compilation unit, thus verifying that inline keywords have not been forgotten
+// when linked together with test.cc.
+
+#include <httplib.h>

test/test.cc

@@ -354,7 +354,7 @@ TEST(BufferStreamTest, read) {
   EXPECT_EQ(0, strm.read(buf, 1));
 }
 
-TEST(ChunkedEncodingTest, FromHTTPWatch) {
+TEST(ChunkedEncodingTest, FromHTTPWatch_Online) {
   auto host = "www.httpwatch.com";
 
 #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
@@ -377,7 +377,7 @@ TEST(ChunkedEncodingTest, FromHTTPWatch) {
   EXPECT_EQ(out, res->body);
 }
 
-TEST(ChunkedEncodingTest, WithContentReceiver) {
+TEST(ChunkedEncodingTest, WithContentReceiver_Online) {
   auto host = "www.httpwatch.com";
 
 #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
@@ -405,7 +405,7 @@ TEST(ChunkedEncodingTest, WithContentReceiver) {
   EXPECT_EQ(out, body);
 }
 
-TEST(ChunkedEncodingTest, WithResponseHandlerAndContentReceiver) {
+TEST(ChunkedEncodingTest, WithResponseHandlerAndContentReceiver_Online) {
   auto host = "www.httpwatch.com";
 
 #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
@@ -437,7 +437,7 @@ TEST(ChunkedEncodingTest, WithResponseHandlerAndContentReceiver) {
   EXPECT_EQ(out, body);
 }
 
-TEST(RangeTest, FromHTTPBin) {
+TEST(RangeTest, FromHTTPBin_Online) {
   auto host = "httpbin.org";
 
 #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
@@ -578,7 +578,7 @@ TEST(ConnectionErrorTest, Timeout) {
   EXPECT_TRUE(res.error() == Error::Connection);
 }
 
-TEST(CancelTest, NoCancel) {
+TEST(CancelTest, NoCancel_Online) {
   auto host = "httpbin.org";
 
 #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
@@ -596,7 +596,7 @@ TEST(CancelTest, NoCancel) {
   EXPECT_EQ(200, res->status);
 }
 
-TEST(CancelTest, WithCancelSmallPayload) {
+TEST(CancelTest, WithCancelSmallPayload_Online) {
   auto host = "httpbin.org";
 
 #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
@@ -613,7 +613,7 @@ TEST(CancelTest, WithCancelSmallPayload) {
   EXPECT_EQ(Error::Canceled, res.error());
 }
 
-TEST(CancelTest, WithCancelLargePayload) {
+TEST(CancelTest, WithCancelLargePayload_Online) {
   auto host = "httpbin.org";
 
 #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
@@ -632,7 +632,7 @@ TEST(CancelTest, WithCancelLargePayload) {
   EXPECT_EQ(Error::Canceled, res.error());
 }
 
-TEST(BaseAuthTest, FromHTTPWatch) {
+TEST(BaseAuthTest, FromHTTPWatch_Online) {
   auto host = "httpbin.org";
 
 #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
@@ -683,7 +683,7 @@ TEST(BaseAuthTest, FromHTTPWatch) {
 }
 
 #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
-TEST(DigestAuthTest, FromHTTPWatch) {
+TEST(DigestAuthTest, FromHTTPWatch_Online) {
   auto host = "httpbin.org";
   auto port = 443;
   SSLClient cli(host, port);
@@ -730,7 +730,7 @@ TEST(DigestAuthTest, FromHTTPWatch) {
 }
 #endif
 
-TEST(AbsoluteRedirectTest, Redirect) {
+TEST(AbsoluteRedirectTest, Redirect_Online) {
   auto host = "nghttp2.org";
 
 #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
@@ -745,7 +745,7 @@ TEST(AbsoluteRedirectTest, Redirect) {
   EXPECT_EQ(200, res->status);
 }
 
-TEST(RedirectTest, Redirect) {
+TEST(RedirectTest, Redirect_Online) {
   auto host = "nghttp2.org";
 
 #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
@@ -760,7 +760,7 @@ TEST(RedirectTest, Redirect) {
   EXPECT_EQ(200, res->status);
 }
 
-TEST(RelativeRedirectTest, Redirect) {
+TEST(RelativeRedirectTest, Redirect_Online) {
   auto host = "nghttp2.org";
 
 #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
@@ -775,7 +775,7 @@ TEST(RelativeRedirectTest, Redirect) {
   EXPECT_EQ(200, res->status);
 }
 
-TEST(TooManyRedirectTest, Redirect) {
+TEST(TooManyRedirectTest, Redirect_Online) {
   auto host = "nghttp2.org";
 
 #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
@@ -791,7 +791,7 @@ TEST(TooManyRedirectTest, Redirect) {
 }
 
 #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
-TEST(YahooRedirectTest, Redirect) {
+TEST(YahooRedirectTest, Redirect_Online) {
   Client cli("yahoo.com");
 
   auto res = cli.Get("/");
@@ -805,7 +805,7 @@ TEST(YahooRedirectTest, Redirect) {
   EXPECT_EQ("https://yahoo.com/", res->location);
 }
 
-TEST(HttpsToHttpRedirectTest, Redirect) {
+TEST(HttpsToHttpRedirectTest, Redirect_Online) {
   SSLClient cli("nghttp2.org");
   cli.set_follow_location(true);
   auto res = cli.Get(
@@ -814,7 +814,7 @@ TEST(HttpsToHttpRedirectTest, Redirect) {
   EXPECT_EQ(200, res->status);
 }
 
-TEST(HttpsToHttpRedirectTest2, Redirect) {
+TEST(HttpsToHttpRedirectTest2, Redirect_Online) {
   SSLClient cli("nghttp2.org");
   cli.set_follow_location(true);
 
@@ -827,7 +827,7 @@ TEST(HttpsToHttpRedirectTest2, Redirect) {
   EXPECT_EQ(200, res->status);
 }
 
-TEST(HttpsToHttpRedirectTest3, Redirect) {
+TEST(HttpsToHttpRedirectTest3, Redirect_Online) {
   SSLClient cli("nghttp2.org");
   cli.set_follow_location(true);
 
@@ -839,7 +839,7 @@ TEST(HttpsToHttpRedirectTest3, Redirect) {
   EXPECT_EQ(200, res->status);
 }
 
-TEST(UrlWithSpace, Redirect) {
+TEST(UrlWithSpace, Redirect_Online) {
   SSLClient cli("edge.forgecdn.net");
   cli.set_follow_location(true);
 
@@ -852,42 +852,49 @@ TEST(UrlWithSpace, Redirect) {
 #endif
 
 TEST(RedirectToDifferentPort, Redirect) {
-  Server svr8080;
-  Server svr8081;
-
-  svr8080.Get("/1", [&](const Request & /*req*/, Response &res) {
-    res.set_redirect("http://localhost:8081/2");
-  });
-
-  svr8081.Get("/2", [&](const Request & /*req*/, Response &res) {
+  Server svr1;
+  svr1.Get("/1", [&](const Request & /*req*/, Response &res) {
     res.set_content("Hello World!", "text/plain");
   });
 
-  auto thread8080 = std::thread([&]() { svr8080.listen("localhost", 8080); });
+  int svr1_port = 0;
+  auto thread1 = std::thread([&]() {
+    svr1_port = svr1.bind_to_any_port("localhost");
+    svr1.listen_after_bind();
+  });
 
-  auto thread8081 = std::thread([&]() { svr8081.listen("localhost", 8081); });
+  Server svr2;
+  svr2.Get("/2", [&](const Request & /*req*/, Response &res) {
+    res.set_redirect("http://localhost:" + std::to_string(svr1_port) + "/1");
+  });
 
-  while (!svr8080.is_running() || !svr8081.is_running()) {
+  int svr2_port = 0;
+  auto thread2 = std::thread([&]() {
+    svr2_port = svr2.bind_to_any_port("localhost");
+    svr2.listen_after_bind();
+  });
+
+  while (!svr1.is_running() || !svr2.is_running()) {
     std::this_thread::sleep_for(std::chrono::milliseconds(1));
   }
 
   // Give GET time to get a few messages.
   std::this_thread::sleep_for(std::chrono::seconds(1));
 
-  Client cli("localhost", 8080);
+  Client cli("localhost", svr2_port);
   cli.set_follow_location(true);
 
-  auto res = cli.Get("/1");
+  auto res = cli.Get("/2");
   ASSERT_TRUE(res);
   EXPECT_EQ(200, res->status);
   EXPECT_EQ("Hello World!", res->body);
 
-  svr8080.stop();
-  svr8081.stop();
-  thread8080.join();
-  thread8081.join();
-  ASSERT_FALSE(svr8080.is_running());
-  ASSERT_FALSE(svr8081.is_running());
+  svr1.stop();
+  svr2.stop();
+  thread1.join();
+  thread2.join();
+  ASSERT_FALSE(svr1.is_running());
+  ASSERT_FALSE(svr2.is_running());
 }
 
 TEST(RedirectFromPageWithContent, Redirect) {
@@ -3769,7 +3776,7 @@ TEST(GetWithParametersTest, GetWithParameters) {
     EXPECT_EQ("world3", req.get_param_value("hello3"));
   });
 
-  svr.Get(R"(/resources/([a-z0-9\\-]+))", [&](const Request& req, Response&) {
+  svr.Get(R"(/resources/([a-z0-9\\-]+))", [&](const Request &req, Response &) {
     EXPECT_EQ("resource-id", req.matches[1]);
     EXPECT_EQ("foo", req.get_param_value("param1"));
     EXPECT_EQ("bar", req.get_param_value("param2"));
@@ -3852,7 +3859,7 @@ TEST(GetWithParametersTest, GetWithParameters2) {
   ASSERT_FALSE(svr.is_running());
 }
 
-TEST(ClientDefaultHeadersTest, DefaultHeaders) {
+TEST(ClientDefaultHeadersTest, DefaultHeaders_Online) {
   Client cli("httpbin.org");
   cli.set_default_headers({make_range_header({{1, 10}})});
   cli.set_connection_timeout(5);
@@ -4089,21 +4096,21 @@ TEST(SSLClientTest, UpdateCAStore) {
   httplib_client.set_ca_cert_store(ca_store_2);
 }
 
-TEST(SSLClientTest, ServerNameIndication) {
+TEST(SSLClientTest, ServerNameIndication_Online) {
   SSLClient cli("httpbin.org", 443);
   auto res = cli.Get("/get");
   ASSERT_TRUE(res);
   ASSERT_EQ(200, res->status);
 }
 
-TEST(SSLClientTest, ServerCertificateVerification1) {
+TEST(SSLClientTest, ServerCertificateVerification1_Online) {
   SSLClient cli("google.com");
   auto res = cli.Get("/");
   ASSERT_TRUE(res);
   ASSERT_EQ(301, res->status);
 }
 
-TEST(SSLClientTest, ServerCertificateVerification2) {
+TEST(SSLClientTest, ServerCertificateVerification2_Online) {
   SSLClient cli("google.com");
   cli.enable_server_certificate_verification(true);
   cli.set_ca_cert_path("hello");
@@ -4112,7 +4119,7 @@ TEST(SSLClientTest, ServerCertificateVerification2) {
   EXPECT_EQ(Error::SSLLoadingCerts, res.error());
 }
 
-TEST(SSLClientTest, ServerCertificateVerification3) {
+TEST(SSLClientTest, ServerCertificateVerification3_Online) {
   SSLClient cli("google.com");
   cli.set_ca_cert_path(CA_CERT_FILE);
   auto res = cli.Get("/");
@@ -4145,7 +4152,7 @@ TEST(SSLClientTest, ServerCertificateVerification4) {
   t.join();
 }
 
-TEST(SSLClientTest, WildcardHostNameMatch) {
+TEST(SSLClientTest, WildcardHostNameMatch_Online) {
   SSLClient cli("www.youtube.com");
 
   cli.set_ca_cert_path(CA_CERT_FILE);
@@ -4390,7 +4397,7 @@ TEST(NoScheme, SimpleInterface) {
   ASSERT_TRUE(cli.is_valid());
 }
 
-TEST(SendAPI, SimpleInterface) {
+TEST(SendAPI, SimpleInterface_Online) {
   Client cli("http://yahoo.com");
 
   Request req;
@@ -4403,7 +4410,7 @@ TEST(SendAPI, SimpleInterface) {
 }
 
 #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
-TEST(YahooRedirectTest2, SimpleInterface) {
+TEST(YahooRedirectTest2, SimpleInterface_Online) {
   Client cli("http://yahoo.com");
 
   auto res = cli.Get("/");
@@ -4417,7 +4424,7 @@ TEST(YahooRedirectTest2, SimpleInterface) {
   EXPECT_EQ("https://yahoo.com/", res->location);
 }
 
-TEST(YahooRedirectTest3, SimpleInterface) {
+TEST(YahooRedirectTest3, SimpleInterface_Online) {
   Client cli("https://yahoo.com");
 
   auto res = cli.Get("/");
@@ -4431,7 +4438,7 @@ TEST(YahooRedirectTest3, SimpleInterface) {
   EXPECT_EQ("https://www.yahoo.com/", res->location);
 }
 
-TEST(YahooRedirectTest3, NewResultInterface) {
+TEST(YahooRedirectTest3, NewResultInterface_Online) {
   Client cli("https://yahoo.com");
 
   auto res = cli.Get("/");
@@ -4456,7 +4463,7 @@ TEST(YahooRedirectTest3, NewResultInterface) {
 }
 
 #ifdef CPPHTTPLIB_BROTLI_SUPPORT
-TEST(DecodeWithChunkedEncoding, BrotliEncoding) {
+TEST(DecodeWithChunkedEncoding, BrotliEncoding_Online) {
   Client cli("https://cdnjs.cloudflare.com");
   auto res =
       cli.Get("/ajax/libs/jquery/3.5.1/jquery.js", {{"Accept-Encoding", "br"}});
@@ -4469,7 +4476,7 @@ TEST(DecodeWithChunkedEncoding, BrotliEncoding) {
 }
 #endif
 
-TEST(HttpsToHttpRedirectTest, SimpleInterface) {
+TEST(HttpsToHttpRedirectTest, SimpleInterface_Online) {
   Client cli("https://nghttp2.org");
   cli.set_follow_location(true);
   auto res =
@@ -4480,7 +4487,7 @@ TEST(HttpsToHttpRedirectTest, SimpleInterface) {
   EXPECT_EQ(200, res->status);
 }
 
-TEST(HttpsToHttpRedirectTest2, SimpleInterface) {
+TEST(HttpsToHttpRedirectTest2, SimpleInterface_Online) {
   Client cli("https://nghttp2.org");
   cli.set_follow_location(true);
 
@@ -4493,7 +4500,7 @@ TEST(HttpsToHttpRedirectTest2, SimpleInterface) {
   EXPECT_EQ(200, res->status);
 }
 
-TEST(HttpsToHttpRedirectTest3, SimpleInterface) {
+TEST(HttpsToHttpRedirectTest3, SimpleInterface_Online) {
   Client cli("https://nghttp2.org");
   cli.set_follow_location(true);
 
@@ -4520,7 +4527,6 @@ TEST(HttpToHttpsRedirectTest, CertFile) {
     ssl_svr.stop();
   });
 
-
   thread t = thread([&]() { ASSERT_TRUE(svr.listen("127.0.0.1", PORT)); });
   thread t2 = thread([&]() { ASSERT_TRUE(ssl_svr.listen("127.0.0.1", 1235)); });
   std::this_thread::sleep_for(std::chrono::milliseconds(1));