segregated getDefaultNode in utils #1005
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| /* | ||
| * Copyright (c) 2024 the original author or authors. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package com.networknt.schema.utils; | ||
|
|
||
| import com.fasterxml.jackson.databind.JsonNode; | ||
| import com.networknt.schema.JsonSchema; | ||
| import com.networknt.schema.JsonSchemaRef; | ||
|
|
||
| /** | ||
| * The 'Defaults' class provides utility methods for retrieving default values | ||
| * from a JSON schema. | ||
| * | ||
| * This class contains a single static method, 'getDefaultNode', which takes a | ||
| * 'JsonSchema' object as input | ||
| * and returns the default value specified in the schema. If the schema does not | ||
| * have a default value, | ||
| * it checks if the schema has a reference to another schema and recursively | ||
| * calls itself with the referenced schema. | ||
| * | ||
| * Usage: | ||
| * JsonSchema schema = ...; // create or obtain a JSON schema | ||
| * JsonNode defaultNode = Defaults.getDefaultNode(schema); // retrieve the | ||
| * default value from the schema | ||
| * | ||
| * Note: This class requires the 'com.networknt.schema.JsonSchema' and | ||
| * 'com.networknt.schema.JsonSchemaRef' classes | ||
| * from the 'networknt/json-schema-validator' library. | ||
| */ | ||
| public class Defaults { | ||
|
There was a problem hiding this comment. Add the javadoc for the class. |
||
| /** | ||
| * Retrieves the default value specified in the JSON schema. | ||
| * | ||
| * This method takes a 'JsonSchema' object as input and returns the default | ||
| * value specified in the schema. | ||
| * If the schema does not have a default value, it checks if the schema has a | ||
| * reference to another schema | ||
| * and recursively calls itself with the referenced schema. | ||
| * | ||
| * @param schema the JSON schema from which to retrieve the default value | ||
| * @return the default value specified in the schema, or null if no default | ||
| * value is found | ||
| */ | ||
| public static JsonNode getDefaultNode(JsonSchema schema) { | ||
| JsonNode result = schema.getSchemaNode().get("default"); | ||
| if (result == null) { | ||
| JsonSchemaRef schemaRef = JsonSchemaRefs.from(schema); | ||
| if (schemaRef != null) { | ||
| result = getDefaultNode(schemaRef.getSchema()); | ||
| } | ||
| } | ||
| return result; | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| package com.networknt.schema.utils; | ||
|
|
||
| import static org.junit.jupiter.api.Assertions.assertEquals; | ||
| import static org.junit.jupiter.api.Assertions.assertNotNull; | ||
| import static org.junit.jupiter.api.Assertions.assertNull; | ||
|
|
||
| import java.io.InputStream; | ||
|
|
||
| import org.junit.jupiter.api.Test; | ||
| 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.VersionFlag; | ||
| public class DefaultsTest { | ||
|
|
||
| @Test | ||
| void testGetDefaultNodeNotNull() throws Exception { | ||
| ObjectMapper mapper = new ObjectMapper(); | ||
| JsonNode node = mapper.readTree("{\"default\": \"defaultValue\"}"); | ||
| JsonSchemaFactory factory = JsonSchemaFactory.getInstance(VersionFlag.V7); | ||
| JsonSchema schema = factory.getSchema(node); | ||
| JsonNode result = Defaults.getDefaultNode(schema); | ||
| assertNotNull(result, "Default node should not be null"); | ||
| } | ||
|
|
||
| @Test | ||
| void testGetDefaultNodeWhenDefaultNotFound() throws Exception { | ||
| ObjectMapper mapper = new ObjectMapper(); | ||
| // Create a JsonNode without a "default" field | ||
| JsonNode node = mapper.readTree("{\"notDefault\": \"value\"}"); | ||
| JsonSchemaFactory factory = JsonSchemaFactory.getInstance(VersionFlag.V7); | ||
| JsonSchema schema = factory.getSchema(node); | ||
| JsonNode result = Defaults.getDefaultNode(schema); | ||
| // Assert that the result is null, as there's no "default" node in the schema | ||
| assertNull(result, "Default node should be null when 'default' node is not found in the schema"); | ||
| } | ||
|
|
||
| @Test | ||
| void testGetDefaultNodeWhenDefaultInRef() throws Exception { | ||
|
There was a problem hiding this comment. Don't create external resources for the test. Just use strings inline as it makes the test hard to read and verify. This test isn't even valid. You have a unused variable |
||
| InputStream mainSchemaInputStream = DefaultsTest.class.getResourceAsStream("/mainSchema.json"); | ||
| InputStream referredSchemaInputStream = DefaultsTest.class.getResourceAsStream("/referredSchema.json"); | ||
| ObjectMapper mapper = new ObjectMapper(); | ||
| JsonNode mainSchemaNode = mapper.readTree(mainSchemaInputStream); | ||
| JsonNode referredSchemaNode = mapper.readTree(referredSchemaInputStream); | ||
| JsonSchemaFactory factory = JsonSchemaFactory.getInstance(VersionFlag.V7); | ||
| JsonSchema mainSchema = factory.getSchema(referredSchemaNode); // Use referred schema here | ||
| JsonNode result = Defaults.getDefaultNode(mainSchema); | ||
| assertNotNull(result, "Default node should not be null when 'default' node is in the referred schema"); | ||
| assertEquals("defaultValue", result.asText(), "Default node should have the default value in the referred schema"); | ||
| } | ||
|
|
||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| { | ||
| "$ref": "referredSchema.json" | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| { | ||
| "type": "string", | ||
| "default": "defaultValue" | ||
| } |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just change this to
The 'Defaults' class provides utility methods for retrieving default values from a JSON schema.