Mock api response (#30)

* Init mock response keyword

* Add mock response

Author: atthaboon

Examples/request-api-demo.robot

@@ -0,0 +1,29 @@
+*** Settings ***
+Library    Dialogs    
+Library    PuppeteerLibrary
+Test Setup    Open browser to test page    
+Test Teardown    Close Browser
+
+
+*** Variables ***
+${HOME_PAGE_URL}    http://127.0.0.1:7272
+
+
+*** Test Cases ***
+Mock response for api request
+    &{response}    Create Dictionary    body=I'm a mock response
+    Mock Current Page Api Response    /ajax_info.json\\?count=3    ${response}        
+    Click Element    id=get_ajax
+    Wait Until Page Contains    I'm a mock response
+    
+Mock response with json response
+    &{response}    Create Dictionary    body={ 'data': 'I\'m a mock response'}    contentType=application/json
+    Mock Current Page Api Response    /ajax_info.json\\?count=3    ${response}        
+    Click Element    id=get_ajax
+    Wait Until Page Contains    I'm a mock response    
+    
+*** Keywords ***
+Open browser to test page
+    ${HEADLESS}     Get variable value    ${HEADLESS}    ${False}
+    &{options} =    create dictionary   headless=${HEADLESS}
+    Open browser    ${HOME_PAGE_URL}   options=${options}

PuppeteerLibrary/__init__.py

@@ -16,12 +16,15 @@
     FormElementKeywordsAsync,
     JavascriptKeywords,
     JavascriptKeywordsAsync,
+    MockResponseKeywords,
+    MockResponseKeywordsAsync,
     ScreenshotKeywords,
     ScreenshotKeywordsAsync,
     UtilityKeywords,
     WaitingKeywords,
     WaitingKeywordsAsync)
 
+
 # Get the version from the _version.py versioneer file. For a git checkout,
 # this is computed based on the number of commits since the last tag.
 from ._version import get_versions
@@ -92,6 +95,7 @@ def __init__(self):
             ElementKeywords(self),
             FormElementKeywords(self),
             JavascriptKeywords(self),
+            MockResponseKeywords(self),
             ScreenshotKeywords(self),
             UtilityKeywords(self),
             WaitingKeywords(self)
@@ -104,6 +108,7 @@ def __init__(self):
             ElementKeywordsAsync(self),
             FormElementKeywordsAsync(self),
             JavascriptKeywordsAsync(self),
+            MockResponseKeywordsAsync(self),
             ScreenshotKeywordsAsync(self),
             WaitingKeywordsAsync(self)
         ]

PuppeteerLibrary/keywords/__init__.py

@@ -8,6 +8,8 @@
 from .formelement_async import FormElementKeywordsAsync
 from .javascript import JavascriptKeywords
 from .javascript_async import JavascriptKeywordsAsync
+from .mockresponse import MockResponseKeywords
+from .mockresponse_async import MockResponseKeywordsAsync
 from .screenshot import ScreenshotKeywords
 from .screenshot_async import ScreenshotKeywordsAsync
 from .utility import UtilityKeywords

PuppeteerLibrary/keywords/mockresponse.py

@@ -0,0 +1,47 @@
+from PuppeteerLibrary.base.robotlibcore import keyword
+from PuppeteerLibrary.base.librarycomponent import LibraryComponent
+from PuppeteerLibrary.keywords.mockresponse_async import MockResponseKeywordsAsync
+
+
+class MockResponseKeywords(LibraryComponent):
+
+    def __init__(self, ctx):
+        super().__init__(ctx)
+        self.async_func = MockResponseKeywordsAsync(self.ctx)
+
+    @keyword
+    def mock_current_page_api_response(self, url, mock_response, method='GET', body=None):
+        """
+        Mock current page api response.
+
+        The ``mock_response`` is a dictionary which can have the following fields:
+        - ``status`` (int): Response status code, defaults to 200.
+        - ``headers`` (dict): Optional response headers.
+        - ``contentType`` (str): If set, equals to setting ``Content-Type`` response header.
+        - ``body`` (str|bytes): Optional response body.
+
+        The ``url`` is request url. url can be partial url match using regexp
+        Match Options:
+
+        | Options            | Url value                                        |
+        | Exact match        | ^http://127.0.0.1:7272/ajax_info.json\\?count=3$ |
+        | Partial match      | /ajax_info.json\\?count=3                        |
+        | Regular expression | .*?/ajax_info.json\\?count=3                     |
+
+        The ``method`` is HTTP Request Methods:
+        - GET (default)
+        - POST
+        - PUT
+        - HEAD
+        - DELETE
+        - PATCH
+
+        The ``body`` is request body message. body can match using regexp
+
+        Example:
+
+        | &{response}                    | Create Dictionary          | body=I'm a mock response |
+        | Mock Current Page Api Response | /ajax_info.json\\?count=3  | ${response}              |
+
+        """
+        return self.loop.run_until_complete(self.async_func.mock_current_page_api_response_async(url, mock_response, method, body))

PuppeteerLibrary/keywords/mockresponse_async.py

@@ -0,0 +1,29 @@
+import asyncio
+import re
+from pyppeteer.network_manager import Request
+from PuppeteerLibrary.base.robotlibcore import keyword
+from PuppeteerLibrary.base.librarycomponent import LibraryComponent
+
+
+class MockResponseKeywordsAsync(LibraryComponent):
+
+    def __init__(self, ctx):
+        self.ctx = ctx
+
+    @keyword
+    async def mock_current_page_api_response_async(self, url, mock_response, method='GET', body=None):
+        page = self.ctx.get_current_page()
+        await page.setRequestInterception(True)
+        page.on('request', lambda request:
+            asyncio.ensure_future(self.mock_api_response(request, url, mock_response, method, body)))
+
+    async def mock_api_response(self, request: Request, url, mock_response, method, body):
+        if re.search(url, request.url) is not None and request.method == method:
+            try:
+                pos_data = (await request.postData())
+            except:
+                pos_data = ''
+            if body is None or re.search(body, pos_data.replace('\n', '')):
+                return await request.respond(mock_response)
+        await request.continue_()
+