mirror of
https://github.com/theupdateframework/python-tuf
synced 2026-05-24 10:08:28 +00:00
3ed21abf2d
Update new test modules to stop using unittest_toolbox, in preparation for its removal in #1790. The tools provided by unittest_toolbox can easily (in a more obvious way) be replaced by using the standard library modules `tempfile` and `random` (no more used) directly. In the case of tempdir and -file creation/removal, skipping the use of unittest_toolbox, which does this by default, also uncovers some test cleanup failures, which would occur when temporary test directories were removed while a test server hadn't released them. (see `except OSError: pass` in unittest_toolbox's `tearDown` method) **Change details** **test_fetcher_ng.py:** - Stop implicitly creating (setUp) and removing (tearDown) tmp test dirs. -Move now manual creation of an exemplary targets file to setUpClass, as the same file is used by all tests. And remove it explicitly in tearDownClass after killing the server (see note about failure above). - Trigger URL parsing error with a hardcoded invalid URL string instead of a random string. **test_updater_ng.py** - Stop implicitly creating (setUp) and removing (tearDown) tmp test dirs. - Explicitly create tmp test dirs in setUp, but don't remove them in tearDown to avoid above mentioned failures. They will be removed all at once when removing the tmp root test dir in tearDownClass Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
126 lines
3.8 KiB
Python
126 lines
3.8 KiB
Python
#!/usr/bin/env python
|
|
|
|
# Copyright 2020, TUF contributors
|
|
# SPDX-License-Identifier: MIT OR Apache-2.0
|
|
|
|
"""
|
|
<Program Name>
|
|
test_utils.py
|
|
|
|
<Author>
|
|
Martin Vrachev.
|
|
|
|
<Started>
|
|
October 21, 2020.
|
|
|
|
<Copyright>
|
|
See LICENSE-MIT OR LICENSE for licensing information.
|
|
|
|
<Purpose>
|
|
Provide tests for some of the functions in utils.py module.
|
|
"""
|
|
|
|
import logging
|
|
import os
|
|
import socket
|
|
import sys
|
|
import unittest
|
|
|
|
from tests import utils
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
def can_connect(port: int) -> bool:
|
|
"""Check if a socket can connect on the given port"""
|
|
try:
|
|
sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
|
|
sock.connect(("localhost", port))
|
|
return True
|
|
# pylint: disable=broad-except
|
|
except Exception:
|
|
return False
|
|
finally:
|
|
# The process will always enter in finally even after return.
|
|
if sock:
|
|
sock.close()
|
|
|
|
|
|
class TestServerProcess(unittest.TestCase):
|
|
"""Test functionality provided in TestServerProcess from tests/utils.py."""
|
|
|
|
def test_simple_server_startup(self) -> None:
|
|
# Test normal case
|
|
server_process_handler = utils.TestServerProcess(log=logger)
|
|
|
|
# Make sure we can connect to the server
|
|
self.assertTrue(can_connect(server_process_handler.port))
|
|
server_process_handler.clean()
|
|
|
|
def test_simple_https_server_startup(self) -> None:
|
|
# Test normal case
|
|
good_cert_path = os.path.join("ssl_certs", "ssl_cert.crt")
|
|
server_process_handler = utils.TestServerProcess(
|
|
log=logger,
|
|
server="simple_https_server_old.py",
|
|
extra_cmd_args=[good_cert_path],
|
|
)
|
|
|
|
# Make sure we can connect to the server
|
|
self.assertTrue(can_connect(server_process_handler.port))
|
|
server_process_handler.clean()
|
|
|
|
# Test when no cert file is provided
|
|
server_process_handler = utils.TestServerProcess(
|
|
log=logger, server="simple_https_server_old.py"
|
|
)
|
|
|
|
# Make sure we can connect to the server
|
|
self.assertTrue(can_connect(server_process_handler.port))
|
|
server_process_handler.clean()
|
|
|
|
# Test with a non existing cert file.
|
|
non_existing_cert_path = os.path.join("ssl_certs", "non_existing.crt")
|
|
server_process_handler = utils.TestServerProcess(
|
|
log=logger,
|
|
server="simple_https_server_old.py",
|
|
extra_cmd_args=[non_existing_cert_path],
|
|
)
|
|
|
|
# Make sure we can connect to the server
|
|
self.assertTrue(can_connect(server_process_handler.port))
|
|
server_process_handler.clean()
|
|
|
|
def test_slow_retrieval_server_startup(self) -> None:
|
|
# Test normal case
|
|
server_process_handler = utils.TestServerProcess(
|
|
log=logger, server="slow_retrieval_server_old.py"
|
|
)
|
|
|
|
# Make sure we can connect to the server
|
|
self.assertTrue(can_connect(server_process_handler.port))
|
|
server_process_handler.clean()
|
|
|
|
def test_cleanup(self) -> None:
|
|
# Test normal case
|
|
server_process_handler = utils.TestServerProcess(
|
|
log=logger, server="simple_server.py"
|
|
)
|
|
|
|
server_process_handler.clean()
|
|
|
|
# Check if the process has successfully been killed.
|
|
self.assertFalse(server_process_handler.is_process_running())
|
|
|
|
def test_server_exit_before_timeout(self) -> None:
|
|
with self.assertRaises(utils.TestServerProcessError):
|
|
utils.TestServerProcess(logger, server="non_existing_server.py")
|
|
|
|
# Test starting a server which immediately exits."
|
|
with self.assertRaises(utils.TestServerProcessError):
|
|
utils.TestServerProcess(logger, server="fast_server_exit.py")
|
|
|
|
|
|
if __name__ == "__main__":
|
|
utils.configure_test_logging(sys.argv)
|
|
unittest.main()
|