Custom queries for PRH

Change-Id: Ie795c5951b63c138f1898bdfc16509233febf7ec
Issue-ID: DCAEGEN2-1604
Signed-off-by: kurczews <krzysztof.kurczewski@nokia.com>

10 files changed, 351 insertions, 1 deletions

diff --git a/prh-commons/pom.xml b/prh-commons/pom.xml
index fb8e8978..02136961 100644
--- a/prh-commons/pom.xml
+++ b/prh-commons/pom.xml
@@ -38,6 +38,10 @@
       <groupId>org.onap.dcaegen2.services.sdk.rest.services</groupId>
       <artifactId>common-dependency</artifactId>
     </dependency>
+    <dependency>
+      <groupId>org.onap.dcaegen2.services.sdk.rest.services</groupId>
+      <artifactId>aai-client</artifactId>
+    </dependency>
 
     <dependency>
       <groupId>org.slf4j</groupId>
diff --git a/prh-commons/src/main/java/org/onap/dcaegen2/services/prh/model/queries/NamedNode.java b/prh-commons/src/main/java/org/onap/dcaegen2/services/prh/model/queries/NamedNode.java
new file mode 100644
index 00000000..6329e7e0
--- /dev/null
+++ b/prh-commons/src/main/java/org/onap/dcaegen2/services/prh/model/queries/NamedNode.java
@@ -0,0 +1,34 @@
+/*
+ * ============LICENSE_START=======================================================
+ * PNF-REGISTRATION-HANDLER
+ * ================================================================================
+ * Copyright (C) 2019 NOKIA 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.dcaegen2.services.prh.model.queries;
+
+import java.util.Map;
+import org.immutables.value.Value;
+
+/**
+ * @see NamedNodeAdapter
+ * @see NamedNodes
+ */
+@Value.Immutable
+public interface NamedNode {
+    String name();
+    Map<String, Object> properties();
+}
\ No newline at end of file
diff --git a/prh-commons/src/main/java/org/onap/dcaegen2/services/prh/model/queries/NamedNodeAdapter.java b/prh-commons/src/main/java/org/onap/dcaegen2/services/prh/model/queries/NamedNodeAdapter.java
new file mode 100644
index 00000000..be6c8d5b
--- /dev/null
+++ b/prh-commons/src/main/java/org/onap/dcaegen2/services/prh/model/queries/NamedNodeAdapter.java
@@ -0,0 +1,71 @@
+/*
+ * ============LICENSE_START=======================================================
+ * PNF-REGISTRATION-HANDLER
+ * ================================================================================
+ * Copyright (C) 2019 NOKIA 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.dcaegen2.services.prh.model.queries;
+
+import com.google.gson.TypeAdapter;
+import com.google.gson.stream.JsonReader;
+import com.google.gson.stream.JsonWriter;
+import java.io.IOException;
+import org.onap.dcaegen2.services.prh.model.queries.ImmutableNamedNode.Builder;
+
+/**
+ * @see NamedNode
+ * @see <a href="https://docs.onap.org/en/dublin/submodules/aai/aai-common.git/docs/AAI%20REST%20API%20Documentation/customQueries.html">AAI
+ *  Custom queries</a></a>
+ */
+public class NamedNodeAdapter extends TypeAdapter<NamedNode> {
+
+    @Override
+    public void write(JsonWriter jsonWriter, NamedNode namedNode) {
+        throw new UnsupportedOperationException("This model is read only!");
+    }
+
+    @Override
+    public NamedNode read(JsonReader jsonReader) throws IOException {
+        jsonReader.beginObject();
+        Builder nodeBuilder = ImmutableNamedNode.builder().name(jsonReader.nextName());
+        readProperties(jsonReader, nodeBuilder);
+        jsonReader.endObject();
+
+        return nodeBuilder.build();
+    }
+
+    private void readProperties(JsonReader jsonReader, Builder nodeBuilder) throws IOException {
+        jsonReader.beginObject();
+        while (jsonReader.hasNext()) {
+            String key = jsonReader.nextName();
+            switch (jsonReader.peek()) {
+                case STRING:
+                    nodeBuilder.putProperties(key, jsonReader.nextString());
+                    break;
+                case NUMBER:
+                    nodeBuilder.putProperties(key, jsonReader.nextInt());
+                    break;
+                case BOOLEAN:
+                    nodeBuilder.putProperties(key, jsonReader.nextBoolean());
+                    break;
+                default:
+                    jsonReader.skipValue();
+            }
+        }
+        jsonReader.endObject();
+    }
+}
\ No newline at end of file
diff --git a/prh-commons/src/main/java/org/onap/dcaegen2/services/prh/model/queries/NamedNodes.java b/prh-commons/src/main/java/org/onap/dcaegen2/services/prh/model/queries/NamedNodes.java
new file mode 100644
index 00000000..6a463ddf
--- /dev/null
+++ b/prh-commons/src/main/java/org/onap/dcaegen2/services/prh/model/queries/NamedNodes.java
@@ -0,0 +1,40 @@
+/*
+ * ============LICENSE_START=======================================================
+ * PNF-REGISTRATION-HANDLER
+ * ================================================================================
+ * Copyright (C) 2019 NOKIA 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.dcaegen2.services.prh.model.queries;
+
+import com.google.gson.annotations.SerializedName;
+import java.util.List;
+import org.immutables.gson.Gson;
+import org.immutables.value.Value;
+
+/**
+ * @see NamedNode
+ * @see PnfQuery
+ * @see <a href="https://docs.onap.org/en/dublin/submodules/aai/aai-common.git/docs/AAI%20REST%20API%20Documentation/customQueries.html">AAI
+ * Custom queries</a></a>
+ */
+@Value.Immutable
+@Gson.TypeAdapters(fieldNamingStrategy = true)
+public interface NamedNodes {
+
+    @SerializedName(value = "results")
+    List<NamedNode> results();
+}
\ No newline at end of file
diff --git a/prh-commons/src/main/java/org/onap/dcaegen2/services/prh/model/queries/PnfQuery.java b/prh-commons/src/main/java/org/onap/dcaegen2/services/prh/model/queries/PnfQuery.java
new file mode 100644
index 00000000..7a9025aa
--- /dev/null
+++ b/prh-commons/src/main/java/org/onap/dcaegen2/services/prh/model/queries/PnfQuery.java
@@ -0,0 +1,54 @@
+/*
+ * ============LICENSE_START=======================================================
+ * PNF-REGISTRATION-HANDLER
+ * ================================================================================
+ * Copyright (C) 2019 NOKIA 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.dcaegen2.services.prh.model.queries;
+
+import static java.util.Arrays.asList;
+import static org.onap.dcaegen2.services.sdk.rest.services.adapters.http.HttpMethod.PUT;
+
+import com.google.gson.annotations.SerializedName;
+import java.util.List;
+import org.onap.dcaegen2.services.sdk.rest.services.aai.client.service.http.Request;
+import org.onap.dcaegen2.services.sdk.rest.services.adapters.http.HttpMethod;
+
+/**
+ * @see NamedNodes
+ * @see <a href="https://docs.onap.org/en/dublin/submodules/aai/aai-common.git/docs/AAI%20REST%20API%20Documentation/customQueries.html">AAI
+ * Custom queries</a></a>
+ */
+public class PnfQuery implements Request {
+
+    @SerializedName("start")
+    private final List<String> startNodes;
+
+    public PnfQuery(String pnfName) {
+        this.startNodes = asList("/nodes/pnfs/pnf/" + pnfName);
+    }
+
+    @Override
+    public HttpMethod method() {
+        return PUT;
+    }
+
+    @Override
+    public String uri() {
+        return "/query?format=resource&subgraph=star&nodesOnly=true";
+    }
+}
\ No newline at end of file
diff --git a/prh-commons/src/main/java/org/onap/dcaegen2/services/prh/model/utils/PrhModelAwareGsonBuilder.java b/prh-commons/src/main/java/org/onap/dcaegen2/services/prh/model/utils/PrhModelAwareGsonBuilder.java
index 1974f6da..e01711a7 100644
--- a/prh-commons/src/main/java/org/onap/dcaegen2/services/prh/model/utils/PrhModelAwareGsonBuilder.java
+++ b/prh-commons/src/main/java/org/onap/dcaegen2/services/prh/model/utils/PrhModelAwareGsonBuilder.java
@@ -23,8 +23,9 @@ package org.onap.dcaegen2.services.prh.model.utils;
 import com.google.gson.Gson;
 import com.google.gson.GsonBuilder;
 import com.google.gson.TypeAdapterFactory;
-
 import java.util.ServiceLoader;
+import org.onap.dcaegen2.services.prh.model.queries.NamedNode;
+import org.onap.dcaegen2.services.prh.model.queries.NamedNodeAdapter;
 
 public final class PrhModelAwareGsonBuilder {
 
@@ -34,6 +35,7 @@ public final class PrhModelAwareGsonBuilder {
     public static Gson createGson() {
         GsonBuilder gsonBuilder = new GsonBuilder();
         TYPE_ADAPTER_FACTORIES.forEach(gsonBuilder::registerTypeAdapterFactory);
+        gsonBuilder.registerTypeAdapter(NamedNode.class, new NamedNodeAdapter());
         return gsonBuilder.create();
     }
 }
diff --git a/prh-commons/src/test/java/org/onap/dcaegen2/services/prh/model/queries/NamedNodesTest.java b/prh-commons/src/test/java/org/onap/dcaegen2/services/prh/model/queries/NamedNodesTest.java
new file mode 100644
index 00000000..0991d31f
--- /dev/null
+++ b/prh-commons/src/test/java/org/onap/dcaegen2/services/prh/model/queries/NamedNodesTest.java
@@ -0,0 +1,58 @@
+/*
+ * ============LICENSE_START=======================================================
+ * PNF-REGISTRATION-HANDLER
+ * ================================================================================
+ * Copyright (C) 2019 NOKIA 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.dcaegen2.services.prh.model.queries;
+
+import static java.util.Objects.requireNonNull;
+import static org.assertj.core.api.Assertions.assertThat;
+
+import com.google.gson.Gson;
+import java.io.InputStreamReader;
+import org.junit.jupiter.api.Test;
+import org.onap.dcaegen2.services.prh.model.utils.PrhModelAwareGsonBuilder;
+
+class NamedNodesTest {
+
+    @Test
+    void shouldParseJsonToNamedNodes() {
+        // given
+        InputStreamReader inputStream = getJsonFromFile("pnf_query_response.json");
+        Gson gson = PrhModelAwareGsonBuilder.createGson();
+
+        // when
+        NamedNodes nodes = gson.fromJson(inputStream, NamedNodes.class);
+
+        // then
+        assertThat(nodes.results().size()).isEqualTo(3);
+        assertThat(nodes.results().get(0))
+            .matches(node -> "pnf".equals(node.name()))
+            .matches(node -> node.properties().get("pnf-name").equals("foo"));
+        assertThat(nodes.results().get(1))
+            .matches(node -> "logical-link".equals(node.name()))
+            .matches(node -> node.properties().get("link-name").equals("bar"));
+        assertThat(nodes.results().get(2))
+            .matches(node -> "service-instance".equals(node.name()))
+            .matches(node -> node.properties().get("service-instance-name").equals("baz"));
+    }
+
+    private InputStreamReader getJsonFromFile(String file) {
+        return new InputStreamReader(requireNonNull(getClass().getClassLoader().getResourceAsStream(file)));
+    }
+}
diff --git a/prh-commons/src/test/java/org/onap/dcaegen2/services/prh/model/queries/PnfQueryTest.java b/prh-commons/src/test/java/org/onap/dcaegen2/services/prh/model/queries/PnfQueryTest.java
new file mode 100644
index 00000000..0ab0b17b
--- /dev/null
+++ b/prh-commons/src/test/java/org/onap/dcaegen2/services/prh/model/queries/PnfQueryTest.java
@@ -0,0 +1,55 @@
+/*
+ * ============LICENSE_START=======================================================
+ * PNF-REGISTRATION-HANDLER
+ * ================================================================================
+ * Copyright (C) 2019 NOKIA 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.dcaegen2.services.prh.model.queries;
+
+import static java.util.Objects.requireNonNull;
+import static java.util.stream.Collectors.joining;
+import static org.assertj.core.api.Assertions.assertThat;
+
+import com.google.gson.Gson;
+import java.io.BufferedReader;
+import java.io.IOException;
+import java.io.InputStreamReader;
+import org.junit.jupiter.api.Test;
+import org.onap.dcaegen2.services.prh.model.utils.PrhModelAwareGsonBuilder;
+
+class PnfQueryTest {
+
+    @Test
+    void shouldParseToCorrectJson() throws IOException {
+        // given
+        PnfQuery pnfQuery = new PnfQuery("foo");
+
+        // when
+        Gson gson = PrhModelAwareGsonBuilder.createGson();
+
+        // then
+        String json = gson.toJson(pnfQuery);
+        assertThat(json).isEqualToIgnoringWhitespace(getJsonFromFile("pnf_query_request.json"));
+    }
+
+    private String getJsonFromFile(String file) throws IOException {
+        try (BufferedReader br = new BufferedReader(new InputStreamReader(
+            requireNonNull(getClass().getClassLoader().getResourceAsStream(file))))) {
+            return br.lines().collect(joining(System.lineSeparator()));
+        }
+    }
+}
\ No newline at end of file
diff --git a/prh-commons/src/test/resources/pnf_query_request.json b/prh-commons/src/test/resources/pnf_query_request.json
new file mode 100644
index 00000000..2a171c76
--- /dev/null
+++ b/prh-commons/src/test/resources/pnf_query_request.json
@@ -0,0 +1,5 @@
+{
+  "start": [
+    "/nodes/pnfs/pnf/foo"
+  ]
+}
\ No newline at end of file
diff --git a/prh-commons/src/test/resources/pnf_query_response.json b/prh-commons/src/test/resources/pnf_query_response.json
new file mode 100644
index 00000000..f74b37a6
--- /dev/null
+++ b/prh-commons/src/test/resources/pnf_query_response.json
@@ -0,0 +1,27 @@
+{
+  "results": [
+    {
+      "pnf": {
+        "pnf-name": "foo",
+        "in-maint": false,
+        "resource-version": "1559732370039"
+      }
+    },
+    {
+      "logical-link": {
+        "link-name": "bar",
+        "in-maint": false,
+        "link-type": "attachment-point",
+        "resource-version": "1559805666899"
+      }
+    },
+    {
+      "service-instance": {
+        "service-instance-id": "pnf-service-id",
+        "service-instance-name": "baz",
+        "resource-version": "1559732385933",
+        "orchestration-status": "ACTIVE"
+      }
+    }
+  ]
+}
\ No newline at end of file