Skip to content

Validate expression block-scalar chomping #215

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

Draft
ericsciple wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Validate expression block-scalar chomping #215

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
58 changes: 58 additions & 0 deletions languageservice/src/validate.expressions-chomp-allowed.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
import {registerLogger} from "./log";
import {createDocument} from "./test-utils/document";
import {TestLogger} from "./test-utils/logger";
import {clearCache} from "./utils/workflow-cache";
import {validate} from "./validate";

registerLogger(new TestLogger());

beforeEach(() => {
clearCache();
});

describe("block scalar chomping - allowed cases", () => {
it("does NOT warn for step.run with clip chomping (exception)", async () => {
const input = `
on: push
jobs:
build:
runs-on: ubuntu-latest
steps:
- run: |
echo \${{ github.event_name }}
`;
const result = await validate(createDocument("wf.yaml", input));

expect(result.filter(d => d.code === "expression-block-scalar-chomping")).toEqual([]);
});

it("does not warn for inline expression", async () => {
const input = `
on: push
jobs:
build:
if: \${{ github.event_name == 'push' }}
runs-on: ubuntu-latest
steps:
- run: echo hi
`;
const result = await validate(createDocument("wf.yaml", input));

expect(result.filter(d => d.code === "expression-block-scalar-chomping")).toEqual([]);
});

it("does not warn for quoted string", async () => {
const input = `
on: push
jobs:
build:
if: "\${{ github.event_name == 'push' }}"
runs-on: ubuntu-latest
steps:
- run: echo hi
`;
const result = await validate(createDocument("wf.yaml", input));

expect(result.filter(d => d.code === "expression-block-scalar-chomping")).toEqual([]);
});
});
142 changes: 142 additions & 0 deletions languageservice/src/validate.expressions-chomp-error-boolean.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,142 @@
import {DiagnosticSeverity} from "vscode-languageserver-types";
import {registerLogger} from "./log";
import {createDocument} from "./test-utils/document";
import {TestLogger} from "./test-utils/logger";
import {clearCache} from "./utils/workflow-cache";
import {validate} from "./validate";

registerLogger(new TestLogger());

beforeEach(() => {
clearCache();
});

describe("block scalar chomping - boolean fields", () => {
describe("job continue-on-error", () => {
it("errors with clip chomping", async () => {
const input = `
on: push
jobs:
build:
runs-on: ubuntu-latest
continue-on-error: |
\${{ matrix.experimental }}
steps:
- run: echo hi
`;
const result = await validate(createDocument("wf.yaml", input));

expect(result).toContainEqual(
expect.objectContaining({
message:
"Block scalar adds trailing newline which breaks boolean evaluation. Use '|-' to strip trailing newlines.",
code: "expression-block-scalar-chomping",
severity: DiagnosticSeverity.Error
})
);
});

it("errors with keep chomping", async () => {
const input = `
on: push
jobs:
build:
runs-on: ubuntu-latest
continue-on-error: |+
\${{ matrix.experimental }}
steps:
- run: echo hi
`;
const result = await validate(createDocument("wf.yaml", input));

expect(result).toContainEqual(
expect.objectContaining({
message:
"Block scalar adds trailing newline which breaks boolean evaluation. Use '|-' to strip trailing newlines.",
code: "expression-block-scalar-chomping",
severity: DiagnosticSeverity.Error
})
);
});

it("does not error with strip chomping", async () => {
const input = `
on: push
jobs:
build:
runs-on: ubuntu-latest
continue-on-error: |-
\${{ matrix.experimental }}
steps:
- run: echo hi
`;
const result = await validate(createDocument("wf.yaml", input));

expect(result.filter(d => d.code === "expression-block-scalar-chomping")).toEqual([]);
});
});

describe("step continue-on-error", () => {
it("errors with clip chomping", async () => {
const input = `
on: push
jobs:
build:
runs-on: ubuntu-latest
steps:
- run: echo hi
continue-on-error: |
\${{ matrix.experimental }}
`;
const result = await validate(createDocument("wf.yaml", input));

expect(result).toContainEqual(
expect.objectContaining({
message:
"Block scalar adds trailing newline which breaks boolean evaluation. Use '|-' to strip trailing newlines.",
code: "expression-block-scalar-chomping",
severity: DiagnosticSeverity.Error
})
);
});

it("errors with keep chomping", async () => {
const input = `
on: push
jobs:
build:
runs-on: ubuntu-latest
steps:
- run: echo hi
continue-on-error: |+
\${{ matrix.experimental }}
`;
const result = await validate(createDocument("wf.yaml", input));

expect(result).toContainEqual(
expect.objectContaining({
message:
"Block scalar adds trailing newline which breaks boolean evaluation. Use '|-' to strip trailing newlines.",
code: "expression-block-scalar-chomping",
severity: DiagnosticSeverity.Error
})
);
});

it("does not error with strip chomping", async () => {
const input = `
on: push
jobs:
build:
runs-on: ubuntu-latest
steps:
- run: echo hi
continue-on-error: |-
\${{ matrix.experimental }}
`;
const result = await validate(createDocument("wf.yaml", input));

expect(result.filter(d => d.code === "expression-block-scalar-chomping")).toEqual([]);
});
});
});
188 changes: 188 additions & 0 deletions languageservice/src/validate.expressions-chomp-error-if.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,188 @@
import {DiagnosticSeverity} from "vscode-languageserver-types";
import {registerLogger} from "./log";
import {createDocument} from "./test-utils/document";
import {TestLogger} from "./test-utils/logger";
import {clearCache} from "./utils/workflow-cache";
import {validate} from "./validate";

registerLogger(new TestLogger());

beforeEach(() => {
clearCache();
});

describe("block scalar chomping - if fields", () => {
describe("job-if", () => {
it("errors with clip chomping", async () => {
const input = `
on: push
jobs:
build:
if: |
\${{ github.event_name == 'push' }}
runs-on: ubuntu-latest
steps:
- run: echo hi
`;
const result = await validate(createDocument("wf.yaml", input));

expect(result).toContainEqual(
expect.objectContaining({
message:
"Block scalar adds trailing newline which breaks boolean evaluation. Use '|-' to strip trailing newlines.",
code: "expression-block-scalar-chomping",
severity: DiagnosticSeverity.Error
})
);
});

it("errors with keep chomping", async () => {
const input = `
on: push
jobs:
build:
if: |+
\${{ github.event_name == 'push' }}
runs-on: ubuntu-latest
steps:
- run: echo hi
`;
const result = await validate(createDocument("wf.yaml", input));

expect(result).toContainEqual(
expect.objectContaining({
message:
"Block scalar adds trailing newline which breaks boolean evaluation. Use '|-' to strip trailing newlines.",
code: "expression-block-scalar-chomping",
severity: DiagnosticSeverity.Error
})
);
});

it("does not error with strip chomping", async () => {
const input = `
on: push
jobs:
build:
if: |-
\${{ github.event_name == 'push' }}
runs-on: ubuntu-latest
steps:
- run: echo hi
`;
const result = await validate(createDocument("wf.yaml", input));

expect(result.filter(d => d.code === "expression-block-scalar-chomping")).toEqual([]);
});

it("errors without ${{ }} (isExpression)", async () => {
const input = `
on: push
jobs:
build:
if: |
github.event_name == 'push'
runs-on: ubuntu-latest
steps:
- run: echo hi
`;
const result = await validate(createDocument("wf.yaml", input));

expect(result).toContainEqual(
expect.objectContaining({
message:
"Block scalar adds trailing newline which breaks boolean evaluation. Use '|-' to strip trailing newlines.",
code: "expression-block-scalar-chomping",
severity: DiagnosticSeverity.Error
})
);
});

it("uses > indicator in error message for folded scalars", async () => {
const input = `
on: push
jobs:
build:
if: >
\${{ github.event_name == 'push' }}
runs-on: ubuntu-latest
steps:
- run: echo hi
`;
const result = await validate(createDocument("wf.yaml", input));

expect(result).toContainEqual(
expect.objectContaining({
message:
"Block scalar adds trailing newline which breaks boolean evaluation. Use '>-' to strip trailing newlines.",
code: "expression-block-scalar-chomping",
severity: DiagnosticSeverity.Error
})
);
});
});

describe("step-if", () => {
it("errors with clip chomping", async () => {
const input = `
on: push
jobs:
build:
runs-on: ubuntu-latest
steps:
- if: |
\${{ github.event_name == 'push' }}
run: echo hi
`;
const result = await validate(createDocument("wf.yaml", input));

expect(result).toContainEqual(
expect.objectContaining({
message:
"Block scalar adds trailing newline which breaks boolean evaluation. Use '|-' to strip trailing newlines.",
code: "expression-block-scalar-chomping",
severity: DiagnosticSeverity.Error
})
);
});

it("errors with keep chomping", async () => {
const input = `
on: push
jobs:
build:
runs-on: ubuntu-latest
steps:
- if: |+
\${{ github.event_name == 'push' }}
run: echo hi
`;
const result = await validate(createDocument("wf.yaml", input));

expect(result).toContainEqual(
expect.objectContaining({
message:
"Block scalar adds trailing newline which breaks boolean evaluation. Use '|-' to strip trailing newlines.",
code: "expression-block-scalar-chomping",
severity: DiagnosticSeverity.Error
})
);
});

it("does not error with strip chomping", async () => {
const input = `
on: push
jobs:
build:
runs-on: ubuntu-latest
steps:
- if: |-
\${{ github.event_name == 'push' }}
run: echo hi
`;
const result = await validate(createDocument("wf.yaml", input));

expect(result.filter(d => d.code === "expression-block-scalar-chomping")).toEqual([]);
});
});
});
Loading
Loading