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

pass toolchain context, fixes #441 #445

Merged
merged 2 commits into from
Nov 18, 2023
Merged

pass toolchain context, fixes #441 #445

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9381f01
fix: pass in toolchain when requesting context, and log output
kristof-mattei Nov 18, 2023
52ca270
fix: consolidate toolchain building
kristof-mattei Nov 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
47 changes: 27 additions & 20 deletions dist/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91156,31 +91156,31 @@ const exec = __importStar(__nccwpck_require__(1514));
const core_1 = __nccwpck_require__(4543);
const outputParser_1 = __nccwpck_require__(3237);
const reporter_1 = __nccwpck_require__(5021);
async function buildContext(program) {
async function buildContext(program, toolchain) {
const context = {
cargo: "",
clippy: "",
rustc: "",
};
await Promise.all([
await exec.exec("rustc", ["-V"], {
silent: true,
await exec.exec("rustc", buildToolchainArguments(toolchain, ["-V"]), {
silent: false,
listeners: {
stdout: (buffer) => {
return (context.rustc = buffer.toString().trim());
},
},
}),
await program.call(["-V"], {
silent: true,
await program.call(buildToolchainArguments(toolchain, ["-V"]), {
silent: false,
listeners: {
stdout: (buffer) => {
return (context.cargo = buffer.toString().trim());
},
},
}),
await program.call(["clippy", "-V"], {
silent: true,
await program.call(buildToolchainArguments(toolchain, ["clippy", "-V"]), {
silent: false,
listeners: {
stdout: (buffer) => {
return (context.clippy = buffer.toString().trim());
Expand All @@ -91191,7 +91191,7 @@ async function buildContext(program) {
return context;
}
async function runClippy(actionInput, program) {
const args = buildArgs(actionInput);
const args = buildClippyArguments(actionInput);
const outputParser = new outputParser_1.OutputParser();
const options = {
ignoreReturnCode: true,
Expand Down Expand Up @@ -91229,26 +91229,33 @@ function getProgram(useCross) {
}
async function run(actionInput) {
const program = await getProgram(actionInput.useCross);
const context = await buildContext(program);
const context = await buildContext(program, actionInput.toolchain);
const { stats, annotations, exitCode } = await runClippy(actionInput, program);
await new reporter_1.Reporter().report(stats, annotations, context);
if (exitCode !== 0) {
throw new Error(`Clippy had exited with the ${exitCode} exit code`);
}
}
exports.run = run;
function buildArgs(actionInput) {
function buildToolchainArguments(toolchain, after) {
const args = [];
// Toolchain selection MUST go first in any condition
if (actionInput.toolchain) {
args.push(`+${actionInput.toolchain}`);
}
args.push("clippy");
// `--message-format=json` should just right after the `cargo clippy`
// because usually people are adding the `-- -D warnings` at the end
// of arguments and it will mess up the output.
args.push("--message-format=json");
return args.concat(actionInput.args);
if (toolchain) {
args.push(`+${toolchain}`);
}
args.push(...after);
return args;
}
function buildClippyArguments(actionInput) {
// Toolchain selection MUST go first in any condition!
return buildToolchainArguments(actionInput.toolchain, [
"clippy",
// `--message-format=json` should just right after the `cargo clippy`
// because usually people are adding the `-- -D warnings` at the end
// of arguments and it will mess up the output.
"--message-format=json",
// and the rest
...actionInput.args,
]);
}


Expand Down
2 changes: 1 addition & 1 deletion dist/index.js.map
View file
Open in desktop

Large diffs are not rendered by default.

49 changes: 29 additions & 20 deletions src/clippy.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,32 +17,32 @@ interface ClippyResult {
exitCode: number;
}

async function buildContext(program: Program): Promise<Context> {
async function buildContext(program: Program, toolchain: string | undefined): Promise<Context> {
const context: Context = {
cargo: "",
clippy: "",
rustc: "",
};

await Promise.all([
await exec.exec("rustc", ["-V"], {
silent: true,
await exec.exec("rustc", buildToolchainArguments(toolchain, ["-V"]), {
silent: false,
listeners: {
stdout: (buffer: Buffer) => {
return (context.rustc = buffer.toString().trim());
},
},
}),
await program.call(["-V"], {
silent: true,
await program.call(buildToolchainArguments(toolchain, ["-V"]), {
silent: false,
listeners: {
stdout: (buffer: Buffer) => {
return (context.cargo = buffer.toString().trim());
},
},
}),
await program.call(["clippy", "-V"], {
silent: true,
await program.call(buildToolchainArguments(toolchain, ["clippy", "-V"]), {
silent: false,
listeners: {
stdout: (buffer: Buffer) => {
return (context.clippy = buffer.toString().trim());
Expand All @@ -55,7 +55,7 @@ async function buildContext(program: Program): Promise<Context> {
}

async function runClippy(actionInput: input.ParsedInput, program: Program): Promise<ClippyResult> {
const args = buildArgs(actionInput);
const args = buildClippyArguments(actionInput);
const outputParser = new OutputParser();

const options: exec.ExecOptions = {
Expand Down Expand Up @@ -99,7 +99,7 @@ function getProgram(useCross: boolean): Promise<Program> {
export async function run(actionInput: input.ParsedInput): Promise<void> {
const program: Program = await getProgram(actionInput.useCross);

const context = await buildContext(program);
const context = await buildContext(program, actionInput.toolchain);

const { stats, annotations, exitCode } = await runClippy(actionInput, program);

Expand All @@ -110,20 +110,29 @@ export async function run(actionInput: input.ParsedInput): Promise<void> {
}
}

function buildArgs(actionInput: input.ParsedInput): string[] {
const args: string[] = [];
function buildToolchainArguments(toolchain: string | undefined, after: string[]): string[] {
const args = [];

// Toolchain selection MUST go first in any condition
if (actionInput.toolchain) {
args.push(`+${actionInput.toolchain}`);
if (toolchain) {
args.push(`+${toolchain}`);
}

args.push("clippy");
args.push(...after);

// `--message-format=json` should just right after the `cargo clippy`
// because usually people are adding the `-- -D warnings` at the end
// of arguments and it will mess up the output.
args.push("--message-format=json");
return args;
}

function buildClippyArguments(actionInput: input.ParsedInput): string[] {
// Toolchain selection MUST go first in any condition!
return buildToolchainArguments(actionInput.toolchain, [
"clippy",

return args.concat(actionInput.args);
// `--message-format=json` should just right after the `cargo clippy`
// because usually people are adding the `-- -D warnings` at the end
// of arguments and it will mess up the output.
"--message-format=json",

// and the rest
...actionInput.args,
]);
}
29 changes: 28 additions & 1 deletion src/tests/clippy.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,33 @@ describe("clippy", () => {
await expect(run(actionInput)).rejects.toThrow(/Clippy had exited with the (\d)+ exit code/);
});

it("records versions with toolchain", async () => {
const reportSpy = jest.spyOn(Reporter.prototype, "report");
jest.spyOn(exec, "exec").mockImplementation((commandline: string, args?: string[], options?: exec.ExecOptions) => {
if (commandline.endsWith("cargo")) {
if (args?.[0] === "+nightly" && args?.[1] === "-V") {
options?.listeners?.stdout?.(Buffer.from("cargo version"));
} else if (args?.[0] === "+nightly" && args?.[1] === "clippy" && args?.[2] === "-V") {
options?.listeners?.stdout?.(Buffer.from("clippy version"));
}
} else if (commandline === "rustc" && args?.[0] === "+nightly" && args?.[1] === "-V") {
options?.listeners?.stdout?.(Buffer.from("rustc version"));
}
return Promise.resolve(0);
});

const actionInput: ParsedInput = {
toolchain: "nightly",
args: [],
useCross: false,
workingDirectory: undefined,
};

await expect(run(actionInput)).resolves.toBeUndefined();

expect(reportSpy).toBeCalledWith({ error: 0, help: 0, ice: 0, note: 0, warning: 0 }, [], { cargo: "cargo version", clippy: "clippy version", rustc: "rustc version" });
});

it("records versions", async () => {
const reportSpy = jest.spyOn(Reporter.prototype, "report");
jest.spyOn(exec, "exec").mockImplementation((commandline: string, args?: string[], options?: exec.ExecOptions) => {
Expand All @@ -78,7 +105,7 @@ describe("clippy", () => {
});

const actionInput: ParsedInput = {
toolchain: "stable",
toolchain: undefined,
args: [],
useCross: false,
workingDirectory: undefined,
Expand Down