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.

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

Jump to bottom

Fix debug arg error #23814

Merged
merged 3 commits into from
Jul 15, 2024
Merged

Fix debug arg error #23814

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4c2f1ac
do not modify justMyCode arg
paulacamargo25 Jul 14, 2024
7ebfbc4
fix tests
paulacamargo25 Jul 14, 2024
b571759
fix lint
paulacamargo25 Jul 14, 2024
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
7 changes: 0 additions & 7 deletions src/client/debugger/extension/configuration/resolvers/attach.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,17 +43,10 @@ export class AttachConfigurationResolver extends BaseConfigurationResolver<Attac
// Connect and listen cannot be mixed with host property.
debugConfiguration.host = 'localhost';
}
if (debugConfiguration.justMyCode === undefined) {
// Populate justMyCode using debugStdLib
debugConfiguration.justMyCode = !debugConfiguration.debugStdLib;
}
debugConfiguration.showReturnValue = debugConfiguration.showReturnValue !== false;
// Pass workspace folder so we can get this when we get debug events firing.
debugConfiguration.workspaceFolder = workspaceFolder ? workspaceFolder.fsPath : undefined;
const debugOptions = debugConfiguration.debugOptions!;
if (!debugConfiguration.justMyCode) {
AttachConfigurationResolver.debugOption(debugOptions, DebugOptions.DebugStdLib);
}
if (debugConfiguration.django) {
AttachConfigurationResolver.debugOption(debugOptions, DebugOptions.Django);
}
Expand Down
7 changes: 0 additions & 7 deletions src/client/debugger/extension/configuration/resolvers/launch.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,14 +145,7 @@ export class LaunchConfigurationResolver extends BaseConfigurationResolver<Launc
if (!Array.isArray(debugConfiguration.debugOptions)) {
debugConfiguration.debugOptions = [];
}
if (debugConfiguration.justMyCode === undefined) {
// Populate justMyCode using debugStdLib
debugConfiguration.justMyCode = !debugConfiguration.debugStdLib;
}
const debugOptions = debugConfiguration.debugOptions!;
if (!debugConfiguration.justMyCode) {
LaunchConfigurationResolver.debugOption(debugOptions, DebugOptions.DebugStdLib);
}
if (debugConfiguration.stopOnEntry) {
LaunchConfigurationResolver.debugOption(debugOptions, DebugOptions.StopOnEntry);
}
Expand Down
1 change: 0 additions & 1 deletion src/client/debugger/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ export enum DebugOptions {
RedirectOutput = 'RedirectOutput',
Django = 'Django',
Jinja = 'Jinja',
DebugStdLib = 'DebugStdLib',
Sudo = 'Sudo',
Pyramid = 'Pyramid',
FixFilePathCase = 'FixFilePathCase',
Expand Down
2 changes: 0 additions & 2 deletions src/client/testing/common/debugLauncher.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,8 +143,6 @@ export class DebugLauncher implements ITestDebugLauncher {
) {
// cfg.pythonPath is handled by LaunchConfigurationResolver.

// Default value of justMyCode is not provided intentionally, for now we derive its value required for launchArgs using debugStdLib
// Have to provide it if and when we remove complete support for debugStdLib
if (!cfg.console) {
cfg.console = 'internalConsole';
}
Expand Down
69 changes: 0 additions & 69 deletions src/test/debugger/extension/configuration/resolvers/attach.unit.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -496,74 +496,5 @@ getInfoPerOS().forEach(([osName, osType, path]) => {
expect(debugConfig).to.have.property('clientOS', getClientOS());
expect(debugConfig).to.have.property('debugOptions').to.be.deep.equal(expectedDebugOptions);
});

const testsForJustMyCode = [
{
justMyCode: false,
debugStdLib: true,
expectedResult: false,
},
{
justMyCode: false,
debugStdLib: false,
expectedResult: false,
},
{
justMyCode: false,
debugStdLib: undefined,
expectedResult: false,
},
{
justMyCode: true,
debugStdLib: false,
expectedResult: true,
},
{
justMyCode: true,
debugStdLib: true,
expectedResult: true,
},
{
justMyCode: true,
debugStdLib: undefined,
expectedResult: true,
},
{
justMyCode: undefined,
debugStdLib: false,
expectedResult: true,
},
{
justMyCode: undefined,
debugStdLib: true,
expectedResult: false,
},
{
justMyCode: undefined,
debugStdLib: undefined,
expectedResult: true,
},
];
test('Ensure justMyCode property is correctly derived from debugStdLib', async () => {
const activeFile = 'xyz.py';
const workspaceFolder = createMoqWorkspaceFolder(__dirname);
setupActiveEditor(activeFile, PYTHON_LANGUAGE);
const defaultWorkspace = path.join('usr', 'desktop');
setupWorkspaces([defaultWorkspace]);

const debugOptions = debugOptionsAvailable
.slice()
.concat(DebugOptions.Jinja, DebugOptions.Sudo) as DebugOptions[];

testsForJustMyCode.forEach(async (testParams) => {
const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
...attach,
debugOptions,
justMyCode: testParams.justMyCode,
debugStdLib: testParams.debugStdLib,
});
expect(debugConfig).to.have.property('justMyCode', testParams.expectedResult);
});
});
});
});
69 changes: 1 addition & 68 deletions src/test/debugger/extension/configuration/resolvers/launch.unit.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -768,80 +768,13 @@ getInfoPerOS().forEach(([osName, osType, path]) => {
expect(debugConfig).to.have.property('redirectOutput', true);
expect(debugConfig).to.have.property('justMyCode', false);
expect(debugConfig).to.have.property('debugOptions');
const expectedOptions = [
DebugOptions.DebugStdLib,
DebugOptions.ShowReturnValue,
DebugOptions.RedirectOutput,
];
const expectedOptions = [DebugOptions.ShowReturnValue, DebugOptions.RedirectOutput];
if (osType === platform.OSType.Windows) {
expectedOptions.push(DebugOptions.FixFilePathCase);
}
expect((debugConfig as DebugConfiguration).debugOptions).to.be.deep.equal(expectedOptions);
});

const testsForJustMyCode = [
{
justMyCode: false,
debugStdLib: true,
expectedResult: false,
},
{
justMyCode: false,
debugStdLib: false,
expectedResult: false,
},
{
justMyCode: false,
debugStdLib: undefined,
expectedResult: false,
},
{
justMyCode: true,
debugStdLib: false,
expectedResult: true,
},
{
justMyCode: true,
debugStdLib: true,
expectedResult: true,
},
{
justMyCode: true,
debugStdLib: undefined,
expectedResult: true,
},
{
justMyCode: undefined,
debugStdLib: false,
expectedResult: true,
},
{
justMyCode: undefined,
debugStdLib: true,
expectedResult: false,
},
{
justMyCode: undefined,
debugStdLib: undefined,
expectedResult: true,
},
];
test('Ensure justMyCode property is correctly derived from debugStdLib', async () => {
const pythonPath = `PythonPath_${new Date().toString()}`;
const workspaceFolder = createMoqWorkspaceFolder(__dirname);
const pythonFile = 'xyz.py';
setupIoc(pythonPath);
setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
testsForJustMyCode.forEach(async (testParams) => {
const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
...launch,
debugStdLib: testParams.debugStdLib,
justMyCode: testParams.justMyCode,
});
expect(debugConfig).to.have.property('justMyCode', testParams.expectedResult);
});
});

const testsForRedirectOutput = [
{
console: 'internalConsole',
Expand Down
9 changes: 0 additions & 9 deletions src/test/testing/common/debugLauncher.unit.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,13 +234,6 @@ suite('Unit Tests - Debug Launcher', () => {
}
expected.workspaceFolder = workspaceFolders[0].uri.fsPath;
expected.debugOptions = [];
if (expected.justMyCode === undefined) {
// Populate justMyCode using debugStdLib
expected.justMyCode = !expected.debugStdLib;
}
if (!expected.justMyCode) {
expected.debugOptions.push(DebugOptions.DebugStdLib);
}
if (expected.stopOnEntry) {
expected.debugOptions.push(DebugOptions.StopOnEntry);
}
Expand Down Expand Up @@ -379,7 +372,6 @@ suite('Unit Tests - Debug Launcher', () => {
envFile: 'some/dir/.env',
redirectOutput: false,
debugStdLib: true,
justMyCode: false,
// added by LaunchConfigurationResolver:
internalConsoleOptions: 'neverOpen',
subProcess: true,
Expand All @@ -399,7 +391,6 @@ suite('Unit Tests - Debug Launcher', () => {
envFile: expected.envFile,
redirectOutput: expected.redirectOutput,
debugStdLib: expected.debugStdLib,
justMyCode: undefined,
},
]);

Expand Down
Loading