You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2022/02/08 14:08:33 UTC

[commons-vfs] branch master updated: VFS-814 - FtpFileObject: re-fetch MDTM after refresh (#238)

This is an automated email from the ASF dual-hosted git repository.

ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-vfs.git


The following commit(s) were added to refs/heads/master by this push:
     new fffdf96  VFS-814 - FtpFileObject: re-fetch MDTM after refresh (#238)
fffdf96 is described below

commit fffdf96bccd3a19e3e47bb7b76f31ad49d721ea6
Author: Luke Wood <lu...@gmail.com>
AuthorDate: Tue Feb 8 14:08:26 2022 +0000

    VFS-814 - FtpFileObject: re-fetch MDTM after refresh (#238)
    
    Co-authored-by: Luke Wood <lu...@paxport.net>
---
 .../commons/vfs2/provider/ftp/FtpFileObject.java   |  1 +
 .../ftp/FtpMdtmOnRefreshLastModifiedTests.java     | 71 ++++++++++++++++++++++
 .../ftp/FtpProviderMdtmOnRefreshTestCase.java      | 30 +++++++++
 3 files changed, 102 insertions(+)

diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpFileObject.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpFileObject.java
index b6c07d9..d5bc19d 100644
--- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpFileObject.java
+++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ftp/FtpFileObject.java
@@ -222,6 +222,7 @@ public class FtpFileObject extends AbstractFileObject<FtpFileSystem> {
         synchronized (getFileSystem()) {
             this.ftpFile = null;
             this.childMap = null;
+            this.mdtmSet = false;
         }
     }
 
diff --git a/commons-vfs2/src/test/java/org/apache/commons/vfs2/provider/ftp/FtpMdtmOnRefreshLastModifiedTests.java b/commons-vfs2/src/test/java/org/apache/commons/vfs2/provider/ftp/FtpMdtmOnRefreshLastModifiedTests.java
new file mode 100644
index 0000000..e70a057
--- /dev/null
+++ b/commons-vfs2/src/test/java/org/apache/commons/vfs2/provider/ftp/FtpMdtmOnRefreshLastModifiedTests.java
@@ -0,0 +1,71 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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.apache.commons.vfs2.provider.ftp;
+
+import java.io.IOException;
+import java.time.Instant;
+import java.util.concurrent.ThreadLocalRandom;
+
+import org.apache.commons.vfs2.FileContent;
+import org.apache.commons.vfs2.FileObject;
+import org.apache.commons.vfs2.FileSystemException;
+import org.apache.commons.vfs2.LastModifiedTests;
+import org.junit.Assert;
+import org.junit.Test;
+
+import static org.mockito.Mockito.spy;
+import static org.mockito.Mockito.when;
+
+public class FtpMdtmOnRefreshLastModifiedTests extends LastModifiedTests {
+
+    /**
+     * Tests {@link FileContent#getLastModifiedTime()} re-calls {@link FtpClient#mdtmInstant(String)} after refresh.
+     */
+    @Test
+    public void testGetLastModifiedFileExactMatchRefresh() throws IOException {
+        final String fileName = "file1.txt";
+        final FileObject readFolder = getReadFolder();
+        final FtpFileObject fileObject = (FtpFileObject) readFolder.resolveFile(fileName);
+
+        returnsCorrectMdtmValue(fileObject);
+        fileObject.refresh();
+        returnsCorrectMdtmValue(fileObject);
+    }
+
+    private void returnsCorrectMdtmValue(final FtpFileObject fileObject) throws IOException {
+        final String relPath = fileObject.getRelPath();
+        final FtpClient ftpClient = spyClient(fileObject);
+
+        final long expected = ThreadLocalRandom.current().nextLong(Instant.now().toEpochMilli());
+        when(ftpClient.mdtmInstant(relPath)).thenReturn(Instant.ofEpochMilli(expected));
+
+        final long lastModTIme = fileObject.getContent().getLastModifiedTime();
+
+        if (expected != lastModTIme) {
+            Assert.fail(String.format("%s returned epoch %s not expected: %s.",
+                    FtpFileObject.class.getSimpleName(), lastModTIme, expected));
+        }
+    }
+
+    private FtpClient spyClient(final FtpFileObject fileObject) throws FileSystemException {
+        final FtpFileSystem fileSystem = (FtpFileSystem) fileObject.getFileSystem();
+        final FtpClient ftpClientSpy = spy(fileSystem.getClient());
+        fileSystem.putClient(ftpClientSpy);
+        return ftpClientSpy;
+    }
+}
diff --git a/commons-vfs2/src/test/java/org/apache/commons/vfs2/provider/ftp/FtpProviderMdtmOnRefreshTestCase.java b/commons-vfs2/src/test/java/org/apache/commons/vfs2/provider/ftp/FtpProviderMdtmOnRefreshTestCase.java
new file mode 100644
index 0000000..88411a5
--- /dev/null
+++ b/commons-vfs2/src/test/java/org/apache/commons/vfs2/provider/ftp/FtpProviderMdtmOnRefreshTestCase.java
@@ -0,0 +1,30 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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.apache.commons.vfs2.provider.ftp;
+
+import junit.framework.Test;
+
+public class FtpProviderMdtmOnRefreshTestCase extends FtpProviderTestCase {
+
+    /**
+     * MDTM is supported by default for underlying Apache MINA FTP server.
+     */
+    public static Test suite() throws Exception {
+        return suite(new FtpProviderTestCase(true), FtpMdtmOnRefreshLastModifiedTests.class);
+    }
+
+}