Add vaults to pkgdef schema. resolves SYN-9842

changes/20f4328db25794b411a68fd7cdcc3f34.yaml

@@ -0,0 +1,7 @@
+---
+desc: 'Added ``vaults`` to the Storm package definition schema, which enables declaring
+  vaults and their associated schemas.'
+desc:literal: false
+prs: []
+type: feat
+...

synapse/data/jsonschemas/json-schema.org/draft-07/schema

@@ -0,0 +1,244 @@
+{
+	"$schema": "http://json-schema.org/draft-07/schema#",
+	"$id": "http://json-schema.org/draft-07/schema#",
+	"title": "Core schema meta-schema",
+	"definitions": {
+		"schemaArray": {
+			"type": "array",
+			"minItems": 1,
+			"items": {
+				"$ref": "#"
+			}
+		},
+		"nonNegativeInteger": {
+			"type": "integer",
+			"minimum": 0
+		},
+		"nonNegativeIntegerDefault0": {
+			"allOf": [
+				{
+					"$ref": "#/definitions/nonNegativeInteger"
+				},
+				{
+					"default": 0
+				}
+			]
+		},
+		"simpleTypes": {
+			"enum": [
+				"array",
+				"boolean",
+				"integer",
+				"null",
+				"number",
+				"object",
+				"string"
+			]
+		},
+		"stringArray": {
+			"type": "array",
+			"items": {
+				"type": "string"
+			},
+			"uniqueItems": true,
+			"default": []
+		}
+	},
+	"type": [
+		"object",
+		"boolean"
+	],
+	"properties": {
+		"$id": {
+			"type": "string",
+			"format": "uri-reference"
+		},
+		"$schema": {
+			"type": "string",
+			"format": "uri"
+		},
+		"$ref": {
+			"type": "string",
+			"format": "uri-reference"
+		},
+		"$comment": {
+			"type": "string"
+		},
+		"title": {
+			"type": "string"
+		},
+		"description": {
+			"type": "string"
+		},
+		"default": true,
+		"readOnly": {
+			"type": "boolean",
+			"default": false
+		},
+		"writeOnly": {
+			"type": "boolean",
+			"default": false
+		},
+		"examples": {
+			"type": "array",
+			"items": true
+		},
+		"multipleOf": {
+			"type": "number",
+			"exclusiveMinimum": 0
+		},
+		"maximum": {
+			"type": "number"
+		},
+		"exclusiveMaximum": {
+			"type": "number"
+		},
+		"minimum": {
+			"type": "number"
+		},
+		"exclusiveMinimum": {
+			"type": "number"
+		},
+		"maxLength": {
+			"$ref": "#/definitions/nonNegativeInteger"
+		},
+		"minLength": {
+			"$ref": "#/definitions/nonNegativeIntegerDefault0"
+		},
+		"pattern": {
+			"type": "string",
+			"format": "regex"
+		},
+		"additionalItems": {
+			"$ref": "#"
+		},
+		"items": {
+			"anyOf": [
+				{
+					"$ref": "#"
+				},
+				{
+					"$ref": "#/definitions/schemaArray"
+				}
+			],
+			"default": true
+		},
+		"maxItems": {
+			"$ref": "#/definitions/nonNegativeInteger"
+		},
+		"minItems": {
+			"$ref": "#/definitions/nonNegativeIntegerDefault0"
+		},
+		"uniqueItems": {
+			"type": "boolean",
+			"default": false
+		},
+		"contains": {
+			"$ref": "#"
+		},
+		"maxProperties": {
+			"$ref": "#/definitions/nonNegativeInteger"
+		},
+		"minProperties": {
+			"$ref": "#/definitions/nonNegativeIntegerDefault0"
+		},
+		"required": {
+			"$ref": "#/definitions/stringArray"
+		},
+		"additionalProperties": {
+			"$ref": "#"
+		},
+		"definitions": {
+			"type": "object",
+			"additionalProperties": {
+				"$ref": "#"
+			},
+			"default": {}
+		},
+		"properties": {
+			"type": "object",
+			"additionalProperties": {
+				"$ref": "#"
+			},
+			"default": {}
+		},
+		"patternProperties": {
+			"type": "object",
+			"additionalProperties": {
+				"$ref": "#"
+			},
+			"propertyNames": {
+				"format": "regex"
+			}
+		},
+		"dependencies": {
+			"type": "object",
+			"additionalProperties": {
+				"anyOf": [
+					{
+						"$ref": "#"
+					},
+					{
+						"$ref": "#/definitions/stringArray"
+					}
+				]
+			}
+		},
+		"propertyNames": {
+			"$ref": "#"
+		},
+		"const": true,
+		"enum": {
+			"type": "array",
+			"items": true,
+			"minItems": 1,
+			"uniqueItems": true
+		},
+		"type": {
+			"anyOf": [
+				{
+					"$ref": "#/definitions/simpleTypes"
+				},
+				{
+					"type": "array",
+					"items": {
+						"$ref": "#/definitions/simpleTypes"
+					},
+					"minItems": 1,
+					"uniqueItems": true
+				}
+			]
+		},
+		"format": {
+			"type": "string"
+		},
+		"contentMediaType": {
+			"type": "string"
+		},
+		"contentEncoding": {
+			"type": "string"
+		},
+		"if": {
+			"$ref": "#"
+		},
+		"then": {
+			"$ref": "#"
+		},
+		"else": {
+			"$ref": "#"
+		},
+		"allOf": {
+			"$ref": "#/definitions/schemaArray"
+		},
+		"anyOf": {
+			"$ref": "#/definitions/schemaArray"
+		},
+		"oneOf": {
+			"$ref": "#/definitions/schemaArray"
+		},
+		"not": {
+			"$ref": "#"
+		}
+	},
+	"default": true
+}

synapse/lib/schemas.py

@@ -790,6 +790,26 @@
                 'required': ['name', 'varname', 'desc', 'type', 'scopes'],
             },
         },
+        'vaults': {
+            'type': 'object',
+            'patternProperties': {
+                '^.*$': {
+                    'type': 'object',
+                    'properties': {
+                        'schemas': {
+                            'type': 'object',
+                            'properties': {
+                                'configs': {'$ref': 'https://json-schema.org/draft-07/schema'},
+                                'secrets': {'$ref': 'https://json-schema.org/draft-07/schema'}
+                            },
+                            'additionalProperties': False,
+                        },
+                    },
+                    'additionalProperties': False,
+                },
+            },
+            'additionalProperties': False,
+        }
     },
     'additionalProperties': True,
     'required': ['name', 'version'],
@@ -1063,7 +1083,7 @@
             },
             'additionalItems': True,
             'required': ('name',),
-        },
+        }
     }
 }
 reqValidPkgdef = s_config.getJsValidator(_reqValidPkgdefSchema)

synapse/tests/files/stormpkg/badvaultskeys.yaml

@@ -0,0 +1,16 @@
+name: badvaultskeys
+version: 0.0.1
+
+vaults:
+  badvaultskeys:
+    schemas:
+      newpconfigs:
+        type: object
+        properties:
+          foo:
+            type: string
+      newpsecrets:
+        type: object
+        properties:
+          quux:
+            type: string

synapse/tests/files/stormpkg/badvaultsschema.yaml

@@ -0,0 +1,16 @@
+name: badvaultsschema
+version: 0.0.1
+
+vaults:
+  badvaultsschema:
+    schemas:
+      configs:
+        type: newpobject
+        properties:
+          foo:
+            type: string
+      secrets:
+        type: object
+        properties:
+          quux:
+            type: string

synapse/tests/files/stormpkg/testpkg.yaml

@@ -109,6 +109,35 @@ configvars:
       workflowconfig: true
       type: [inet:fqdn, [str, inet:url]]
 
+vaults:
+  testpkg:
+    schemas:
+      configs:
+        type: object
+        properties:
+          foo:
+            type: string
+            default: hehe haha
+          bar:
+            oneOf:
+              - { type: boolean }
+              - { type: string }
+          baz:
+            type: boolean
+        additionalProperties: false
+        required:
+          - bar
+          - baz
+      secrets:
+        type: object
+        properties:
+          quux:
+            type: string
+            minLength: 2
+        additionalProperties: false
+        required:
+          - quux
+
 commands:
     - name: testpkgcmd
       descr: |