tests: add test for chunked encoding with http cli library
authorNoel Power <noel.power@suse.com>
Thu, 23 Sep 2021 11:18:22 +0000 (12:18 +0100)
committerAndrew Bartlett <abartlet@samba.org>
Wed, 27 Mar 2024 01:14:31 +0000 (01:14 +0000)
Adds http test client to excercise the http client library
and a blackbox test to run the client. This client is built
only with selftest

also adds a knownfail for the test

Signed-off-by: Noel Power <noel.power@suse.com>
Reviewed-by: Andrew Bartlett <abartlet@samba.org>
BUG: https://bugzilla.samba.org/show_bug.cgi?id=15611

python/samba/tests/blackbox/http_chunk.py [new file with mode: 0644]
selftest/knownfail.d/http_chunks [new file with mode: 0644]
selftest/tests.py

diff --git a/python/samba/tests/blackbox/http_chunk.py b/python/samba/tests/blackbox/http_chunk.py
new file mode 100644 (file)
index 0000000..1b5cc17
--- /dev/null
@@ -0,0 +1,116 @@
+# Blackbox tests for http_test
+#
+# Copyright (C) Noel Power noel.power@suse.com
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+import os
+import time
+import threading
+import logging
+import json
+from http.server import HTTPServer, BaseHTTPRequestHandler
+from samba.logger import get_samba_logger
+from samba.tests import BlackboxTestCase, BlackboxProcessError
+
+logger = get_samba_logger(name=__name__)
+COMMAND = "bin/http_test"
+def make_chunks(msg, chunk_size):
+    chunks = []
+    while len(msg) > chunk_size:
+        chunk = msg[:chunk_size]
+        chunks.append(chunk)
+        msg = msg[chunk_size:]
+    if len(msg):
+        chunks.append(msg)
+    return chunks
+
+# simple handler, spits back the 'path' passed in
+# GET or POST and a chunked encoded http response
+# where the chunk size is 10 octets
+class ChunkHTTPRequestHandler(BaseHTTPRequestHandler):
+    def handle_req(self):
+        msg = bytes(self.path, encoding="utf-8")
+        chunks = make_chunks(msg, 10)
+
+        self.send_response(200)
+        self.send_header('content-type', 'application/json; charset=UTF-8')
+        self.send_header('Transfer-Encoding', 'chunked')
+        self.end_headers()
+        resp = bytes()
+        for chunk in chunks:
+            resp = resp + ("%x" % len(chunk)).encode("utf-8") + b'\r\n' + chunk + b'\r\n'
+        resp += b'0\r\n\r\n'
+        self.wfile.write(resp)
+
+    def do_POST(self):
+        self.handle_req()
+    def do_GET(self):
+        self.handle_req()
+
+class HttpChunkBlackboxTests(BlackboxTestCase):
+    def setUp(self):
+        self.server = HTTPServer((os.getenv("SERVER_IP", "localhost"), 8080),
+                                 ChunkHTTPRequestHandler,
+                                 bind_and_activate=False)
+        self.t = threading.Thread(target=HttpChunkBlackboxTests.http_server, args=(self,))
+        self.t.setDaemon(True)
+        self.t.start()
+        time.sleep(1)
+
+    def tearDown(self):
+        super().tearDown()
+
+    def http_server(self):
+        self.server.server_bind()
+        self.server.server_activate()
+        self.server.serve_forever()
+
+    def test_single_chunk(self):
+        try:
+            msg = "one_chunk"
+            resp = self.check_output("%s -U%% -I%s --uri %s" % (COMMAND, os.getenv("SERVER_IP", "localhost"), msg))
+            self.assertEqual(msg, resp.decode('utf-8'))
+        except BlackboxProcessError as e:
+            print("Failed with: %s" % e)
+            self.fail(str(e))
+
+    def test_multi_chunks(self):
+        try:
+            msg = "snglechunksnglechunksnglechunksnglechunksnglechunk"
+            resp = self.check_output("%s -U%% -I%s --uri %s" % (COMMAND, os.getenv("SERVER_IP", "localhost"), msg))
+            self.assertEqual(msg, resp.decode('utf-8'))
+        except BlackboxProcessError as e:
+            print("Failed with: %s" % e)
+            self.fail(str(e))
+
+    def test_exceed_request_size(self):
+        try:
+            msg = "snglechunksnglechunksnglechunksnglechunksnglechunk"
+            resp = self.check_output("%s -d11 -U%% -I%s --rsize 49 --uri %s" % (COMMAND, os.getenv("SERVER_IP", "localhost"), msg))
+            self.fail(str(e))
+        except BlackboxProcessError as e:
+            if "http_read_chunk: size 50 exceeds max content len 49 skipping body" not in e.stderr.decode('utf-8'):
+                self.fail(str(e))
+            if "unexpected 0 len response" not in e.stdout.decode('utf-8'):
+                self.fail(str(e))
+
+    def test_exact_request_size(self):
+        try:
+            msg = "snglechunksnglechunksnglechunksnglechunksnglechunk"
+            resp = self.check_output("%s -U%% -I%s --rsize 50 --uri %s" % (COMMAND, os.getenv("SERVER_IP", "localhost"), msg))
+            self.assertEqual(msg, resp.decode('utf-8'))
+        except BlackboxProcessError as e:
+            print("Failed with: %s" % e)
+            self.fail(str(e))
diff --git a/selftest/knownfail.d/http_chunks b/selftest/knownfail.d/http_chunks
new file mode 100644 (file)
index 0000000..e58e002
--- /dev/null
@@ -0,0 +1,5 @@
+^samba.tests.blackbox.http_chunk.samba.tests.blackbox.http_chunk.HttpChunkBlackboxTests.test_multi_chunks
+^samba.tests.blackbox.http_chunk.samba.tests.blackbox.http_chunk.HttpChunkBlackboxTests.test_single_chunk
+^samba.tests.blackbox.http_chunk.samba.tests.blackbox.http_chunk.HttpChunkBlackboxTests.test_exact_request_size
+^samba.tests.blackbox.http_chunk.samba.tests.blackbox.http_chunk.HttpChunkBlackboxTests.test_exceed_request_size
+
index 169a4af40feb51531dc7f983a13fdae862fe60ea..21e1a490644842a487e33a17ef91d6d4197906ee 100644 (file)
@@ -302,6 +302,7 @@ plantestsuite(
     cmdline('test_special_group.sh', '$PREFIX_ABS/provision'))
 
 planpythontestsuite("fileserver", "samba.tests.blackbox.http_content")
+planpythontestsuite("fileserver", "samba.tests.blackbox.http_chunk")
 planpythontestsuite("none", "samba.tests.upgradeprovision")
 planpythontestsuite("none", "samba.tests.xattr")
 planpythontestsuite("none", "samba.tests.ntacls")