devicemanager-core refactoring and support for TLS mountpoints using data-provider interface

Use NodeId instead of String for mountpointname and enhance data-provider for creation of TLS mountpoints using REST or from the UI

Issue-ID: CCSDK-3403
Signed-off-by: Ravi Pendurty <ravi.pendurty@highstreet-technologies.com>
Change-Id: Iafb9fe81c2e1d1152beef2b86299edb78a870d85
Signed-off-by: Ravi Pendurty <ravi.pendurty@highstreet-technologies.com>

4 files changed, 282 insertions, 6 deletions

diff --git a/sdnr/wt/data-provider/model/pom.xml b/sdnr/wt/data-provider/model/pom.xml
index 15eeccef7..6a193a423 100644
--- a/sdnr/wt/data-provider/model/pom.xml
+++ b/sdnr/wt/data-provider/model/pom.xml
@@ -56,17 +56,17 @@
             <artifactId>openroadm-pm-types</artifactId>
             <version>${project.version}</version>
         </dependency>
-         <dependency>
-            <groupId>org.opendaylight.netconf</groupId>
-            <artifactId>sal-netconf-connector</artifactId>
-            <scope>provided</scope>
-        </dependency>
         <dependency>
             <groupId>${project.groupId}</groupId>
             <artifactId>sdnr-wt-common</artifactId>
             <version>${project.version}</version>
         </dependency>
         <dependency>
+            <groupId>org.opendaylight.netconf</groupId>
+            <artifactId>sal-netconf-connector</artifactId>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
             <groupId>com.fasterxml.jackson.core</groupId>
             <artifactId>jackson-databind</artifactId>
         </dependency>
diff --git a/sdnr/wt/data-provider/model/src/main/yang/data-provider@2020-11-10.yang b/sdnr/wt/data-provider/model/src/main/yang/data-provider@2020-11-10.yang
index 31c7fd875..be2c638e2 100644
--- a/sdnr/wt/data-provider/model/src/main/yang/data-provider@2020-11-10.yang
+++ b/sdnr/wt/data-provider/model/src/main/yang/data-provider@2020-11-10.yang
@@ -195,7 +195,7 @@ module data-provider {
         description
           "implements sth. like o-ran*.yang";
       }
-      enum ORAN {
+      enum O-RAN {
         description
           "implements RAN according to o-ran*.yang";
       }
@@ -1253,6 +1253,11 @@ module data-provider {
       description
         "categorized type of device based on implemented yang specs";
     }
+    leaf device-function {
+      type string;
+      description
+            "specifies the RAN functions supported by the device";
+    }
     leaf is-required {
       type boolean;
       description
@@ -1273,6 +1278,11 @@ module data-provider {
       description
         "TLS key-id in MD-SAL";
     }
+    leaf mount-method {
+      type string;
+      description
+        "netconf-node credential type for mount";
+    }
     description
       "An object class defining the NetConf connection towards a
        NetConf server. ";
@@ -1897,4 +1907,23 @@ module data-provider {
         }
       }
     }
+  rpc read-tls-key-entry {
+      description
+        "Get tls-keys of netconf-keystore";
+      input {
+        uses entity-input;
+      }
+      output {
+        container pagination {
+          uses pagination-output-g;
+          description
+            "The pagination details used by the provider to filter the data.";
+        }
+        leaf-list data {
+          type string;
+          description
+            "The output data as list of tls-keys in netconf-keystore";
+        }
+      }
+    }
 }
diff --git a/sdnr/wt/data-provider/provider/src/main/java/org/onap/ccsdk/features/sdnr/wt/dataprovider/impl/DataProviderServiceImpl.java b/sdnr/wt/data-provider/provider/src/main/java/org/onap/ccsdk/features/sdnr/wt/dataprovider/impl/DataProviderServiceImpl.java
index ad712847f..2bf67fde9 100644
--- a/sdnr/wt/data-provider/provider/src/main/java/org/onap/ccsdk/features/sdnr/wt/dataprovider/impl/DataProviderServiceImpl.java
+++ b/sdnr/wt/data-provider/provider/src/main/java/org/onap/ccsdk/features/sdnr/wt/dataprovider/impl/DataProviderServiceImpl.java
@@ -95,12 +95,17 @@ import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.pro
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.ReadPmdata24hLtpListOutput;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.ReadStatusInput;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.ReadStatusOutput;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.ReadTlsKeyEntryInput;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.ReadTlsKeyEntryOutput;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.ReadTlsKeyEntryOutputBuilder;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.UpdateMaintenanceInput;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.UpdateMaintenanceOutput;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.UpdateMediatorServerInput;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.UpdateMediatorServerOutput;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.UpdateNetworkElementConnectionInput;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.UpdateNetworkElementConnectionOutput;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.read.tls.key.entry.output.Pagination;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.read.tls.key.entry.output.PaginationBuilder;
 import org.opendaylight.yangtools.concepts.Builder;
 import org.opendaylight.yangtools.concepts.ObjectRegistration;
 import org.opendaylight.yangtools.yang.binding.DataObject;
@@ -119,6 +124,8 @@ public class DataProviderServiceImpl implements DataProviderService, AutoCloseab
     public static final String CONFIGURATIONFILE = "etc/dataprovider.properties";
     private static final long DATABASE_TIMEOUT_MS = 120 * 1000L;
     private static final @NonNull InstanceIdentifier<Keystore> KEYSTORE_IIF = InstanceIdentifier.create(Keystore.class);
+    private static final Pagination EMPTY_PAGINATION = new PaginationBuilder().setSize(Uint32.valueOf(20))
+            .setTotal(Uint64.valueOf(0)).setPage(Uint64.valueOf(1)).build();
     private static final long DEFAULT_PAGESIZE = 20;
     private static final long DEFAULT_PAGE = 1;
 
@@ -407,6 +414,45 @@ public class DataProviderServiceImpl implements DataProviderService, AutoCloseab
         return result.buildFuture();
     }
 
+    @Override
+    public ListenableFuture<RpcResult<ReadTlsKeyEntryOutput>> readTlsKeyEntry(ReadTlsKeyEntryInput input) {
+        LOG.debug("RPC Request: readTlsKeyEntry with input {}", input);
+        RpcResultBuilder<ReadTlsKeyEntryOutput> result = read(() -> DataProviderServiceImpl.this.readTlsKeys(input));
+        return result.buildFuture();
+    }
+
+    // -- private classes and functions
+
+    private ReadTlsKeyEntryOutputBuilder readTlsKeys(ReadTlsKeyEntryInput input) {
+        Optional<Keystore> result = Optional.empty();
+        try {
+            result = this.dataBroker.newReadOnlyTransaction().read(LogicalDatastoreType.CONFIGURATION, KEYSTORE_IIF)
+                    .get();
+        } catch (InterruptedException | ExecutionException e) {
+            LOG.warn("problem reading netconf-keystore: ", e);
+        }
+        ReadTlsKeyEntryOutputBuilder output = new ReadTlsKeyEntryOutputBuilder();
+        if (result.isEmpty()) {
+            return output.setData(Arrays.asList()).setPagination(EMPTY_PAGINATION);
+        }
+        Map<KeyCredentialKey, KeyCredential> keyCredential = result.get().getKeyCredential();
+        if (keyCredential == null) {
+            return output.setData(Arrays.asList()).setPagination(EMPTY_PAGINATION);
+        }
+        long pageNum = input.getPagination() == null ? DEFAULT_PAGE
+                : input.getPagination().getPage() == null ? DEFAULT_PAGE : input.getPagination().getPage().longValue();
+        long size = input.getPagination() == null ? DEFAULT_PAGESIZE
+                : input.getPagination().getSize() == null ? DEFAULT_PAGESIZE
+                        : input.getPagination().getSize().longValue();
+        long from = pageNum > 0 ? (pageNum - 1) * size : 0;
+        output.setData(keyCredential.keySet().stream().skip(from).limit(size).map(e -> e.getKeyId())
+                .collect(Collectors.toList()));
+        output.setPagination(new PaginationBuilder().setPage(Uint64.valueOf(pageNum))
+                .setSize(Uint32.valueOf(output.getData().size())).setTotal(Uint64.valueOf(keyCredential.size()))
+                .build());
+        return output;
+    }
+
     private static String assembleExceptionMessage(Exception e) {
         StringWriter sw = new StringWriter();
         PrintWriter pw = new PrintWriter(sw);
diff --git a/sdnr/wt/data-provider/provider/src/test/java/org/onap/ccsdk/features/sdnr/wt/dataprovider/test/TestGetTlsKeys.java b/sdnr/wt/data-provider/provider/src/test/java/org/onap/ccsdk/features/sdnr/wt/dataprovider/test/TestGetTlsKeys.java
new file mode 100644
index 000000000..610f5476c
--- /dev/null
+++ b/sdnr/wt/data-provider/provider/src/test/java/org/onap/ccsdk/features/sdnr/wt/dataprovider/test/TestGetTlsKeys.java
@@ -0,0 +1,201 @@
+/*
+ * ============LICENSE_START=======================================================
+ * ONAP : ccsdk features
+ * ================================================================================
+ * Copyright (C) 2021 highstreet technologies GmbH Intellectual Property.
+ * 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.ccsdk.features.sdnr.wt.dataprovider.test;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.fail;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
+import com.google.common.util.concurrent.FluentFuture;
+import java.io.File;
+import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.StandardOpenOption;
+import java.util.Optional;
+import java.util.concurrent.ExecutionException;
+import org.eclipse.jdt.annotation.NonNull;
+import org.junit.AfterClass;
+import org.junit.BeforeClass;
+import org.junit.Test;
+import org.onap.ccsdk.features.sdnr.wt.dataprovider.http.MsServlet;
+import org.onap.ccsdk.features.sdnr.wt.dataprovider.impl.DataProviderServiceImpl;
+import org.onap.ccsdk.features.sdnr.wt.dataprovider.test.util.HostInfoForTest;
+import org.onap.ccsdk.features.sdnr.wt.yang.mapper.YangToolsMapper;
+import org.opendaylight.mdsal.binding.api.DataBroker;
+import org.opendaylight.mdsal.binding.api.ReadTransaction;
+import org.opendaylight.mdsal.binding.api.RpcProviderService;
+import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.keystore.rev171017.Keystore;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.ReadTlsKeyEntryInput;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.ReadTlsKeyEntryInputBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.ReadTlsKeyEntryOutput;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.entity.input.Pagination;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.entity.input.PaginationBuilder;
+import org.opendaylight.yangtools.util.concurrent.FluentFutures;
+import org.opendaylight.yangtools.yang.binding.DataObject;
+import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
+import org.opendaylight.yangtools.yang.common.RpcResult;
+import org.opendaylight.yangtools.yang.common.Uint32;
+import org.opendaylight.yangtools.yang.common.Uint64;
+
+public class TestGetTlsKeys {
+
+    private static final int DBPORT = HostInfoForTest.get()[0].port;
+    private static RpcProviderService rpcProviderService = mock(RpcProviderService.class);
+    private static MsServlet msServlet = mock(MsServlet.class);
+    private static DataBroker dataBroker = mock(DataBroker.class);
+    private static DataProviderServiceImpl dataProvider = null;
+
+    @BeforeClass
+    public static void init() {
+        String configContent = "[es]\n" + "esHosts=" + String.format("http://localhost:%d", DBPORT) + "\n"
+                + "esArchiveLifetimeSeconds=2592000\n" + "esCluster=\n" + "esArchiveCheckIntervalSeconds=0\n"
+                + "esNode=elasticsearchnode\n" + "esAuthUsername=${SDNRDBUSERNAME}\n"
+                + "esAuthPassword=${SDNRDBPASSWORD}\n" + "esTrustAllCerts=${SDNRDBTRUSTALLCERTS}\n" + "";
+        try {
+            finish();
+            Files.createDirectories(new File("etc").toPath());
+            Files.write(new File(DataProviderServiceImpl.CONFIGURATIONFILE).toPath(), configContent.getBytes(),
+                    StandardOpenOption.WRITE, StandardOpenOption.CREATE_NEW);
+        } catch (IOException e) {
+            e.printStackTrace();
+            fail(e.getMessage());
+        }
+
+        when(dataBroker.newReadOnlyTransaction())
+                .thenReturn(new ReadHelperTransaction("src/test/resources/tlskeys/keys1.json", Keystore.class));
+        try {
+            dataProvider = new DataProviderServiceImpl(rpcProviderService, msServlet, dataBroker);
+        } catch (Exception e) {
+            e.printStackTrace();
+            fail(e.getMessage());
+        }
+
+    }
+
+    @AfterClass
+    public static void finish() {
+        File f = new File(DataProviderServiceImpl.CONFIGURATIONFILE);
+        if (f.exists()) {
+            f.delete();
+        }
+        File folder = new File("etc");
+        if (folder.exists()) {
+            folder.delete();
+        }
+    }
+
+    @Test
+    public void test() {
+         Pagination pagination = new PaginationBuilder().setPage(Uint64.valueOf(1)).setSize(Uint32.valueOf(20)).build();
+        ReadTlsKeyEntryInput firstPageInput = new ReadTlsKeyEntryInputBuilder().setPagination(pagination).build();
+        RpcResult<ReadTlsKeyEntryOutput> output = null;
+        try {
+            output = dataProvider.readTlsKeyEntry(firstPageInput).get();
+        } catch (InterruptedException | ExecutionException e) {
+            fail(e.getMessage());
+        }
+        ReadTlsKeyEntryOutput result = output.getResult();
+        assertEquals(4,result.getPagination().getTotal().longValue());
+        assertEquals(4, result.getData().size());
+        assertEquals(1, result.getPagination().getPage().longValue());
+        assertEquals(4, result.getPagination().getSize().longValue());
+    }
+    @Test
+    public void test2() {
+         Pagination pagination = new PaginationBuilder().setPage(Uint64.valueOf(1)).setSize(Uint32.valueOf(2)).build();
+        ReadTlsKeyEntryInput firstPageInput = new ReadTlsKeyEntryInputBuilder().setPagination(pagination).build();
+        RpcResult<ReadTlsKeyEntryOutput> output = null;
+        try {
+            output = dataProvider.readTlsKeyEntry(firstPageInput).get();
+        } catch (InterruptedException | ExecutionException e) {
+            fail(e.getMessage());
+        }
+        ReadTlsKeyEntryOutput result = output.getResult();
+        assertEquals(4,result.getPagination().getTotal().longValue());
+        assertEquals(2, result.getData().size());
+        assertEquals(1, result.getPagination().getPage().longValue());
+        assertEquals(2, result.getPagination().getSize().longValue());
+    }
+
+    @Test
+    public void test3() {
+         Pagination pagination = new PaginationBuilder().setPage(Uint64.valueOf(2)).setSize(Uint32.valueOf(3)).build();
+        ReadTlsKeyEntryInput firstPageInput = new ReadTlsKeyEntryInputBuilder().setPagination(pagination).build();
+        RpcResult<ReadTlsKeyEntryOutput> output = null;
+        try {
+            output = dataProvider.readTlsKeyEntry(firstPageInput).get();
+        } catch (InterruptedException | ExecutionException e) {
+            fail(e.getMessage());
+        }
+        ReadTlsKeyEntryOutput result = output.getResult();
+        assertEquals(4,result.getPagination().getTotal().longValue());
+        assertEquals(1, result.getData().size());
+        assertEquals(2, result.getPagination().getPage().longValue());
+        assertEquals(1, result.getPagination().getSize().longValue());
+    }
+
+    private static class ReadHelperTransaction implements ReadTransaction {
+        private final String filename;
+        private final YangToolsMapper mapper;
+        private final Class<?> clazz;
+
+        public ReadHelperTransaction(String filename, Class<?> clazz) {
+            this.filename = filename;
+            this.clazz = clazz;
+            this.mapper = new YangToolsMapper();
+        }
+
+        @Override
+        public @NonNull Object getIdentifier() {
+            // TODO Auto-generated method stub
+            return null;
+        }
+
+        @SuppressWarnings("unchecked")
+        @Override
+        public <T extends DataObject> @NonNull FluentFuture<Optional<T>> read(@NonNull LogicalDatastoreType store,
+                @NonNull InstanceIdentifier<T> path) {
+
+            T result = null;
+            try {
+                result = (T) this.mapper.readValue(new File(filename), this.clazz);
+            } catch (IOException e) {
+                return FluentFutures.immediateFluentFuture(Optional.empty());
+            }
+            return FluentFutures.immediateFluentFuture(Optional.of(result));
+        }
+
+        @Override
+        public @NonNull FluentFuture<Boolean> exists(@NonNull LogicalDatastoreType store,
+                @NonNull InstanceIdentifier<?> path) {
+            // TODO Auto-generated method stub
+            return null;
+        }
+
+        @Override
+        public void close() {
+            // TODO Auto-generated method stub
+
+        }
+    }
+}