New partitions cli option for displaying client information

Change-Id: Iba0a9f7ea809368bf0965b44d8ff60e7486ee3d8

@@ -18,7 +18,13 @@ package org.onosproject.cli.net;
 import java.util.List;
 
 import org.apache.karaf.shell.commands.Command;
+import org.apache.karaf.shell.commands.Option;
 import org.onosproject.cli.AbstractShellCommand;
+import org.onosproject.cluster.ClusterService;
+import org.onosproject.cluster.ControllerNode;
+import org.onosproject.cluster.NodeId;
+import org.onosproject.store.primitives.PartitionAdminService;
+import org.onosproject.store.service.PartitionClientInfo;
 import org.onosproject.store.service.PartitionInfo;
 import org.onosproject.store.service.StorageAdminService;
 
@@ -35,7 +41,13 @@ import com.google.common.collect.Ordering;
         description = "Lists information about partitions in the system")
 public class PartitionsListCommand extends AbstractShellCommand {
 
-    private static final String FMT = "%-20s %8s %25s %s";
+    @Option(name = "-c", aliases = "--clients",
+            description = "Show inforamtion about partition clients",
+            required = false, multiValued = false)
+    private boolean reportClientInfo = false;
+
+    private static final String SERVER_FMT = "%-20s %8s %25s %s";
+    private static final String CLIENT_FMT = "%-20s %8s %10s %25s";
 
     /**
      * Displays partition info as text.
@@ -47,18 +59,18 @@ public class PartitionsListCommand extends AbstractShellCommand {
             return;
         }
         print("----------------------------------------------------------");
-        print(FMT, "Name", "Term", "Members", "");
+        print(SERVER_FMT, "Name", "Term", "Members", "");
         print("----------------------------------------------------------");
 
         for (PartitionInfo info : partitionInfo) {
             boolean first = true;
             for (String member : Ordering.natural().sortedCopy(info.members())) {
                 if (first) {
-                    print(FMT, info.name(), info.term(), member,
+                    print(SERVER_FMT, info.name(), info.term(), member,
                             member.equals(info.leader()) ? "*" : "");
                     first = false;
                 } else {
-                    print(FMT, "", "", member,
+                    print(SERVER_FMT, "", "", member,
                             member.equals(info.leader()) ? "*" : "");
                 }
             }
@@ -69,6 +81,39 @@ public class PartitionsListCommand extends AbstractShellCommand {
     }
 
     /**
+     * Displays partition client info as text.
+     *
+     * @param partitionClientInfo partition client information
+     */
+    private void displayPartitionClients(List<PartitionClientInfo> partitionClientInfo) {
+        if (partitionClientInfo.isEmpty()) {
+            return;
+        }
+        ClusterService clusterService = get(ClusterService.class);
+        print("-------------------------------------------------------------------");
+        print(CLIENT_FMT, "Name", "SessionId", "Status", "Servers");
+        print("-------------------------------------------------------------------");
+
+        for (PartitionClientInfo info : partitionClientInfo) {
+            boolean first = true;
+            for (NodeId serverId : Ordering.natural().sortedCopy(info.servers())) {
+                ControllerNode server = clusterService.getNode(serverId);
+                String serverString = String.format("%s:%d", server.id(), server.tcpPort());
+                if (first) {
+                    print(CLIENT_FMT, info.partitionId(), info.sessionId(),
+                            info.status(), serverString);
+                    first = false;
+                } else {
+                    print(CLIENT_FMT, "", "", "", serverString);
+                }
+            }
+            if (!first) {
+                print("-------------------------------------------------------------------");
+            }
+        }
+    }
+
+    /**
      * Converts partition info into a JSON object.
      *
      * @param partitionInfo partition descriptions
@@ -99,15 +144,58 @@ public class PartitionsListCommand extends AbstractShellCommand {
         return partitions;
     }
 
+    /**
+     * Converts partition client info into a JSON object.
+     *
+     * @param partitionClientInfo partition client descriptions
+     */
+    private JsonNode jsonForClientInfo(List<PartitionClientInfo> partitionClientInfo) {
+        ObjectMapper mapper = new ObjectMapper();
+        ArrayNode partitions = mapper.createArrayNode();
+        ClusterService clusterService = get(ClusterService.class);
+
+        // Create a JSON node for each partition client
+        partitionClientInfo.stream()
+            .forEach(info -> {
+                ObjectNode partition = mapper.createObjectNode();
+
+                // Add each member to the "servers" array for this partition
+                ArrayNode servers = partition.putArray("servers");
+                info.servers()
+                        .stream()
+                        .map(clusterService::getNode)
+                        .map(node -> String.format("%s:%d", node.ip(), node.tcpPort()))
+                        .forEach(servers::add);
+
+                // Complete the partition attributes and add it to the array
+                partition.put("partitionId", info.partitionId().toString())
+                         .put("sessionId", info.sessionId())
+                         .put("status", info.status().toString());
+                partitions.add(partition);
+
+            });
+
+        return partitions;
+    }
+
     @Override
     protected void execute() {
         StorageAdminService storageAdminService = get(StorageAdminService.class);
+        if (reportClientInfo) {
+            PartitionAdminService partitionAdminService = get(PartitionAdminService.class);
+            List<PartitionClientInfo> partitionClientInfo = partitionAdminService.partitionClientInfo();
+            if (outputJson()) {
+                print("%s", jsonForClientInfo(partitionClientInfo));
+            } else {
+                displayPartitionClients(partitionClientInfo);
+            }
+        } else {
             List<PartitionInfo> partitionInfo = storageAdminService.getPartitionInfo();
-
             if (outputJson()) {
                 print("%s", json(partitionInfo));
             } else {
                 displayPartitions(partitionInfo);
             }
         }
+    }
 }

@@ -17,6 +17,7 @@ package org.onosproject.store.primitives;
 
 import java.util.List;
 
+import org.onosproject.store.service.PartitionClientInfo;
 import org.onosproject.store.service.PartitionInfo;
 
 /**
@@ -29,4 +30,10 @@ public interface PartitionAdminService {
      * @return list of {@code PartitionInfo}
      */
     List<PartitionInfo> partitionInfo();
+
+    /**
+     * Returns the {@link PartitionClientInfo information} for partition clients.
+     * @return list of {@code PartitionClientInfo}
+     */
+    List<PartitionClientInfo> partitionClientInfo();
 }
\ No newline at end of file

+/*
+ * Copyright 2016-present Open Networking Laboratory
+ *
+ * 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.
+ */
+package org.onosproject.store.service;
+
+import java.util.Collection;
+
+import org.onosproject.cluster.NodeId;
+import org.onosproject.cluster.PartitionId;
+import org.onosproject.store.service.DistributedPrimitive.Status;
+
+import com.google.common.collect.ImmutableList;
+
+import static com.google.common.base.Preconditions.checkNotNull;
+
+/**
+ * Contains information about a database partition client.
+ */
+public class PartitionClientInfo {
+    private final PartitionId partitionId;
+    private final Status status;
+    private final Collection<NodeId> servers;
+    private final long sessionId;
+
+    public PartitionClientInfo(PartitionId partitionId, Collection<NodeId> servers, long sessionId, Status status) {
+        this.partitionId = checkNotNull(partitionId);
+        this.servers = ImmutableList.copyOf(checkNotNull(servers));
+        this.sessionId = sessionId;
+        this.status = checkNotNull(status);
+    }
+
+    /**
+     * Returns the identifier for the partition.
+     *
+     * @return partition id
+     */
+    public PartitionId partitionId() {
+        return partitionId;
+    }
+
+    /**
+     * Returns the collection of servers that are members of the partition.
+     *
+     * @return active members of the partition
+     */
+    public Collection<NodeId> servers() {
+        return servers;
+    }
+
+    /**
+     * Return the sessionId for the partition client.
+     * @return session id
+     */
+    public long sessionId() {
+        return sessionId;
+    }
+
+    /**
+     * Returns the current status for the client session.
+     * @return status
+     */
+    public Status status() {
+        return status;
+    }
+}

@@ -49,6 +49,7 @@ import org.onosproject.store.primitives.PartitionAdminService;
 import org.onosproject.store.primitives.PartitionEvent;
 import org.onosproject.store.primitives.PartitionEventListener;
 import org.onosproject.store.primitives.PartitionService;
+import org.onosproject.store.service.PartitionClientInfo;
 import org.onosproject.store.service.PartitionInfo;
 import org.slf4j.Logger;
 
@@ -176,4 +177,13 @@ public class PartitionManager extends AbstractListenerManager<PartitionEvent, Pa
             processMetadataUpdate(event.subject());
         }
     }
+
+    @Override
+    public List<PartitionClientInfo> partitionClientInfo() {
+        return partitions.values()
+                         .stream()
+                         .map(StoragePartition::client)
+                         .map(StoragePartitionClient::clientInfo)
+                         .collect(Collectors.toList());
+    }
 }

@@ -53,6 +53,7 @@ import org.onosproject.store.service.AsyncDistributedSet;
 import org.onosproject.store.service.AsyncLeaderElector;
 import org.onosproject.store.service.DistributedPrimitive.Status;
 import org.onosproject.store.service.DistributedQueue;
+import org.onosproject.store.service.PartitionClientInfo;
 import org.onosproject.store.service.Serializer;
 import org.slf4j.Logger;
 
@@ -190,6 +191,17 @@ public class StoragePartitionClient implements DistributedPrimitiveCreator, Mana
         return client.isOpen();
     }
 
+    /**
+     * Returns the {@link PartitionClientInfo information} for this client.
+     * @return partition client information
+     */
+    public PartitionClientInfo clientInfo() {
+        return new PartitionClientInfo(partition.getId(),
+                partition.getMembers(),
+                copycatClient.session().id(),
+                mapper.apply(copycatClient.state()));
+    }
+
     private CopycatClient newCopycatClient(Collection<Address> members,
                                            Transport transport,
                                            io.atomix.catalyst.serializer.Serializer serializer,