refresh timer management tests in debug tracker

Signed-off-by: Jens Reinecke <[email protected]>

Author: jreineckearm

src/debug-session/gdbtarget-debug-tracker.test.ts

@@ -247,4 +247,79 @@ describe('GDBTargetDebugTracker', () => {
 
     });
 
+    describe('refresh timer management', () => {
+        let adapterFactory: vscode.DebugAdapterTrackerFactory|undefined;
+        let gdbSession: GDBTargetDebugSession|undefined = undefined;
+        let tracker: vscode.DebugAdapterTracker|undefined|null = undefined;
+
+        beforeEach(async () => {
+            adapterFactory = undefined;
+            gdbSession = undefined;
+            tracker = undefined;
+            (vscode.debug.registerDebugAdapterTrackerFactory as jest.Mock).mockImplementation((_debugType: string, factory: vscode.DebugAdapterTrackerFactory): vscode.Disposable => {
+                adapterFactory = factory;
+                return { dispose: jest.fn() };
+            });
+            debugTracker.activate(contextMock);
+
+            debugTracker.onWillStartSession(session => gdbSession = session);
+            tracker = await adapterFactory!.createDebugAdapterTracker(debugSessionFactory(debugConfigurationFactory()));
+            tracker!.onWillStartSession!();
+            // Enable refresh timer
+            gdbSession!.refreshTimer.enabled = true;
+        });
+
+        const sendContinueEvent = () => {
+            // Send continued event
+            const continuedEvent: DebugProtocol.ContinuedEvent = {
+                event: 'continued',
+                type: 'event',
+                seq: 1,
+                body: {
+                    threadId: 1
+                }
+            };
+            tracker!.onDidSendMessage!(continuedEvent);
+        };
+
+        const sendStoppedEvent = () => {
+            // Send stopped event
+            const stoppedEvent: DebugProtocol.StoppedEvent = {
+                event: 'stopped',
+                type: 'event',
+                seq: 1,
+                body: {
+                    reason: 'step'
+                }
+            };
+            tracker!.onDidSendMessage!(stoppedEvent);
+        };
+
+        it.each([
+            { eventName: 'stopped', eventData: { event: 'stopped', type: 'event', seq: 1, body: { reason: 'step' } } },
+            { eventName: 'terminated', eventData: { event: 'terminated', type: 'event', seq: 1, body: { } } }, // Does't pass optional 'restart' property
+            { eventName: 'exited', eventData: { event: 'exited', type: 'event', seq: 1, body: { exitCode: 0 } } },
+        ])('starts refresh timer on session continued event, and stops on $eventName event', async ({ eventData }) => {
+            expect(gdbSession).toBeDefined();
+            sendContinueEvent();
+            expect(gdbSession!.refreshTimer.isRunning).toBe(true);
+            // Send event supposed to stop the timer
+            tracker!.onDidSendMessage!(eventData);
+            expect(gdbSession!.refreshTimer.isRunning).toBe(false);
+        });
+
+        it.each([
+            { requestName: 'next', requestArguments: { command: 'next', type: 'request', seq: 1, arguments: { threadId: 1 } } },
+            { requestName: 'stepIn', requestArguments: { command: 'stepIn', type: 'request', seq: 1, arguments: { threadId: 1 } } },
+            { requestName: 'stepOut', requestArguments: { command: 'stepOut', type: 'request', seq: 1, arguments: { threadId: 1  } } },
+        ])('starts refresh timer on $requestName request, and stops on stoppedEvent', async ({ requestArguments }) => {
+            expect(gdbSession).toBeDefined();
+            tracker!.onWillReceiveMessage!(requestArguments);
+            expect(gdbSession!.refreshTimer.isRunning).toBe(true);
+            // Send event supposed to stop the timer
+            sendStoppedEvent();
+            expect(gdbSession!.refreshTimer.isRunning).toBe(false);
+        });
+    });
+
 });