Add module for error responses

Module will hold a common error message object used by
API's to clients for returning an overall error message
and list of detail messages and warnings.

Added an example and finished a JUnit test.

Changed to response code from HTTP

Added assertj and used StandardCoder

Issue-ID: POLICY-1195
Change-Id: Id0fcf4831b8d03223c590f8085f207dbbbe559b4
Signed-off-by: Pamela Dragosh <pdragosh@research.att.com>

diff --git a/models-errors/pom.xml b/models-errors/pom.xml
new file mode 100644 (file)
index 0000000..ab99853
--- /dev/null
+++ b/models-errors/pom.xml
@@ -0,0 +1,41 @@
+<!--
+  ============LICENSE_START=======================================================
+   Copyright (C) 2019 Nordix Foundation.
+  ================================================================================
+  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=========================================================
+-->
+
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <parent>
+        <groupId>org.onap.policy.models</groupId>
+        <artifactId>policy-models</artifactId>
+        <version>2.0.0-SNAPSHOT</version>
+    </parent>
+
+    <artifactId>models-errors</artifactId>
+
+    <name>${project.artifactId}</name>
+    <description>The models for Policy API's to return Error/warning message details.</description>
+    <dependencies>
+        <dependency>
+            <groupId>org.onap.policy.common</groupId>
+            <artifactId>gson</artifactId>
+            <version>${policy.common.version}</version>
+        </dependency>
+    </dependencies>
+</project>

diff --git a/models-errors/src/main/java/org/onap/policy/models/errors/concepts/ErrorResponse.java b/models-errors/src/main/java/org/onap/policy/models/errors/concepts/ErrorResponse.java
new file mode 100644 (file)
index 0000000..b072ba1
--- /dev/null
+++ b/models-errors/src/main/java/org/onap/policy/models/errors/concepts/ErrorResponse.java
@@ -0,0 +1,50 @@
+/*
+ * ============LICENSE_START=======================================================
+ * ONAP Policy Decision Models
+ * ================================================================================
+ * 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.models.errors.concepts;
+
+import com.google.gson.annotations.SerializedName;
+
+import java.util.List;
+
+import javax.ws.rs.core.Response;
+
+import lombok.Data;
+
+/**
+ * This class is for defining a common error/warning
+ * response from API calls in the Policy Framework.
+ *
+ * @author pameladragosh
+ *
+ */
+@Data
+public class ErrorResponse {
+
+    @SerializedName("code")
+    private Response.Status  responseCode;
+    @SerializedName("error")
+    private String  errorMessage;
+    @SerializedName("details")
+    private List<String>    errorDetails;
+    @SerializedName("warnings")
+    private List<String>    warningDetails;
+
+}

diff --git a/models-errors/src/test/java/org/onap/policy/models/errors/concepts/ErrorResponseTest.java b/models-errors/src/test/java/org/onap/policy/models/errors/concepts/ErrorResponseTest.java
new file mode 100644 (file)
index 0000000..ff2baa9
--- /dev/null
+++ b/models-errors/src/test/java/org/onap/policy/models/errors/concepts/ErrorResponseTest.java
@@ -0,0 +1,62 @@
+/*
+ * ============LICENSE_START=======================================================
+ * ONAP Policy Decision Models
+ * ================================================================================
+ * 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.models.errors.concepts;
+
+import static org.assertj.core.api.Assertions.assertThatCode;
+import static org.junit.Assert.assertEquals;
+
+import java.util.Arrays;
+
+import javax.ws.rs.core.Response;
+
+import org.junit.Test;
+import org.onap.policy.common.utils.coder.StandardCoder;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class ErrorResponseTest {
+
+    public static final Logger logger = LoggerFactory.getLogger(ErrorResponseTest.class);
+
+    @Test
+    public void test() {
+        assertThatCode(() -> {
+            ErrorResponse error = new ErrorResponse();
+
+            error.setResponseCode(Response.Status.NOT_ACCEPTABLE);
+            error.setErrorMessage("Missing metadata section");
+
+            error.setErrorDetails(Arrays.asList("You must have a metadata section with policy-id value"));
+
+            error.setWarningDetails(Arrays.asList("Please make sure topology template field is included."));
+
+            StandardCoder coder = new StandardCoder();
+            String jsonOutput = coder.encode(error);
+
+            logger.debug("Resulting json output {}", jsonOutput);
+
+            ErrorResponse deserializedResponse = coder.decode(jsonOutput, ErrorResponse.class);
+
+            assertEquals(deserializedResponse, error);
+        }).doesNotThrowAnyException();
+    }
+
+}

diff --git a/models-errors/src/test/java/org/onap/policy/models/errors/concepts/TestModels.java b/models-errors/src/test/java/org/onap/policy/models/errors/concepts/TestModels.java
new file mode 100644 (file)
index 0000000..03dd8e6
--- /dev/null
+++ b/models-errors/src/test/java/org/onap/policy/models/errors/concepts/TestModels.java
@@ -0,0 +1,42 @@
+/*
+ * ============LICENSE_START=======================================================
+ * ONAP Policy Decision Models
+ * ================================================================================
+ * 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.models.errors.concepts;
+
+import com.openpojo.reflection.filters.FilterPackageInfo;
+import com.openpojo.validation.Validator;
+import com.openpojo.validation.ValidatorBuilder;
+import com.openpojo.validation.test.impl.GetterTester;
+import com.openpojo.validation.test.impl.SetterTester;
+
+import org.junit.Test;
+import org.onap.policy.common.utils.validation.ToStringTester;
+
+public class TestModels {
+
+    @Test
+    public void testDecisionModels() {
+        final Validator validator = ValidatorBuilder.create().with(new ToStringTester()).with(new SetterTester())
+                .with(new GetterTester()).build();
+        validator.validate(TestModels.class.getPackage().getName(), new FilterPackageInfo());
+    }
+
+
+}

diff --git a/models-errors/src/test/resources/error.response.simple.json b/models-errors/src/test/resources/error.response.simple.json
new file mode 100644 (file)
index 0000000..d9420c0
--- /dev/null
+++ b/models-errors/src/test/resources/error.response.simple.json
@@ -0,0 +1,11 @@
+{
+    "code" : "404",
+    "error" : "Policy Type does not exist",
+    "details" : [
+        "Missing metadata section",
+        "The property value foo bar is missing"   
+    ],
+    "warnings" : [
+        "The topology_template is missing"
+    ]
+}

diff --git a/pom.xml b/pom.xml
index 8d80849..9694746 100644 (file)
--- a/pom.xml
+++ b/pom.xml
@@ -56,6 +56,7 @@
         <module>models-dao</module>
         <module>models-tosca</module>
         <module>models-pap</module>
+        <module>models-errors</module>
         <module>models-decisions</module>
         <module>models-provider</module>
         <module>models-examples</module>
@@ -117,6 +118,12 @@
             <scope>test</scope>
         </dependency>
 
+        <dependency>
+            <groupId>org.assertj</groupId>
+            <artifactId>assertj-core</artifactId>
+            <scope>test</scope>
+        </dependency>
+
         <dependency>
             <groupId>org.eclipse.persistence</groupId>
             <artifactId>eclipselink</artifactId>