add tests

Author: dojutsu-user

tests/test_ui.py

@@ -5,6 +5,7 @@
 import os
 import json
 import time
+from urllib import parse
 
 import pytest
 import sphinx
@@ -571,9 +572,8 @@ def test_enter_button_on_input_field_when_no_result_active(selenium, app, status
         )
         search_outer_input.send_keys('i am searching')
         search_outer_input.send_keys(Keys.ENTER)
-
         WebDriverWait(selenium, 10).until(
-            EC.url_matches(app.outdir / 'search.html')
+            EC.url_contains(app.outdir / 'search.html')
         )
 
         # enter button should redirect the user to search page
@@ -635,3 +635,106 @@ def test_position_search_modal(selenium, app, status, warning):
             assert (
                 abs(actual_y - calculated_y) < 10
             ), f'difference between calculated and actual y coordinate should not be greater than 10 pixels for {"x".join(map(str, window_size))}'
+
+
+@pytest.mark.sphinx(srcdir=TEST_DOCS_SRC)
+def test_writing_query_adds_rtd_search_as_url_param(selenium, app, status, warning):
+    """Test if the `rtd_search` query param is added to the url when user is searching."""
+    app.build()
+    path = app.outdir / 'index.html'
+
+    # to test this, we need to override the $.ajax function
+    ajax_func = '''
+        <script>
+            $.ajax = function(params) {
+                return params.error(
+                    { },
+                    'error',
+                    'Dummy Error.'
+                )
+            }
+        </script>
+    '''
+
+    injected_script = SCRIPT_TAG + ajax_func
+
+    with InjectJsManager(path, injected_script) as _:
+        selenium.get(f'file://{path}')
+        open_search_modal(selenium)
+        query = 'i am searching'
+        query_len = len(query)
+
+        assert (
+            'rtd_search=' not in parse.unquote(selenium.current_url)
+        ), 'rtd_search param must not be present in the url when page loads'
+
+        search_outer_input = selenium.find_element_by_class_name(
+            'search__outer__input'
+        )
+        search_outer_input.send_keys(query)
+        query_param = f'rtd_search={query}'
+
+        assert (
+            query_param in parse.unquote(selenium.current_url)
+        ), 'query param must be present in the url'
+
+        # deleting query from input field
+        for i in range(query_len):
+            search_outer_input.send_keys(Keys.BACK_SPACE)
+
+            if i != query_len -1:
+                
+                current_query = query[:query_len - i - 1]
+                current_url = parse.unquote(selenium.current_url)
+                query_in_url = current_url[current_url.find('rtd_search'):]
+
+                assert (
+                    f'rtd_search={current_query}' == query_in_url
+                )
+
+        assert (
+            'rtd_search=' not in parse.unquote(selenium.current_url)
+        ), 'rtd_search param must not be present in the url if query is empty'
+
+
+@pytest.mark.sphinx(srcdir=TEST_DOCS_SRC)
+def test_modal_open_if_rtd_search_is_present(selenium, app, status, warning):
+    """Test if search modal opens if `rtd_search` query param is present in the URL."""
+    app.build()
+    path = app.outdir / 'index.html'
+
+    # to test this, we need to override the $.ajax function
+    ajax_func = '''
+        <script>
+            $.ajax = function(params) {
+                return params.error(
+                    { },
+                    'error',
+                    'Dummy Error.'
+                )
+            }
+        </script>
+    '''
+
+    injected_script = SCRIPT_TAG + ajax_func
+
+    with InjectJsManager(path, injected_script) as _:
+        selenium.get(f'file://{path}?rtd_search=i am searching')
+        time.sleep(3)  # give time to open modal and start searching
+
+        search_outer_wrapper = selenium.find_element_by_class_name(
+            'search__outer__wrapper'
+        )
+        search_result_box = selenium.find_element_by_class_name(
+            'search__result__box'
+        )
+
+        assert (
+            search_outer_wrapper.is_displayed() is True
+        ), 'search modal should displayed when the page loads'
+        assert (
+            search_result_box.text == 'Error Occurred. Please try again.'
+        ), 'user should be notified that there is error while searching'
+        assert (
+            len(search_result_box.find_elements_by_css_selector('*')) == 0
+        ), 'search result box should not have any child elements because there are no results'