Skip to content

Commit

Permalink
JAMES-1606: Integration tests for FileSystem implementation
Browse files Browse the repository at this point in the history 
git-svn-id: https://svn.apache.org/repos/asf/james/project/trunk@1709626 13f79535-47bb-0310-9956-ffa450edef68
  • Loading branch information
@mbaechler
mbaechler committed Oct 20, 2015
1 parent fa9a2f0 commit 7aa76c9
Show file tree
Hide file tree
Showing 9 changed files with 420 additions and 8 deletions.
10 changes: 10 additions & 0 deletions server/container/filesystem-api/pom.xml
View file
Expand Up @@ -50,6 +50,16 @@
<groupId>junit</groupId>
<artifactId>junit</artifactId>
</dependency>
<dependency>
<groupId>org.assertj</groupId>
<artifactId>assertj-core</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>pl.pragmatists</groupId>
<artifactId>JUnitParams</artifactId>
<scope>test</scope>
</dependency>
</dependencies>

<build>
Expand Down
299 changes: 299 additions & 0 deletions .../filesystem-api/src/test/java/org/apache/james/filesystem/api/AbstractFileSystemTest.java
View file
@@ -0,0 +1,299 @@
/****************************************************************
* 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.james.filesystem.api;

import static junitparams.JUnitParamsRunner.$;
import static org.assertj.core.api.Assertions.assertThat;

import java.io.File;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.net.InetSocketAddress;

import org.apache.commons.io.FileUtils;
import org.apache.commons.io.IOUtils;
import org.junit.After;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.TemporaryFolder;
import org.junit.runner.RunWith;

import com.sun.net.httpserver.HttpExchange;
import com.sun.net.httpserver.HttpHandler;
import com.sun.net.httpserver.HttpServer;

import junitparams.JUnitParamsRunner;
import junitparams.Parameters;

@SuppressWarnings("restriction")
@RunWith(JUnitParamsRunner.class)
public abstract class AbstractFileSystemTest {
private static final String FAKE_DIRECTORY = "b7b73e3a-5234-11e5-87f2-9b171f273b49/";
private static final String FAKE_FILE = "d9091ae6-521f-11e5-b666-bb11fef67c2a";
private static final String EXISTING_CLASSPATH_FILE = "classpathTest.txt";
private static final String EXISTING_CLASSPATH_FILE_WITH_SPACES = "class path Test.txt";

@Rule public TemporaryFolder tmpFolder = new TemporaryFolder();

protected FileSystem fileSystem;

private HttpServer httpServer;
private File rootDirectory;

protected abstract FileSystem buildFileSystem(String configurationRootDirectory);

@Before
public void setUp() throws Exception {
httpServer = HttpServer.create(new InetSocketAddress("localhost", 0), 0);
httpServer.createContext("/", new SlashHandler());
httpServer.start();

rootDirectory = tmpFolder.getRoot();
createSubFolderWithAFileIn("conf", "conf.txt", "confcontent");
createSubFolderWithAFileIn("var", "var.txt", "varcontent");

fileSystem = buildFileSystem(rootDirectory.getAbsolutePath());
}

private void createSubFolderWithAFileIn(String folderName, String fileName, String fileContent) throws IOException {
File folder = tmpFolder.newFolder(folderName);
File file = new File(folder.getAbsolutePath() + "/" + fileName);
FileUtils.writeStringToFile(file, fileContent);
}

@After
public void tearDown() throws Exception {
httpServer.stop(0);
}

private static class SlashHandler implements HttpHandler {

@Override
public void handle(HttpExchange exchange) throws IOException {
if (exchange.getRequestURI().getPath().equals("/")) {
String response = "content";
exchange.sendResponseHeaders(200, response.length());
OutputStream responseBody = exchange.getResponseBody();
responseBody.write(response.getBytes());
responseBody.close();
} else {
exchange.sendResponseHeaders(404, 0);
}
}
}

@Test
public final void getBaseDirShouldReturnParentDir() throws Exception {
File basedir = fileSystem.getBasedir();
assertThat(basedir.getPath()).isEqualTo(rootDirectory.getAbsolutePath());
}

@Test(expected = NullPointerException.class)
public final void nullInputShouldThrowNullPointerException() throws Exception {
fileSystem.getFile(null);
}

public final void emptyInputShouldThrowReturnEmptyPathFile() throws Exception {
File file = fileSystem.getFile("");
assertThat(file.getPath()).isEmpty();;
}

@Test
public final void protocolOnlyShouldReturnEmptyPathFile() throws Exception {
File file = fileSystem.getFile("file:");
assertThat(file.getPath()).isEmpty();
}

@Test
public final void protocolWithDoubleSlashesOnlyShouldReturnDir() throws Exception {
File file = fileSystem.getFile("file://");
assertThat(file).isDirectory();
}

public static class UrlsAsFileThrowingFileNotFoundExceptionProvider {
public static Object[] provides() {
return $(
$("bad://file"),
$("classpath:" + FAKE_FILE),
$("classpath:/" + FAKE_FILE),
$("http://localhost:$PORT$/"),
$("classpath:" + new File(ClassLoader.getSystemResource(EXISTING_CLASSPATH_FILE).getFile()).getAbsolutePath()),
$("classpath:java/lang/String.class")
);
}
}

@Test(expected = FileNotFoundException.class)
@Parameters(source = UrlsAsFileThrowingFileNotFoundExceptionProvider.class)
public final void urlAsFileThrowingFileNotFoundException(String url) throws Exception {
url = replacePort(url);

fileSystem.getFile(url);
}

public static class NonExistingFilesProvider {
public static Object[] provides() {
return $(
$("file:///" + FAKE_FILE),
$("file:///" + FAKE_DIRECTORY + FAKE_FILE),
$("file://conf/" + FAKE_FILE),
$("file://var/" + FAKE_FILE)
);
}
}

@Test
@Parameters(source = NonExistingFilesProvider.class)
public void nonExistingFilesShouldNotExist(String url) throws Exception {
File f = fileSystem.getFile(url);
assertThat(f).doesNotExist();
}

public static class NonAvailableStreamsProvider {
public static Object[] provide() {
return $(
$("http://localhost:$PORT$/" + FAKE_FILE),
$("classpath:java/lang/" + FAKE_FILE + ".clas"),
$("classpath:" + FAKE_FILE)
);
}
}

@Test(expected = FileNotFoundException.class)
@Parameters(source = NonAvailableStreamsProvider.class)
public final void getFakeHttpResourceAsInputStreamShouldThrow(String url) throws Exception {
url = replacePort(url);

fileSystem.getResource(url);
}

public static class AvailableStreamsProvider {
public static Object[] provide() {
return $(
$("http://localhost:$PORT$/"),
$("classpath:java/lang/String.class"),
$("classpath:" + EXISTING_CLASSPATH_FILE),
$("classpath:" + EXISTING_CLASSPATH_FILE_WITH_SPACES),
$("classpath:/" + EXISTING_CLASSPATH_FILE),
$("classpath:/" + EXISTING_CLASSPATH_FILE_WITH_SPACES)
);
}
}

@Test
@Parameters(source = AvailableStreamsProvider.class)
public final void availableInputStreamShouldReturnANonEmptyStream(String url) throws Exception {
url = replacePort(url);
InputStream inputStream = fileSystem.getResource(url);
try {
assertThat(IOUtils.toString(inputStream).length()).isGreaterThan(0);
} finally {
IOUtils.closeQuietly(inputStream);
}
}

private String replacePort(String url) {
return url.replace("$PORT$", String.valueOf(httpServer.getAddress().getPort()));
}

public static class FileToCreateProvider {
public static Object[] provide() {
return $(
$("fileSystemTest", ".txt"),
$("file System Test", ".txt")
);
}
}

@Test
@Parameters(source = FileToCreateProvider.class)
public final void createdFilesShouldExist(String name, String extension) throws Exception {
File temp = createTempFile(name, extension);
try {
File expected = fileSystem.getFile("file:" + temp.getAbsolutePath());
assertThat(expected).exists();
} finally {
temp.delete();
}
}

@Test
@Parameters(source = FileToCreateProvider.class)
public final void createdFilesShouldExistWhenAccessedWithTwoSlashes(String name, String extension) throws Exception {
File temp = createTempFile(name, extension);
try {
File expected = fileSystem.getFile("file://" + temp.getAbsolutePath());
assertThat(expected).exists();
} finally {
temp.delete();
}
}

@Test
@Parameters(source = FileToCreateProvider.class)
public final void createdFilesAsInputStreamShouldBeAvailable(String name, String extension) throws Exception {
File temp = createTempFile(name, extension);
InputStream inputStream = null;
try {
inputStream = fileSystem.getResource("file:" + temp.getAbsolutePath());
assertThat(IOUtils.toString(inputStream)).isEqualTo("content");
} finally {
IOUtils.closeQuietly(inputStream);
temp.delete();
}
}

@Test
@Parameters(source = FileToCreateProvider.class)
public final void createdFilesAsInputStreamShouldBeAvailableWhenAccessedWithTwoSlashes(String name, String extension) throws Exception {
File temp = createTempFile(name, extension);
InputStream inputStream = null;
try {
inputStream = fileSystem.getResource("file://" + temp.getAbsolutePath());
assertThat(IOUtils.toString(inputStream)).isEqualTo("content");
} finally {
IOUtils.closeQuietly(inputStream);
temp.delete();
}
}

private File createTempFile(String name, String extension) throws IOException {
File temp = File.createTempFile(name, extension);
FileUtils.write(temp, "content");
return temp;
}

@Test
public void testConfProtocolSouldReturnConfFile() throws Exception {
File file = fileSystem.getFile("file://conf/conf.txt");

assertThat(file).hasContent("confcontent");
}

@Test
public void testVarProtocolSouldReturnVarFile() throws Exception {
File file = fileSystem.getFile("file://var/var.txt");

assertThat(file).hasContent("varcontent");
}

}
1 change: 1 addition & 0 deletions server/container/filesystem-api/src/test/resources/class path Test.txt
View file
@@ -0,0 +1 @@
Non empty
1 change: 1 addition & 0 deletions server/container/filesystem-api/src/test/resources/classpathTest.txt
View file
@@ -0,0 +1 @@
Non empty
16 changes: 16 additions & 0 deletions server/container/spring/pom.xml
View file
Expand Up @@ -43,6 +43,12 @@
<groupId>org.apache.james</groupId>
<artifactId>james-server-filesystem-api</artifactId>
</dependency>
<dependency>
<groupId>org.apache.james</groupId>
<artifactId>james-server-filesystem-api</artifactId>
<scope>test</scope>
<type>test-jar</type>
</dependency>
<dependency>
<groupId>org.apache.james</groupId>
<artifactId>james-server-mailetcontainer-api</artifactId>
Expand Down Expand Up @@ -156,6 +162,16 @@
<groupId>org.apache.geronimo.specs</groupId>
<artifactId>geronimo-jpa_2.0_spec</artifactId>
</dependency>
<dependency>
<groupId>org.assertj</groupId>
<artifactId>assertj-core</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>pl.pragmatists</groupId>
<artifactId>JUnitParams</artifactId>
<scope>test</scope>
</dependency>
</dependencies>

<build>
Expand Down

0 comments on commit 7aa76c9

Please sign in to comment.