actions/languageservices
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #138 from github/joshmgross/complete-reusable-job-inputs

Browse Source 
Support completing reusable job inputs
This commit is contained in:
Josh Gross
2023-02-08 10:39:04 -05:00
committed by GitHub
parent 672b989fcd 27cde6715c
commit a019b70280
6 changed files with 187 additions and 72 deletions
Download Patch File Download Diff File Expand all files Collapse all files
actions-languageservice/src/complete.reusable-workflows.test.ts
+59
View File
@@ -0,0 +1,59 @@
import {CompletionItem, MarkupContent} from "vscode-languageserver-types";
import {complete} from "./complete";
import {getPositionFromCursor} from "./test-utils/cursor-position";
import {testFileProvider} from "./test-utils/test-file-provider";
function mapResult(result: CompletionItem[]) {
return result.map(x => {
return {label: x.label, description: (x.documentation as MarkupContent).value};
});
}
describe("completion with reusable workflows", () => {
it("completes job inputs", async () => {
const input = `
on: push
jobs:
build:
uses: ./reusable-workflow-with-inputs.yaml
with:
|
`;
const result = await complete(...getPositionFromCursor(input), {fileProvider: testFileProvider});
expect(result).not.toBeUndefined();
expect(mapResult(result)).toEqual([
{
label: "name",
description: "An optional name"
},
{
label: "username",
description: "A username passed from the caller workflow"
}
]);
});
it("filters out existing job inputs", async () => {
const input = `
on: push
jobs:
build:
uses: ./reusable-workflow-with-inputs.yaml
with:
username: monalisa
|
`;
const result = await complete(...getPositionFromCursor(input), {fileProvider: testFileProvider});
expect(result).not.toBeUndefined();
expect(mapResult(result)).toEqual([
{
label: "name",
description: "An optional name"
}
]);
});
});
actions-languageservice/src/test-utils/test-file-provider.ts
+75
View File
@@ -0,0 +1,75 @@
import {FileProvider} from "@github/actions-workflow-parser/workflows/file-provider";
import {fileIdentifier} from "@github/actions-workflow-parser/workflows/file-reference";
export const testFileProvider: FileProvider = {
getFileContent: async ref => {
switch (fileIdentifier(ref)) {
case "monalisa/octocat/workflow.yaml@main":
return {
name: "monalisa/octocat/workflow.yaml",
content: `
on: workflow_call
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
`
};
case "monalisa/octocat/.github/workflows/non-reusable-workflow.yaml@main":
return {
name: "monalisa/octocat/.github/workflows/non-reusable-workflow.yaml",
content: `
on: push
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
`
};
case "./reusable-workflow.yaml":
return {
name: "reusable-workflow.yaml",
content: `
on: workflow_call
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
`
};
case "./reusable-workflow-with-inputs.yaml":
return {
name: "reusable-workflow-with-inputs.yaml",
content: `
on:
workflow_call:
inputs:
username:
description: 'A username passed from the caller workflow'
required: true
type: string
name:
description: 'An optional name'
required: false
type: string
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
`
};
default:
throw new Error("File not found");
}
}
};
actions-languageservice/src/validate.ts
+7 -2
View File
@@ -118,15 +118,20 @@ async function additionalValidations(
// Allowed values coming from the schema have already been validated. Only check if
// a value provider is defined for a token and if it is, validate the values match.
if (config?.valueProviderConfig && token.range && validationDefinition) {
if (token.range && validationDefinition) {
const defKey = validationDefinition.key;
if (defKey === "step-with") {
// Action inputs should be validated already in validateAction
continue;
}
if (defKey === "workflow-job-with") {
// Reusable workflow job inputs are validated by the parser
continue;
}
// Try a custom value provider first
let valueProvider = config.valueProviderConfig[defKey];
let valueProvider = config?.valueProviderConfig?.[defKey];
if (!valueProvider) {
// fall back to default
valueProvider = defaultValueProviders[defKey];
actions-languageservice/src/validate.workflow-references.test.ts
+1 -70
View File
@@ -1,76 +1,7 @@
import {FileProvider} from "@github/actions-workflow-parser/workflows/file-provider";
import {fileIdentifier} from "@github/actions-workflow-parser/workflows/file-reference";
import {createDocument} from "./test-utils/document";
import {testFileProvider} from "./test-utils/test-file-provider";
import {validate} from "./validate";
const testFileProvider: FileProvider = {
getFileContent: async ref => {
switch (fileIdentifier(ref)) {
case "monalisa/octocat/workflow.yaml@main":
return {
name: "monalisa/octocat/workflow.yaml",
content: `
on: workflow_call
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
`
};
case "monalisa/octocat/.github/workflows/non-reusable-workflow.yaml@main":
return {
name: "monalisa/octocat/.github/workflows/non-reusable-workflow.yaml",
content: `
on: push
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
`
};
case "./reusable-workflow.yaml":
return {
name: "reusable-workflow.yaml",
content: `
on: workflow_call
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
`
};
case "./reusable-workflow-with-inputs.yaml":
return {
name: "reusable-workflow-with-inputs.yaml",
content: `
on:
workflow_call:
inputs:
username:
description: 'A username passed from the caller workflow'
required: true
type: string
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
`
};
default:
throw new Error("File not found");
}
}
};
describe("workflow references validation", () => {
it("invalid workflow reference", async () => {
const input = `
actions-languageservice/src/value-providers/default.ts
+5
View File
@@ -1,6 +1,7 @@
import {WorkflowContext} from "../context/workflow-context";
import {ValueProviderConfig, ValueProviderKind} from "./config";
import {needs} from "./needs";
import {reusableJobInputs} from "./reusable-job-inputs";
import {stringsToValues} from "./strings-to-values";
export const defaultValueProviders: ValueProviderConfig = {
@@ -8,6 +9,10 @@ export const defaultValueProviders: ValueProviderConfig = {
kind: ValueProviderKind.AllowedValues,
get: needs
},
"workflow-job-with": {
kind: ValueProviderKind.AllowedValues,
get: async context => reusableJobInputs(context)
},
"runs-on": {
kind: ValueProviderKind.SuggestedValues,
get: async (_: WorkflowContext) =>
actions-languageservice/src/value-providers/reusable-job-inputs.ts
+40
View File
@@ -0,0 +1,40 @@
import {MappingToken} from "@github/actions-workflow-parser/templates/tokens/mapping-token";
import {TemplateToken} from "@github/actions-workflow-parser/templates/tokens/template-token";
import {isMapping, isString} from "@github/actions-workflow-parser/templates/tokens/type-guards";
import {WorkflowContext} from "../context/workflow-context";
import {Value} from "./config";
import {stringsToValues} from "./strings-to-values";
export function reusableJobInputs(context: WorkflowContext): Value[] {
if (!context.reusableWorkflowJob?.["input-definitions"]) {
return [];
}
const values: Value[] = [];
for (const {key, value} of context.reusableWorkflowJob["input-definitions"]) {
if (!isString(key)) {
continue;
}
values.push({
label: key.value,
description: inputDescription(value)
});
}
return values;
}
function inputDescription(inputDef: TemplateToken): string | undefined {
if (!isMapping(inputDef)) {
return undefined;
}
const descriptionToken = inputDef.find("description");
if (!descriptionToken || !isString(descriptionToken)) {
return undefined;
}
return descriptionToken.value;
}