Add ValidationResult for arbitrary beans

Added implementations of ValidationResult for arbitrary objects and
for beans (i.e., containers of arbitrary objects).

Change-Id: I4c6f35bd19f1386062ce19125cbc648c399cc331
Issue-ID: POLICY-1542
Signed-off-by: Jim Hahn <jrh3@att.com>

3 files changed, 350 insertions, 0 deletions

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());
+        }
+    }
+}