aai-core/src/test/java/org/onap/aai/introspection/sideeffect/DataCopyTest.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
  21 package org.onap.aai.introspection.sideeffect;
  22
  23 import org.apache.commons.io.IOUtils;
  24 import org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversalSource;
  25 import org.apache.tinkerpop.gremlin.structure.Graph;
  26 import org.apache.tinkerpop.gremlin.structure.Vertex;
  27 import org.apache.tinkerpop.gremlin.structure.VertexProperty;
  28 import org.janusgraph.core.JanusGraph;
  29 import org.janusgraph.core.JanusGraphFactory;
  30 import org.junit.*;
  31 import org.junit.rules.ExpectedException;
  32 import org.junit.runner.RunWith;
  33 import org.junit.runners.Parameterized;
  34 import org.mockito.Mock;
  35 import org.mockito.MockitoAnnotations;
  36 import org.springframework.test.annotation.DirtiesContext;
  37
  38 import org.onap.aai.AAISetup;
  39 import org.onap.aai.db.props.AAIProperties;
  40 import org.onap.aai.edges.enums.EdgeProperty;
  41 import org.onap.aai.exceptions.AAIException;
  42 import org.onap.aai.introspection.Introspector;
  43 import org.onap.aai.introspection.Loader;
  44 import org.onap.aai.introspection.ModelType;
  45 import org.onap.aai.introspection.sideeffect.exceptions.AAIMissingRequiredPropertyException;
  46 import org.onap.aai.parsers.query.QueryParser;
  47 import org.onap.aai.serialization.db.DBSerializer;
  48 import org.onap.aai.serialization.engines.JanusGraphDBEngine;
  49 import org.onap.aai.serialization.engines.QueryStyle;
  50 import org.onap.aai.serialization.engines.TransactionalGraphEngine;
  51
  52 import java.io.FileInputStream;
  53 import java.io.IOException;
  54 import java.io.UnsupportedEncodingException;
  55 import java.nio.charset.StandardCharsets;
  56 import java.util.Arrays;
  57 import java.util.Collection;
  58
  59 import static org.junit.Assert.assertEquals;
  60 import static org.junit.Assert.assertNull;
  61 import static org.mockito.Mockito.spy;
  62 import static org.mockito.Mockito.when;
  63
  64 @RunWith(value = Parameterized.class)
  65 @DirtiesContext(classMode = DirtiesContext.ClassMode.BEFORE_CLASS)
  66 public class DataCopyTest extends AAISetup {
  67
  68     private static JanusGraph graph;
  69     private final static ModelType introspectorFactoryType = ModelType.MOXY;
  70     private static Loader loader;
  71     private static TransactionalGraphEngine dbEngine;
  72     @Mock
  73     private Vertex self;
  74     @Mock
  75     private VertexProperty<String> prop;
  76     @Mock
  77     private QueryParser uriQuery;
  78     @Rule
  79     public ExpectedException thrown = ExpectedException.none();
  80
  81     @Parameterized.Parameter
  82     public QueryStyle queryStyle;
  83
  84     @Parameterized.Parameters(name = "QueryStyle.{0}")
  85     public static Collection<Object[]> data() {
  86         return Arrays.asList(new Object[][] {{QueryStyle.TRAVERSAL}, {QueryStyle.TRAVERSAL_URI}});
  87     }
  88
  89     @BeforeClass
  90     public static void setup() {
  91         graph = JanusGraphFactory.build().set("storage.backend", "inmemory").open();
  92         System.setProperty("AJSC_HOME", ".");
  93         System.setProperty("BUNDLECONFIG_DIR", "src/test/resources/bundleconfig-local");
  94
  95         graph.traversal()
  96             .addV("model")
  97             .property("aai-node-type", "model")
  98             .property("model-invariant-id", "key1")
  99             .property(AAIProperties.AAI_URI,"/service-design-and-creation/models/model/key1")
 100             .as("v1")
 101             .addV("model-ver")
 102             .property("aai-node-type", "model-ver")
 103             .property("model-ver", "myValue")
 104             .property("model-version-id", "key2")
 105             .property("model-version", "testValue")
 106             .property(AAIProperties.AAI_URI, "/service-design-and-creation/models/model/key1/model-vers/model-ver/key2")
 107             .as("v2")
 108             .addE("org.onap.relationships.inventory.BelongsTo").to("v1").from("v2")
 109             .property(EdgeProperty.CONTAINS.toString(), true)
 110             .addV("model")
 111             .property("aai-node-type", "model")
 112             .property("model-invariant-id", "key3")
 113             .property(AAIProperties.AAI_URI, "/service-design-and-creation/models/model/key3")
 114             .as("v3")
 115             .addV()
 116             .property("aai-node-type", "model-ver")
 117             .property("model-ver", "myValue")
 118             .property("model-version-id", "key4")
 119             .property(AAIProperties.AAI_URI, "/service-design-and-creation/models/model/key3/model-vers/model-ver/key4")
 120             .as("v4")
 121             .addE("org.onap.relationships.inventory.BelongsTo").to("v3").from("v4")
 122             .property(EdgeProperty.CONTAINS.toString(), true)
 123             .next();
 124         graph.tx().commit();
 125     }
 126
 127     @AfterClass
 128     public static void tearDown() {
 129         graph.tx().rollback();
 130         graph.close();
 131     }
 132
 133     @Before
 134     public void initMock() {
 135         loader = loaderFactory.createLoaderForVersion(introspectorFactoryType, schemaVersions.getDefaultVersion());
 136         MockitoAnnotations.initMocks(this);
 137         dbEngine = new JanusGraphDBEngine(queryStyle, loader);
 138     }
 139
 140     @Test
 141     public void runPopulatePersonaModelVer() throws AAIException, UnsupportedEncodingException,
 142             IllegalArgumentException, SecurityException {
 143
 144         final Loader loader = loaderFactory.createLoaderForVersion(ModelType.MOXY, schemaVersions.getDefaultVersion());
 145         final Introspector obj = loader.introspectorFromName("generic-vnf");
 146         obj.setValue("vnf-id", "myId");
 147         obj.setValue("model-invariant-id", "key1");
 148         obj.setValue("model-version-id", "key2");
 149         TransactionalGraphEngine spy = spy(dbEngine);
 150         TransactionalGraphEngine.Admin adminSpy = spy(dbEngine.asAdmin());
 151         Graph g = graph.newTransaction();
 152         GraphTraversalSource traversal = g.traversal();
 153         when(spy.asAdmin()).thenReturn(adminSpy);
 154         when(adminSpy.getTraversalSource()).thenReturn(traversal);
 155         when(self.<String>property(AAIProperties.AAI_URI)).thenReturn(prop);
 156         when(prop.orElse(null)).thenReturn(obj.getURI());
 157         DBSerializer serializer =
 158                 new DBSerializer(schemaVersions.getDefaultVersion(), spy, introspectorFactoryType, "AAI_TEST");
 159         SideEffectRunner runner = new SideEffectRunner.Builder(spy, serializer).addSideEffect(DataCopy.class).build();
 160
 161         runner.execute(obj, self);
 162
 163         assertEquals("value populated", "testValue", obj.getValue("persona-model-version"));
 164
 165         g.tx().rollback();
 166
 167     }
 168
 169     @Test
 170     public void verifyNestedSideEffect() throws AAIException, IllegalArgumentException, SecurityException, IOException {
 171
 172         final Loader loader = loaderFactory.createLoaderForVersion(ModelType.MOXY, schemaVersions.getDefaultVersion());
 173         final Introspector obj = loader.unmarshal("customer", this.getJsonString("nested-case.json"));
 174         TransactionalGraphEngine spy = spy(dbEngine);
 175         TransactionalGraphEngine.Admin adminSpy = spy(dbEngine.asAdmin());
 176         Graph g = graph.newTransaction();
 177         GraphTraversalSource traversal = g.traversal();
 178         when(spy.tx()).thenReturn(g);
 179         when(spy.asAdmin()).thenReturn(adminSpy);
 180         when(adminSpy.getTraversalSource()).thenReturn(traversal);
 181         when(self.<String>property(AAIProperties.AAI_URI)).thenReturn(prop);
 182         when(prop.orElse(null)).thenReturn(obj.getURI());
 183         when(uriQuery.isDependent()).thenReturn(false);
 184         DBSerializer serializer =
 185                 new DBSerializer(schemaVersions.getDefaultVersion(), spy, introspectorFactoryType, "AAI_TEST");
 186         Vertex v = serializer.createNewVertex(obj);
 187         serializer.serializeToDb(obj, v, uriQuery, obj.getURI(), "test");
 188
 189         assertEquals("nested value populated", "testValue", g.traversal().V()
 190                 .has("service-instance-id", "nested-instance-key").next().property("persona-model-version").orElse(""));
 191
 192         g.tx().rollback();
 193
 194     }
 195
 196     @Test
 197     public void expectedMissingPropertyExceptionInURI() throws AAIException, UnsupportedEncodingException {
 198
 199         final Loader loader = loaderFactory.createLoaderForVersion(ModelType.MOXY, schemaVersions.getDefaultVersion());
 200         final Introspector obj = loader.introspectorFromName("generic-vnf");
 201         obj.setValue("vnf-id", "myId");
 202         obj.setValue("model-invariant-id", "key1");
 203
 204         TransactionalGraphEngine spy = spy(dbEngine);
 205         TransactionalGraphEngine.Admin adminSpy = spy(dbEngine.asAdmin());
 206         Graph g = graph.newTransaction();
 207         GraphTraversalSource traversal = g.traversal();
 208         when(spy.asAdmin()).thenReturn(adminSpy);
 209         when(adminSpy.getTraversalSource()).thenReturn(traversal);
 210         when(self.<String>property(AAIProperties.AAI_URI)).thenReturn(prop);
 211         when(prop.orElse(null)).thenReturn(obj.getURI());
 212         DBSerializer serializer =
 213                 new DBSerializer(schemaVersions.getDefaultVersion(), spy, introspectorFactoryType, "AAI_TEST");
 214         SideEffectRunner runner = new SideEffectRunner.Builder(spy, serializer).addSideEffect(DataCopy.class).build();
 215
 216         thrown.expect(AAIMissingRequiredPropertyException.class);
 217         runner.execute(obj, self);
 218     }
 219
 220     @Test
 221     public void expectedMissingPropertyExceptionForResultingObject() throws AAIException, UnsupportedEncodingException {
 222         final Loader loader = loaderFactory.createLoaderForVersion(ModelType.MOXY, schemaVersions.getDefaultVersion());
 223         final Introspector obj = loader.introspectorFromName("generic-vnf");
 224         obj.setValue("vnf-id", "myId");
 225         obj.setValue("model-invariant-id", "key3");
 226         obj.setValue("model-version-id", "key4");
 227
 228         TransactionalGraphEngine spy = spy(dbEngine);
 229         TransactionalGraphEngine.Admin adminSpy = spy(dbEngine.asAdmin());
 230         Graph g = graph.newTransaction();
 231         GraphTraversalSource traversal = g.traversal();
 232         when(spy.asAdmin()).thenReturn(adminSpy);
 233         when(adminSpy.getTraversalSource()).thenReturn(traversal);
 234         when(self.<String>property(AAIProperties.AAI_URI)).thenReturn(prop);
 235         when(prop.orElse(null)).thenReturn(obj.getURI());
 236         DBSerializer serializer =
 237                 new DBSerializer(schemaVersions.getDefaultVersion(), spy, introspectorFactoryType, "AAI_TEST");
 238         SideEffectRunner runner = new SideEffectRunner.Builder(spy, serializer).addSideEffect(DataCopy.class).build();
 239
 240         thrown.expect(AAIMissingRequiredPropertyException.class);
 241         runner.execute(obj, self);
 242     }
 243
 244     @Test
 245     public void expectNoProcessingWithNoProperties() throws AAIException, UnsupportedEncodingException {
 246         final Loader loader = loaderFactory.createLoaderForVersion(ModelType.MOXY, schemaVersions.getDefaultVersion());
 247         final Introspector obj = loader.introspectorFromName("generic-vnf");
 248         obj.setValue("vnf-id", "myId");
 249
 250         TransactionalGraphEngine spy = spy(dbEngine);
 251         TransactionalGraphEngine.Admin adminSpy = spy(dbEngine.asAdmin());
 252         Graph g = graph.newTransaction();
 253         GraphTraversalSource traversal = g.traversal();
 254         when(spy.asAdmin()).thenReturn(adminSpy);
 255         when(adminSpy.getTraversalSource()).thenReturn(traversal);
 256         when(self.<String>property(AAIProperties.AAI_URI)).thenReturn(prop);
 257         when(prop.orElse(null)).thenReturn(obj.getURI());
 258         DBSerializer serializer =
 259                 new DBSerializer(schemaVersions.getDefaultVersion(), spy, introspectorFactoryType, "AAI_TEST");
 260         SideEffectRunner runner = new SideEffectRunner.Builder(spy, serializer).addSideEffect(DataCopy.class).build();
 261
 262         runner.execute(obj, self);
 263
 264         assertNull("no model-version-id", obj.getValue("model-version-id"));
 265         assertNull("no model-invariant-id", obj.getValue("model-invariant-id"));
 266
 267     }
 268
 269     private String getJsonString(String filename) throws IOException {
 270
 271         FileInputStream is = new FileInputStream("src/test/resources/oxm/sideeffect/" + filename);
 272         String s = IOUtils.toString(is, StandardCharsets.UTF_8);
 273         IOUtils.closeQuietly(is);
 274
 275         return s;
 276     }
 277 }