Writing a test for times.py #18

.github/workflows/python-tests.yml

@@ -0,0 +1,26 @@
+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
+          pip install pytest
+      - name: Test with pytest
+        run: |
+          pytest

fixture.yaml

@@ -0,0 +1,9 @@
+- 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')
+
+- 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 12:30:00", "2010-01-12 12:45:00")
+  expected: []

test_times.py

@@ -0,0 +1,84 @@
+from times import time_range,compute_overlap_time
+import pytest
+
+
+'''
+def test_given_input(): 
+
+    large = time_range("2010-01-12 10:00:00", "2010-01-12 9:00:00")
+    short = time_range("2010-01-12 10:30:00", "2010-01-12 10:45:00", 2, 60)
+    print(compute_overlap_time(large, short))
+
+    result = []
+    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 that do not overlap
+    large = time_range("2010-01-12 11:00:00", "2010-01-12 12:00:00")
+    short = time_range("2010-01-12 10:30:00", "2010-01-12 10:45:00")
+    print(compute_overlap_time(large, short))
+
+    result1 = []
+    result1 = compute_overlap_time(large, short)
+    expected1  = []
+    assert result1 == expected1
+
+
+
+    #two time ranges that both contain several intervals each
+    large = time_range("2010-01-12 10:00:00", "2010-01-12 12:00:00", 2, 60)
+    short = time_range("2010-01-12 10:30:00", "2010-01-12 10:45:00", 2, 60)
+    print(compute_overlap_time(large, short))
+
+    result2 = []
+    result2 = compute_overlap_time(large, short)
+    expected2  = [('2010-01-12 10:30:00', '2010-01-12 10:37:00'), ('2010-01-12 10:38:00', '2010-01-12 10:40:00')]
+    assert result2 == expected2
+
+
+
+    #two time ranges that end exactly at the same time when the other starts
+    large = time_range("2010-01-12 10:00:00", "2010-01-12 10:30:00")
+    short = time_range("2010-01-12 10:30:00", "2010-01-12 10:45:00", 2, 60)
+    print(compute_overlap_time(large, short))
+
+    result3 = []
+    result3 = compute_overlap_time(large, short)
+    expected3  = []
+    assert result3 == expected3
+''' 
+'''
+large1 = time_range("2010-01-12 10:00:00", "2010-01-12 11:00:00")
+short1 = time_range("2010-01-12 10:30:00", "2010-01-12 10:45:00", 2, 60)
+short2 = time_range("2010-01-12 10:30:00", "2010-01-12 10:45:00")
+
+@pytest.mark.parametrize(
+    "time_range_1,time_range_2,expected",
+    [(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')]), 
+    (large1,short2, [('2010-01-12 10:30:00', '2010-01-12 10:45:00')])],
+)
+
+def test_eval(time_range_1,time_range_2, expected):
+    assert compute_overlap_time(time_range_1,time_range_2) == expected
+'''
+
+import yaml
+
+file=open('./fixture.yaml')
+data=yaml.load(file,Loader=yaml.FullLoader)
+
+fixture = []
+for i in data:
+    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_eval(time_range_1,time_range_2,expected):
+    assert compute_overlap_time(time_range_1,time_range_2) == expected

times.py

@@ -1,16 +1,25 @@
 import datetime
+import pytest
+import yaml
 
+pytest.raises
 
 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")
+
+    #if end_time_s < start_time_s:
+        #raise ValueError("time range {},{} is invalid.".format(start_time,end_time))
+
+    if end_time_s<start_time_s:
+        raise ValueError("time range {},{} is invalid.".format(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]
 
-
 def compute_overlap_time(range1, range2):
     overlap_time = []
     for start1, end1 in range1:
@@ -20,7 +29,21 @@ def compute_overlap_time(range1, range2):
             overlap_time.append((low, high))
     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)
-    print(compute_overlap_time(large, short))
+'''
+large = time_range("2010-01-12 11:00:00", "2010-01-12 12:00:00")
+short = time_range("2010-01-12 10:30:00", "2010-01-12 10:45:00")
+print(compute_overlap_time(large, short))
+'''
+'''
+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)
+print(large,short)
+'''
+
+file=open('./fixture.yaml')
+data=yaml.load(file,Loader=yaml.FullLoader)
+time_range_1 = []
+for i in range(len(data)):
+    time_range_1.append(data[i]['time_range_1'])
+
+print(time_range_1)