Update config tests (#4400)

Author: mattseddon

extension/src/test/suite/config.test.ts

@@ -23,15 +23,42 @@ suite('Config Test Suite', () => {
     return setConfigValue(ConfigKey.FOCUSED_PROJECTS, undefined)
   })
 
+  const mockDvcMonoRepo = Uri.file(resolve(dvcDemoPath)).fsPath
+  const mockDvcSubRoot1 = Uri.file(join(mockDvcMonoRepo, 'data')).fsPath
+  const mockDvcSubRoot2 = Uri.file(join(mockDvcMonoRepo, '.dvc')).fsPath
+
+  const buildConfig = async () => {
+    const extensionsChanged = disposable.track(new EventEmitter<void>())
+    const config = disposable.track(new Config(extensionsChanged.event))
+    await config.isReady()
+
+    const mockGetWorkspaceFolders = stub(
+      WorkspaceFolders,
+      'getWorkspaceFolders'
+    ).returns([mockDvcMonoRepo])
+
+    return { config, extensionsChanged, mockGetWorkspaceFolders }
+  }
+
+  const getConfigUpdatedPromise = () =>
+    new Promise(resolve => {
+      const singleUseListener = workspace.onDidChangeConfiguration(e => {
+        if (e.affectsConfiguration(ConfigKey.FOCUSED_PROJECTS)) {
+          resolve(undefined)
+          disposable.untrack(singleUseListener)
+          singleUseListener.dispose()
+        }
+      })
+      disposable.track(singleUseListener)
+    })
+
   describe('Config', () => {
     it('should re-fetch the python extension API (and execution details) if any extensions are enabled/disabled or installed/uninstalled', async () => {
       const mockGetExtensionAPI = stub(Extensions, 'getExtensionAPI').resolves(
         undefined
       )
 
-      const extensionsChanged = disposable.track(new EventEmitter<void>())
-
-      const config = disposable.track(new Config(extensionsChanged.event))
+      const { config, extensionsChanged } = await buildConfig()
       expect(mockGetExtensionAPI).to.be.called
       expect(config.getPythonBinPath()).to.be.undefined
 
@@ -52,113 +79,79 @@ suite('Config Test Suite', () => {
       expect(config.getPythonBinPath()).to.equal(pythonBinPath)
     })
 
-    it('should fire an event if dvc.focusedProjects is changed', async () => {
-      const getConfigUpdatedPromise = () =>
-        new Promise(resolve => {
-          const singleUseListener = workspace.onDidChangeConfiguration(e => {
-            if (e.affectsConfiguration(ConfigKey.FOCUSED_PROJECTS)) {
-              resolve(undefined)
-              disposable.untrack(singleUseListener)
-              singleUseListener.dispose()
-            }
-          })
-          disposable.track(singleUseListener)
-        })
-
-      const extensionsChanged = disposable.track(new EventEmitter<void>())
-      const config = disposable.track(new Config(extensionsChanged.event))
-      await config.isReady()
-
-      let configUpdated = getConfigUpdatedPromise()
-      const mockDvcMonoRepo = Uri.file(resolve(dvcDemoPath)).fsPath
-      const mockGetWorkspaceFolders = stub(
-        WorkspaceFolders,
-        'getWorkspaceFolders'
-      ).returns([mockDvcMonoRepo])
-      const mockDvcSubRoot1 = Uri.file(join(mockDvcMonoRepo, 'data')).fsPath
-      const mockDvcSubRoot2 = Uri.file(join(mockDvcMonoRepo, '.dvc')).fsPath
+    it('should be able to focus a project if it is inside of the workspace', async () => {
+      const { config } = await buildConfig()
+      const configUpdated = getConfigUpdatedPromise()
 
       await setConfigValue(ConfigKey.FOCUSED_PROJECTS, mockDvcSubRoot1)
       await configUpdated
 
-      expect(
-        config.getFocusedProjects(),
-        'should set the focused project to the root if it is inside of the workspace'
-      ).to.deep.equal([mockDvcSubRoot1])
-
-      configUpdated = getConfigUpdatedPromise()
-
-      await setConfigValue(ConfigKey.FOCUSED_PROJECTS, [mockDvcSubRoot1])
-      await configUpdated
-
-      expect(
-        config.getFocusedProjects(),
-        'should not call setup if the value(s) inside of the option have not changed'
-      ).to.deep.equal([mockDvcSubRoot1])
+      expect(config.getFocusedProjects()).to.deep.equal([mockDvcSubRoot1])
+    })
 
-      configUpdated = getConfigUpdatedPromise()
+    it('should be able to focus multiple sub-projects', async () => {
+      const { config } = await buildConfig()
+      const configUpdated = getConfigUpdatedPromise()
 
       await setConfigValue(ConfigKey.FOCUSED_PROJECTS, [
         mockDvcSubRoot1,
         mockDvcSubRoot2
       ])
       await configUpdated
 
-      expect(
-        config.getFocusedProjects(),
-        'should be able to focus multiple sub-projects'
-      ).to.deep.equal([mockDvcSubRoot1, mockDvcSubRoot2].sort())
+      expect(config.getFocusedProjects()).to.deep.equal(
+        [mockDvcSubRoot1, mockDvcSubRoot2].sort()
+      )
+    })
+
+    it('should be able to focus multiple sub-projects along with the monorepo root', async () => {
+      const { config } = await buildConfig()
+      const configUpdated = getConfigUpdatedPromise()
 
       await setConfigValue(ConfigKey.FOCUSED_PROJECTS, [
         mockDvcSubRoot2,
-        mockDvcSubRoot1
+        mockDvcSubRoot1,
+        mockDvcMonoRepo
       ])
       await configUpdated
 
-      expect(
-        config.getFocusedProjects(),
-        'should not call setup if the value(s) inside of the option have not changed'
-      ).to.deep.equal([mockDvcSubRoot1, mockDvcSubRoot2].sort())
+      expect(config.getFocusedProjects()).to.deep.equal(
+        [mockDvcMonoRepo, mockDvcSubRoot1, mockDvcSubRoot2].sort()
+      )
+    })
+
+    it('should be able to unfocus projects', async () => {
+      const { config } = await buildConfig()
+      const configSet = getConfigUpdatedPromise()
 
       await setConfigValue(ConfigKey.FOCUSED_PROJECTS, [
         mockDvcSubRoot2,
         mockDvcSubRoot1,
         mockDvcMonoRepo
       ])
-      await configUpdated
+      await configSet
 
-      expect(
-        config.getFocusedProjects(),
-        'should be able to focus multiple sub-projects along with the monorepo root'
-      ).to.deep.equal(
+      expect(config.getFocusedProjects()).to.deep.equal(
         [mockDvcMonoRepo, mockDvcSubRoot1, mockDvcSubRoot2].sort()
       )
 
-      await setConfigValue(ConfigKey.FOCUSED_PROJECTS, undefined)
-      await configUpdated
-
-      expect(
-        config.getFocusedProjects(),
-        'should be able to unset the option'
-      ).to.equal(undefined)
+      const configUpdated = getConfigUpdatedPromise()
 
-      await setConfigValue(ConfigKey.FOCUSED_PROJECTS, null)
+      await setConfigValue(ConfigKey.FOCUSED_PROJECTS, undefined)
       await configUpdated
 
-      expect(
-        config.getFocusedProjects(),
-        'should be able to set the option to the default value'
-      ).to.equal(undefined)
+      expect(config.getFocusedProjects()).to.equal(undefined)
+    })
 
+    it('should not focus projects that are outside of the workspace', async () => {
+      const { config, mockGetWorkspaceFolders } = await buildConfig()
+      const configUpdated = getConfigUpdatedPromise()
       mockGetWorkspaceFolders.restore()
 
       await setConfigValue(ConfigKey.FOCUSED_PROJECTS, ['a', 'b', 'c'])
       await configUpdated
 
-      expect(
-        config.getFocusedProjects(),
-        'should exclude projects that are outside of the workspace'
-      ).to.equal(undefined)
-    }).timeout(10000)
+      expect(config.getFocusedProjects()).to.equal(undefined)
+    })
   })
 })