test/com/google/enterprise/adaptor/fs/WindowsFileDelegateTest.java - plexi/fs - Git at Google

 // Copyright 2014 Google Inc. 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.

 package com.google.enterprise.adaptor.fs;

 import com.google.common.base.Charsets;
 import com.google.common.base.Preconditions;
 import com.google.common.collect.Sets;
 import com.google.common.io.CharStreams;
 import com.google.enterprise.adaptor.Acl;
 import com.google.enterprise.adaptor.DocIdPusher;

 import static org.junit.Assert.*;
 import static org.junit.Assume.*;

 import org.junit.*;
 import org.junit.rules.ExpectedException;
 import org.junit.rules.TemporaryFolder;

 import java.io.File;
 import java.io.IOException;
 import java.io.InputStreamReader;
 import java.nio.file.DirectoryStream;
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.Paths;
 import java.nio.file.StandardCopyOption;
 import java.nio.file.attribute.AclFileAttributeView;
 import java.nio.file.attribute.BasicFileAttributes;
 import java.nio.file.attribute.FileTime;
 import java.util.Collections;
 import java.util.Set;

 /** Tests for {@link WindowsFileDelegate} */
 public class WindowsFileDelegateTest {

   @BeforeClass
   public static void checkIfRunningOnWindows() {
     TestHelper.assumeOsIsWindows();
   }

   private FileDelegate delegate = new WindowsFileDelegate();
   private AccumulatingAsyncDocIdPusher pusher =
       new AccumulatingAsyncDocIdPusher();
   private Path tempRoot;

   @Rule
   public ExpectedException thrown = ExpectedException.none();

   @Rule
   public TemporaryFolder temp = new TemporaryFolder();

   @Before
   public void setUp() throws Exception {
     tempRoot = temp.getRoot().getCanonicalFile().toPath();
   }

   @After
   public void tearDown() {
     delegate.destroy();
   }

   private Path newTempDir(String name) throws IOException {
     return temp.newFolder(name).toPath().toRealPath();
   }

   private Path newTempFile(String name) throws IOException {
     return temp.newFile(name).toPath().toRealPath();
   }

   private Path newTempFile(Path parent, String name) throws IOException {
     Preconditions.checkArgument(parent.startsWith(tempRoot));
     return Files.createFile(parent.resolve(name));
   }

   @Test
   public void testNewDocIdLocalFiles() throws Exception {
     Path dir = newTempDir("testDir");
     Path file = newTempFile(dir, "test");

     String id = delegate.newDocId(tempRoot).getUniqueId();
     assertTrue(id.startsWith(tempRoot.toString().replace('\\', '/')));
     assertTrue(id.endsWith("/"));

     id = delegate.newDocId(dir).getUniqueId();
     assertTrue(id.startsWith(tempRoot.toString().replace('\\', '/')));
     assertTrue(id.startsWith(dir.toString().replace('\\', '/')));
     assertTrue(id.endsWith("/"));

     id = delegate.newDocId(file).getUniqueId();
     assertTrue(id.startsWith(tempRoot.toString().replace('\\', '/')));
     assertTrue(id.startsWith(dir.toString().replace('\\', '/')));
     assertTrue(id.equals(file.toString().replace('\\', '/')));
     assertFalse(id.endsWith("/"));
   }

   @Test
   public void testNewDocIdVirtualUncPaths() throws Exception {
     assertEquals("\\\\host/share",
         delegate.newDocId(Paths.get("\\\\host\\share")).getUniqueId());
     assertEquals("\\\\host/share",
         delegate.newDocId(Paths.get("\\\\host\\share\\")).getUniqueId());
     assertEquals("\\\\host/share/foo/bar",
         delegate.newDocId(Paths.get("\\\\host\\share\\foo\\bar"))
         .getUniqueId());
   }

   @Test
   public void testNewDocIdLocalUncPaths() throws Exception {
     String uncTempRoot = getTempRootAsUncPath();
     assumeNotNull(uncTempRoot);
     Path tempRoot = Paths.get(uncTempRoot);
     String expectedTempRootId = "\\\\" + uncTempRoot.substring(2)
         .replace('\\', '/') + "/";

     assertEquals(expectedTempRootId,
         delegate.newDocId(tempRoot).getUniqueId());

     newTempDir("testDir");
     assertEquals(expectedTempRootId + "testDir/",
         delegate.newDocId(tempRoot.resolve("testDir")).getUniqueId());

     newTempFile("test");
     assertEquals(expectedTempRootId + "test",
         delegate.newDocId(tempRoot.resolve("test")).getUniqueId());
   }

   private String getTempRootAsUncPath() throws IOException {
     String tempPath = temp.getRoot().getCanonicalPath();
     if (tempPath.length() > 2 && tempPath.charAt(1) == ':') {
       String uncPath = "\\\\localhost\\" + tempPath.substring(0, 1) + "$"
           + tempPath.substring(2);
       try {
         // Now verify we have access to the local administrative share.
         if (new File(uncPath).list() != null) {
           return uncPath;
         }
       } catch (SecurityException e) {
         // Cannot access local administrative share.
       }
     }
     return null;
   }

   @Test
   public void testStartMonitorBadPath() throws Exception {
     Path file = newTempFile("test.txt");
     thrown.expect(IOException.class);
     delegate.startMonitorPath(file, pusher);
   }

   @Test
   public void testStartStopMonitor() throws Exception {
     delegate.startMonitorPath(tempRoot, pusher);
     delegate.stopMonitorPath();
   }

   @Test
   public void testMonitorAddFile() throws Exception {
     // These shouldn't show up as new or modified.
     newTempDir("existingDir");
     newTempFile("existingFile");
     delegate.startMonitorPath(tempRoot, pusher);
     Path file = newTempFile("test.txt");
     // Adding a file shows up as a change to its parent.
     checkForChanges(Collections.singleton(newRecord(tempRoot)));
   }

   @Test
   public void testMonitorDeleteFile() throws Exception {
     Path file = newTempFile("test.txt");
     delegate.startMonitorPath(tempRoot, pusher);
     Files.delete(file);
     // Deleting a file shows up as a change to itself and its parent.
     checkForChanges(Sets.newHashSet(newRecord(tempRoot), newRecord(file)));
   }

   @Test
   public void testMonitorRenameFile() throws Exception {
     Path file = newTempFile("test.txt");
     Path newFile = file.resolveSibling("newName.txt");
     delegate.startMonitorPath(tempRoot, pusher);
     Files.move(file, newFile, StandardCopyOption.ATOMIC_MOVE);
     // Renaming a file shows up as a change to its old name, its new name,
     // and its parent.
     checkForChanges(Sets.newHashSet(newRecord(tempRoot), newRecord(file),
         newRecord(newFile)));
   }

   @Test
   public void testMonitorMoveAccrossDirs() throws Exception {
     Path dir1 = newTempDir("dir1");
     Path dir2 = newTempDir("dir2");
     Path file1 = newTempFile(dir1, "test.txt");
     Path file2 = dir2.resolve(file1.getFileName());
     delegate.startMonitorPath(tempRoot, pusher);
     Files.move(file1, file2);
     // Moving a file shows up as a change to its old name, its new name,
     // its old parent, and its new parent.
     checkForChanges(Sets.newHashSet(newRecord(file1), newRecord(file2),
         newRecord(dir1), newRecord(dir2)));
   }

   @Test
   public void testMonitorModifyFile() throws Exception {
     Path file = newTempFile("test.txt");
     delegate.startMonitorPath(tempRoot, pusher);
     Files.write(file, "Hello World".getBytes("UTF-8"));
     // Modifying a file shows up as a change to that file.
     checkForChanges(Collections.singleton(newRecord(file)));
   }

   @Test
   public void testMonitorModifyFileAttributes() throws Exception {
     Path file = newTempFile("test.txt");
     FileTime lastModified = Files.getLastModifiedTime(file);
     delegate.startMonitorPath(tempRoot, pusher);
     Files.setLastModifiedTime(file,
         FileTime.fromMillis(lastModified.toMillis() + 10000L));
     // Modifying a file shows up as a change to that file.
     checkForChanges(Collections.singleton(newRecord(file)));
   }

   @Test
   public void testMonitorRenameDir() throws Exception {
     Path dir = newTempDir("dir1");
     Path newDir = dir.resolveSibling("newName.dir");
     delegate.startMonitorPath(tempRoot, pusher);
     Files.move(dir, newDir, StandardCopyOption.ATOMIC_MOVE);
     // Renaming a directory shows up as a change to its old name, its new name,
     // and its parent.
     checkForChanges(Sets.newHashSet(newRecord(tempRoot), newRecord(dir)));
   }

   @Test
   public void testMonitorMoveDir() throws Exception {
     Path dir1 = newTempDir("dir1");
     Path dir2 = newTempDir("dir2");
     Path dir1dir2 = dir1.resolve(dir2.getFileName());
     delegate.startMonitorPath(tempRoot, pusher);
     Files.move(dir2, dir1dir2);
     // Moving a file shows up as a change to its old name, its new name,
     // its old parent, and its new parent.
     checkForChanges(Sets.newHashSet(newRecord(tempRoot), newRecord(dir1),
         newRecord(dir2)));
   }

   @Test
   public void testMonitorChangesInSubDirs() throws Exception {
     Path dir = newTempDir("testDir");
     Path file = newTempFile(dir, "test.txt");
     delegate.startMonitorPath(tempRoot, pusher);
     Files.write(file, "Hello World".getBytes("UTF-8"));
     // Modifying a file shows up as a change to that file.
     checkForChanges(Sets.newHashSet(newRecord(file), newRecord(dir)));
   }

   private void checkForChanges(Set<DocIdPusher.Record> expected)
       throws Exception {
     // Collect up the changes.
     Set<DocIdPusher.Record> changes = Sets.newHashSet();
     final long maxLatencyMillis = 10000;
     long latencyMillis = maxLatencyMillis;
     long batchLatencyMillis = 500;
     boolean inFollowup = false;

     while (latencyMillis > 0) {
       Thread.sleep(batchLatencyMillis);
       latencyMillis -= batchLatencyMillis;

       changes.addAll(pusher.getRecords());
       pusher.reset();
       if (changes.size() == expected.size()) {
         // If the changes size is equal to the expected size then
         // keep listening for changes for the same period of time
         // that it took to get the current notifications to see if
         // we find any additional changes.
         if (!inFollowup) {
           latencyMillis = maxLatencyMillis - latencyMillis;
           inFollowup = true;
         }
       }
       if (changes.size() > expected.size()) {
         // We've found more changes than are expected. Just stop
         // listening, we'll fail below.
         break;
       }
     }

     // Now verify that the changes we got were the ones that were expected.
     assertEquals(expected, changes);
   }

   private DocIdPusher.Record newRecord(Path path) throws Exception {
     return new DocIdPusher.Record.Builder(delegate.newDocId(path))
         .setCrawlImmediately(true).build();
   }
 }
	// Copyright 2014 Google Inc. 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.

	package com.google.enterprise.adaptor.fs;

	import com.google.common.base.Charsets;
	import com.google.common.base.Preconditions;
	import com.google.common.collect.Sets;
	import com.google.common.io.CharStreams;
	import com.google.enterprise.adaptor.Acl;
	import com.google.enterprise.adaptor.DocIdPusher;

	import static org.junit.Assert.*;
	import static org.junit.Assume.*;

	import org.junit.*;
	import org.junit.rules.ExpectedException;
	import org.junit.rules.TemporaryFolder;

	import java.io.File;
	import java.io.IOException;
	import java.io.InputStreamReader;
	import java.nio.file.DirectoryStream;
	import java.nio.file.Files;
	import java.nio.file.Path;
	import java.nio.file.Paths;
	import java.nio.file.StandardCopyOption;
	import java.nio.file.attribute.AclFileAttributeView;
	import java.nio.file.attribute.BasicFileAttributes;
	import java.nio.file.attribute.FileTime;
	import java.util.Collections;
	import java.util.Set;

	/** Tests for {@link WindowsFileDelegate} */
	public class WindowsFileDelegateTest {

	@BeforeClass
	public static void checkIfRunningOnWindows() {
	TestHelper.assumeOsIsWindows();
	}

	private FileDelegate delegate = new WindowsFileDelegate();
	private AccumulatingAsyncDocIdPusher pusher =
	new AccumulatingAsyncDocIdPusher();
	private Path tempRoot;

	@Rule
	public ExpectedException thrown = ExpectedException.none();

	@Rule
	public TemporaryFolder temp = new TemporaryFolder();

	@Before
	public void setUp() throws Exception {
	tempRoot = temp.getRoot().getCanonicalFile().toPath();
	}

	@After
	public void tearDown() {
	delegate.destroy();
	}

	private Path newTempDir(String name) throws IOException {
	return temp.newFolder(name).toPath().toRealPath();
	}

	private Path newTempFile(String name) throws IOException {
	return temp.newFile(name).toPath().toRealPath();
	}

	private Path newTempFile(Path parent, String name) throws IOException {
	Preconditions.checkArgument(parent.startsWith(tempRoot));
	return Files.createFile(parent.resolve(name));
	}

	@Test
	public void testNewDocIdLocalFiles() throws Exception {
	Path dir = newTempDir("testDir");
	Path file = newTempFile(dir, "test");

	String id = delegate.newDocId(tempRoot).getUniqueId();
	assertTrue(id.startsWith(tempRoot.toString().replace('\\', '/')));
	assertTrue(id.endsWith("/"));

	id = delegate.newDocId(dir).getUniqueId();
	assertTrue(id.startsWith(tempRoot.toString().replace('\\', '/')));
	assertTrue(id.startsWith(dir.toString().replace('\\', '/')));
	assertTrue(id.endsWith("/"));

	id = delegate.newDocId(file).getUniqueId();
	assertTrue(id.startsWith(tempRoot.toString().replace('\\', '/')));
	assertTrue(id.startsWith(dir.toString().replace('\\', '/')));
	assertTrue(id.equals(file.toString().replace('\\', '/')));
	assertFalse(id.endsWith("/"));
	}

	@Test
	public void testNewDocIdVirtualUncPaths() throws Exception {
	assertEquals("\\\\host/share",
	delegate.newDocId(Paths.get("\\\\host\\share")).getUniqueId());
	assertEquals("\\\\host/share",
	delegate.newDocId(Paths.get("\\\\host\\share\\")).getUniqueId());
	assertEquals("\\\\host/share/foo/bar",
	delegate.newDocId(Paths.get("\\\\host\\share\\foo\\bar"))
	.getUniqueId());
	}

	@Test
	public void testNewDocIdLocalUncPaths() throws Exception {
	String uncTempRoot = getTempRootAsUncPath();
	assumeNotNull(uncTempRoot);
	Path tempRoot = Paths.get(uncTempRoot);
	String expectedTempRootId = "\\\\" + uncTempRoot.substring(2)
	.replace('\\', '/') + "/";

	assertEquals(expectedTempRootId,
	delegate.newDocId(tempRoot).getUniqueId());

	newTempDir("testDir");
	assertEquals(expectedTempRootId + "testDir/",
	delegate.newDocId(tempRoot.resolve("testDir")).getUniqueId());

	newTempFile("test");
	assertEquals(expectedTempRootId + "test",
	delegate.newDocId(tempRoot.resolve("test")).getUniqueId());
	}

	private String getTempRootAsUncPath() throws IOException {
	String tempPath = temp.getRoot().getCanonicalPath();
	if (tempPath.length() > 2 && tempPath.charAt(1) == ':') {
	String uncPath = "\\\\localhost\\" + tempPath.substring(0, 1) + "$"
	+ tempPath.substring(2);
	try {
	// Now verify we have access to the local administrative share.
	if (new File(uncPath).list() != null) {
	return uncPath;
	}
	} catch (SecurityException e) {
	// Cannot access local administrative share.
	}
	}
	return null;
	}

	@Test
	public void testStartMonitorBadPath() throws Exception {
	Path file = newTempFile("test.txt");
	thrown.expect(IOException.class);
	delegate.startMonitorPath(file, pusher);
	}

	@Test
	public void testStartStopMonitor() throws Exception {
	delegate.startMonitorPath(tempRoot, pusher);
	delegate.stopMonitorPath();
	}

	@Test
	public void testMonitorAddFile() throws Exception {
	// These shouldn't show up as new or modified.
	newTempDir("existingDir");
	newTempFile("existingFile");
	delegate.startMonitorPath(tempRoot, pusher);
	Path file = newTempFile("test.txt");
	// Adding a file shows up as a change to its parent.
	checkForChanges(Collections.singleton(newRecord(tempRoot)));
	}

	@Test
	public void testMonitorDeleteFile() throws Exception {
	Path file = newTempFile("test.txt");
	delegate.startMonitorPath(tempRoot, pusher);
	Files.delete(file);
	// Deleting a file shows up as a change to itself and its parent.
	checkForChanges(Sets.newHashSet(newRecord(tempRoot), newRecord(file)));
	}

	@Test
	public void testMonitorRenameFile() throws Exception {
	Path file = newTempFile("test.txt");
	Path newFile = file.resolveSibling("newName.txt");
	delegate.startMonitorPath(tempRoot, pusher);
	Files.move(file, newFile, StandardCopyOption.ATOMIC_MOVE);
	// Renaming a file shows up as a change to its old name, its new name,
	// and its parent.
	checkForChanges(Sets.newHashSet(newRecord(tempRoot), newRecord(file),
	newRecord(newFile)));
	}

	@Test
	public void testMonitorMoveAccrossDirs() throws Exception {
	Path dir1 = newTempDir("dir1");
	Path dir2 = newTempDir("dir2");
	Path file1 = newTempFile(dir1, "test.txt");
	Path file2 = dir2.resolve(file1.getFileName());
	delegate.startMonitorPath(tempRoot, pusher);
	Files.move(file1, file2);
	// Moving a file shows up as a change to its old name, its new name,
	// its old parent, and its new parent.
	checkForChanges(Sets.newHashSet(newRecord(file1), newRecord(file2),
	newRecord(dir1), newRecord(dir2)));
	}

	@Test
	public void testMonitorModifyFile() throws Exception {
	Path file = newTempFile("test.txt");
	delegate.startMonitorPath(tempRoot, pusher);
	Files.write(file, "Hello World".getBytes("UTF-8"));
	// Modifying a file shows up as a change to that file.
	checkForChanges(Collections.singleton(newRecord(file)));
	}

	@Test
	public void testMonitorModifyFileAttributes() throws Exception {
	Path file = newTempFile("test.txt");
	FileTime lastModified = Files.getLastModifiedTime(file);
	delegate.startMonitorPath(tempRoot, pusher);
	Files.setLastModifiedTime(file,
	FileTime.fromMillis(lastModified.toMillis() + 10000L));
	// Modifying a file shows up as a change to that file.
	checkForChanges(Collections.singleton(newRecord(file)));
	}

	@Test
	public void testMonitorRenameDir() throws Exception {
	Path dir = newTempDir("dir1");
	Path newDir = dir.resolveSibling("newName.dir");
	delegate.startMonitorPath(tempRoot, pusher);
	Files.move(dir, newDir, StandardCopyOption.ATOMIC_MOVE);
	// Renaming a directory shows up as a change to its old name, its new name,
	// and its parent.
	checkForChanges(Sets.newHashSet(newRecord(tempRoot), newRecord(dir)));
	}

	@Test
	public void testMonitorMoveDir() throws Exception {
	Path dir1 = newTempDir("dir1");
	Path dir2 = newTempDir("dir2");
	Path dir1dir2 = dir1.resolve(dir2.getFileName());
	delegate.startMonitorPath(tempRoot, pusher);
	Files.move(dir2, dir1dir2);
	// Moving a file shows up as a change to its old name, its new name,
	// its old parent, and its new parent.
	checkForChanges(Sets.newHashSet(newRecord(tempRoot), newRecord(dir1),
	newRecord(dir2)));
	}

	@Test
	public void testMonitorChangesInSubDirs() throws Exception {
	Path dir = newTempDir("testDir");
	Path file = newTempFile(dir, "test.txt");
	delegate.startMonitorPath(tempRoot, pusher);
	Files.write(file, "Hello World".getBytes("UTF-8"));
	// Modifying a file shows up as a change to that file.
	checkForChanges(Sets.newHashSet(newRecord(file), newRecord(dir)));
	}

	private void checkForChanges(Set<DocIdPusher.Record> expected)
	throws Exception {
	// Collect up the changes.
	Set<DocIdPusher.Record> changes = Sets.newHashSet();
	final long maxLatencyMillis = 10000;
	long latencyMillis = maxLatencyMillis;
	long batchLatencyMillis = 500;
	boolean inFollowup = false;

	while (latencyMillis > 0) {
	Thread.sleep(batchLatencyMillis);
	latencyMillis -= batchLatencyMillis;

	changes.addAll(pusher.getRecords());
	pusher.reset();
	if (changes.size() == expected.size()) {
	// If the changes size is equal to the expected size then
	// keep listening for changes for the same period of time
	// that it took to get the current notifications to see if
	// we find any additional changes.
	if (!inFollowup) {
	latencyMillis = maxLatencyMillis - latencyMillis;
	inFollowup = true;
	}
	}
	if (changes.size() > expected.size()) {
	// We've found more changes than are expected. Just stop
	// listening, we'll fail below.
	break;
	}
	}

	// Now verify that the changes we got were the ones that were expected.
	assertEquals(expected, changes);
	}

	private DocIdPusher.Record newRecord(Path path) throws Exception {
	return new DocIdPusher.Record.Builder(delegate.newDocId(path))
	.setCrawlImmediately(true).build();
	}
	}