Merge pull request #438 from jakob-bagterp/feature/increase-codecov-test-coverage

Feature: Increase Codecov test coverage (part 7)

Author: jakob-bagterp

test/_constant/interval.py

@@ -1 +1 @@
-ULTRA_SHORT_INTERVAL: float = 0.001  # 1 millisecond.
+ONE_MILLISECOND_AS_SECOND: float = 0.001

test/timer/exception_handling/__init__.py

@@ -0,0 +1,45 @@
+from collections.abc import Callable
+from contextlib import nullcontext as does_not_raise_exception
+
+import pytest
+
+from .soft_error.decimals_1_test import (
+    test_timer_decimals_above_accepted_value,
+    test_timer_decimals_below_accepted_value)
+from .soft_error.invalid_thread_type_start_test import (
+    test_timer_start_invalid_thread_type_soft_error_with_context_manager,
+    test_timer_start_invalid_thread_type_soft_error_without_context_manager)
+from .soft_error.invalid_thread_type_stop_test import (
+    test_timer_stop_invalid_thread_type_soft_error_with_context_manager,
+    test_timer_stop_invalid_thread_type_soft_error_without_context_manager)
+from .soft_error.start_test import (
+    test_timer_start_default_thread_twice_soft_error_without_context_manager,
+    test_timer_start_thread_name_collision_soft_error_with_context_manager,
+    test_timer_start_thread_name_collision_soft_error_without_context_manager)
+from .soft_error.stop_test import (
+    test_timer_stop_default_thread_while_custom_thread_is_running_soft_error,
+    test_timer_stop_not_started_thread_soft_error_without_start,
+    test_timer_stop_not_started_thread_soft_error_without_start_and_with_custom_thread,
+    test_timer_stop_unknown_thread_soft_error_with_default_and_custom_thread,
+    test_timer_stop_unknown_thread_soft_error_with_multiple_custom_threads)
+
+
+@pytest.mark.parametrize("test_function", [
+    test_timer_decimals_below_accepted_value,
+    test_timer_decimals_above_accepted_value,
+    test_timer_start_invalid_thread_type_soft_error_without_context_manager,
+    test_timer_start_invalid_thread_type_soft_error_with_context_manager,
+    test_timer_stop_invalid_thread_type_soft_error_without_context_manager,
+    test_timer_stop_invalid_thread_type_soft_error_with_context_manager,
+    test_timer_start_default_thread_twice_soft_error_without_context_manager,
+    test_timer_start_thread_name_collision_soft_error_with_context_manager,
+    test_timer_start_thread_name_collision_soft_error_without_context_manager,
+    test_timer_stop_default_thread_while_custom_thread_is_running_soft_error,
+    test_timer_stop_not_started_thread_soft_error_without_start,
+    test_timer_stop_not_started_thread_soft_error_without_start_and_with_custom_thread,
+    test_timer_stop_unknown_thread_soft_error_with_default_and_custom_thread,
+    test_timer_stop_unknown_thread_soft_error_with_multiple_custom_threads,
+])
+def test_timer_does_not_raise_exceptions(test_function: Callable[..., None], capfd: object) -> None:
+    with does_not_raise_exception():
+        test_function(capfd)

test/timer/exception_handling/does_not_raise_exceptions_test.py

@@ -2,6 +2,7 @@
 from os import linesep
 
 import pytest
+from _constant.interval import ONE_MILLISECOND_AS_SECOND
 from _helper import operating_system
 from _helper.random import random_thread_name, random_thread_name_but_not
 from _helper.timer import ensure_all_timer_threads_are_stopped
@@ -17,7 +18,7 @@ def test_timer_stop_unknown_thread_soft_error_with_default_and_custom_thread(cap
     custom_thread = random_thread_name()
     timer = ensure_all_timer_threads_are_stopped()
     timer.start()
-    time.sleep(0.001)
+    time.sleep(ONE_MILLISECOND_AS_SECOND)
     timer.stop(thread=custom_thread)
     terminal_output, _ = capfd.readouterr()
     assert terminal_output == \
@@ -35,7 +36,7 @@ def test_timer_stop_unknown_thread_soft_error_with_multiple_custom_threads(capfd
     custom_thread_2 = random_thread_name_but_not(custom_thread_1)
     timer = ensure_all_timer_threads_are_stopped()
     timer.start(thread=custom_thread_1)
-    time.sleep(0.001)
+    time.sleep(ONE_MILLISECOND_AS_SECOND)
     timer.stop(thread=custom_thread_2)
     terminal_output, _ = capfd.readouterr()
     assert terminal_output == \

test/timer/exception_handling/soft_error/__init__.py

@@ -1,6 +1,7 @@
 import re
 import time
 
+from _constant.interval import ONE_MILLISECOND_AS_SECOND
 from _helper.terminal_output import successful_output_regex
 from _helper.timer import ensure_all_timer_threads_are_stopped
 
@@ -12,7 +13,7 @@ def test_timer_decimals_output(capfd: object) -> None:
     ensure_all_timer_threads_are_stopped()
     for decimals in range(MINIMUM, MAXIMUM + 1):
         with Timer(decimals=decimals):
-            time.sleep(0.001)
+            time.sleep(ONE_MILLISECOND_AS_SECOND)
         terminal_output, _ = capfd.readouterr()
         expected_output_regex = successful_output_regex(decimals=decimals)
         assert re.fullmatch(expected_output_regex, terminal_output)

test/timer/exception_handling/soft_error/stop_test.py

@@ -4,7 +4,7 @@
 from typing import Any
 
 import pytest
-from _constant.interval import ULTRA_SHORT_INTERVAL
+from _constant.interval import ONE_MILLISECOND_AS_SECOND
 from _helper.terminal_output import successful_output_regex
 from _helper.timer import ensure_all_timer_threads_are_stopped
 
@@ -17,32 +17,32 @@
 
 @function_timer()
 def function_with_args(a: int, b: int) -> None:
-    time.sleep(ULTRA_SHORT_INTERVAL)
+    time.sleep(ONE_MILLISECOND_AS_SECOND)
 
 
 @function_timer()
 def function_with_kwargs(x: int = 1, y: int = 2) -> None:
-    time.sleep(ULTRA_SHORT_INTERVAL)
+    time.sleep(ONE_MILLISECOND_AS_SECOND)
 
 
 @function_timer()
 def function_with_args_and_kwargs(a: int, b: int, x: int = 3, y: int = 4) -> None:
-    time.sleep(ULTRA_SHORT_INTERVAL)
+    time.sleep(ONE_MILLISECOND_AS_SECOND)
 
 
 @function_timer()
 def function_with_args_and_kwargs_number_and_strings(a: int, b: str, x: int = 3, y: str = "4") -> None:
-    time.sleep(ULTRA_SHORT_INTERVAL)
+    time.sleep(ONE_MILLISECOND_AS_SECOND)
 
 
 @function_timer(thread=CUSTOM_THREAD)
 def function_with_args_kwargs_and_custom_thread(a: int, b: int, x: int = 3, y: int = 4) -> None:
-    time.sleep(ULTRA_SHORT_INTERVAL)
+    time.sleep(ONE_MILLISECOND_AS_SECOND)
 
 
 @function_timer(thread=CUSTOM_THREAD, decimals=CUSTOM_DECIMALS)
 def function_with_args_kwargs_custom_thread_and_custom_decimals(a: int, b: int, x: int = 3, y: int = 4) -> None:
-    time.sleep(ULTRA_SHORT_INTERVAL)
+    time.sleep(ONE_MILLISECOND_AS_SECOND)
 
 
 @pytest.mark.parametrize("function, args, kwargs, expected_thread_name, decimals", [

test/timer/successful_output/decimals_2_test.py

@@ -3,7 +3,7 @@
 from collections.abc import Callable
 
 import pytest
-from _constant.interval import ULTRA_SHORT_INTERVAL
+from _constant.interval import ONE_MILLISECOND_AS_SECOND
 from _helper.terminal_output import successful_output_regex
 from _helper.timer import ensure_all_timer_threads_are_stopped
 
@@ -15,22 +15,22 @@
 
 @function_timer()
 def function_to_be_timed() -> None:
-    time.sleep(ULTRA_SHORT_INTERVAL)
+    time.sleep(ONE_MILLISECOND_AS_SECOND)
 
 
 @function_timer(thread=CUSTOM_THREAD)
 def function_to_be_timed_with_custom_thread() -> None:
-    time.sleep(ULTRA_SHORT_INTERVAL)
+    time.sleep(ONE_MILLISECOND_AS_SECOND)
 
 
 @function_timer(decimals=CUSTOM_DECIMALS)
 def function_to_be_timed_with_custom_decimals() -> None:
-    time.sleep(ULTRA_SHORT_INTERVAL)
+    time.sleep(ONE_MILLISECOND_AS_SECOND)
 
 
 @function_timer(thread=CUSTOM_THREAD, decimals=CUSTOM_DECIMALS)
 def function_to_be_timed_with_custom_thread_and_decimals() -> None:
-    time.sleep(ULTRA_SHORT_INTERVAL)
+    time.sleep(ONE_MILLISECOND_AS_SECOND)
 
 
 @pytest.mark.parametrize("function, thread, decimals", [

test/timer/successful_output/decorator/function_with_arguments_test.py

@@ -1,6 +1,7 @@
 import re
 import time
 
+from _constant.interval import ONE_MILLISECOND_AS_SECOND
 from _helper.random import random_thread_name
 from _helper.terminal_output import successful_output_regex
 from _helper.timer import ensure_all_timer_threads_are_stopped
@@ -12,7 +13,7 @@ def test_timer_thread_output(capfd: object) -> None:
     ensure_all_timer_threads_are_stopped()
     custom_thread = random_thread_name()
     with Timer(thread=custom_thread):
-        time.sleep(0.001)
+        time.sleep(ONE_MILLISECOND_AS_SECOND)
     terminal_output, _ = capfd.readouterr()
     expected_output_regex = successful_output_regex(thread=custom_thread)
     assert re.fullmatch(expected_output_regex, terminal_output)

test/timer/successful_output/decorator/function_without_arguments_test.py

@@ -1,6 +1,6 @@
 import time
 
-from _constant.interval import ULTRA_SHORT_INTERVAL
+from _constant.interval import ONE_MILLISECOND_AS_SECOND
 from _helper.random import random_thread_name
 from _helper.terminal_output import (verify_decimals_in_terminal_output,
                                      verify_prefix_in_terminal_output)
@@ -12,15 +12,15 @@
 
 def test_with_statement_context_manager(capfd: object) -> None:
     with Timer():
-        time.sleep(ULTRA_SHORT_INTERVAL)
+        time.sleep(ONE_MILLISECOND_AS_SECOND)
     terminal_output, _ = capfd.readouterr()
     assert verify_prefix_in_terminal_output(terminal_output)
 
 
 def test_with_statement_context_manager_with_thread(capfd: object) -> None:
     thread = random_thread_name(4)
     with Timer(thread=thread):
-        time.sleep(ULTRA_SHORT_INTERVAL)
+        time.sleep(ONE_MILLISECOND_AS_SECOND)
     terminal_output, _ = capfd.readouterr()
     assert verify_prefix_in_terminal_output(terminal_output)
     assert thread in terminal_output
@@ -29,7 +29,7 @@ def test_with_statement_context_manager_with_thread(capfd: object) -> None:
 def test_with_statement_context_manager_with_decimals(capfd: object) -> None:
     for decimals in DECIMALS_RANGE:
         with Timer(decimals=decimals):
-            time.sleep(ULTRA_SHORT_INTERVAL)
+            time.sleep(ONE_MILLISECOND_AS_SECOND)
         terminal_output, _ = capfd.readouterr()
         assert verify_prefix_in_terminal_output(terminal_output)
         assert verify_decimals_in_terminal_output(decimals, terminal_output)
@@ -39,7 +39,7 @@ def test_with_statement_context_manager_with_thread_1nd_decimals(capfd: object)
     thread = random_thread_name(4)
     for decimals in DECIMALS_RANGE:
         with Timer(thread=thread, decimals=decimals):
-            time.sleep(ULTRA_SHORT_INTERVAL)
+            time.sleep(ONE_MILLISECOND_AS_SECOND)
         terminal_output, _ = capfd.readouterr()
         assert verify_prefix_in_terminal_output(terminal_output)
         assert thread in terminal_output
@@ -52,9 +52,9 @@ def test_with_statement_context_manager_with_multiple_nested_threads_and_decimal
     for decimals in DECIMALS_RANGE:
         with Timer():
             with Timer(thread=thread_1, decimals=decimals):
-                time.sleep(ULTRA_SHORT_INTERVAL)
+                time.sleep(ONE_MILLISECOND_AS_SECOND)
                 with Timer(thread=thread_2):
-                    time.sleep(ULTRA_SHORT_INTERVAL)
+                    time.sleep(ONE_MILLISECOND_AS_SECOND)
                 terminal_output_1, _ = capfd.readouterr()
                 assert verify_prefix_in_terminal_output(terminal_output_1)
                 assert thread_2 in terminal_output_1
@@ -72,7 +72,7 @@ def test_mix_of_context_manager_standard(capfd: object) -> None:
     timer = Timer()
     timer.start(thread=thread)
     with Timer():
-        time.sleep(ULTRA_SHORT_INTERVAL)
+        time.sleep(ONE_MILLISECOND_AS_SECOND)
     terminal_output_1, _ = capfd.readouterr()
     assert verify_prefix_in_terminal_output(terminal_output_1)
     timer.stop(thread)