Add pytest timeout to add timeout to tests

Author: rhatgadkar-goog

pyproject.toml

@@ -82,3 +82,6 @@ exclude = ['docs/*']
 
 [tool.pytest.ini_options]
 asyncio_mode = "auto"
+timeout = 5  
+log_cli=true  
+log_level=INFO

requirements-test.txt

@@ -16,3 +16,4 @@ pytest-cov==6.2.1
 pytest-aiohttp==1.1.0
 SQLAlchemy[asyncio]==2.0.41
 aioresponses==0.7.8
+pytest-timeout==2.4.0

requirements.txt

@@ -1,6 +1,6 @@
 aiofiles==24.1.0
 aiohttp==3.12.13
-cryptography==44.0.3
+cryptography==45.0.5
 google-auth==2.40.3
 requests==2.32.4
 protobuf==6.31.1

tests/unit/test_connector.py

@@ -38,24 +38,28 @@ def test_Connector_init(credentials: FakeCredentials) -> None:
     Test to check whether the __init__ method of Connector
     properly sets default attributes.
     """
+    print("RISHABH DEBUG: started test")
     connector = Connector(credentials)
     assert connector._quota_project is None
     assert connector._alloydb_api_endpoint == "alloydb.googleapis.com"
     assert connector._client is None
     assert connector._credentials == credentials
     assert connector._closed is False
     connector.close()
+    print("RISHABH DEBUG: completed test")
 
 
 def test_Connector_init_bad_ip_type(credentials: FakeCredentials) -> None:
     """Test that Connector errors due to bad ip_type str."""
+    print("RISHABH DEBUG: started test")
     bad_ip_type = "BAD-IP-TYPE"
     with pytest.raises(ValueError) as exc_info:
         Connector(ip_type=bad_ip_type, credentials=credentials)
     assert (
         exc_info.value.args[0]
         == f"Incorrect value for ip_type, got '{bad_ip_type}'. Want one of: 'PUBLIC', 'PRIVATE', 'PSC'."
     )
+    print("RISHABH DEBUG: completed test")
 
 
 @pytest.mark.parametrize(
@@ -106,9 +110,11 @@ def test_Connector_init_ip_type(
     Test to check whether the __init__ method of Connector
     properly sets ip_type.
     """
+    print("RISHABH DEBUG: started test")
     connector = Connector(credentials=credentials, ip_type=ip_type)
     assert connector._ip_type == expected
     connector.close()
+    print("RISHABH DEBUG: completed test")
 
 
 def test_Connector_init_alloydb_api_endpoint_with_http_prefix(
@@ -118,11 +124,13 @@ def test_Connector_init_alloydb_api_endpoint_with_http_prefix(
     Test to check whether the __init__ method of Connector properly sets
     alloydb_api_endpoint when its URL has an 'http://' prefix.
     """
+    print("RISHABH DEBUG: started test")
     connector = Connector(
         alloydb_api_endpoint="http://alloydb.googleapis.com", credentials=credentials
     )
     assert connector._alloydb_api_endpoint == "alloydb.googleapis.com"
     connector.close()
+    print("RISHABH DEBUG: completed test")
 
 
 def test_Connector_init_alloydb_api_endpoint_with_https_prefix(
@@ -132,30 +140,35 @@ def test_Connector_init_alloydb_api_endpoint_with_https_prefix(
     Test to check whether the __init__ method of Connector properly sets
     alloydb_api_endpoint when its URL has an 'https://' prefix.
     """
+    print("RISHABH DEBUG: started test")
     connector = Connector(
         alloydb_api_endpoint="https://alloydb.googleapis.com", credentials=credentials
     )
     assert connector._alloydb_api_endpoint == "alloydb.googleapis.com"
     connector.close()
+    print("RISHABH DEBUG: completed test")
 
 
 def test_Connector_context_manager(credentials: FakeCredentials) -> None:
     """
     Test to check whether the __init__ method of Connector
     properly sets defaults as context manager.
     """
+    print("RISHABH DEBUG: started test")
     with Connector(credentials) as connector:
         assert connector._quota_project is None
         assert connector._alloydb_api_endpoint == "alloydb.googleapis.com"
         assert connector._client is None
         assert connector._credentials == credentials
+    print("RISHABH DEBUG: completed test")
 
 
 def test_Connector_close(credentials: FakeCredentials) -> None:
     """
     Test that Connector's close method stops event loop and
     background thread, and sets the connector as closed.
     """
+    print("RISHABH DEBUG: started test")
     with Connector(credentials) as connector:
         loop: asyncio.AbstractEventLoop = connector._loop
         thread: Thread = connector._thread
@@ -165,13 +178,15 @@ def test_Connector_close(credentials: FakeCredentials) -> None:
     assert loop.is_running() is False
     assert thread.is_alive() is False
     assert connector._closed is True
+    print("RISHABH DEBUG: completed test")
 
 
 @pytest.mark.usefixtures("proxy_server")
 def test_connect(credentials: FakeCredentials, fake_client: FakeAlloyDBClient) -> None:
     """
     Test that connector.connect returns connection object.
     """
+    print("RISHABH DEBUG: started test")
     client = fake_client
     with Connector(credentials) as connector:
         connector._client = client
@@ -187,12 +202,14 @@ def test_connect(credentials: FakeCredentials, fake_client: FakeAlloyDBClient) -
             )
         # check connection is returned
         assert connection is True
+    print("RISHABH DEBUG: completed test")
 
 
 def test_connect_bad_ip_type(
     credentials: FakeCredentials, fake_client: FakeAlloyDBClient
 ) -> None:
     """Test that Connector.connect errors due to bad ip_type str."""
+    print("RISHABH DEBUG: started test")
     with Connector(credentials=credentials) as connector:
         connector._client = fake_client
         bad_ip_type = "BAD-IP-TYPE"
@@ -209,12 +226,14 @@ def test_connect_bad_ip_type(
             exc_info.value.args[0]
             == f"Incorrect value for ip_type, got '{bad_ip_type}'. Want one of: 'PUBLIC', 'PRIVATE', 'PSC'."
         )
+    print("RISHABH DEBUG: completed test")
 
 
 def test_connect_unsupported_driver(credentials: FakeCredentials) -> None:
     """
     Test that connector.connect errors with unsupported database driver.
     """
+    print("RISHABH DEBUG: started test")
     client = FakeAlloyDBClient()
     with Connector(credentials) as connector:
         connector._client = client
@@ -229,10 +248,12 @@ def test_connect_unsupported_driver(credentials: FakeCredentials) -> None:
             exc_info.value.args[0]
             == "Driver 'bad_driver' is not a supported database driver."
         )
+    print("RISHABH DEBUG: completed test")
 
 
 def test_Connector_close_called_multiple_times(credentials: FakeCredentials) -> None:
     """Test that Connector.close can be called multiple times."""
+    print("RISHABH DEBUG: started test")
     # open and close Connector object
     connector = Connector(credentials=credentials)
     # verify background thread exists
@@ -242,6 +263,7 @@ def test_Connector_close_called_multiple_times(credentials: FakeCredentials) ->
     assert connector._thread.is_alive() is False
     # call connector.close a second time
     connector.close()
+    print("RISHABH DEBUG: completed test")
 
 
 def test_Connector_remove_cached_bad_instance(
@@ -252,6 +274,7 @@ def test_Connector_remove_cached_bad_instance(
     the cache and ensure no background refresh happens (which would be
     wasted cycles).
     """
+    print("RISHABH DEBUG: started test")
     instance_uri = "projects/test-project/locations/test-region/clusters/test-cluster/instances/bad-test-instance"
     with Connector(credentials) as connector:
         # The timeout of AlloyDB API methods is set to 60s by default.
@@ -270,13 +293,15 @@ def test_Connector_remove_cached_bad_instance(
         with pytest.raises(RetryError):
             connector.connect(instance_uri, "pg8000")
         assert instance_uri not in connector._cache
+    print("RISHABH DEBUG: completed test")
 
 
 async def test_Connector_remove_cached_no_ip_type(credentials: FakeCredentials) -> None:
     """When a Connector attempts to connect and preferred IP type is not present,
     it should delete the instance from the cache and ensure no background refresh
     happens (which would be wasted cycles).
     """
+    print("RISHABH DEBUG: started test")
     instance_uri = "projects/test-project/locations/test-region/clusters/test-cluster/instances/test-instance"
     # set instance to only have Public IP
     fake_client = FakeAlloyDBClient()
@@ -296,6 +321,7 @@ async def test_Connector_remove_cached_no_ip_type(credentials: FakeCredentials)
             await connector.connect_async(instance_uri, "pg8000", ip_type="private")
         # check that cache has been removed from dict
         assert instance_uri not in connector._cache
+    print("RISHABH DEBUG: completed test")
 
 
 @pytest.mark.usefixtures("proxy_server")
@@ -306,6 +332,7 @@ def test_Connector_static_connection_info(
     Test that Connector.__init__() can specify a static connection info to
     connect to an instance.
     """
+    print("RISHABH DEBUG: started test")
     static_info = write_static_info(fake_client.instance)
     with Connector(credentials=credentials, static_conn_info=static_info) as connector:
         connector._client = fake_client
@@ -321,12 +348,14 @@ def test_Connector_static_connection_info(
             )
         # check connection is returned
         assert connection is True
+    print("RISHABH DEBUG: completed test")
 
 
 def test_connect_when_closed(credentials: FakeCredentials) -> None:
     """
     Test that connector.connect errors when the connection is closed.
     """
+    print("RISHABH DEBUG: started test")
     connector = Connector(credentials=credentials)
     connector.close()
     with pytest.raises(ClosedConnectorError) as exc_info:
@@ -335,3 +364,4 @@ def test_connect_when_closed(credentials: FakeCredentials) -> None:
         exc_info.value.args[0]
         == "Connection attempt failed because the connector has already been closed."
     )
+    print("RISHABH DEBUG: completed test")