fix(tests): properly mock DocumentDBClient to satisfy TypeScript requirements

Author: Muzaffer Aydin

packages/core/src/test/docdb/explorer/dbClusterNode.test.ts

@@ -14,7 +14,11 @@ import { DBInstance, DocumentDBClient } from '../../../shared/clients/docdbClien
 describe('DBClusterNode', function () {
     let mockClient: DocumentDBClient
     beforeEach(() => {
-        mockClient = {} as DocumentDBClient
+        mockClient = {
+            listClusters: sinon.stub().resolves([]), // Mock implementation
+            listInstances: sinon.stub().resolves([]), // Mock implementation
+        } as Partial<DocumentDBClient> as DocumentDBClient
+
         DBClusterNode['globalPollingArns'].clear()
     })
 
@@ -33,7 +37,7 @@ describe('DBClusterNode', function () {
     }
 
     it('gets children', async function () {
-        mockClient.listInstances = sinon.stub().resolves([instanceA, instanceB])
+        ;(mockClient.listInstances as sinon.SinonStub) = sinon.stub().resolves([instanceA, instanceB])
         const node = new DBClusterNode(parentNode, cluster, mockClient)
         const [firstInstanceNode, secondInstanceNode, ...otherNodes] = await node.getChildren()
 
@@ -44,17 +48,17 @@ describe('DBClusterNode', function () {
 
     it('returns false for available status', function () {
         const clusterStatus = { ...cluster, Status: 'available' }
-        const node = new DBClusterNode(parentNode, clusterStatus, mockClient)
 
+        const node = new DBClusterNode(parentNode, clusterStatus, mockClient)
         const requiresPolling = node.isStatusRequiringPolling()
 
         assert.strictEqual(requiresPolling, false, 'isStatusRequiringPolling should return false for available status')
     })
 
     it('returns true for creating status', function () {
         const clusterStatus = { ...cluster, Status: 'creating' }
-        const node = new DBClusterNode(parentNode, clusterStatus, mockClient)
 
+        const node = new DBClusterNode(parentNode, clusterStatus, mockClient)
         const requiresPolling = node.isStatusRequiringPolling()
 
         assert.strictEqual(requiresPolling, true, 'isStatusRequiringPolling should return true for creating status')
@@ -64,18 +68,11 @@ describe('DBClusterNode', function () {
         const clusterStatus = { ...cluster, Status: 'creating' }
 
         const trackChangesSpy = sinon.spy(DBClusterNode.prototype, 'trackChanges')
-
-        // Initialize the node with a status that requires polling
         const node = new DBClusterNode(parentNode, clusterStatus, mockClient)
-
-        // Check the result of isStatusRequiringPolling
         const requiresPolling = node.isStatusRequiringPolling()
-        assert.strictEqual(requiresPolling, true, 'isStatusRequiringPolling should return true for creating status')
 
-        // Assert that trackChanges was called
+        assert.strictEqual(requiresPolling, true, 'isStatusRequiringPolling should return true for creating status')
         assert.ok(trackChangesSpy.calledOnce, 'trackChanges should be called when polling is required')
-
-        // Verify the node is in the polling state
         assert.strictEqual(node.isPolling, true, 'Node should be in polling state')
 
         trackChangesSpy.restore()
@@ -85,18 +82,11 @@ describe('DBClusterNode', function () {
         const clusterStatus = { ...cluster, Status: 'available' }
 
         const trackChangesSpy = sinon.spy(DBClusterNode.prototype, 'trackChanges')
-
-        // Initialize the node with a status that does not require polling
         const node = new DBClusterNode(parentNode, clusterStatus, mockClient)
-
-        // Check the result of isStatusRequiringPolling
         const requiresPolling = node.isStatusRequiringPolling()
-        assert.strictEqual(requiresPolling, false, 'isStatusRequiringPolling should return false for available status')
 
-        // Assert that trackChanges was not called
+        assert.strictEqual(requiresPolling, false, 'isStatusRequiringPolling should return false for available status')
         assert.ok(trackChangesSpy.notCalled, 'trackChanges should not be called when polling is not required')
-
-        // Verify the node is not in the polling state
         assert.strictEqual(node.isPolling, false, 'Node should not be in polling state')
 
         trackChangesSpy.restore()
@@ -106,36 +96,23 @@ describe('DBClusterNode', function () {
         const clusterStatus = { ...cluster, Status: 'available' }
 
         const trackChangesSpy = sinon.spy(DBClusterNode.prototype, 'trackChanges')
-
-        // Initialize the node with a status that does not require polling
         const node = new DBClusterNode(parentNode, clusterStatus, mockClient)
-
-        // Check the result of isStatusRequiringPolling
         const requiresPolling = node.isStatusRequiringPolling()
-        assert.strictEqual(requiresPolling, false, 'isStatusRequiringPolling should return false for available status')
 
-        // Assert that trackChanges was not called
+        assert.strictEqual(requiresPolling, false, 'isStatusRequiringPolling should return false for available status')
         assert.ok(trackChangesSpy.notCalled, 'trackChanges should not be called when polling is not required')
-
-        // Verify the node is not in the polling state
         assert.strictEqual(node.isPolling, false, 'Node should not be in polling state')
 
         trackChangesSpy.restore()
     })
 
     it('has isPolling set to false and getStatus returns available when status is available', async function () {
         const clusterStatus = { ...cluster, Status: 'available' }
-
-        // Mock the DocumentDB client to return the status
         mockClient.listClusters = sinon.stub().resolves([clusterStatus])
 
-        // Initialize the node with a status of 'available'
         const node = new DBClusterNode(parentNode, clusterStatus, mockClient)
 
-        // Verify the node is not in the polling state
         assert.strictEqual(node.isPolling, false, 'Node should not be in polling state')
-
-        // Get the status from the node and verify it is 'available'
         assert.strictEqual(node.status, 'available', 'getStatus should return available for the node')
     })
 })