add validator for duration format (#593)

Co-authored-by: iouakrim <[email protected]>

Author: iouakrim

src/main/java/com/networknt/schema/FormatKeyword.java

@@ -17,6 +17,7 @@
 package com.networknt.schema;
 
 import com.fasterxml.jackson.databind.JsonNode;
+import com.networknt.schema.format.DurationValidator;
 import com.networknt.schema.format.EmailValidator;
 
 import java.util.Collection;
@@ -31,6 +32,7 @@ public class FormatKeyword implements Keyword {
     private final String DATE_TIME = "date-time";
     private final String UUID = "uuid";
     private final String EMAIL = "email";
+    private final String DURATION = "duration";
 
     public FormatKeyword(ValidatorTypeCode type, Map<String, Format> formats) {
         this.type = type;
@@ -60,6 +62,9 @@ public JsonValidator newValidator(String schemaPath, JsonNode schemaNode, JsonSc
             } else if (formatName.equals(EMAIL)) {
                 return new EmailValidator(schemaPath, schemaNode, parentSchema, validationContext, formatName);
             }
+            else if (formatName.equals(DURATION)) {
+                return new DurationValidator(schemaPath, schemaNode, parentSchema, validationContext, formatName);
+            }
         }
         return new FormatValidator(schemaPath, schemaNode, parentSchema, validationContext, format);
     }

src/main/java/com/networknt/schema/format/DurationValidator.java

@@ -0,0 +1,89 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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.format;
+
+import com.fasterxml.jackson.databind.JsonNode;
+import com.networknt.schema.*;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.util.Collections;
+import java.util.LinkedHashSet;
+import java.util.Set;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
+/**
+ *
+ * <p>This class provides methods to validate a duration format .
+ *
+ * @version $Revision$
+ * @since Validator 1.4
+ */
+public class DurationValidator extends BaseJsonValidator implements JsonValidator {
+    private static final Logger logger = LoggerFactory.getLogger(DurationValidator.class);
+
+    private static final String DURATION_REGEX = "^(-?)P(?=\\d|T\\d)(?:(\\d+)Y)?(?:(\\d+)M)?(?:(\\d+)([DW]))?(?:T(?:(\\d+)H)?(?:(\\d+)M)?(?:(\\d+(?:\\.\\d+)?)S)?)?$";
+    private static final Pattern DURATION_PATTERN = Pattern.compile(DURATION_REGEX);
+    private final String formatName;
+
+
+
+    /**
+     * <p>Checks if a field has a valid duration.</p>
+     *
+     * @param duration The value validation is being performed on.  A <code>null</code>
+     *              value is considered invalid.
+     * @return true if the duration valid.
+     */
+    public boolean isValid(String duration) {
+        if (duration == null) {
+            return false;
+        }
+
+        Matcher durationMatcher = DURATION_PATTERN.matcher(duration);
+        if (!durationMatcher.matches()) {
+            return false;
+        }
+
+        return true;
+    }
+
+    public DurationValidator(String schemaPath, JsonNode schemaNode, JsonSchema parentSchema, ValidationContext validationContext, String formatName) {
+        super(schemaPath, schemaNode, parentSchema, ValidatorTypeCode.FORMAT, validationContext);
+        this.formatName = formatName;
+        this.validationContext = validationContext;
+        parseErrorCode(getValidatorType().getErrorCodeKey());
+    }
+
+    @Override
+    public Set<ValidationMessage> validate(JsonNode node, JsonNode rootNode, String at) {
+        debug(logger, node, rootNode, at);
+
+        Set<ValidationMessage> errors = new LinkedHashSet<ValidationMessage>();
+
+        JsonType nodeType = TypeFactory.getValueNodeType(node, this.validationContext.getConfig());
+        if (nodeType != JsonType.STRING) {
+            return errors;
+        }
+        if (!isValid(node.textValue())) {
+            errors.add(buildValidationMessage(at, node.textValue(), formatName));
+        }
+        return Collections.unmodifiableSet(errors);
+
+    }
+}

src/test/java/com/networknt/schema/DurationFormatValidatorTest.java

@@ -0,0 +1,48 @@
+/*
+ * Copyright (c) 2016 Network New Technologies Inc.
+ *
+ * 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;
+
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import org.junit.jupiter.api.Test;
+
+import java.io.IOException;
+import java.util.Set;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+public class DurationFormatValidatorTest {
+
+    @Test
+    public void durationFormatValidatorTest() throws JsonProcessingException, IOException {
+        ObjectMapper objectMapper = new ObjectMapper();
+        final String schema = "{\"type\": \"string\", \"format\": \"duration\"}\n";
+        final JsonNode validTargetNode = objectMapper.readTree("\"P1D\"");
+        final JsonNode invalidTargetNode = objectMapper.readTree("\"INVALID_DURATION\"");
+
+        final JsonSchemaFactory validatorFactory = JsonSchemaFactory.builder(JsonSchemaFactory.getInstance(SpecVersion.VersionFlag.V201909)).build();
+        final JsonSchema validatorSchema = validatorFactory.getSchema(schema);
+
+        Set<ValidationMessage> messages = validatorSchema.validate(validTargetNode);
+        assertEquals(0, messages.size());
+
+        messages = validatorSchema.validate(invalidTargetNode);
+        assertEquals(1, messages.size());
+
+    }
+}