Merge pull request #35 from chavarera/main

#32 Resolved

Author: chavarera

README.md

@@ -22,16 +22,18 @@
 - WebDriver
   - Manage multiple web drivers such as chrome,chromium,firefox.
 - Different Utilities
-  - Retrieve element with 5 different attribute.
-  - Perform clicks on element
-  - Take full page and element screenshot.
+  - Retrieve elements with 5 different attributes.
+  - Perform clicks on element,
+  - Take a full page and element screenshot.
   - Hide and show elements.
   - Information filling on different form elements such as text,radio,checkbox.
-  - Retrieves current cookies from browser.
-  - Retrieve url and web page source
+  - Retrieves current cookies from the browser.
+  - Retrieve url and web page source.
+  - Add or modify existing cookies.
+  - Check Existence of an element on the page.
 - Element Parser
-  - table Information
-  - Retrieve dropdown options in dictionary
+  - table Information.
+  - Retrieve dropdown options in the dictionary.
 
 ## How To Use
 
@@ -74,19 +76,19 @@ from s_tool.driver import SeleniumDriver
 
 
 class SBot(SeleniumDriver):
-    """Example Bot using s-tool"""
+   """Example Bot using s-tool"""
 
-    def __init__(self, *args, **kwargs):
-        super().__init__(*args, **kwargs)
+   def __init__(self, *args, **kwargs):
+       super().__init__(*args, **kwargs)
 
-    def run(self):
-        self.get("https://google.com")
-        sessionid = self.session()
-        url = self.url()
-        cookies = self.cookies()
+   def run(self):
+       self.get("https://google.com")
+       sessionid = self.session()
+       url = self.url()
+       cookies = self.cookies()
 
-        # print sessionid,url,cookies
-        print(f"\nurl     :   {url} \nsession :   {sessionid}\ncookies :   {cookies}\n")
+       # print sessionid,url,cookies
+       print(f"\n url     :   {url} \n session :   {sessionid}\n cookies :   {cookies}\n")
 
 
 bot = SBot("firefox", headless=True)  # change headless=False to run with gui mode
@@ -103,13 +105,13 @@ bot.close()
 from s_tool.driver import SeleniumDriver as SBot
 
 with SBot("firefox", headless=True) as obj:
-    obj.get("https://google.com")
-    sessionid = obj.session()
-    url = obj.url()
-    cookies = obj.cookies()
+   obj.get("https://google.com")
+   sessionid = obj.session()
+   url = obj.url()
+   cookies = obj.cookies()
 
-    # print sessionid,url,cookies
-    print(f"\nurl     :   {url} \nsession :   {sessionid}\ncookies :   {cookies}\n")
+   # print sessionid,url,cookies
+   print(f"\n url     :   {url} \n session :   {sessionid}\n cookies :   {cookies}\n")
 
 ```
 
@@ -118,7 +120,7 @@ with SBot("firefox", headless=True) as obj:
 - Web driver utilities
   - Scrolling element and page.
   - Handling popup and alert boxes.
-  - Switching windows,frame,tabs,iframes.
+  - Switching windows,frames,tabs,iframes.
   - logger.
 - Element Parser
   - list

s_tool/driver.py

@@ -16,6 +16,7 @@
     hide_show_elements,
     is_element,
     page_source,
+    set_cookies,
     take_screenshot,
     visit,
 )
@@ -94,6 +95,7 @@ def _load_methods(self):
         self.hide = partial(hide_show_elements, self.driver)
         self.fill = partial(fill, self.driver)
         self.is_element = partial(is_element, self.driver)
+        self.set_cookies = partial(set_cookies, self.driver)
 
 
 if __name__ == "__main__":

s_tool/utils.py

@@ -122,6 +122,44 @@ def get_cookies(driver: webdriver) -> dict:
     return cookies_dict or {}
 
 
+def set_cookies(
+    driver: webdriver,
+    drop_all: bool = False,
+    drop_keys: set = set(),
+    **cookies,
+) -> None:
+    """Set cookies into webdriver instance
+
+    Args:
+        driver    : selenium webdriver.
+        drop_all  : default False, set it to True to delete all cookies.
+        drop_keys : a set of cookie keys to delete from the browser.
+        **cookies : variable length of cookies.
+
+    Returns:
+        None
+
+    Usage:
+        set_cookies(driver,name="s-tool",version=1)
+        set_cookies(driver,drop_all=True,name="s-tool",version=1)
+        set_cookies(driver,**{'name':"s-tool","version":1}
+    """
+    # cookies name and value must be in string
+    cookies = {str(k): str(v) for k, v in cookies.items()}
+
+    # Delete all cookies
+    if drop_all:
+        driver.delete_all_cookies()
+
+    # Delete only given cookies Name
+    for name in drop_keys:
+        driver.delete_cookie(name)
+
+    # Add new cookies
+    for name, value in cookies.items():
+        driver.add_cookie({"name": name, "value": value})
+
+
 def take_screenshot(driver: webdriver, element: tuple = None) -> Union[bytes, None]:
     """take screenshot of given element if element is
     not given take a full page screeenshot and return

tests/test_driver.py

@@ -0,0 +1,41 @@
+from s_tool.driver import SeleniumDriver
+
+from . import TEST_URL
+
+
+def test_cookies():
+    with SeleniumDriver("firefox", headless=True) as obj:
+        obj.get("https://www.google.com/")
+
+        # Validate cookies type
+        assert type(obj.cookies()) is dict
+
+        # Drop all cookies
+        obj.set_cookies(drop_all=True)
+        assert obj.cookies() == {}
+
+        # Set new cookies
+
+        obj.set_cookies(name="s-tool", version="1.0")
+        cookies = obj.cookies()
+        assert cookies.get("name") == "s-tool"
+
+        # Drop cookie by name
+        obj.set_cookies(drop_keys={"version"})
+        cookies = obj.cookies()
+        assert cookies.get("version", 1) == 1
+
+
+def test_base():
+    with SeleniumDriver("firefox", headless=True) as obj:
+        URL = "https://www.google.com/"
+        obj.get(URL)
+
+        # session
+        assert type(obj.session()) is str
+
+        # current_url
+        assert URL in obj.url()
+
+        # page_source
+        assert len(obj.text()) > 100