Reuse authentication state (#144)

* Init state storage support

* Add support delete storage

* Archive test report

* Update test steps

Co-authored-by: DESKTOP\atthaboon.s <[email protected]>

Author: atthaboon

.github/workflows/pythonpackage.yml

@@ -79,4 +79,11 @@ jobs:
       uses: GabrielBB/xvfb-action@v1
       with:
         working-directory: ./ #optional
-        run: robot -v BROWSER:${{ matrix.browser }} -e IgnoreORIgnore_${{ matrix.browser }} Examples
+        run: robot --outputdir test-report -v BROWSER:${{ matrix.browser }} -e IgnoreORIgnore_${{ matrix.browser }} Examples
+    - name: Upload a test report
+      if: always()
+      uses: actions/[email protected]
+      with:
+        # Artifact name
+        name: test-report
+        path: test-report

.gitignore

@@ -29,3 +29,6 @@ Examples/test.csv
 .venv/
 Examples/trace.zip
 Examples/traces/
+Examples/state-admin.json
+Examples/test-report/
+test-report/

Examples/browser-management/handle-state.robot

@@ -0,0 +1,44 @@
+*** Settings ***
+Library    PuppeteerLibrary
+Test Setup    Open browser to test page    
+Test Teardown    Close All Browser
+Suite Teardown    Close Puppeteer
+
+
+*** Variables ***
+${DEFAULT_BROWSER}    chrome
+${HOME_PAGE_URL}    https://demoqa.com/login
+${PROFILE_PAGE_URL}    https://demoqa.com/profile
+${USERNAME}    qahive
+${PASSWORD}    Welcome1!
+
+
+*** Test Cases ***
+Save and Reuse browser authen state into json file
+    [Tags]    Ignore_ptchrome
+    Input Text    id=userName    ${USERNAME}
+    Input Password    id=password    ${PASSWORD}
+    Click Element    id=login
+    Wait Until Page Contains Element    id=userName-value
+    Wait Until Page Contains    ${USERNAME}    
+    Save Browser Storage State    admin
+    Close All Browser
+    ############################################################
+    # Reopen and bypass login by using state ref
+    ############################################################
+    ${BROWSER} =     Get variable value    ${BROWSER}     ${DEFAULT_BROWSER}
+    ${HEADLESS}     Get variable value    ${HEADLESS}    ${False}
+    &{options} =    create dictionary   headless=${HEADLESS}    state_ref=admin
+    Open browser    ${PROFILE_PAGE_URL}   browser=${BROWSER}    options=${options}
+    Wait Until Page Contains    ${USERNAME}
+    Delete Browser Storage State    admin
+    Delete All Browser Storage States
+
+*** 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}
+    Set Screenshot Directory    test-report
+    Capture Page Screenshot        

PuppeteerLibrary/ikeywords/ibrowsermanagement_async.py

@@ -71,3 +71,9 @@ async def add_cookie(self, name: str, value: str):
 
     async def delete_all_cookies(self):
         pass
+    
+    ##############################
+    # State
+    ##############################
+    async def save_browser_storage_state(self, state_folder: str, ref='user'):
+        pass

PuppeteerLibrary/keywords/browsermanagement.py

@@ -1,3 +1,5 @@
+import os
+import shutil
 from PuppeteerLibrary.base.librarycomponent import LibraryComponent
 from PuppeteerLibrary.base.robotlibcore import keyword
 from PuppeteerLibrary.ikeywords.ibrowsermanagement_async import iBrowserManagementAsync
@@ -8,6 +10,7 @@ class BrowserManagementKeywords(LibraryComponent):
 
     def __init__(self, ctx):
         super().__init__(ctx)
+        self.STATES_FOLDER = './states'
 
     def get_async_keyword_group(self) -> iBrowserManagementAsync:
         return self.ctx.get_current_library_context().get_async_keyword_group(type(self).__name__)
@@ -32,6 +35,7 @@ def open_browser(self, url, browser="chrome", alias=None, options={}):
         | width              | default 1366           |
         | height             | default 768            |
         | emulate            | iPhone 11              |
+        | state_ref          | State Reference        |
 
         **Other options**
         pwchrome, webkit and firefox please visit: https://playwright.dev/python/docs/api/class-browser?_highlight=new_page#browsernew_pagekwargs
@@ -234,3 +238,47 @@ def delete_all_cookies(self):
         """ Deletes all cookies.
         """
         return self.loop.run_until_complete(self.get_async_keyword_group().delete_all_cookies())
+
+    ##############################
+    # State
+    ##############################
+    @keyword
+    def save_browser_storage_state(self, ref='user'):
+        """ Save browser storage state that can resue Authentication state
+
+            *ref* : reference state name
+
+            *Limitation* only support Playwright browser
+        """
+        self.info('Save storate state for ' + ref)
+        try:
+            os.mkdir(self.STATES_FOLDER)
+        except:
+            self.info('states folder already exists.')
+        return self.loop.run_until_complete(self.get_async_keyword_group().save_browser_storage_state(self.STATES_FOLDER, ref))
+
+    @keyword
+    def delete_browser_storage_state(self, ref):
+        """ Delete browser storage state
+
+            *ref* : reference state name
+
+            *Limitation* only support Playwright browser
+        """
+        file_path = self.STATES_FOLDER +'/state-'+ ref + '.json'
+        if os.path.exists(file_path):
+            os.remove(file_path)
+        else:
+            self.warn('Can not delete the storate '+ref+' as it doesn\'t exists')
+
+    @keyword
+    def delete_all_browser_storage_states(self):
+        """ Delete all browser storage state
+
+            *Limitation* only support Playwright browser
+        """
+        try:
+            shutil.rmtree(self.STATES_FOLDER)
+        except OSError as e:
+            self.warn("Error: %s - %s." % (e.filename, e.strerror))
+

PuppeteerLibrary/playwright/async_keywords/playwright_browsermanagement.py

@@ -137,3 +137,10 @@ async def add_cookie(self, name: str, value: str):
 
     async def delete_all_cookies(self):
         await self.library_ctx.get_browser_context().contexts[0].clear_cookies()
+
+    ##############################
+    # State
+    ##############################
+    async def save_browser_storage_state(self, state_folder, ref='user'):
+        storage  = await self.library_ctx.get_browser_context().contexts[0].storage_state(path=state_folder+"/state-"+ ref +".json")
+        return storage

PuppeteerLibrary/playwright/playwright_context.py

@@ -113,6 +113,9 @@ async def create_new_page(self, options: dict={}) -> BasePage:
         if 'emulate' in options:
             device_options = self.playwright.devices[options['emulate']]
 
+        if 'state_ref' in options:
+            device_options['storage_state'] = './states/state-'+ options['state_ref'] + '.json'
+
         new_page = await self.browser.new_page(**device_options)
         self.current_page = PlaywrightPage(new_page)
         return self.current_page

PuppeteerLibrary/puppeteer/async_keywords/puppeteer_browsermanagement.py

@@ -144,3 +144,9 @@ async def delete_all_cookies(self):
         cookies = await self.library_ctx.get_current_page().get_page().cookies()
         for cookie in cookies:
             await self.library_ctx.get_current_page().get_page().deleteCookie(cookie)
+
+    ##############################
+    # State
+    ##############################
+    async def save_browser_storage_state(self, state_folder, ref='user'):
+        raise Exception('Not support for puppeteer browser')