add n to some notebook keywords, settings keywords (#41)

bollwyvl · web-flow · commit 90ad1587f0eb · 2021-04-30T14:41:07.000-04:00
diff --git a/_scripts/atest.py b/_scripts/atest.py
@@ -65,7 +65,6 @@ def run_tests(attempt=0, extra_args=None):
         f"PY:{P.THIS_PYTHON}",
         "--randomize",
         "all",
-        "--xunitskipnoncritical",
         "--xunit",
         ".".join(["xunit", "xml"]),
         ".",
diff --git a/atest/lab/00_shell.robot b/atest/lab/00_shell.robot
@@ -11,5 +11,5 @@ Open JupyterLab
 Get Help
     Open JupyterLab    ${BROWSER}
     Open With JupyterLab Menu    Help    About JupyterLab
-    Capture Element Screenshot    css:.jp-Dialog-content    lab${/}about.png
+    Capture Element Screenshot    css:.jp-Dialog-content    00-about.png
     Click Element    css:${JLAB CSS ACCEPT}
diff --git a/atest/lab/10_notebook.robot b/atest/lab/10_notebook.robot
@@ -4,23 +4,43 @@ Test Teardown     Run Keyword and Ignore Error    Reset JupyterLab and Close
 Default Tags      notebook
 Library           JupyterLibrary
 Library           Process
+Test Setup        Open JupyterLab    ${BROWSER}
 
 *** Test Cases ***
 IPython Notebook on Lab
-    Open JupyterLab    ${BROWSER}
     Launch a new JupyterLab Document
     Add and Run JupyterLab Code Cell    print("hello world")
     Wait Until JupyterLab Kernel Is Idle
     Current JupyterLab Cell Output Should Contain    hello world
-    Capture Page Screenshot    lab${/}ipython.png
+    Capture Page Screenshot    10-00-ipython.png
     Save JupyterLab Notebook
 
 IPython Notebook Outputs on Lab
-    Open JupyterLab    ${BROWSER}
     Launch a new JupyterLab Document
     FOR    ${i}    IN RANGE    ${10}
         Add and Run JupyterLab Code Cell    print("${i} hello world " * ${i ** 2})
     END
     Wait Until JupyterLab Kernel Is Idle
-    Screenshot Each Output of Active JupyterLab Document    lab${/}ipython_outputs${/}
+    Screenshot Each Output of Active JupyterLab Document    10-10-outputs
     Save JupyterLab Notebook
+
+Multiple Notebooks on Lab
+    [Tags]    notebooks
+    Disable JupyterLab Modal Command Palette
+    Launch a new JupyterLab Document
+    Wait Until JupyterLab Kernel Is Idle
+    Add and Run JupyterLab Code Cell    print("hello world")
+    Wait Until JupyterLab Kernel Is Idle
+    Page Should Contain    hello world
+    Capture Page Screenshot    10-20-one-notebook.png
+    Launch a new JupyterLab Document
+    ${tab1} =    Get JupyterLab Dock Panel Tab    Untitled1.ipynb
+    Click Element    ${tab1}
+    Add and Run JupyterLab Code Cell    print("yet another world")    n=2
+    Wait Until JupyterLab Kernel Is Idle
+    Page Should Contain    another world
+    Drag And Drop By Offset    ${tab1}    800    500
+    Capture Page Screenshot    10-21-two-notesbook.png
+    Close JupyterLab Dock Panel Tab    Untitled1.ipynb
+    Maybe Accept a JupyterLab Prompt
+    Page Should Not Contain    yet another world
diff --git a/atest/lab/20_magic.robot b/atest/lab/20_magic.robot
@@ -31,5 +31,5 @@ Wait for and Click Text
     ${sel} =    Set Variable    xpath://*[contains(text(), '${canary}')]
     Wait Until Page Contains Element    ${sel}
     Click Element    ${sel}
-    Capture Page Screenshot    lab${/}magic-${NEXT SCREENSHOT}-${canary}.png
+    Capture Page Screenshot    20-00-magic-${NEXT SCREENSHOT}-${canary}.png
     Set Test Variable    ${NEXT SCREENSHOT}    ${NEXT SCREENSHOT.__add__(1)}
diff --git a/atest/lab/30_settings.robot b/atest/lab/30_settings.robot
@@ -0,0 +1,21 @@
+*** Settings ***
+Suite Teardown    Run Keyword and Ignore Error    Close All Browsers
+Test Teardown     Run Keyword and Ignore Error    Reset JupyterLab and Close
+Default Tags      settings
+Library           JupyterLibrary
+Library           Process
+
+*** Variables ***
+${PACKAGE}        @jupyterlab/apputils-extension
+${PLUGIN}         palette
+
+*** Test Cases ***
+Command Palette
+    [Documentation]    Verify settings and command palette
+    Open JupyterLab    ${BROWSER}
+    Disable JupyterLab Modal Command Palette
+    ${config} =    Get JupyterLab Plugin Settings    ${PACKAGE}    ${PLUGIN}
+    Should Be True    not ${config["modal"]}
+    Enable JupyterLab Modal Command Palette
+    ${config} =    Get JupyterLab Plugin Settings    ${PACKAGE}    ${PLUGIN}
+    Should Be True    ${config["modal"]}
diff --git a/atest/lab/__init__.robot b/atest/lab/__init__.robot
@@ -1,5 +1,10 @@
 *** Settings ***
-Suite Setup       Wait for New Jupyter Server to be Ready
+Suite Setup       Set Up JupyterLab Suite
 Suite Teardown    Terminate All Jupyter Servers
 Force Tags        client:jupyterlab
 Library           JupyterLibrary
+
+*** Keywords ***
+Set Up JupyterLab Suite
+    Wait for New Jupyter Server to be Ready
+    Set Screenshot Directory    ${OUTPUT DIR}${/}lab
diff --git a/docs/HISTORY.ipynb b/docs/HISTORY.ipynb
@@ -22,7 +22,10 @@
     "| Products under review         | Versions                 |\n",
     "|-----------------------------|--------------------------|\n",
     "| JupyterLab Classic                  | 0.1.10 |\n",
-    "| Voila                  | 0.2.9 |"
+    "| Voila                  | 0.2.9 |\n",
+    "\n",
+    "- Several JupyterLab keywords now accept an `${n}` argument to handle multiple documents on the page.\n",
+    "- Many JupyterLab keywords that wait for certain events can be configured with `${timeout}` and `${sleep}` to suit."
    ]
   },
   {
diff --git a/src/JupyterLibrary/clients/jupyterlab/Commands.robot b/src/JupyterLibrary/clients/jupyterlab/Commands.robot
@@ -7,7 +7,7 @@ Execute JupyterLab Command
     [Arguments]    ${command}    ${accept}=${True}    ${close}=${True}
     [Documentation]    Use the JupyterLab
     ...    [https://jupyterlab.readthedocs.io/en/stable/user/commands.html|Command Palette]
-    ...    to run a command and ``accept`` any resulting dialogs, then ``close``
+    ...    to run a ``command`` and ``accept`` any resulting dialogs, then ``close``
     ...    the Command Palette.
     Maybe accept a JupyterLab prompt
     Open Command Palette with Hotkeys
@@ -18,6 +18,11 @@ Execute JupyterLab Command
     Run Keyword If    ${close}    Maybe Close JupyterLab Sidebar
 
 Open Command Palette with Hotkeys
+    [Documentation]
+    ...    Open the JupyterLab Command Palette with the platform-specific keyboard
+    ...    shortcuts. Note that the JupyterLab 3 modal command palette is flaky.
+    ...    Enabling the sidebar-based mechanism may help, see:
+    ...    - [#Set JupyterLab Plugin Settings|Set JupyterLab Plugin Settings]
     ${accel} =    Get ACCEL key
     Press Keys    id:main    ${accel}+SHIFT+c
     Wait Until Page Contains Element    css:${JLAB CSS CMD INPUT}
diff --git a/src/JupyterLibrary/clients/jupyterlab/Icons.robot b/src/JupyterLibrary/clients/jupyterlab/Icons.robot
@@ -26,7 +26,7 @@ Resource          JupyterLibrary/clients/jupyterlab/PageInfo.robot
 *** Keywords ***    ***
 Get JupyterLab Icon CSS
     [Arguments]    ${icon}
-    [Documentation]    Get a Lab version-specific, but general CSS selector for an icon
+    [Documentation]    Get a Lab version-specific, but general CSS selector for an ``icon``.
     ${version} =    Get JupyterLab Application Version Info
     ${sel} =    Set Variable If    ${version[0].__eq__('1')}
     ...    ${JLAB1 CSS ICONS['${icon}']}
@@ -35,7 +35,7 @@ Get JupyterLab Icon CSS
 
 Get JupyterLab Icon XPath
     [Arguments]    ${icon}
-    [Documentation]    Get a Lab version-specific, but general XPath selector for an icon
+    [Documentation]    Get a Lab version-specific, but general XPath selector for an ``icon``.
     ${version} =    Get JupyterLab Application Version Info
     ${sel} =    Set Variable If    ${version[0].__eq__('1')}
     ...    ${JLAB1 XP ICONS['${icon}']}
diff --git a/src/JupyterLibrary/clients/jupyterlab/Launcher.robot b/src/JupyterLibrary/clients/jupyterlab/Launcher.robot
@@ -3,15 +3,17 @@ Resource          JupyterLibrary/clients/jupyterlab/Selectors.robot
 
 *** Keywords ***
 Launch a new JupyterLab Document
-    [Arguments]    ${kernel}=Python 3    ${category}=Notebook
+    [Arguments]    ${kernel}=Python 3    ${category}=Notebook    ${timeout}=10s    ${sleep}=0.5s
     [Documentation]    Use the JupyterLab launcher to launch a document of ``category``
     ...    Notebook or Console with the given ``kernel``, and wait until the loading
     ...    animation is complete.
-    Wait Until Page Contains Element    xpath:${JLAB XP CARD}    timeout=10s
+    ${launcher} =    Get WebElements    xpath:${JLAB XP LAUNCHER}
+    Run Keyword If    not ${launcher.__len__()}    Execute JupyterLab Command    New Launcher
+    Wait Until Page Contains Element    xpath:${JLAB XP CARD}    timeout=${timeout}
     Click Element    xpath:${JLAB XP CARD}\[@title='${kernel}'][@data-category='${category}']
     Run Keyword And Ignore Error
     ...    Wait Until Page Contains Element    css:${JLAB CSS SPINNER}
     Run Keyword And Ignore Error
     ...    Wait Until Page Does Not Contain Element    css:${JLAB CSS SPINNER}
     Wait Until Page Contains Element    css:${JLAB CSS ACTIVE INPUT}
-    Sleep    0.5s
+    Sleep    ${sleep}
diff --git a/src/JupyterLibrary/clients/jupyterlab/Notebook.robot b/src/JupyterLibrary/clients/jupyterlab/Notebook.robot
@@ -7,34 +7,47 @@ Resource          JupyterLibrary/common/CodeMirror.robot
 
 *** Keywords ***
 Add and Run JupyterLab Code Cell
-    [Arguments]    @{code}
-    [Documentation]    Add a ``code`` cell to the currently active notebook and run it.
-    ...    ``code`` is a list of strings to set as lines in the code editor
+    [Arguments]    @{code}    ${n}=1
+    [Documentation]    Add a ``code`` cell to the ``n`` th notebook on the page and run it.
+    ...    ``code`` is a list of strings to set as lines in the code editor.
+    ...    ``n`` is the 1-based index of the notebook, usually in order of opening.
     ${nl} =    Set Variable    \n
     ${add icon} =    Get JupyterLab Icon XPath    add
-    Click Element    xpath:${JLAB XP NB TOOLBAR}//${add icon}
+    ${nb} =    Get WebElement    xpath://div${JLAB XP NB FRAG}\[${n}]
+    # rely on main area widgets all having ids
+    ${nbid} =    Get Element Attribute    ${nb}    id
+    Click Element    ${nb.find_element_by_xpath('''div${JLAB XP NB TOOLBAR FRAG}//${add icon}''')}
     Sleep    0.1s
-    ${cell} =    Get WebElement    css:${JLAB CSS ACTIVE INPUT}
+    ${cell} =    Set Variable
+    ...    ${nb.find_element_by_css_selector('''${JLAB CSS ACTIVE INPUT}'''.replace('''${JLAB CSS ACTIVE DOC}''', ''))}
     Click Element    ${cell}
-    Set CodeMirror Value    ${JLAB CSS ACTIVE INPUT}    @{code}
-    Run Current JupyterLab Code Cell
+    Set CodeMirror Value    \#${nbid}${JLAB CSS ACTIVE INPUT}    @{code}
+    Run Current JupyterLab Code Cell    ${n}
     Click Element    ${cell}
 
 Wait Until JupyterLab Kernel Is Idle
-    [Documentation]    Wait for a kernel to be busy, and then stop being busy
+    [Arguments]    ${n}=1
+    [Documentation]    Wait for a kernel to be busy, and then stop being busy, in the ``n`` th notebook.
+    ...    ``n`` is the 1-based index of the notebook, usually in order of opening.
     ${busy icon} =    Get JupyterLab Icon XPath    filled circle
+    ${sel} =    Set Variable
+    ...    xpath://div${JLAB XP NB FRAG}\[${n}]//div${JLAB XP NB TOOLBAR FRAG}//${busy icon}
     Run Keyword And Ignore Error
-    ...    Wait Until Page Does Not Contain Element    xpath://${JLAB XP NB TOOLBAR}//${busy icon}
+    ...    Wait Until Page Does Not Contain Element    ${sel}
     Run Keyword And Ignore Error
-    ...    Wait Until Page Does Not Contain    xpath:${JLAB XP NB TOOLBAR}//${busy icon}
+    ...    Wait Until Page Does Not Contain    ${sel}
 
 Save JupyterLab Notebook
-    [Documentation]    Use the `Save Notebook` command
+    [Documentation]    Use the `Save Notebook` command with the currently-active notebook.
     Execute JupyterLab Command    Save Notebook
 
 Run Current JupyterLab Code Cell
+    [Arguments]    ${n}=1
+    [Documentation]    Run the currently-selected cell(s) in the ``n`` th notebook.
+    ...    ``n`` is the 1-based index of the notebook, usually in order of opening.
     ${run icon} =    Get JupyterLab Icon XPath    run
-    ${sel} =    Set Variable    xpath:${JLAB XP NB TOOLBAR}//${run icon}
-    Wait Until Page Contains Element    ${sel}
-    Click Element    ${sel}
+    ${nb} =    Get WebElement    xpath://div${JLAB XP NB FRAG}\[${n}]
+    ${run btn} =    Set Variable
+    ...    ${nb.find_element_by_xpath('''div${JLAB XP NB TOOLBAR FRAG}//${run icon}''')}
+    Click Element    ${run btn}
     Sleep    0.5s
diff --git a/src/JupyterLibrary/clients/jupyterlab/Output.robot b/src/JupyterLibrary/clients/jupyterlab/Output.robot
@@ -4,31 +4,32 @@ Resource          JupyterLibrary/clients/jupyterlab/Selectors.robot
 *** Keywords ***
 Current JupyterLab Cell Output Should Contain
     [Arguments]    ${expected}
+    [Documentation]    Check the current active Notebook cell for the ``expected`` text.
     Wait Until Page Contains Element    css:${JLAB CSS ACTIVE OUTPUT CHILDREN}
     Element Should Contain    css:${JLAB CSS ACTIVE OUTPUT CHILDREN}    ${expected}
 
 Screenshot Each Output of Active JupyterLab Cell
     [Arguments]    ${prefix}
-    [Documentation]    Capture all of the outputs of the current Cell as screenshots
-    ...    with a ``prefix``.
+    [Documentation]    Capture all of the outputs of the current _Cell_ as screenshots
+    ...    with a ``prefix`` (may include folders).
     ${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
     END
 
 Screenshot Markdown of Active JupyterLab Cell
     [Arguments]    ${prefix}
-    [Documentation]    Capture all of the rendered Markdown of the current Document as screenshots
-    ...    with a ``prefix``.
+    [Documentation]    Capture all of the rendered Markdown of the current _Document_ as screenshots
+    ...    with a ``prefix`` (may include folders).
     ${inputs} =    Get WebElements    css:${JLAB CSS ACTIVE CELL MARKDOWN}
     FOR    ${i}    IN RANGE    ${inputs.__len__()}
         Capture Element Screenshot    ${inputs[${i}]}    ${prefix}_markdown_${i}.png
     END
 
 Screenshot Each Output of Active JupyterLab Document
     [Arguments]    ${prefix}
-    [Documentation]    Capture all of the outputs of the current **Document** as
-    ...    screenshots with a ``prefix``.
+    [Documentation]    Capture all of the outputs of the current _Document_ as
+    ...    screenshots with a ``prefix`` (may include folders).
     ${cells} =    Get WebElements    css:${JLAB CSS ACTIVE DOC CELLS}
     FOR    ${i}    IN RANGE    ${cells.__len__()}
         Click element    ${cells[${i}]}
diff --git a/src/JupyterLibrary/clients/jupyterlab/PageInfo.robot b/src/JupyterLibrary/clients/jupyterlab/PageInfo.robot
@@ -1,59 +1,30 @@
 *** Settings ***
-#
-# Example pageInfo
-#
-#                 <script id="jupyter-config-data" type="application/json">{
-#                 "appName": "JupyterLab", "appNamespace": "jupyterlab",
-#                 "appSettingsDir": "$PREFIX/share/jupyter/lab/settings", "appUrl": "/lab",
-#                 "appVersion": "2.2.9", "asset_url": "", "baseUrl": "/",
-#                 "buildAvailable": true, "buildCheck": true, "cacheFiles": true,
-#                 "devMode": false, "exposeAppInBrowser": false, "fullAppUrl": "/lab",
-#                 "fullListingsUrl": "/lab/api/listings",
-#                 "fullMathjaxUrl": "/static/components/MathJax/MathJax.js",
-#                 "fullSettingsUrl": "/lab/api/settings", "fullStaticUrl": "/static/lab",
-#                 "fullThemesUrl": "/lab/api/themes", "fullTreeUrl": "/lab/tree",
-#                 "fullWorkspacesApiUrl": "/lab/api/workspaces", "fullWorkspacesUrl": "/lab/workspaces",
-#                 "ga_code": "", "ignorePlugins": [], "listingsUrl": "/lab/api/listings",
-#                 "mathjaxConfig": "TeX-AMS-MML_HTMLorMML-full,Safe", "notebookVersion": "[6, 1, 5]",
-#                 "quitButton": true, "schemasDir": "$PREFIX/share/jupyter/lab/schemas",
-#                 "serverRoot": "$CWD", "settingsUrl": "/lab/api/settings",
-#                 "staticDir": "$PREFIX/share/jupyter/lab/static",
-#                 "staticUrl": "/static/lab", "store_id": 2,
-#                 "templatesDir": "$PREFIX/share/jupyter/lab/static", "terminalsAvailable": true,
-#                 "themesDir": "$PREFIX/share/jupyter/lab/themes", "themesUrl": "/lab/api/themes",
-#                 "token": "$TOKEN", "treeUrl": "/lab/tree",
-#                 "userSettingsDir": "$HOME/.jupyter/lab/user-settings",
-#                 "workspacesApiUrl": "/lab/api/workspaces",
-#                 "workspacesDir": "$HOME/.jupyter/lab/workspaces",
-#                 "workspacesUrl": "/lab/workspaces", "wsUrl": ""
-#                 }</script>
-#
-# **NOTE**: Some pageInfo values might contain $SENSITIVE_INFORMATION.
-#                 It is not recommended to store/emit/log pageInfo, unfiltered.
-#
 Resource          JupyterLibrary/clients/jupyterlab/Selectors.robot
 Library           json    WITH NAME    JSON
 Library           String
 
 *** Variables ***
-# TODO: test with jlab1
 ${JLAB XP PAGEINFO}    script[contains(@id, 'jupyter-config-data')]
+# keep this updated below
 @{JLAB DEFAULT PAGEINFO TAGS}    appName    appVersion    buildAvailable
 ...               buildCheck    notebookVersion    devMode
 
 *** Keywords ***
 Get JupyterLab Page Info
     [Arguments]    ${key}=${EMPTY}    ${clear}=${False}
-    [Documentation]    Get one (or all) of the pageConfig datum from JupyterLab's HTML
+    [Documentation]    Get one (or all) of the ``pageInfo`` ``key`` s from JupyterLab's HTML ``<head>``.
+    ...    Optionally ``clear`` the cached info first.
+    ...
     ...    See also:
-    ...    - *Tag With JupyterLab Metadata*
+    ...    - [#Tag With JupyterLab Metadata|Tag With JupyterLab Metadata]
     ${pageInfo} =    Get Variable Value    ${JLAB PAGEINFO CACHE}    ${EMPTY}
     Run Keyword If    ${clear} or not ${pageInfo.__len__()}    Update JupyterLab PageInfo Cache
     ${pageInfo} =    Set Variable    ${JLAB PAGEINFO CACHE}
-    ${result} =    Set Variable If    ${key.__len__()}    ${pageInfo.get(key)}    ${pageInfo}
+    ${result} =    Set Variable If    ${key.__len__()}    ${pageInfo.get("${key}")}    ${pageInfo}
     [Return]    ${result}
 
 Update JupyterLab PageInfo Cache
+    [Documentation]    Update the cached JupyterLab ``pageInfo``. _Not usually needed._
     ${sel} =    Set Variable    xpath://${JLAB XP PAGEINFO}
     Wait Until Page Contains Element    ${sel}
     ${txt} =    Get Element Attribute    ${sel}    innerHTML
@@ -62,14 +33,20 @@ Update JupyterLab PageInfo Cache
 
 Tag With JupyterLab Metadata
     [Arguments]    ${keys}=${JLAB DEFAULT PAGEINFO TAGS}    ${clear}=${False}
-    [Documentation]    Tag the current test (or suite) with JupyterLab pageInfo
+    [Documentation]    Tag the current test (or suite) with ``keys`` from the
+    ...    JupyterLab ``pageInfo``.
+    ...    The default ``keys``: ``appName`` ``appVersion`` ``buildAvailable``
+    ...    ``buildCheck`` ``notebookVersion`` ``devMode``
     ${info} =    Get JupyterLab Page Info    clear=${clear}
     FOR    ${key}    IN    @{keys}
         ${val} =    Set Variable    ${info.get("${key}")}
         Set Tags    jupyterlab:${key}:${val}
     END
 
 Get JupyterLab Application Version Info
+    [Documentation]    Get the version of the application ``2.3.0.rc1`` as a list of
+    ...    strings from ``pageInfo``, e.g. ``["2", "3", "1", "rc1"]``. Optionally ``clear``
+    ...    the cached info first.
     [Arguments]    ${clear}=${False}
-    ${json} =    Get JupyterLab Page Info    clear=${clear}
-    [Return]    ${json['appVersion'].split(".")}
+    ${version} =    Get JupyterLab Page Info    appVersion    clear=${clear}
+    [Return]    ${version.split(".")}
diff --git a/src/JupyterLibrary/clients/jupyterlab/Selectors.robot b/src/JupyterLibrary/clients/jupyterlab/Selectors.robot
diff --git a/src/JupyterLibrary/clients/jupyterlab/Settings.robot b/src/JupyterLibrary/clients/jupyterlab/Settings.robot
diff --git a/src/JupyterLibrary/clients/jupyterlab/Shell.robot b/src/JupyterLibrary/clients/jupyterlab/Shell.robot
diff --git a/src/JupyterLibrary/clients/jupyterlab/Shortcuts.robot b/src/JupyterLibrary/clients/jupyterlab/Shortcuts.robot
diff --git a/src/JupyterLibrary/keywords/server.py b/src/JupyterLibrary/keywords/server.py

Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,10 @@`
`22`	`22`	`"\| Products under review \| Versions \|\n",`
`23`	`23`	`"\|-----------------------------\|--------------------------\|\n",`
`24`	`24`	`"\| JupyterLab Classic \| 0.1.10 \|\n",`
`25`		`- "\| Voila \| 0.2.9 \|"`
	`25`	`+ "\| Voila \| 0.2.9 \|\n",`
	`26`	`+ "\n",`
	`27`	+ "- Several JupyterLab keywords now accept an `${n}` argument to handle multiple documents on the page.\n",
	`28`	+ "- Many JupyterLab keywords that wait for certain events can be configured with `${timeout}` and `${sleep}` to suit."
`26`	`29`	`]`
`27`	`30`	`},`
`28`	`31`	`{`