Writing a test for times.py

.github/workflows/python-tests.yml

@@ -0,0 +1,25 @@
+name: Python package
+
+on: [push]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.8", "3.10"]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        # This case we are only updating pip, but you could add other dependencies needed.
+        run: |
+          python -m pip install --upgrade pip
+      - name: Test with pytest
+        run: |
+          pytest

.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+    "python.testing.pytestArgs": [
+        "."
+    ],
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true
+}

fixture.yml

@@ -0,0 +1,9 @@
+
+
+- generic:
+  time_range_1: time_range("2010-01-12 10:00:00", "2010-01-12 12:00:00")
+  time_range_2: time_range("2010-01-12 10:30:00", "2010-01-12 10:45:00", 2, 60)
+  expected:
+    - ('2010-01-12 10:30:00', '2010-01-12 10:37:00')
+    - ('2010-01-12 10:38:00', '2010-01-12 10:45:00')
+

test_times.py

@@ -0,0 +1,40 @@
+from times import time_range
+from times import compute_overlap_time
+from pytest import raises
+def test_time_given_input():
+
+    large = time_range("2010-01-12 10:00:00", "2010-01-12 12:00:00")
+    short = time_range("2010-01-12 10:30:00", "2010-01-12 10:45:00", 2, 60)
+    result = compute_overlap_time(large, short)
+    expected = [('2010-01-12 10:30:00', '2010-01-12 10:37:00'), ('2010-01-12 10:38:00', '2010-01-12 10:45:00')]
+    assert result == expected
+
+    #two time ranges do not overlap
+    large2 = time_range("2010-01-12 10:00:00", "2010-01-12 12:00:00")
+    short2 = time_range("2010-01-12 13:30:00", "2010-01-12 13:45:00", 2, 60)
+    with raises(ValueError) as e_info2:
+        compute_overlap_time(large2, short2)
+    expected2 = "no overlap between two time range"
+    assert e_info2.value.args[0] == expected2
+
+    #two time ranges that both contain several intervals each
+    large3 = time_range("2010-01-12 10:00:00", "2010-01-12 12:00:00")
+    short3 = time_range("2010-01-12 11:30:00", "2010-01-12 12:45:00", 2, 60)
+    result3 = compute_overlap_time(large3, short3)
+    expected3 = [("2010-01-12 11:30:00", "2010-01-12 12:00:00")]
+    assert result3 == expected3
+
+    #two time ranges that end exactly at the same time when the other starts
+    large4 = time_range("2010-01-12 10:00:00", "2010-01-12 12:00:00")
+    short4 = time_range("2010-01-12 12:00:00", "2010-01-12 12:45:00", 2, 60)
+    with raises(ValueError) as e_info4:
+        compute_overlap_time(large4, short4)
+    expected4 = "no overlap between two time range"
+    assert e_info4.value.args[0] == expected4
+
+    large5 = time_range("2010-01-12 10:00:00", "2010-01-12 12:00:00")
+    short5 = time_range("2010-01-12 09:00:00", "2010-01-12 09:45:00", 2, 60)
+    with raises(ValueError) as e_info5:
+        compute_overlap_time(large5, short5)
+    expected5 = "no overlap between two time range"
+    assert e_info5.value.args[0] == expected5

test_times2.py

@@ -0,0 +1,15 @@
+from times import time_range
+from times import compute_overlap_time
+import pytest
+
+large1 = time_range("2010-01-12 10:00:00", "2010-01-12 12:00:00")
+short1 = time_range("2010-01-12 10:30:00", "2010-01-12 10:45:00", 2, 60)
+large3 = time_range("2010-01-12 10:00:00", "2010-01-12 12:00:00")
+short3 = time_range("2010-01-12 11:30:00", "2010-01-12 12:45:00", 2, 60)
+
+large2 = time_range("2010-01-12 10:00:00", "2010-01-12 12:00:00")
+short2 = time_range("2010-01-12 13:30:00", "2010-01-12 13:45:00", 2, 60)
+
+@pytest.mark.parametrize("test_input,expected",[(compute_overlap_time(large1,short1),[('2010-01-12 10:30:00', '2010-01-12 10:37:00'), ('2010-01-12 10:38:00', '2010-01-12 10:45:00')]),(compute_overlap_time(large3, short3),[("2010-01-12 11:30:00", "2010-01-12 12:00:00")])])
+def test_compute_overlap_time(test_input, expected):
+    assert test_input == expected

test_times3.py

@@ -0,0 +1,18 @@
+from times import time_range
+from times import compute_overlap_time
+import pytest
+import yaml
+
+with open('fixture.yml') as ymlfile:
+    yml = yaml.safe_load(ymlfile)
+    fixture = []
+    for i in yml:
+        time_range_1 = eval(i['time_range_1'])
+        time_range_2 = eval(i['time_range_2'])
+        expected = [eval(j) for j in i['expected']]
+        fixture.append((time_range_1,time_range_2,expected))
+
+@pytest.mark.parametrize("time_range_1, time_range_2, expected", fixture)
+def test_compute_overlap_time(time_range_1, time_range_2, expected):
+    result = compute_overlap_time(time_range_1, time_range_2)
+    assert result == expected

times.py

@@ -1,26 +1,43 @@
 import datetime
+import pytest
+from pytest import raises
 
+def value_error_warning(start_time_s, end_time_s):
+    if start_time_s > end_time_s:
+        raise ValueError("Input time is invalid, start time is later than end time!")
 
 def time_range(start_time, end_time, number_of_intervals=1, gap_between_intervals_s=0):
     start_time_s = datetime.datetime.strptime(start_time, "%Y-%m-%d %H:%M:%S")
     end_time_s = datetime.datetime.strptime(end_time, "%Y-%m-%d %H:%M:%S")
+    value_error_warning(start_time_s, end_time_s)
+
     d = (end_time_s - start_time_s).total_seconds() / number_of_intervals + gap_between_intervals_s * (1 / number_of_intervals - 1)
     sec_range = [(start_time_s + datetime.timedelta(seconds=i * d + i * gap_between_intervals_s),
-                  start_time_s + datetime.timedelta(seconds=(i + 1) * d + i * gap_between_intervals_s))
-                 for i in range(number_of_intervals)]
-    return [(ta.strftime("%Y-%m-%d %H:%M:%S"), tb.strftime("%Y-%m-%d %H:%M:%S")) for ta, tb in sec_range]
+                start_time_s + datetime.timedelta(seconds=(i + 1) * d + i * gap_between_intervals_s))
+                for i in range(number_of_intervals)]
 
+    return [(ta.strftime("%Y-%m-%d %H:%M:%S"), tb.strftime("%Y-%m-%d %H:%M:%S")) for ta, tb in sec_range]
 
 def compute_overlap_time(range1, range2):
     overlap_time = []
-    for start1, end1 in range1:
-        for start2, end2 in range2:
-            low = max(start1, start2)
-            high = min(end1, end2)
-            overlap_time.append((low, high))
-    return overlap_time
+    earlist_1 = range1[0][0]
+    latest_1 = range1[-1][1]
+    earlist_2 = range2[0][0]
+    latest_2 = range2[-1][1]
+
+    if latest_1 <= earlist_2 or latest_2 <= earlist_1:
+        raise ValueError("no overlap between two time range")
+    else:
+        for start1, end1 in range1:
+            for start2, end2 in range2:
+                if start2 < end1:
+                    low = max(start1, start2)
+                    high = min(end1, end2)
+                    overlap_time.append((low, high))
+        print(overlap_time)
+        return overlap_time
 
 if __name__ == "__main__":
     large = time_range("2010-01-12 10:00:00", "2010-01-12 12:00:00")
-    short = time_range("2010-01-12 10:30:00", "2010-01-12 10:45:00", 2, 60)
+    short = time_range("2010-01-12 13:30:00", "2010-01-12 13:45:00", 2, 60)
     print(compute_overlap_time(large, short))