Add basic integration tests for .deepnote file handling (GRN-4766) #99
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,166 @@ | ||||||
| /* eslint-disable @typescript-eslint/no-require-imports, @typescript-eslint/no-var-requires */ | ||||||
| import { assert } from 'chai'; | ||||||
| import { Uri, workspace, NotebookDocument } from 'vscode'; | ||||||
| import { IDisposable } from '../../../platform/common/types'; | ||||||
| import { captureScreenShot, IExtensionTestApi, waitForCondition } from '../../common.node'; | ||||||
| import { EXTENSION_ROOT_DIR_FOR_TESTS, initialize } from '../../initialize.node'; | ||||||
| import { closeNotebooksAndCleanUpAfterTests, startJupyterServer, getDefaultKernelConnection } from './helper.node'; | ||||||
| import { logger } from '../../../platform/logging'; | ||||||
| import { IDeepnoteNotebookManager } from '../../../notebooks/types'; | ||||||
| import { IKernel, IKernelProvider, INotebookKernelExecution } from '../../../kernels/types'; | ||||||
| import { createKernelController } from './executionHelper'; | ||||||
|
|
||||||
| /* eslint-disable @typescript-eslint/no-explicit-any, no-invalid-this */ | ||||||
| suite('Deepnote Integration Tests @kernelCore', function () { | ||||||
|
Contributor
There was a problem hiding this comment. Misleading suite tag. Suite is tagged -suite('Deepnote Integration Tests @kernelCore', function () {
+suite('Deepnote Integration Tests', function () {📝 Committable suggestion
Suggested change
🤖 Prompt for AI Agents |
||||||
| let api: IExtensionTestApi; | ||||||
| const disposables: IDisposable[] = []; | ||||||
| const deepnoteFilePath = Uri.joinPath( | ||||||
| Uri.file(EXTENSION_ROOT_DIR_FOR_TESTS), | ||||||
| 'src', | ||||||
| 'test', | ||||||
| 'datascience', | ||||||
| 'notebook', | ||||||
| 'test.deepnote' | ||||||
| ); | ||||||
| let nbDocument: NotebookDocument; | ||||||
| let kernel: IKernel; | ||||||
| let kernelExecution: INotebookKernelExecution; | ||||||
| this.timeout(240_000); | ||||||
|
|
||||||
| suiteSetup(async function () { | ||||||
| logger.info('Suite Setup VS Code Notebook - Deepnote Integration'); | ||||||
| this.timeout(240_000); | ||||||
| try { | ||||||
| api = await initialize(); | ||||||
| logger.info('After initialize'); | ||||||
|
|
||||||
| await startJupyterServer(); | ||||||
| logger.info('After starting Jupyter'); | ||||||
|
|
||||||
| const notebookManager = api.serviceContainer.get<IDeepnoteNotebookManager>(IDeepnoteNotebookManager); | ||||||
| notebookManager.selectNotebookForProject('test-project-id', 'main-notebook-id'); | ||||||
|
|
||||||
| nbDocument = await workspace.openNotebookDocument(deepnoteFilePath); | ||||||
| logger.info(`Opened notebook with ${nbDocument.cellCount} cells`); | ||||||
|
|
||||||
| const kernelProvider = api.serviceContainer.get<IKernelProvider>(IKernelProvider); | ||||||
| const metadata = await getDefaultKernelConnection(); | ||||||
| const controller = createKernelController(); | ||||||
| kernel = kernelProvider.getOrCreate(nbDocument, { metadata, resourceUri: nbDocument.uri, controller }); | ||||||
| logger.info('Before starting kernel'); | ||||||
| await kernel.start(); | ||||||
| logger.info('After starting kernel'); | ||||||
| kernelExecution = kernelProvider.getKernelExecution(kernel); | ||||||
|
|
||||||
| logger.info('Suite Setup (completed)'); | ||||||
| } catch (e) { | ||||||
| logger.error('Suite Setup (failed) - Deepnote Integration', e); | ||||||
| await captureScreenShot('deepnote-suite'); | ||||||
| throw e; | ||||||
| } | ||||||
| }); | ||||||
|
|
||||||
| setup(function () { | ||||||
| logger.info(`Start Test (completed) ${this.currentTest?.title}`); | ||||||
| }); | ||||||
|
|
||||||
| teardown(async function () { | ||||||
| if (this.currentTest?.isFailed()) { | ||||||
| await captureScreenShot(this); | ||||||
| } | ||||||
| logger.info(`Ended Test (completed) ${this.currentTest?.title}`); | ||||||
| }); | ||||||
|
|
||||||
| suiteTeardown(() => closeNotebooksAndCleanUpAfterTests(disposables)); | ||||||
|
|
||||||
| test('Load .deepnote file', async function () { | ||||||
| logger.debug('Test: Load .deepnote file - starting'); | ||||||
|
|
||||||
| assert.equal(nbDocument.notebookType, 'deepnote', 'Notebook type should be deepnote'); | ||||||
| assert.equal(nbDocument.cellCount, 3, 'Notebook should have 3 cells'); | ||||||
| assert.equal(nbDocument.metadata?.deepnoteProjectId, 'test-project-id', 'Project ID should match'); | ||||||
| assert.equal(nbDocument.metadata?.deepnoteNotebookId, 'main-notebook-id', 'Notebook ID should match'); | ||||||
|
|
||||||
| logger.debug('Test: Load .deepnote file - completed'); | ||||||
| }); | ||||||
|
|
||||||
| test('Execute code cell and verify output', async function () { | ||||||
| logger.debug('Test: Execute code cell - starting'); | ||||||
|
|
||||||
| const cell = nbDocument.cellAt(0); | ||||||
| assert.equal(cell.kind, 1, 'First cell should be a code cell'); | ||||||
|
|
||||||
| await kernelExecution.executeCell(cell); | ||||||
|
|
||||||
| await waitForCondition( | ||||||
| async () => cell.executionSummary?.success === true, | ||||||
| 30_000, | ||||||
| 'Cell execution did not complete successfully' | ||||||
| ); | ||||||
|
|
||||||
| assert.isAtLeast(cell.executionSummary?.executionOrder || 0, 1, 'Cell should have execution order'); | ||||||
| assert.isTrue(cell.executionSummary?.success, 'Cell execution should succeed'); | ||||||
| assert.isAtLeast(cell.outputs.length, 1, 'Cell should have at least one output'); | ||||||
|
|
||||||
| const outputText = new TextDecoder().decode(cell.outputs[0].items[0].data).toString(); | ||||||
| assert.include(outputText, 'Hello World', 'Output should contain "Hello World"'); | ||||||
|
|
||||||
|
||||||
| logger.debug('Test: Execute code cell - completed'); | ||||||
| }); | ||||||
|
|
||||||
| test('Execute multiple code cells with shared state', async function () { | ||||||
| logger.debug('Test: Execute multiple code cells - starting'); | ||||||
|
|
||||||
| const cell1 = nbDocument.cellAt(0); | ||||||
| const cell2 = nbDocument.cellAt(1); | ||||||
|
|
||||||
| await kernelExecution.executeCell(cell1); | ||||||
| await waitForCondition( | ||||||
| async () => cell1.executionSummary?.success === true, | ||||||
| 30_000, | ||||||
| 'First cell execution did not complete' | ||||||
| ); | ||||||
|
|
||||||
| await kernelExecution.executeCell(cell2); | ||||||
| await waitForCondition( | ||||||
| async () => cell2.executionSummary?.success === true, | ||||||
| 30_000, | ||||||
| 'Second cell execution did not complete' | ||||||
| ); | ||||||
|
|
||||||
| assert.isTrue(cell2.executionSummary?.success, 'Second cell should execute successfully'); | ||||||
| assert.isAtLeast(cell2.outputs.length, 1, 'Second cell should have output'); | ||||||
|
|
||||||
| const outputText = new TextDecoder().decode(cell2.outputs[0].items[0].data).toString(); | ||||||
| assert.include(outputText, '42', 'Output should contain the value 42'); | ||||||
|
|
||||||
|
||||||
| logger.debug('Test: Execute multiple code cells - completed'); | ||||||
| }); | ||||||
|
|
||||||
| test('Init notebook executes automatically', async function () { | ||||||
| logger.debug('Test: Init notebook execution - starting'); | ||||||
|
|
||||||
| const notebookManager = api.serviceContainer.get<IDeepnoteNotebookManager>(IDeepnoteNotebookManager); | ||||||
|
|
||||||
| await waitForCondition( | ||||||
| async () => notebookManager.hasInitNotebookBeenRun('test-project-id'), | ||||||
| 60_000, | ||||||
| 'Init notebook did not execute within timeout' | ||||||
| ); | ||||||
|
|
||||||
| assert.isTrue( | ||||||
| notebookManager.hasInitNotebookBeenRun('test-project-id'), | ||||||
| 'Init notebook should have been marked as run' | ||||||
| ); | ||||||
|
|
||||||
| const cell = nbDocument.cellAt(0); | ||||||
| await kernelExecution.executeCell(cell); | ||||||
| await waitForCondition( | ||||||
| async () => cell.executionSummary?.success === true, | ||||||
| 30_000, | ||||||
| 'Cell execution did not complete' | ||||||
| ); | ||||||
|
|
||||||
| logger.debug('Test: Init notebook execution - completed'); | ||||||
| }); | ||||||
| }); | ||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| metadata: | ||
| createdAt: '2025-01-01T00:00:00.000Z' | ||
| modifiedAt: '2025-01-01T00:00:00.000Z' | ||
| project: | ||
| id: test-project-id | ||
| name: Test Project | ||
| initNotebookId: init-notebook-id | ||
|
Contributor
There was a problem hiding this comment. 🧩 Analysis chainInit notebook execution not tested. PR objectives require verifying that the init notebook (referenced by Verify whether init notebook auto-execution is implemented and add a test that:
🏁 Script executed: #!/bin/bash
# Search for init notebook execution logic in the codebase
rg -nP --type=ts 'initNotebook' -C3Length of output: 10708 Length of output: 0 🏁 Script executed: #!/bin/bash
# Check if test.deepnote file exists and what it contains
find . -name "test.deepnote" -type f -exec cat {} \;Length of output: 990 🏁 Script executed: #!/bin/bash
# Search for any test references to deepnoteKernelAutoSelector or deepnoteInitNotebookRunner
fd -e "test.ts" -e "test.js" -e "spec.ts" | xargs rg -l "deepnoteKernelAutoSelector|deepnoteInitNotebookRunner" 2>/dev/nullLength of output: 0 Add tests for init notebook auto-execution on kernel start. Init notebook execution is implemented in
🤖 Prompt for AI Agents |
||
| notebooks: | ||
| - id: init-notebook-id | ||
| name: Init Notebook | ||
| blocks: | ||
| - id: init-block-1 | ||
| type: code | ||
| content: | | ||
| # This is the init notebook | ||
| import sys | ||
| print("Init notebook executed") | ||
| sortingKey: '0001' | ||
| - id: main-notebook-id | ||
| name: Main Notebook | ||
| blocks: | ||
| - id: block-1 | ||
| type: code | ||
| content: | | ||
| print("Hello World") | ||
| sortingKey: '0001' | ||
| - id: block-2 | ||
| type: code | ||
| content: | | ||
| x = 42 | ||
| print(f"The answer is {x}") | ||
| sortingKey: '0002' | ||
| - id: block-3 | ||
| type: markdown | ||
| content: | | ||
| # Test Markdown | ||
| This is a test markdown block. | ||
| sortingKey: '0003' | ||
| version: '1.0' | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@FilipPyrek pls open a pr doing just this for the sake of integrations tests already in main and assign me as a reviewer.