Merge pull request #19 from fabi200123/generate-jsonschema

Add json-schema generator

go.mod

@@ -6,15 +6,22 @@ toolchain go1.22.3
 
 require (
 	github.com/BurntSushi/toml v1.2.1
-	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/google/uuid v1.6.0
 	github.com/gophercloud/gophercloud v1.11.0
 	github.com/gophercloud/utils v0.0.0-20230324070755-05e9e7f5ea4d
+	github.com/invopop/jsonschema v0.12.0
 	github.com/stretchr/testify v1.9.0
 	gopkg.in/yaml.v2 v2.4.0
 )
 
-require github.com/stretchr/objx v0.5.2 // indirect
+require (
+	github.com/bahlo/generic-list-go v0.2.0 // indirect
+	github.com/buger/jsonparser v1.1.1 // indirect
+	github.com/mailru/easyjson v0.7.7 // indirect
+	github.com/stretchr/objx v0.5.2 // indirect
+	github.com/wk8/go-ordered-map/v2 v2.1.8 // indirect
+)
 
 require (
 	github.com/davecgh/go-spew v1.1.1 // indirect

go.sum

@@ -1,7 +1,11 @@
 github.com/BurntSushi/toml v1.2.1 h1:9F2/+DoOYIOksmaJFPw1tGFy1eDnIJXg+UHjuD8lTak=
 github.com/BurntSushi/toml v1.2.1/go.mod h1:CxXYINrC8qIiEnFrOxCa7Jy5BFHlXnUU2pbicEuybxQ=
-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=
@@ -17,6 +21,11 @@ github.com/gophercloud/utils v0.0.0-20230324070755-05e9e7f5ea4d/go.mod h1:z4Dey7
 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/hashicorp/go-uuid v1.0.3/go.mod h1:6SBZvOh/SIDV7/2o3Jml5SYk/TvGqwFJ/bN7x4byOro=
+github.com/invopop/jsonschema v0.12.0 h1:6ovsNSuvn9wEQVOyc72aycBMVQFKz7cPdMJn10CvzRI=
+github.com/invopop/jsonschema v0.12.0/go.mod h1:ffZ5Km5SWWRAIN6wbDXItl95euhFz2uON45H2qjYt+0=
+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=
@@ -35,6 +44,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 h1:J9EGpcZtP0E/raorCMxlFGSTBrsSlaDGf3jU/qvAE2c=
 github.com/xeipuuv/gojsonpointer v0.0.0-20180127040702-4e3ac2762d5f/go.mod h1:N2zxlSyiKSe5eX1tZViRH5QA0qijqEDrYZiPEAiq3wU=
 github.com/xeipuuv/gojsonreference v0.0.0-20180127040603-bd5ef7bd5415 h1:EzJWgHovont7NscjpAxXsDA8S8BMYve8Y5+7cuRE7R0=

provider/spec.go

@@ -26,6 +26,7 @@ import (
 	"github.com/gophercloud/gophercloud/openstack/compute/v2/servers"
 	"github.com/gophercloud/gophercloud/openstack/imageservice/v2/images"
 	"github.com/gophercloud/gophercloud/openstack/networking/v2/networks"
+	"github.com/invopop/jsonschema"
 	"github.com/xeipuuv/gojsonschema"
 
 	"github.com/cloudbase/garm-provider-openstack/config"
@@ -42,104 +43,35 @@ var (
 	DefaultGetCloudconfig GetCloudConfigFunc = cloudconfig.GetCloudConfig
 )
 
-const jsonSchema string = `
-
-{
-    "$schema": "http://cloudbase.it/garm-provider-openstack/schemas/extra_specs#",
-    "type": "object",
-    "description": "Schema defining supported extra specs for the Garm OpenStack Provider",
-    "properties": {
-        "security_groups": {
-            "type": "array",
-            "items": {
-                "type": "string"
-            }
-        },
-        "network_id": {
-            "type": "string",
-            "description": "The tenant network to which runners will be connected to."
-        },
-        "storage_backend": {
-            "type": "string",
-            "description": "The cinder backend to use when creating volumes."
-        },
-        "boot_from_volume": {
-            "type": "boolean",
-            "description": "Whether to boot from volume or not. Use this option if the root disk size defined by the flavor is not enough."
-        },
-        "boot_disk_size": {
-            "type": "integer",
-            "description": "The size of the root disk in GB. Default is 50 GB."
-        },
-        "use_config_drive": {
-            "type": "boolean",
-            "description": "Use config drive."
-        },
-        "enable_boot_debug": {
-            "type": "boolean",
-            "description": "Enable cloud-init debug mode. Adds 'set -x' into the cloud-init script."
-        },
-        "allowed_image_owners": {
-            "type": "array",
-            "items": {
-                "type": "string"
-            },
-            "description": "A list of image owners to allow when creating the instance. If not specified, all images will be allowed." 
-        },
-		"image_visibility": {
-			"type": "string",
-			"description": "The visibility of the image to use."
-		},
-        "disable_updates": {
-            "type": "boolean",
-            "description": "Disable automatic updates 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": {
-                "type": "string"
-            }
-        }
-    },
-	"additionalProperties": false
-}
-`
-
 type extraSpecs struct {
 	SecurityGroups     []string `json:"security_groups,omitempty"`
-	AllowedImageOwners []string `json:"allowed_image_owners,omitempty"`
-	ImageVisibility    string   `json:"image_visibility,omitempty"`
-	NetworkID          string   `json:"network_id"`
-	StorageBackend     string   `json:"storage_backend,omitempty"`
-	BootFromVolume     *bool    `json:"boot_from_volume,omitempty"`
-	BootDiskSize       *int64   `json:"boot_disk_size,omitempty"`
-	UseConfigDrive     *bool    `json:"use_config_drive"`
-	EnableBootDebug    *bool    `json:"enable_boot_debug"`
-	DisableUpdates     *bool    `json:"disable_updates"`
-	ExtraPackages      []string `json:"extra_packages"`
+	AllowedImageOwners []string `json:"allowed_image_owners,omitempty" jsonschema:"description=A list of image owners to allow when creating the instance. If not specified, all images will be allowed."`
+	ImageVisibility    string   `json:"image_visibility,omitempty" jsonschema:"description=The visibility of the image to use."`
+	NetworkID          string   `json:"network_id,omitempty" jsonschema:"description=The tenant network to which runners will be connected to."`
+	StorageBackend     string   `json:"storage_backend,omitempty" jsonschema:"description=The cinder backend to use when creating volumes."`
+	BootFromVolume     *bool    `json:"boot_from_volume,omitempty" jsonschema:"description=Whether to boot from volume or not. Use this option if the root disk size defined by the flavor is not enough."`
+	BootDiskSize       *int64   `json:"boot_disk_size,omitempty" jsonschema:"description=The size of the root disk in GB. Default is 50 GB."`
+	UseConfigDrive     *bool    `json:"use_config_drive,omitempty" jsonschema:"description=Use config drive."`
+	EnableBootDebug    *bool    `json:"enable_boot_debug,omitempty" jsonschema:"description=Enable cloud-init debug mode. Adds 'set -x' into the cloud-init script."`
+	DisableUpdates     *bool    `json:"disable_updates,omitempty" jsonschema:"description=Disable automatic updates 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 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 {