Playwright support download file (#73)

* Playwright Add download keywords

* Add demo download file

* Fix download attribute

* Fix demo

Author: atthaboon

Examples/form-handler/download-file.robot

@@ -0,0 +1,23 @@
+*** Settings ***
+Library    PuppeteerLibrary
+Test Setup    Open browser to test page
+Test Teardown    Close All Browser
+Suite Teardown    Close Puppeteer
+
+*** Variables ***
+${DEFAULT_BROWSER}    webkit
+${HOME_PAGE_URL}    http://127.0.0.1:7272/basic-html-elements.html
+
+
+*** Test Cases ***
+Download file
+    [Tags]    Ignore_chrome
+    ${file path} =    Download File    id=download-file
+    Should Not Be Empty    ${file path}    Download file failed
+
+*** Keywords ***
+Open browser to test page
+    ${BROWSER} =     Get variable value    ${BROWSER}    ${DEFAULT_BROWSER}
+    ${HEADLESS}     Get variable value    ${HEADLESS}    ${False}
+    &{options} =    create dictionary   headless=${HEADLESS}
+    Open browser    ${HOME_PAGE_URL}    browser=${BROWSER}   options=${options}

Examples/form-handler/element-properties.robot

@@ -12,7 +12,7 @@ ${HOME_PAGE_URL}    http://127.0.0.1:7272/basic-html-elements.html
 *** Test Cases ***
 Count element
     ${No of h2} =    Get Element Count    css=h2
-    Should Be Equal As Numbers    12    ${No of h2}
+    Should Be Equal As Numbers    13    ${No of h2}
 
 Get element attribute
     ${type value} =   Get Element Attribute    id=alert_confirm    type

PuppeteerLibrary/ikeywords/iformelement_async.py

@@ -11,4 +11,7 @@ async def input_text(self, locator: str, text: str, clear=True):
     @abstractmethod
     async def clear_element_text(self, locator: str):
         pass
-    
+    
+    @abstractmethod
+    async def download_file(self, locator: str):
+        pass

PuppeteerLibrary/keywords/formelement.py

@@ -1,3 +1,4 @@
+import asyncio
 from PuppeteerLibrary.base.robotlibcore import keyword
 from PuppeteerLibrary.base.librarycomponent import LibraryComponent
 from PuppeteerLibrary.ikeywords.iformelement_async import iFormElementAsync
@@ -36,3 +37,6 @@ def clear_element_text(self, locator):
         """
         self.loop.run_until_complete(self.get_async_keyword_group().clear_element_text(locator))
 
+    @keyword
+    def download_file(self, locator):
+        return self.loop.run_until_complete(self.get_async_keyword_group().download_file(locator))

PuppeteerLibrary/playwright/async_keywords/playwright_formelement.py

@@ -1,3 +1,4 @@
+import asyncio
 from PuppeteerLibrary.ikeywords.iformelement_async import iFormElementAsync
 from PuppeteerLibrary.locators.SelectorAbstraction import SelectorAbstraction
 
@@ -15,8 +16,12 @@ async def input_text(self, locator: str, text: str, clear=True):
     async def clear_element_text(self, locator: str):
         await self._clear_input_text(locator)
 
+    async def download_file(self, locator: str):
+        page = self.library_ctx.get_current_page().get_page()
+        tasks = self.library_ctx.get_current_page().click_with_selenium_locator(locator), page.waitForEvent('download')
+        _, b = await asyncio.gather(*tasks)
+        return await b.path()
+
     async def _clear_input_text(self, selenium_locator):
         await self.library_ctx.get_current_page().click_with_selenium_locator(selenium_locator, {'clickCount': 3})
         await self.library_ctx.get_current_page().get_page().keyboard.press('Backspace')
-
-    

PuppeteerLibrary/playwright/playwright_context.py

@@ -38,7 +38,8 @@ async def start_server(self, options: dict=None):
         if self.browser_type == "webkit":
             self.browser = await self.playwright.webkit.launch(headless=False)
         elif self.browser_type == "firefox":
-            self.browser = await self.playwright.firefox.launch(headless=False)
+            self.browser = await self.playwright.firefox.launch(headless=False)    
+        self.browser.acceptDownloads = True
 
     async def stop_server(self):
         await self.playwright.stop()
@@ -50,7 +51,9 @@ def is_server_started(self) -> bool:
         return False
 
     async def create_new_page(self, options: dict=None) -> BasePage:
-        device_options = {}
+        device_options = {
+            'acceptDownloads': True
+        }
         if 'emulate' in options:
             device_options = self.playwright.devices[options['emulate']]
         new_page = await self.browser.newPage(**device_options)

PuppeteerLibrary/puppeteer/async_keywords/puppeteer_formelement.py

@@ -1,4 +1,3 @@
-from robot.libraries.BuiltIn import BuiltIn
 from PuppeteerLibrary.ikeywords.iformelement_async import iFormElementAsync
 
 
@@ -14,6 +13,9 @@ async def input_text(self, locator: str, text: str, clear=True):
 
     async def clear_element_text(self, locator: str):
         await self._clear_input_text(locator)
+
+    async def download_file(self, locator: str):
+        raise Exception("Sorry, keyword: download_file not support.")
 
     async def _clear_input_text(self, selenium_locator):
         await self.library_ctx.get_current_page().click_with_selenium_locator(selenium_locator, {'clickCount': 3})

demoapp/html/basic-html-elements.html

@@ -312,6 +312,17 @@ <h2>Navigate Page</h2>
       <hr>
     </div>
 
+    <div class="container">
+      <div class="row" style="margin-top: 20px;">
+        <h2>Download file</h2>
+      </div>
+      <div class="row" style="margin-top: 20px;">
+        <a id="download-file" href="files/test.csv" download>download</a>
+      </div>
+      <hr>
+    </div>
+
+
     <br>
     <br>
     <br>

demoapp/html/files/test.csv

@@ -0,0 +1 @@
+t1,t2,t3