2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved.
6 * ================================================================================
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 * ============LICENSE_END=========================================================
20 package org.onap.aai.serialization.engines.query;
22 import com.jayway.jsonpath.JsonPath;
23 import org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversalSource;
24 import org.apache.tinkerpop.gremlin.process.traversal.step.util.Tree;
25 import org.apache.tinkerpop.gremlin.structure.*;
26 import org.apache.tinkerpop.gremlin.tinkergraph.structure.TinkerGraph;
27 import org.junit.Test;
28 import org.onap.aai.AAISetup;
29 import org.onap.aai.edges.exceptions.AmbiguousRuleChoiceException;
30 import org.onap.aai.edges.exceptions.EdgeRuleNotFoundException;
31 import org.onap.aai.exceptions.AAIException;
32 import org.onap.aai.introspection.Loader;
33 import org.onap.aai.introspection.ModelType;
34 import org.onap.aai.serialization.db.EdgeSerializer;
35 import org.springframework.beans.factory.annotation.Autowired;
36 import org.springframework.test.annotation.DirtiesContext;
38 import java.io.InputStream;
41 import static org.hamcrest.CoreMatchers.is;
42 import static org.hamcrest.collection.IsIterableContainingInAnyOrder.containsInAnyOrder;
43 import static org.junit.Assert.assertThat;
44 import static org.junit.Assert.assertTrue;
45 import static org.onap.aai.edges.enums.EdgeField.CONTAINS;
47 @DirtiesContext(classMode = DirtiesContext.ClassMode.BEFORE_CLASS)
48 public class GraphTraversalQueryEngineTest extends AAISetup {
51 EdgeSerializer edgeSer;
54 public void testFindParents() throws AAIException {
56 Graph graph = TinkerGraph.open();
58 Vertex cloudreg = graph.addVertex(T.id, "00", "aai-node-type", "cloud-region");
59 Vertex tenant = graph.addVertex(T.id, "10", "aai-node-type", "tenant");
60 Vertex vserver = graph.addVertex(T.id, "20", "aai-node-type", "vserver");
62 GraphTraversalSource g = graph.traversal();
64 edgeSer.addTreeEdge(g, cloudreg, tenant);
65 edgeSer.addTreeEdge(g, tenant, vserver);
67 //expect start vertex back plus any parents
68 List<Vertex> crExpected = new ArrayList<>(Arrays.asList(cloudreg)); //no parents
69 List<Vertex> tenExpected = new ArrayList<>(Arrays.asList(tenant, cloudreg)); //only has the immediate parent
70 List<Vertex> vsExpected = new ArrayList<>(Arrays.asList(vserver, tenant, cloudreg)); //parent & grandparent
72 GraphTraversalQueryEngine engine = new GraphTraversalQueryEngine(g);
75 List<Vertex> crRes = engine.findParents(cloudreg);
76 assertTrue(crRes.containsAll(crExpected) && crExpected.containsAll(crRes));
78 List<Vertex> tenRes = engine.findParents(tenant);
79 assertTrue(tenRes.containsAll(tenExpected) && tenExpected.containsAll(tenRes));
81 List<Vertex> vsRes = engine.findParents(vserver);
82 assertTrue(vsRes.containsAll(vsExpected) && vsExpected.containsAll(vsRes));
83 //verify expected ordering - start, parent, grandparent
84 assertTrue(vsRes.get(0).equals(vserver));
85 assertTrue(vsRes.get(1).equals(tenant));
86 assertTrue(vsRes.get(2).equals(cloudreg));
90 public void testFindAllParentsGivenAaiUris(){
93 Graph graph = TinkerGraph.open();
95 Vertex cloudreg = graph.addVertex(T.id, "00", "aai-node-type", "cloud-region", "aai-uri", "/cloud-infrastructure/cloud-regions/cloud-region/testowner/testid");
96 Vertex tenant = graph.addVertex(T.id, "10", "aai-node-type", "tenant", "aai-uri", "/cloud-infrastructure/cloud-regions/cloud-region/testowner/testid/tenants/tenant/testTenant1");
97 Vertex vserver = graph.addVertex(T.id, "20", "aai-node-type", "vserver", "aai-uri", "/cloud-infrastructure/cloud-regions/cloud-region/testowner/testid/tenants/tenant/testTenant1/vservers/vserver/testVserver1");
99 String [] uris = new String[]{
100 "/cloud-infrastructure/cloud-regions/cloud-region/testowner/testid/tenants/tenant/testTenant1",
101 "/cloud-infrastructure/cloud-regions/cloud-region/testowner/testid/tenants/tenant/testTenant1/vservers/vserver/testVserver1",
102 "/cloud-infrastructure/cloud-regions/cloud-region/testowner/testid"
105 GraphTraversalSource g = graph.traversal();
106 GraphTraversalQueryEngine queryEngine = new GraphTraversalQueryEngine(g);
107 List<Vertex> vertices = queryEngine.findParents(uris);
109 assertThat("Returned vertices should be 3 cloud region, tenant and vserver", vertices.size(), is(3));
110 assertThat("Expected the first element back to be vserver", vertices.get(0), is(vserver));
111 assertThat("Expected the second element back to be tenant", vertices.get(1), is(tenant));
112 assertThat("Expected the element back to be cloud region", vertices.get(2), is(cloudreg));
116 public void testFindAllChildren() throws AAIException {
118 Graph graph = TinkerGraph.open();
120 Vertex cloudreg = graph.addVertex(T.id, "00", "aai-node-type", "cloud-region");
121 Vertex tenant = graph.addVertex(T.id, "10", "aai-node-type", "tenant");
122 Vertex vserver = graph.addVertex(T.id, "20", "aai-node-type", "vserver");
123 Vertex vserver2 = graph.addVertex(T.id, "21", "aai-node-type", "vserver");
124 Vertex oam = graph.addVertex(T.id, "30", "aai-node-type", "oam-network");
126 GraphTraversalSource g = graph.traversal();
128 edgeSer.addTreeEdge(g, cloudreg, tenant);
129 edgeSer.addTreeEdge(g, tenant, vserver);
130 edgeSer.addTreeEdge(g, tenant, vserver2);
131 edgeSer.addTreeEdge(g, cloudreg, oam);
133 List<Vertex> crExpected = new ArrayList<>(Arrays.asList(cloudreg, tenant, vserver, vserver2, oam));
134 List<Vertex> vsExpected = new ArrayList<>(Arrays.asList(vserver));
136 GraphTraversalQueryEngine engine = new GraphTraversalQueryEngine(g);
139 List<Vertex> crRes = engine.findAllChildren(cloudreg);
140 assertTrue(crRes.containsAll(crExpected) && crExpected.containsAll(crRes));
142 List<Vertex> vsRes = engine.findAllChildren(vserver);
143 assertTrue(vsRes.containsAll(vsExpected) && vsExpected.containsAll(vsRes));
147 public void testFindChildrenOfType() throws AAIException {
149 Graph graph = TinkerGraph.open();
151 Vertex gv = graph.addVertex(T.id, "00", "aai-node-type", "generic-vnf");
152 Vertex lint1 = graph.addVertex(T.id, "10", "aai-node-type", "l-interface");
153 Vertex lint2 = graph.addVertex(T.id, "11", "aai-node-type", "l-interface");
154 Vertex lag = graph.addVertex(T.id, "20", "aai-node-type", "lag-interface");
155 Vertex lint3 = graph.addVertex(T.id, "12", "aai-node-type", "l-interface");
157 GraphTraversalSource g = graph.traversal();
159 edgeSer.addTreeEdge(g, gv, lint1);
160 edgeSer.addTreeEdge(g, gv, lint2);
161 edgeSer.addTreeEdge(g, gv, lag);
162 edgeSer.addTreeEdge(g, lag, lint3);
164 List<Vertex> expected = new ArrayList<>(Arrays.asList(lint1, lint2));
166 GraphTraversalQueryEngine engine = new GraphTraversalQueryEngine(g);
169 List<Vertex> results = engine.findChildrenOfType(gv, "l-interface");
170 assertTrue(results.containsAll(expected) && expected.containsAll(results));
174 public void testFindChildren() throws AAIException {
176 Graph graph = TinkerGraph.open();
178 Vertex gv = graph.addVertex(T.id, "00", "aai-node-type", "generic-vnf");
179 Vertex lint1 = graph.addVertex(T.id, "10", "aai-node-type", "l-interface");
180 Vertex lint2 = graph.addVertex(T.id, "11", "aai-node-type", "l-interface");
181 Vertex lag = graph.addVertex(T.id, "20", "aai-node-type", "lag-interface");
182 Vertex lint3 = graph.addVertex(T.id, "12", "aai-node-type", "l-interface");
184 GraphTraversalSource g = graph.traversal();
186 edgeSer.addTreeEdge(g, gv, lint1);
187 edgeSer.addTreeEdge(g, gv, lint2);
188 edgeSer.addTreeEdge(g, gv, lag);
189 edgeSer.addTreeEdge(g, lag, lint3);
191 List<Vertex> expected = new ArrayList<>(Arrays.asList(lint1, lint2, lag));
193 GraphTraversalQueryEngine engine = new GraphTraversalQueryEngine(g);
196 List<Vertex> results = engine.findChildren(gv);
197 assertTrue(results.containsAll(expected) && expected.containsAll(results));
201 public void testFindRelatedVertices() throws AAIException {
204 Graph graph = TinkerGraph.open();
206 Vertex gv = graph.addVertex(T.id, "00", "aai-node-type", "generic-vnf");
207 Vertex lint = graph.addVertex(T.id, "10", "aai-node-type", "l-interface");
208 Vertex lint2 = graph.addVertex(T.id, "11", "aai-node-type", "l-interface");
209 Vertex log = graph.addVertex(T.id, "20", "aai-node-type", "logical-link");
211 GraphTraversalSource g = graph.traversal();
213 edgeSer.addTreeEdge(g, gv, lint);
214 edgeSer.addEdge(g, lint, log);
215 edgeSer.addEdge(g, log, lint2);
217 List<Vertex> outExpected = new ArrayList<>(Arrays.asList(lint));
218 List<Vertex> inExpected = new ArrayList<>(Arrays.asList(lint, lint2));
219 List<Vertex> bothExpected = new ArrayList<>(Arrays.asList(log));
221 GraphTraversalQueryEngine engine = new GraphTraversalQueryEngine(g);
224 List<Vertex> outRes = engine.findRelatedVertices(gv, Direction.IN, "org.onap.relationships.inventory.BelongsTo", "l-interface");
225 assertTrue(outRes.containsAll(outExpected) && outExpected.containsAll(outRes));
227 List<Vertex> inRes = engine.findRelatedVertices(log, Direction.IN, "tosca.relationships.network.LinksTo", "l-interface");
228 assertTrue(inRes.containsAll(inExpected) && inExpected.containsAll(inRes));
230 List<Vertex> bothRes = engine.findRelatedVertices(lint, Direction.BOTH, "tosca.relationships.network.LinksTo", "logical-link");
231 assertTrue(bothRes.containsAll(bothExpected) && bothExpected.containsAll(bothRes));
235 public void testFindSubGraph() throws AAIException, EdgeRuleNotFoundException, AmbiguousRuleChoiceException {
237 Graph graph = TinkerGraph.open();
239 Vertex cr = graph.addVertex(T.id, "00", "aai-node-type", "cloud-region");
240 Vertex ten = graph.addVertex(T.id, "10", "aai-node-type", "tenant");
241 Vertex ten2 = graph.addVertex(T.id, "11", "aai-node-type", "tenant");
242 Vertex vs = graph.addVertex(T.id, "20", "aai-node-type", "vserver");
243 Vertex vs2 = graph.addVertex(T.id, "21", "aai-node-type", "vserver");
244 Vertex lint = graph.addVertex(T.id, "30", "aai-node-type", "l-interface");
245 Vertex comp = graph.addVertex(T.id, "40", "aai-node-type", "complex");
246 Vertex ctag = graph.addVertex(T.id, "50", "aai-node-type", "ctag-pool");
247 Vertex gv = graph.addVertex(T.id, "60", "aai-node-type", "generic-vnf");
248 Vertex lag = graph.addVertex(T.id, "70", "aai-node-type", "lag-interface");
249 Vertex lint2 = graph.addVertex(T.id, "31", "aai-node-type", "l-interface");
250 Vertex log = graph.addVertex(T.id, "80", "aai-node-type", "logical-link");
251 Vertex vnfc = graph.addVertex(T.id, "90", "aai-node-type", "vnfc");
252 Vertex modelVer = graph.addVertex(T.id, "100", "aai-node-type", "model-ver");
254 GraphTraversalSource g = graph.traversal();
256 Edge crTen = edgeSer.addTreeEdge(g, cr, ten);
257 Edge crTen2 = edgeSer.addTreeEdge(g, cr, ten2);
258 Edge tenVs = edgeSer.addTreeEdge(g, ten, vs);
259 Edge tenVs2 = edgeSer.addTreeEdge(g, ten, vs2);
260 Edge vsLInt = edgeSer.addTreeEdge(g, vs, lint);
261 Edge lintLog = edgeSer.addEdge(g, lint, log);
262 Edge vsGv = edgeSer.addEdge(g, vs, gv);
263 edgeSer.addEdge(g, gv, vnfc);
265 edgeSer.addTreeEdge(g, gv, lag);
266 edgeSer.addTreeEdge(g, lag, lint2);
267 Edge modelVerEdge = edgeSer.addPrivateEdge(g, gv, modelVer, null);
269 edgeSer.addTreeEdge(g, comp, ctag);
270 Edge crComp = edgeSer.addEdge(g, cr, comp);
272 //findSubGraph(cr, 0, true)
273 List<Element> expected1 = new ArrayList<>(Arrays.asList(cr));
274 //findSubGraph(cr, 2, true)
275 List<Element> expected2 = new ArrayList<>(Arrays.asList(cr, ten, ten2, vs, vs2,
276 crTen, crTen2, tenVs, tenVs2));
278 List<Element> expected3 = new ArrayList<>(Arrays.asList(cr, ten, ten2, comp, vs, vs2, lint, gv, log,
279 crTen, crTen2, crComp, tenVs, tenVs2, vsLInt,
282 GraphTraversalQueryEngine engine = new GraphTraversalQueryEngine(g);
285 Tree<Element> res1 = engine.findSubGraph(cr, 0, true);
286 Set<Element> resList1 = treeToList(res1);
287 assertTrue(resList1.containsAll(expected1) && expected1.containsAll(resList1));
289 Tree<Element> res2 = engine.findSubGraph(cr, 2, true);
290 Set<Element> resList2 = treeToList(res2);
291 assertTrue(resList2.containsAll(expected2) && expected2.containsAll(resList2));
293 Tree<Element> res3 = engine.findSubGraph(cr);
294 Set<Element> resList3 = treeToList(res3);
295 assertThat(resList3, containsInAnyOrder(expected3.toArray()));
296 // assertTrue(resList3.containsAll(expected3) && expected3.containsAll(resList3));
300 * convenience helper method to make it easier to check the contents of the tree against
301 * a list of expected results
302 * @param tree - the tree whose contents you want in collection form
303 * @return set of the contents of the tree
305 private Set<Element> treeToList(Tree<Element> tree) {
306 Set<Element> ret = new HashSet<>();
308 for (Element key : tree.keySet()) {
310 ret.addAll(treeToList(tree.get(key)));
317 public void testFindEdgesForVersion() throws AAIException, EdgeRuleNotFoundException, AmbiguousRuleChoiceException {
319 Graph graph = TinkerGraph.open();
321 Vertex gv = graph.addVertex(T.id, "00", "aai-node-type", "generic-vnf");
322 Vertex vnfc = graph.addVertex(T.id, "10", "aai-node-type", "vnfc");
323 Vertex lob = graph.addVertex(T.id, "20", "aai-node-type", "line-of-business");
324 Vertex lint = graph.addVertex(T.id, "30", "aai-node-type", "l-interface");
325 Vertex mv = graph.addVertex(T.id, "40", "aai-node-type", "model-ver");
326 Vertex cr = graph.addVertex(T.id, "50", "aai-node-type", "cloud-region");
327 Vertex tn = graph.addVertex(T.id, "60", "aai-node-type", "tenant");
329 Edge cloudRegionToTenantEdge = tn
330 .addEdge("some-edge", cr, CONTAINS.toString(), "NONE");
332 GraphTraversalSource g = graph.traversal();
334 edgeSer.addTreeEdge(g, gv, lint); //tree edge so shouldn't appear in results
335 Edge gvVnfc = edgeSer.addEdge(g, gv, vnfc);
336 edgeSer.addEdge(g, gv, lob); //v11/12 not v10
337 Edge gvMvEdge = edgeSer.addPrivateEdge(g, gv, mv, null);
339 List<Edge> expected = new ArrayList<>(Arrays.asList(gvVnfc));
341 GraphTraversalQueryEngine engine = new GraphTraversalQueryEngine(g);
344 Loader loader = loaderFactory.createLoaderForVersion(ModelType.MOXY, schemaVersions.getRelatedLinkVersion());
345 List<Edge> results = engine.findEdgesForVersion(gv, loader);
346 assertThat(results, containsInAnyOrder(expected.toArray()));
348 expected = new ArrayList<>(Arrays.asList(cloudRegionToTenantEdge));
349 results = engine.findEdgesForVersion(cr, loader);
350 assertThat(results, containsInAnyOrder(expected.toArray()));
354 public void testFindCousinVertices() throws AAIException {
356 Graph graph = TinkerGraph.open();
358 Vertex gv = graph.addVertex(T.id, "00", "aai-node-type", "generic-vnf");
359 Vertex vnfc = graph.addVertex(T.id, "10", "aai-node-type", "vnfc");
360 Vertex lob = graph.addVertex(T.id, "20", "aai-node-type", "line-of-business");
361 Vertex lint = graph.addVertex(T.id, "30", "aai-node-type", "l-interface");
363 GraphTraversalSource g = graph.traversal();
365 edgeSer.addTreeEdge(g, gv, lint); //tree edge so shouldn't appear in results
366 edgeSer.addEdge(g, gv, vnfc);
367 edgeSer.addEdge(g, gv, lob);
369 List<Vertex> expected = new ArrayList<>(Arrays.asList(vnfc, lob));
371 GraphTraversalQueryEngine engine = new GraphTraversalQueryEngine(g);
374 List<Vertex> results = engine.findCousinVertices(gv);
375 assertTrue(results.containsAll(expected) && expected.containsAll(results));