Add print pdf keyword (#35)

* init pdf keyword

* Init default pdf path

* Add support pdf keywords and docs

* Update screenshot example keywords

Author: atthaboon

.gitignore

@@ -21,3 +21,4 @@ example.png
 log.html
 report.html
 /Examples/*.png
+*.pdf

Examples/generate-pdf-demo.robot

@@ -0,0 +1,20 @@
+*** Settings ***
+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 ***
+Generate pdf file
+    Print as pdf    
+
+*** 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

@@ -18,6 +18,8 @@
     JavascriptKeywordsAsync,
     MockResponseKeywords,
     MockResponseKeywordsAsync,
+    PDFKeywords,
+    PDFKeywordsAsync,
     ScreenshotKeywords,
     ScreenshotKeywordsAsync,
     UtilityKeywords,
@@ -102,6 +104,7 @@ def __init__(self):
             FormElementKeywords(self),
             JavascriptKeywords(self),
             MockResponseKeywords(self),
+            PDFKeywords(self),
             ScreenshotKeywords(self),
             UtilityKeywords(self),
             WaitingKeywords(self)
@@ -115,6 +118,7 @@ def __init__(self):
             FormElementKeywordsAsync(self),
             JavascriptKeywordsAsync(self),
             MockResponseKeywordsAsync(self),
+            PDFKeywordsAsync(self),
             ScreenshotKeywordsAsync(self),
             WaitingKeywordsAsync(self)
         ]

PuppeteerLibrary/keywords/__init__.py

@@ -10,6 +10,8 @@
 from .javascript_async import JavascriptKeywordsAsync
 from .mockresponse import MockResponseKeywords
 from .mockresponse_async import MockResponseKeywordsAsync
+from .pdf import PDFKeywords
+from .pdf_async import PDFKeywordsAsync
 from .screenshot import ScreenshotKeywords
 from .screenshot_async import ScreenshotKeywordsAsync
 from .utility import UtilityKeywords

PuppeteerLibrary/keywords/pdf.py

@@ -0,0 +1,28 @@
+from PuppeteerLibrary.base.librarycomponent import LibraryComponent
+from PuppeteerLibrary.base.robotlibcore import keyword
+from PuppeteerLibrary.keywords.pdf_async import PDFKeywordsAsync, DEFAULT_FILENAME_PAGE
+
+
+class PDFKeywords(LibraryComponent):
+
+    def __init__(self, ctx):
+        super().__init__(ctx)
+        self.async_func = PDFKeywordsAsync(self.ctx)
+    
+    @keyword
+    def print_as_pdf(self, filename=DEFAULT_FILENAME_PAGE):
+        """
+        Print current web page as pdf file. This keyword only support with ``HEADLESS`` mode enable.
+
+        The ``filename`` argument specifies filename and path to save the file.
+        Default valid is 'pdf-{index}.pdf'.
+
+        Example:
+
+        | &{options} =   | create dictionary                             | headless=${False}  |
+        | Open browser   | https://www.w3schools.com/html/html_forms.asp | options=${options} |
+        | Print as PDF   |                                               |                    |
+        | Print as PDF   | custom-pdf-{index}.pdf                        |                    |
+
+        """
+        return self.loop.run_until_complete(self.async_func.print_as_pdf_async(filename))

PuppeteerLibrary/keywords/pdf_async.py

@@ -0,0 +1,38 @@
+import os
+from PuppeteerLibrary.base.robotlibcore import keyword
+from PuppeteerLibrary.base.librarycomponent import LibraryComponent
+
+
+DEFAULT_FILENAME_PAGE = 'pdf-{index}.pdf'
+
+class PDFKeywordsAsync(LibraryComponent):
+
+    def __init__(self, ctx):
+        self.ctx = ctx
+        self.log_dir = os.curdir
+    
+    @keyword
+    async def print_as_pdf_async(self, filename):
+        path = self._get_pdf_path(filename)
+        await self.ctx.current_page.emulateMedia('screen')
+        await self.ctx.current_page.pdf({'path': path})
+        self.info('Print as pdf: '+path)
+
+    def _get_pdf_path(self, filename):
+        directory = self.log_dir
+        filename = filename.replace('/', os.sep)
+        index = 0
+        while True:
+            index += 1
+            formatted = self._format_path(filename, index)
+            path = os.path.join(directory, formatted)
+            if formatted == filename or not os.path.exists(path):
+                return path
+
+    def _format_path(self, file_path, index):
+        return file_path.format_map(_SafeFormatter(index=index))
+
+class _SafeFormatter(dict):
+
+    def __missing__(self, key):
+        return '{%s}' % key

PuppeteerLibrary/keywords/screenshot.py

@@ -11,4 +11,16 @@ def __init__(self, ctx):
 
     @keyword
     def capture_page_screenshot(self, filename=DEFAULT_FILENAME_PAGE):
+        """
+        Capture current web page as image png file.
+
+        The ``filename`` argument specifies filename and path to save the file.
+        Default valid is 'puppeteer-screenshot-{index}.png'.
+
+        Example:
+
+        | Capture page screenshot   |                    |
+        | Capture page screenshot   | custom-{index}.png |
+
+        """
         return self.loop.run_until_complete(self.async_func.capture_page_screenshot_async(filename))

PuppeteerLibrary/keywords/screenshot_async.py

@@ -3,7 +3,7 @@
 from PuppeteerLibrary.base.robotlibcore import keyword
 from PuppeteerLibrary.base.librarycomponent import LibraryComponent
 
-DEFAULT_FILENAME_PAGE = 'selenium-screenshot-{index}.png'
+DEFAULT_FILENAME_PAGE = 'puppeteer-screenshot-{index}.png'
 
 class ScreenshotKeywordsAsync(LibraryComponent):