aai-core/src/test/java/org/onap/aai/serialization/engines/query/GraphTraversalQueryEngineTest.java

   1 /**
   2  * ============LICENSE_START=======================================================
   3  * org.onap.aai
   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
  10  *
  11  *    http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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=========================================================
  19  */
  20 package org.onap.aai.serialization.engines.query;
  21
  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;
  37
  38 import java.io.InputStream;
  39 import java.util.*;
  40
  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;
  46
  47 @DirtiesContext(classMode = DirtiesContext.ClassMode.BEFORE_CLASS)
  48 public class GraphTraversalQueryEngineTest extends AAISetup {
  49
  50         @Autowired
  51         EdgeSerializer edgeSer;
  52
  53         @Test
  54         public void testFindParents() throws AAIException {
  55                 //setup
  56                 Graph graph = TinkerGraph.open();
  57
  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");
  61
  62                 GraphTraversalSource g = graph.traversal();
  63
  64                 edgeSer.addTreeEdge(g, cloudreg, tenant);
  65                 edgeSer.addTreeEdge(g, tenant, vserver);
  66
  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
  71
  72                 GraphTraversalQueryEngine engine = new GraphTraversalQueryEngine(g);
  73
  74                 //test
  75                 List<Vertex> crRes = engine.findParents(cloudreg);
  76                 assertTrue(crRes.containsAll(crExpected) && crExpected.containsAll(crRes));
  77
  78                 List<Vertex> tenRes = engine.findParents(tenant);
  79                 assertTrue(tenRes.containsAll(tenExpected) && tenExpected.containsAll(tenRes));
  80
  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));
  87         }
  88
  89         @Test
  90         public void testFindAllParentsGivenAaiUris(){
  91
  92         //setup
  93         Graph graph = TinkerGraph.open();
  94
  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");
  98
  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"
 103         };
 104
 105         GraphTraversalSource g = graph.traversal();
 106         GraphTraversalQueryEngine queryEngine = new GraphTraversalQueryEngine(g);
 107         List<Vertex> vertices = queryEngine.findParents(uris);
 108
 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));
 113     }
 114
 115         @Test
 116         public void testFindAllChildren() throws AAIException {
 117                 //setup
 118                 Graph graph = TinkerGraph.open();
 119
 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");
 125
 126                 GraphTraversalSource g = graph.traversal();
 127
 128                 edgeSer.addTreeEdge(g, cloudreg, tenant);
 129                 edgeSer.addTreeEdge(g, tenant, vserver);
 130                 edgeSer.addTreeEdge(g, tenant, vserver2);
 131                 edgeSer.addTreeEdge(g, cloudreg, oam);
 132
 133                 List<Vertex> crExpected = new ArrayList<>(Arrays.asList(cloudreg, tenant, vserver, vserver2, oam));
 134                 List<Vertex> vsExpected = new ArrayList<>(Arrays.asList(vserver));
 135
 136                 GraphTraversalQueryEngine engine = new GraphTraversalQueryEngine(g);
 137
 138                 //test
 139                 List<Vertex> crRes = engine.findAllChildren(cloudreg);
 140                 assertTrue(crRes.containsAll(crExpected) && crExpected.containsAll(crRes));
 141
 142                 List<Vertex> vsRes = engine.findAllChildren(vserver);
 143                 assertTrue(vsRes.containsAll(vsExpected) && vsExpected.containsAll(vsRes));
 144         }
 145
 146         @Test
 147         public void testFindChildrenOfType() throws AAIException {
 148                 //setup
 149                 Graph graph = TinkerGraph.open();
 150
 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");
 156
 157                 GraphTraversalSource g = graph.traversal();
 158
 159                 edgeSer.addTreeEdge(g, gv, lint1);
 160                 edgeSer.addTreeEdge(g, gv, lint2);
 161                 edgeSer.addTreeEdge(g, gv, lag);
 162                 edgeSer.addTreeEdge(g, lag, lint3);
 163
 164                 List<Vertex> expected = new ArrayList<>(Arrays.asList(lint1, lint2));
 165
 166                 GraphTraversalQueryEngine engine = new GraphTraversalQueryEngine(g);
 167
 168                 //test
 169                 List<Vertex> results = engine.findChildrenOfType(gv, "l-interface");
 170                 assertTrue(results.containsAll(expected) && expected.containsAll(results));
 171         }
 172
 173         @Test
 174         public void testFindChildren() throws AAIException {
 175                 //setup
 176                 Graph graph = TinkerGraph.open();
 177
 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");
 183
 184                 GraphTraversalSource g = graph.traversal();
 185
 186                 edgeSer.addTreeEdge(g, gv, lint1);
 187                 edgeSer.addTreeEdge(g, gv, lint2);
 188                 edgeSer.addTreeEdge(g, gv, lag);
 189                 edgeSer.addTreeEdge(g, lag, lint3);
 190
 191                 List<Vertex> expected = new ArrayList<>(Arrays.asList(lint1, lint2, lag));
 192
 193                 GraphTraversalQueryEngine engine = new GraphTraversalQueryEngine(g);
 194
 195                 //test
 196                 List<Vertex> results = engine.findChildren(gv);
 197                 assertTrue(results.containsAll(expected) && expected.containsAll(results));
 198         }
 199
 200         @Test
 201         public void testFindRelatedVertices() throws AAIException {
 202                 //setup
 203
 204                 Graph graph = TinkerGraph.open();
 205
 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");
 210
 211                 GraphTraversalSource g = graph.traversal();
 212
 213                 edgeSer.addTreeEdge(g, gv, lint);
 214                 edgeSer.addEdge(g, lint, log);
 215                 edgeSer.addEdge(g, log, lint2);
 216
 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));
 220
 221                 GraphTraversalQueryEngine engine = new GraphTraversalQueryEngine(g);
 222
 223                 //test
 224                 List<Vertex> outRes = engine.findRelatedVertices(gv, Direction.IN, "org.onap.relationships.inventory.BelongsTo", "l-interface");
 225                 assertTrue(outRes.containsAll(outExpected) && outExpected.containsAll(outRes));
 226
 227                 List<Vertex> inRes = engine.findRelatedVertices(log, Direction.IN, "tosca.relationships.network.LinksTo", "l-interface");
 228                 assertTrue(inRes.containsAll(inExpected) && inExpected.containsAll(inRes));
 229
 230                 List<Vertex> bothRes = engine.findRelatedVertices(lint, Direction.BOTH, "tosca.relationships.network.LinksTo", "logical-link");
 231                 assertTrue(bothRes.containsAll(bothExpected) && bothExpected.containsAll(bothRes));
 232         }
 233
 234         @Test
 235         public void testFindSubGraph() throws AAIException, EdgeRuleNotFoundException, AmbiguousRuleChoiceException {
 236                 //setup
 237                 Graph graph = TinkerGraph.open();
 238
 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");
 253
 254                 GraphTraversalSource g = graph.traversal();
 255
 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);
 264
 265                 edgeSer.addTreeEdge(g, gv, lag);
 266                 edgeSer.addTreeEdge(g, lag, lint2);
 267         Edge modelVerEdge = edgeSer.addPrivateEdge(g, gv, modelVer, null);
 268
 269                 edgeSer.addTreeEdge(g, comp, ctag);
 270                 Edge crComp = edgeSer.addEdge(g, cr, comp);
 271
 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));
 277                 //findSubGraph(cr)
 278                 List<Element> expected3 = new ArrayList<>(Arrays.asList(cr, ten, ten2, comp, vs, vs2, lint, gv, log,
 279                                                                                                                                 crTen, crTen2, crComp, tenVs, tenVs2, vsLInt,
 280                                                                                                                                 vsGv, lintLog));
 281
 282                 GraphTraversalQueryEngine engine = new GraphTraversalQueryEngine(g);
 283
 284                 //test
 285                 Tree<Element> res1 = engine.findSubGraph(cr, 0, true);
 286                 Set<Element> resList1 = treeToList(res1);
 287                 assertTrue(resList1.containsAll(expected1) && expected1.containsAll(resList1));
 288
 289                 Tree<Element> res2 = engine.findSubGraph(cr, 2, true);
 290                 Set<Element> resList2 = treeToList(res2);
 291                 assertTrue(resList2.containsAll(expected2) && expected2.containsAll(resList2));
 292
 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));
 297         }
 298
 299         /**
 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
 304          */
 305         private Set<Element> treeToList(Tree<Element> tree) {
 306                 Set<Element> ret = new HashSet<>();
 307
 308                 for (Element key : tree.keySet()) {
 309                         ret.add(key);
 310                         ret.addAll(treeToList(tree.get(key)));
 311                 }
 312
 313                 return ret;
 314         }
 315
 316         @Test
 317         public void testFindEdgesForVersion() throws AAIException, EdgeRuleNotFoundException, AmbiguousRuleChoiceException {
 318                 //setup
 319                 Graph graph = TinkerGraph.open();
 320
 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");
 328
 329                 Edge cloudRegionToTenantEdge = tn
 330                          .addEdge("some-edge", cr, CONTAINS.toString(), "NONE");
 331
 332                 GraphTraversalSource g = graph.traversal();
 333
 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);
 338
 339                 List<Edge> expected = new ArrayList<>(Arrays.asList(gvVnfc));
 340
 341                 GraphTraversalQueryEngine engine = new GraphTraversalQueryEngine(g);
 342
 343                 //test
 344                 Loader loader = loaderFactory.createLoaderForVersion(ModelType.MOXY, schemaVersions.getRelatedLinkVersion());
 345                 List<Edge> results = engine.findEdgesForVersion(gv, loader);
 346                 assertThat(results, containsInAnyOrder(expected.toArray()));
 347
 348         expected = new ArrayList<>(Arrays.asList(cloudRegionToTenantEdge));
 349                 results = engine.findEdgesForVersion(cr, loader);
 350                 assertThat(results, containsInAnyOrder(expected.toArray()));
 351         }
 352
 353         @Test
 354         public void testFindCousinVertices() throws AAIException {
 355                 //setup
 356                 Graph graph = TinkerGraph.open();
 357
 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");
 362
 363                 GraphTraversalSource g = graph.traversal();
 364
 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);
 368
 369                 List<Vertex> expected = new ArrayList<>(Arrays.asList(vnfc, lob));
 370
 371                 GraphTraversalQueryEngine engine = new GraphTraversalQueryEngine(g);
 372
 373                 //test
 374                 List<Vertex> results = engine.findCousinVertices(gv);
 375                 assertTrue(results.containsAll(expected) && expected.containsAll(results));
 376         }
 377 }