Only open experiments webview in integration tests when necessary (#4434)

Author: mattseddon

extension/src/test/suite/experiments/columns/tree.test.ts

@@ -10,7 +10,7 @@ import {
   appendColumnToPath,
   buildMetricOrParamPath
 } from '../../../../experiments/columns/paths'
-import { buildExperiments, stubWorkspaceExperimentsGetters } from '../util'
+import { buildExperiments, stubWorkspaceGetters } from '../util'
 import { Status } from '../../../../path/selection/model'
 import { ColumnType } from '../../../../experiments/webview/contract'
 import {
@@ -356,8 +356,9 @@ suite('Experiments Columns Tree Test Suite', () => {
     })
 
     it('should be able to display selected columns first with dvc.views.experiments.selectFirstColumns', async () => {
-      const { columnsModel, experiments } =
-        await stubWorkspaceExperimentsGetters(disposable)
+      const { columnsModel, experiments } = await stubWorkspaceGetters(
+        disposable
+      )
 
       const columnsOrder = columnsModel.getColumnOrder()
 

extension/src/test/suite/experiments/index.test.ts

@@ -19,7 +19,7 @@ import {
   DEFAULT_EXPERIMENTS_OUTPUT,
   buildExperiments,
   buildExperimentsWebview,
-  stubWorkspaceExperimentsGetters
+  stubWorkspaceGettersWebview
 } from './util'
 import { Disposable } from '../../../extension'
 import expShowFixture from '../../fixtures/expShow/base/output'
@@ -469,7 +469,7 @@ suite('Experiments Test Suite', () => {
     }).timeout(WEBVIEW_TEST_TIMEOUT)
 
     it('should be able to handle a message to apply an experiment', async () => {
-      const { mockMessageReceived } = await stubWorkspaceExperimentsGetters(
+      const { mockMessageReceived } = await stubWorkspaceGettersWebview(
         disposable
       )
 
@@ -493,7 +493,7 @@ suite('Experiments Test Suite', () => {
     }).timeout(WEBVIEW_TEST_TIMEOUT)
 
     it('should be able to handle a message to create a branch from an experiment', async () => {
-      const { mockMessageReceived } = await stubWorkspaceExperimentsGetters(
+      const { mockMessageReceived } = await stubWorkspaceGettersWebview(
         disposable
       )
 
@@ -556,7 +556,7 @@ suite('Experiments Test Suite', () => {
 
     it('should handle a message to push an experiment', async () => {
       const { experiments, mockMessageReceived } =
-        await stubWorkspaceExperimentsGetters(disposable)
+        await stubWorkspaceGettersWebview(disposable)
 
       const mockExpId = 'exp-e7a67'
 
@@ -643,7 +643,7 @@ suite('Experiments Test Suite', () => {
 
     it('should be able to handle a message to modify the workspace params and queue an experiment', async () => {
       const { experiments, dvcExecutor, mockMessageReceived } =
-        await stubWorkspaceExperimentsGetters(disposable)
+        await stubWorkspaceGettersWebview(disposable)
 
       const mockModifiedParams = [
         '-S',
@@ -672,7 +672,7 @@ suite('Experiments Test Suite', () => {
 
     it('should be able to handle a message to modify the workspace params and run a new experiment', async () => {
       const { experiments, dvcRunner, mockMessageReceived } =
-        await stubWorkspaceExperimentsGetters(disposable)
+        await stubWorkspaceGettersWebview(disposable)
 
       const mockModifiedParams = [
         '-S',
@@ -702,7 +702,7 @@ suite('Experiments Test Suite', () => {
 
     it('should be able to handle a message to modify the workspace params, reset and run a new experiment', async () => {
       const { experiments, dvcRunner, mockMessageReceived } =
-        await stubWorkspaceExperimentsGetters(disposable)
+        await stubWorkspaceGettersWebview(disposable)
 
       const mockModifiedParams = [
         '-S',
@@ -757,8 +757,8 @@ suite('Experiments Test Suite', () => {
     }).timeout(WEBVIEW_TEST_TIMEOUT)
 
     it("should be able to handle a message to toggle an experiment's status", async () => {
-      const { experiments, experimentsModel } =
-        await stubWorkspaceExperimentsGetters(disposable)
+      const { experimentsModel, mockMessageReceived } =
+        await stubWorkspaceGettersWebview(disposable)
 
       const idToToggle = 'test-branch'
       const runningInQueueId = 'exp-e7a67'
@@ -782,8 +782,6 @@ suite('Experiments Test Suite', () => {
         'queued experiment cannot be selected'
       ).to.be.false
 
-      const webview = await experiments.showWebview()
-      const mockMessageReceived = getMessageReceivedEmitter(webview)
       const toggleSpy = spy(experimentsModel, 'toggleStatus')
 
       mockMessageReceived.fire({
@@ -1178,7 +1176,7 @@ suite('Experiments Test Suite', () => {
 
     it('should be able to handle a message to select experiments for plotting', async () => {
       const { experiments, experimentsModel, mockMessageReceived } =
-        await stubWorkspaceExperimentsGetters(disposable)
+        await stubWorkspaceGettersWebview(disposable)
 
       const queuedId = '90aea7f'
       const runningInQueueId = 'exp-e7a67'
@@ -1210,8 +1208,8 @@ suite('Experiments Test Suite', () => {
         dvc: true,
         experiments: true
       })
-      const { experiments, experimentsModel } =
-        await stubWorkspaceExperimentsGetters(disposable)
+      const { experiments, experimentsModel, mockMessageReceived } =
+        await stubWorkspaceGettersWebview(disposable)
       const mockShowPlots = stub(WorkspacePlots.prototype, 'showWebview')
 
       const dataSent = new Promise(resolve =>
@@ -1221,8 +1219,6 @@ suite('Experiments Test Suite', () => {
         })
       )
 
-      const webview = await experiments.showWebview()
-      const mockMessageReceived = getMessageReceivedEmitter(webview)
       const runningInQueueId = 'exp-e7a67'
       const mockExperimentIds = ['main', 'test-branch', runningInQueueId]
 
@@ -1293,7 +1289,7 @@ suite('Experiments Test Suite', () => {
 
     it('should handle a message to stop experiments running', async () => {
       const { dvcExecutor, mockMessageReceived } =
-        await stubWorkspaceExperimentsGetters(disposable)
+        await stubWorkspaceGettersWebview(disposable)
 
       const mockQueueKill = stub(dvcExecutor, 'queueKill')
       const mockStopProcesses = stub(ProcessExecution, 'stopProcesses')

extension/src/test/suite/experiments/model/filterBy/tree.test.ts

@@ -23,7 +23,11 @@ import {
 } from '../../../util'
 import { buildMetricOrParamPath } from '../../../../../experiments/columns/paths'
 import { RegisteredCommands } from '../../../../../commands/external'
-import { buildExperiments, stubWorkspaceExperimentsGetters } from '../../util'
+import {
+  buildExperiments,
+  stubWorkspaceGetters,
+  stubWorkspaceGettersWebview
+} from '../../util'
 import {
   ColumnType,
   TableData
@@ -61,7 +65,7 @@ suite('Experiments Filter By Tree Test Suite', () => {
     })
 
     it('should be able to update the table data by adding and removing a filter', async () => {
-      const { experiments, messageSpy } = await stubWorkspaceExperimentsGetters(
+      const { experiments, messageSpy } = await stubWorkspaceGettersWebview(
         disposable
       )
 
@@ -131,7 +135,7 @@ suite('Experiments Filter By Tree Test Suite', () => {
     }).timeout(WEBVIEW_TEST_TIMEOUT)
 
     it('should be able to remove all filters with dvc.views.experimentsFilterByTree.removeAllFilters', async () => {
-      const { experiments } = await stubWorkspaceExperimentsGetters(disposable)
+      const { experiments } = await stubWorkspaceGetters(disposable)
 
       const mockShowQuickPick = stub(window, 'showQuickPick')
       const mockShowInputBox = stub(window, 'showInputBox')
@@ -336,7 +340,7 @@ suite('Experiments Filter By Tree Test Suite', () => {
 
     it('should be able to filter to starred experiments', async () => {
       const { experiments, experimentsModel, messageSpy } =
-        await stubWorkspaceExperimentsGetters(disposable)
+        await stubWorkspaceGettersWebview(disposable)
 
       experimentsModel.toggleStars(['main'])
 
@@ -364,9 +368,7 @@ suite('Experiments Filter By Tree Test Suite', () => {
     }).timeout(WEBVIEW_TEST_TIMEOUT)
 
     it('should provide a shortcut to filter to starred experiments', async () => {
-      const { experimentsModel } = await stubWorkspaceExperimentsGetters(
-        disposable
-      )
+      const { experimentsModel } = await stubWorkspaceGetters(disposable)
 
       const mockAddFilter = stub(experimentsModel, 'addFilter')
 

extension/src/test/suite/experiments/model/sortBy/tree.test.ts

@@ -11,10 +11,7 @@ import {
   ColumnType
 } from '../../../../../experiments/webview/contract'
 import { QuickPickItemWithValue } from '../../../../../vscode/quickPick'
-import {
-  buildExperimentsWebview,
-  stubWorkspaceExperimentsGetters
-} from '../../util'
+import { buildExperimentsWebview, stubWorkspaceGetters } from '../../util'
 import { experimentsUpdatedEvent } from '../../../util'
 import { dvcDemoPath } from '../../../../util'
 import { generateTestExpShowOutput } from '../../../../util/experiments'
@@ -287,9 +284,7 @@ suite('Experiments Sort By Tree Test Suite', () => {
     }).timeout(WEBVIEW_TEST_TIMEOUT)
 
     it('should provide a shortcut to sort by starred experiments', async () => {
-      const { experimentsModel } = await stubWorkspaceExperimentsGetters(
-        disposable
-      )
+      const { experimentsModel } = await stubWorkspaceGetters(disposable)
 
       const mockAddSort = stub(experimentsModel, 'addSort')
 

extension/src/test/suite/experiments/model/tree.test.ts

@@ -26,7 +26,11 @@ import {
 } from '../../../../commands/external'
 import { buildPlots, buildPlotsWebview } from '../../plots/util'
 import { ExperimentsTree } from '../../../../experiments/model/tree'
-import { buildExperiments, stubWorkspaceExperimentsGetters } from '../util'
+import {
+  buildExperiments,
+  stubWorkspaceGetters,
+  stubWorkspaceGettersWebview
+} from '../util'
 import { WEBVIEW_TEST_TIMEOUT } from '../../timeouts'
 import {
   QuickPickItemWithValue,
@@ -331,7 +335,7 @@ suite('Experiments Tree Test Suite', () => {
 
     it('should be able to push an experiment with dvc.views.experimentsTree.pushExperiment', async () => {
       bypassProgressCloseDelay()
-      const { experiments } = await stubWorkspaceExperimentsGetters(disposable)
+      const { experiments } = await stubWorkspaceGettersWebview(disposable)
 
       const mockUpdate = stub(experiments, 'update').resolves(undefined)
 
@@ -360,9 +364,9 @@ suite('Experiments Tree Test Suite', () => {
 
     it('should be able to push the provided experiment with dvc.views.experimentsTree.pushExperiment (if no experiments are selected)', async () => {
       bypassProgressCloseDelay()
-      const mockExperiment = 'exp-to-push'
+      const { experiments } = await stubWorkspaceGetters(disposable)
 
-      const { experiments } = await stubWorkspaceExperimentsGetters(disposable)
+      const mockExperiment = 'exp-to-push'
 
       const mockUpdate = stub(experiments, 'update').resolves(undefined)
 
@@ -388,12 +392,12 @@ suite('Experiments Tree Test Suite', () => {
 
     it('should be able to push multiple experiments with dvc.views.experimentsTree.pushExperiment', async () => {
       bypassProgressCloseDelay()
+      const { experiments } = await stubWorkspaceGetters(disposable)
+
       const mockFirstExperimentId = 'first-exp-pushed'
       const mockSecondExperimentId = 'second-exp-pushed'
       const mockQueuedExperimentLabel = 'queued-excluded'
 
-      const { experiments } = await stubWorkspaceExperimentsGetters(disposable)
-
       const mockUpdate = stub(experiments, 'update').resolves(undefined)
 
       const mockExpPush = stub(DvcExecutor.prototype, 'expPush').resolves('')
@@ -571,7 +575,7 @@ suite('Experiments Tree Test Suite', () => {
 
     it('should be able to queue an experiment from an existing one with dvc.views.experiments.queueExperiment', async () => {
       const { dvcExecutor, experimentsModel, mockGetOnlyOrPickProject } =
-        await stubWorkspaceExperimentsGetters(disposable)
+        await stubWorkspaceGetters(disposable)
 
       const mockExperimentRunQueue = stub(dvcExecutor, 'expRunQueue').resolves(
         'true'
@@ -622,7 +626,7 @@ suite('Experiments Tree Test Suite', () => {
 
     it('should be able to run a new experiment from an existing one with dvc.views.experiments.runExperiment', async () => {
       const { dvcRunner, experimentsModel, mockGetOnlyOrPickProject } =
-        await stubWorkspaceExperimentsGetters(disposable)
+        await stubWorkspaceGetters(disposable)
 
       const mockRunExperiment = stub(dvcRunner, 'runExperiment').resolves(
         undefined
@@ -670,7 +674,7 @@ suite('Experiments Tree Test Suite', () => {
 
     it('should be able to reset and run a new checkpoint experiment from an existing one with dvc.views.experiments.resetAndRunCheckpointExperiment', async () => {
       const { dvcRunner, experimentsModel, mockGetOnlyOrPickProject } =
-        await stubWorkspaceExperimentsGetters(disposable)
+        await stubWorkspaceGetters(disposable)
 
       const mockRunExperimentReset = stub(
         dvcRunner,

extension/src/test/suite/experiments/util.ts

@@ -22,6 +22,7 @@ import { DEFAULT_CURRENT_BRANCH_COMMITS_TO_SHOW } from '../../../cli/dvc/constan
 import { PersistenceKey } from '../../../persistence/constants'
 import { ExpShowOutput } from '../../../cli/dvc/contract'
 import { buildExperimentsPipeline } from '../pipeline/util'
+import { Setup } from '../../../setup'
 
 export const DEFAULT_EXPERIMENTS_OUTPUT = {
   availableNbCommits: { main: 5 },
@@ -284,7 +285,53 @@ export const buildExperimentsData = (
   }
 }
 
-export const stubWorkspaceExperimentsGetters = async (
+const stubWorkspaceExperiments = (
+  dvcRoot: string,
+  experiments: Experiments
+) => {
+  const mockGetOnlyOrPickProject = stub(
+    WorkspaceExperiments.prototype,
+    'getOnlyOrPickProject'
+  ).resolves(dvcRoot)
+
+  const mockGetRepository = stub(
+    WorkspaceExperiments.prototype,
+    'getRepository'
+  ).returns(experiments)
+
+  return { mockGetOnlyOrPickProject, mockGetRepository }
+}
+
+export const stubWorkspaceGetters = async (
+  disposer: Disposer,
+  dvcRoot = dvcDemoPath
+) => {
+  const {
+    columnsModel,
+    dvcExecutor,
+    dvcRunner,
+    experiments,
+    experimentsModel
+  } = buildExperiments({ disposer })
+
+  await experiments.isReady()
+
+  stub(Setup.prototype, 'shouldBeShown').returns({
+    dvc: true,
+    experiments: true
+  })
+
+  return {
+    columnsModel,
+    dvcExecutor,
+    dvcRunner,
+    experiments,
+    experimentsModel,
+    ...stubWorkspaceExperiments(dvcRoot, experiments)
+  }
+}
+
+export const stubWorkspaceGettersWebview = async (
   disposer: Disposer,
   dvcRoot = dvcDemoPath
 ) => {
@@ -298,25 +345,14 @@ export const stubWorkspaceExperimentsGetters = async (
     mockMessageReceived
   } = await buildExperimentsWebview({ disposer })
 
-  const mockGetOnlyOrPickProject = stub(
-    WorkspaceExperiments.prototype,
-    'getOnlyOrPickProject'
-  ).resolves(dvcRoot)
-
-  const mockGetRepository = stub(
-    WorkspaceExperiments.prototype,
-    'getRepository'
-  ).returns(experiments)
-
   return {
     columnsModel,
     dvcExecutor,
     dvcRunner,
     experiments,
     experimentsModel,
     messageSpy,
-    mockGetOnlyOrPickProject,
-    mockGetRepository,
+    ...stubWorkspaceExperiments(dvcRoot, experiments),
     mockMessageReceived
   }
 }