mirror of
https://github.com/theupdateframework/python-tuf
synced 2026-05-24 10:08:28 +00:00
5d9a6f6598
These changes can be summarized with the following bullets: - Delegate generation of ports used for the tests to the OS - Use thread-safe Queue for processes communication instead of temporary files - Remove all instances of port generation or hardcoded ports - Make test_slow_retrieval.py fully conform with TestServerProcess Delegate generation of ports used for the tests to the OS is much better than if we manually generate them, because there is always a chance that the port we have randomly pick turns out to be taken. By giving 0 to the port argument we ask the OS to give us an arbitrary unused port. Use thread-safe Queue for processes communication instead of temporary files became a necessity because of findings made by Jussi Kukkonen. With the latest changes made in pr 1192 we were rapidly reading from the temporary files and Jussi found that it happened rarely the successful message "bind succeded..." to be corrupted. It seems, this is a thread issue related to the thread redirecting the subprocess stdout to the temp file and our thread rapidly reading from the file. By using a thread-safe Queue we eliminate this possibility. For reference read: https://github.com/theupdateframework/tuf/issues/1196 Lastly, test_slow_retrieval.py and slow_retrieval.py were refactored. Until now, slow_retrieval.py couldn't use the TestServerProcess class from utils.py for a port generation because of a bug related to httpd.handle_request(). Now, when we use httpd.serve_forever() we can refactor both of those files and fully conform with TestServerProcess. Signed-off-by: Martin Vrachev <mvrachev@vmware.com>
73 lines
2.1 KiB
Python
Executable file
73 lines
2.1 KiB
Python
Executable file
#!/usr/bin/env python
|
|
|
|
# Copyright 2012 - 2017, New York University and the TUF contributors
|
|
# SPDX-License-Identifier: MIT OR Apache-2.0
|
|
|
|
"""
|
|
<Program>
|
|
simple_server.py
|
|
|
|
<Author>
|
|
Konstantin Andrianov.
|
|
|
|
<Started>
|
|
February 15, 2012.
|
|
|
|
<Copyright>
|
|
See LICENSE-MIT or LICENSE for licensing information.
|
|
|
|
<Purpose>
|
|
This is a basic server that was designed to be used in conjunction with
|
|
test_download.py to test download.py module.
|
|
|
|
<Reference>
|
|
SimpleHTTPServer:
|
|
http://docs.python.org/library/simplehttpserver.html#module-SimpleHTTPServer
|
|
"""
|
|
|
|
# Help with Python 3 compatibility, where the print statement is a function, an
|
|
# implicit relative import is invalid, and the '/' operator performs true
|
|
# division. Example: print 'hello world' raises a 'SyntaxError' exception.
|
|
from __future__ import print_function
|
|
from __future__ import absolute_import
|
|
from __future__ import division
|
|
from __future__ import unicode_literals
|
|
|
|
import sys
|
|
import random
|
|
|
|
import six
|
|
from six.moves.SimpleHTTPServer import SimpleHTTPRequestHandler
|
|
|
|
|
|
class QuietHTTPRequestHandler(SimpleHTTPRequestHandler):
|
|
"""A SimpleHTTPRequestHandler that does not write incoming requests to
|
|
stderr. """
|
|
def log_request(self, code='-', size='-'):
|
|
pass
|
|
|
|
# NOTE: On Windows/Python2 tests that use this simple_server.py in a
|
|
# subprocesses hang after a certain amount of requests (~68), if a PIPE is
|
|
# passed as Popen's stderr argument. This problem doesn't emerge if
|
|
# we silence the HTTP messages.
|
|
# If you decide to receive the HTTP messages, then this bug
|
|
# could reappear.
|
|
use_quiet_http_request_handler = True
|
|
|
|
if len(sys.argv) > 2:
|
|
use_quiet_http_request_handler = sys.argv[2]
|
|
|
|
if use_quiet_http_request_handler:
|
|
handler = QuietHTTPRequestHandler
|
|
else:
|
|
handler = SimpleHTTPRequestHandler
|
|
|
|
# Allow re-use so you can re-run tests as often as you want even if the
|
|
# tests re-use ports. Otherwise TCP TIME-WAIT prevents reuse for ~1 minute
|
|
six.moves.socketserver.TCPServer.allow_reuse_address = True
|
|
|
|
httpd = six.moves.socketserver.TCPServer(('localhost', 0), handler)
|
|
port_message = 'bind succeeded, server port is: ' \
|
|
+ str(httpd.server_address[1])
|
|
print(port_message)
|
|
httpd.serve_forever()
|