Merge pull request #809 from jupyter-lsp/fix-ci-for-lab-3.4

Fix CI regressions, make tests work with JupyterLab 3.4

Author: krassowski

atest/00_Smoke.robot

@@ -3,6 +3,7 @@ Resource        Keywords.resource
 
 Suite Setup     Set Screenshot Directory    ${SCREENSHOTS DIR}${/}smoke
 
+
 *** Test Cases ***
 Lab Version
     Capture Page Screenshot    00-smoke.png

atest/01_Editor.robot

@@ -6,6 +6,7 @@ Suite Setup     Setup Suite For Screenshots    editor
 
 Force Tags      ui:editor    aspect:ls:features
 
+
 *** Test Cases ***
 Bash
     Editor Shows Features for Language    Bash    example.sh    Diagnostics=Failed to parse expression
@@ -54,8 +55,13 @@ Markdown
 
 Python (pylsp)
     ${def} =    Set Variable    xpath:(//span[contains(@class, 'cm-variable')][contains(text(), 'fib')])[last()]
-    Editor Shows Features for Server    pylsp    Python    example.py    Diagnostics=undefined name 'result' (pyflakes)
-    ...    Jump to Definition=${def}    Rename=${def}
+    Editor Shows Features for Server
+    ...    pylsp
+    ...    Python
+    ...    example.py
+    ...    Diagnostics=undefined name 'result' (pyflakes)
+    ...    Jump to Definition=${def}
+    ...    Rename=${def}
 
 Python (pyright)
     ${def} =    Set Variable    xpath:(//span[contains(@class, 'cm-variable')][contains(text(), 'fib')])[last()]
@@ -69,7 +75,8 @@ R
 
 Robot Framework
     [Tags]    gh:332
-    ${def} =    Set Variable    xpath:(//span[contains(@class, 'cm-keyword')][contains(text(), 'Special Log')])[last()]
+    ${def} =    Set Variable
+    ...    xpath:(//span[contains(@class, 'cm-keyword')][contains(text(), 'Special Log')])[last()]
     Editor Shows Features for Language    Robot Framework    example.robot    Diagnostics=Undefined keyword
     ...    Jump to Definition=${def}
 
@@ -95,6 +102,7 @@ SQL
 YAML
     Editor Shows Features for Language    YAML    example.yaml    Diagnostics=Map keys must be unique
 
+
 *** Keywords ***
 Editor Shows Features for Server
     [Arguments]    ${server}    ${Language}    ${file}    &{features}
@@ -138,7 +146,7 @@ Editor Content Changed
     [Arguments]    ${old_content}
     ${new_content} =    Get Editor Content
     Should Not Be Equal    ${old_content}    ${new_content}
-    [Return]    ${new_content}
+    RETURN    ${new_content}
 
 Editor Should Rename
     [Arguments]    ${symbol}

atest/02_Settings.robot

@@ -3,6 +3,7 @@ Resource        Keywords.resource
 
 Suite Setup     Setup Suite For Screenshots    settings
 
+
 *** Test Cases ***
 Settings
     Open in Advanced Settings    ${LSP PLUGIN ID}

atest/03_Notebook.robot

@@ -4,6 +4,7 @@ Resource        Keywords.resource
 Suite Setup     Setup Suite For Screenshots    notebook
 Test Setup      Try to Close All Tabs
 
+
 *** Test Cases ***
 Python
     [Setup]    Setup Notebook    Python    Python.ipynb
@@ -101,6 +102,7 @@ Adding Text To Cells After Kernel Restart
     Wait Until Keyword Succeeds    3x    1s    File Content Should Be Equal    ${virtual_path}    \n\n\ntext\n
     [Teardown]    Clean Up After Working With File    Empty.ipynb
 
+
 *** Keywords ***
 File Content Should Be Equal
     [Arguments]    ${file}    ${text}

atest/04_Interface/BackendFailure.robot

@@ -4,10 +4,12 @@ Resource            ../Keywords.resource
 Suite Setup         Setup Server and Browser    server_extension_enabled=${False}
 Suite Teardown      Setup Server and Browser    server_extension_enabled=${True}
 
+
 *** Variables ***
 ${STATUSBAR}    css:div.lsp-statusbar-item
 ${POPOVER}      css:.lsp-popover
 
+
 *** Test Cases ***
 Handles Server Extension Failure
     Setup Notebook    Python    Python.ipynb    wait=${False}

atest/04_Interface/DiagnosticsPanel.robot

@@ -7,6 +7,7 @@ Test Teardown       Clean Up
 
 Force Tags          ui:notebook    aspect:ls:features
 
+
 *** Variables ***
 ${DIAGNOSTIC MESSAGE R}     Closing curly-braces should always be on their own line
 ${DIAGNOSTIC MESSAGE}       trailing whitespace
@@ -15,6 +16,7 @@ ${EXPECTED_COUNT}           4
 ${MENU COLUMNS}             xpath://div[contains(@class, 'lm-Menu-itemLabel')][contains(text(), "columns")]
 ${R CELL}                   %%R\n{}
 
+
 *** Test Cases ***
 Diagnostics Panel Opens
     Capture Page Screenshot    03-panel-opens.png
@@ -121,6 +123,7 @@ Diagnostics Panel Works After Removing Foreign Document
     Wait Until Keyword Succeeds    10 x    1s    Element Should Not Contain    ${DIAGNOSTICS PANEL}
     ...    ${DIAGNOSTIC MESSAGE R}
 
+
 *** Keywords ***
 Open Context Menu Over W291
     Click Element    css:.lsp-diagnostics-listing th[data-id="Code"]

atest/04_Interface/Statusbar.robot

@@ -3,12 +3,14 @@ Resource        ../Keywords.resource
 
 Suite Setup     Setup Suite For Screenshots    statusbar
 
+
 *** Variables ***
 ${STATUSBAR}        css:div.lsp-statusbar-item
 ${DIAGNOSTIC}       W291 trailing whitespace (pycodestyle)
 ${POPOVER}          css:.lsp-popover
 ${HELP_BUTTON}      css:.lsp-popover .lsp-help-button
 
+
 *** Test Cases ***
 Statusbar Popup Opens
     Setup Notebook    Python    Python.ipynb
@@ -68,6 +70,7 @@ Status Changes Correctly Between Editors
     Wait Until Element Contains    ${STATUSBAR}    Initialized (additional servers needed)    timeout=60s
     [Teardown]    Clean Up After Working With File    example.plain
 
+
 *** Keywords ***
 Switch To Tab
     [Arguments]    ${file}

atest/05_Features/Completion.robot

@@ -7,10 +7,13 @@ Test Teardown       Clean Up After Working With File    Completion.ipynb
 
 Force Tags          feature:completion
 
+
 *** Variables ***
 ${COMPLETER_BOX}            css:.jp-Completer.jp-HoverBox
 ${DOCUMENTATION_PANEL}      css:.jp-Completer-docpanel
-${KERNEL_BUSY_INDICATOR}    css:.jp-NotebookPanel-toolbar div[title="Kernel Busy"]
+${KERNEL_BUSY_INDCA_OLD}    css:.jp-NotebookPanel-toolbar div[title="Kernel Busy"]
+${KERNEL_BUSY_INDICATOR}    css:.jp-Notebook-ExecutionIndicator div[data-status="busy"]
+
 
 *** Test Cases ***
 Works When Kernel Is Idle
@@ -89,8 +92,8 @@ Uses LSP Completions When Kernel Resoponse Times Out
     Should Complete While Kernel Is Busy
 
 Uses LSP Completions When Kernel Is Busy
-    [Tags]    requires:busy-indicator
     [Documentation]    When kernel is not available the best thing is to show some suggestions (LSP) rather than none.
+    [Tags]    requires:busy-indicator
     Configure JupyterLab Plugin    {"kernelResponseTimeout": -1, "waitForBusyKernel": false}
     ...    plugin id=${COMPLETION PLUGIN ID}
     Should Complete While Kernel Is Busy
@@ -357,6 +360,7 @@ Completes Paths In Strings
     Press Keys    None    ENTER
     Wait Until Keyword Succeeds    40x    0.5s    Cell Editor Should Equal    26    '../Completion.ipynb'
 
+
 *** Keywords ***
 Setup Completion Test
     Setup Notebook    Python    Completion.ipynb
@@ -365,12 +369,12 @@ Get Cell Editor Content
     [Arguments]    ${cell_nr}
     ${content} =    Execute JavaScript
     ...    return document.querySelector('.jp-Cell:nth-child(${cell_nr}) .CodeMirror').CodeMirror.getValue()
-    [Return]    ${content}
+    RETURN    ${content}
 
 Get File Editor Content
     ${content} =    Execute JavaScript
     ...    return document.querySelector('.jp-FileEditorCodeWrapper .CodeMirror').CodeMirror.getValue()
-    [Return]    ${content}
+    RETURN    ${content}
 
 Cell Editor Should Equal
     [Arguments]    ${cell}    ${value}
@@ -392,7 +396,7 @@ Activate Completer Suggestion
         Capture Page Screenshot    ${i}-completions.png
         ${matching_active_elements} =    Get Element Count    ${active_suggestion}
         LOG    ${matching_active_elements}
-        Exit For Loop If    ${matching_active_elements} == 1
+        IF    ${matching_active_elements} == 1            BREAK
         Press Keys    None    DOWN
         Sleep    0.1s
     END
@@ -408,12 +412,14 @@ Select Completer Suggestion
 
 Completer Should Suggest
     [Arguments]    ${text}    ${timeout}=10s
-    Wait Until Page Contains Element    ${COMPLETER_BOX} .jp-Completer-item[data-value="${text}"]    timeout=${timeout}
+    Wait Until Page Contains Element
+    ...    ${COMPLETER_BOX} .jp-Completer-item[data-value="${text}"]
+    ...    timeout=${timeout}
 
 Get Completion Item Vertical Position
     [Arguments]    ${text}
     ${position} =    Get Vertical Position    ${COMPLETER_BOX} .jp-Completer-item[data-value="${text}"]
-    [Return]    ${position}
+    RETURN    ${position}
 
 Completer Should Include Icon
     [Arguments]    ${icon}
@@ -437,7 +443,7 @@ Completer Should Include Documentation
 
 Count Completer Hints
     ${count} =    Get Element Count    css:.jp-Completer-item
-    [Return]    ${count}
+    RETURN    ${count}
 
 Should Complete While Kernel Is Busy
     # Run the cell with sleep(20)
@@ -446,12 +452,20 @@ Should Complete While Kernel Is Busy
     # Lab Command    Run Selected Cells And Don't Advance
     Press Keys    None    CTRL+ENTER
     # Confirm that the kernel is busy
-    Wait Until Page Contains Element    ${KERNEL_BUSY_INDICATOR}    timeout=5s
+    IF    '${LAB VERSION}'.startswith('3.4')
+        Wait Until Page Contains Element    ${KERNEL_BUSY_INDICATOR}    timeout=5s
+    ELSE
+        Wait Until Page Contains Element    ${KERNEL_BUSY_INDCA_OLD}    timeout=5s
+    END
     # Enter a cell with "t"
     Enter Cell Editor    18
     # Check if completion worked
     Enter Cell Editor    1    line=2
     Trigger Completer    timeout=10s
     Completer Should Suggest    test
     # Confirm that the kernel indicator was busy all along
-    Page Should Contain Element    ${KERNEL_BUSY_INDICATOR}
+    IF    '${LAB VERSION}'.startswith('3.4')
+        Page Should Contain Element    ${KERNEL_BUSY_INDICATOR}
+    ELSE
+        Page Should Contain Element    ${KERNEL_BUSY_INDCA_OLD}
+    END

atest/05_Features/Diagnostics.robot

@@ -8,6 +8,7 @@ Test Teardown       Clean Up After Working With File    Diagnostic.ipynb
 Force Tags          feature:diagnostics
 # note: diagnostics are also tested in 01_Editor and 04_Interface/DiagnosticsPanel.robot
 
+
 *** Test Cases ***
 Diagnostics with deprecated tag have strike-through decoration
     Wait Until Page Contains Element    css:.cm-lsp-diagnostic[title*="is deprecated"]    timeout=25s

atest/05_Features/Highlights.robot

@@ -7,6 +7,7 @@ Test Teardown       Clean Up After Working With File    Highlights.ipynb
 
 Force Tags          feature:highlights
 
+
 *** Test Cases ***
 # cursor is symbolized by pipe (|), for example when
 # it is at the end of line, after `1` in `test = 1`
@@ -60,6 +61,7 @@ Highlights are removed when no cell is focused
     Blur Cell Editor    1
     Should Highlight Token    test
 
+
 *** Keywords ***
 Should Not Highlight Any Tokens
     Page Should Not Contain    css:.cm-lsp-highlight