add support for validator (#70)

* add support for validator 2020-12

* add JsonSchema2023

* timeout for tests increased

Author: vmidyllic

.github/workflows/ci-test.yaml

@@ -31,4 +31,4 @@ jobs:
       - name: Unit Tests
         env:
           IPFS_URL: ${{secrets.IPFS_URL }}
-        run: go test -race -timeout=60s ./...
+        run: go test -race -timeout=180s ./...

go.mod

@@ -13,7 +13,7 @@ require (
 	// https://github.com/piprate/json-gold/commit/36fcca9d7e487684a764e552e7d837a14546a157
 	github.com/piprate/json-gold v0.5.1-0.20230111113000-6ddbe6e6f19f
 	github.com/pkg/errors v0.9.1
-	github.com/qri-io/jsonschema v0.2.1
+	github.com/santhosh-tekuri/jsonschema/v5 v5.3.0
 	github.com/stretchr/testify v1.8.2
 	golang.org/x/crypto v0.7.0
 )
@@ -43,7 +43,6 @@ require (
 	github.com/multiformats/go-varint v0.0.7 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
 	github.com/pquerna/cachecontrol v0.0.0-20180517163645-1555304b9b35 // indirect
-	github.com/qri-io/jsonpointer v0.1.1 // indirect
 	github.com/spaolacci/murmur3 v1.1.0 // indirect
 	github.com/whyrusleeping/tar-utils v0.0.0-20201201191210-20a61371de5b // indirect
 	golang.org/x/sys v0.6.0 // indirect

go.sum

@@ -67,18 +67,13 @@ github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZb
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/pquerna/cachecontrol v0.0.0-20180517163645-1555304b9b35 h1:J9b7z+QKAmPf4YLrFg6oQUotqHQeUNWwkvo7jZp1GLU=
 github.com/pquerna/cachecontrol v0.0.0-20180517163645-1555304b9b35/go.mod h1:prYjPmNq4d1NPVmpShWobRqXY3q7Vp+80DqgxxUrUIA=
-github.com/qri-io/jsonpointer v0.1.1 h1:prVZBZLL6TW5vsSB9fFHFAMBLI4b0ri5vribQlTJiBA=
-github.com/qri-io/jsonpointer v0.1.1/go.mod h1:DnJPaYgiKu56EuDp8TU5wFLdZIcAnb/uH9v37ZaMV64=
-github.com/qri-io/jsonschema v0.2.1 h1:NNFoKms+kut6ABPf6xiKNM5214jzxAhDBrPHCJ97Wg0=
-github.com/qri-io/jsonschema v0.2.1/go.mod h1:g7DPkiOsK1xv6T/Ao5scXRkd+yTFygcANPBaaqW+VrI=
-github.com/sergi/go-diff v1.0.0 h1:Kpca3qRNrduNnOQeazBd0ysaKrUJiIuISHxogkT9RPQ=
-github.com/sergi/go-diff v1.0.0/go.mod h1:0CfEIISq7TuYL3j771MWULgwwjU+GofnZX9QAmXWZgo=
+github.com/santhosh-tekuri/jsonschema/v5 v5.3.0 h1:uIkTLo0AGRc8l7h5l9r+GcYi9qfVPt6lD4/bhmzfiKo=
+github.com/santhosh-tekuri/jsonschema/v5 v5.3.0/go.mod h1:FKdcjfQW6rpZSnxxUvEA5H/cDPdvJ/SZJQLWWXWGrZ0=
 github.com/spaolacci/murmur3 v1.1.0 h1:7c1g84S4BPRrfL5Xrdp6fOJ206sU9y293DDHaoy0bLI=
 github.com/spaolacci/murmur3 v1.1.0/go.mod h1:JwIasOWyU6f++ZhiEuf87xNszmSA2myDM2Kzu9HwQUA=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw=
 github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo=
-github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
 github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
 github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU=
 github.com/stretchr/testify v1.8.2 h1:+h33VjcLVPDHtOdpUCuF+7gSuG3yGIftsP1YvFihtJ8=

json/validator.go

@@ -1,11 +1,10 @@
 package json
 
 import (
-	"context"
+	"bytes"
 	"encoding/json"
 
-	"github.com/pkg/errors"
-	"github.com/qri-io/jsonschema"
+	jsonschema "github.com/santhosh-tekuri/jsonschema/v5"
 )
 
 // Validator validate json data
@@ -14,16 +13,23 @@ type Validator struct {
 
 // ValidateData validate JSON data by JSON Schema
 func (v Validator) ValidateData(data, schema []byte) error {
-	rs := &jsonschema.Schema{}
-	if err := json.Unmarshal(schema, rs); err != nil {
-		return errors.Wrap(err, "unmarshal schema")
+
+	compiler := jsonschema.NewCompiler()
+
+	err := compiler.AddResource("temp.json", bytes.NewReader(schema))
+	if err != nil {
+		return err
 	}
-	errs, err := rs.ValidateBytes(context.Background(), data)
+
+	var c map[string]interface{}
+	err = json.Unmarshal(data, &c)
 	if err != nil {
-		return errors.Wrap(err, "err during schema validation")
+		return err
 	}
-	if len(errs) > 0 {
-		return errs[0] // return only first error
+
+	sh, err := compiler.Compile("temp.json")
+	if err != nil {
+		return err
 	}
-	return nil
+	return sh.Validate(c)
 }

json/validator_test.go

@@ -86,6 +86,6 @@ func TestValidatorWithInvalidField(t *testing.T) {
 	err = jsonProcessor.ValidateData(dataBytes, schema)
 
 	assert.NotNil(t, err)
-	assert.Containsf(t, err.Error(), "\"birthday\" value is required", "expected error containing %q, got %s", "\"birthdayYear\" value is required", err)
+	assert.Containsf(t, err.Error(), "missing properties: 'birthday'", "expected error containing %q, got %s", "missing properties: 'birthDayYear'", err)
 
 }

processor/json/processor_test.go

@@ -19,8 +19,12 @@ const (
 	Iden3ReverseSparseMerkleTreeProof CredentialStatusType = "Iden3ReverseSparseMerkleTreeProof"
 
 	// JSONSchemaValidator2018 JSON schema for verification of W3CCredential
+	// Deprecated: https://www.w3.org/2018/credentials/#JsonSchemaValidator2018
 	JSONSchemaValidator2018 = "JsonSchemaValidator2018"
 
+	// JSONSchema2023 JSON schema for verification of W3CCredential (https://www.w3.org/TR/vc-json-schema/#jsonschema2023)
+	JSONSchema2023 = "JsonSchema2023"
+
 	// BJJSignatureProofType is a proof type for BJJ signature proofs
 	BJJSignatureProofType ProofType = "BJJSignature2021"