IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

[CI/CD] implement readiness check before yielding local-http(s) test servers (#12050)

Browse Source 
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
This commit is contained in:
James Addison 2024-03-08 10:16:31 +00:00 committed by GitHub
parent 1281b158b4
commit 1bfddf81e0
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 11 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
CHANGES.rst
View File

@ -90,6 +90,9 @@ Bugs fixed
Patch by Bénédikt Tran. Patch by Bénédikt Tran.
* #12008: Fix case-sensitive lookup of ``std:label`` names in intersphinx inventory. * #12008: Fix case-sensitive lookup of ``std:label`` names in intersphinx inventory.
Patch by Michael Goerz. Patch by Michael Goerz.
* #12038: Resolve ``linkcheck`` unit test timeouts on Windows by adding a readiness
check to the test HTTP(S) server setup code.
Patch by James Addison.
Testing Testing
------- -------

10
tests/utils.py
View File

@ -1,6 +1,7 @@
import contextlib import contextlib
import http.server import http.server
import pathlib import pathlib
import socket
import threading import threading
from ssl import PROTOCOL_TLS_SERVER, SSLContext from ssl import PROTOCOL_TLS_SERVER, SSLContext
@ -15,11 +16,15 @@ CERT_FILE = str(TESTS_ROOT / "certs" / "cert.pem")
# File lock for tests # File lock for tests
LOCK_PATH = str(TESTS_ROOT / 'test-server.lock') LOCK_PATH = str(TESTS_ROOT / 'test-server.lock')
HOST_NAME = "localhost"
HOST_PORT = 7777
ADDRESS = (HOST_NAME, HOST_PORT)
class HttpServerThread(threading.Thread): class HttpServerThread(threading.Thread):
def __init__(self, handler, *args, **kwargs): def __init__(self, handler, *args, **kwargs):
super().__init__(*args, **kwargs) super().__init__(*args, **kwargs)
self.server = http.server.ThreadingHTTPServer(("localhost", 7777), handler) self.server = http.server.ThreadingHTTPServer(ADDRESS, handler)
def run(self): def run(self):
self.server.serve_forever(poll_interval=0.001) self.server.serve_forever(poll_interval=0.001)
@ -45,7 +50,8 @@ def create_server(thread_class):
server_thread = thread_class(handler, daemon=True) server_thread = thread_class(handler, daemon=True)
server_thread.start() server_thread.start()
try: try:
yield server_thread socket.create_connection(ADDRESS, timeout=0.5).close() # Attempt connection.
yield server_thread # Connection has been confirmed possible; proceed.
finally: finally:
server_thread.terminate() server_thread.terminate()
return contextlib.contextmanager(server) return contextlib.contextmanager(server)