forked from microsoft/vscode-black-formatter
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add smoke test to detect extension load and python selection (microso…
- Loading branch information
1 parent
6566656
commit 12df405
Showing
12 changed files
with
225 additions
and
28 deletions.
There are no files selected for viewing
This file contains 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 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 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 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 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 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 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,40 @@ | ||
| // Copyright (c) Microsoft Corporation. All rights reserved. | ||
| // Licensed under the MIT License. | ||
| /* eslint-disable @typescript-eslint/naming-convention */ | ||
|
|
||
| import * as cp from 'child_process'; | ||
| import * as path from 'path'; | ||
|
|
||
| import { runTests, downloadAndUnzipVSCode, resolveCliArgsFromVSCodeExecutablePath } from '@vscode/test-electron'; | ||
| import { EXTENSION_ROOT_DIR } from '../../common/constants'; | ||
|
|
||
| const TEST_PROJECT_DIR = path.join(EXTENSION_ROOT_DIR, 'src', 'test', 'ts_tests', 'test_data', 'project'); | ||
|
|
||
| async function main() { | ||
| try { | ||
| const vscodeExecutablePath = await downloadAndUnzipVSCode('stable'); | ||
|
|
||
| const [cli, ...args] = resolveCliArgsFromVSCodeExecutablePath(vscodeExecutablePath); | ||
| const command = path.relative(EXTENSION_ROOT_DIR, cli); | ||
| cp.spawnSync(command, [...args, '--install-extension', 'ms-python.python'], { | ||
| encoding: 'utf-8', | ||
| stdio: 'inherit', | ||
| }); | ||
|
|
||
| const extensionDevelopmentPath = EXTENSION_ROOT_DIR; | ||
| const extensionTestsPath = path.resolve(__dirname, './index'); | ||
|
|
||
| await runTests({ | ||
| extensionDevelopmentPath, | ||
| extensionTestsPath, | ||
| extensionTestsEnv: { SMOKE_TESTS: 'true' }, | ||
| launchArgs: [TEST_PROJECT_DIR], | ||
| }); | ||
| } catch (err) { | ||
| console.error('Failed to run tests'); | ||
| console.error(err); | ||
| process.exit(1); | ||
| } | ||
| } | ||
|
|
||
| main(); |
This file contains 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,6 @@ | ||
| { | ||
| "[python]": { | ||
| "editor.defaultFormatter": "ms-python.black-formatter", | ||
| "editor.formatOnSave": true | ||
| } | ||
| } |
This file contains 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,4 @@ | ||
| import os | ||
| import sys | ||
|
|
||
| print(os.fspath(sys.executable)) |
This file contains 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,2 @@ | ||
| import sys | ||
| print(sys.executable) |
This file contains 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,2 @@ | ||
| import os;import sys | ||
| print(os.fspath(sys.executable)) |
This file contains 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,118 @@ | ||
| // Copyright (c) Microsoft Corporation. All rights reserved. | ||
| // Licensed under the MIT License. | ||
|
|
||
| import * as path from 'path'; | ||
| import * as vscode from 'vscode'; | ||
| import * as fsapi from 'fs-extra'; | ||
| import { EXTENSION_ROOT_DIR } from '../../../../common/constants'; | ||
| import { assert } from 'chai'; | ||
|
|
||
| const TEST_PROJECT_DIR = path.join(EXTENSION_ROOT_DIR, 'src', 'test', 'ts_tests', 'test_data', 'project'); | ||
| const TIMEOUT = 120000; // 120 seconds | ||
|
|
||
| suite('Smoke Tests', function () { | ||
| this.timeout(TIMEOUT); | ||
|
|
||
| let disposables: vscode.Disposable[] = []; | ||
|
|
||
| setup(async () => { | ||
| disposables = []; | ||
| await vscode.commands.executeCommand('workbench.action.closeAllEditors'); | ||
| }); | ||
|
|
||
| teardown(async () => { | ||
| await vscode.commands.executeCommand('workbench.action.closeAllEditors'); | ||
|
|
||
| disposables.forEach((d) => d.dispose()); | ||
| disposables = []; | ||
| }); | ||
|
|
||
| async function ensurePythonExt(activate?: boolean): Promise<void> { | ||
| const pythonExt = vscode.extensions.getExtension('ms-python.python'); | ||
| assert.ok(pythonExt, 'Python Extension not found'); | ||
| if (activate) { | ||
| await pythonExt?.activate(); | ||
| } | ||
| } | ||
|
|
||
| async function ensureBlackExt(activate?: boolean): Promise<void> { | ||
| const extension = vscode.extensions.getExtension('ms-python.black-formatter'); | ||
| assert.ok(extension, 'Black Formatter Extension not found'); | ||
| if (activate) { | ||
| await extension?.activate(); | ||
| } | ||
| } | ||
|
|
||
| test('Ensure Black Formatter Extension loads', async () => { | ||
| await vscode.workspace.openTextDocument(path.join(TEST_PROJECT_DIR, 'myscript.py')); | ||
|
|
||
| await ensurePythonExt(true); | ||
| await ensureBlackExt(false); | ||
|
|
||
| const extension = vscode.extensions.getExtension('ms-python.black-formatter'); | ||
| if (extension) { | ||
| let timeout = TIMEOUT; | ||
| while (!extension.isActive && timeout > 0) { | ||
| await new Promise((resolve) => setTimeout(resolve, 100)); | ||
| timeout -= 100; | ||
| } | ||
| assert.ok(extension.isActive, `Extension not activated in ${TIMEOUT / 1000} seconds`); | ||
| } | ||
| }); | ||
|
|
||
| test('Ensure Black Formatter formats a file on save', async () => { | ||
| await vscode.commands.executeCommand('workbench.action.closeAllEditors'); | ||
| await ensurePythonExt(true); | ||
| const scriptPath = path.join(TEST_PROJECT_DIR, 'myscript.py'); | ||
|
|
||
| const unformatted = await fsapi.readFile(path.join(TEST_PROJECT_DIR, 'myscript.unformatted'), { | ||
| encoding: 'utf8', | ||
| }); | ||
| const formatted = await fsapi.readFile(path.join(TEST_PROJECT_DIR, 'myscript.formatted'), { encoding: 'utf8' }); | ||
| await fsapi.writeFile(scriptPath, unformatted, { encoding: 'utf8' }); | ||
|
|
||
| await ensureBlackExt(true); | ||
|
|
||
| const doc = await vscode.workspace.openTextDocument(scriptPath); | ||
| await vscode.window.showTextDocument(doc); | ||
|
|
||
| const editor = vscode.window.activeTextEditor; | ||
| assert.ok(editor, 'No active editor'); | ||
| assert.ok(editor?.document.uri.fsPath.endsWith('myscript.py'), 'Active editor is not myscript.py'); | ||
|
|
||
| const formatDone = new Promise<void>((resolve) => { | ||
| const watcher = vscode.workspace.createFileSystemWatcher( | ||
| new vscode.RelativePattern(TEST_PROJECT_DIR, 'myscript.py'), | ||
| true, // We don't need create events | ||
| false, // We need change events | ||
| true, // We don't need delete events | ||
| ); | ||
| disposables.push( | ||
| watcher, | ||
| watcher.onDidChange((e) => { | ||
| const text = fsapi.readFileSync(e.fsPath, { encoding: 'utf8' }); | ||
| if (!text.includes(';')) { | ||
| console.log('Saved with format changes'); | ||
| resolve(); | ||
| } else { | ||
| console.log('Saved without format changes'); | ||
| } | ||
| }), | ||
| ); | ||
| }); | ||
|
|
||
| const timer = setInterval(() => { | ||
| console.log('Saving file'); | ||
| vscode.commands.executeCommand('workbench.action.files.save'); | ||
| }, 1000); | ||
| disposables.push({ dispose: () => clearInterval(timer) }); | ||
|
|
||
| await vscode.commands.executeCommand('workbench.action.files.save'); | ||
| await formatDone; | ||
| const actualText = await fsapi.readFile(scriptPath, { encoding: 'utf8' }); | ||
| assert.equal(actualText, formatted); | ||
|
|
||
| //cleanup | ||
| await fsapi.writeFile(scriptPath, '', { encoding: 'utf8' }); | ||
| }); | ||
| }); |