Bug 1288007 - Allow perf series and data apis to accept date range (#1831)

tests/webapp/api/test_performance_data_api.py

@@ -9,6 +9,11 @@ from treeherder.perf.models import (PerformanceDatum,
                                     PerformanceFramework,
                                     PerformanceSignature)
 
+NOW = datetime.datetime.now()
+ONE_DAY_AGO = NOW - datetime.timedelta(days=1)
+THREE_DAYS_AGO = NOW - datetime.timedelta(days=3)
+SEVEN_DAYS_AGO = NOW - datetime.timedelta(days=7)
+
 
 @pytest.fixture
 def summary_perf_signature(test_perf_signature):
@@ -235,3 +240,95 @@ def test_filter_data_by_framework(webapp, test_repository, test_perf_signature,
     assert len(datums) == 1
     assert datums[0]['job_id'] == 1
     assert datums[0]['signature_id'] == 2
+
+
+def test_filter_signatures_by_interval(webapp, test_repository, test_perf_signature):
+    # interval for the last 24 hours, only one signature exists last updated within that timeframe
+    resp = webapp.get(reverse('performance-signatures-list',
+                              kwargs={
+                                  "project": test_perf_signature.repository.name
+                              }) + '?interval={}'.format(86400))
+    assert resp.status_int == 200
+    assert len(resp.json.keys()) == 1
+    assert resp.json[test_perf_signature.signature_hash]['id'] == 1
+
+
+@pytest.mark.parametrize('start_date, end_date, exp_count, exp_id', [
+    (SEVEN_DAYS_AGO, ONE_DAY_AGO, 1, 1),
+    (THREE_DAYS_AGO, '', 1, 1),
+    (ONE_DAY_AGO, '', 0, 0)])
+def test_filter_signatures_by_range(webapp, test_repository, test_perf_signature,
+                                    start_date, end_date, exp_count, exp_id):
+    # set signature last updated to 3 days ago
+    test_perf_signature.last_updated = THREE_DAYS_AGO
+    test_perf_signature.save()
+
+    resp = webapp.get(reverse('performance-signatures-list',
+                              kwargs={
+                                  "project": test_perf_signature.repository.name
+                              }) + '?start_date={}&end_date={}'.format(start_date, end_date))
+    assert resp.status_int == 200
+    assert len(resp.json.keys()) == exp_count
+    if exp_count != 0:
+        assert resp.json[test_perf_signature.signature_hash]['id'] == exp_id
+
+
+@pytest.mark.parametrize('interval, exp_datums_len, exp_job_ids', [
+    (86400, 1, [0]),
+    (86400 * 3, 2, [1, 0])])
+def test_filter_data_by_interval(webapp, test_repository, test_perf_signature,
+                                 interval, exp_datums_len, exp_job_ids):
+    # create some test data
+    for (i, timestamp) in enumerate([NOW, NOW - datetime.timedelta(days=2), NOW - datetime.timedelta(days=7)]):
+        PerformanceDatum.objects.create(
+            repository=test_perf_signature.repository,
+            job_id=i,
+            result_set_id=i,
+            signature=test_perf_signature,
+            value=i,
+            push_timestamp=timestamp)
+
+    client = APIClient()
+
+    # going back interval of 1 day, should find 1 item
+    resp = client.get(reverse('performance-data-list',
+                              kwargs={"project": test_repository.name}) +
+                      '?signatures={}&interval={}'.format(
+                          test_perf_signature.signature_hash,
+                          interval))
+
+    assert resp.status_code == 200
+    datums = resp.data[test_perf_signature.signature_hash]
+    assert len(datums) == exp_datums_len
+    for x in range(exp_datums_len):
+        assert datums[x]['job_id'] == exp_job_ids[x]
+
+
+@pytest.mark.parametrize('start_date, end_date, exp_datums_len, exp_job_ids', [
+    (SEVEN_DAYS_AGO, THREE_DAYS_AGO, 1, [2]),
+    (THREE_DAYS_AGO, '', 2, [1, 0])])
+def test_filter_data_by_range(webapp, test_repository, test_perf_signature,
+                              start_date, end_date, exp_datums_len, exp_job_ids):
+    # create some test data
+    for (i, timestamp) in enumerate([NOW, NOW - datetime.timedelta(days=2), NOW - datetime.timedelta(days=5)]):
+        PerformanceDatum.objects.create(
+            repository=test_perf_signature.repository,
+            job_id=i,
+            result_set_id=i,
+            signature=test_perf_signature,
+            value=i,
+            push_timestamp=timestamp)
+
+    client = APIClient()
+
+    resp = client.get(reverse('performance-data-list',
+                              kwargs={"project": test_repository.name}) +
+                      '?signatures={}&start_date={}&end_date={}'.format(
+                          test_perf_signature.signature_hash,
+                          start_date, end_date))
+
+    assert resp.status_code == 200
+    datums = resp.data[test_perf_signature.signature_hash]
+    assert len(datums) == exp_datums_len
+    for x in range(exp_datums_len):
+        assert datums[x]['job_id'] == exp_job_ids[x]

treeherder/webapp/api/performance_data.py

@@ -64,11 +64,22 @@ class PerformanceSignatureViewSet(viewsets.ViewSet):
                 framework__in=frameworks)
 
         interval = request.query_params.get('interval')
+        start_date = request.query_params.get('start_date')  # 'YYYY-MM-DDTHH:MM:SS
+        end_date = request.query_params.get('end_date')  # 'YYYY-MM-DDTHH:MM:SS'
+        if interval and (start_date or end_date):
+            return Response({"message": "Provide either interval only -or- start (and end) date"},
+                            status=HTTP_400_BAD_REQUEST)
+
         if interval:
             signature_data = signature_data.filter(
                 last_updated__gte=datetime.datetime.fromtimestamp(
                     int(time.time() - int(interval))))
 
+        if start_date:
+            signature_data = signature_data.filter(last_updated__gte=start_date)
+        if end_date:
+            signature_data = signature_data.filter(last_updated__lte=end_date)
+
         platform = request.query_params.get('platform')
         if platform:
             platforms = models.MachinePlatform.objects.filter(
@@ -179,11 +190,22 @@ class PerformanceDatumViewSet(viewsets.ViewSet):
                 signature__framework__in=frameworks)
 
         interval = request.query_params.get('interval')
+        start_date = request.query_params.get('start_date')  # 'YYYY-MM-DDTHH:MM:SS
+        end_date = request.query_params.get('end_date')  # 'YYYY-MM-DDTHH:MM:SS'
+        if interval and (start_date or end_date):
+            return Response({"message": "Provide either interval only -or- start (and end) date"},
+                            status=HTTP_400_BAD_REQUEST)
+
         if interval:
             datums = datums.filter(
                 push_timestamp__gt=datetime.datetime.fromtimestamp(
                     int(time.time() - int(interval))))
 
+        if start_date:
+            datums = datums.filter(push_timestamp__gt=start_date)
+        if end_date:
+            datums = datums.filter(push_timestamp__lt=end_date)
+
         ret = defaultdict(list)
         values_list = datums.values_list(
             'signature_id', 'signature__signature_hash', 'job_id', 'result_set_id',