Fix to return OK/200 and an empty result set when no data found

RELEASE_NOTES.md

@@ -6,6 +6,8 @@
 
 ### Bug fixes
 
+- Fix to return OK/200 and an empty result set when no data found (#720)
+
 ### Continuous Integration
 
 ### Documentation

src/reporter/delete.py

@@ -21,11 +21,8 @@ def delete_entity(entity_id, type_=None, from_date=None, to_date=None):
 
     logging.getLogger(__name__).info("deleted {} entities".format(deleted))
     if deleted == 0:
-        r = {
-            "error": "Not Found",
-            "description": "No records were found for such query."
-        }
-        return r, 404
+        r = []
+        return r, 200
 
     if deleted > 0:
         return '{} records successfully deleted.'.format(deleted), 204
@@ -53,11 +50,8 @@ def delete_entities(entity_type, from_date=None, to_date=None,
         logging.getLogger(__name__).info(
             "deleted {} entities of type {}".format(deleted, entity_type))
         if deleted == 0:
-            r = {
-                "error": "Not Found",
-                "description": "No records were found for such query."
-            }
-            return r, 404
+            r = []
+            return r, 200
 
         if deleted > 0:
             return '{} records successfully deleted.'.format(deleted), 204

src/reporter/op.py

@@ -70,12 +70,9 @@ def query():
             logging.getLogger(__name__).info("Query processed successfully")
             res.append(entities[0])
         else:
-            r = {
-                "error": "Not Found",
-                "description": "No records were found for such query."
-            }
+            r = []
             logging.getLogger(__name__).info("No value found for query")
-            return r, 404
+            return r, 200
     return res, 200
 
 

src/reporter/query_1T1E1A.py

@@ -93,12 +93,9 @@ def query_1T1E1A(attr_name,   # In Path
         logging.getLogger(__name__).info("Query processed successfully")
         return res
 
-    r = {
-        "error": "Not Found",
-        "description": "No records were found for such query."
-    }
+    r = []
     logging.getLogger(__name__).info("No value found for query")
-    return r, 404
+    return r, 200
 
 
 def query_1T1E1A_value(*args, **kwargs):

src/reporter/query_1T1ENA.py

@@ -109,12 +109,9 @@ def query_1T1ENA(entity_id,   # In Path
             "usage of id and type rather than entityId and entityType from version 0.9")
         return res
 
-    r = {
-        "error": "Not Found",
-        "description": "No records were found for such query."
-    }
+    r = []
     logging.getLogger(__name__).info("No value found for query")
-    return r, 404
+    return r, 200
 
 
 def query_1T1ENA_value(*args, **kwargs):

src/reporter/query_1TNE1A.py

@@ -108,12 +108,9 @@ def query_1TNE1A(attr_name,   # In Path
             "usage of id and type rather than entityId and entityType from version 0.9")
         return res
 
-    r = {
-        "error": "Not Found",
-        "description": "No records were found for such query."
-    }
+    r = []
     logging.getLogger(__name__).info("No value found for query")
-    return r, 404
+    return r, 200
 
 
 def _prepare_response(entities, attr_name, entity_type, entity_ids,

src/reporter/query_1TNENA.py

@@ -111,12 +111,9 @@ def query_1TNENA(entity_type=None,  # In Path
             "usage of id and type rather than entityId and entityType from version 0.9")
         return res
 
-    r = {
-        "error": "Not Found",
-        "description": "No records were found for such query."
-    }
+    r = []
     logging.getLogger(__name__).info("No value found for query")
-    return r, 404
+    return r, 200
 
 
 def _prepare_response(entities, attrs, entity_type, entity_ids,

src/reporter/query_NTNE.py

@@ -62,9 +62,6 @@ def query_NTNE(limit=10000,
         logging.getLogger(__name__).info("Query processed successfully")
         return res
 
-    r = {
-        "error": "Not Found",
-        "description": "No records were found for such query."
-    }
+    r = []
     logging.getLogger(__name__).info("No value found for query")
-    return r, 404
+    return r, 200

src/reporter/query_NTNE1A.py

@@ -146,12 +146,9 @@ def query_NTNE1A(attr_name,  # In Path
         logging.warning(
             "usage of id and type rather than entityId and entityType from version 0.9")
         return res
-    r = {
-        "error": "Not Found",
-        "description": "No records were found for such query."
-    }
+    r = []
     logging.getLogger(__name__).info("No value found for query")
-    return r, 404
+    return r, 200
 
 
 def query_NTNE1A_value(*args, **kwargs):

src/reporter/query_NTNENA.py

@@ -159,12 +159,9 @@ def query_NTNENA(id_=None,  # In Query
         logging.getLogger(__name__).info("AggrMethod cannot be applied")
         return r, 404
 
-    r = {
-        "error": "Not Found",
-        "description": "No records were found for such query."
-    }
+    r = []
     logging.getLogger(__name__).info("No value found for query")
-    return r, 404
+    return r, 200
 
 
 def query_NTNENA_value(*args, **kwargs):

src/reporter/tests/test_1T1E1A.py

@@ -437,11 +437,8 @@ def test_not_found(service):
     h = {'Fiware-Service': service}
 
     r = requests.get(query_url(), params=query_params, headers=h)
-    assert r.status_code == 404, r.text
-    assert r.json() == {
-        "error": "Not Found",
-        "description": "No records were found for such query."
-    }
+    assert r.status_code == 200, r.text
+    assert r.json() == []
 
 
 @pytest.mark.parametrize("service", services)

src/reporter/tests/test_1T1ENA.py

@@ -642,8 +642,5 @@ def test_not_found(service):
     h = {'Fiware-Service': service}
 
     r = requests.get(query_url(), params=query_params, headers=h)
-    assert r.status_code == 404, r.text
-    assert r.json() == {
-        "error": "Not Found",
-        "description": "No records were found for such query."
-    }
+    assert r.status_code == 200, r.text
+    assert r.json() == []

src/reporter/tests/test_1TNE1A.py

@@ -152,11 +152,8 @@ def idPattern_not_found(service):
     h = {'Fiware-Service': service}
 
     r = requests.get(query_url(), params=query_params, headers=h)
-    assert r.status_code == 404, r.text
-    assert r.json() == {
-        "error": "Not Found",
-        "description": "No records were found for such query."
-    }
+    assert r.status_code == 200, r.text
+    assert r.json() == []
 
 
 @pytest.mark.parametrize("service", services)
@@ -281,11 +278,8 @@ def test_not_found(service):
     h = {'Fiware-Service': service}
 
     r = requests.get(query_url(), params=query_params, headers=h)
-    assert r.status_code == 404, r.text
-    assert r.json() == {
-        "error": "Not Found",
-        "description": "No records were found for such query."
-    }
+    assert r.status_code == 200, r.text
+    assert r.json() == []
 
 
 @pytest.mark.parametrize("service", services)

src/reporter/tests/test_1TNENA.py

@@ -159,11 +159,8 @@ def idPattern_not_found(service):
     }
     h = {'Fiware-Service': service}
     r = requests.get(query_url(), params=query_params, headers=h)
-    assert r.status_code == 404, r.text
-    assert r.json() == {
-        "error": "Not Found",
-        "description": "No records were found for such query."
-    }
+    assert r.status_code == 200, r.text
+    assert r.json() == []
 
 
 @pytest.mark.parametrize("service", services)
@@ -319,11 +316,8 @@ def test_not_found(service):
     }
     h = {'Fiware-Service': service}
     r = requests.get(query_url(), params=query_params, headers=h)
-    assert r.status_code == 404, r.text
-    assert r.json() == {
-        "error": "Not Found",
-        "description": "No records were found for such query."
-    }
+    assert r.status_code == 200, r.text
+    assert r.json() == []
 
 
 @pytest.mark.parametrize("service", services)

src/reporter/tests/test_Headers.py

@@ -77,9 +77,8 @@ def test_for_invalid_headers(notification):
     get_url = "{}/entities/Room0".format(QL_URL)
     res_get = requests.get(get_url, headers=HEADERS_INVALID)
 
-    assert res_get.status_code == 404
+    assert res_get.status_code == 200
+    assert res_get.json() == []
 
-    exp_result = {
-        'description': 'No records were found for such query.',
-        'error': 'Not Found'}
+    exp_result = []
     assert res_get.json() == exp_result

src/reporter/tests/test_NTNE.py

@@ -65,11 +65,8 @@ def test_not_found(service):
     }
     h = {'Fiware-Service': service}
     r = requests.get(query_url(), params=query_params, headers=h)
-    assert r.status_code == 404, r.text
-    assert r.json() == {
-        "error": "Not Found",
-        "description": "No records were found for such query."
-    }
+    assert r.status_code == 200, r.text
+    assert r.json() == []
 
 
 @pytest.mark.parametrize("service", services)
@@ -79,11 +76,8 @@ def idpattern_not_found(service):
     }
     h = {'Fiware-Service': service}
     r = requests.get(query_url(), params=query_params, headers=h)
-    assert r.status_code == 404, r.text
-    assert r.json() == {
-        "error": "Not Found",
-        "description": "No records were found for such query."
-    }
+    assert r.status_code == 200, r.text
+    assert r.json() == []
 
 
 @pytest.mark.parametrize("service", services)

src/reporter/tests/test_NTNE1A.py

@@ -113,11 +113,8 @@ def idPattern_not_found(service, reporter_dataset):
     }
     h = {'Fiware-Service': service}
     r = requests.get(query_url(), params=query_params, headers=h)
-    assert r.status_code == 404, r.text
-    assert r.json() == {
-        "error": "Not Found",
-        "description": "No records were found for such query."
-    }
+    assert r.status_code == 200, r.text
+    assert r.json() == []
 
 
 @pytest.mark.parametrize("service", services)
@@ -308,11 +305,8 @@ def test_not_found(service, reporter_dataset):
     }
     h = {'Fiware-Service': service}
     r = requests.get(query_url(), params=query_params, headers=h)
-    assert r.status_code == 404, r.text
-    assert r.json() == {
-        "error": "Not Found",
-        "description": "No records were found for such query."
-    }
+    assert r.status_code == 200, r.text
+    assert r.json() == []
 
 
 @pytest.mark.parametrize("service", services)

src/reporter/tests/test_NTNENA.py

@@ -301,11 +301,8 @@ def idPattern_not_found(service, reporter_dataset):
         'idPattern': 'NotThere'
     }
     r = query(params=query_params, service=service)
-    assert r.status_code == 404, r.text
-    assert r.json() == {
-        "error": "Not Found",
-        "description": "No records were found for such query."
-    }
+    assert r.status_code == 200, r.text
+    assert r.json() == []
 
 
 @pytest.mark.parametrize("service", services)
@@ -985,11 +982,8 @@ def test_not_found(service, reporter_dataset):
         'type': 'NotThere'
     }
     r = query(params=query_params, service=service)
-    assert r.status_code == 404, r.text
-    assert r.json() == {
-        "error": "Not Found",
-        "description": "No records were found for such query."
-    }
+    assert r.status_code == 200, r.text
+    assert r.json() == []
 
 
 @pytest.mark.parametrize("service", services)

src/reporter/tests/test_delete.py

@@ -67,7 +67,8 @@ def test_delete_entity(service):
 
     # Values are gone
     r = requests.get(url, params=params, headers=h)
-    assert r.status_code == 404, r.text
+    assert r.status_code == 200, r.text
+    assert r.json() == []
 
     # But not for other entities of same type
     url = '{}/entities/{}'.format(QL_URL, entity_type + '1')
@@ -111,7 +112,8 @@ def test_delete_entities(service):
     for e in range(2):
         url = '{}/entities/{}'.format(QL_URL, '{}{}'.format(entity_type, e))
         r = requests.get(url, params=params, headers=h)
-        assert r.status_code == 404, r.text
+        assert r.status_code == 200, r.text
+        assert r.json() == []
 
     # But not for entities of other types
     url = '{}/entities/{}'.format(QL_URL, 'Room1')
@@ -136,11 +138,8 @@ def test_not_found(service):
     url = '{}/entities/{}'.format(QL_URL, entity_type + '0')
 
     r = requests.delete(url, params=params, headers=h)
-    assert r.status_code == 404, r.text
-    assert r.json() == {
-        "error": "Not Found",
-        "description": "No records were found for such query."
-    }
+    assert r.status_code == 200, r.text
+    assert r.json() == []
 
 
 @pytest.mark.parametrize("service", [
@@ -281,7 +280,8 @@ def test_delete_347():
     time.sleep(SLEEP_TIME)
     url = '{}/entities/{}'.format(QL_URL, '{}{}'.format(entity_type, 'un3'))
     r = requests.get(url, params=params, headers=h)
-    assert r.status_code == 404, r.text
+    assert r.status_code == 200, r.text
+    assert r.json() == []
 
 
 def test_delete_different_servicepaths():
@@ -366,7 +366,8 @@ def test_delete_different_servicepaths():
     time.sleep(SLEEP_TIME)
     url = '{}/entities/{}'.format(QL_URL, 'un3')
     r = requests.get(url, params=params, headers=h)
-    assert r.status_code == 404, r.text
+    assert r.status_code == 200, r.text
+    assert r.json() == []
 
 
 def test_drop_table():
@@ -448,4 +449,5 @@ def test_drop_table():
     time.sleep(SLEEP_TIME)
     url = '{}/entities/{}'.format(QL_URL, 'un3')
     r = requests.get(url, params=params, headers=h)
-    assert r.status_code == 404, r.text
+    assert r.status_code == 200, r.text
+    assert r.json() == []