#419

Committed 05 May 2025 08:11AM UTC coverage: 90.169% (+0.8%) from 89.357%

Build # #419

Build Type

Pull #255

github

Committed by

web-flow

Commit Message

Merge pull request #256 from kit-data-manager/make-spec-examples-executable

Make specification examples (from readme) executable

Pull Request Pull Request #255: Next Version (v2.1.0-rc2 | v2.1.0)

Run Details

63 of 70 new or added lines in 16 files covered. (90.0%)

14 existing lines in 5 files now uncovered.

1917 of 2126 relevant lines covered (90.17%)

0.9 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

74.29

/src/main/java/edu/kit/datamanager/ro_crate/entities/validation/JsonSchemaValidation.java

package edu.kit.datamanager.ro_crate.entities.validation;

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.networknt.schema.JsonSchema;
import com.networknt.schema.JsonSchemaFactory;
import com.networknt.schema.SpecVersion;
import com.networknt.schema.ValidationMessage;

import edu.kit.datamanager.ro_crate.objectmapper.MyObjectMapper;

import java.net.URISyntaxException;
import java.net.URL;
import java.util.Objects;
import java.util.Set;

/**
 * Implementation of the entity validation strategy that uses json schema.
 */
public class JsonSchemaValidation implements EntityValidationStrategy {

  private static final URL entitySchemaDefault
      = Objects.requireNonNull(JsonSchemaValidation.class.getClassLoader()
      .getResource("json_schemas/entity_schema.json"));
  private static final URL fieldSchemaDefault
      = Objects.requireNonNull(JsonSchemaValidation.class.getClassLoader()
      .getResource("json_schemas/entity_field_structure_schema.json"));

  private JsonSchema entitySchema;
  private JsonSchema entityFieldSchema;

  /**
   *  Default constructor that uses the default schemas.
   */
  public JsonSchemaValidation() {
    JsonSchemaFactory factory = JsonSchemaFactory.getInstance(SpecVersion.VersionFlag.V201909);
    try {
      this.entitySchema = factory.getSchema(entitySchemaDefault.toURI());
      this.entityFieldSchema = factory.getSchema(fieldSchemaDefault.toURI());
    } catch (URISyntaxException e) {
      e.printStackTrace();
    }
  }

  /**
   * Constructor that uses custom schemas present as Json files.
   *
   * @param entitySchema schema for the entities validation.
   * @param fieldSchema schema for the field validation.
   */
  public JsonSchemaValidation(JsonNode entitySchema, JsonNode fieldSchema) {
    JsonSchemaFactory factory = JsonSchemaFactory.getInstance(SpecVersion.VersionFlag.V201909);
    this.entitySchema = factory.getSchema(entitySchema);
    this.entityFieldSchema = factory.getSchema(fieldSchema);
  }

  @Override
  public boolean validateEntity(JsonNode entity) {
    Set<ValidationMessage> errors = this.entitySchema.validate(entity);
    if (errors.size() != 0) {
      System.err.println("This entity does not comply to the basic RO-Crate entity structure.");
      return false;
    }
    return true;
  }

  @Override
  public boolean validateFieldOfEntity(JsonNode field) {
    Set<ValidationMessage> errors = this.entityFieldSchema.validate(field);
    if (!errors.isEmpty()) {
      ObjectMapper objectMapper = MyObjectMapper.getMapper();
      System.err.println("The property: ");
      try {
        System.err.println(objectMapper.writerWithDefaultPrettyPrinter().writeValueAsString(field));
      } catch (JsonProcessingException e) {
        e.printStackTrace();
      }
      System.err.println("does not comply with the flattened structure"
          + " of the RO-Crate json document.");
      return false;
    }
    return true;
  }
}

1	package edu.kit.datamanager.ro_crate.entities.validation;
2
3	import com.fasterxml.jackson.core.JsonProcessingException;
4	import com.fasterxml.jackson.databind.JsonNode;
5	import com.fasterxml.jackson.databind.ObjectMapper;
6	import com.networknt.schema.JsonSchema;
7	import com.networknt.schema.JsonSchemaFactory;
8	import com.networknt.schema.SpecVersion;
9	import com.networknt.schema.ValidationMessage;
10
11	import edu.kit.datamanager.ro_crate.objectmapper.MyObjectMapper;
12
13	import java.net.URISyntaxException;
14	import java.net.URL;
15	import java.util.Objects;
16	import java.util.Set;
17
18	/**
19	* Implementation of the entity validation strategy that uses json schema.
20	*/
21	public class JsonSchemaValidation implements EntityValidationStrategy {
22
23	private static final URL entitySchemaDefault	1✔
24	= Objects.requireNonNull(JsonSchemaValidation.class.getClassLoader()	1✔
25	.getResource("json_schemas/entity_schema.json"));	1✔
26	private static final URL fieldSchemaDefault	1✔
27	= Objects.requireNonNull(JsonSchemaValidation.class.getClassLoader()	1✔
28	.getResource("json_schemas/entity_field_structure_schema.json"));	1✔
29
30	private JsonSchema entitySchema;
31	private JsonSchema entityFieldSchema;
32
33	/**
34	* Default constructor that uses the default schemas.
35	*/
36	public JsonSchemaValidation() {	1✔
37	JsonSchemaFactory factory = JsonSchemaFactory.getInstance(SpecVersion.VersionFlag.V201909);	1✔
38	try {
39	this.entitySchema = factory.getSchema(entitySchemaDefault.toURI());	1✔
40	this.entityFieldSchema = factory.getSchema(fieldSchemaDefault.toURI());	1✔
41	} catch (URISyntaxException e) {	×
42	e.printStackTrace();	×
43	}	1✔
44	}	1✔
45
46	/**
47	* Constructor that uses custom schemas present as Json files.
48	*
49	* @param entitySchema schema for the entities validation.
50	* @param fieldSchema schema for the field validation.
51	*/
52	public JsonSchemaValidation(JsonNode entitySchema, JsonNode fieldSchema) {	×
53	JsonSchemaFactory factory = JsonSchemaFactory.getInstance(SpecVersion.VersionFlag.V201909);	×
54	this.entitySchema = factory.getSchema(entitySchema);	×
55	this.entityFieldSchema = factory.getSchema(fieldSchema);	×
56	}	×
57
58	@Override
59	public boolean validateEntity(JsonNode entity) {
60	Set<ValidationMessage> errors = this.entitySchema.validate(entity);	1✔
61	if (errors.size() != 0) {	1✔
62	System.err.println("This entity does not comply to the basic RO-Crate entity structure.");	1✔
63	return false;	1✔
64	}
65	return true;	1✔
66	}
67
68	@Override
69	public boolean validateFieldOfEntity(JsonNode field) {
70	Set<ValidationMessage> errors = this.entityFieldSchema.validate(field);	1✔
71	if (!errors.isEmpty()) {	1✔
72	ObjectMapper objectMapper = MyObjectMapper.getMapper();	1✔
73	System.err.println("The property: ");	1✔
74	try {
75	System.err.println(objectMapper.writerWithDefaultPrettyPrinter().writeValueAsString(field));	1✔
UNCOV 76	} catch (JsonProcessingException e) {	×
77	e.printStackTrace();	×
78	}	1✔
79	System.err.println("does not comply with the flattened structure"	1✔
80	+ " of the RO-Crate json document.");
81	return false;	1✔
82	}
83	return true;	1✔
84	}
85	}

kit-data-manager / ro-crate-java / #419

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous