Add enum and default to version in schema

afrittoli · afrittoli · commit 98452e6328f8 · 2022-08-24T16:53:38.000+02:00
Add a unit test to verify invalid versions are not accepted

Signed-off-by: Andrea Frittoli &lt;andrea.frittoli@gmail.com&gt;
diff --git a/jsonschema/changeabandoned.json b/jsonschema/changeabandoned.json
@@ -6,7 +6,10 @@
       "properties": {
         "version": {
           "type": "string",
-          "minLength": 1
+          "enum": [
+            "draft"
+          ],
+          "default": "draft"
         },
         "id": {
           "type": "string",
diff --git a/jsonschema/changecreated.json b/jsonschema/changecreated.json
@@ -6,7 +6,10 @@
       "properties": {
         "version": {
           "type": "string",
-          "minLength": 1
+          "enum": [
+            "draft"
+          ],
+          "default": "draft"
         },
         "id": {
           "type": "string",
diff --git a/jsonschema/changemerged.json b/jsonschema/changemerged.json
@@ -6,7 +6,10 @@
       "properties": {
         "version": {
           "type": "string",
-          "minLength": 1
+          "enum": [
+            "draft"
+          ],
+          "default": "draft"
         },
         "id": {
           "type": "string",
diff --git a/jsonschema/changereviewed.json b/jsonschema/changereviewed.json
@@ -6,7 +6,10 @@
       "properties": {
         "version": {
           "type": "string",
-          "minLength": 1
+          "enum": [
+            "draft"
+          ],
+          "default": "draft"
         },
         "id": {
           "type": "string",
diff --git a/jsonschema/changeupdated.json b/jsonschema/changeupdated.json
@@ -6,7 +6,10 @@
       "properties": {
         "version": {
           "type": "string",
-          "minLength": 1
+          "enum": [
+            "draft"
+          ],
+          "default": "draft"
         },
         "id": {
           "type": "string",
diff --git a/jsonschema/pipelinerunfinished.json b/jsonschema/pipelinerunfinished.json
@@ -6,7 +6,10 @@
       "properties": {
         "version": {
           "type": "string",
-          "minLength": 1
+          "enum": [
+            "draft"
+          ],
+          "default": "draft"
         },
         "id": {
           "type": "string",
diff --git a/jsonschema/pipelinerunqueued.json b/jsonschema/pipelinerunqueued.json
@@ -6,7 +6,10 @@
       "properties": {
         "version": {
           "type": "string",
-          "minLength": 1
+          "enum": [
+            "draft"
+          ],
+          "default": "draft"
         },
         "id": {
           "type": "string",
diff --git a/jsonschema/pipelinerunstarted.json b/jsonschema/pipelinerunstarted.json
@@ -6,7 +6,10 @@
       "properties": {
         "version": {
           "type": "string",
-          "minLength": 1
+          "enum": [
+            "draft"
+          ],
+          "default": "draft"
         },
         "id": {
           "type": "string",
diff --git a/jsonschema/taskrunfinished.json b/jsonschema/taskrunfinished.json
@@ -6,7 +6,10 @@
       "properties": {
         "version": {
           "type": "string",
-          "minLength": 1
+          "enum": [
+            "draft"
+          ],
+          "default": "draft"
         },
         "id": {
           "type": "string",
diff --git a/jsonschema/taskrunstarted.json b/jsonschema/taskrunstarted.json
@@ -6,7 +6,10 @@
       "properties": {
         "version": {
           "type": "string",
-          "minLength": 1
+          "enum": [
+            "draft"
+          ],
+          "default": "draft"
         },
         "id": {
           "type": "string",
diff --git a/pkg/api/bindings_test.go b/pkg/api/bindings_test.go
@@ -504,12 +504,15 @@ func TestAsJsonString(t *testing.T) {
 
 func TestInvalidEvent(t *testing.T) {
 
-	eventNoSource, _ := NewCDEvent(ChangeAbandonedEventV1)
+	eventNoSource, _ := NewChangeAbandonedEvent()
 	eventNoSource.SetSubjectId(testSubjectId)
 
-	eventNoSubjectId, _ := NewCDEvent(ChangeAbandonedEventV1)
+	eventNoSubjectId, _ := NewChangeAbandonedEvent()
 	eventNoSubjectId.SetSource(testSource)
 
+	eventBadVersion, _ := NewChangeAbandonedEvent()
+	eventBadVersion.Context.Version = "invalid"
+
 	tests := []struct {
 		name  string
 		event CDEvent
@@ -519,6 +522,9 @@ func TestInvalidEvent(t *testing.T) {
 	}, {
 		name:  "missing subject id",
 		event: eventNoSubjectId,
+	}, {
+		name:  "invalid version",
+		event: eventBadVersion,
 	}}
 	for _, tc := range tests {
 		t.Run(tc.name, func(t *testing.T) {
diff --git a/pkg/api/types.go b/pkg/api/types.go
@@ -30,7 +30,7 @@ type Context struct {
 	// uses. This enables the interpretation of the context. Compliant event
 	// producers MUST use a value of draft when referring to this version of the
 	// specification.
-	Version string `json:"version" jsonschema:"required,minLength=1"`
+	Version string `json:"version" jsonschema:"required,enum=draft,default=draft"`
 
 	// Spec: https://cdevents.dev/docs/spec/#id
 	// Description: Identifier for an event. Subsequent delivery attempts of the
