Merge pull request #148 from aml-org/release/1.5.0

W-13925189 Release/1.5.0

Author: damianpedra

Dockerfile

@@ -10,8 +10,8 @@ RUN go mod tidy
 COPY . .
 RUN make ci-go
 
-FROM openjdk:8u292-jre AS ci-java
-#FROM openjdk/8u292-jdk AS ci-java
+FROM eclipse-temurin:17-focal AS ci-java
+
 # Copy content
 COPY . ./src
 WORKDIR ./src

README.md

@@ -142,7 +142,7 @@ To integrate with AMF, download an AMF CLI JAR with the following script:
 
 ## Obtaining semantic data from API specs with AMF
 
-To parse API specification files with the CLI using Java (Java 8 required):
+To parse API specification files with the CLI using Java (Java 17 required):
 
 ```shell
 # Simple parse
@@ -168,4 +168,4 @@ java -jar amf.jar validate PROFILE
 
 # Contributing
 
-For details on how to develop and contribute, please refer to [contributing guide](docs/contributing.md)
+For details on how to develop and contribute, please refer to [contributing guide](docs/contributing.md)

docs/contributing.md

@@ -3,7 +3,7 @@
 ## Development requirements
 
 * Go 1.19
-* Java 8 (to validate validation profiles & reports only)
+* Java 17 (to validate validation profiles & reports only)
 * Node 16
 * Make
 
@@ -24,7 +24,7 @@ make test-js
 ```
 
 When writing new validation profiles or modifying validation reports you will need to validate both are correct. This 
-requires Java 8 and an AMF CLI that can be downloaded with `./scripts/download-amf-cli.sh`
+requires Java 17 and an AMF CLI that can be downloaded with `./scripts/download-amf-cli.sh`
 
 To find and validate all validation profiles and reports in the project run:
 
@@ -161,4 +161,4 @@ Test cases extracted from the SHACL TCK
 
 * `test/tck`
 
-Proprietary TCK cases
+Proprietary TCK cases

internal/generator/generator.go

@@ -33,10 +33,21 @@ func IriExpanderFrom(profile profile.Profile) *misc.IriExpander {
 // code to execute the profile.
 func Generate(profile profile.Profile) RegoUnit {
 	iriExpander := IriExpanderFrom(profile)
-	acc := []string{pkg(profile), profileName(profile), preamble(profile)}
+	acc := []string{pkg(profile), profileName(profile), customRego(profile), preamble(profile)}
+
 	for _, r := range ruleSet(profile) {
 		acc = append(acc, GenerateTopLevelExpression(r, iriExpander))
 	}
+
+	n := 0
+	for _, val := range acc {
+		if val != "" {
+			acc[n] = val
+			n++
+		}
+	}
+	acc = acc[:n]
+
 	return RegoUnit{
 		Name:       packageName(profile),
 		Entrypoint: entrypoint(profile),
@@ -81,6 +92,16 @@ func entrypoint(profile profile.Profile) string {
 	return "report"
 }
 
+func customRego(profile profile.Profile) string {
+	acc := make([]string, 0)
+	if profile.CustomRego != nil {
+		acc = append(acc, "# Custom rego extensions")
+		acc = append(acc, *profile.CustomRego)
+	}
+
+	return strings.Join(acc, "\n\n")
+}
+
 func preamble(profile profile.Profile) string {
 	acc := make([]string, 0)
 	acc = append(acc, preambleRaw)
@@ -100,6 +121,12 @@ func preamble(profile profile.Profile) string {
 }
 
 const preambleRaw = `
+# Import future keywords
+import future.keywords.in
+import future.keywords.every
+import future.keywords.if
+import future.keywords.contains
+
 # Finds a node in the graph, following a link in the flatten JSON-LD node
 find = node {
   id := data.link["@id"]

internal/parser/parsing_test.go

@@ -22,7 +22,7 @@ func TestParsed(t *testing.T) {
 		}
 
 		if actual != expected {
-			t.Errorf("%s> Actual did not match expected", fix.Profile)
+			t.Errorf("%s> Actual did not match expected %s", fix.Profile, fix.Parsed)
 		}
 	}
 }

internal/parser/profile/parser.go

@@ -20,6 +20,11 @@ func Parse(doc *y.Yaml) (Profile, error) {
 			profile.Description = &description
 		}
 
+		customRego, err := doc.Get("rego_extensions").String()
+		if err == nil {
+			profile.CustomRego = &customRego
+		}
+
 		prefixes := doc.Get("prefixes")
 		if prefixes.IsFound() {
 			context, err := ParsePrefixes(prefixes)

internal/parser/profile/rule.go

@@ -43,6 +43,7 @@ type AtomicStatement struct {
 type Profile struct {
 	Name        string
 	Description *string
+	CustomRego  *string
 	Prefixes    ProfileContext
 	Violation   []Rule
 	Warning     []Rule

internal/validator/contexts/contexts.go

@@ -18,6 +18,10 @@ var DefaultAMFContext = types.ObjectMap{
 	"security":    "http://a.ml/vocabularies/security#",
 	"sourcemaps":  "http://a.ml/vocabularies/document-source-maps#",
 	"apiExt":      ApiExtensionUri,
+	"gcl":         "http://anypoint.com/vocabs/gcl#",
+	"management":  "http://anypoint.com/vocabs/management#",
+	"api":         "http://anypoint.com/vocabs/api#",
+	"catalog":     "http://anypoint.com/vocabs/digital-repository#",
 }
 
 var DefaultValidationContext = types.ObjectMap{
@@ -78,6 +82,9 @@ var DefaultValidationContext = types.ObjectMap{
 	"conforms": types.StringMap{
 		"@id": "http://www.w3.org/ns/shacl#conforms",
 	},
+	"dateCreated": types.StringMap{
+		"@id": "http://a.ml/vocabularies/core##dateCreated",
+	},
 	"profileName": types.StringMap{
 		"@id": "http://a.ml/vocabularies/validation#profileName",
 	},

internal/validator/process_result.go

@@ -5,9 +5,9 @@ import (
 	"github.com/open-policy-agent/opa/rego"
 )
 
-func processResult(result *rego.ResultSet, eventChan *chan e.Event) (string, error) {
+func processResult(result *rego.ResultSet, eventChan *chan e.Event, configuration ValidationConfiguration) (string, error) {
 	dispatchEvent(e.NewEvent(e.BuildReportStart), eventChan)
-	report, err := BuildReport(result)
+	report, err := BuildReport(result, configuration)
 	dispatchEvent(e.NewEvent(e.BuildReportDone), eventChan)
 	return report, err
 }

internal/validator/report.go

@@ -12,7 +12,7 @@ import (
 	"strings"
 )
 
-func BuildReport(resultPtr *rego.ResultSet) (string, error) {
+func BuildReport(resultPtr *rego.ResultSet, configuration ValidationConfiguration) (string, error) {
 	result := *resultPtr
 	if len(result) == 0 {
 		return "", errors.New("empty result from evaluation")
@@ -26,9 +26,10 @@ func BuildReport(resultPtr *rego.ResultSet) (string, error) {
 	infos := m["info"].([]any)
 	results := buildResults(violations, warnings, infos)
 	conforms := len(violations) == 0
+	dateCreated := configuration.CurrentTime()
 
 	context := buildContext(len(results) == 0)
-	reportNode := ValidationReportNode(profileName, results, conforms)
+	reportNode := ValidationReportNode(profileName, results, conforms, dateCreated)
 	instance := DialectInstance(&reportNode, &context)
 	return Encode(instance), nil
 }