Skip to content

test(editor): fake vscode as an external editor MONGOSH-1011 #1131

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
Oct 5, 2021
Merged

test(editor): fake vscode as an external editor MONGOSH-1011 #1131

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
fdfa245
test: fake vscode as an external editor MONGOSH-1011
alenakhineika Oct 4, 2021
6ddec43
test: assert extension inside script
alenakhineika Oct 4, 2021
5ef4808
test: move expectedExtension to a proper test
alenakhineika Oct 4, 2021
fd02e97
test: using flags along with file names
alenakhineika Oct 4, 2021
577910f
refactor: stringify flags
alenakhineika Oct 4, 2021
2df89be
refactor: use deepStrictEqual and slice
alenakhineika Oct 4, 2021
187b790
test: check if windows ignores shebang in script
alenakhineika Oct 4, 2021
05534b8
test: fix opening objects
alenakhineika Oct 4, 2021
3fcb8c8
test: refactor unit tests
alenakhineika Oct 5, 2021
8161d85
refactor: change test name and check one windows test
alenakhineika Oct 5, 2021
0320432
test: return fix for multiline on windows
alenakhineika Oct 5, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
266 changes: 207 additions & 59 deletions packages/cli-repl/test/e2e-editor.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ import { promisify } from 'util';
import rimraf from 'rimraf';

import { eventually } from '../../../testing/eventually';
import { useTmpdir, fakeExternalEditor, setTemporaryHomeDirectory } from './repl-helpers';
import { TestShell } from './test-shell';
import { useTmpdir, fakeExternalEditor, setTemporaryHomeDirectory } from './repl-helpers';

describe('external editor e2e', () => {
const tmpdir = useTmpdir();
Expand Down Expand Up @@ -45,76 +45,224 @@ describe('external editor e2e', () => {
}
});

it('returns a modified identifier for fn', async() => {
const shellOriginalInput = "const fn = function () { console.log(111); }; edit('fn')";
const editorOutput = `function () {
console.log(222);
};`;
const shellModifiedInput = 'fn = function () { console.log(222); };';
const editor = await fakeExternalEditor(editorOutput);
const result = await shell.executeLine(`config.set("editor", ${JSON.stringify(editor)});`);

expect(result).to.include('"editor" has been changed');
shell.writeInputLine(shellOriginalInput);
await eventually(() => {
shell.assertContainsOutput(shellModifiedInput);
context('when editor is node command', () => {
it('creates a file with .js extension', async() => {
const shellOriginalInput = 'edit 111';
const editorOutput = '222';
const shellModifiedInput = '222';
const editor = await fakeExternalEditor({
output: editorOutput,
expectedExtension: '.js',
tmpdir: tmpdir.path,
name: 'editor',
isNodeCommand: true
});
const result = await shell.executeLine(`config.set("editor", ${JSON.stringify(editor)});`);

expect(result).to.include('"editor" has been changed');
shell.writeInputLine(shellOriginalInput);
await eventually(() => {
shell.assertContainsOutput(shellModifiedInput);
});
});
});

it('returns a modified identifier for var', async() => {
const shellOriginalInput = "const myVar = '111'; edit('myVar')";
const editorOutput = "const myVar = '222';";
const shellModifiedInput = "myVar = '222';";
const editor = await fakeExternalEditor(editorOutput);
const result = await shell.executeLine(`config.set("editor", ${JSON.stringify(editor)});`);

expect(result).to.include('"editor" has been changed');
shell.writeInputLine(shellOriginalInput);
await eventually(() => {
shell.assertContainsOutput(shellModifiedInput);
it('returns a modified identifier for fn', async() => {
const shellOriginalInput = "const fn = function () { console.log(111); }; edit('fn')";
const editorOutput = `function () {
console.log(222);
};`;
const shellModifiedInput = 'fn = function () { console.log(222); };';
const editor = await fakeExternalEditor({
output: editorOutput,
tmpdir: tmpdir.path,
name: 'editor',
isNodeCommand: true
});
const result = await shell.executeLine(`config.set("editor", ${JSON.stringify(editor)});`);

expect(result).to.include('"editor" has been changed');
shell.writeInputLine(shellOriginalInput);
await eventually(() => {
shell.assertContainsOutput(shellModifiedInput);
});
});

it('returns a modified identifier for var', async() => {
const shellOriginalInput = "const myVar = '111'; edit('myVar')";
const editorOutput = '"222"';
const shellModifiedInput = 'myVar = "222"';
const editor = await fakeExternalEditor({
output: editorOutput,
tmpdir: tmpdir.path,
name: 'editor',
isNodeCommand: true
});
const result = await shell.executeLine(`config.set("editor", ${JSON.stringify(editor)});`);

expect(result).to.include('"editor" has been changed');
shell.writeInputLine(shellOriginalInput);
await eventually(() => {
shell.assertContainsOutput(shellModifiedInput);
});
});

it('returns a modified identifier for a.b.c', async() => {
const shellOriginalInput = "const myObj = { field: { child: 'string value' } }; edit('myObj')";
const editorOutput = `{
"field": {
"child": "new value"
}
}`;
const shellModifiedInput = 'myObj = { "field": { "child": "new value" } }';
const editor = await fakeExternalEditor({
output: editorOutput,
tmpdir: tmpdir.path,
name: 'editor',
isNodeCommand: true
});
const result = await shell.executeLine(`config.set("editor", ${JSON.stringify(editor)});`);

expect(result).to.include('"editor" has been changed');
shell.writeInputLine(shellOriginalInput);
await eventually(() => {
shell.assertContainsOutput(shellModifiedInput);
});
});

it('returns an error when editor exits with exitCode 1', async() => {
const shellOriginalInput = 'edit function() {}';
const editor = await fakeExternalEditor({
tmpdir: tmpdir.path,
name: 'editor',
isNodeCommand: true
});
const result = await shell.executeLine(`config.set("editor", ${JSON.stringify(editor)});`);

expect(result).to.include('"editor" has been changed');
shell.writeInputLine(shellOriginalInput);
await eventually(() => {
shell.assertContainsError('failed with an exit code 1');
});
});

it('opens an empty editor', async() => {
const output = '';
const editor = await fakeExternalEditor({
output,
tmpdir: tmpdir.path,
name: 'editor',
isNodeCommand: true
});
const result = await shell.executeLine(`config.set("editor", ${JSON.stringify(editor)});`);

expect(result).to.include('"editor" has been changed');
shell.writeInputLine('edit');
await eventually(() => {
shell.assertContainsOutput(output);
});
});
});

it('returns a modified identifier for a.b.c', async() => {
const shellOriginalInput = "const myObj = { field: { child: 'string value' } }; edit('myObj')";
const editorOutput = `const myObj = {
field: {
child: 'new value'
context('when editor is executable file', () => {
before(function() {
if (process.platform === 'win32') {
return this.skip(); // Shebangs don't work on windows.
}
};`;
const shellModifiedInput = "myObj = { field: { child: 'new value' } };";
const editor = await fakeExternalEditor(editorOutput);
const result = await shell.executeLine(`config.set("editor", ${JSON.stringify(editor)});`);

expect(result).to.include('"editor" has been changed');
shell.writeInputLine(shellOriginalInput);
await eventually(() => {
shell.assertContainsOutput(shellModifiedInput);
});
});

it('returns an error when editor exits with exitCode 1', async() => {
const shellOriginalInput = 'edit function() {}';
const editor = await fakeExternalEditor();
const result = await shell.executeLine(`config.set("editor", ${JSON.stringify(editor)});`);
await shell.executeLine('config.set("showStackTraces", true); print(process.env.PATH);');
context('not vscode', () => {
it('creates a file with .js extension', async() => {
const editorOutput = "const name = 'Succeeded!'";
const shellModifiedInput = "const name = 'Succeeded!'";
const editor = await fakeExternalEditor({
output: editorOutput,
expectedExtension: '.js',
tmpdir: tmpdir.path,
name: 'editor',
isNodeCommand: false,
flags: '--trace-uncaught'
});
const result = await shell.executeLine(`config.set("editor", ${JSON.stringify(editor)});`);

expect(result).to.include('"editor" has been changed');
shell.writeInputLine(shellOriginalInput);
await eventually(() => {
shell.assertContainsError('failed with an exit code 1');
expect(result).to.include('"editor" has been changed');
shell.writeInputLine("const name = 'I want to test a sequence of writeInputLine'");
shell.writeInputLine('edit name');
await eventually(() => {
shell.assertContainsOutput(shellModifiedInput);
});
});
});
});

it('opens an empty editor', async() => {
const output = '';
const editor = await fakeExternalEditor(output);
const result = await shell.executeLine(`config.set("editor", ${JSON.stringify(editor)});`);
context('vscode', () => {
context('when mongodb extension is installed', () => {
beforeEach(async() => {
// make a fake dir for vscode mongodb extension
await fs.mkdir(path.join(homedir, '.vscode', 'extensions', 'mongodb.mongodb-vscode-0.0.0'), { recursive: true });
});

it('creates a file with .mongodb extension', async() => {
const shellOriginalInput = 'edit 111';
const editorOutput = 'edit 222';
const shellModifiedInput = '222';
const editor = await fakeExternalEditor({
output: editorOutput,
expectedExtension: '.mongodb',
tmpdir: tmpdir.path,
name: 'code',
isNodeCommand: false
});
const result = await shell.executeLine(`config.set("editor", ${JSON.stringify(editor)});`);

expect(result).to.include('"editor" has been changed');
shell.writeInputLine(shellOriginalInput);
await eventually(() => {
shell.assertContainsOutput(shellModifiedInput);
});
});

it('allows using flags along with file names', async() => {
const shellOriginalInput = "edit 'string with whitespaces'";
const editorOutput = "'string with whitespaces and const x = 0;'";
const shellModifiedInput = "'string with whitespaces and const x = 0;'";
const editor = await fakeExternalEditor({
output: editorOutput,
expectedExtension: '.mongodb',
tmpdir: tmpdir.path,
name: 'code',
flags: '--wait',
isNodeCommand: false
});
const result = await shell.executeLine(`config.set("editor", ${JSON.stringify(editor)});`);

expect(result).to.include('"editor" has been changed');
shell.writeInputLine(shellOriginalInput);
await eventually(() => {
shell.assertContainsOutput(shellModifiedInput);
});
});
});

context('when mongodb extension is not installed', () => {
it('creates a file with .js extension', async() => {
const shellOriginalInput = "edit const x = 'y';";
const editorOutput = "const x = 'zyz';";
const shellModifiedInput = "const x = 'zyz';";
const editor = await fakeExternalEditor({
output: editorOutput,
expectedExtension: '.js',
tmpdir: tmpdir.path,
name: 'code',
isNodeCommand: false
});
const result = await shell.executeLine(`config.set("editor", ${JSON.stringify(editor)});`);

expect(result).to.include('"editor" has been changed');
shell.writeInputLine('edit');
await eventually(() => {
shell.assertContainsOutput(output);
expect(result).to.include('"editor" has been changed');
shell.writeInputLine(shellOriginalInput);
await eventually(() => {
shell.assertContainsOutput(shellModifiedInput);
});
});
});
});
});
});
40 changes: 31 additions & 9 deletions packages/cli-repl/test/repl-helpers.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,29 +77,51 @@ async function readReplLogfile(logPath: string) {
}


const fakeExternalEditor = async(output?: string) => {
const base = path.resolve(__dirname, '..', '..', '..', 'tmp', 'test', `${Date.now()}`, `${Math.random()}`);
const tmpDoc = path.join(base, 'editor-script.js');
const fakeExternalEditor = async(
{ output, expectedExtension, tmpdir, name, flags, isNodeCommand }: {
output?: string,
expectedExtension?: string,
tmpdir: string,
name: string,
flags?: string,
isNodeCommand: boolean
}
) => {
const tmpDoc = path.join(tmpdir, name);
const editor = isNodeCommand ? `node ${tmpDoc}` : tmpDoc;
let script: string;

if (typeof output === 'string') {
script = `(async () => {
script = `#!/usr/bin/env node
(async () => {
const tmpDoc = process.argv[process.argv.length - 1];
const { promises: { writeFile } } = require("fs");
const assert = require("assert");
const path = require("path");

if (${JSON.stringify(expectedExtension ?? '')}) {
assert.strictEqual(path.extname(tmpDoc), ${JSON.stringify(expectedExtension)});
}

if (${JSON.stringify(flags ?? '')}) {
assert.deepStrictEqual((${JSON.stringify(flags)}).split(/\s+/), process.argv.slice(2, -1));
}

await writeFile(tmpDoc, ${JSON.stringify(output)}, { mode: 0o600 });
})()`;
})().catch((err) => { process.nextTick(() => { throw err; }); });`;
} else {
script = 'process.exit(1);';
script = `#!/usr/bin/env node
process.exit(1);`;
}

await fs.mkdir(path.dirname(tmpDoc), { recursive: true, mode: 0o700 });
await fs.writeFile(tmpDoc, script, { mode: 0o600 });
await fs.writeFile(tmpDoc, script, { mode: 0o700 });

return `node ${tmpDoc}`;
return flags ? `${editor} ${flags}` : editor;
};

const setTemporaryHomeDirectory = () => {
const homedir: string = path.resolve(__dirname, '..', '..', '..', 'tmp', `cli-repl-home-${Date.now()}-${Math.random()}`);
const homedir: string = path.resolve(__dirname, '..', '..', '..', 'tmp', 'test', `cli-repl-home-${Date.now()}-${Math.random()}`);
const env: Record<string, string> = { ...process.env, HOME: homedir, USERPROFILE: homedir };

if (process.platform === 'win32') {
Expand Down
Loading