Add Enable debug mode (#31)

* Add enable and disable debug mode

* Add disable debug mode

* Add exclude tag when run test

Author: atthaboon

.github/workflows/pythonpackage.yml

@@ -33,4 +33,4 @@ jobs:
         python setup.py install
         pip install -r demoapp/requirements.txt
         python demoapp/server.py &
-        robot -v HEADLESS:True Examples
+        robot -v HEADLESS:True -e Ignore Examples

Examples/quick-start.robot

@@ -20,7 +20,7 @@ Example login form submit
     ...    Click Link    partial link:logout    AND
     ...    Wait For Response Url    http://127.0.0.1:7272/
 
-Control browser example
+Example Control browser
     ${HEADLESS}     Get variable value    ${HEADLESS}    ${False}
     &{options} =    create dictionary   headless=${HEADLESS}
     Open browser    http://127.0.0.1:7272   options=${options}
@@ -30,6 +30,14 @@ Control browser example
     Reload page
     ${header} =    Get Text    css:h1
     Should Be Equal    Login Page    ${header}
+    
+Example Debug mode
+    [Tags]    Ignore
+    Enable Debug Mode
+    Open browser    http://127.0.0.1:7272
+    Input text    id:username_field    demo
+    Input text    id:password_field    mode
+
 
 *** Keywords ***
 Test Teardown

PuppeteerLibrary/__init__.py

@@ -81,6 +81,12 @@ class PuppeteerLibrary(DynamicCore):
     current_context_name = None
     current_page = None
 
+    debug_mode = False
+    debug_mode_options = {
+        'slowMo': 200,
+        'devtools': False
+    }
+
     def __init__(self):
         try:
             self.loop = asyncio.get_event_loop()

PuppeteerLibrary/base/context.py

@@ -15,3 +15,4 @@ def __init__(self, ctx):
             print('Warning: Asyncio not supported')
         self.ctx = ctx
         self.ctx.timeout = 30
+

PuppeteerLibrary/keywords/browsermanagement.py

@@ -41,22 +41,29 @@ async def open_browser_async():
             if self.ctx.browser is None:
                 default_args = []
                 default_options = {
+                    'slowMo': 0,
                     'headless': True,
+                    'devtools': False,
                     'width': 1366,
                     'height': 768
                 }
-                merged_options = None
-                if options is None:
-                    merged_options = default_options
-                else:
-                    merged_options = {**default_options, **options}
+
+                merged_options = default_options
+
+                if options is not None:
+                    merged_options = {**merged_options, **options}
+
+                if self.ctx.debug_mode is True:
+                    merged_options = {**merged_options, **self.ctx.debug_mode_options}
 
                 if 'win' not in sys.platform.lower():
                     default_args = ['--no-sandbox', '--disable-setuid-sandbox']
 
                 self.info(('Open browser to ' + url + '\n' +
                             str(merged_options)))
                 self.ctx.browser = await launch(
+                    slowMo=merged_options['slowMo'],
+                    devtools=merged_options['devtools'],
                     headless=merged_options['headless'],
                     defaultViewport={
                         'width': merged_options['width'],

PuppeteerLibrary/keywords/utility.py

@@ -32,3 +32,35 @@ async def _run_async_keywords(self, iterable):
             return await asyncio.gather(*statements)
         except Exception as err:
             raise Exception(err)
+
+    @keyword
+    def enable_debug_mode(self, slowMo=150, devtools=True):
+        """Enable debug mode.
+
+        The ``slowMo`` argument specifies delay for each test step.
+        The ``devtools`` argument specifies enable devtools or not.
+
+        Example:
+
+        | Enable Debug Mode |                       |      |
+        | Open browser      | http://127.0.0.1:7272 |      |
+        | Input text        | id:username_field     | demo |
+        | Input text        | id:password_field     | mode |
+
+        """
+        self.ctx.debug_mode = True
+        self.ctx.debug_mode_options['headless'] = False
+        self.ctx.debug_mode_options['slowMo'] = slowMo
+        self.ctx.debug_mode_options['devtools'] = devtools
+
+    @keyword
+    def disable_debug_mode(self):
+        """Disable debug mode. This keyword will close all browser and reset debug mode to False.
+        """
+        async def disable_debug_mode_async():
+            await self.ctx.browser.close()
+
+        self.loop.run_until_complete(disable_debug_mode_async())
+        self.ctx.debug_mode = False
+        self.ctx.clear_browser()
+