Fix e2e tests (#4106)

* attempt to scroll to the bottom of the SCM view

* try using the arrow keys to bring items into view

* tidy up util code

Author: mattseddon

extension/src/test/e2e/extension.test.ts

@@ -4,7 +4,7 @@ import {
   closeAllEditors,
   createCustomPlot,
   deleteAllExistingExperiments,
-  deleteCustomPlot,
+  deleteCustomPlots,
   dismissAllNotifications,
   expectAllPlotsToBeFilled,
   findDecorationTooltip,
@@ -29,9 +29,7 @@ before('should finish loading the extension', async function () {
 after(async function () {
   this.timeout(60000)
 
-  try {
-    await deleteCustomPlot()
-  } catch {}
+  await deleteCustomPlots()
   await dismissAllNotifications()
 
   return waitForDvcToFinish()
@@ -175,7 +173,7 @@ describe('Plots Webview', function () {
     await webview.unfocus()
     await closeAllEditors()
 
-    await deleteCustomPlot()
+    await deleteCustomPlots()
     await workbench.executeCommand('DVC: Show Plots')
 
     await waitForDvcToFinish()
@@ -230,12 +228,16 @@ describe('Source Control View', function () {
           const tooltip = await findDecorationTooltip(treeItem)
           expect(tooltip).toBeTruthy()
         }
-        return dvcTreeItemLabels.length > 0
+        return expectedScmItemLabels.length === dvcTreeItemLabels.length
       },
       {
         interval: 5000,
         timeout: 60000
       }
     )
+
+    expectedScmItemLabels.sort()
+    dvcTreeItemLabels.sort()
+    expect(expectedScmItemLabels).toStrictEqual(dvcTreeItemLabels)
   })
 })

extension/src/test/e2e/util.ts

@@ -1,6 +1,6 @@
 import { Key } from 'webdriverio'
 import { $$, browser } from '@wdio/globals'
-import { ViewControl } from 'wdio-vscode-service'
+import { ViewControl, Workbench } from 'wdio-vscode-service'
 import { PlotsWebview } from './pageObjects/plotsWebview.js'
 
 const findProgressBars = () => $$('.monaco-progress-container')
@@ -17,8 +17,8 @@ export const dismissAllNotifications = async (): Promise<void> => {
   await browser.waitUntil(async () => {
     const workbench = await browser.getWorkbench()
     const notifications = await workbench.getNotifications()
-    for (const n of notifications) {
-      await n.dismiss()
+    for (const notification of notifications) {
+      await notification.dismiss()
     }
     const openNotifications = await workbench.getNotifications()
     return openNotifications.length === 0
@@ -35,6 +35,50 @@ const dvcIsWorking = async (): Promise<boolean> => {
   )
 }
 
+const notificationShown = async (
+  workbench: Workbench,
+  message: string
+): Promise<boolean> => {
+  const notifications = await workbench.getNotifications()
+  return notifications.some(
+    async notification => (await notification.elem.getText()) === message
+  )
+}
+
+const runDeleteCommand = async (
+  command: string,
+  nothingToDeleteMessage: string
+): Promise<void> => {
+  const workbench = await browser.getWorkbench()
+  const commandPalette = await workbench.executeCommand(command)
+
+  let nothingToDelete = false
+
+  await browser.waitUntil(async () => {
+    if (await notificationShown(workbench, nothingToDeleteMessage)) {
+      nothingToDelete = true
+      return true
+    }
+
+    return commandPalette.elem.isDisplayed()
+  })
+
+  if (nothingToDelete) {
+    return
+  }
+  await browser
+    .action('key')
+    .down(Key.Shift)
+    .down(Key.Tab)
+    .up(Key.Tab)
+    .up(Key.Shift)
+    .perform()
+
+  await browser.keys('Space')
+
+  return browser.keys('Enter')
+}
+
 export const waitForDvcToFinish = async (timeout = 60000): Promise<void> => {
   await browser.waitUntil(async () => !(await dvcIsWorking()), {
     timeout
@@ -100,32 +144,12 @@ export const waitForViewContainerToLoad = async (): Promise<void> => {
   )
 }
 
-export const deleteAllExistingExperiments = async () => {
-  const workbench = await browser.getWorkbench()
-
-  const deleteNonWorkspaceExperiments = await workbench.executeCommand(
-    'DVC: Remove Experiment(s)'
+export const deleteAllExistingExperiments = (): Promise<void> =>
+  runDeleteCommand(
+    'DVC: Remove Experiment(s)',
+    'There are no experiments to select.'
   )
 
-  try {
-    await browser.waitUntil(() =>
-      deleteNonWorkspaceExperiments.elem.isDisplayed()
-    )
-
-    await browser
-      .action('key')
-      .down(Key.Shift)
-      .down(Key.Tab)
-      .up(Key.Tab)
-      .up(Key.Shift)
-      .perform()
-
-    await browser.keys('Space')
-
-    return browser.keys('Enter')
-  } catch {}
-}
-
 export const runModifiedExperiment = async () => {
   const workbench = await browser.getWorkbench()
   const options = await workbench.executeCommand(
@@ -142,7 +166,10 @@ export const runModifiedExperiment = async () => {
     .up(Key.Enter)
     .pause(100)
     .perform()
-  await browser.keys([...'0.005', 'Enter'])
+
+  const nonCachedParam = `0.00${Date.now()}`
+
+  await browser.keys([...nonCachedParam, 'Enter'])
   return workbench.executeCommand('DVC: Show Experiments')
 }
 
@@ -161,16 +188,11 @@ export const createCustomPlot = async (): Promise<void> => {
   return browser.keys('Enter')
 }
 
-export const deleteCustomPlot = async (): Promise<void> => {
-  const workbench = await browser.getWorkbench()
-  const removeCustomPlot = await workbench.executeCommand(
-    'DVC: Remove Custom Plot(s)'
+export const deleteCustomPlots = (): Promise<void> =>
+  runDeleteCommand(
+    'DVC: Remove Custom Plot(s)',
+    'There are no plots to remove.'
   )
-  await browser.waitUntil(() => removeCustomPlot.elem.isDisplayed())
-  await browser.keys('ArrowDown')
-  await browser.keys('Space')
-  return browser.keys('Enter')
-}
 
 export const waitForAllPlotsToRender = (
   webview: PlotsWebview,
@@ -193,11 +215,19 @@ export const expectAllPlotsToBeFilled = async (webview: PlotsWebview) => {
 }
 
 export const findScmTreeItems = async () => {
-  const workspace = await browser.getWorkbench()
-  const activityBar = workspace.getActivityBar()
+  const workbench = await browser.getWorkbench()
+  const activityBar = workbench.getActivityBar()
   const sourceControlIcon = await activityBar.getViewControl('Source Control')
 
   await sourceControlIcon?.openView()
 
+  const visibleItems = await findCurrentTreeItems()
+
+  await visibleItems[visibleItems.length - 1].click()
+
+  for (let i = 0; i < 20; i++) {
+    await browser.keys('ArrowDown')
+  }
+
   return findCurrentTreeItems()
 }