From 695d66a9635dd15c5fc8a16165f5651f50755c86 Mon Sep 17 00:00:00 2001 From: irama Date: Thu, 28 Mar 2019 10:32:44 +0530 Subject: [PATCH] Update AAI Assistant Tools for CCVPN Extension Implementaion to support intelligent surveillance function in CCVPN extension Issue-ID: HOLMES-194 Change-Id: Ic1b6acc5efb72a1f65f27ce5c27d2d6b6f47b7ce Signed-off-by: irama --- .../onap/holmes/common/aai/AaiJsonParserUtil.java | 135 ++++++++++++++++++ .../onap/holmes/common/aai/AaiQuery4Ccvpn2.java | 118 ++++++++++++++++ .../onap/holmes/common/aai/config/AaiConfig.java | 10 +- .../holmes/common/aai/AaiQuery4Ccvpn2Test.java | 156 +++++++++++++++++++++ holmes-actions/src/test/resources/ccvpn2.data.json | 98 +++++++++++++ 5 files changed, 516 insertions(+), 1 deletion(-) create mode 100644 holmes-actions/src/main/java/org/onap/holmes/common/aai/AaiJsonParserUtil.java create mode 100644 holmes-actions/src/main/java/org/onap/holmes/common/aai/AaiQuery4Ccvpn2.java create mode 100644 holmes-actions/src/test/java/org/onap/holmes/common/aai/AaiQuery4Ccvpn2Test.java create mode 100644 holmes-actions/src/test/resources/ccvpn2.data.json diff --git a/holmes-actions/src/main/java/org/onap/holmes/common/aai/AaiJsonParserUtil.java b/holmes-actions/src/main/java/org/onap/holmes/common/aai/AaiJsonParserUtil.java new file mode 100644 index 0000000..e6cd207 --- /dev/null +++ b/holmes-actions/src/main/java/org/onap/holmes/common/aai/AaiJsonParserUtil.java @@ -0,0 +1,135 @@ +/*- + * ============LICENSE_START======================================================= + * org.onap.holmes.common.aai + * ================================================================================ + * Copyright (C) 2018-2019 Huawei. All rights reserved. + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ============LICENSE_END========================================================= + */ + +package org.onap.holmes.common.aai; + +import com.alibaba.fastjson.JSONArray; +import com.alibaba.fastjson.JSONObject; +import lombok.extern.slf4j.Slf4j; +import org.jvnet.hk2.annotations.Service; +import org.onap.holmes.common.aai.config.AaiConfig; +import org.onap.holmes.common.config.MicroServiceConfig; +import org.onap.holmes.common.exception.CorrelationException; + +import javax.ws.rs.client.Client; +import javax.ws.rs.client.ClientBuilder; +import javax.ws.rs.client.WebTarget; +import javax.ws.rs.core.MultivaluedHashMap; +import javax.ws.rs.core.MultivaluedMap; +import javax.ws.rs.core.Response; +import java.util.Map; +import java.util.regex.Matcher; +import java.util.regex.Pattern; + + +@Service +@Slf4j +public class AaiJsonParserUtil { + + public static String getPath(String urlTemplate, String paramName, String paramValue) { + return urlTemplate.replaceAll("\\{" + paramName + "\\}", paramValue); + } + + public static String getPath(String serviceInstancePath) { + Pattern pattern = Pattern.compile("/aai/(v\\d+)/([A-Za-z0-9\\-]+[^/])(/*.*)"); + Matcher matcher = pattern.matcher(serviceInstancePath); + String ret = "/api"; + if (matcher.find()) { + ret += "/aai-" + matcher.group(2) + "/" + matcher.group(1) + matcher.group(3); + } + + return ret; + } + + public static Response get(String host, String path) throws CorrelationException { + Client client = ClientBuilder.newClient(); + WebTarget target = client.target(host).path(path); + try { + Response response = target.request().headers(getAaiHeaders()).get(); + if (response.getStatusInfo().getFamily() != Response.Status.Family.SUCCESSFUL) { + throw new CorrelationException("Failed to connect to AAI. \nCause: " + + response.getStatusInfo().getReasonPhrase() + "\nDetails: \n" + + getErrorMsg(String.format("%s%s", host, path), null, response)); + } + return response; + } catch (CorrelationException e) { + throw e; + } catch (Exception e) { + throw new CorrelationException(e.getMessage() + "More info: " + + getErrorMsg(String.format("%s%s", host, path), null, null), e); + } + } + + public static JSONObject getInfo(String response, String field) { + JSONObject jObject = JSONObject.parseObject(response); + JSONObject relationshipList = extractJsonObject(jObject, "relationship-list"); + JSONArray relationShip = extractJsonArray(relationshipList, "relationship"); + if (relationShip != null) { + for (int i = 0; i < relationShip.size(); ++i) { + final JSONObject object = relationShip.getJSONObject(i); + if (object.getString("related-to").equals(field)) { + return object; + } + } + } + return null; + } + + public static JSONObject extractJsonObject(JSONObject obj, String key) { + if (obj != null && key != null && obj.containsKey(key)) { + return obj.getJSONObject(key); + } + return null; + } + + public static JSONArray extractJsonArray(JSONObject obj, String key) { + if (obj != null && key != null && obj.containsKey(key)) { + return obj.getJSONArray(key); + } + return null; + } + + public static String getHostAddr() { + return MicroServiceConfig.getMsbServerAddrWithHttpPrefix(); + } + + public static String getErrorMsg(String url, Map body, Response response) { + StringBuilder sb = new StringBuilder(); + sb.append("Rerquest URL: ").append(url).append("\n"); + sb.append("Request Header: ").append(JSONObject.toJSONString(getAaiHeaders())).append("\n"); + if (body != null) { + sb.append("Request Body: ").append(JSONObject.toJSONString(body)).append("\n"); + } + if (response != null) { + sb.append("Request Body: ").append(response.readEntity(String.class)); + } + return sb.toString(); + } + + public static MultivaluedMap getAaiHeaders() { + MultivaluedMap headers = new MultivaluedHashMap<>(); + headers.add("X-TransactionId", AaiConfig.X_TRANSACTION_ID); + headers.add("X-FromAppId", AaiConfig.X_FROMAPP_ID); + headers.add("Authorization", AaiConfig.getAuthenticationCredentials()); + headers.add("Accept", "application/json"); + headers.add("Content-Type", "application/json"); + return headers; + } +} diff --git a/holmes-actions/src/main/java/org/onap/holmes/common/aai/AaiQuery4Ccvpn2.java b/holmes-actions/src/main/java/org/onap/holmes/common/aai/AaiQuery4Ccvpn2.java new file mode 100644 index 0000000..9b13b8e --- /dev/null +++ b/holmes-actions/src/main/java/org/onap/holmes/common/aai/AaiQuery4Ccvpn2.java @@ -0,0 +1,118 @@ +/*- + * ============LICENSE_START======================================================= + * org.onap.holmes.common.aai + * ================================================================================ + * Copyright (C) 2018-2019 Huawei. All rights reserved. + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ============LICENSE_END========================================================= + */ + +package org.onap.holmes.common.aai; + +import com.alibaba.fastjson.JSON; +import com.alibaba.fastjson.JSONArray; +import com.alibaba.fastjson.JSONObject; +import lombok.extern.slf4j.Slf4j; +import org.jvnet.hk2.annotations.Service; +import org.onap.holmes.common.aai.config.AaiConfig; +import org.onap.holmes.common.exception.CorrelationException; + +import javax.ws.rs.core.MultivaluedHashMap; +import javax.ws.rs.core.MultivaluedMap; +import javax.ws.rs.core.Response; +import java.util.regex.Matcher; +import java.util.regex.Pattern; + +import static org.onap.holmes.common.aai.AaiJsonParserUtil.extractJsonArray; +import static org.onap.holmes.common.aai.AaiJsonParserUtil.get; +import static org.onap.holmes.common.aai.AaiJsonParserUtil.getHostAddr; +import static org.onap.holmes.common.aai.AaiJsonParserUtil.getInfo; +import static org.onap.holmes.common.aai.AaiJsonParserUtil.getPath; + +@Service +@Slf4j +public class AaiQuery4Ccvpn2 { + + private MultivaluedMap headers; + + static public AaiQuery4Ccvpn2 newInstance() { + return new AaiQuery4Ccvpn2(); + } + + private AaiQuery4Ccvpn2() { + headers = new MultivaluedHashMap<>(); + headers.add("X-TransactionId", AaiConfig.X_TRANSACTION_ID); + headers.add("X-FromAppId", AaiConfig.X_FROMAPP_ID); + headers.add("Authorization", AaiConfig.getAuthenticationCredentials()); + headers.add("Accept", "application/json"); + headers.add("Content-Type", "application/json"); + } + + private String getSiteVNFId(String siteService) throws CorrelationException { + Response response = get(getHostAddr(), AaiConfig.MsbConsts.AAI_SITE_RESOURCES_QUERY); + String resStr = response.readEntity(String.class); + JSONObject resObj = JSON.parseObject(resStr); + JSONArray siteResources = extractJsonArray(resObj, "site-resource"); + if (siteResources != null) { + for (int i = 0; i < siteResources.size(); i++) { + final JSONObject object = siteResources.getJSONObject(i); + if (siteService.equals(object.getString("site-resource-name"))) { + JSONObject vnfInfo = getInfo(object.toJSONString(), "vnf-instance"); + String vnfPath = vnfInfo.getString("related-link"); + + String vnfId = null; + Pattern pattern = Pattern.compile("/aai/v\\d+/business/customers/customer/(.+)" + + "/service-subscriptions/service-subscription/(.+)" + + "/vnf-instances/vnf-instance/(.+)"); + Matcher matcher = pattern.matcher(vnfPath); + if (matcher.find()) { + vnfId = matcher.group(3); + } + + return vnfId; + } + } + } + return null; + } + + private JSONObject getServiceInstanceByVnfId(String vnfId) throws CorrelationException { + Response response = get(getHostAddr(), getPath(AaiConfig.MsbConsts.AAI_SITE_VNF_QUERY, + "vnfId", vnfId)); + String resStr = response.readEntity(String.class); + return getInfo(resStr, "service-instance"); + } + + public JSONObject getSiteServiceInstance(String siteService) throws CorrelationException { + String vnfId = getSiteVNFId(siteService); + JSONObject serviceInstanceInfo = getServiceInstanceByVnfId(vnfId); + String serviceInstancePath = serviceInstanceInfo.getString("related-link"); + Response response = get(getHostAddr(), getPath(serviceInstancePath)); + String res = response.readEntity(String.class); + JSONObject instance = JSON.parseObject(res); + String[] params = new String[2]; + Pattern pattern = Pattern.compile("/aai/v\\d+/business/customers/customer/(.+)" + + "/service-subscriptions/service-subscription/(.+)" + + "/service-instances/service-instance/(.+)"); + Matcher matcher = pattern.matcher(serviceInstancePath); + if (matcher.find()) { + params[0] = matcher.group(1); + params[1] = matcher.group(2); + } + instance.put("globalSubscriberId", params[0]); + instance.put("serviceType", params[1]); + instance.put("vnfId", vnfId); + return instance; + } +} diff --git a/holmes-actions/src/main/java/org/onap/holmes/common/aai/config/AaiConfig.java b/holmes-actions/src/main/java/org/onap/holmes/common/aai/config/AaiConfig.java index b3cd28a..3373470 100644 --- a/holmes-actions/src/main/java/org/onap/holmes/common/aai/config/AaiConfig.java +++ b/holmes-actions/src/main/java/org/onap/holmes/common/aai/config/AaiConfig.java @@ -59,7 +59,9 @@ public class AaiConfig { public static class MsbConsts { - private static final String AAI_NETWORK = "/aai/"; + private static final String AAI_MSB_PREF = "/api"; + + private static final String AAI_NETWORK = "/aai-network/"; private static final String AAI_BUSINESS = "/aai-business/"; @@ -84,5 +86,11 @@ public class AaiConfig { public static final String AAI_SERVICE_INSTANCES_ADDR_4_CCVPN = AAI_BUSINESS + AAI_API_VERSION + "/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}"; public static final String AAI_VM_ADDR = AAI_SEARCH + AAI_API_VERSION + "/nodes-query?search-node-type=vserver&filter="; + + public static final String AAI_SITE_RESOURCES_QUERY = AAI_MSB_PREF + AAI_NETWORK + AAI_API_VERSION + + "/site-resources"; + + public static final String AAI_SITE_VNF_QUERY = AAI_MSB_PREF + AAI_NETWORK + AAI_API_VERSION + + "/generic-vnfs/generic-vnf/{vnfId}"; } } diff --git a/holmes-actions/src/test/java/org/onap/holmes/common/aai/AaiQuery4Ccvpn2Test.java b/holmes-actions/src/test/java/org/onap/holmes/common/aai/AaiQuery4Ccvpn2Test.java new file mode 100644 index 0000000..1fca1da --- /dev/null +++ b/holmes-actions/src/test/java/org/onap/holmes/common/aai/AaiQuery4Ccvpn2Test.java @@ -0,0 +1,156 @@ +/*- + * ============LICENSE_START======================================================= + * org.onap.holmes.common.aai + * ================================================================================ + * Copyright (C) 2018-2019 Huawei. All rights reserved. + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ============LICENSE_END========================================================= + */ + +package org.onap.holmes.common.aai; + +import com.alibaba.fastjson.JSONObject; +import org.easymock.EasyMock; +import org.junit.After; +import org.junit.Before; +import org.junit.BeforeClass; +import org.junit.Rule; +import org.junit.Test; +import org.junit.rules.ExpectedException; +import org.junit.runner.RunWith; +import org.onap.holmes.common.aai.config.AaiConfig; +import org.onap.holmes.common.exception.CorrelationException; +import org.powermock.api.easymock.PowerMock; +import org.powermock.core.classloader.annotations.PrepareForTest; +import org.powermock.modules.junit4.PowerMockRunner; +import org.powermock.reflect.Whitebox; + +import javax.ws.rs.client.Client; +import javax.ws.rs.client.ClientBuilder; +import javax.ws.rs.client.Invocation; +import javax.ws.rs.client.WebTarget; +import javax.ws.rs.core.MultivaluedHashMap; +import javax.ws.rs.core.MultivaluedMap; +import javax.ws.rs.core.Response; +import java.io.BufferedReader; +import java.io.File; +import java.io.FileNotFoundException; +import java.io.FileReader; +import java.io.IOException; + +import static org.onap.holmes.common.config.MicroServiceConfig.MSB_ADDR; + + +@RunWith(PowerMockRunner.class) +@PrepareForTest({ClientBuilder.class, Client.class, Invocation.Builder.class, WebTarget.class, Response.class}) +public class AaiQuery4Ccvpn2Test { + + @Rule + public ExpectedException thrown = ExpectedException.none(); + + private static JSONObject data; + + private static AaiQuery4Ccvpn2 aai = AaiQuery4Ccvpn2.newInstance(); + + private static MultivaluedMap headers = new MultivaluedHashMap<>(); + private static Client client; + private static WebTarget webTarget; + private static Invocation.Builder builder; + private static Response response; + + @BeforeClass + static public void beforeClass() { + System.setProperty(MSB_ADDR, "127.0.0.1:80"); + + File file = new File(AaiQuery4Ccvpn2Test.class.getClassLoader().getResource("./ccvpn2.data.json").getFile()); + BufferedReader reader = null; + try { + reader = new BufferedReader(new FileReader(file)); + StringBuilder sb = new StringBuilder(); + reader.lines().forEach(l -> sb.append(l)); + data = JSONObject.parseObject(sb.toString()); + } catch (FileNotFoundException e) { + // Do nothing + } catch (IOException e) { + // Do nothing + } finally { + if (reader != null) { + try { + reader.close(); + } catch (IOException e) { + // Do nothing + } + } + } + + headers.add("X-TransactionId", AaiConfig.X_TRANSACTION_ID); + headers.add("X-FromAppId", AaiConfig.X_FROMAPP_ID); + headers.add("Authorization", AaiConfig.getAuthenticationCredentials()); + headers.add("Accept", "application/json"); + headers.add("Content-Type", "application/json"); + Whitebox.setInternalState(aai, "headers", headers); + } + + @Before + public void before() { + PowerMock.mockStatic(ClientBuilder.class); + client = PowerMock.createMock(Client.class); + webTarget = PowerMock.createMock(WebTarget.class); + builder = PowerMock.createMock(Invocation.Builder.class); + response = PowerMock.createMock(Response.class); + } + + @After + public void after() { + PowerMock.resetAll(); + } + + @Test + public void test_getServiceInstances_exception() throws CorrelationException { + mockGetMethod(); + EasyMock.expect(response.readEntity(String.class)).andReturn(data.getJSONObject("site-resources").toJSONString + ()); + EasyMock.expect(response.getStatusInfo()).andReturn(Response.Status.OK); + + mockGetMethod(); + EasyMock.expect(response.readEntity(String.class)).andReturn(data.getJSONObject("499hkg9933NNN").toJSONString + ()); + EasyMock.expect(response.getStatusInfo()).andReturn(Response.Status.OK); + + mockGetMethod(); + EasyMock.expect(response.readEntity(String.class)).andReturn(data.getJSONObject("499hkg9933NNN").toJSONString + ()); + EasyMock.expect(response.getStatusInfo()).andReturn(Response.Status.OK); + + PowerMock.replayAll(); + + aai.getSiteServiceInstance("HkHubONSDEMOBJHKCustomer"); + + PowerMock.verifyAll(); + } + + + private void mockGetMethod() { + initCommonMock(); + EasyMock.expect(builder.get()).andReturn(response); + } + + private void initCommonMock() { + EasyMock.expect(ClientBuilder.newClient()).andReturn(client); + EasyMock.expect(client.target(EasyMock.anyObject(String.class))).andReturn(webTarget); + EasyMock.expect(webTarget.path(EasyMock.anyObject(String.class))).andReturn(webTarget); + EasyMock.expect(webTarget.request()).andReturn(builder); + EasyMock.expect(builder.headers(headers)).andReturn(builder); + } +} diff --git a/holmes-actions/src/test/resources/ccvpn2.data.json b/holmes-actions/src/test/resources/ccvpn2.data.json new file mode 100644 index 0000000..23faa60 --- /dev/null +++ b/holmes-actions/src/test/resources/ccvpn2.data.json @@ -0,0 +1,98 @@ +{ + "site-resources": { + "site-resource": [ + { + "site-resource-id": "3801b392-f596-4f7b-93d6-4d0a33b014bc", + "site-resource-name": "HkHubONSDEMOBJHKCustomer", + "description": "HongkongLabDesc", + "type": "single-gateway", + "role": "dsvpn-hub", + "selflink": "restconf/config/GENERIC-RESOURCE-API:services/service/499hkg9933NNN/service-data/vnfs/vnf/3801b392-f596-4f7b-93d6-4d0a33b014bc/vnf-data/", + "operational-status": "Online", + "resource-version": "1553193393081", + "relationship-list": { + "relationship": [ + { + "related-to": "complex", + "relationship-label": "org.onap.relationships.inventory.Uses", + "related-link": "/aai/v14/cloud-infrastructure/complexes/complex/3801b392-f596-4f7b-93d6-4d0a33b014bc", + "relationship-data": { + "relationship-key": "complex.physical-location-id", + "relationship-value": "3801b392-f596-4f7b-93d6-4d0a33b014bc" + } + }, + { + "related-to": "vnf-instance", + "relationship-label": "org.onap.relationships.inventory.PartOf", + "related-link": "/aai/v14/business/customers/customer/ONSDEMOBJHKCustomer/service-subscriptions/service-subscription/service-ccvpn/vnf-instances/vnf-instance/499hkg9933NNN", + "relationship-data": [ + { + "relationship-key": "customer.global-customer-id", + "relationship-value": "ONSDEMOBJHKCustomer" + }, + { + "relationship-key": "service-subscription.service-type", + "relationship-value": "service-ccvpn" + }, + { + "relationship-key": "service-instance.service-instance-id", + "relationship-value": "499hkg9933NNN" + } + ], + "related-to-property": { + "property-key": "service-instance.service-instance-name", + "property-value": "499hkg9933NNN" + } + } + ] + } + } + ] + }, + "499hkg9933NNN": { + "site-resource-id": "3801b392-f596-4f7b-93d6-4d0a33b014bc", + "site-resource-name": "HkHubONSDEMOBJHKCustomer", + "description": "HongkongLabDesc", + "type": "single-gateway", + "role": "dsvpn-hub", + "selflink": "restconf/config/GENERIC-RESOURCE-API:services/service/499hkg9933NNN/service-data/vnfs/vnf/3801b392-f596-4f7b-93d6-4d0a33b014bc/vnf-data/", + "operational-status": "Online", + "resource-version": "1553193393081", + "relationship-list": { + "relationship": [ + { + "related-to": "complex", + "relationship-label": "org.onap.relationships.inventory.Uses", + "related-link": "/aai/v14/cloud-infrastructure/complexes/complex/3801b392-f596-4f7b-93d6-4d0a33b014bc", + "relationship-data": { + "relationship-key": "complex.physical-location-id", + "relationship-value": "3801b392-f596-4f7b-93d6-4d0a33b014bc" + } + }, + { + "related-to": "service-instance", + "relationship-label": "org.onap.relationships.inventory.PartOf", + "related-link": "/aai/v14/business/customers/customer/ONSDEMOBJHKCustomer/service-subscriptions/service-subscription/service-ccvpn/service-instances/service-instance/499hkg9933NNN", + "relationship-data": [ + { + "relationship-key": "customer.global-customer-id", + "relationship-value": "ONSDEMOBJHKCustomer" + }, + { + "relationship-key": "service-subscription.service-type", + "relationship-value": "service-ccvpn" + }, + { + "relationship-key": "service-instance.service-instance-id", + "relationship-value": "499hkg9933NNN" + } + ], + "related-to-property": { + "property-key": "service-instance.service-instance-name", + "property-value": "499hkg9933NNN" + } + } + ] + } + } +} \ No newline at end of file -- 2.16.6