Merge pull request #1 from TBD54566975/fun-with-js-files

structure for test runners

Author: decentralgabe

.eslintrc.cjs

@@ -0,0 +1,43 @@
+module.exports = {
+  'env': {
+    'node': true,
+  },
+  'extends': [
+    'google',
+    'plugin:react/recommended',
+  ],
+  'overrides': [
+    {
+      'env': {
+        'node': true,
+      },
+      'files': [
+        '.eslintrc.{js,cjs}',
+      ],
+      'parserOptions': {
+        'sourceType': 'script',
+      },
+    },
+  ],
+  'parserOptions': {
+    'ecmaVersion': 'latest',
+    'sourceType': 'module',
+  },
+  'plugins': [
+    'react',
+  ],
+  'rules': {
+    'no-invalid-this': 'off',
+    'max-len': [
+      'error',
+      {
+        'code': 100,
+        'tabWidth': 2,
+        'ignoreComments': true, // "comments": 80
+        'ignoreUrls': true,
+        'ignoreStrings': true,
+        'ignoreTemplateLiterals': true,
+      },
+    ],
+  },
+};

.gitignore

@@ -1,6 +1,12 @@
 # IDE
 .idea
 
+# Reports
+reports/*.html
+
+# Output
+tests/output/*/*/*.json
+
 # Logs
 logs
 *.log

implementations/docker-compose.yml

@@ -0,0 +1,9 @@
+version: "3.9"
+services:
+  tbd:
+    image: tbd/vc-json-schema-test-suite
+    build:
+      context: ./tbd
+      dockerfile: Dockerfile
+    volumes:
+      - ../tests:/tests

implementations/index.js

@@ -1,9 +1,32 @@
-import fs from 'fs';
-import path from 'path';
+import {createRequire} from 'node:module';
 
-const jsonsInDir = fs.readdirSync('./').filter(file => path.extname(file) === '.json');
+const require = createRequire(import.meta.url);
+const requireDir = require('require-dir');
+const dir = requireDir('./');
 
-const implementations = jsonsInDir.map(file => {
-    const fileData = fs.readFileSync(path.join('./', file));
-    return JSON.parse(fileData.toString());
-});
+export const implementations = Object.values(dir);
+
+export const JsonSchemaVersions = {
+  202012: '2020-12',
+  201909: '2019-09',
+  Draft7: 'Draft-7',
+};
+
+export const VcJsonSchemaTypes = {
+  JsonSchema: 'JsonSchema',
+  JsonSchemaCredential: 'JsonSchemaCredential',
+};
+
+export const implementationsWhichSupportVersionAndType = ({
+  impls = implementations,
+  version,
+  type,
+}) => {
+  const matchingImpls = [];
+  for (const i of impls) {
+    if (Object.keys(i.specs).includes(version) && i.specs[version].includes(type)) {
+      matchingImpls.push(i);
+    }
+  }
+  return matchingImpls;
+};

implementations/sample.json renamed to implementations/tbd.json

@@ -1,5 +1,5 @@
 {
-  "name": "test impl",
+  "name": "tbd",
   "specs": {
     "2020-12": [
       "JsonSchema",

implementations/tbd/Dockerfile

@@ -0,0 +1,17 @@
+FROM golang:1.21-alpine
+
+# Set destination for COPY
+WORKDIR /app
+
+# Download Go modules
+COPY go.mod .
+COPY go.sum .
+RUN go mod download
+
+# Copy the source code
+COPY *.go ./
+
+# Build executable
+RUN go build -tags jwx_es256k -o /tbd .
+
+ENTRYPOINT ["/tbd"]

implementations/tbd/README.md

@@ -0,0 +1,25 @@
+# TBD's VC JSON Schema Implementation
+
+## Local
+### Building
+
+Assuming you have [go](https://go.dev/) installed...
+
+```bash
+go build ./...
+```
+
+Which will produce a binary called `vc-json-schema-test-suite`
+
+### Running
+
+Select format, schema, credential, and output files and run as follows:
+
+```bash
+ ./vc-json-schema-test-suite validate --format JsonSchema --schema ../../tests/input/test-1-schema.json --credential ../../tests/input/test-1-credential.json --output ../../tests/output/tests-1-output.json```
+ ```
+
+## Docker
+### Building
+
+### Running

implementations/tbd/cli.go

@@ -0,0 +1,66 @@
+package main
+
+import (
+	"flag"
+	"fmt"
+	"os"
+)
+
+const (
+	JSONSchemaType           = "JsonSchema"
+	JSONSchemaCredentialType = "JsonSchemaCredential"
+)
+
+func main() {
+	if len(os.Args) < 3 {
+		panic("must supply [format, schema, credential, output] arguments")
+	}
+
+	var schema, format, credential, output string
+
+	createCmd := flag.NewFlagSet("validate", flag.ExitOnError)
+	createCmd.StringVar(&format, "format", "", "schema format")
+	createCmd.StringVar(&schema, "schema", "", "schema schema file")
+	createCmd.StringVar(&credential, "credential", "", "credential schema file")
+	createCmd.StringVar(&output, "output", "", "output file")
+
+	switch os.Args[1] {
+	case "validate":
+		if err := createCmd.Parse(os.Args[2:]); err != nil {
+			fmt.Printf("error running create: %s\n", err.Error())
+			os.Exit(1)
+		}
+		fmt.Printf("flags parsed: format=%s, schema=%s, credential=%s, output=%s\n", format, schema, credential, output)
+		validateFlags(format, schema, credential, output)
+		if err := ValidateCredentialAgainstSchema(format, schema, credential, output); err != nil {
+			fmt.Printf("error validating using schema %s: %s\n", schema, err.Error())
+			os.Exit(1)
+		}
+		fmt.Println("credential validated; output written to file")
+	default:
+		fmt.Println("expected 'validate' command")
+		os.Exit(1)
+	}
+}
+
+func validateFlags(format, schema, credential, output string) {
+	if format == "" {
+		fmt.Println("no format specified")
+		os.Exit(1)
+	}
+	if format != JSONSchemaType && format != JSONSchemaCredentialType {
+		fmt.Println("invalid format specified")
+		os.Exit(1)
+	}
+	if schema == "" {
+		fmt.Println("no schema file specified")
+		os.Exit(1)
+	}
+	if credential == "" {
+		fmt.Println("no credential file specified")
+		os.Exit(1)
+	}
+	if output == "" {
+		fmt.Println("no output file specified")
+	}
+}

implementations/tbd/file.go

@@ -0,0 +1,73 @@
+package main
+
+import (
+	"encoding/json"
+	"os"
+
+	"github.com/TBD54566975/ssi-sdk/credential"
+	"github.com/TBD54566975/ssi-sdk/credential/schema"
+	"github.com/pkg/errors"
+)
+
+func getCredentialFromFile(filePath string) (*credential.VerifiableCredential, error) {
+	bytes, err := os.ReadFile(filePath)
+	if err != nil {
+		return nil, errors.Wrapf(err, "could not read credential from file: %s", filePath)
+	}
+	var cred credential.VerifiableCredential
+	if err = json.Unmarshal(bytes, &cred); err != nil {
+		return nil, errors.Wrap(err, "could not unmarshal credential")
+	}
+	return &cred, nil
+}
+
+func getSchemaFromFile(format, filePath string) (*schema.JSONSchema, error) {
+	var s schema.JSONSchema
+	if format == JSONSchemaCredentialType {
+		schemaCred, err := getCredentialFromFile(filePath)
+		if err != nil {
+			return nil, errors.Wrap(err, "could not get schema credential from file")
+		}
+		jsonSchema, ok := schemaCred.CredentialSubject[credential.VerifiableCredentialJSONSchemaProperty]
+		if !ok {
+			return nil, errors.New("credential does not contain json schema")
+		}
+		s = jsonSchema.(map[string]any)
+	} else {
+		bytes, err := os.ReadFile(filePath)
+		if err != nil {
+			return nil, errors.Wrapf(err, "could not read vp from file: %s", filePath)
+		}
+		if err = json.Unmarshal(bytes, &s); err != nil {
+			return nil, errors.Wrap(err, "could not unmarshal schema")
+		}
+	}
+	return &s, nil
+}
+
+func writeValidationResult(result ValidationResult, filePath string) error {
+	data, err := json.MarshalIndent(validationResult{Result: result}, "", "    ")
+	if err != nil {
+		return err
+	}
+	return writeOutputToFile(data, filePath)
+}
+
+type ValidationResult string
+
+const (
+	Success       ValidationResult = "success"
+	Failure       ValidationResult = "failure"
+	Indeterminate ValidationResult = "indeterminate"
+)
+
+type validationResult struct {
+	Result ValidationResult `json:"result"`
+}
+
+func writeOutputToFile(data []byte, filePath string) error {
+	if err := os.WriteFile(filePath, data, 0755); err != nil {
+		return errors.Wrapf(err, "could not write %d bytes to file: %s", len(data), filePath)
+	}
+	return nil
+}

implementations/tbd/go.mod

@@ -0,0 +1,52 @@
+module github.com/TBD54566975/vc-json-schema-test-suite
+
+go 1.21
+
+require (
+	github.com/TBD54566975/ssi-sdk v0.0.4-alpha.0.20230818212001-6e1043316e75
+	github.com/pkg/errors v0.9.1
+)
+
+require (
+	github.com/btcsuite/btcd/btcec/v2 v2.3.2 // indirect
+	github.com/cloudflare/circl v1.3.3 // indirect
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/decred/dcrd/dcrec/secp256k1/v4 v4.2.0 // indirect
+	github.com/gabriel-vasile/mimetype v1.4.2 // indirect
+	github.com/go-playground/locales v0.14.1 // indirect
+	github.com/go-playground/universal-translator v0.18.1 // indirect
+	github.com/go-playground/validator/v10 v10.15.0 // indirect
+	github.com/goccy/go-json v0.10.2 // indirect
+	github.com/google/uuid v1.3.0 // indirect
+	github.com/hyperledger/aries-framework-go v0.3.2 // indirect
+	github.com/hyperledger/aries-framework-go/component/kmscrypto v0.0.0-20230427134832-0c9969493bd3 // indirect
+	github.com/hyperledger/aries-framework-go/component/log v0.0.0-20230427134832-0c9969493bd3 // indirect
+	github.com/hyperledger/aries-framework-go/component/models v0.0.0-20230501135648-a9a7ad029347 // indirect
+	github.com/hyperledger/aries-framework-go/spi v0.0.0-20230427134832-0c9969493bd3 // indirect
+	github.com/kilic/bls12-381 v0.1.1-0.20210503002446-7b7597926c69 // indirect
+	github.com/leodido/go-urn v1.2.4 // indirect
+	github.com/lestrrat-go/blackmagic v1.0.1 // indirect
+	github.com/lestrrat-go/httpcc v1.0.1 // indirect
+	github.com/lestrrat-go/httprc v1.0.4 // indirect
+	github.com/lestrrat-go/iter v1.0.2 // indirect
+	github.com/lestrrat-go/jwx/v2 v2.0.12 // indirect
+	github.com/lestrrat-go/option v1.0.1 // indirect
+	github.com/mr-tron/base58 v1.2.0 // indirect
+	github.com/multiformats/go-base32 v0.1.0 // indirect
+	github.com/multiformats/go-base36 v0.1.0 // indirect
+	github.com/multiformats/go-multibase v0.2.0 // indirect
+	github.com/multiformats/go-multicodec v0.9.0 // indirect
+	github.com/multiformats/go-varint v0.0.7 // indirect
+	github.com/piprate/json-gold v0.5.0 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
+	github.com/pquerna/cachecontrol v0.1.0 // indirect
+	github.com/santhosh-tekuri/jsonschema/v5 v5.3.1 // indirect
+	github.com/segmentio/asm v1.2.0 // indirect
+	github.com/sirupsen/logrus v1.9.3 // indirect
+	github.com/stretchr/testify v1.8.4 // indirect
+	golang.org/x/crypto v0.12.0 // indirect
+	golang.org/x/net v0.10.0 // indirect
+	golang.org/x/sys v0.11.0 // indirect
+	golang.org/x/text v0.12.0 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
+)