Skip to content

Fix add_labels.test.cjs test framework and empty labels behavior #9006

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

Merged
pelikhan merged 3 commits into from
Jan 5, 2026
Merged

Fix add_labels.test.cjs test framework and empty labels behavior #9006

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
d9b7b64
Initial plan
Copilot Jan 5, 2026
e3a15fe
Fix add_labels.test.cjs to use vitest and fix empty labels test expec…
Copilot Jan 5, 2026
f5a2e79
Apply prettier formatting to add_labels.cjs (single-line ternary expr…
Copilot Jan 5, 2026
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
12 changes: 3 additions & 9 deletions actions/setup/js/add_labels.cjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,20 +48,14 @@ async function main(config = {}) {
processedCount++;

// Determine target issue/PR number
const itemNumber = message.item_number !== undefined
? parseInt(String(message.item_number), 10)
: context.payload?.issue?.number || context.payload?.pull_request?.number;
const itemNumber = message.item_number !== undefined ? parseInt(String(message.item_number), 10) : context.payload?.issue?.number || context.payload?.pull_request?.number;

if (!itemNumber || isNaN(itemNumber)) {
const errorMsg = message.item_number !== undefined
? `Invalid item number: ${message.item_number}`
: "No item_number provided and not in issue/PR context";
const errorMsg = message.item_number !== undefined ? `Invalid item number: ${message.item_number}` : "No item_number provided and not in issue/PR context";
core.warning(errorMsg);
return {
success: false,
error: message.item_number !== undefined
? `Invalid item number: ${message.item_number}`
: "No issue/PR number available",
error: message.item_number !== undefined ? `Invalid item number: ${message.item_number}` : "No issue/PR number available",
};
}

Expand Down
98 changes: 49 additions & 49 deletions actions/setup/js/add_labels.test.cjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
// @ts-check
const { describe, it, beforeEach } = require("node:test");
const assert = require("node:assert");
import { describe, it, expect, beforeEach } from "vitest";
const { main } = require("./add_labels.cjs");

describe("add_labels", () => {
Expand All @@ -21,15 +20,15 @@ describe("add_labels", () => {
};

// Capture all logged messages
mockCore.info = (msg) => {
mockCore.info = msg => {
mockCore.infos.push(msg);
mockCore.messages.push({ level: "info", message: msg });
};
mockCore.warning = (msg) => {
mockCore.warning = msg => {
mockCore.warnings.push(msg);
mockCore.messages.push({ level: "warning", message: msg });
};
mockCore.error = (msg) => {
mockCore.error = msg => {
mockCore.errors.push(msg);
mockCore.messages.push({ level: "error", message: msg });
};
Expand Down Expand Up @@ -63,21 +62,21 @@ describe("add_labels", () => {
describe("main factory", () => {
it("should create a handler function with default configuration", async () => {
const handler = await main();
assert.strictEqual(typeof handler, "function");
expect(typeof handler).toBe("function");
});

it("should create a handler function with custom configuration", async () => {
const handler = await main({
allowed: ["bug", "enhancement"],
max: 5,
});
assert.strictEqual(typeof handler, "function");
expect(typeof handler).toBe("function");
});

it("should log configuration on initialization", async () => {
await main({ allowed: ["bug", "enhancement"], max: 3 });
assert.ok(mockCore.infos.some((msg) => msg.includes("max=3")));
assert.ok(mockCore.infos.some((msg) => msg.includes("bug, enhancement")));
expect(mockCore.infos.some(msg => msg.includes("max=3"))).toBe(true);
expect(mockCore.infos.some(msg => msg.includes("bug, enhancement"))).toBe(true);
});
});

Expand All @@ -86,7 +85,7 @@ describe("add_labels", () => {
const handler = await main({ max: 10 });
const addLabelsCalls = [];

mockGithub.rest.issues.addLabels = async (params) => {
mockGithub.rest.issues.addLabels = async params => {
addLabelsCalls.push(params);
return {};
};
Expand All @@ -99,19 +98,19 @@ describe("add_labels", () => {
{}
);

assert.strictEqual(result.success, true);
assert.strictEqual(result.number, 456);
assert.deepStrictEqual(result.labelsAdded, ["bug", "enhancement"]);
assert.strictEqual(addLabelsCalls.length, 1);
assert.strictEqual(addLabelsCalls[0].issue_number, 456);
assert.deepStrictEqual(addLabelsCalls[0].labels, ["bug", "enhancement"]);
expect(result.success).toBe(true);
expect(result.number).toBe(456);
expect(result.labelsAdded).toEqual(["bug", "enhancement"]);
expect(addLabelsCalls.length).toBe(1);
expect(addLabelsCalls[0].issue_number).toBe(456);
expect(addLabelsCalls[0].labels).toEqual(["bug", "enhancement"]);
});

it("should add labels to an issue from context when item_number not provided", async () => {
const handler = await main({ max: 10 });
const addLabelsCalls = [];

mockGithub.rest.issues.addLabels = async (params) => {
mockGithub.rest.issues.addLabels = async params => {
addLabelsCalls.push(params);
return {};
};
Expand All @@ -123,10 +122,10 @@ describe("add_labels", () => {
{}
);

assert.strictEqual(result.success, true);
assert.strictEqual(result.number, 123);
assert.deepStrictEqual(result.labelsAdded, ["documentation"]);
assert.strictEqual(result.contextType, "issue");
expect(result.success).toBe(true);
expect(result.number).toBe(123);
expect(result.labelsAdded).toEqual(["documentation"]);
expect(result.contextType).toBe("issue");
});

it("should add labels to a pull request from context", async () => {
Expand All @@ -139,7 +138,7 @@ describe("add_labels", () => {
const handler = await main({ max: 10 });
const addLabelsCalls = [];

mockGithub.rest.issues.addLabels = async (params) => {
mockGithub.rest.issues.addLabels = async params => {
addLabelsCalls.push(params);
return {};
};
Expand All @@ -151,9 +150,9 @@ describe("add_labels", () => {
{}
);

assert.strictEqual(result.success, true);
assert.strictEqual(result.number, 789);
assert.strictEqual(result.contextType, "pull request");
expect(result.success).toBe(true);
expect(result.number).toBe(789);
expect(result.contextType).toBe("pull request");
});

it("should handle invalid item_number", async () => {
Expand All @@ -167,8 +166,8 @@ describe("add_labels", () => {
{}
);

assert.strictEqual(result.success, false);
assert.ok(result.error.includes("Invalid item number"));
expect(result.success).toBe(false);
expect(result.error.includes("Invalid item number")).toBe(true);
});

it("should handle missing item_number and no context", async () => {
Expand All @@ -183,8 +182,8 @@ describe("add_labels", () => {
{}
);

assert.strictEqual(result.success, false);
assert.ok(result.error.includes("No issue/PR number available"));
expect(result.success).toBe(false);
expect(result.error.includes("No issue/PR number available")).toBe(true);
});

it("should respect max count limit", async () => {
Expand All @@ -198,7 +197,7 @@ describe("add_labels", () => {
},
{}
);
assert.strictEqual(result1.success, true);
expect(result1.success).toBe(true);

// Second call succeeds
const result2 = await handler(
Expand All @@ -208,7 +207,7 @@ describe("add_labels", () => {
},
{}
);
assert.strictEqual(result2.success, true);
expect(result2.success).toBe(true);

// Third call should fail
const result3 = await handler(
Expand All @@ -218,8 +217,8 @@ describe("add_labels", () => {
},
{}
);
assert.strictEqual(result3.success, false);
assert.ok(result3.error.includes("Max count"));
expect(result3.success).toBe(false);
expect(result3.error.includes("Max count")).toBe(true);
});

it("should filter labels based on allowed list", async () => {
Expand All @@ -229,7 +228,7 @@ describe("add_labels", () => {
});

const addLabelsCalls = [];
mockGithub.rest.issues.addLabels = async (params) => {
mockGithub.rest.issues.addLabels = async params => {
addLabelsCalls.push(params);
return {};
};
Expand All @@ -242,8 +241,8 @@ describe("add_labels", () => {
{}
);

assert.strictEqual(result.success, true);
assert.deepStrictEqual(result.labelsAdded, ["bug", "enhancement"]);
expect(result.success).toBe(true);
expect(result.labelsAdded).toEqual(["bug", "enhancement"]);
});

it("should handle empty labels array", async () => {
Expand All @@ -257,8 +256,9 @@ describe("add_labels", () => {
{}
);

assert.strictEqual(result.success, false);
assert.ok(result.error.includes("labels must be an array") || result.error.includes("No valid labels"));
expect(result.success).toBe(true);
expect(result.labelsAdded).toEqual([]);
expect(result.message).toBe("No valid labels found");
});

it("should handle API errors gracefully", async () => {
Expand All @@ -276,15 +276,15 @@ describe("add_labels", () => {
{}
);

assert.strictEqual(result.success, false);
assert.ok(result.error.includes("API Error"));
expect(result.success).toBe(false);
expect(result.error.includes("API Error")).toBe(true);
});

it("should deduplicate labels", async () => {
const handler = await main({ max: 10 });
const addLabelsCalls = [];

mockGithub.rest.issues.addLabels = async (params) => {
mockGithub.rest.issues.addLabels = async params => {
addLabelsCalls.push(params);
return {};
};
Expand All @@ -297,15 +297,15 @@ describe("add_labels", () => {
{}
);

assert.strictEqual(result.success, true);
assert.deepStrictEqual(result.labelsAdded, ["bug", "enhancement"]);
expect(result.success).toBe(true);
expect(result.labelsAdded).toEqual(["bug", "enhancement"]);
});

it("should sanitize and trim label names", async () => {
const handler = await main({ max: 10 });
const addLabelsCalls = [];

mockGithub.rest.issues.addLabels = async (params) => {
mockGithub.rest.issues.addLabels = async params => {
addLabelsCalls.push(params);
return {};
};
Expand All @@ -318,15 +318,15 @@ describe("add_labels", () => {
{}
);

assert.strictEqual(result.success, true);
assert.ok(result.labelsAdded.length > 0);
expect(result.success).toBe(true);
expect(result.labelsAdded.length).toBeGreaterThan(0);
});

it("should use spread operator for context.repo", async () => {
const handler = await main({ max: 10 });
const addLabelsCalls = [];

mockGithub.rest.issues.addLabels = async (params) => {
mockGithub.rest.issues.addLabels = async params => {
addLabelsCalls.push(params);
return {};
};
Expand All @@ -339,8 +339,8 @@ describe("add_labels", () => {
{}
);

assert.strictEqual(addLabelsCalls[0].owner, "test-owner");
assert.strictEqual(addLabelsCalls[0].repo, "test-repo");
expect(addLabelsCalls[0].owner).toBe("test-owner");
expect(addLabelsCalls[0].repo).toBe("test-repo");
});
});
});