Add basic integration tests for .deepnote file handling (GRN-4766)

.github/workflows/ci.yml

@@ -143,6 +143,47 @@ jobs:
       - name: Check licenses
         run: npm run check-licenses
 
+  integration-tests:
+    name: Integration Tests
+    runs-on: ubicloud
+    timeout-minutes: 30
+    permissions:
+      id-token: write
+      contents: read
+      packages: read
+    steps:
+      - name: Checkout
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5
+
+      - name: Setup Node.js
+        uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v5
+        with:
+          cache: 'npm'
+          node-version: ${{ env.NODE_VERSION }}
+          registry-url: 'https://npm.pkg.github.com'
+          scope: '@deepnote'
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Install Jupyter
+        run: python3 -m pip install jupyter ipykernel
+
+      - name: Install dependencies
+        run: npm ci --prefer-offline --no-audit
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Compile TypeScript
+        run: npm run compile
+
+      - name: Run integration tests
+        run: xvfb-run -a -s "-screen 0 1024x768x24" npm run test:integration
+        env:
+          VSC_JUPYTER_CI_TEST_GREP: 'Deepnote Integration Tests'
+
   check_licenses:
     name: Check Licenses
     runs-on: ubuntu-latest

src/notebooks/deepnote/deepnoteExplorerView.ts

@@ -1,7 +1,6 @@
 import { injectable, inject } from 'inversify';
 import { commands, window, workspace, type TreeView, Uri, l10n } from 'vscode';
 import * as yaml from 'js-yaml';
-import { convertIpynbFilesToDeepnoteFile } from '@deepnote/convert';
 
 import { IExtensionContext } from '../../platform/common/types';
 import { IDeepnoteNotebookManager } from '../types';
@@ -357,6 +356,7 @@ export class DeepnoteExplorerView {
                 const outputFileName = `${projectName}.deepnote`;
                 const outputPath = Uri.joinPath(workspaceFolder.uri, outputFileName).path;
 
+                const { convertIpynbFilesToDeepnoteFile } = await import('@deepnote/convert');
                 await convertIpynbFilesToDeepnoteFile(inputFilePaths, {
                     outputPath: outputPath,
                     projectName: projectName
@@ -429,6 +429,7 @@ export class DeepnoteExplorerView {
                 // File doesn't exist, continue
             }
 
+            const { convertIpynbFilesToDeepnoteFile } = await import('@deepnote/convert');
             await convertIpynbFilesToDeepnoteFile(inputFilePaths, {
                 outputPath: outputUri.path,
                 projectName: projectName

src/test/datascience/notebook/deepnote.vscode.test.ts

@@ -0,0 +1,76 @@
+/* eslint-disable @typescript-eslint/no-require-imports, @typescript-eslint/no-var-requires */
+import { assert } from 'chai';
+import * as path from '../../../platform/vscode-path/path';
+import { Uri, workspace } from 'vscode';
+import { IDisposable } from '../../../platform/common/types';
+import { captureScreenShot, IExtensionTestApi } from '../../common.node';
+import { EXTENSION_ROOT_DIR_FOR_TESTS, initialize } from '../../initialize.node';
+import { closeNotebooksAndCleanUpAfterTests } from './helper.node';
+import { logger } from '../../../platform/logging';
+import { IDeepnoteNotebookManager } from '../../../notebooks/types';
+
+/* eslint-disable @typescript-eslint/no-explicit-any, no-invalid-this */
+suite('Deepnote Integration Tests @kernelCore', function () {
+    let api: IExtensionTestApi;
+    const disposables: IDisposable[] = [];
+    const deepnoteFilePath = Uri.file(
+        path.join(EXTENSION_ROOT_DIR_FOR_TESTS, 'src', 'test', 'datascience', 'notebook', 'test.deepnote')
+    );
+    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('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');
+
+        const notebookManager = api.serviceContainer.get<IDeepnoteNotebookManager>(IDeepnoteNotebookManager);
+        assert.isOk(notebookManager, 'Notebook manager should be available');
+
+        notebookManager.selectNotebookForProject('test-project-id', 'main-notebook-id');
+
+        const nbDocument = await workspace.openNotebookDocument(deepnoteFilePath);
+
+        logger.debug(`Opened notebook with type: ${nbDocument.notebookType}, cells: ${nbDocument.cellCount}`);
+
+        assert.equal(nbDocument.notebookType, 'deepnote', 'Notebook type should be deepnote');
+        assert.isTrue(nbDocument.cellCount > 0, 'Notebook should have 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('Extension services are available', async function () {
+        logger.debug('Test: Extension services are available - starting');
+
+        const notebookManager = api.serviceContainer.get<IDeepnoteNotebookManager>(IDeepnoteNotebookManager);
+        assert.isOk(notebookManager, 'Notebook manager should be available');
+
+        logger.debug('Test: Extension services are available - completed');
+    });
+});

src/test/datascience/notebook/test.deepnote

@@ -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
+  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'