Commit4ac71e9

authored

fix(codersdk/toolsdk): ensure all tools include required fields of aisdk.Schema (#17632)

1 parentef00ae5 commit4ac71e9Copy full SHA for 4ac71e9

File tree

+29

-0

lines changed

+29

-0

lines changed

Lines changed: 2 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -327,6 +327,7 @@ var ListWorkspaces = Tool[ListWorkspacesArgs, []MinimalWorkspace]{`
`327`	`327`	`"description":"The owner of the workspaces to list. Use\"me\" to list workspaces for the authenticated user. If you do not specify an owner,\"me\" will be assumed by default.",`
`328`	`328`	`},`
`329`	`329`	`},`
	`330`	`+Required: []string{},`
`330`	`331`	`},`
`331`	`332`	`},`
`332`	`333`	`Handler:func(ctx context.Context,depsDeps,argsListWorkspacesArgs) ([]MinimalWorkspace,error) {`
`@@ -1256,6 +1257,7 @@ var DeleteTemplate = Tool[DeleteTemplateArgs, codersdk.Response]{`
`1256`	`1257`	`"type":"string",`
`1257`	`1258`	`},`
`1258`	`1259`	`},`
	`1260`	`+Required: []string{"template_id"},`
`1259`	`1261`	`},`
`1260`	`1262`	`},`
`1261`	`1263`	`Handler:func(ctx context.Context,depsDeps,argsDeleteTemplateArgs) (codersdk.Response,error) {`

Lines changed: 27 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -539,6 +539,33 @@ func TestWithCleanContext(t *testing.T) {`
`539`	`539`	`})`
`540`	`540`	`}`
`541`	`541`
	`542`	`+funcTestToolSchemaFields(t*testing.T) {`
	`543`	`+t.Parallel()`
	`544`	`+`
	`545`	`+// Test that all tools have the required Schema fields (Properties and Required)`
	`546`	`+for_,tool:=rangetoolsdk.All {`
	`547`	`+t.Run(tool.Tool.Name,func(t*testing.T) {`
	`548`	`+t.Parallel()`
	`549`	`+`
	`550`	`+// Check that Properties is not nil`
	`551`	`+require.NotNil(t,tool.Tool.Schema.Properties,`
	`552`	`+"Tool %q missing Schema.Properties",tool.Tool.Name)`
	`553`	`+`
	`554`	`+// Check that Required is not nil`
	`555`	`+require.NotNil(t,tool.Tool.Schema.Required,`
	`556`	`+"Tool %q missing Schema.Required",tool.Tool.Name)`
	`557`	`+`
	`558`	`+// Ensure Properties has entries for all required fields`
	`559`	`+for_,requiredField:=rangetool.Tool.Schema.Required {`
	`560`	`+_,exists:=tool.Tool.Schema.Properties[requiredField]`
	`561`	`+require.True(t,exists,`
	`562`	`+"Tool %q requires field %q but it is not defined in Properties",`
	`563`	`+tool.Tool.Name,requiredField)`
	`564`	`+}`
	`565`	`+})`
	`566`	`+}`
	`567`	`+}`
	`568`	`+`
`542`	`569`	`// TestMain runs after all tests to ensure that all tools in this package have`
`543`	`570`	`// been tested once.`
`544`	`571`	`funcTestMain(m*testing.M) {`

Comments

(0)