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 static org.junit.Assert.*;
24 import java.util.ArrayList;
25 import java.util.Arrays;
26 import java.util.HashSet;
27 import java.util.Iterator;
28 import java.util.List;
31 import com.att.eelf.configuration.EELFLogger;
32 import com.att.eelf.configuration.EELFManager;
33 import org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversalSource;
34 import org.apache.tinkerpop.gremlin.process.traversal.step.util.Tree;
35 import org.apache.tinkerpop.gremlin.structure.Direction;
36 import org.apache.tinkerpop.gremlin.structure.Edge;
37 import org.apache.tinkerpop.gremlin.structure.Element;
38 import org.apache.tinkerpop.gremlin.structure.Graph;
39 import org.apache.tinkerpop.gremlin.structure.T;
40 import org.apache.tinkerpop.gremlin.structure.Vertex;
41 import org.apache.tinkerpop.gremlin.tinkergraph.structure.TinkerGraph;
42 import org.apache.tinkerpop.gremlin.tinkergraph.structure.TinkerVertex;
43 import org.junit.Test;
44 import org.onap.aai.AAISetup;
45 import org.onap.aai.exceptions.AAIException;
46 import org.onap.aai.introspection.Loader;
47 import org.onap.aai.introspection.LoaderFactory;
48 import org.onap.aai.introspection.ModelType;
49 import org.onap.aai.introspection.Version;
50 import org.onap.aai.serialization.db.EdgeRules;
52 public class GraphTraversalQueryEngineTest extends AAISetup {
55 public void testFindParents() throws AAIException {
57 EdgeRules rules = EdgeRules.getInstance();
58 Graph graph = TinkerGraph.open();
60 Vertex cloudreg = graph.addVertex(T.id, "00", "aai-node-type", "cloud-region");
61 Vertex tenant = graph.addVertex(T.id, "10", "aai-node-type", "tenant");
62 Vertex vserver = graph.addVertex(T.id, "20", "aai-node-type", "vserver");
64 GraphTraversalSource g = graph.traversal();
66 rules.addTreeEdge(g, cloudreg, tenant);
67 rules.addTreeEdge(g, tenant, vserver);
69 //expect start vertex back plus any parents
70 List<Vertex> crExpected = new ArrayList<>(Arrays.asList(cloudreg)); //no parents
71 List<Vertex> tenExpected = new ArrayList<>(Arrays.asList(tenant, cloudreg)); //only has the immediate parent
72 List<Vertex> vsExpected = new ArrayList<>(Arrays.asList(vserver, tenant, cloudreg)); //parent & grandparent
74 GraphTraversalQueryEngine engine = new GraphTraversalQueryEngine(g);
77 List<Vertex> crRes = engine.findParents(cloudreg);
78 assertTrue(crRes.containsAll(crExpected) && crExpected.containsAll(crRes));
80 List<Vertex> tenRes = engine.findParents(tenant);
81 assertTrue(tenRes.containsAll(tenExpected) && tenExpected.containsAll(tenRes));
83 List<Vertex> vsRes = engine.findParents(vserver);
84 assertTrue(vsRes.containsAll(vsExpected) && vsExpected.containsAll(vsRes));
85 //verify expected ordering - start, parent, grandparent
86 assertTrue(vsRes.get(0).equals(vserver));
87 assertTrue(vsRes.get(1).equals(tenant));
88 assertTrue(vsRes.get(2).equals(cloudreg));
92 public void testFindAllChildren() throws AAIException {
94 EdgeRules rules = EdgeRules.getInstance();
95 Graph graph = TinkerGraph.open();
97 Vertex cloudreg = graph.addVertex(T.id, "00", "aai-node-type", "cloud-region");
98 Vertex tenant = graph.addVertex(T.id, "10", "aai-node-type", "tenant");
99 Vertex vserver = graph.addVertex(T.id, "20", "aai-node-type", "vserver");
100 Vertex vserver2 = graph.addVertex(T.id, "21", "aai-node-type", "vserver");
101 Vertex oam = graph.addVertex(T.id, "30", "aai-node-type", "oam-network");
103 GraphTraversalSource g = graph.traversal();
105 rules.addTreeEdge(g, cloudreg, tenant);
106 rules.addTreeEdge(g, tenant, vserver);
107 rules.addTreeEdge(g, tenant, vserver2);
108 rules.addTreeEdge(g, cloudreg, oam);
110 List<Vertex> crExpected = new ArrayList<>(Arrays.asList(cloudreg, tenant, vserver, vserver2, oam));
111 List<Vertex> vsExpected = new ArrayList<>(Arrays.asList(vserver));
113 GraphTraversalQueryEngine engine = new GraphTraversalQueryEngine(g);
116 List<Vertex> crRes = engine.findAllChildren(cloudreg);
117 assertTrue(crRes.containsAll(crExpected) && crExpected.containsAll(crRes));
119 List<Vertex> vsRes = engine.findAllChildren(vserver);
120 assertTrue(vsRes.containsAll(vsExpected) && vsExpected.containsAll(vsRes));
124 public void testFindChildrenOfType() throws AAIException {
126 EdgeRules rules = EdgeRules.getInstance();
127 Graph graph = TinkerGraph.open();
129 Vertex gv = graph.addVertex(T.id, "00", "aai-node-type", "generic-vnf");
130 Vertex lint1 = graph.addVertex(T.id, "10", "aai-node-type", "l-interface");
131 Vertex lint2 = graph.addVertex(T.id, "11", "aai-node-type", "l-interface");
132 Vertex lag = graph.addVertex(T.id, "20", "aai-node-type", "lag-interface");
133 Vertex lint3 = graph.addVertex(T.id, "12", "aai-node-type", "l-interface");
135 GraphTraversalSource g = graph.traversal();
137 rules.addTreeEdge(g, gv, lint1);
138 rules.addTreeEdge(g, gv, lint2);
139 rules.addTreeEdge(g, gv, lag);
140 rules.addTreeEdge(g, lag, lint3);
142 List<Vertex> expected = new ArrayList<>(Arrays.asList(lint1, lint2));
144 GraphTraversalQueryEngine engine = new GraphTraversalQueryEngine(g);
147 List<Vertex> results = engine.findChildrenOfType(gv, "l-interface");
148 assertTrue(results.containsAll(expected) && expected.containsAll(results));
152 public void testFindChildren() throws AAIException {
154 EdgeRules rules = EdgeRules.getInstance();
155 Graph graph = TinkerGraph.open();
157 Vertex gv = graph.addVertex(T.id, "00", "aai-node-type", "generic-vnf");
158 Vertex lint1 = graph.addVertex(T.id, "10", "aai-node-type", "l-interface");
159 Vertex lint2 = graph.addVertex(T.id, "11", "aai-node-type", "l-interface");
160 Vertex lag = graph.addVertex(T.id, "20", "aai-node-type", "lag-interface");
161 Vertex lint3 = graph.addVertex(T.id, "12", "aai-node-type", "l-interface");
163 GraphTraversalSource g = graph.traversal();
165 rules.addTreeEdge(g, gv, lint1);
166 rules.addTreeEdge(g, gv, lint2);
167 rules.addTreeEdge(g, gv, lag);
168 rules.addTreeEdge(g, lag, lint3);
170 List<Vertex> expected = new ArrayList<>(Arrays.asList(lint1, lint2, lag));
172 GraphTraversalQueryEngine engine = new GraphTraversalQueryEngine(g);
175 List<Vertex> results = engine.findChildren(gv);
176 assertTrue(results.containsAll(expected) && expected.containsAll(results));
180 public void testFindDeletable() throws AAIException {
182 EdgeRules rules = EdgeRules.getInstance("/dbedgerules/DbEdgeRules_test.json");
184 Graph graph = TinkerGraph.open();
185 Vertex parent = graph.addVertex(T.id, "00", "aai-node-type", "test-parent");
186 Vertex child = graph.addVertex(T.id, "10", "aai-node-type", "test-child");
187 Vertex cousin = graph.addVertex(T.id, "20", "aai-node-type", "test-cousin");
188 Vertex grandchild = graph.addVertex(T.id, "30", "aai-node-type", "test-grandchild");
190 GraphTraversalSource g = graph.traversal();
192 rules.addTreeEdge(g, parent, child); //delete-other-v=none, no cascade
193 rules.addTreeEdge(g, child, grandchild); //d-o-v=out, yes from child
194 rules.addEdge(g, cousin, child); //d-o-v=out, yes from cousin
196 List<Vertex> parentExpected = new ArrayList<>(Arrays.asList(parent));
197 List<Vertex> childExpected = new ArrayList<>(Arrays.asList(child, grandchild));
198 List<Vertex> cousinExpected = new ArrayList<>(Arrays.asList(cousin, child, grandchild));
200 GraphTraversalQueryEngine engine = new GraphTraversalQueryEngine(g);
203 List<Vertex> parentDeletes = engine.findDeletable(parent);
204 assertTrue(parentExpected.containsAll(parentDeletes) && parentDeletes.containsAll(parentExpected));
206 List<Vertex> childDeletes = engine.findDeletable(child);
207 assertTrue(childExpected.containsAll(childDeletes) && childDeletes.containsAll(childExpected));
209 List<Vertex> cousinDeletes = engine.findDeletable(cousin);
210 assertTrue(cousinExpected.containsAll(cousinDeletes) && cousinDeletes.containsAll(cousinExpected));
214 public void testFindRelatedVertices() throws AAIException {
216 EdgeRules rules = EdgeRules.getInstance();
218 Graph graph = TinkerGraph.open();
220 Vertex gv = graph.addVertex(T.id, "00", "aai-node-type", "generic-vnf");
221 Vertex lint = graph.addVertex(T.id, "10", "aai-node-type", "l-interface");
222 Vertex lint2 = graph.addVertex(T.id, "11", "aai-node-type", "l-interface");
223 Vertex log = graph.addVertex(T.id, "20", "aai-node-type", "logical-link");
225 GraphTraversalSource g = graph.traversal();
227 rules.addTreeEdge(g, gv, lint);
228 rules.addEdge(g, lint, log);
229 rules.addEdge(g, log, lint2);
231 List<Vertex> outExpected = new ArrayList<>(Arrays.asList(lint));
232 List<Vertex> inExpected = new ArrayList<>(Arrays.asList(lint, lint2));
233 List<Vertex> bothExpected = new ArrayList<>(Arrays.asList(log));
235 GraphTraversalQueryEngine engine = new GraphTraversalQueryEngine(g);
238 List<Vertex> outRes = engine.findRelatedVertices(gv, Direction.IN, "org.onap.relationships.inventory.BelongsTo", "l-interface");
239 assertTrue(outRes.containsAll(outExpected) && outExpected.containsAll(outRes));
241 List<Vertex> inRes = engine.findRelatedVertices(log, Direction.IN, "tosca.relationships.network.LinksTo", "l-interface");
242 assertTrue(inRes.containsAll(inExpected) && inExpected.containsAll(inRes));
244 List<Vertex> bothRes = engine.findRelatedVertices(lint, Direction.BOTH, "tosca.relationships.network.LinksTo", "logical-link");
245 assertTrue(bothRes.containsAll(bothExpected) && bothExpected.containsAll(bothRes));
249 public void testFindSubGraph() throws AAIException {
251 EdgeRules rules = EdgeRules.getInstance();
252 Graph graph = TinkerGraph.open();
254 Vertex cr = graph.addVertex(T.id, "00", "aai-node-type", "cloud-region");
255 Vertex ten = graph.addVertex(T.id, "10", "aai-node-type", "tenant");
256 Vertex ten2 = graph.addVertex(T.id, "11", "aai-node-type", "tenant");
257 Vertex vs = graph.addVertex(T.id, "20", "aai-node-type", "vserver");
258 Vertex vs2 = graph.addVertex(T.id, "21", "aai-node-type", "vserver");
259 Vertex lint = graph.addVertex(T.id, "30", "aai-node-type", "l-interface");
260 Vertex comp = graph.addVertex(T.id, "40", "aai-node-type", "complex");
261 Vertex ctag = graph.addVertex(T.id, "50", "aai-node-type", "ctag-pool");
262 Vertex gv = graph.addVertex(T.id, "60", "aai-node-type", "generic-vnf");
263 Vertex lag = graph.addVertex(T.id, "70", "aai-node-type", "lag-interface");
264 Vertex lint2 = graph.addVertex(T.id, "31", "aai-node-type", "l-interface");
265 Vertex log = graph.addVertex(T.id, "80", "aai-node-type", "logical-link");
266 Vertex vnfc = graph.addVertex(T.id, "90", "aai-node-type", "vnfc");
268 GraphTraversalSource g = graph.traversal();
270 Edge crTen = rules.addTreeEdge(g, cr, ten);
271 Edge crTen2 = rules.addTreeEdge(g, cr, ten2);
272 Edge tenVs = rules.addTreeEdge(g, ten, vs);
273 Edge tenVs2 = rules.addTreeEdge(g, ten, vs2);
274 Edge vsLInt = rules.addTreeEdge(g, vs, lint);
275 Edge lintLog = rules.addEdge(g, lint, log);
276 Edge vsGv = rules.addEdge(g, vs, gv);
277 rules.addEdge(g, gv, vnfc);
279 rules.addTreeEdge(g, gv, lag);
280 rules.addTreeEdge(g, lag, lint2);
282 rules.addTreeEdge(g, comp, ctag);
283 Edge crComp = rules.addEdge(g, cr, comp);
285 //findSubGraph(cr, 0, true)
286 List<Element> expected1 = new ArrayList<>(Arrays.asList(cr));
287 //findSubGraph(cr, 2, true)
288 List<Element> expected2 = new ArrayList<>(Arrays.asList(cr, ten, ten2, vs, vs2,
289 crTen, crTen2, tenVs, tenVs2));
291 List<Element> expected3 = new ArrayList<>(Arrays.asList(cr, ten, ten2, comp, vs, vs2, lint, gv, log,
292 crTen, crTen2, crComp, tenVs, tenVs2, vsLInt,
295 GraphTraversalQueryEngine engine = new GraphTraversalQueryEngine(g);
298 Tree<Element> res1 = engine.findSubGraph(cr, 0, true);
299 Set<Element> resList1 = treeToList(res1);
300 assertTrue(resList1.containsAll(expected1) && expected1.containsAll(resList1));
302 Tree<Element> res2 = engine.findSubGraph(cr, 2, true);
303 Set<Element> resList2 = treeToList(res2);
304 assertTrue(resList2.containsAll(expected2) && expected2.containsAll(resList2));
306 Tree<Element> res3 = engine.findSubGraph(cr);
307 Set<Element> resList3 = treeToList(res3);
308 assertTrue(resList3.containsAll(expected3) && expected3.containsAll(resList3));
312 * convenience helper method to make it easier to check the contents of the tree against
313 * a list of expected results
314 * @param tree - the tree whose contents you want in collection form
315 * @return set of the contents of the tree
317 private Set<Element> treeToList(Tree<Element> tree) {
318 Set<Element> ret = new HashSet<>();
320 for (Element key : tree.keySet()) {
322 ret.addAll(treeToList(tree.get(key)));
329 public void testFindEdgesForVersion() throws AAIException {
331 EdgeRules rules = EdgeRules.getInstance();
332 Graph graph = TinkerGraph.open();
334 Vertex gv = graph.addVertex(T.id, "00", "aai-node-type", "generic-vnf");
335 Vertex vnfc = graph.addVertex(T.id, "10", "aai-node-type", "vnfc");
336 Vertex lob = graph.addVertex(T.id, "20", "aai-node-type", "line-of-business");
337 Vertex lint = graph.addVertex(T.id, "30", "aai-node-type", "l-interface");
339 GraphTraversalSource g = graph.traversal();
341 rules.addTreeEdge(g, gv, lint); //tree edge so shouldn't appear in results
342 Edge gvVnfc = rules.addEdge(g, gv, vnfc);
343 rules.addEdge(g, gv, lob); //v11/12 not v10
345 List<Edge> expected = new ArrayList<>(Arrays.asList(gvVnfc));
347 GraphTraversalQueryEngine engine = new GraphTraversalQueryEngine(g);
350 Loader loader = LoaderFactory.createLoaderForVersion(ModelType.MOXY, Version.v10);
351 List<Edge> results = engine.findEdgesForVersion(gv, loader);
352 assertTrue(results.containsAll(expected) && expected.containsAll(results));
356 public void testFindCousinVertices() throws AAIException {
358 EdgeRules rules = EdgeRules.getInstance();
359 Graph graph = TinkerGraph.open();
361 Vertex gv = graph.addVertex(T.id, "00", "aai-node-type", "generic-vnf");
362 Vertex vnfc = graph.addVertex(T.id, "10", "aai-node-type", "vnfc");
363 Vertex lob = graph.addVertex(T.id, "20", "aai-node-type", "line-of-business");
364 Vertex lint = graph.addVertex(T.id, "30", "aai-node-type", "l-interface");
366 GraphTraversalSource g = graph.traversal();
368 rules.addTreeEdge(g, gv, lint); //tree edge so shouldn't appear in results
369 rules.addEdge(g, gv, vnfc);
370 rules.addEdge(g, gv, lob);
372 List<Vertex> expected = new ArrayList<>(Arrays.asList(vnfc, lob));
374 GraphTraversalQueryEngine engine = new GraphTraversalQueryEngine(g);
377 List<Vertex> results = engine.findCousinVertices(gv);
378 assertTrue(results.containsAll(expected) && expected.containsAll(results));