Support Playwright v15 and trace log (#130)

* Bump playwright from 1.11.1 to 1.15.0

Bumps [playwright](https://github.com/Microsoft/playwright-python) from 1.11.1 to 1.15.0.
- [Release notes](https://github.com/Microsoft/playwright-python/releases)
- [Commits](microsoft/playwright-python@v1.11.1...v1.15.0)

---
updated-dependencies:
- dependency-name: playwright
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>

* Add missing playwright dependencies

* Init support trace file

* Update default browser for chrome

* Update pythonpackage.yml

* Update force tag

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: DESKTOP\atthaboon.s <[email protected]>

Author: atthaboon

.github/workflows/pythonpackage.yml

@@ -12,11 +12,11 @@ jobs:
         # python-version: [3.7, 3.8, 3.9]
         include:
           - python-version: 3.7
-            browser: pwchrome
+            browser: chrome
           - python-version: 3.7
-            browser: webkit
+            browser: ptchrome
           - python-version: 3.8
-            browser: chrome
+            browser: webkit
           - python-version: 3.9
             browser: firefox
 
@@ -73,6 +73,7 @@ jobs:
         pip install -r demoapp/requirements.txt
         pyppeteer-install
         python -m playwright install
+        npx playwright install-deps
         python demoapp/server.py &
     - name: System test
       uses: GabrielBB/xvfb-action@v1

.gitignore

@@ -26,4 +26,6 @@ Examples/logs/
 Examples/tmp-download/test.csv
 Examples;tmp-download/test.csv
 Examples/test.csv
-.venv/
+.venv/
+Examples/trace.zip
+Examples/traces/

Examples/browser-management/tracing.robot

@@ -0,0 +1,33 @@
+*** Settings ***
+Library    PuppeteerLibrary
+Test Teardown    Close All Browser
+Suite Teardown    Close Puppeteer
+
+*** Variables ***
+${DEFAULT_BROWSER}    chrome
+
+
+*** Test Cases ***
+Tracing log without path
+    ${BROWSER} =     Get variable value    ${BROWSER}    ${DEFAULT_BROWSER}
+    Open browser to test page    http://127.0.0.1:7272/login-form-example.html
+    Run Keyword If    '${BROWSER}' != 'ptchrome'    Start tracing    
+    Select Checkbox    id=exampleCheck1
+    Checkbox Should Be Selected    id=exampleCheck1
+    Run Keyword If    '${BROWSER}' != 'ptchrome'    Stop Tracing
+
+Tracing log with specific path
+    ${BROWSER} =     Get variable value    ${BROWSER}    ${DEFAULT_BROWSER}
+    Open browser to test page    http://127.0.0.1:7272/login-form-example.html
+    Run Keyword If    '${BROWSER}' != 'ptchrome'    Start tracing    
+    Select Checkbox    id=exampleCheck1
+    Checkbox Should Be Selected    id=exampleCheck1
+    Run Keyword If    '${BROWSER}' != 'ptchrome'    Stop Tracing    trace2.zip
+
+*** Keywords ***
+Open browser to test page
+    [Arguments]    ${url}
+    ${BROWSER} =     Get variable value    ${BROWSER}    ${DEFAULT_BROWSER}
+    ${HEADLESS}     Get variable value    ${HEADLESS}    ${False}
+    &{options} =    create dictionary   headless=${HEADLESS}
+    Open browser    ${url}    browser=${BROWSER}   options=${options}

Examples/form-handler/checkbox-element.robot

@@ -4,7 +4,7 @@ Test Teardown    Close All Browser
 Suite Teardown    Close Puppeteer
 
 *** Variables ***
-${DEFAULT_BROWSER}    chrome
+${DEFAULT_BROWSER}    pwchrome
 
 
 *** Test Cases ***

Examples/locator/chain-locator.robot

@@ -1,12 +1,12 @@
 *** Settings ***
-Force Tags    Ignore_chrome
+Force Tags    Ignore_ptchrome
 Library    PuppeteerLibrary
 Test Setup    Open browser to test page
 Test Teardown    Close All Browser
 Suite Teardown    Close Puppeteer
 
 *** Variables ***
-${DEFAULT_BROWSER}    pwchrome
+${DEFAULT_BROWSER}    chrome
 ${HOME_PAGE_URL}    http://127.0.0.1:7272/register-form-example.html
 
 

PuppeteerLibrary/ikeywords/ibrowsermanagement_async.py

@@ -28,6 +28,17 @@ async def wait_for_new_window_open(self, timeout=None):
     async def switch_window(self, locator='MAIN'):
         pass
 
+    ##############################
+    # Trace
+    ##############################
+    @abstractmethod
+    async def start_tracing(self):
+        pass
+
+    @abstractmethod
+    async def stop_tracing(self, path=None):
+        pass
+
     ##############################
     # Page
     ##############################

PuppeteerLibrary/keywords/browsermanagement.py

@@ -1,6 +1,7 @@
 from PuppeteerLibrary.base.librarycomponent import LibraryComponent
 from PuppeteerLibrary.base.robotlibcore import keyword
 from PuppeteerLibrary.ikeywords.ibrowsermanagement_async import iBrowserManagementAsync
+from robot.libraries.BuiltIn import BuiltIn
 
 
 class BrowserManagementKeywords(LibraryComponent):
@@ -18,8 +19,9 @@ def open_browser(self, url, browser="chrome", alias=None, options={}):
         The ``browser`` argument specifies which browser to use.
 
         |    = Browser =           |    = Name(s) =   |    = Engine =   |
-        | Google Chrome            | chrome           | Puppeteer       |
+        | Google Chrome Default    | chrome           | Playwright      |
         | Google Chrome Playwright | pwchrome         | Playwright      |
+        | Google Chrome Puppeteer  | ptchrome         | Puppeteer       |
         | Webkit (Safari engine)   | webkit           | Playwright      |
         | Firefox                  | firefox          | Playwright      |
 
@@ -162,6 +164,30 @@ def enable_emulate_mode(self, emulate_name):
         """
         return self.loop.run_until_complete(self.get_async_keyword_group().enable_emulate_mode_async(emulate_name))
 
+    ##############################
+    # Trace
+    ##############################
+    @keyword
+    def start_tracing(self):
+        """Create trace log file
+
+        # View the trace by running following command
+
+        playwright show-trace trace.zip
+        """
+        return self.loop.run_until_complete(self.get_async_keyword_group().start_tracing())
+
+    @keyword
+    def stop_tracing(self, path=None):
+        """Stop trace and generate the trace file.
+
+        Default will be ``traces/<testcasename>.zip``
+        """
+        if path is None:
+            test_name = BuiltIn().get_variable_value("${TEST_NAME}")
+            path = 'traces/'+test_name+'.zip'
+        return self.loop.run_until_complete(self.get_async_keyword_group().stop_tracing(path))
+
     ##############################
     # Page
     ##############################

PuppeteerLibrary/library_context/library_context_factory.py

@@ -7,12 +7,14 @@ class LibraryContextFactory:
     def create(self, browser_type: str) -> iLibraryContext:
         """Return iLibraryContext based on specific browser_type
 
-        Create context based on browser type (chrome, pwchrome, safari, webkit)
+        Create context based on browser type (chrome, pwchrome, ptchrome, safari, webkit)
         """
         if browser_type.lower() == 'chrome':
-            return PuppeteerContext(browser_type)
-        if browser_type.lower() == 'pwchrome':
             return PlaywrightContext(browser_type)
+        elif browser_type.lower() == 'pwchrome':
+            return PlaywrightContext(browser_type)
+        elif browser_type.lower() == 'ptchrome':
+            return PuppeteerContext(browser_type)
         elif browser_type.lower() == 'safari':
             return PlaywrightContext(browser_type)
         elif browser_type.lower() == 'webkit':

PuppeteerLibrary/playwright/async_keywords/playwright_browsermanagement.py

@@ -79,6 +79,17 @@ async def switch_window(self, locator='MAIN'):
             raise Exception('Sorry Switch window support only NEW, MAIN, title and url')
         raise Exception('Can\'t find specify page locator.')
 
+    ##############################
+    # Trace
+    ##############################
+    async def start_tracing(self):
+        await self.library_ctx.start_tracing()
+        
+    async def stop_tracing(self, path=None):
+        if path is None:
+            path = 'trace.zip'
+        await self.library_ctx.stop_tracing(path)
+
     ##############################
     # Page
     ##############################

PuppeteerLibrary/playwright/playwright_context.py

@@ -28,6 +28,7 @@ class PlaywrightContext(iLibraryContext):
 
     playwright: any = None
     browser: any = None
+    current_context: any = None
     current_page: any = None
     current_iframe = None
 
@@ -63,7 +64,7 @@ async def start_server(self, options: dict={}):
         if self.playwright is None:
             self.playwright = await async_playwright().start()
 
-        if self.browser_type == "pwchrome":
+        if self.browser_type == "chrome" or self.browser_type == "pwchrome":
             self.browser = await self.playwright.chromium.launch(
                 headless=merged_options['headless'])
         elif self.browser_type == "webkit":
@@ -73,6 +74,7 @@ async def start_server(self, options: dict={}):
             self.browser = await self.playwright.firefox.launch(
                 headless=merged_options['headless'])
         self.browser.accept_downloads = True
+        # self.current_context = await self.browser.new_context()
 
     async def stop_server(self):
         await self.playwright.stop()
@@ -155,8 +157,17 @@ def get_async_keyword_group(self, keyword_group_name: str):
         }
         return switcher.get(keyword_group_name)
 
+    async def start_tracing(self):
+        if len(self.browser.contexts) > 0:
+            await self.browser.contexts[0].tracing.start(screenshots=True, snapshots=True)
+
+    async def stop_tracing(self, path):
+        if len(self.browser.contexts) > 0:
+            await self.browser.contexts[0].tracing.stop(path=path)
+        
     def _reset_context(self):
         self.browser = None
+        self.current_context = None
         self.current_page = None
         self.current_iframe = None