Merge pull request #15 from fabi200123/generate-jsonschema

Add json-schema generator

go.mod

@@ -11,7 +11,8 @@ require (
  github.com/aws/aws-sdk-go-v2/credentials v1.17.20
  github.com/aws/aws-sdk-go-v2/service/ec2 v1.165.0
  github.com/aws/smithy-go v1.20.2
- github.com/cloudbase/garm-provider-common v0.1.4-0.20240906095211-57315d4ac8ae
+ github.com/cloudbase/garm-provider-common v0.1.4-0.20240912084949-899c120c80ce
+ github.com/invopop/jsonschema v0.12.0
  github.com/stretchr/testify v1.9.0
  github.com/xeipuuv/gojsonschema v1.2.0
 )
@@ -26,17 +27,21 @@ require (
  github.com/aws/aws-sdk-go-v2/service/sso v1.21.0 // indirect
  github.com/aws/aws-sdk-go-v2/service/ssooidc v1.25.0 // indirect
  github.com/aws/aws-sdk-go-v2/service/sts v1.29.0 // indirect
+ github.com/bahlo/generic-list-go v0.2.0 // indirect
+ github.com/buger/jsonparser v1.1.1 // indirect
  github.com/davecgh/go-spew v1.1.1 // indirect
  github.com/felixge/httpsnoop v1.0.4 // indirect
  github.com/google/uuid v1.6.0 // indirect
  github.com/gorilla/handlers v1.5.2 // indirect
  github.com/jmespath/go-jmespath v0.4.0 // indirect
+ github.com/mailru/easyjson v0.7.7 // indirect
  github.com/mattn/go-isatty v0.0.20 // indirect
  github.com/minio/sio v0.4.0 // indirect
  github.com/pkg/errors v0.9.1 // indirect
  github.com/pmezard/go-difflib v1.0.0 // indirect
  github.com/stretchr/objx v0.5.2 // indirect
  github.com/teris-io/shortid v0.0.0-20220617161101-71ec9f2aa569 // indirect
+ github.com/wk8/go-ordered-map/v2 v2.1.8 // indirect
  github.com/xeipuuv/gojsonpointer v0.0.0-20190905194746-02993c407bfb // indirect
  github.com/xeipuuv/gojsonreference v0.0.0-20180127040603-bd5ef7bd5415 // indirect
  golang.org/x/crypto v0.26.0 // indirect

go.sum

@@ -28,8 +28,12 @@ github.com/aws/aws-sdk-go-v2/service/sts v1.29.0 h1:dqW4XRwPE/poWSqVntpeXLHzpPK6
 github.com/aws/aws-sdk-go-v2/service/sts v1.29.0/go.mod h1:j8+hrxlmLR8ZQo6ytTAls/JFrt5bVisuS6PD8gw2VBw=
 github.com/aws/smithy-go v1.20.2 h1:tbp628ireGtzcHDDmLT/6ADHidqnwgF57XOXZe6tp4Q=
 github.com/aws/smithy-go v1.20.2/go.mod h1:krry+ya/rV9RDcV/Q16kpu6ypI4K2czasz0NC3qS14E=
-github.com/cloudbase/garm-provider-common v0.1.4-0.20240906095211-57315d4ac8ae h1:GDcVb/ForsCtpGj2kFH+iPu6/IIj0b5pV/h27qL6+GI=
-github.com/cloudbase/garm-provider-common v0.1.4-0.20240906095211-57315d4ac8ae/go.mod h1:sK26i2NpjjAjhanNKiWw8iPkqt+XeohTKpFnEP7JdZ4=
+github.com/bahlo/generic-list-go v0.2.0 h1:5sz/EEAK+ls5wF+NeqDpk5+iNdMDXrh3z3nPnH1Wvgk=
+github.com/bahlo/generic-list-go v0.2.0/go.mod h1:2KvAjgMlE5NNynlg/5iLrrCCZ2+5xWbdbCW3pNTGyYg=
+github.com/buger/jsonparser v1.1.1 h1:2PnMjfWD7wBILjqQbt530v576A/cAbQvEW9gGIpYMUs=
+github.com/buger/jsonparser v1.1.1/go.mod h1:6RYKKt7H4d4+iWqouImQ9R2FZql3VbhNgx27UK13J/0=
+github.com/cloudbase/garm-provider-common v0.1.4-0.20240912084949-899c120c80ce h1:spSF26dB6llkdyEeVPDdobdbv2z09zL10MUJG/YYkoE=
+github.com/cloudbase/garm-provider-common v0.1.4-0.20240912084949-899c120c80ce/go.mod h1:sK26i2NpjjAjhanNKiWw8iPkqt+XeohTKpFnEP7JdZ4=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
@@ -39,10 +43,15 @@ github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
 github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
 github.com/gorilla/handlers v1.5.2 h1:cLTUSsNkgcwhgRqvCNmdbRWG0A3N4F+M2nWKdScwyEE=
 github.com/gorilla/handlers v1.5.2/go.mod h1:dX+xVpaxdSw+q0Qek8SSsl3dfMk3jNddUkMzo0GtH0w=
+github.com/invopop/jsonschema v0.12.0 h1:6ovsNSuvn9wEQVOyc72aycBMVQFKz7cPdMJn10CvzRI=
+github.com/invopop/jsonschema v0.12.0/go.mod h1:ffZ5Km5SWWRAIN6wbDXItl95euhFz2uON45H2qjYt+0=
 github.com/jmespath/go-jmespath v0.4.0 h1:BEgLn5cpjn8UN1mAw4NjwDrS35OdebyEtFe+9YPoQUg=
 github.com/jmespath/go-jmespath v0.4.0/go.mod h1:T8mJZnbsbmF+m6zOOFylbeCJqk5+pHWvzYPziyZiYoo=
 github.com/jmespath/go-jmespath/internal/testify v1.5.1 h1:shLQSRRSCCPj3f2gpwzGwWFoC7ycTf1rcQZHOlsJ6N8=
 github.com/jmespath/go-jmespath/internal/testify v1.5.1/go.mod h1:L3OGu8Wl2/fWfCI6z80xFu9LTZmf1ZRjMHUOPmWr69U=
+github.com/josharian/intern v1.0.0/go.mod h1:5DoeVV0s6jJacbCEi61lwdGj/aVlrQvzHFFd8Hwg//Y=
+github.com/mailru/easyjson v0.7.7 h1:UGYAvKxe3sBsEDzO8ZeWOSlIQfWFlxbzLZe7hwFURr0=
+github.com/mailru/easyjson v0.7.7/go.mod h1:xzfreul335JAWq5oZzymOObrkdz5UnU4kGfJJLY9Nlc=
 github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY=
 github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
 github.com/minio/sio v0.4.0 h1:u4SWVEm5lXSqU42ZWawV0D9I5AZ5YMmo2RXpEQ/kRhc=
@@ -59,6 +68,8 @@ github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsT
 github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
 github.com/teris-io/shortid v0.0.0-20220617161101-71ec9f2aa569 h1:xzABM9let0HLLqFypcxvLmlvEciCHL7+Lv+4vwZqecI=
 github.com/teris-io/shortid v0.0.0-20220617161101-71ec9f2aa569/go.mod h1:2Ly+NIftZN4de9zRmENdYbvPQeaVIYKWpLFStLFEBgI=
+github.com/wk8/go-ordered-map/v2 v2.1.8 h1:5h/BUHu93oj4gIdvHHHGsScSTMijfx5PeYkE/fJgbpc=
+github.com/wk8/go-ordered-map/v2 v2.1.8/go.mod h1:5nJHM5DyteebpVlHnWMV0rPz6Zp7+xBAnxjb1X5vnTw=
 github.com/xeipuuv/gojsonpointer v0.0.0-20180127040702-4e3ac2762d5f/go.mod h1:N2zxlSyiKSe5eX1tZViRH5QA0qijqEDrYZiPEAiq3wU=
 github.com/xeipuuv/gojsonpointer v0.0.0-20190905194746-02993c407bfb h1:zGWFAtiMcyryUHoUjUJX0/lt1H2+i2Ka2n+D3DImSNo=
 github.com/xeipuuv/gojsonpointer v0.0.0-20190905194746-02993c407bfb/go.mod h1:N2zxlSyiKSe5eX1tZViRH5QA0qijqEDrYZiPEAiq3wU=

internal/spec/spec.go

@@ -24,66 +24,27 @@ import (
  "github.com/cloudbase/garm-provider-common/cloudconfig"
  "github.com/cloudbase/garm-provider-common/params"
  "github.com/cloudbase/garm-provider-common/util"
+ "github.com/invopop/jsonschema"
  "github.com/xeipuuv/gojsonschema"
 )
 
-const (
- jsonSchema string = `
- {
- "$schema": "http://cloudbase.it/garm-provider-aws/schemas/extra_specs#",
- "type": "object",
- "description": "Schema defining supported extra specs for the Garm AWS Provider",
- "properties": {
- "subnet_id": {
- "type": "string",
- "pattern": "^subnet-[0-9a-fA-F]{17}$"
- },
- "ssh_key_name": {
- "type": "string",
- "description": "The name of the Key Pair to use for the instance."
- },
- "disable_updates": {
- "type": "boolean",
- "description": "Disable automatic updates on the VM."
- },
- "enable_boot_debug": {
- "type": "boolean",
- "description": "Enable boot debug on the VM."
- },
- "extra_packages": {
- "type": "array",
- "description": "Extra packages to install on the VM.",
- "items": {
- "type": "string"
- }
- },
- "runner_install_template": {
- "type": "string",
- "description": "This option can be used to override the default runner install template. If used, the caller is responsible for the correctness of the template as well as the suitability of the template for the target OS. Use the extra_context extra spec if your template has variables in it that need to be expanded."
- },
- "extra_context": {
- "type": "object",
- "description": "Extra context that will be passed to the runner_install_template.",
- "additionalProperties": {
- "type": "string"
- }
- },
- "pre_install_scripts": {
- "type": "object",
- "description": "A map of pre-install scripts that will be run before the runner install script. These will run as root and can be used to prep a generic image before we attempt to install the runner. The key of the map is the name of the script as it will be written to disk. The value is a byte array with the contents of the script."
- }
- },
- "additionalProperties": false
- }
- `
-)
-
 type ToolFetchFunc func(osType params.OSType, osArch params.OSArch, tools []params.RunnerApplicationDownload) (params.RunnerApplicationDownload, error)
 
 var DefaultToolFetch ToolFetchFunc = util.GetTools
 
+func generateJSONSchema() *jsonschema.Schema {
+ reflector := jsonschema.Reflector{
+ AllowAdditionalProperties: false,
+ }
+ // Reflect the extraSpecs struct
+ schema := reflector.Reflect(extraSpecs{})
+
+ return schema
+}
+
 func jsonSchemaValidation(schema json.RawMessage) error {
- schemaLoader := gojsonschema.NewStringLoader(jsonSchema)
+ jsonSchema := generateJSONSchema()
+ schemaLoader := gojsonschema.NewGoLoader(jsonSchema)
  extraSpecsLoader := gojsonschema.NewBytesLoader(schema)
  result, err := gojsonschema.Validate(schemaLoader, extraSpecsLoader)
  if err != nil {
@@ -112,11 +73,13 @@ func newExtraSpecsFromBootstrapData(data params.BootstrapInstance) (*extraSpecs,
 }
 
 type extraSpecs struct {
- SubnetID *string `json:"subnet_id,omitempty"`
- SSHKeyName *string `json:"ssh_key_name,omitempty"`
- DisableUpdates *bool `json:"disable_updates"`
- EnableBootDebug *bool `json:"enable_boot_debug"`
- ExtraPackages []string `json:"extra_packages"`
+ SubnetID *string `json:"subnet_id,omitempty" jsonschema:"pattern=^subnet-[0-9a-fA-F]{17}$"`
+ SSHKeyName *string `json:"ssh_key_name,omitempty" jsonschema:"description=The name of the Key Pair to use for the instance."`
+ DisableUpdates *bool `json:"disable_updates,omitempty" jsonschema:"description=Disable automatic updates on the VM."`
+ EnableBootDebug *bool `json:"enable_boot_debug,omitempty" jsonschema:"description=Enable boot debug on the VM"`
+ ExtraPackages []string `json:"extra_packages,omitempty" jsonschema:"description=Extra packages to install on the VM"`
+ // The Cloudconfig struct from common package
+ cloudconfig.CloudConfigSpec
 }
 
 func GetRunnerSpecFromBootstrapParams(cfg *config.Config, data params.BootstrapInstance, controllerID string) (*RunnerSpec, error) {
@@ -141,6 +104,10 @@ func GetRunnerSpecFromBootstrapParams(cfg *config.Config, data params.BootstrapI
 
  spec.MergeExtraSpecs(extraSpecs)
 
+ if err := spec.Validate(); err != nil {
+ return nil, fmt.Errorf("error validating spec: %w", err)
+ }
+
  return spec, nil
 }