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=========================================================
21 package org.onap.aai.serialization.queryformats;
23 import com.google.gson.JsonObject;
24 import org.apache.tinkerpop.gremlin.process.traversal.strategy.verification.ReadOnlyStrategy;
25 import org.apache.tinkerpop.gremlin.structure.Graph;
26 import org.apache.tinkerpop.gremlin.structure.Vertex;
27 import org.apache.tinkerpop.gremlin.tinkergraph.structure.TinkerGraph;
28 import org.junit.Before;
29 import org.junit.Test;
30 import org.mockito.Mock;
31 import org.mockito.MockitoAnnotations;
32 import org.onap.aai.AAISetup;
33 import org.onap.aai.exceptions.AAIException;
34 import org.onap.aai.introspection.Loader;
35 import org.onap.aai.introspection.ModelType;
36 import org.onap.aai.serialization.db.DBSerializer;
37 import org.onap.aai.serialization.engines.JanusGraphDBEngine;
38 import org.onap.aai.serialization.engines.QueryStyle;
39 import org.onap.aai.serialization.engines.TransactionalGraphEngine;
40 import org.onap.aai.serialization.queryformats.exceptions.AAIFormatVertexException;
41 import org.onap.aai.serialization.queryformats.utils.UrlBuilder;
42 import org.onap.aai.setup.SchemaVersion;
44 import static org.junit.Assert.*;
45 import static org.mockito.Mockito.spy;
46 import static org.mockito.Mockito.when;
48 public class ResourceWithSoTTest extends AAISetup {
50 private UrlBuilder urlBuilder;
53 private Vertex putVertex;
54 private Vertex patchVertex1;
55 private Vertex patchVertex2;
57 private JsonObject jsonPutObj = new JsonObject();
58 private JsonObject jsonPatchObj1 = new JsonObject();
59 private JsonObject jsonPatchObj2 = new JsonObject();
61 private SchemaVersion version;
62 private ResourceWithSoT resourceWithSoT;
64 private TransactionalGraphEngine dbEngine;
65 private Loader loader;
66 private DBSerializer serializer;
67 private final ModelType factoryType = ModelType.MOXY;
70 public void setUp() throws Exception {
72 version = schemaVersions.getDefaultVersion();
73 MockitoAnnotations.initMocks(this);
75 graph = TinkerGraph.open();
77 long currentTimeMs = System.currentTimeMillis();
78 String timeNowInMs = Long.toString(currentTimeMs);
81 jsonPutObj.addProperty("aai-created-ts", timeNowInMs);
82 jsonPutObj.addProperty("aai-last-mod-ts", timeNowInMs);
83 jsonPutObj.addProperty("source-of-truth", "user_a");
84 jsonPutObj.addProperty("last-mod-source-of-truth", "user_a");
85 jsonPutObj.addProperty("last-action-performed", "Created");
87 putVertex = graph.addVertex("aai-created-ts", timeNowInMs, "aai-last-mod-ts", timeNowInMs, "source-of-truth",
88 "user_a", "last-mod-source-of-truth", "user_a");
90 // PATCH / MODIFY with differing source of truths
91 jsonPatchObj1.addProperty("aai-created-ts", timeNowInMs);
92 jsonPatchObj1.addProperty("aai-last-mod-ts", timeNowInMs);
93 jsonPatchObj1.addProperty("source-of-truth", "user_a");
94 jsonPatchObj1.addProperty("last-mod-source-of-truth", "user_b");
95 jsonPatchObj1.addProperty("last-action-performed", "Modified");
97 patchVertex1 = graph.addVertex("aai-created-ts", timeNowInMs, "aai-last-mod-ts", timeNowInMs, "source-of-truth",
98 "user_a", "last-mod-source-of-truth", "user_b");
100 // PATCH / MODIFY with differing time stamps
101 jsonPatchObj2.addProperty("aai-created-ts", timeNowInMs);
102 jsonPatchObj2.addProperty("aai-last-mod-ts", Long.toString(currentTimeMs + 1000));
103 jsonPatchObj2.addProperty("source-of-truth", "user_a");
104 jsonPatchObj2.addProperty("last-mod-source-of-truth", "user_a");
105 jsonPatchObj2.addProperty("last-action-performed", "Modified");
107 patchVertex2 = graph.addVertex("aai-created-ts", timeNowInMs, "aai-last-mod-ts",
108 Long.toString(currentTimeMs + 1000), "source-of-truth", "user_a", "last-mod-source-of-truth", "user_a");
110 graph = TinkerGraph.open();
111 createLoaderEngineSetup();
114 // This test is to simulate a PUT request
116 public void testGetJsonFromVertexWithCreateVertex() throws AAIFormatVertexException, AAIException {
117 if (putVertex == null) fail("The vertex used for this test is null. Fail immediately.");
119 JsonObject json = resourceWithSoT.getJsonFromVertex(putVertex).get();
120 assertEquals(jsonPutObj, json);
123 // This test is to simulate PATCH requests
125 public void testGetJsonFromVertexWithModifyVertex() throws AAIFormatVertexException, AAIException {
126 if (patchVertex1 == null) fail("The vertex 1 used for this test is null. Fail immediately.");
127 if (patchVertex2 == null) fail("The vertex 2 used for this test is null. Fail immediately.");
129 // Differing Source of Truths will indicate that the action performed modified the vertex
130 JsonObject json1 = resourceWithSoT.getJsonFromVertex(patchVertex1).get();
131 assertEquals(jsonPatchObj1, json1);
133 // Timestamps that have a large span in time difference will (likely) indicate that the transaction was not a
134 // create (thus, modify)
135 JsonObject json2 = resourceWithSoT.getJsonFromVertex(patchVertex2).get();
136 assertEquals(jsonPatchObj2, json2);
140 public void testGetJsonFromVertexWithNullVertex() throws AAIFormatVertexException, AAIException {
141 // Null check, will return null.
142 assertNull(resourceWithSoT.getJsonFromVertex(null));
145 public void createLoaderEngineSetup() throws AAIException {
147 if (loader == null) {
148 loader = loaderFactory.createLoaderForVersion(factoryType, version);
149 // loader = LoaderFactory.createLoaderForVersion(factoryType, version);
150 dbEngine = spy(new JanusGraphDBEngine(QueryStyle.TRAVERSAL, loader));
151 serializer = new DBSerializer(version, dbEngine, factoryType, "Junit");
152 resourceWithSoT = new ResourceWithSoT.Builder(loader, serializer, urlBuilder).build();
154 TransactionalGraphEngine.Admin spyAdmin = spy(dbEngine.asAdmin());
156 when(dbEngine.tx()).thenReturn(graph);
157 when(dbEngine.asAdmin()).thenReturn(spyAdmin);
159 when(spyAdmin.getReadOnlyTraversalSource())
160 .thenReturn(graph.traversal().withStrategies(ReadOnlyStrategy.instance()));
161 when(spyAdmin.getTraversalSource()).thenReturn(graph.traversal());