Merge branch 'release/1.0.3'

Author: jarnaiz

README.md

@@ -14,7 +14,7 @@ This project provides a first API implementation, little optimized, but "complet
 <dependency>
 	<groupId>com.upplication</groupId>
 	<artifactId>s3fs</artifactId>
-	<version>1.0.2</version>
+	<version>1.0.3</version>
 </dependency>
 ```
 

pom.xml

@@ -4,7 +4,7 @@
 	<groupId>com.upplication</groupId>
 	<artifactId>s3fs</artifactId>
 	<packaging>jar</packaging>
-	<version>1.0.2</version>
+	<version>1.0.3</version>
 	<name>s3fs</name>
 	<description>S3 filesystem provider for Java 7</description>
 	<url>https://github.com/Upplication/Amazon-S3-FileSystem-NIO2</url>

src/main/java/com/upplication/s3fs/S3FileAttributes.java

@@ -11,13 +11,16 @@ public class S3FileAttributes implements BasicFileAttributes {
 	private final boolean directory;
 	private final boolean regularFile;
 	private final String key;
+	private long cacheCreated;
 
 	public S3FileAttributes(String key, FileTime lastModifiedTime, long size, boolean isDirectory, boolean isRegularFile) {
 		this.key = key;
 		this.lastModifiedTime = lastModifiedTime;
 		this.size = size;
 		directory = isDirectory;
 		regularFile = isRegularFile;
+
+		cacheCreated = System.currentTimeMillis();
 	}
 
 	@Override
@@ -69,4 +72,14 @@ public Object fileKey() {
 	public String toString() {
 		return format("[%s: lastModified=%s, size=%s, isDirectory=%s, isRegularFile=%s]", key, lastModifiedTime, size, directory, regularFile);
 	}
+
+	public long getCacheCreated() {
+		return cacheCreated;
+	}
+
+	// for testing
+
+	public void setCacheCreated(long time) {
+		this.cacheCreated = time;
+	}
 }

src/main/java/com/upplication/s3fs/S3FileSystem.java

@@ -30,12 +30,14 @@ public class S3FileSystem extends FileSystem implements Comparable<S3FileSystem>
 	private final String key;
 	private final AmazonS3 client;
 	private final String endpoint;
+    private int cache;
 
-	public S3FileSystem(S3FileSystemProvider provider, String key, AmazonS3 client, String endpoint) {
+    public S3FileSystem(S3FileSystemProvider provider, String key, AmazonS3 client, String endpoint) {
 		this.provider = provider;
 		this.key = key;
 		this.client = client;
 		this.endpoint = endpoint;
+        this.cache = 60000; // 1 minute cache for the s3Path
 	}
 
 	@Override
@@ -183,4 +185,8 @@ public boolean equals(Object obj) {
 	public int compareTo(S3FileSystem o) {
 		return key.compareTo(o.getKey());
 	}
+
+    public int getCache() {
+        return cache;
+    }
 }

src/main/java/com/upplication/s3fs/S3FileSystemProvider.java

@@ -45,6 +45,7 @@
 import com.google.common.collect.ImmutableList;
 import com.google.common.collect.ImmutableSet;
 import com.google.common.collect.Sets;
+import com.upplication.s3fs.util.Cache;
 import com.upplication.s3fs.util.S3Utils;
 
 /**
@@ -81,6 +82,7 @@ public class S3FileSystemProvider extends FileSystemProvider {
     private static final ConcurrentMap<String, S3FileSystem> fileSystems = new ConcurrentHashMap<>();
 
     private S3Utils s3Utils = new S3Utils();
+    private Cache cache = new Cache();
 
 	@Override
 	public String getScheme() {
@@ -441,8 +443,17 @@ public <V extends FileAttributeView> V getFileAttributeView(Path path, Class<V>
 	public <A extends BasicFileAttributes> A readAttributes(Path path, Class<A> type, LinkOption... options) throws IOException {
 		S3Path s3Path = toS3Path(path);
         if (type == BasicFileAttributes.class) {
-            return type.cast(s3Utils.getS3FileAttributes(s3Path));
+            if (cache.isInTime(s3Path.getFileSystem().getCache(), s3Path.getFileAttributes())) {
+				A result = type.cast(s3Path.getFileAttributes());
+				s3Path.setFileAttributes(null);
+				return result;
+			} else {
+                S3FileAttributes attrs = s3Utils.getS3FileAttributes(s3Path);
+                s3Path.setFileAttributes(attrs);
+                return type.cast(attrs);
+            }
         }
+
         throw new UnsupportedOperationException(format("only %s supported", BasicFileAttributes.class));
 	}
 
@@ -534,9 +545,17 @@ public boolean isOpen(S3FileSystem s3FileSystem) {
 
     /**
      * only 4 testing
-     * @return
      */
+
 	protected static ConcurrentMap<String, S3FileSystem> getFilesystems() {
 		return fileSystems;
 	}
+
+    public Cache getCache() {
+        return cache;
+    }
+
+    public void setCache(Cache cache) {
+        this.cache = cache;
+    }
 }

src/main/java/com/upplication/s3fs/S3Iterator.java

@@ -1,5 +1,6 @@
 package com.upplication.s3fs;
 
+import java.nio.file.NoSuchFileException;
 import java.nio.file.Path;
 import java.util.ArrayList;
 import java.util.Arrays;
@@ -8,13 +9,12 @@
 import java.util.List;
 import java.util.NoSuchElementException;
 import java.util.Set;
-
-import com.amazonaws.services.s3.AmazonS3;
 import com.amazonaws.services.s3.model.ListObjectsRequest;
 import com.amazonaws.services.s3.model.ObjectListing;
 import com.amazonaws.services.s3.model.S3ObjectSummary;
 import com.google.common.collect.Lists;
 import com.google.common.collect.Sets;
+import com.upplication.s3fs.util.S3Utils;
 
 /**
  * S3 iterator over folders at first level.
@@ -32,6 +32,8 @@ public class S3Iterator implements Iterator<Path> {
 	private int size;
 	private boolean incremental;
 
+    private S3Utils s3Utils = new S3Utils();
+
 	public S3Iterator(S3Path path) {
 		this(path, false);
 	}
@@ -138,7 +140,7 @@ private void parseObjectListing(String key, List<S3Path> listPath, ObjectListing
             String immediateDescendantKey = getImmediateDescendant(key, objectSummaryKey);
             if (immediateDescendantKey != null) {
                 S3Path descendentPart = new S3Path(fileSystem, fileStore, fileSystem.key2Parts(immediateDescendantKey));
-
+                descendentPart.setFileAttributes(s3Utils.toS3FileAttributes(objectSummary, descendentPart.getKey()));
                 if (!listPath.contains(descendentPart)) {
                     listPath.add(descendentPart);
                 }

src/main/java/com/upplication/s3fs/S3Path.java

@@ -57,6 +57,11 @@ public class S3Path implements Path {
 	 */
 	private S3FileSystem fileSystem;
 
+    /**
+     * S3FileAttributes cache
+     */
+    private S3FileAttributes fileAttributes;
+
 	/**
 	 * path must be a string of the form "/{bucket}", "/{bucket}/{key}" or just
 	 * "{key}".
@@ -431,6 +436,14 @@ public int hashCode() {
 		return result;
 	}
 
+    public S3FileAttributes getFileAttributes() {
+        return fileAttributes;
+    }
+
+    public void setFileAttributes(S3FileAttributes fileAttributes) {
+        this.fileAttributes = fileAttributes;
+    }
+
 	// ~ helpers methods
 
 	private static Function<String, String> strip(final String... strs) {
@@ -455,9 +468,9 @@ public boolean apply(@Nullable String input) {
 		};
 	}
 
-	/*
-	 * delete redundant "/" and empty parts
-	 */
+    /*
+     * delete redundant "/" and empty parts
+     */
 	private abstract static class KeyParts {
 		private static ImmutableList<String> parse(String[] parts) {
 			return ImmutableList.copyOf(filter(transform(Arrays.asList(parts), strip("/")), notEmpty()));

src/main/java/com/upplication/s3fs/util/Cache.java

@@ -0,0 +1,28 @@
+package com.upplication.s3fs.util;
+
+import com.upplication.s3fs.S3FileAttributes;
+
+public class Cache {
+
+    /**
+     * check if the cache of the S3FileAttributes is still valid
+     * @param cache int cache time of the fileAttributes in milliseconds
+     * @param fileAttributes S3FileAttributes to check if is still valid, can be null
+     * @return true or false, if cache are -1 and fileAttributes are not null then always return true
+     */
+    public boolean isInTime(int cache, S3FileAttributes fileAttributes){
+        if (fileAttributes == null) {
+            return false;
+        }
+
+        if (cache == -1) {
+            return true;
+        }
+
+        return getCurrentTime() - cache <= fileAttributes.getCacheCreated();
+    }
+
+    public long getCurrentTime(){
+        return System.currentTimeMillis();
+    }
+}

src/main/java/com/upplication/s3fs/util/S3Utils.java

@@ -15,10 +15,10 @@
 public class S3Utils {
 
     /**
-     * Get the {@link com.amazonaws.services.s3.model.S3ObjectSummary} that represent this Path or her first child if this path not exists
-     * @param s3Path {@link com.upplication.s3fs.S3Path}
-     * @return {@link com.amazonaws.services.s3.model.S3ObjectSummary}
-     * @throws java.nio.file.NoSuchFileException if not found the path and any child
+     * Get the {@link S3ObjectSummary} that represent this Path or her first child if this path not exists
+     * @param s3Path {@link S3Path}
+     * @return {@link S3ObjectSummary}
+     * @throws NoSuchFileException if not found the path and any child
      */
     public S3ObjectSummary getS3ObjectSummary(S3Path s3Path) throws NoSuchFileException {
         String key = s3Path.getKey();
@@ -61,9 +61,19 @@ public S3ObjectSummary getS3ObjectSummary(S3Path s3Path) throws NoSuchFileExcept
      * @return S3FileAttributes
      */
     public S3FileAttributes getS3FileAttributes(S3Path s3Path) throws NoSuchFileException {
-        String key = s3Path.getKey();
         S3ObjectSummary objectSummary = getS3ObjectSummary(s3Path);
+        return toS3FileAttributes(objectSummary, s3Path.getKey());
+    }
 
+    /**
+     * convert S3ObjectSummary to S3FileAttributes
+     * @param objectSummary S3ObjectSummary mandatory not null, the real objectSummary with
+     *                      exactly the same key than the key param or the immediate descendant
+     *                      if it is a virtual directory
+     * @param key String the real key that can be exactly equal than the objectSummary or
+     * @return S3FileAttributes
+     */
+    public S3FileAttributes toS3FileAttributes(S3ObjectSummary objectSummary, String key) {
         // parse the data to BasicFileAttributes.
         FileTime lastModifiedTime = null;
         if (objectSummary.getLastModified() != null){
@@ -77,8 +87,7 @@ public S3FileAttributes getS3FileAttributes(S3Path s3Path) throws NoSuchFileExce
         if (key.endsWith("/") && resolvedKey.equals(key) ||
                 resolvedKey.equals(key + "/")) {
             directory = true;
-        }
-        else if (key.isEmpty()) { // is a bucket (no key)
+        } else if (key.isEmpty()) { // is a bucket (no key)
             directory = true;
             resolvedKey = "/";
         }
@@ -88,8 +97,9 @@ else if (!resolvedKey.equals(key) && resolvedKey.startsWith(key)) { // is a dire
             size = 0;
             // delete extra part
             resolvedKey = key + "/";
-        } else
+        } else {
             regularFile = true;
+        }
         return new S3FileAttributes(resolvedKey, lastModifiedTime, size, directory, regularFile);
     }
-}
+}

src/test/java/com/upplication/s3fs/CacheTest.java

@@ -0,0 +1,48 @@
+package com.upplication.s3fs;
+
+import com.upplication.s3fs.util.Cache;
+import org.junit.Test;
+
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertTrue;
+import static org.mockito.Mockito.doReturn;
+import static org.mockito.Mockito.spy;
+
+public class CacheTest {
+
+    @Test
+    public void cacheIsInclusive() {
+        Cache cache = spy(new Cache());
+        doReturn(300L).when(cache).getCurrentTime();
+
+        S3FileAttributes attributes = new S3FileAttributes("key", null, 0, false, true);
+        attributes.setCacheCreated(0);
+
+        boolean result = cache.isInTime(300, attributes);
+        assertTrue(result);
+    }
+
+    @Test
+    public void outOfTime() {
+        Cache cache = spy(new Cache());
+        doReturn(200L).when(cache).getCurrentTime();
+
+        S3FileAttributes attributes = new S3FileAttributes("key", null, 0, false, true);
+        attributes.setCacheCreated(0);
+
+        boolean result = cache.isInTime(100, attributes);
+        assertFalse(result);
+    }
+
+    @Test
+    public void infinite() {
+        Cache cache = spy(new Cache());
+        doReturn(200L).when(cache).getCurrentTime();
+
+        S3FileAttributes attributes = new S3FileAttributes("key", null, 0, false, true);
+        attributes.setCacheCreated(100);
+
+        boolean result = cache.isInTime(-1, attributes);
+        assertTrue(result);
+    }
+}