From 5d0ad5f3d3158357183849ca329ac6999be6281d Mon Sep 17 00:00:00 2001 From: Lathish Date: Thu, 6 Aug 2020 10:19:33 +0100 Subject: Initial A1 adapter api implmentation Issue-ID: CCSDK-2604 Change-Id: If946b4f0cc92410e6b903928fd9cb2fd79996dc3 Signed-off-by: Lathish --- a1-adapter/a1-adapter-api/provider/pom.xml | 9 +- .../ccsdk/features/a1/adapter/A1AdapterClient.java | 75 +++++++++ .../features/a1/adapter/A1AdapterProvider.java | 174 +++++++++++++++++++++ .../OSGI-INF/blueprint/impl-blueprint.xml | 50 ++++++ .../org/opendaylight/blueprint/impl-blueprint.xml | 50 ++++++ .../features/a1/adapter/A1AdapterProviderTest.java | 101 ++++++++++++ 6 files changed, 458 insertions(+), 1 deletion(-) create mode 100644 a1-adapter/a1-adapter-api/provider/src/main/java/org/onap/ccsdk/features/a1/adapter/A1AdapterClient.java create mode 100644 a1-adapter/a1-adapter-api/provider/src/main/java/org/onap/ccsdk/features/a1/adapter/A1AdapterProvider.java create mode 100644 a1-adapter/a1-adapter-api/provider/src/main/resources/OSGI-INF/blueprint/impl-blueprint.xml create mode 100644 a1-adapter/a1-adapter-api/provider/src/main/resources/org/opendaylight/blueprint/impl-blueprint.xml create mode 100644 a1-adapter/a1-adapter-api/provider/src/test/java/org/onap/ccsdk/features/a1/adapter/A1AdapterProviderTest.java (limited to 'a1-adapter/a1-adapter-api/provider') diff --git a/a1-adapter/a1-adapter-api/provider/pom.xml b/a1-adapter/a1-adapter-api/provider/pom.xml index bf7ae330..8f1d94e8 100644 --- a/a1-adapter/a1-adapter-api/provider/pom.xml +++ b/a1-adapter/a1-adapter-api/provider/pom.xml @@ -26,7 +26,7 @@ org.onap.ccsdk.parent binding-parent - 2.0.0-SNAPSHOT + 2.0.1-SNAPSHOT @@ -135,6 +135,13 @@ + + org.apache.maven.plugins + maven-javadoc-plugin + + 8 + + diff --git a/a1-adapter/a1-adapter-api/provider/src/main/java/org/onap/ccsdk/features/a1/adapter/A1AdapterClient.java b/a1-adapter/a1-adapter-api/provider/src/main/java/org/onap/ccsdk/features/a1/adapter/A1AdapterClient.java new file mode 100644 index 00000000..fb21de4c --- /dev/null +++ b/a1-adapter/a1-adapter-api/provider/src/main/java/org/onap/ccsdk/features/a1/adapter/A1AdapterClient.java @@ -0,0 +1,75 @@ +/*- + * ============LICENSE_START======================================================= + * Copyright (C) 2020 Nordix Foundation. + * ================================================================================ + * 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. + * + * SPDX-License-Identifier: Apache-2.0 + * ============LICENSE_END========================================================= + */ + +package org.onap.ccsdk.features.a1.adapter; + +import java.util.Properties; +import org.onap.ccsdk.sli.core.sli.SvcLogicException; +import org.onap.ccsdk.sli.core.sli.provider.MdsalHelper; +import org.onap.ccsdk.sli.core.sli.provider.SvcLogicService; +import org.opendaylight.yang.gen.v1.org.onap.a1.adapter.rev200122.GetA1PolicyTypeOutputBuilder; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +public class A1AdapterClient { + + private static final Logger LOG = LoggerFactory.getLogger(A1AdapterClient.class); + + private SvcLogicService svcLogicService = null; + + public A1AdapterClient(final SvcLogicService svcLogicService) { + this.svcLogicService = svcLogicService; + } + + public boolean hasGraph(String module, String rpc, String version, String mode) + throws SvcLogicException { + return svcLogicService.hasGraph(module, rpc, version, mode); + } + + public Properties execute(String module, String rpc, String version, String mode, + GetA1PolicyTypeOutputBuilder serviceData, Properties parms) throws SvcLogicException { + Properties localProp; + localProp = MdsalHelper.toProperties(parms, serviceData); + if (LOG.isDebugEnabled()) { + LOG.debug("Parameters passed to SLI"); + + for (Object key : localProp.keySet()) { + String parmName = (String) key; + String parmValue = localProp.getProperty(parmName); + + LOG.debug(parmName + " = " + parmValue); + } + } + Properties respProps = svcLogicService.execute(module, rpc, version, mode, localProp); + if (LOG.isDebugEnabled()) { + LOG.debug("Parameters returned by SLI"); + for (Object key : respProps.keySet()) { + String parmName = (String) key; + String parmValue = respProps.getProperty(parmName); + LOG.debug(parmName + " = " + parmValue); + } + } + if ("failure".equalsIgnoreCase(respProps.getProperty("SvcLogic.status"))) { + return respProps; + } + MdsalHelper.toBuilder(respProps, serviceData); + return respProps; + } +} diff --git a/a1-adapter/a1-adapter-api/provider/src/main/java/org/onap/ccsdk/features/a1/adapter/A1AdapterProvider.java b/a1-adapter/a1-adapter-api/provider/src/main/java/org/onap/ccsdk/features/a1/adapter/A1AdapterProvider.java new file mode 100644 index 00000000..a1b9ef92 --- /dev/null +++ b/a1-adapter/a1-adapter-api/provider/src/main/java/org/onap/ccsdk/features/a1/adapter/A1AdapterProvider.java @@ -0,0 +1,174 @@ +/*- + * ============LICENSE_START======================================================= + * Copyright (C) 2020 Nordix Foundation. + * ================================================================================ + * 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. + * + * SPDX-License-Identifier: Apache-2.0 + * ============LICENSE_END========================================================= + */ + +package org.onap.ccsdk.features.a1.adapter; + +import com.google.common.util.concurrent.Futures; +import com.google.common.util.concurrent.ListenableFuture; +import java.util.Properties; +import java.util.concurrent.ExecutorService; +import java.util.concurrent.Executors; +import org.onap.ccsdk.sli.core.sli.provider.MdsalHelper; +import org.opendaylight.controller.md.sal.binding.api.DataBroker; +import org.opendaylight.controller.md.sal.binding.api.NotificationPublishService; +import org.opendaylight.controller.sal.binding.api.BindingAwareBroker; +import org.opendaylight.controller.sal.binding.api.RpcProviderRegistry; +import org.opendaylight.yang.gen.v1.org.onap.a1.adapter.rev200122.A1ADAPTERAPIService; +import org.opendaylight.yang.gen.v1.org.onap.a1.adapter.rev200122.DeleteA1PolicyInput; +import org.opendaylight.yang.gen.v1.org.onap.a1.adapter.rev200122.DeleteA1PolicyOutput; +import org.opendaylight.yang.gen.v1.org.onap.a1.adapter.rev200122.GetA1PolicyInput; +import org.opendaylight.yang.gen.v1.org.onap.a1.adapter.rev200122.GetA1PolicyOutput; +import org.opendaylight.yang.gen.v1.org.onap.a1.adapter.rev200122.GetA1PolicyStatusInput; +import org.opendaylight.yang.gen.v1.org.onap.a1.adapter.rev200122.GetA1PolicyStatusOutput; +import org.opendaylight.yang.gen.v1.org.onap.a1.adapter.rev200122.GetA1PolicyTypeInput; +import org.opendaylight.yang.gen.v1.org.onap.a1.adapter.rev200122.GetA1PolicyTypeInputBuilder; +import org.opendaylight.yang.gen.v1.org.onap.a1.adapter.rev200122.GetA1PolicyTypeOutput; +import org.opendaylight.yang.gen.v1.org.onap.a1.adapter.rev200122.GetA1PolicyTypeOutputBuilder; +import org.opendaylight.yang.gen.v1.org.onap.a1.adapter.rev200122.PutA1PolicyInput; +import org.opendaylight.yang.gen.v1.org.onap.a1.adapter.rev200122.PutA1PolicyOutput; +import org.opendaylight.yangtools.yang.common.RpcResult; +import org.opendaylight.yangtools.yang.common.RpcResultBuilder; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * Defines a base implementation for your provider. This class overrides the generated interface + * from the YANG model and implements the request model for the A1 interface. This class identifies + * the Near-RT RIC throught the IP passed over the payload and calls the corresponding Near-RT RIC + * over Rest API + * + * 
+ *
+ */
+@SuppressWarnings("squid:S1874") // "@Deprecated" code should not be used
+public class A1AdapterProvider implements AutoCloseable, A1ADAPTERAPIService {
+
+  private static final Logger log = LoggerFactory.getLogger(A1AdapterProvider.class);
+
+  private static final String APPLICATION_NAME = "a1Adapter-api";
+
+  private final ExecutorService executor;
+  protected DataBroker dataBroker;
+  protected NotificationPublishService notificationService;
+  protected RpcProviderRegistry rpcRegistry;
+  protected BindingAwareBroker.RpcRegistration rpcRegistration;
+  private final A1AdapterClient a1AdapterClient;
+
+  public A1AdapterProvider(final DataBroker dataBroker,
+      final NotificationPublishService notificationPublishService,
+      final RpcProviderRegistry rpcProviderRegistry, final A1AdapterClient a1AdapterClient) {
+
+    log.info("Creating provider for {}", APPLICATION_NAME);
+    executor = Executors.newFixedThreadPool(1);
+    this.dataBroker = dataBroker;
+    this.notificationService = notificationPublishService;
+    this.rpcRegistry = rpcProviderRegistry;
+    this.a1AdapterClient = a1AdapterClient;
+    initialize();
+  }
+
+  public void initialize() {
+    log.info("Initializing provider for {}", APPLICATION_NAME);
+    rpcRegistration = rpcRegistry.addRpcImplementation(A1ADAPTERAPIService.class, this);
+    log.info("Initialization complete for {}", APPLICATION_NAME);
+  }
+
+  protected void initializeChild() {
+    // Override if you have custom initialization intelligence
+  }
+
+  @Override
+  public void close() throws Exception {
+    log.info("Closing provider for {}", APPLICATION_NAME);
+    executor.shutdown();
+    rpcRegistration.close();
+    log.info("Successfully closed provider for {}", APPLICATION_NAME);
+  }
+
+  @Override
+  public ListenableFuture> deleteA1Policy(
+      DeleteA1PolicyInput input) {
+    // TODO Auto-generated method stub
+    return null;
+  }
+
+  @Override
+  public ListenableFuture> getA1Policy(GetA1PolicyInput input) {
+    log.info("Start of getA1Policy");
+    return null;
+  }
+
+  @Override
+  public ListenableFuture> getA1PolicyStatus(
+      GetA1PolicyStatusInput input) {
+    // TODO Auto-generated method stub
+    return null;
+  }
+
+  @Override
+  public ListenableFuture> getA1PolicyType(
+      GetA1PolicyTypeInput input) {
+    log.info("Start of getA1PolicyType");
+    final String svcOperation = "getA1PolicyType";
+    Properties parms = new Properties();
+    GetA1PolicyTypeOutputBuilder policyTypeResponse = new GetA1PolicyTypeOutputBuilder();
+    // add input to parms
+    log.info("Adding INPUT data for " + svcOperation + " input: " + input);
+    GetA1PolicyTypeInputBuilder inputBuilder = new GetA1PolicyTypeInputBuilder(input);
+    MdsalHelper.toProperties(parms, inputBuilder.build());
+    log.info("Printing SLI parameters to be passed");
+    // iterate properties file to get key-value pairs
+    for (String key : parms.stringPropertyNames()) {
+      String value = parms.getProperty(key);
+      log.info("The SLI parameter in " + key + " is: " + value);
+    }
+    // Call SLI sync method
+    try {
+      if (a1AdapterClient.hasGraph("A1-ADAPTER-API", svcOperation, null, "sync")) {
+        log.info("A1AdapterClient has a Directed Graph for '" + svcOperation + "'");
+        try {
+          a1AdapterClient.execute("A1-ADAPTER-API", svcOperation, null, "sync", policyTypeResponse,
+              parms);
+          policyTypeResponse.setHttpStatus(200);
+        } catch (Exception e) {
+          log.error("Caught exception executing service logic for " + svcOperation, e);
+          policyTypeResponse.setHttpStatus(500);
+        }
+      } else {
+        log.error("No service logic active for A1Adapter: '" + svcOperation + "'");
+        policyTypeResponse.setHttpStatus(503);
+      }
+    } catch (Exception e) {
+      log.error("Caught exception looking for service logic", e);
+      policyTypeResponse.setHttpStatus(500);
+    }
+    RpcResult rpcResult = RpcResultBuilder
+        .status(true).withResult(policyTypeResponse.build()).build();
+    log.info("End of getA1PolicyType");
+    return Futures.immediateFuture(rpcResult);
+  }
+
+  @Override
+  public ListenableFuture> putA1Policy(PutA1PolicyInput input) {
+    // TODO Auto-generated method stub
+    return null;
+  }
+
+}
diff --git a/a1-adapter/a1-adapter-api/provider/src/main/resources/OSGI-INF/blueprint/impl-blueprint.xml b/a1-adapter/a1-adapter-api/provider/src/main/resources/OSGI-INF/blueprint/impl-blueprint.xml
new file mode 100644
index 00000000..29403607
--- /dev/null
+++ b/a1-adapter/a1-adapter-api/provider/src/main/resources/OSGI-INF/blueprint/impl-blueprint.xml
@@ -0,0 +1,50 @@
+
+
+
+
+
+    
+
+    
+        
+    
+
+    
+
+    
+
+    
+
+    
+        
+        
+        
+        
+    
+
+
diff --git a/a1-adapter/a1-adapter-api/provider/src/main/resources/org/opendaylight/blueprint/impl-blueprint.xml b/a1-adapter/a1-adapter-api/provider/src/main/resources/org/opendaylight/blueprint/impl-blueprint.xml
new file mode 100644
index 00000000..29403607
--- /dev/null
+++ b/a1-adapter/a1-adapter-api/provider/src/main/resources/org/opendaylight/blueprint/impl-blueprint.xml
@@ -0,0 +1,50 @@
+
+
+
+
+
+    
+
+    
+        
+    
+
+    
+
+    
+
+    
+
+    
+        
+        
+        
+        
+    
+
+
diff --git a/a1-adapter/a1-adapter-api/provider/src/test/java/org/onap/ccsdk/features/a1/adapter/A1AdapterProviderTest.java b/a1-adapter/a1-adapter-api/provider/src/test/java/org/onap/ccsdk/features/a1/adapter/A1AdapterProviderTest.java
new file mode 100644
index 00000000..901bc008
--- /dev/null
+++ b/a1-adapter/a1-adapter-api/provider/src/test/java/org/onap/ccsdk/features/a1/adapter/A1AdapterProviderTest.java
@@ -0,0 +1,101 @@
+/*-
+ * ============LICENSE_START=======================================================
+ *  Copyright (C) 2020 Nordix Foundation.
+ * ================================================================================
+ * 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.ccsdk.features.a1.adapter;
+
+import static org.junit.Assert.assertEquals;
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.ArgumentMatchers.eq;
+import static org.mockito.Mockito.when;
+import com.google.common.util.concurrent.ListenableFuture;
+import java.util.Properties;
+import java.util.concurrent.ExecutionException;
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.Mock;
+import org.mockito.Mockito;
+import org.mockito.junit.MockitoJUnitRunner;
+import org.onap.ccsdk.sli.core.sli.SvcLogicException;
+import org.opendaylight.controller.md.sal.binding.api.DataBroker;
+import org.opendaylight.controller.md.sal.binding.api.NotificationPublishService;
+import org.opendaylight.controller.sal.binding.api.RpcProviderRegistry;
+import org.opendaylight.yang.gen.v1.org.onap.a1.adapter.rev200122.GetA1PolicyTypeInputBuilder;
+import org.opendaylight.yang.gen.v1.org.onap.a1.adapter.rev200122.GetA1PolicyTypeOutput;
+import org.opendaylight.yang.gen.v1.org.onap.a1.adapter.rev200122.GetA1PolicyTypeOutputBuilder;
+import org.opendaylight.yangtools.yang.common.RpcResult;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * This class Tests all the methods in A1AdapterProvider
+ *
+ */
+
+@RunWith(MockitoJUnitRunner.Silent.class)
+public class A1AdapterProviderTest {
+
+  protected static final Logger LOG = LoggerFactory.getLogger(A1AdapterProviderTest.class);
+
+  class A1AdapterProviderMock extends A1AdapterProvider {
+
+    A1AdapterProviderMock(final DataBroker dataBroker,
+        final NotificationPublishService notificationPublishService,
+        final RpcProviderRegistry rpcProviderRegistry, final A1AdapterClient A1AdapterClient) {
+      super(dataBroker, mockNotificationPublishService, mockRpcProviderRegistry, a1AdapterClient);
+    }
+
+  }
+
+  private A1AdapterProviderMock a1AdapterProviderMock = null;
+  @Mock
+  private DataBroker dataBroker;
+  @Mock
+  private NotificationPublishService mockNotificationPublishService;
+  @Mock
+  private RpcProviderRegistry mockRpcProviderRegistry;
+  @Mock
+  private A1AdapterClient a1AdapterClient;
+  private static String module = "A1-ADAPTER-API";
+  private static String mode = "sync";
+
+  @Before
+  public void setUp() throws Exception {
+
+    a1AdapterProviderMock = new A1AdapterProviderMock(dataBroker, mockNotificationPublishService,
+        mockRpcProviderRegistry, a1AdapterClient);
+    a1AdapterProviderMock = Mockito.spy(a1AdapterProviderMock);
+
+  }
+
+  @Test
+  public void test_getA1PolicyType()
+      throws SvcLogicException, InterruptedException, ExecutionException {
+    String rpc = "getA1PolicyType";
+    Properties respProps = new Properties();
+    GetA1PolicyTypeInputBuilder inputBuilder = new GetA1PolicyTypeInputBuilder();
+    when(a1AdapterClient.hasGraph(module, rpc, null, mode)).thenReturn(true);
+    when(a1AdapterClient.execute(eq(module), eq(rpc), eq(null), eq(mode),
+        any(GetA1PolicyTypeOutputBuilder.class), any(Properties.class))).thenReturn(respProps);
+    ListenableFuture> result =
+        a1AdapterProviderMock.getA1PolicyType(inputBuilder.build());
+    assertEquals("200", String.valueOf(result.get().getResult().getHttpStatus()));
+  }
+}
-- 
cgit 1.2.3-korg