fix(requests): add warnings for = in url

Author: lucagiove

atests/test_url_warning.robot

@@ -9,15 +9,24 @@ Suite Teardown  Teardown Flask Http Server And Sessions
 
 *** Test Cases ***
 
-Named URL with = symbol should not have warnings
+On Session Named URL with = symbol should not have warnings
    GET On Session  ${GLOBAL_SESSION}  url=/anything?a=a&b=b
 
-Positional URL with = symbol
+On Session Positional URL with = symbol
    Run Keyword And Expect Error   TypeError:*  GET On Session  ${GLOBAL_SESSION}  /anything?a=a&b=b
 
-Positional URL with '' should not have warnings
+On Session Positional URL with '' should not have warnings
    GET On Session  ${GLOBAL_SESSION}  ${Empty}
 
-Positional URL with None should not have warnings
+On Session Positional URL with None should not have warnings
    GET On Session  ${GLOBAL_SESSION}  ${None}
 
+Session Less Named URL with = symbol should not have warnings
+   GET  url=${HTTP_LOCAL_SERVER}/anything?a=a&b=b
+
+Session Less Positional URL with = symbol
+   Run Keyword And Expect Error   TypeError:*  GET  ${HTTP_LOCAL_SERVER}/anything?a=a&b=b
+
+Session Less Positional URL with '' should not have warnings
+   GET  ${HTTP_LOCAL_SERVER}/${Empty}
+

src/RequestsLibrary/RequestsKeywords.py

@@ -3,9 +3,9 @@
 from robot.api.deco import keyword
 from robot.libraries.BuiltIn import BuiltIn
 
+from RequestsLibrary import log
 from RequestsLibrary.compat import urljoin
-from RequestsLibrary import utils, log
-from RequestsLibrary.utils import is_file_descriptor
+from RequestsLibrary.utils import is_file_descriptor, warn_if_equal_symbol_in_url_session_less
 
 
 class RequestsKeywords(object):
@@ -54,7 +54,6 @@ def _common_request(
 
         return resp
 
-
     @staticmethod
     def _merge_url(session, uri):
         """
@@ -152,6 +151,7 @@ def get_file_for_streaming_upload(path):
         return open(path, 'rb')
 
     @keyword('GET')
+    @warn_if_equal_symbol_in_url_session_less
     def session_less_get(self, url, params=None,
                          expected_status=None, msg=None, **kwargs):
         """
@@ -193,6 +193,7 @@ def session_less_get(self, url, params=None,
         return response
 
     @keyword('POST')
+    @warn_if_equal_symbol_in_url_session_less
     def session_less_post(self, url, data=None, json=None,
                           expected_status=None, msg=None, **kwargs):
         """
@@ -219,6 +220,7 @@ def session_less_post(self, url, data=None, json=None,
         return response
 
     @keyword('PUT')
+    @warn_if_equal_symbol_in_url_session_less
     def session_less_put(self, url, data=None, json=None,
                          expected_status=None, msg=None, **kwargs):
         """
@@ -246,6 +248,7 @@ def session_less_put(self, url, data=None, json=None,
         return response
 
     @keyword('HEAD')
+    @warn_if_equal_symbol_in_url_session_less
     def session_less_head(self, url,
                           expected_status=None, msg=None, **kwargs):
         """
@@ -270,6 +273,7 @@ def session_less_head(self, url,
         return response
 
     @keyword('PATCH')
+    @warn_if_equal_symbol_in_url_session_less
     def session_less_patch(self, url, data=None, json=None,
                            expected_status=None, msg=None, **kwargs):
         """
@@ -296,6 +300,7 @@ def session_less_patch(self, url, data=None, json=None,
         return response
 
     @keyword('DELETE')
+    @warn_if_equal_symbol_in_url_session_less
     def session_less_delete(self, url,
                             expected_status=None, msg=None, **kwargs):
         """
@@ -317,6 +322,7 @@ def session_less_delete(self, url,
         return response
 
     @keyword('OPTIONS')
+    @warn_if_equal_symbol_in_url_session_less
     def session_less_options(self, url,
                              expected_status=None, msg=None, **kwargs):
         """

src/RequestsLibrary/RequestsOnSessionKeywords.py

@@ -1,13 +1,13 @@
 from robot.api.deco import keyword
 
-from RequestsLibrary.utils import warn_if_equal_symbol_in_url
+from RequestsLibrary.utils import warn_if_equal_symbol_in_url_on_session
 from .SessionKeywords import SessionKeywords
 
 
 class RequestsOnSessionKeywords(SessionKeywords):
 
-    @warn_if_equal_symbol_in_url
     @keyword("GET On Session")
+    @warn_if_equal_symbol_in_url_on_session
     def get_on_session(self, alias, url, params=None,
                        expected_status=None, msg=None, **kwargs):
         """
@@ -33,8 +33,8 @@ def get_on_session(self, alias, url, params=None,
         self._check_status(expected_status, response, msg)
         return response
 
-    @warn_if_equal_symbol_in_url
     @keyword("POST On Session")
+    @warn_if_equal_symbol_in_url_on_session
     def post_on_session(self, alias, url, data=None, json=None,
                         expected_status=None, msg=None, **kwargs):
         """
@@ -62,8 +62,8 @@ def post_on_session(self, alias, url, data=None, json=None,
         self._check_status(expected_status, response, msg)
         return response
 
-    @warn_if_equal_symbol_in_url
     @keyword("PATCH On Session")
+    @warn_if_equal_symbol_in_url_on_session
     def patch_on_session(self, alias, url, data=None, json=None,
                          expected_status=None, msg=None, **kwargs):
         """
@@ -91,8 +91,8 @@ def patch_on_session(self, alias, url, data=None, json=None,
         self._check_status(expected_status, response, msg)
         return response
 
-    @warn_if_equal_symbol_in_url
     @keyword("PUT On Session")
+    @warn_if_equal_symbol_in_url_on_session
     def put_on_session(self, alias, url, data=None, json=None,
                        expected_status=None, msg=None, **kwargs):
         """
@@ -120,8 +120,8 @@ def put_on_session(self, alias, url, data=None, json=None,
         self._check_status(expected_status, response, msg)
         return response
 
-    @warn_if_equal_symbol_in_url
     @keyword('DELETE On Session')
+    @warn_if_equal_symbol_in_url_on_session
     def delete_on_session(self, alias, url,
                           expected_status=None, msg=None, **kwargs):
         """
@@ -144,8 +144,8 @@ def delete_on_session(self, alias, url,
         self._check_status(expected_status, response, msg)
         return response
 
-    @warn_if_equal_symbol_in_url
     @keyword("HEAD On Session")
+    @warn_if_equal_symbol_in_url_on_session
     def head_on_session(self, alias, url,
                         expected_status=None, msg=None, **kwargs):
         """
@@ -171,8 +171,8 @@ def head_on_session(self, alias, url,
         self._check_status(expected_status, response, msg)
         return response
 
-    @warn_if_equal_symbol_in_url
     @keyword("OPTIONS On Session")
+    @warn_if_equal_symbol_in_url_on_session
     def options_on_session(self, alias, url,
                            expected_status=None, msg=None, **kwargs):
         """

src/RequestsLibrary/utils.py

@@ -125,16 +125,32 @@ def format_data_according_to_header(session, data, headers):
     return data
 
 
-def warn_if_equal_symbol_in_url(func):
+def _log_url_warning_if_url_not_in_kwargs(kwargs):
+    if 'url' not in kwargs:
+        logger.warn("You might have an = symbol in url."
+                    " You better place 'url=' before, example: 'url=/your-url/foo?param=a'"
+                    " or use '/your-url/foo  params=param=a' or escape it")
+
+
+def warn_if_equal_symbol_in_url_session_less(func):
     def decorator(*args, **kwargs):
         try:
-            args[2]
+            args[1]
         except IndexError:
-            if 'url' not in kwargs:
-                logger.warn("You might have an = symbol in url."
-                            " You better place 'url=' before, example: 'url=/your-url/foo?param=a'"
-                            " or use '/your-url/foo  params=param=a' or escape it")
+            _log_url_warning_if_url_not_in_kwargs(kwargs)
+        return func(*args, **kwargs)
 
+    decorator.__name__ = func.__name__
+    decorator.__doc__ = func.__doc__
+    return decorator
+
+
+def warn_if_equal_symbol_in_url_on_session(func):
+    def decorator(*args, **kwargs):
+        try:
+            args[2]
+        except IndexError:
+            _log_url_warning_if_url_not_in_kwargs(kwargs)
         return func(*args, **kwargs)
     decorator.__name__ = func.__name__
     decorator.__doc__ = func.__doc__