diff options
Diffstat (limited to 'common-parameters')
6 files changed, 701 insertions, 0 deletions
diff --git a/common-parameters/src/main/java/org/onap/policy/common/parameters/BeanValidationResult.java b/common-parameters/src/main/java/org/onap/policy/common/parameters/BeanValidationResult.java new file mode 100644 index 00000000..f8eebcf1 --- /dev/null +++ b/common-parameters/src/main/java/org/onap/policy/common/parameters/BeanValidationResult.java @@ -0,0 +1,166 @@ +/* + * ============LICENSE_START======================================================= + * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * 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. + * + * SPDX-License-Identifier: Apache-2.0 + * ============LICENSE_END========================================================= + */ + +package org.onap.policy.common.parameters; + +import java.util.ArrayList; +import java.util.Collection; +import java.util.List; +import java.util.function.Function; + +/** + * This class holds the result of the validation of an arbitrary bean. + */ +public class BeanValidationResult extends ValidationResultImpl { + + /** + * Validation results for each item in the bean. + */ + private final List<ValidationResult> itemResults = new ArrayList<>(); + + + /** + * Constructs the object. + * + * @param name name of the bean being validated + * @param object object being validated + */ + public BeanValidationResult(String name, Object object) { + super(name, object); + } + + /** + * Adds a result to this result. + * + * @param result the result to be added + * @return {@code true} if the result is {@code null} or valid, {@code false} if the + * result is invalid + */ + public boolean addResult(ValidationResult result) { + if (result == null) { + return true; + } + + itemResults.add(result); + setResult(result.getStatus()); + + return result.isValid(); + } + + /** + * Validates that a sub-object within the bean is not {@code null}. + * + * @param subName name of the sub-object + * @param subObject the sub-object + * @return {@code true} if the value is not null, {@code false} otherwise + */ + public boolean validateNotNull(String subName, Object subObject) { + ObjectValidationResult result = new ObjectValidationResult(subName, subObject); + + if (result.validateNotNull()) { + return true; + + } else { + addResult(result); + return false; + } + } + + /** + * Validates the items in a list, after validating that the list, itself, is not null. + * + * @param listName name of the list + * @param list list whose items are to be validated, or {@code null} + * @param itemValidator function to validate an item in the list + * @return {@code true} if all items in the list are valid, {@code false} otherwise + */ + public <T> boolean validateNotNullList(String listName, Collection<T> list, + Function<T, ValidationResult> itemValidator) { + + return validateNotNull(listName, list) && validateList(listName, list, itemValidator); + } + + /** + * Validates the items in a list. + * + * @param listName name of the list + * @param list list whose items are to be validated, or {@code null} + * @param itemValidator function to validate an item in the list + * @return {@code true} if all items in the list are valid, {@code false} otherwise + */ + public <T> boolean validateList(String listName, Collection<T> list, Function<T, ValidationResult> itemValidator) { + if (list == null) { + return true; + } + + BeanValidationResult result = new BeanValidationResult(listName, null); + for (T item : list) { + if (item == null) { + result.addResult(new ObjectValidationResult("item", item, ValidationStatus.INVALID, "null")); + } else { + result.addResult(itemValidator.apply(item)); + } + } + + if (result.isValid()) { + return true; + + } else { + addResult(result); + return false; + } + } + + /** + * Gets the validation result. + * + * @param initialIndentation the indentation to use on the main result output + * @param subIndentation the indentation to use on sub parts of the result output + * @param showClean output information on clean fields + * @return the result + */ + @Override + public String getResult(final String initialIndentation, final String subIndentation, final boolean showClean) { + if (!showClean && getStatus() == ValidationStatus.CLEAN) { + return null; + } + + StringBuilder builder = new StringBuilder(); + + builder.append(initialIndentation); + builder.append('"'); + builder.append(getName()); + + builder.append("\" "); + builder.append(getStatus()); + builder.append(", "); + builder.append(getMessage()); + builder.append('\n'); + + for (ValidationResult itemResult : itemResults) { + String message = itemResult.getResult(initialIndentation + subIndentation, subIndentation, showClean); + if (message != null) { + builder.append(message); + } + } + + return builder.toString(); + } +} diff --git a/common-parameters/src/main/java/org/onap/policy/common/parameters/ObjectValidationResult.java b/common-parameters/src/main/java/org/onap/policy/common/parameters/ObjectValidationResult.java new file mode 100644 index 00000000..e5597206 --- /dev/null +++ b/common-parameters/src/main/java/org/onap/policy/common/parameters/ObjectValidationResult.java @@ -0,0 +1,65 @@ +/* + * ============LICENSE_START======================================================= + * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * 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. + * + * SPDX-License-Identifier: Apache-2.0 + * ============LICENSE_END========================================================= + */ + +package org.onap.policy.common.parameters; + +/** + * This class holds the result of the validation of an object within a bean. + */ +public class ObjectValidationResult extends ValidationResultImpl { + + /** + * Constructs the object. + * + * @param name name of the object of this result + * @param object object being validated + */ + public ObjectValidationResult(String name, Object object) { + super(name, object); + } + + /** + * Constructs the object. + * + * @param name name of the object of this result + * @param object object being validated + */ + public ObjectValidationResult(String name, Object object, ValidationStatus status, String message) { + super(name, object, status, message); + } + + /** + * Gets the validation result. + * + * @param initialIndentation the result indentation + * @param subIndentation the indentation to use on sub parts of the result output + * @param showClean output information on clean fields + * @return the result + */ + @Override + public String getResult(final String initialIndentation, final String subIndentation, final boolean showClean) { + if (!showClean && getStatus() == ValidationStatus.CLEAN) { + return null; + } + + return initialIndentation + "item \"" + getName() + "\" value \"" + getObject() + "\" " + getStatus() + ", " + + getMessage() + '\n'; + } +} diff --git a/common-parameters/src/main/java/org/onap/policy/common/parameters/ValidationResultImpl.java b/common-parameters/src/main/java/org/onap/policy/common/parameters/ValidationResultImpl.java new file mode 100644 index 00000000..1d8aa239 --- /dev/null +++ b/common-parameters/src/main/java/org/onap/policy/common/parameters/ValidationResultImpl.java @@ -0,0 +1,120 @@ +/* + * ============LICENSE_START======================================================= + * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * 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. + * + * SPDX-License-Identifier: Apache-2.0 + * ============LICENSE_END========================================================= + */ + +package org.onap.policy.common.parameters; + +import lombok.Getter; + +/** + * Basic implementation of a ValidationResult. + */ +@Getter +public abstract class ValidationResultImpl implements ValidationResult { + public static final String ITEM_HAS_STATUS_MESSAGE = "item has status "; + + /** + * Name of the object of this result. + */ + private final String name; + + /** + * Object being validated. + */ + private final Object object; + + /** + * Validation status of this object. + */ + private ValidationStatus status = ValidationStatus.CLEAN; + + /** + * Validation message. + */ + private String message = ITEM_HAS_STATUS_MESSAGE + status.toString(); + + + /** + * Constructs the object. + * + * @param name name of the object of this result + * @param object object being validated + */ + public ValidationResultImpl(String name, Object object) { + this.name = name; + this.object = object; + } + + /** + * Constructs the object. + * + * @param name name of the object of this result + * @param object object being validated + * @param status the validation status + * @param message the validation message explaining the validation status + */ + public ValidationResultImpl(String name, Object object, ValidationStatus status, String message) { + this.name = name; + this.object = object; + this.status = status; + this.message = message; + } + + /** + * Validates that the value is not {@code null}. + * + * @return {@code true} if the value is not null, {@code false} otherwise + */ + public boolean validateNotNull() { + if (object == null) { + setResult(ValidationStatus.INVALID, "is null"); + return false; + + } else { + return true; + } + } + + /** + * Set the validation result status. On a sequence of calls, the most serious + * validation status is recorded, assuming the status enum ordinals increase in order + * of severity. + * + * @param status validation status the bean is receiving + */ + public void setResult(final ValidationStatus status) { + setResult(status, ITEM_HAS_STATUS_MESSAGE + status.toString()); + } + + /** + * Set the validation result status. On a sequence of calls, the most serious + * validation status is recorded, assuming the status enum ordinals increase in order + * of severity. + * + * @param status the validation status + * @param message the validation message explaining the validation status + */ + @Override + public void setResult(final ValidationStatus status, final String message) { + if (this.status.ordinal() < status.ordinal()) { + this.status = status; + this.message = message; + } + } +} diff --git a/common-parameters/src/test/java/org/onap/policy/common/parameters/TestBeanValidationResult.java b/common-parameters/src/test/java/org/onap/policy/common/parameters/TestBeanValidationResult.java new file mode 100644 index 00000000..30e2c0da --- /dev/null +++ b/common-parameters/src/test/java/org/onap/policy/common/parameters/TestBeanValidationResult.java @@ -0,0 +1,155 @@ +/* + * ============LICENSE_START======================================================= + * ONAP + * ================================================================================ + * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * 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. + * ============LICENSE_END========================================================= + */ + +package org.onap.policy.common.parameters; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertNull; +import static org.junit.Assert.assertTrue; + +import java.util.Arrays; +import java.util.List; +import org.junit.Before; +import org.junit.Test; + +public class TestBeanValidationResult { + private static final String MY_LIST = "my-list"; + private static final String OBJECT = "an object"; + private static final String INITIAL_INDENT = "xx "; + private static final String NEXT_INDENT = "yy "; + private static final String MID_INDENT = "xx yy "; + private static final String NAME = "my-name"; + private static final String BEAN_INVALID_MSG = requote("'my-name' INVALID, item has status INVALID\n"); + + private String cleanMsg; + private String invalidMsg; + + private BeanValidationResult bean; + private ObjectValidationResult clean; + private ObjectValidationResult invalid; + + /** + * Sets up. + */ + @Before + public void setUp() { + clean = new ObjectValidationResult("abc", 10); + cleanMsg = clean.getResult("", "", true); + + invalid = new ObjectValidationResult("def", 20); + invalid.setResult(ValidationStatus.INVALID, "invalid"); + invalidMsg = invalid.getResult(); + + bean = new BeanValidationResult(NAME, OBJECT); + } + + @Test + public void testBeanValidationResult() { + assertTrue(bean.isValid()); + assertNull(bean.getResult()); + } + + @Test + public void testAddResult_testGetResult() { + // null should be ok + assertTrue(bean.addResult(null)); + + assertTrue(bean.addResult(clean)); + assertTrue(bean.isValid()); + assertNull(bean.getResult()); + + assertFalse(bean.addResult(invalid)); + assertFalse(bean.isValid()); + assertEquals(BEAN_INVALID_MSG + " " + invalidMsg, bean.getResult()); + + assertEquals(INITIAL_INDENT + BEAN_INVALID_MSG + MID_INDENT + cleanMsg + MID_INDENT + invalidMsg, + bean.getResult(INITIAL_INDENT, NEXT_INDENT, true)); + } + + @Test + public void testValidateNotNull() { + assertTrue(bean.validateNotNull("sub-name", "sub-object")); + assertTrue(bean.isValid()); + assertNull(bean.getResult()); + + assertFalse(bean.validateNotNull("sub-name", null)); + assertFalse(bean.isValid()); + assertEquals(requote(BEAN_INVALID_MSG + " item 'sub-name' value 'null' INVALID, is null\n"), bean.getResult()); + } + + @Test + public void testValidateNotNullList() { + List<ValidationResult> list = Arrays.asList(clean); + assertTrue(bean.validateNotNullList(MY_LIST, list, item -> item)); + assertTrue(bean.isValid()); + assertNull(bean.getResult()); + + list = Arrays.asList(invalid, invalid); + assertFalse(bean.validateNotNullList(MY_LIST, list, item -> item)); + assertFalse(bean.isValid()); + assertEquals(requote(BEAN_INVALID_MSG + " 'my-list' INVALID, item has status INVALID\n " + invalidMsg + + " " + invalidMsg), bean.getResult()); + } + + @Test + public void testValidateNotNullList_NullList() { + List<ValidationResult> list = null; + assertFalse(bean.validateNotNullList("my-list", list, item -> item)); + assertFalse(bean.isValid()); + assertEquals(requote(BEAN_INVALID_MSG + " item 'my-list' value 'null' INVALID, is null\n"), bean.getResult()); + + } + + @Test + public void testValidateList() { + List<ValidationResult> list = null; + bean = new BeanValidationResult(NAME, OBJECT); + assertTrue(bean.validateList(MY_LIST, list, item -> item)); + assertTrue(bean.isValid()); + assertNull(bean.getResult()); + + list = Arrays.asList(clean); + bean = new BeanValidationResult(NAME, OBJECT); + assertTrue(bean.validateList(MY_LIST, list, item -> item)); + assertTrue(bean.isValid()); + assertNull(bean.getResult()); + + // null item in the list + list = Arrays.asList(clean, null); + bean = new BeanValidationResult(NAME, OBJECT); + assertFalse(bean.validateList(MY_LIST, list, item -> item)); + assertFalse(bean.isValid()); + assertEquals(requote(BEAN_INVALID_MSG + " 'my-list' INVALID, item has status INVALID\n " + + "item 'item' value 'null' INVALID, null\n"), bean.getResult()); + + list = Arrays.asList(invalid, invalid); + bean = new BeanValidationResult(NAME, OBJECT); + assertFalse(bean.validateList(MY_LIST, list, item -> item)); + assertFalse(bean.isValid()); + assertEquals(requote(BEAN_INVALID_MSG + " 'my-list' INVALID, item has status INVALID\n " + invalidMsg + + " " + invalidMsg), bean.getResult()); + + } + + private static String requote(String text) { + return text.replace('\'', '"'); + } +} diff --git a/common-parameters/src/test/java/org/onap/policy/common/parameters/TestObjectValidationResult.java b/common-parameters/src/test/java/org/onap/policy/common/parameters/TestObjectValidationResult.java new file mode 100644 index 00000000..5fd7d892 --- /dev/null +++ b/common-parameters/src/test/java/org/onap/policy/common/parameters/TestObjectValidationResult.java @@ -0,0 +1,73 @@ +/* + * ============LICENSE_START======================================================= + * ONAP + * ================================================================================ + * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * 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. + * ============LICENSE_END========================================================= + */ + +package org.onap.policy.common.parameters; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertNull; +import static org.junit.Assert.assertTrue; + +import org.junit.Test; + +public class TestObjectValidationResult { + private static final String NAME = "my-name"; + private static final Object OBJECT = "my-object"; + + private ObjectValidationResult result; + + @Test + public void testValidationResultImplStringObjectValidationStatusString() { + result = new ObjectValidationResult(NAME, OBJECT, ValidationStatus.INVALID, "invalid data"); + assertEquals(NAME, result.getName()); + assertEquals(OBJECT, result.getObject()); + assertEquals(ValidationStatus.INVALID, result.getStatus()); + assertEquals("invalid data", result.getMessage()); + } + + @Test + public void testGetResult() { + result = new ObjectValidationResult(NAME, OBJECT); + assertEquals(ValidationStatus.CLEAN, result.getStatus()); + assertNull(result.getResult()); + assertEquals(requote("xxx item 'my-name' value 'my-object' CLEAN, item has status CLEAN\n"), + result.getResult("xxx ", "yyy", true)); + + result.setResult(ValidationStatus.WARNING, "a warning"); + assertEquals(ValidationStatus.WARNING, result.getStatus()); + + // should not override warning + result.setResult(ValidationStatus.OBSERVATION, "an observation"); + assertEquals(ValidationStatus.WARNING, result.getStatus()); + + assertTrue(result.isValid()); + assertEquals(requote("item 'my-name' value 'my-object' WARNING, a warning\n"), result.getResult()); + + result.setResult(ValidationStatus.INVALID, "is invalid"); + assertEquals(ValidationStatus.INVALID, result.getStatus()); + + assertFalse(result.isValid()); + assertEquals(requote("item 'my-name' value 'my-object' INVALID, is invalid\n"), result.getResult()); + } + + private String requote(String text) { + return text.replace('\'', '"'); + } +} diff --git a/common-parameters/src/test/java/org/onap/policy/common/parameters/TestValidationResultImpl.java b/common-parameters/src/test/java/org/onap/policy/common/parameters/TestValidationResultImpl.java new file mode 100644 index 00000000..da6107cf --- /dev/null +++ b/common-parameters/src/test/java/org/onap/policy/common/parameters/TestValidationResultImpl.java @@ -0,0 +1,122 @@ +/* + * ============LICENSE_START======================================================= + * ONAP + * ================================================================================ + * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * 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. + * ============LICENSE_END========================================================= + */ + +package org.onap.policy.common.parameters; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertNull; +import static org.junit.Assert.assertTrue; + +import org.junit.Before; +import org.junit.Test; + +public class TestValidationResultImpl { + private static final String NAME = "my-name"; + private static final Object OBJECT = "my-object"; + + private MyResult result; + + @Before + public void setUp() { + result = new MyResult(NAME, OBJECT); + } + + @Test + public void testValidationResultImplStringObjectValidationStatusString() { + result = new MyResult(NAME, OBJECT, ValidationStatus.INVALID, "invalid data"); + assertEquals(NAME, result.getName()); + assertEquals(OBJECT, result.getObject()); + assertEquals(ValidationStatus.INVALID, result.getStatus()); + assertEquals("invalid data", result.getMessage()); + } + + @Test + public void testValidateNotNull() { + assertTrue(result.validateNotNull()); + assertTrue(result.isValid()); + assertNull(result.getResult()); + + // now try with null + result = new MyResult(NAME, null); + assertFalse(result.validateNotNull()); + assertFalse(result.isValid()); + assertEquals("INVALID is null", result.getResult()); + } + + @Test + public void testSetResultValidationStatus() { + result.setResult(ValidationStatus.WARNING); + assertEquals(ValidationStatus.WARNING, result.getStatus()); + + // should not override warning + result.setResult(ValidationStatus.OBSERVATION); + assertEquals(ValidationStatus.WARNING, result.getStatus()); + + assertTrue(result.isValid()); + assertEquals("WARNING item has status WARNING", result.getResult()); + } + + @Test + public void testSetResult_testGetResult_testGetStatus() { + assertEquals(ValidationStatus.CLEAN, result.getStatus()); + assertEquals("CLEAN item has status CLEAN", result.getResult("xxx ", "yyy", true)); + + result.setResult(ValidationStatus.WARNING, "a warning"); + assertEquals(ValidationStatus.WARNING, result.getStatus()); + + // should not override warning + result.setResult(ValidationStatus.OBSERVATION, "an observation"); + assertEquals(ValidationStatus.WARNING, result.getStatus()); + + assertTrue(result.isValid()); + assertEquals("WARNING a warning", result.getResult()); + + result.setResult(ValidationStatus.INVALID, "is invalid"); + assertEquals(ValidationStatus.INVALID, result.getStatus()); + + assertFalse(result.isValid()); + assertEquals("INVALID is invalid", result.getResult()); + } + + @Test + public void testGetName() { + assertEquals(NAME, result.getName()); + } + + private static class MyResult extends ValidationResultImpl { + public MyResult(String name, Object object) { + super(name, object); + } + + public MyResult(String name, Object object, ValidationStatus status, String message) { + super(name, object, status, message); + } + + @Override + public String getResult(String initialIndentation, String subIndentation, boolean showClean) { + if (!showClean && getStatus() == ValidationStatus.CLEAN) { + return null; + } + + return (getStatus() + " " + getMessage()); + } + } +} |