Add test to confirm this works with custom modes

This commit is contained in:
Matt Rubens
2025-01-24 00:12:12 -05:00
parent 7413d6494e
commit 6c3c216034
4 changed files with 236 additions and 58 deletions

View File

@@ -22,6 +22,7 @@ const GroupOptionsSchema = z.object({
},
{ message: "Invalid regular expression pattern" },
),
fileRegexDescription: z.string().optional(),
})
// Schema for a group entry - either a tool group string or a tuple of [group, options]

View File

@@ -1,26 +1,147 @@
import { CustomModeSchema } from "../CustomModesSchema"
import { ZodError } from "zod"
import { CustomModeSchema, validateCustomMode } from "../CustomModesSchema"
import { ModeConfig } from "../../../shared/modes"
describe("CustomModeSchema", () => {
it("validates a basic mode configuration", () => {
describe("validateCustomMode", () => {
test("accepts valid mode configuration", () => {
const validMode = {
slug: "test-mode",
slug: "test",
name: "Test Mode",
roleDefinition: "Test role definition",
groups: ["read", "browser"],
}
groups: ["read"] as const,
} satisfies ModeConfig
expect(() => CustomModeSchema.parse(validMode)).not.toThrow()
expect(() => validateCustomMode(validMode)).not.toThrow()
})
it("validates a mode with file restrictions", () => {
const modeWithFileRestrictions = {
test("accepts mode with multiple groups", () => {
const validMode = {
slug: "test",
name: "Test Mode",
roleDefinition: "Test role definition",
groups: ["read", "edit", "browser"] as const,
} satisfies ModeConfig
expect(() => validateCustomMode(validMode)).not.toThrow()
})
test("accepts mode with optional customInstructions", () => {
const validMode = {
slug: "test",
name: "Test Mode",
roleDefinition: "Test role definition",
customInstructions: "Custom instructions",
groups: ["read"] as const,
} satisfies ModeConfig
expect(() => validateCustomMode(validMode)).not.toThrow()
})
test("rejects missing required fields", () => {
const invalidModes = [
{}, // All fields missing
{ name: "Test" }, // Missing most fields
{
name: "Test",
roleDefinition: "Role",
}, // Missing slug and groups
]
invalidModes.forEach((invalidMode) => {
expect(() => validateCustomMode(invalidMode)).toThrow(ZodError)
})
})
test("rejects invalid slug format", () => {
const invalidMode = {
slug: "not@a@valid@slug",
name: "Test Mode",
roleDefinition: "Test role definition",
groups: ["read"] as const,
} satisfies Omit<ModeConfig, "slug"> & { slug: string }
expect(() => validateCustomMode(invalidMode)).toThrow(ZodError)
expect(() => validateCustomMode(invalidMode)).toThrow("Slug must contain only letters numbers and dashes")
})
test("rejects empty strings in required fields", () => {
const emptyNameMode = {
slug: "123e4567-e89b-12d3-a456-426614174000",
name: "",
roleDefinition: "Test role definition",
groups: ["read"] as const,
} satisfies ModeConfig
const emptyRoleMode = {
slug: "123e4567-e89b-12d3-a456-426614174000",
name: "Test Mode",
roleDefinition: "",
groups: ["read"] as const,
} satisfies ModeConfig
expect(() => validateCustomMode(emptyNameMode)).toThrow("Name is required")
expect(() => validateCustomMode(emptyRoleMode)).toThrow("Role definition is required")
})
test("rejects invalid group configurations", () => {
const invalidGroupMode = {
slug: "123e4567-e89b-12d3-a456-426614174000",
name: "Test Mode",
roleDefinition: "Test role definition",
groups: ["not-a-valid-group"] as any,
}
expect(() => validateCustomMode(invalidGroupMode)).toThrow(ZodError)
})
test("rejects empty groups array", () => {
const invalidMode = {
slug: "123e4567-e89b-12d3-a456-426614174000",
name: "Test Mode",
roleDefinition: "Test role definition",
groups: [] as const,
} satisfies ModeConfig
expect(() => validateCustomMode(invalidMode)).toThrow("At least one tool group is required")
})
test("handles null and undefined gracefully", () => {
expect(() => validateCustomMode(null)).toThrow(ZodError)
expect(() => validateCustomMode(undefined)).toThrow(ZodError)
})
test("rejects non-object inputs", () => {
const invalidInputs = [42, "string", true, [], () => {}]
invalidInputs.forEach((input) => {
expect(() => validateCustomMode(input)).toThrow(ZodError)
})
})
})
describe("fileRegex", () => {
it("validates a mode with file restrictions and descriptions", () => {
const modeWithJustRegex = {
slug: "markdown-editor",
name: "Markdown Editor",
roleDefinition: "Markdown editing mode",
groups: ["read", ["edit", { fileRegex: "\\.md$" }], "browser"],
}
expect(() => CustomModeSchema.parse(modeWithFileRestrictions)).not.toThrow()
const modeWithDescription = {
slug: "docs-editor",
name: "Documentation Editor",
roleDefinition: "Documentation editing mode",
groups: [
"read",
["edit", { fileRegex: "\\.(md|txt)$", fileRegexDescription: "Documentation files only" }],
"browser",
],
}
expect(() => CustomModeSchema.parse(modeWithJustRegex)).not.toThrow()
expect(() => CustomModeSchema.parse(modeWithDescription)).not.toThrow()
})
it("validates file regex patterns", () => {
@@ -69,4 +190,5 @@ describe("CustomModeSchema", () => {
expect(() => CustomModeSchema.parse(modeWithNoGroups)).toThrow(/At least one tool group is required/)
})
})
})

View File

@@ -8,7 +8,6 @@ export function getRulesSection(
supportsComputerUse: boolean,
diffStrategy?: DiffStrategy,
context?: vscode.ExtensionContext,
diffEnabled?: boolean,
): string {
const settingsDir = context ? path.join(context.globalStorageUri.fsPath, "settings") : "<settings directory>"
const customModesPath = path.join(settingsDir, "cline_custom_modes.json")

View File

@@ -84,6 +84,62 @@ describe("isToolAllowedForMode", () => {
expect(diffError).toBeInstanceOf(FileRestrictionError)
})
it("uses description in file restriction error for custom modes", () => {
const customModesWithDescription: ModeConfig[] = [
{
slug: "docs-editor",
name: "Documentation Editor",
roleDefinition: "You are a documentation editor",
groups: [
"read",
["edit", { fileRegex: "\\.(md|txt)$", description: "Documentation files only" }],
"browser",
],
},
]
// Test write_to_file with non-matching file
const writeError = isToolAllowedForMode(
"write_to_file",
"docs-editor",
customModesWithDescription,
undefined,
"test.js",
)
expect(writeError).toBeInstanceOf(FileRestrictionError)
expect((writeError as FileRestrictionError).message).toContain("Documentation files only")
// Test apply_diff with non-matching file
const diffError = isToolAllowedForMode(
"apply_diff",
"docs-editor",
customModesWithDescription,
undefined,
"test.js",
)
expect(diffError).toBeInstanceOf(FileRestrictionError)
expect((diffError as FileRestrictionError).message).toContain("Documentation files only")
// Test that matching files are allowed
const mdResult = isToolAllowedForMode(
"write_to_file",
"docs-editor",
customModesWithDescription,
undefined,
"test.md",
)
expect(mdResult).toBe(true)
const txtResult = isToolAllowedForMode(
"write_to_file",
"docs-editor",
customModesWithDescription,
undefined,
"test.txt",
)
expect(txtResult).toBe(true)
})
it("allows ask mode to edit markdown files only", () => {
// Should allow editing markdown files
const mdResult = isToolAllowedForMode("write_to_file", "ask", [], undefined, "test.md")