refs #278 Unit Test example for ProgressAnimate

Not perfect yet, but shows the basic concepts of testing for both no failures and expected failures.  I tried to fix things in ProgressAnimate as I went along so that hopefully you can see the correlation between what was being tested, and the fixes that went in to pass the tests.

If you haven't used pytest before, there's a few things to do:
- pip install pytest
- make sure pysimplesql is reachable as a module.  The easiest way is to do a local installation by running `pip -e .` in the pysimplesql root directory
- from the commandline, run `pytest` to run all tests.  Or you can run tests for a specific file, I.e. `pytest progressanimate_test.py`

Author: PySimpleSQL

pysimplesql/pysimplesql.py

@@ -3917,6 +3917,29 @@ def __init__(self, title: str, config: dict = None):
         :param config: Dictionary of configuration options as listed above
         :returns: None
         """
+        default_config = {
+            # oscillators for the bar divider and colors
+            "bar": {"value_start": 0, "value_range": 100, "period": 3, "offset": 0},
+            "red": {"value_start": 0, "value_range": 255, "period": 2, "offset": 0},
+            "green": {"value_start": 0, "value_range": 255, "period": 3, "offset": 120},
+            "blue": {"value_start": 0, "value_range": 255, "period": 4, "offset": 240},
+            # phrases to display and the number of seconds to elapse between phrases
+            "phrases": lang.animate_phrases,
+            "phrase_delay": 5,
+        }
+        if config is None:
+            config = {}
+
+        if type(config) is not dict:
+            raise ValueError("config must be a dictionary")
+
+        if set(config.keys()) - set(default_config.keys()):
+            raise NotImplementedError(
+                f"config may only contain keys: {default_config.keys()}"
+            )
+
+        self.config = {**default_config, **config}
+
         self.title = title
         self.win: sg.Window = None
         self.layout = [
@@ -3935,20 +3958,6 @@ def __init__(self, title: str, config: dict = None):
         self.phrase_index = 0
         self.completed = asyncio.Event()
 
-        default_config = {
-            # oscillators for the bar divider and colors
-            "bar": {"value_start": 0, "value_range": 100, "period": 3, "offset": 0},
-            "red": {"value_start": 0, "value_range": 255, "period": 2, "offset": 0},
-            "green": {"value_start": 0, "value_range": 255, "period": 3, "offset": 120},
-            "blue": {"value_start": 0, "value_range": 255, "period": 4, "offset": 240},
-            # phrases to display and the number of seconds to elapse between phrases
-            "phrases": lang.animate_phrases,
-            "phrase_delay": 5,
-        }
-        if config is None:
-            config = {}
-        self.config = {**default_config, **config}
-
     def run(self, fn: callable, *args, **kwargs):
         """
         Runs the function in a separate co-routine, while animating the progress bar in
@@ -3985,6 +3994,7 @@ async def run_process(self, fn: callable, *args, **kwargs):
             return result
         except Exception as e:  # noqa: BLE001
             print(f"\nAn error occurred in the process: {e}")
+            raise e  # Pass the exception along to the caller
         finally:
             self.completed.set()
 

tests/progressanimate_test.py

@@ -0,0 +1,49 @@
+from time import sleep
+
+import pytest
+
+import pysimplesql as ss
+
+
+# Simulated process
+def process(raise_error=False):
+    if raise_error:
+        raise ValueError("Oops! This process had an error!")
+    sleep(5)
+
+
+def test_successful_process():
+    try:
+        sa = ss.ProgressAnimate("Test ProgressAnimate")
+        sa.run(process, False)
+    except Exception as e:
+        assert False, f"An exception was raised: {e}"
+
+
+def test_exception_during_process():
+    with pytest.raises(Exception):
+        sa = ss.ProgressAnimate("Test ProgressAnimate")
+        v = sa.run(process, True)
+        print(v, type(v))
+
+
+def test_config():
+    # What if config was set with an int?
+    with pytest.raises(ValueError):
+        ss.ProgressAnimate("Test", config=1)
+    # What if config was set with a string
+    with pytest.raises(ValueError):
+        ss.ProgressAnimate("Test", config="My Config")
+    # What if config was set with a list?
+    with pytest.raises(ValueError):
+        ss.ProgressAnimate("Test", config=["red"])
+    # What if config was set with a bool?
+    with pytest.raises(ValueError):
+        ss.ProgressAnimate("Test", config=True)
+    # What if the user does supply a dict, but it doesn't have the right keys?
+    with pytest.raises(NotImplementedError):
+        # Purposely fail by
+        config = {
+            "sound_effect": "beep",
+        }
+        ss.ProgressAnimate("Test", config=config)