add capture all outputs

Author: bollwyvl

README.md

@@ -0,0 +1,32 @@
+# robotframework-jupyterlibrary
+> A Robot Framework library for testing Jupyter end-user applications and extensions
+
+---
+
+> _TODO: binder, tests, pip, conda_
+
+# Installation
+
+## Development Installation
+- get Firefox
+- get Miniconda
+- update and activate
+```bash
+conda env update
+conda activate robotframework-jupyterlibrary
+```
+- then
+```bash
+pip install -e . --no-deps --ignore-installed
+```
+- run the tests
+```
+python -m atest.run
+```
+
+# Using
+> _TODO: Figure out a documentation strategy that works with
+         janky-imported resources_
+
+Write `.robot` files that use `JupyterLibrary` keywords. See the
+[acceptance tests](./atest/acceptance) for examples.

atest/acceptance/10_lab/10_notebook.robot

@@ -1,6 +1,7 @@
 *** Settings ***
 Suite Setup       Wait for New Jupyter Server to be Ready
-Test Teardown     Close All Browsers
+Test Teardown     Reset JupyterLab and Close
+Default Tags      notebook
 Library           JupyterLibrary
 Library           Process
 
@@ -12,6 +13,13 @@ IPython Notebook
     Wait Until Kernel Is Idle
     Capture Page Screenshot    ipython.png
 
+IPython Notebook Outputs
+    Open JupyterLab
+    Launch a new JupyterLab Document
+    Add and Run Cell    print("hello world")
+    Wait Until Kernel Is Idle
+    Screenshot Each Output of Active Document    ${OUTPUT_DIR}${/}ipython
+
 *** Keywords ***
 Clean Up Everything
     Close All Browsers

atest/run.py

@@ -12,8 +12,10 @@
 
 def run_tests(*robot_args):
     proc = subprocess.Popen([
-        "python", "-m", "robot", "-d", out, tests
-    ], cwd=here)
+        "python", "-m", "robot", "-d", out,
+        ] + list(robot_args) + [
+            tests,
+        ], cwd=here)
 
     try:
         return proc.wait()
@@ -23,4 +25,4 @@ def run_tests(*robot_args):
 
 
 if __name__ == "__main__":
-    sys.exit(run_tests(sys.argv[1:]))
+    sys.exit(run_tests(*sys.argv[1:]))

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = robotframework-jupyterlibrary
-description = A Robot Framework library for testing Jupyter end-user applications
+description = A Robot Framework library for testing Jupyter end-user applications and extensions
 long_description = file: README.md, CHANGELOG.md
 url = https://github.com/robots-from-jupyter/robotframework-jupyterlibrary
 author = Nicholas Bollweg

src/JupyterLibrary/keywords/screenshots.py

@@ -15,7 +15,7 @@
 
 class ScreenshotKeywords(LibraryComponent):
     @keyword
-    def capture_element_screenshot(self, locator, filename, embed=True):
+    def capture_element_screenshot(self, locator, filename):
         el = self.find_element(locator)
         BuiltIn().run_keyword("Capture Page Screenshot", filename)
         rect = {**el.location, **el.size}

src/JupyterLibrary/resources/jupyterlab/Commands.robot

@@ -7,15 +7,15 @@ Resource   JupyterLibrary/resources/jupyterlab/Selectors.robot
 Execute JupyterLab Command
     [Arguments]    ${command}  ${accept}=${True}  ${close}=${True}
     [Documentation]    Use the JupyterLab Command Palette to run a command
-    Maybe accept a prompt
+    Maybe accept a JupyterLab prompt
     Maybe Open JupyterLab Sidebar  command-palette
     Input Text    css:${JLAB CSS CMD INPUT}    ${command}
     Wait Until Page Contains Element    css:${JLAB CSS CMD ITEM}
     Click Element    css:${JLAB CSS CMD ITEM}
-    Run Keyword If  ${accept}  Maybe Accept a Prompt
-    Run Keyword If  ${close}  Maybe Close Sidebar
+    Run Keyword If  ${accept}  Maybe Accept a JupyterLab Prompt
+    Run Keyword If  ${close}  Maybe Close JupyterLab Sidebar
 
-Reset Application State and Close
+Reset JupyterLab and Close
     [Documentation]    Try to clean up after doing some things to the JupyterLab state
     Execute JupyterLab Command    Reset Application State
     Close Browser

src/JupyterLibrary/resources/jupyterlab/Output.robot

@@ -0,0 +1,27 @@
+*** Settings ***
+Documentation     Get screenshots and content of a JupyterLab Notebook
+Resource   JupyterLibrary/resources/jupyterlab/Selectors.robot
+
+*** Keywords ***
+Screenshot Each Output of Active Cell
+    [Arguments]  ${prefix}
+    ${outputs} =  Get WebElements  css:${JLAB CSS ACTIVE OUTPUT CHILDREN} ${JLAB CSS OUTPUT} > *
+    :FOR   ${i}  IN RANGE  ${outputs.__len__()}
+    \  Capture Element Screenshot  ${outputs[${i}]}  ${prefix}_output_${i}.png
+
+Screenshot Markdown of Active Cell
+    [Arguments]  ${prefix}
+    ${inputs} =  Get WebElements  css:${JLAB CSS ACTIVE CELL MARKDOWN}
+    :FOR   ${i}  IN RANGE  ${inputs.__len__()}
+    \  Capture Element Screenshot  ${inputs[${i}]}  ${prefix}_markdown_${i}.png
+
+Screenshot Each Output of Active Document
+    [Arguments]  ${prefix}
+    ${cells} =  Get WebElements  css:${JLAB CSS ACTIVE DOC CELLS}
+    :FOR  ${i}   IN RANGE  ${cells.__len__()}
+    \   Click element  ${cells[${i}]}
+    \   Run Keyword And Ignore Error    Click element  ${cells[${i + 1}]}
+    \   Click element  ${cells[${i}]}
+    \   Sleep  0.1s
+    \   Screenshot each output of active cell	${prefix}_cell_${i}
+    \   Screenshot Markdown of active cell	${prefix}_cell_${i}

src/JupyterLibrary/resources/jupyterlab/Selectors.robot

@@ -1,25 +1,27 @@
 *** Variables ***
-${JLAB ID SPLASH}      jupyterlab-splash
+${JLAB CSS ACCEPT}  .jp-mod-accept
+${JLAB CSS ACTIVE DOC}  .jp-Document:not(.jp-mod-hidden)
+${JLAB CSS ACTIVE DOC CELLS}  ${JLAB CSS ACTIVE DOC} .jp-Cell
+${JLAB CSS ACTIVE CELL}  ${JLAB CSS ACTIVE DOC} .jp-Cell.jp-mod-active
+${JLAB CSS ACTIVE OUTPUT CHILDREN}    ${JLAB CSS ACTIVE CELL} .jp-OutputArea-child
+${JLAB CSS OUTPUT}   .jp-OutputArea-output
+${JLAB CSS ACTIVE CELL MARKDOWN}    ${JLAB CSS ACTIVE CELL} .jp-MarkdownOutput:not(.jp-mod-hidden)
 
+${JLAB CSS ACTIVE SIDEBAR}  .jp-SideBar .p-TabBar-tab.p-mod-current
+${JLAB CSS BUSY KERNEL}  .jp-Toolbar-kernelStatus.jp-FilledCircleIcon
 ${JLAB CSS CELL}       .jp-Notebook .jp-Cell:last-of-type .jp-InputArea-editor .CodeMirror
-${JLAB CSS SPINNER}        .jp-Spinner
-${JLAB CSS CMD PALETTE}    li[data-id="command-palette"]
 ${JLAB CSS CMD INPUT}    .p-CommandPalette-input
 ${JLAB CSS CMD ITEM}    .p-CommandPalette-item
-${JLAB CSS ACCEPT}  .jp-mod-accept
-${JLAB CSS ACTIVE SIDEBAR}  .jp-SideBar .p-TabBar-tab.p-mod-current
-${JLAB CSS SIDEBAR TAB}  .jp-SideBar .p-TabBar-tab
-${JLAB CSS BUSY KERNEL}  .jp-Toolbar-kernelStatus.jp-FilledCircleIcon
-
-${JLAB CSS NB TOOLBAR}  .jp-NotebookPanel-toolbar
-
-${JLAB CSS ICON RUN}  .jp-RunIcon
+${JLAB CSS CMD PALETTE}    li[data-id="command-palette"]
 ${JLAB CSS ICON ADD}  .jp-AddIcon
-
-${JLAB XP TOP}            //div[@id='jp-top-panel']
-${JLAB XP MENU LABEL}       //div[@class='p-MenuBar-itemLabel']
-${JLAB XP MENU ITEM LABEL}  //div[@class='p-Menu-itemLabel']
+${JLAB CSS ICON RUN}  .jp-RunIcon
+${JLAB CSS NB TOOLBAR}  .jp-NotebookPanel-toolbar
+${JLAB CSS SIDEBAR TAB}  .jp-SideBar .p-TabBar-tab
+${JLAB CSS SPINNER}        .jp-Spinner
+${JLAB ID SPLASH}      jupyterlab-splash
+${JLAB TEXT BUSY PROMPT}  In [*]:
 ${JLAB XP CARD}           //div[@class='jp-LauncherCard']
 ${JLAB XP DOCK}           //div[@id='jp-main-dock-panel']
-
-${JLAB TEXT BUSY PROMPT}  In [*]:
+${JLAB XP MENU ITEM LABEL}  //div[@class='p-Menu-itemLabel']
+${JLAB XP MENU LABEL}       //div[@class='p-MenuBar-itemLabel']
+${JLAB XP TOP}            //div[@id='jp-top-panel']

src/JupyterLibrary/resources/jupyterlab/Shell.robot

@@ -39,6 +39,6 @@ Open With JupyterLab Menu
     :FOR  ${item_label}  IN  @{submenu_labels}
     \  Click JupyterLab Menu Item  ${item_label}
 
-Maybe Accept a Prompt
+Maybe Accept a JupyterLab Prompt
     ${accept} =  Get WebElements  css:${JLAB CSS ACCEPT}
     Run Keyword If  ${accept}   Click Element    ${accept[0]}

src/JupyterLibrary/resources/jupyterlab/Sidebar.robot

@@ -4,13 +4,13 @@ Resource   JupyterLibrary/resources/jupyterlab/Selectors.robot
 
 
 *** Keywords ***
-Maybe Close Sidebar
+Maybe Close JupyterLab Sidebar
     [Documentation]  Attempt to close the JupyterLab sidebar
     ${active} =  Get WebElements  css:${JLAB CSS ACTIVE SIDEBAR}
     Run Keyword If  ${active}   Click Element    ${active[0]}
 
-Maybe Open Sidebar
+Maybe Open JupyterLab Sidebar
     [Arguments]  ${data id}
     [Documentation]  Attempt to open a JupyterLab sidebar (if not already open)
-    Maybe Close Sidebar
+    Maybe Close JupyterLab Sidebar
     Click Element  css:${JLAB CSS SIDEBAR TAB}[data-id="${data id}"]