jsonschema: Encoder benchmarks (#66)

Added some benchmarks to test number of allocation / performance for the public API.

Author: smyrman

schema/encoding/jsonschema/all_test.go

@@ -12,6 +12,76 @@ import (
 	"github.com/stretchr/testify/assert"
 )
 
+// studentSchema serves as a complex nested schema example.
+var studentSchema = schema.Schema{
+	Description: "Object with array of students",
+	Fields: schema.Fields{
+		"students": {
+			Description: "Array of students",
+			Validator: &schema.Array{
+				ValuesValidator: &schema.Object{
+					Schema: &schema.Schema{
+						Description: "Student and class",
+						Fields: schema.Fields{
+							"student": {
+								Description: "The student name",
+								Required:    true,
+								Default:     "Unknown",
+								Validator: &schema.String{
+									MinLen: 1,
+									MaxLen: 10,
+								},
+							},
+							"class": {
+								Description: "The class name",
+								Default:     "Unassigned",
+								Validator: &schema.String{
+									MinLen: 0, // Default value.
+									MaxLen: 10,
+								},
+							},
+						},
+					},
+				},
+			},
+		},
+	},
+}
+
+// studentSchemaJSON contains the expected JSON serialization of studentSchema.
+const studentSchemaJSON = `{
+	"type": "object",
+	"description": "Object with array of students",
+	"additionalProperties": false,
+	"properties": {
+		"students": {
+			"type": "array",
+			"description": "Array of students",
+			"items": {
+				"type": "object",
+				"description": "Student and class",
+				"additionalProperties": false,
+				"properties": {
+					"student": {
+						"type": "string",
+						"description": "The student name",
+						"default": "Unknown",
+						"minLength": 1,
+						"maxLength": 10
+					},
+					"class": {
+						"type": "string",
+						"description": "The class name",
+						"default": "Unassigned",
+						"maxLength": 10
+					}
+				},
+				"required": ["student"]
+			}
+		}
+	}
+}`
+
 type dummyValidator struct{}
 
 func (v dummyValidator) Validate(value interface{}) (interface{}, error) {
@@ -340,73 +410,9 @@ func TestEncoder(t *testing.T) {
 			}`,
 		},
 		{
-			name: "Validator=Array,ValuesValidator=Object{Schema:Student}",
-			schema: schema.Schema{
-				Description: "Object with array of students",
-				Fields: schema.Fields{
-					"students": {
-						Description: "Array of students",
-						Validator: &schema.Array{
-							ValuesValidator: &schema.Object{
-								Schema: &schema.Schema{
-									Description: "Student and class",
-									Fields: schema.Fields{
-										"student": {
-											Description: "The student name",
-											Required:    true,
-											Default:     "Unknown",
-											Validator: &schema.String{
-												MinLen: 1,
-												MaxLen: 10,
-											},
-										},
-										"class": {
-											Description: "The class name",
-											Default:     "Unassigned",
-											Validator: &schema.String{
-												MinLen: 0, // Default value.
-												MaxLen: 10,
-											},
-										},
-									},
-								},
-							},
-						},
-					},
-				},
-			},
-			expect: `{
-				"type": "object",
-				"description": "Object with array of students",
-				"additionalProperties": false,
-				"properties": {
-					"students": {
-						"type": "array",
-						"description": "Array of students",
-						"items": {
-							"type": "object",
-							"description": "Student and class",
-							"additionalProperties": false,
-							"properties": {
-								"student": {
-									"type": "string",
-									"description": "The student name",
-									"default": "Unknown",
-									"minLength": 1,
-									"maxLength": 10
-								},
-								"class": {
-									"type": "string",
-									"description": "The class name",
-									"default": "Unassigned",
-									"maxLength": 10
-								}
-							},
-							"required": ["student"]
-						}
-					}
-				}
-			}`,
+			name:   "Validator=Array,ValuesValidator=Object{Schema:Student}",
+			schema: studentSchema,
+			expect: studentSchemaJSON,
 		},
 		{
 			name: `Validator=Object,Fields["location"].Validator=Object`,

schema/encoding/jsonschema/benchmark_test.go

@@ -0,0 +1,54 @@
+package jsonschema_test
+
+import (
+	"bytes"
+	"testing"
+
+	"github.com/rs/rest-layer/schema"
+	"github.com/rs/rest-layer/schema/encoding/jsonschema"
+)
+
+func BenchmarkEncoder(b *testing.B) {
+	testCases := []struct {
+		Name   string
+		Schema schema.Schema
+	}{
+		{
+			Name: `Schema={Fields:{"b":Bool{}}}`,
+			Schema: schema.Schema{
+				Fields: schema.Fields{
+					"b": {Validator: &schema.Bool{}},
+				},
+			},
+		},
+		{
+			Name: `Schema={Fields:{"s":String{}}}`,
+			Schema: schema.Schema{
+				Fields: schema.Fields{
+					"s": {Validator: &schema.String{}},
+				},
+			},
+		},
+		{
+			Name: `Schema={Fields:{"s":String{MaxLen:42}}}`,
+			Schema: schema.Schema{
+				Fields: schema.Fields{
+					"s": {Validator: &schema.String{MaxLen: 42}},
+				},
+			},
+		},
+		{
+			Name:   `Schema=Student`,
+			Schema: studentSchema,
+		},
+	}
+	for i := range testCases {
+		tc := testCases[i]
+		b.Run(tc.Name, func(b *testing.B) {
+			for i := 0; i < b.N; i++ {
+				enc := jsonschema.NewEncoder(new(bytes.Buffer))
+				enc.Encode(&tc.Schema)
+			}
+		})
+	}
+}