Skip to content
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.

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

Resolve >= 3.13 failing REPL CI tests #24775

Merged
merged 1 commit into from
Feb 3, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
43 changes: 23 additions & 20 deletions src/test/terminals/codeExecution/helper.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,12 @@ import { IServiceContainer } from '../../../client/ioc/types';
import { EnvironmentType, PythonEnvironment } from '../../../client/pythonEnvironments/info';
import { CodeExecutionHelper } from '../../../client/terminals/codeExecution/helper';
import { ICodeExecutionHelper } from '../../../client/terminals/types';
import { PYTHON_PATH } from '../../common';
import { PYTHON_PATH, getPythonSemVer } from '../../common';
import { ReplType } from '../../../client/repl/types';

const TEST_FILES_PATH = path.join(EXTENSION_ROOT_DIR, 'src', 'test', 'python_files', 'terminalExec');

suite('Terminal - Code Execution Helper', () => {
suite('Terminal - Code Execution Helper', async () => {
let activeResourceService: TypeMoq.IMock<IActiveResourceService>;
let documentManager: TypeMoq.IMock<IDocumentManager>;
let applicationShell: TypeMoq.IMock<IApplicationShell>;
Expand Down Expand Up @@ -234,25 +234,28 @@ suite('Terminal - Code Execution Helper', () => {
expect(normalizedCode).to.be.equal(normalizedExpected);
}

['', '1', '2', '3', '4', '5', '6', '7', '8'].forEach((fileNameSuffix) => {
test(`Ensure code is normalized (Sample${fileNameSuffix})`, async () => {
configurationService
.setup((c) => c.getSettings(TypeMoq.It.isAny()))
.returns({
REPL: {
EnableREPLSmartSend: false,
REPLSmartSend: false,
},
// eslint-disable-next-line @typescript-eslint/no-explicit-any
} as any);
const code = await fs.readFile(path.join(TEST_FILES_PATH, `sample${fileNameSuffix}_raw.py`), 'utf8');
const expectedCode = await fs.readFile(
path.join(TEST_FILES_PATH, `sample${fileNameSuffix}_normalized_selection.py`),
'utf8',
);
await ensureCodeIsNormalized(code, expectedCode);
const pythonTestVersion = await getPythonSemVer();
if (pythonTestVersion && pythonTestVersion.minor < 13) {
['', '1', '2', '3', '4', '5', '6', '7', '8'].forEach((fileNameSuffix) => {
test(`Ensure code is normalized (Sample${fileNameSuffix}) - Python < 3.13`, async () => {
configurationService
.setup((c) => c.getSettings(TypeMoq.It.isAny()))
.returns({
REPL: {
EnableREPLSmartSend: false,
REPLSmartSend: false,
},
// eslint-disable-next-line @typescript-eslint/no-explicit-any
} as any);
const code = await fs.readFile(path.join(TEST_FILES_PATH, `sample${fileNameSuffix}_raw.py`), 'utf8');
const expectedCode = await fs.readFile(
path.join(TEST_FILES_PATH, `sample${fileNameSuffix}_normalized_selection.py`),
'utf8',
);
await ensureCodeIsNormalized(code, expectedCode);
});
});
});
}

test("Display message if there's no active file", async () => {
documentManager.setup((doc) => doc.activeTextEditor).returns(() => undefined);
Expand Down
130 changes: 67 additions & 63 deletions src/test/terminals/codeExecution/smartSend.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,15 @@ import { IServiceContainer } from '../../../client/ioc/types';
import { ICodeExecutionHelper } from '../../../client/terminals/types';
import { Commands, EXTENSION_ROOT_DIR } from '../../../client/common/constants';
import { EnvironmentType, PythonEnvironment } from '../../../client/pythonEnvironments/info';
import { PYTHON_PATH } from '../../common';
import { PYTHON_PATH, getPythonSemVer } from '../../common';
import { Architecture } from '../../../client/common/utils/platform';
import { ProcessService } from '../../../client/common/process/proc';
import { l10n } from '../../mocks/vsc';
import { ReplType } from '../../../client/repl/types';

const TEST_FILES_PATH = path.join(EXTENSION_ROOT_DIR, 'src', 'test', 'python_files', 'terminalExec');

suite('REPL - Smart Send', () => {
suite('REPL - Smart Send', async () => {
let documentManager: TypeMoq.IMock<IDocumentManager>;
let applicationShell: TypeMoq.IMock<IApplicationShell>;

Expand Down Expand Up @@ -168,67 +168,71 @@ suite('REPL - Smart Send', () => {
commandManager.verifyAll();
});

test('Smart send should perform smart selection and move cursor', async () => {
configurationService
.setup((c) => c.getSettings(TypeMoq.It.isAny()))
.returns({
REPL: {
REPLSmartSend: true,
},
// eslint-disable-next-line @typescript-eslint/no-explicit-any
} as any);

const activeEditor = TypeMoq.Mock.ofType<TextEditor>();
const firstIndexPosition = new Position(0, 0);
const selection = TypeMoq.Mock.ofType<Selection>();
const wholeFileContent = await fs.readFile(path.join(TEST_FILES_PATH, `sample_smart_selection.py`), 'utf8');

selection.setup((s) => s.anchor).returns(() => firstIndexPosition);
selection.setup((s) => s.active).returns(() => firstIndexPosition);
selection.setup((s) => s.isEmpty).returns(() => true);
activeEditor.setup((e) => e.selection).returns(() => selection.object);

documentManager.setup((d) => d.activeTextEditor).returns(() => activeEditor.object);
document.setup((d) => d.getText(TypeMoq.It.isAny())).returns(() => wholeFileContent);
const actualProcessService = new ProcessService();

const { execObservable } = actualProcessService;

processService
.setup((p) => p.execObservable(TypeMoq.It.isAny(), TypeMoq.It.isAny(), TypeMoq.It.isAny()))
.returns((file, args, options) => execObservable.apply(actualProcessService, [file, args, options]));

const actualSmartOutput = await codeExecutionHelper.normalizeLines(
'my_dict = {',
ReplType.terminal,
wholeFileContent,
);

// my_dict = { <----- smart shift+enter here
// "key1": "value1",
// "key2": "value2"
// } <---- cursor should be here afterwards, hence offset 3
commandManager
.setup((c) => c.executeCommand('cursorMove', TypeMoq.It.isAny()))
.callback((_, arg2) => {
assert.deepEqual(arg2, {
to: 'down',
by: 'line',
value: 3,
});
return Promise.resolve();
})
.verifiable(TypeMoq.Times.once());

commandManager
.setup((c) => c.executeCommand('cursorEnd'))
.returns(() => Promise.resolve())
.verifiable(TypeMoq.Times.once());

const expectedSmartOutput = 'my_dict = {\n "key1": "value1",\n "key2": "value2"\n}\n';
expect(actualSmartOutput).to.be.equal(expectedSmartOutput);
commandManager.verifyAll();
});
const pythonTestVersion = await getPythonSemVer();

if (pythonTestVersion && pythonTestVersion.minor < 13) {
test('Smart send should perform smart selection and move cursor - Python < 3.13', async () => {
configurationService
.setup((c) => c.getSettings(TypeMoq.It.isAny()))
.returns({
REPL: {
REPLSmartSend: true,
},
// eslint-disable-next-line @typescript-eslint/no-explicit-any
} as any);

const activeEditor = TypeMoq.Mock.ofType<TextEditor>();
const firstIndexPosition = new Position(0, 0);
const selection = TypeMoq.Mock.ofType<Selection>();
const wholeFileContent = await fs.readFile(path.join(TEST_FILES_PATH, `sample_smart_selection.py`), 'utf8');

selection.setup((s) => s.anchor).returns(() => firstIndexPosition);
selection.setup((s) => s.active).returns(() => firstIndexPosition);
selection.setup((s) => s.isEmpty).returns(() => true);
activeEditor.setup((e) => e.selection).returns(() => selection.object);

documentManager.setup((d) => d.activeTextEditor).returns(() => activeEditor.object);
document.setup((d) => d.getText(TypeMoq.It.isAny())).returns(() => wholeFileContent);
const actualProcessService = new ProcessService();

const { execObservable } = actualProcessService;

processService
.setup((p) => p.execObservable(TypeMoq.It.isAny(), TypeMoq.It.isAny(), TypeMoq.It.isAny()))
.returns((file, args, options) => execObservable.apply(actualProcessService, [file, args, options]));

const actualSmartOutput = await codeExecutionHelper.normalizeLines(
'my_dict = {',
ReplType.terminal,
wholeFileContent,
);

// my_dict = { <----- smart shift+enter here
// "key1": "value1",
// "key2": "value2"
// } <---- cursor should be here afterwards, hence offset 3
commandManager
.setup((c) => c.executeCommand('cursorMove', TypeMoq.It.isAny()))
.callback((_, arg2) => {
assert.deepEqual(arg2, {
to: 'down',
by: 'line',
value: 3,
});
return Promise.resolve();
})
.verifiable(TypeMoq.Times.once());

commandManager
.setup((c) => c.executeCommand('cursorEnd'))
.returns(() => Promise.resolve())
.verifiable(TypeMoq.Times.once());

const expectedSmartOutput = 'my_dict = {\n "key1": "value1",\n "key2": "value2"\n}\n';
expect(actualSmartOutput).to.be.equal(expectedSmartOutput);
commandManager.verifyAll();
});
}

// Do not perform smart selection when there is explicit selection
test('Smart send should not perform smart selection when there is explicit selection', async () => {
Expand Down