nfs4: add FileTracker#getDelegations method

a method that might be used to list current delegations.

Acked-by: Paul Millar
Target: master

Author: kofemann

core/src/main/java/org/dcache/nfs/v4/FileTracker.java

@@ -572,4 +572,19 @@ public Map<Inode, Collection<NFS4Client>> getOpenFiles() {
                     e -> e.getValue().stream().map(OpenState::getClient).collect(Collectors.toSet()))
               );
     }
+
+
+    /**
+     * Get all currently issued delegations. The resulting map contains file's inodes
+     * as key and collection of nfs clients that hold the delegation as a value.
+     *
+     * @return map of all currently issued delegations.
+     */
+    public Map<Inode, Collection<NFS4Client>> getDelegations() {
+        return delegations.entrySet().stream()
+                .collect(Collectors.toMap(
+                        e -> Inode.forFile(e.getKey().getOpaque()),
+                        e -> e.getValue().stream().map(DelegationState::client).collect(Collectors.toSet()))
+                );
+    }
 }

core/src/test/java/org/dcache/nfs/v4/FileTrackerTest.java

@@ -19,26 +19,35 @@
  */
 package org.dcache.nfs.v4;
 
+import java.net.UnknownHostException;
 import java.nio.charset.StandardCharsets;
+
+import org.dcache.nfs.ChimeraNFSException;
 import org.dcache.nfs.status.BadStateidException;
 import org.dcache.nfs.status.DelayException;
 import org.dcache.nfs.status.InvalException;
 import org.dcache.nfs.status.ShareDeniedException;
-import org.dcache.nfs.v4.xdr.nfs4_prot;
+import org.hamcrest.Matchers;
 import org.junit.Before;
 import org.junit.Test;
 
 import org.dcache.nfs.v4.xdr.nfs_fh4;
 import org.dcache.nfs.vfs.Inode;
 
-import static org.junit.Assert.*;
+import static org.dcache.nfs.v4.xdr.nfs4_prot.OPEN4_SHARE_ACCESS_WANT_READ_DELEG;
 import static org.dcache.nfs.v4.NfsTestUtils.createClient;
 import static org.dcache.nfs.v4.NfsTestUtils.generateFileHandle;
 
 import static org.dcache.nfs.v4.xdr.nfs4_prot.OPEN4_SHARE_ACCESS_READ;
 import static org.dcache.nfs.v4.xdr.nfs4_prot.OPEN4_SHARE_ACCESS_WRITE;
 import static org.dcache.nfs.v4.xdr.nfs4_prot.OPEN4_SHARE_ACCESS_BOTH;
 import static org.dcache.nfs.v4.xdr.nfs4_prot.OPEN4_SHARE_ACCESS_WANT_NO_DELEG;
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertNotEquals;
+import static org.junit.Assert.assertTrue;
+import static org.junit.Assert.fail;
 import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.ArgumentMatchers.anyBoolean;
 import static org.mockito.Mockito.mock;
@@ -216,7 +225,7 @@ public void shouldGetReadDelegation() throws Exception {
         nfs_fh4 fh = generateFileHandle();
         Inode inode = Inode.forFile(fh.value);
 
-        var openRecord = tracker.addOpen(client, stateOwner1, inode, OPEN4_SHARE_ACCESS_READ | nfs4_prot.OPEN4_SHARE_ACCESS_WANT_READ_DELEG, 0);
+        var openRecord = tracker.addOpen(client, stateOwner1, inode, OPEN4_SHARE_ACCESS_READ | OPEN4_SHARE_ACCESS_WANT_READ_DELEG, 0);
         assertTrue("Read delegation not granted", openRecord.hasDelegation());
     }
 
@@ -248,7 +257,7 @@ public void shouldReCallReadDelegationOnConflict() throws Exception {
         nfs_fh4 fh = generateFileHandle();
         Inode inode = Inode.forFile(fh.value);
 
-        var openRecord1 = tracker.addOpen(client1, stateOwner1, inode, OPEN4_SHARE_ACCESS_READ | nfs4_prot.OPEN4_SHARE_ACCESS_WANT_READ_DELEG, 0);
+        var openRecord1 = tracker.addOpen(client1, stateOwner1, inode, OPEN4_SHARE_ACCESS_READ | OPEN4_SHARE_ACCESS_WANT_READ_DELEG, 0);
         try {
             var openRecord2 = tracker.addOpen(client2, stateOwner2, inode, OPEN4_SHARE_ACCESS_WRITE,
                   0);
@@ -272,8 +281,8 @@ public void shouldAllowMultipleReadDelegation() throws Exception {
         nfs_fh4 fh = generateFileHandle();
         Inode inode = Inode.forFile(fh.value);
 
-        var openRecord1 = tracker.addOpen(client1, stateOwner1, inode, OPEN4_SHARE_ACCESS_READ | nfs4_prot.OPEN4_SHARE_ACCESS_WANT_READ_DELEG, 0);
-        var openRecord2 = tracker.addOpen(client2, stateOwner2, inode, OPEN4_SHARE_ACCESS_READ | nfs4_prot.OPEN4_SHARE_ACCESS_WANT_READ_DELEG, 0);
+        var openRecord1 = tracker.addOpen(client1, stateOwner1, inode, OPEN4_SHARE_ACCESS_READ | OPEN4_SHARE_ACCESS_WANT_READ_DELEG, 0);
+        var openRecord2 = tracker.addOpen(client2, stateOwner2, inode, OPEN4_SHARE_ACCESS_READ | OPEN4_SHARE_ACCESS_WANT_READ_DELEG, 0);
 
         assertTrue("Read delegation not granted", openRecord2.hasDelegation());
 
@@ -310,4 +319,49 @@ public void shouldNotIssueReadDelegation() throws Exception {
         var openRecord2 = tracker.addOpen(client, stateOwner, inode, OPEN4_SHARE_ACCESS_READ | OPEN4_SHARE_ACCESS_WANT_NO_DELEG, 0);
         assertFalse("Unwanted delegation", openRecord2.hasDelegation());
     }
+
+
+    @Test
+    public void getOpenFiles() throws UnknownHostException, ChimeraNFSException {
+
+        NFS4Client client1 = createClient(sh);
+        NFS4Client client2 = createClient(sh);
+        StateOwner stateOwner1 = client1.getOrCreateOwner("client1".getBytes(StandardCharsets.UTF_8), new seqid4(0));
+        StateOwner stateOwner2 = client2.getOrCreateOwner("client2".getBytes(StandardCharsets.UTF_8), new seqid4(0));
+
+        nfs_fh4 fh = generateFileHandle();
+        Inode inode = Inode.forFile(fh.value);
+
+        tracker.addOpen(client1, stateOwner1, inode, OPEN4_SHARE_ACCESS_READ, 0);
+        tracker.addOpen(client2, stateOwner2, inode, OPEN4_SHARE_ACCESS_READ, 0);
+
+        var openFiles = tracker.getOpenFiles();
+
+        assertEquals("Number of open files not as expected", 1, openFiles.size());
+
+        var clients = openFiles.get(inode);
+        assertThat("Expected clients not found", clients, Matchers.containsInAnyOrder(client1,client2));
+    }
+
+    @Test
+    public void getDelegations() throws UnknownHostException, ChimeraNFSException {
+
+        NFS4Client client1 = createClient(sh);
+        NFS4Client client2 = createClient(sh);
+        StateOwner stateOwner1 = client1.getOrCreateOwner("client1".getBytes(StandardCharsets.UTF_8), new seqid4(0));
+        StateOwner stateOwner2 = client2.getOrCreateOwner("client2".getBytes(StandardCharsets.UTF_8), new seqid4(0));
+
+        nfs_fh4 fh = generateFileHandle();
+        Inode inode = Inode.forFile(fh.value);
+
+        tracker.addOpen(client1, stateOwner1, inode, OPEN4_SHARE_ACCESS_READ | OPEN4_SHARE_ACCESS_WANT_READ_DELEG, 0);
+        tracker.addOpen(client2, stateOwner2, inode, OPEN4_SHARE_ACCESS_READ | OPEN4_SHARE_ACCESS_WANT_READ_DELEG, 0);
+
+        var delegations = tracker.getDelegations();
+
+        assertEquals("Number of open files not as expected", 1, delegations.size());
+
+        var clients = delegations.get(inode);
+        assertThat("Expected clients not found", clients, Matchers.containsInAnyOrder(client1,client2));
+    }
 }