aml-org · tomsfernandez · Feb 29, 2024
diff --git a/internal/validator/contexts/contexts.go b/internal/validator/contexts/contexts.go
@@ -30,6 +30,7 @@ var DefaultAMFContext = types.ObjectMap{
 
 func DefaultValidationContext(reportConfig config.ReportConfiguration) types.ObjectMap {
 	return types.ObjectMap{
+		"@base": reportConfig.BaseIri,
 		"actual": types.StringMap{
 			"@id": "http://a.ml/vocabularies/validation#actual",
 		},
@@ -117,6 +118,7 @@ func DefaultValidationContext(reportConfig config.ReportConfiguration) types.Obj
 
 func ConformsContext(reportConfig config.ReportConfiguration) types.ObjectMap {
 	return types.ObjectMap{
+		"@base": reportConfig.BaseIri,
 		"conforms": types.StringMap{
 			"@id": "http://www.w3.org/ns/shacl#conforms",
 		},

diff --git a/internal/validator/validate_configuration_test.go b/internal/validator/validate_configuration_test.go
@@ -78,3 +78,35 @@ func TestAlternativeSchemas(t *testing.T) {
 		t.Errorf("Actual '%s' does not match expected '%s'", actual, expected)
 	}
 }
+
+func TestAlernativeBaseIri(t *testing.T) {
+	baseIri := "http://a.ml/my-really-cool-custom-iri"
+
+	reportConfig := c.ReportConfiguration{
+		BaseIri: baseIri,
+	}
+
+	profile := read("../../test/data/integration/profile1/profile.yaml")
+	data := read("../../test/data/integration/profile1/negative.data.jsonld")
+
+	report, err := ValidateWithConfiguration(profile, data, config.Debug, nil, c.TestValidationConfiguration{}, reportConfig)
+
+	if err != nil {
+		t.Errorf("Error during validation\n")
+	}
+
+	var output []any
+	err = json.Unmarshal([]byte(report), &output)
+	if err != nil {
+		t.Errorf("Error during report JSON unmarshling\n")
+	}
+	doc := output[0].(map[string]any)
+	context := doc["@context"].(map[string]any)
+
+	actual := context["@base"].(string)
+	expected := baseIri
+
+	if actual != expected {
+		t.Errorf("Actual '%s' does not match expected '%s'", actual, expected)
+	}
+}
diff --git a/pkg/config/report_configuration.go b/pkg/config/report_configuration.go
@@ -4,12 +4,14 @@ type ReportConfiguration struct {
 	IncludeReportCreationTime bool
 	ReportSchemaIri           string
 	LexicalSchemaIri          string
+	BaseIri                   string
 }
 
 func DefaultReportConfiguration() ReportConfiguration {
 	return ReportConfiguration{
 		IncludeReportCreationTime: true,
 		ReportSchemaIri:           "file:///dialects/validation-report.yaml",
 		LexicalSchemaIri:          "file:///dialects/lexical.yaml",
+		BaseIri:                   "http://a.ml/vocabularies/validation/report#",
 	}
 }
diff --git a/test/data/integration/profile1/negative.report.jsonld b/test/data/integration/profile1/negative.report.jsonld
@@ -1,6 +1,7 @@
 [
   {
     "@context": {
+      "@base": "http://a.ml/vocabularies/validation/report#",
       "actual": {
         "@id": "http://a.ml/vocabularies/validation#actual"
       },

diff --git a/test/data/integration/profile1/negative.report.lexical.jsonld b/test/data/integration/profile1/negative.report.lexical.jsonld
@@ -1,6 +1,7 @@
 [
   {
     "@context": {
+      "@base": "http://a.ml/vocabularies/validation/report#",
       "actual": {
         "@id": "http://a.ml/vocabularies/validation#actual"
       },

diff --git a/test/data/integration/profile1/positive.report.jsonld b/test/data/integration/profile1/positive.report.jsonld
@@ -1,6 +1,7 @@
 [
   {
     "@context": {
+      "@base": "http://a.ml/vocabularies/validation/report#",
       "conforms": {
         "@id": "http://www.w3.org/ns/shacl#conforms"
       },

diff --git a/test/data/integration/profile10/negative.report.jsonld b/test/data/integration/profile10/negative.report.jsonld
@@ -1,6 +1,7 @@
 [
   {
     "@context": {
+      "@base": "http://a.ml/vocabularies/validation/report#",
       "actual": {
         "@id": "http://a.ml/vocabularies/validation#actual"
       },

diff --git a/test/data/integration/profile10/positive.report.jsonld b/test/data/integration/profile10/positive.report.jsonld
@@ -1,6 +1,7 @@
 [
   {
     "@context": {
+      "@base": "http://a.ml/vocabularies/validation/report#",
       "conforms": {
         "@id": "http://www.w3.org/ns/shacl#conforms"
       },

diff --git a/test/data/integration/profile11/negative.report.jsonld b/test/data/integration/profile11/negative.report.jsonld
@@ -1,6 +1,7 @@
 [
   {
     "@context": {
+      "@base": "http://a.ml/vocabularies/validation/report#",
       "actual": {
         "@id": "http://a.ml/vocabularies/validation#actual"
       },

diff --git a/test/data/integration/profile11/negative.report.lexical.jsonld b/test/data/integration/profile11/negative.report.lexical.jsonld
@@ -1,6 +1,7 @@
 [
   {
     "@context": {
+      "@base": "http://a.ml/vocabularies/validation/report#",
       "actual": {
         "@id": "http://a.ml/vocabularies/validation#actual"
       },

diff --git a/test/data/integration/profile11/positive.report.jsonld b/test/data/integration/profile11/positive.report.jsonld
@@ -1,6 +1,7 @@
 [
   {
     "@context": {
+      "@base": "http://a.ml/vocabularies/validation/report#",
       "conforms": {
         "@id": "http://www.w3.org/ns/shacl#conforms"
       },

diff --git a/test/data/integration/profile12/negative.report.jsonld b/test/data/integration/profile12/negative.report.jsonld
@@ -1,6 +1,7 @@
 [
   {
     "@context": {
+      "@base": "http://a.ml/vocabularies/validation/report#",
       "actual": {
         "@id": "http://a.ml/vocabularies/validation#actual"
       },

diff --git a/test/data/integration/profile12/positive.report.jsonld b/test/data/integration/profile12/positive.report.jsonld
@@ -1,6 +1,7 @@
 [
   {
     "@context": {
+      "@base": "http://a.ml/vocabularies/validation/report#",
       "conforms": {
         "@id": "http://www.w3.org/ns/shacl#conforms"
       },

diff --git a/test/data/integration/profile13/negative.report.jsonld b/test/data/integration/profile13/negative.report.jsonld
@@ -1,6 +1,7 @@
 [
   {
     "@context": {
+      "@base": "http://a.ml/vocabularies/validation/report#",
       "actual": {
         "@id": "http://a.ml/vocabularies/validation#actual"
       },

diff --git a/test/data/integration/profile13/negative.report.lexical.jsonld b/test/data/integration/profile13/negative.report.lexical.jsonld
@@ -1,6 +1,7 @@
 [
   {
     "@context": {
+      "@base": "http://a.ml/vocabularies/validation/report#",
       "actual": {
         "@id": "http://a.ml/vocabularies/validation#actual"
       },

diff --git a/test/data/integration/profile13/positive.report.jsonld b/test/data/integration/profile13/positive.report.jsonld
@@ -1,6 +1,7 @@
 [
   {
     "@context": {
+      "@base": "http://a.ml/vocabularies/validation/report#",
       "conforms": {
         "@id": "http://www.w3.org/ns/shacl#conforms"
       },

diff --git a/test/data/integration/profile14/negative.report.jsonld b/test/data/integration/profile14/negative.report.jsonld
@@ -1,6 +1,7 @@
 [
   {
     "@context": {
+      "@base": "http://a.ml/vocabularies/validation/report#",
       "actual": {
         "@id": "http://a.ml/vocabularies/validation#actual"
       },

diff --git a/test/data/integration/profile14/positive.report.jsonld b/test/data/integration/profile14/positive.report.jsonld
@@ -1,6 +1,7 @@
 [
   {
     "@context": {
+      "@base": "http://a.ml/vocabularies/validation/report#",
       "conforms": {
         "@id": "http://www.w3.org/ns/shacl#conforms"
       },

diff --git a/test/data/integration/profile15/negative.data.yaml b/test/data/integration/profile15/negative.data.yaml
@@ -19,7 +19,7 @@ components:
         name:
           description: a property
           type: string
-      required: ["id"]
+      required: [ "id" ]
 
 paths:
   /users:

diff --git a/test/data/integration/profile15/negative.report.jsonld b/test/data/integration/profile15/negative.report.jsonld
@@ -1,6 +1,7 @@
 [
   {
     "@context": {
+      "@base": "http://a.ml/vocabularies/validation/report#",
       "actual": {
         "@id": "http://a.ml/vocabularies/validation#actual"
       },

diff --git a/test/data/integration/profile15/negative.report.lexical.jsonld b/test/data/integration/profile15/negative.report.lexical.jsonld
@@ -1,6 +1,7 @@
 [
   {
     "@context": {
+      "@base": "http://a.ml/vocabularies/validation/report#",
       "actual": {
         "@id": "http://a.ml/vocabularies/validation#actual"
       },

diff --git a/test/data/integration/profile15/positive.data.yaml b/test/data/integration/profile15/positive.data.yaml
@@ -19,7 +19,7 @@ components:
         name:
           description: a property
           type: string
-      required: ["id"]
+      required: [ "id" ]
 
 paths:
   /users:

diff --git a/test/data/integration/profile15/positive.report.jsonld b/test/data/integration/profile15/positive.report.jsonld
@@ -1,6 +1,7 @@
 [
   {
     "@context": {
+      "@base": "http://a.ml/vocabularies/validation/report#",
       "conforms": {
         "@id": "http://www.w3.org/ns/shacl#conforms"
       },

diff --git a/test/data/integration/profile16/negative.data.yaml b/test/data/integration/profile16/negative.data.yaml
@@ -19,7 +19,7 @@ components:
         name:
           description: a property
           type: string
-      required: ["id"]
+      required: [ "id" ]
 
 paths:
   /users:

diff --git a/test/data/integration/profile16/negative.report.jsonld b/test/data/integration/profile16/negative.report.jsonld
@@ -1,6 +1,7 @@
 [
   {
     "@context": {
+      "@base": "http://a.ml/vocabularies/validation/report#",
       "actual": {
         "@id": "http://a.ml/vocabularies/validation#actual"
       },

diff --git a/test/data/integration/profile16/negative.report.lexical.jsonld b/test/data/integration/profile16/negative.report.lexical.jsonld
@@ -1,6 +1,7 @@
 [
   {
     "@context": {
+      "@base": "http://a.ml/vocabularies/validation/report#",
       "actual": {
         "@id": "http://a.ml/vocabularies/validation#actual"
       },

diff --git a/test/data/integration/profile16/positive.data.yaml b/test/data/integration/profile16/positive.data.yaml
@@ -19,7 +19,7 @@ components:
         name:
           description: a property
           type: string
-      required: ["id"]
+      required: [ "id" ]
 
 paths:
   /users:

diff --git a/test/data/integration/profile16/positive.report.jsonld b/test/data/integration/profile16/positive.report.jsonld
@@ -1,6 +1,7 @@
 [
   {
     "@context": {
+      "@base": "http://a.ml/vocabularies/validation/report#",
       "conforms": {
         "@id": "http://www.w3.org/ns/shacl#conforms"
       },

diff --git a/test/data/integration/profile17/negative.data.yaml b/test/data/integration/profile17/negative.data.yaml
@@ -2,4 +2,4 @@ openapi: 3.0.0
 info:
   title: Example API
   version: '1.0'
-paths: {}
+paths: { }
diff --git a/test/data/integration/profile17/negative.report.jsonld b/test/data/integration/profile17/negative.report.jsonld
@@ -1,6 +1,7 @@
 [
   {
     "@context": {
+      "@base": "http://a.ml/vocabularies/validation/report#",
       "actual": {
         "@id": "http://a.ml/vocabularies/validation#actual"
       },

diff --git a/test/data/integration/profile17/negative.report.lexical.jsonld b/test/data/integration/profile17/negative.report.lexical.jsonld
@@ -1,6 +1,7 @@
 [
   {
     "@context": {
+      "@base": "http://a.ml/vocabularies/validation/report#",
       "actual": {
         "@id": "http://a.ml/vocabularies/validation#actual"
       },

diff --git a/test/data/integration/profile17/positive.data.yaml b/test/data/integration/profile17/positive.data.yaml
@@ -2,4 +2,4 @@ openapi: 3.0.0
 info:
   title: Example API
   version: 'v1.1.0'
-paths: {}
+paths: { }
diff --git a/test/data/integration/profile17/positive.report.jsonld b/test/data/integration/profile17/positive.report.jsonld
@@ -1,6 +1,7 @@
 [
   {
     "@context": {
+      "@base": "http://a.ml/vocabularies/validation/report#",
       "conforms": {
         "@id": "http://www.w3.org/ns/shacl#conforms"
       },

diff --git a/test/data/integration/profile18/negative.report.jsonld b/test/data/integration/profile18/negative.report.jsonld
@@ -1,6 +1,7 @@
 [
   {
     "@context": {
+      "@base": "http://a.ml/vocabularies/validation/report#",
       "actual": {
         "@id": "http://a.ml/vocabularies/validation#actual"
       },

diff --git a/test/data/integration/profile18/positive.data.yaml b/test/data/integration/profile18/positive.data.yaml
@@ -2,7 +2,7 @@ openapi: "3.0.0"
 info:
   title: example API
   version: "1.0.0"
-paths: {}
+paths: { }
 x-wadus:
   hola: mundo
   things:

diff --git a/test/data/integration/profile18/positive.report.jsonld b/test/data/integration/profile18/positive.report.jsonld
@@ -1,6 +1,7 @@
 [
   {
     "@context": {
+      "@base": "http://a.ml/vocabularies/validation/report#",
       "conforms": {
         "@id": "http://www.w3.org/ns/shacl#conforms"
       },

diff --git a/test/data/integration/profile19/negative.report.jsonld b/test/data/integration/profile19/negative.report.jsonld
@@ -1,6 +1,7 @@
 [
   {
     "@context": {
+      "@base": "http://a.ml/vocabularies/validation/report#",
       "actual": {
         "@id": "http://a.ml/vocabularies/validation#actual"
       },

diff --git a/test/data/integration/profile19/negative.report.lexical.jsonld b/test/data/integration/profile19/negative.report.lexical.jsonld
@@ -1,6 +1,7 @@
 [
   {
     "@context": {
+      "@base": "http://a.ml/vocabularies/validation/report#",
       "actual": {
         "@id": "http://a.ml/vocabularies/validation#actual"
       },

diff --git a/test/data/integration/profile19/positive.report.jsonld b/test/data/integration/profile19/positive.report.jsonld
@@ -1,6 +1,7 @@
 [
   {
     "@context": {
+      "@base": "http://a.ml/vocabularies/validation/report#",
       "conforms": {
         "@id": "http://www.w3.org/ns/shacl#conforms"
       },

diff --git a/test/data/integration/profile2/negative.report.jsonld b/test/data/integration/profile2/negative.report.jsonld
@@ -1,6 +1,7 @@
 [
   {
     "@context": {
+      "@base": "http://a.ml/vocabularies/validation/report#",
       "actual": {
         "@id": "http://a.ml/vocabularies/validation#actual"
       },

diff --git a/test/data/integration/profile2/negative.report.lexical.jsonld b/test/data/integration/profile2/negative.report.lexical.jsonld
@@ -1,6 +1,7 @@
 [
   {
     "@context": {
+      "@base": "http://a.ml/vocabularies/validation/report#",
       "actual": {
         "@id": "http://a.ml/vocabularies/validation#actual"
       },

diff --git a/test/data/integration/profile2/positive.report.jsonld b/test/data/integration/profile2/positive.report.jsonld
@@ -1,6 +1,7 @@
 [
   {
     "@context": {
+      "@base": "http://a.ml/vocabularies/validation/report#",
       "conforms": {
         "@id": "http://www.w3.org/ns/shacl#conforms"
       },

diff --git a/test/data/integration/profile20/negative.report.jsonld b/test/data/integration/profile20/negative.report.jsonld
@@ -1,6 +1,7 @@
 [
   {
     "@context": {
+      "@base": "http://a.ml/vocabularies/validation/report#",
       "actual": {
         "@id": "http://a.ml/vocabularies/validation#actual"
       },

diff --git a/test/data/integration/profile20/negative.report.lexical.jsonld b/test/data/integration/profile20/negative.report.lexical.jsonld
@@ -1,6 +1,7 @@
 [
   {
     "@context": {
+      "@base": "http://a.ml/vocabularies/validation/report#",
       "actual": {
         "@id": "http://a.ml/vocabularies/validation#actual"
       },