Add test coverage for search hints

Author: OneBlue

events/__init__.py

@@ -16,7 +16,7 @@
 from .errors import *
 from .subscribe import send_event_email, subscribe_to_event, validate_email
 from .access import validate_token, generate_access_url
-from .utils import get_event_component, increase_event_seq_number, get_event_components
+from .utils import get_event_component, increase_event_seq_number, get_event_components, expect_type
 from datetime import datetime, date, timedelta
 from tzlocal import get_localzone
 from flask_wtf.csrf import CSRFProtect
@@ -414,11 +414,22 @@ def search_api(collection):
     if body is None:
         raise HTTPException(400, 'Invalid request: empty body')
 
-    search_term = body.get('pattern', '').strip()
+    search_term = body.get('pattern', '')
+    expect_type(search_term, [str], 'pattern')
+
+    search_term = search_term.strip()
+
     before = body.get('before', inf)
+    expect_type(before, [int, float], 'before', allow_none=True)
+
     after = body.get('after', 0)
+    expect_type(after, [int, float], 'after', allow_none=True)
+
     exact = body.get('exact', False)
+    expect_type(exact, [bool], 'exact')
+
     hint = body.get('hint', None)
+    expect_type(hint, [str], 'hint', allow_none=True)
 
     matched_collection = get_collection(collection)
 

events/test_events.py

@@ -146,6 +146,13 @@
 
 redirect_map = {'redirect-uid': 'event_5.ics', 'redirect-uid-14': 'event_14.ics'}
 
+uid_only_event = Event()
+uid_only_event.add('dtstart', date(2012, 10, 10))
+uid_only_event['summary'] = 'uid_only_title'
+uid_only_event.add('dtend', datetime(2012, 10, 10, 10, 0, 0))
+uid_only_event['uid'] = 'uid_only'
+
+
 
 save_event_override = None
 
@@ -178,7 +185,10 @@ def lookup_event_by_uid(self, uid: str):
             raise NotFoundException(f'event with UID: {uid} not found')
 
     def get_event_impl(self, name: str):
-        event = self.content.get(remove_ics(name))
+        if name == 'uid_only':
+            event = uid_only_event # To test that event are looked up by UID and not via the entire collection
+        else:
+            event = self.content.get(remove_ics(name))
 
         if not event:
             return None
@@ -300,7 +310,7 @@ def test_search_api_without_admin(client):
     assert response.status_code == 404
 
 
-def search_api(client, pattern: str, before: int = None, after: int = None, exact: bool = None) -> list:
+def search_api(client, pattern: str, before: int = None, after: int = None, exact: bool = None, hint: str = None) -> list:
     body = {'pattern': pattern}
 
     if before is not None:
@@ -312,6 +322,9 @@ def search_api(client, pattern: str, before: int = None, after: int = None, exac
     if exact is not None:
         body['exact'] = exact
 
+    if hint is not None:
+        body['hint'] = hint
+
     response = client.post(f'api/1/search', data=json.dumps(body), headers={'X-Admin': 'true', 'Content-Type': 'application/json'})
     assert response.status_code == 200
 
@@ -411,7 +424,28 @@ def test_search_rrule_occurence(client):
     content = search_api(client, "yearly_repeating_event", before=before, after=after)
     assert [e['title'] for e in content] == ['yearly_repeating_event']
 
+def test_search_api_hint_match(client):
+    content = search_api(client, "uid_only", hint='uid_only')
+    assert [e['title'] for e in content] == ['uid_only_title']
+
+def test_search_api_hint_no_match(client):
+    content = search_api(client, "event_12", hint='uid_only')
+    assert [e['title'] for e in content] == ['event_12']
+
+def test_search_api_test_bad_types(client):
+    def expect(body):
+        response = client.post(f'api/1/search', data=json.dumps(body), headers={'X-Admin': 'true', 'Content-Type': 'application/json'})
+        assert response.status_code == 404
+
+    expect({'pattern': None})
+    expect({'pattern': 12})
+    expect({'pattern': '12', 'hint': 12})
+    expect({'pattern': '12', 'hint': 12})
 
+    expect({'pattern': '12', 'after': 'True'})
+    expect({'pattern': '12', 'before': 'foo'})
+    expect({'pattern': '12', 'exact': 'yes'})
+    expect({'pattern': '12', 'exact': None})
 
 def test_view_event_admin(client):
     response = client.get('/1/event_1.ics', headers={'X-Admin': 'true'})

events/utils.py

@@ -1,3 +1,5 @@
+from .errors import SuspiciousRequest
+
 def get_event_components(event) -> list:
     if 'summary' in event:
         return [event]
@@ -25,3 +27,10 @@ def increase_event_seq_number(event):
 
     component['sequence'] = sequence
     return event
+
+def expect_type(value, types, name: str, allow_none=False):
+    if value is None and allow_none:
+        return
+
+    if not any(isinstance(value, e) for e in types):
+        raise SuspiciousRequest(f"Unexpected type for '{name}': {type(value).__name__}")