add tests for new refresh button

Author: Hweinstock

packages/core/src/shared/ui/common/regionSubmenu.ts

@@ -52,7 +52,7 @@ export class RegionSubmenu<T> extends Prompter<RegionSubmenuResponse<T>> {
         super()
     }
 
-    private refresh(prompter: QuickPickPrompter<T | typeof switchRegion>): void {
+    public refresh(prompter: QuickPickPrompter<T | typeof switchRegion>): void {
         // This method cannot be async due to onClick() specifications. Thus we are forced to use .then, .catch as workaround.
         const activeBefore = prompter.quickPick.activeItems
         prompter

packages/core/src/test/shared/ui/prompters/regionSubmenu.test.ts

@@ -4,6 +4,7 @@
  */
 
 import assert from 'assert'
+import * as sinon from 'sinon'
 import { RegionSubmenu } from '../../../../shared/ui/common/regionSubmenu'
 import { DataQuickPickItem, QuickPickPrompter } from '../../../../shared/ui/pickerPrompter'
 import { createQuickPickPrompterTester } from '../../../shared/ui/testUtils'
@@ -12,7 +13,7 @@ describe('regionSubmenu', function () {
     let submenuPrompter: RegionSubmenu<string>
 
     const region1Data = ['option1a', 'option2a', 'option3a']
-    const region2Data = ['option1b', 'option2b', 'option3b']
+    let region2Data = ['option1b', 'option2b', 'option3b']
 
     before(async function () {
         const mockDataProvider = function (regionCode: string) {
@@ -64,4 +65,34 @@ describe('regionSubmenu', function () {
             data: 'option2b',
         })
     })
+
+    it('only has a refresh button', function () {
+        const activeButtons = submenuPrompter.activePrompter!.quickPick.buttons
+        assert.strictEqual(activeButtons.length, 1)
+    })
+
+    it('refresh button calls refresh once onClick', function () {
+        const refreshButton = submenuPrompter.activePrompter!.quickPick.buttons[0]
+        const refreshStub = sinon.stub(RegionSubmenu.prototype, 'refresh')
+        refreshButton.onClick!()
+        sinon.assert.calledOnce(refreshStub)
+        sinon.restore()
+    })
+
+    it('refresh reloads items', async function () {
+        const itemsBeforeLabels = submenuPrompter.activePrompter!.quickPick.items.map((i) => i.label)
+        region2Data = ['option1c', 'option2c', 'option3c']
+
+        // Note that onDidChangeBusy event fires with busy=false when we load new items in.
+        // Since regionSubmenu retroactively adds the default items, they won't be there yet.
+        // So we don't check for them in test to avoid looking at implementation level details.
+        submenuPrompter.activePrompter!.onDidChangeBusy((b: boolean) => {
+            if (!b) {
+                const itemsAfterLabels = submenuPrompter.activePrompter!.quickPick.items.map((i) => i.label)
+                region2Data.forEach((item) => assert(itemsAfterLabels.includes(item)))
+                assert.notStrictEqual(itemsBeforeLabels, itemsAfterLabels)
+            }
+        })
+        submenuPrompter.refresh(submenuPrompter.activePrompter! as QuickPickPrompter<any>)
+    })
 })