mrva/vscode-codeql
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

Add unit tests for Python argument options

Browse Source
This commit is contained in:
Koen Vlaswinkel
2024-04-08 14:48:53 +02:00
parent 9e729ba054
commit 8e231d7b1d
2 changed files with 227 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
extensions/ql-vscode/src/model-editor/languages/python/index.ts
View File

@@ -177,11 +177,28 @@ export const python: ModelsAsDataLanguage = {
// Argument and Parameter are equivalent in Python, but we'll use Argument in the model editor
const argumentsList = getArgumentsList(method.methodParameters).map(
(argument, index): MethodArgument => {
if (
method.endpointType === EndpointType.Method &&
argument === "self" &&
index === 0
) {
return {
path: "Argument[self]",
label: "Argument[self]: self",
};
}
// If this is a method, self does not count as an argument index, so we
// should start at 0 for the second argument
if (method.endpointType === EndpointType.Method) {
index -= 1;
}
// Keyword-only arguments end with `:` in the query
if (argument.endsWith(":")) {
return {
path: `Argument[${argument}]`,
label: `Argument[${argument}]`,
label: `Argument[${argument}]: ${argument.substring(0, argument.length - 1)}`,
};
}
@@ -202,13 +219,7 @@ export const python: ModelsAsDataLanguage = {
);
return {
options: [
{
path: "Argument[self]",
label: "Argument[self]",
},
...argumentsList,
],
options: argumentsList,
// If there are no arguments, we will default to "Argument[self]"
defaultArgumentPath:
argumentsList.length > 0 ? argumentsList[0].path : "Argument[self]",

208
extensions/ql-vscode/test/unit-tests/model-editor/languages/python/index.test.ts Normal file
View File

@@ -0,0 +1,208 @@
import type { MethodDefinition } from "../../../../../src/model-editor/method";
import { EndpointType } from "../../../../../src/model-editor/method";
import { python } from "../../../../../src/model-editor/languages/python";
import type { MethodArgumentOptions } from "../../../../../src/model-editor/languages";
const testCases: Array<{
method: MethodDefinition;
options: MethodArgumentOptions;
}> = [
{
method: {
packageName: "requests",
typeName: "Session",
methodName: "foo",
methodParameters: "(a,b,c)",
endpointType: EndpointType.Function,
},
options: {
options: [
{
path: "Argument[0,a:]",
label: "Argument[0,a:]: a",
},
{
path: "Argument[1,b:]",
label: "Argument[1,b:]: b",
},
{
path: "Argument[2,c:]",
label: "Argument[2,c:]: c",
},
],
defaultArgumentPath: "Argument[0,a:]",
},
},
{
method: {
packageName: "requests",
typeName: "Session",
methodName: "foo",
methodParameters: "(self,a,b,c)",
endpointType: EndpointType.Method,
},
options: {
options: [
{
path: "Argument[self]",
label: "Argument[self]: self",
},
{
path: "Argument[0,a:]",
label: "Argument[0,a:]: a",
},
{
path: "Argument[1,b:]",
label: "Argument[1,b:]: b",
},
{
path: "Argument[2,c:]",
label: "Argument[2,c:]: c",
},
],
defaultArgumentPath: "Argument[self]",
},
},
{
method: {
packageName: "requests",
typeName: "Session",
methodName: "foo",
methodParameters: "(a,b,c:)",
endpointType: EndpointType.Function,
},
options: {
options: [
{
path: "Argument[0,a:]",
label: "Argument[0,a:]: a",
},
{
path: "Argument[1,b:]",
label: "Argument[1,b:]: b",
},
{
path: "Argument[c:]",
label: "Argument[c:]: c",
},
],
defaultArgumentPath: "Argument[0,a:]",
},
},
{
method: {
packageName: "requests",
typeName: "Session",
methodName: "foo",
methodParameters: "(a/,b,c:)",
endpointType: EndpointType.Function,
},
options: {
options: [
{
path: "Argument[0]",
label: "Argument[0]: a",
},
{
path: "Argument[1,b:]",
label: "Argument[1,b:]: b",
},
{
path: "Argument[c:]",
label: "Argument[c:]: c",
},
],
defaultArgumentPath: "Argument[0]",
},
},
{
method: {
packageName: "requests",
typeName: "Session",
methodName: "foo",
methodParameters: "(self,a/,b/,c,d,e,f:,g:,h:)",
endpointType: EndpointType.Method,
},
options: {
options: [
{
path: "Argument[self]",
label: "Argument[self]: self",
},
{
path: "Argument[0]",
label: "Argument[0]: a",
},
{
path: "Argument[1]",
label: "Argument[1]: b",
},
{
path: "Argument[2,c:]",
label: "Argument[2,c:]: c",
},
{
path: "Argument[3,d:]",
label: "Argument[3,d:]: d",
},
{
path: "Argument[4,e:]",
label: "Argument[4,e:]: e",
},
{
path: "Argument[f:]",
label: "Argument[f:]: f",
},
{
path: "Argument[g:]",
label: "Argument[g:]: g",
},
{
path: "Argument[h:]",
label: "Argument[h:]: h",
},
],
defaultArgumentPath: "Argument[self]",
},
},
{
method: {
packageName: "requests",
typeName: "Session",
methodName: "foo",
methodParameters: "(self)",
endpointType: EndpointType.Method,
},
options: {
options: [
{
path: "Argument[self]",
label: "Argument[self]: self",
},
],
defaultArgumentPath: "Argument[self]",
},
},
{
method: {
packageName: "requests",
typeName: "Session",
methodName: "foo",
methodParameters: "()",
endpointType: EndpointType.Function,
},
options: {
options: [],
defaultArgumentPath: "Argument[self]",
},
},
];
describe("getArgumentOptions", () => {
it.each(testCases)(
"returns the correct options for $method",
({ method, options }) => {
expect(python.getArgumentOptions(method)).toEqual(options);
},
);
});