2 * Copyright 2005-2010 the original author or authors.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
16 package org.wamblee.io;
19 import java.io.FileInputStream;
20 import java.io.FileOutputStream;
21 import java.io.IOException;
22 import java.io.InputStream;
23 import java.io.OutputStream;
24 import java.io.UnsupportedEncodingException;
26 import java.net.URLDecoder;
27 import java.nio.MappedByteBuffer;
28 import java.nio.channels.FileChannel;
29 import java.security.CodeSource;
30 import java.util.logging.Level;
31 import java.util.logging.Logger;
33 import junit.framework.Assert;
34 import junit.framework.TestCase;
37 * File system utilities.
39 * @author Erik Brakkee
41 public final class FileSystemUtils {
42 private static final Logger LOG = Logger.getLogger(FileSystemUtils.class
46 * Test output directory relative to the sub project.
48 private static final String TEST_OUTPUT_DIR = "../target/testoutput";
51 * Test input directory relative to the sub project.
53 private static final String TEST_INPUT_DIR = "../src/test/resources";
58 private FileSystemUtils() {
63 * Deletes a directory recursively. The test case will fail if the directory
64 * does not exist or if deletion fails.
67 * Directory to delete.
69 public static void deleteDirRecursively(String aDir) {
70 deleteDirRecursively(new File(aDir));
74 * Deletes a directory recursively. See {@link #deleteDirRecursively}.
79 public static void deleteDirRecursively(File aDir) {
80 TestCase.assertTrue(aDir.isDirectory());
82 for (File file : aDir.listFiles()) {
83 if (file.isDirectory()) {
84 deleteDirRecursively(file);
94 * Deletes a file or directory. The test case will fail if the file or
95 * directory does not exist or if deletion fails. Deletion of a non-empty
96 * directory will always fail.
99 * File or directory to delete.
101 public static void delete(File aFile) {
102 TestCase.assertTrue(aFile.delete());
106 * Gets a path relative to a sub project. This utility should be used to
107 * easily access file paths within a subproject without requiring any
108 * specific Eclipse configuration.
110 * @param aRelativePath
115 public static File getPath(String aRelativePath, Class aTestClass) {
116 CodeSource source = aTestClass.getProtectionDomain().getCodeSource();
118 if (source == null) {
119 LOG.warning("Could not obtain path for '" + aRelativePath +
120 "' for class " + aTestClass + ", using relative path as is");
122 return new File(aRelativePath);
125 URL location = source.getLocation();
126 String protocol = location.getProtocol();
128 if (!protocol.equals("file")) {
129 LOG.warning("protocol is not 'file': " + location);
131 return new File(aRelativePath);
134 String path = location.getPath();
137 path = URLDecoder.decode(location.getPath(), "UTF-8");
138 } catch (UnsupportedEncodingException e) {
139 // ignore it.. just don't decode
140 LOG.log(Level.WARNING, "Decoding path failed: '" +
141 location.getPath() + "'", e);
144 return new File(new File(path).getParentFile(), aRelativePath);
148 * Ensures that a directory hierarchy exists (recursively if needed). If it
149 * is not possible to create the directory, then the test case will fail.
152 * Directory to create.
154 public static void createDir(File aDir) {
155 if (aDir.exists() && !aDir.isDirectory()) {
156 TestCase.fail("'" + aDir +
157 "' already exists and is not a directory");
164 createDir(aDir.getParentFile());
165 TestCase.assertTrue("Could not create '" + aDir + "'", aDir.mkdir());
169 * Creates a file in a directory.
172 * Directory path. Will be created if it does not exist.
178 public static void createFile(File aDir, String aName, InputStream aContents) {
182 OutputStream os = new FileOutputStream(new File(aDir, aName));
183 copyStream(aContents, os);
184 } catch (IOException e) {
186 TestCase.fail(e.getMessage());
191 * Gets the test output directory for a specific test class.
195 * @return Test output directory.
197 public static File getTestOutputDir(Class aTestClass) {
198 File file = getPath(TEST_OUTPUT_DIR, aTestClass);
199 String className = aTestClass.getName();
200 String classRelPath = className.replaceAll("\\.", "/");
202 return new File(file, classRelPath);
206 * Gets the test input directory for a specific test class.
210 * @return Test input directory.
212 public static File getTestInputDir(Class aTestClass) {
213 File file = getPath(TEST_INPUT_DIR, aTestClass);
214 String packageName = aTestClass.getPackage().getName();
215 String packagePath = packageName.replaceAll("\\.", "/");
217 return new File(file, packagePath);
221 * Creates a directory hierarchy for the output directory of a test class if
226 * @return Test directory.
228 public static File createTestOutputDir(Class aTestClass) {
229 File file = getTestOutputDir(aTestClass);
236 * Gets a test output file name. This returns a File object representing the
237 * output file and ensures that the directory where the file will be created
246 public static File getTestOutputFile(String aName, Class aTestClass) {
247 File file = new File(getTestOutputDir(aTestClass), aName);
248 createDir(file.getParentFile());
253 public static String read(InputStream aIs) throws IOException {
255 StringBuffer buffer = new StringBuffer();
258 while ((c = aIs.read()) != -1) {
259 buffer.append((char) c);
262 return buffer.toString();
269 * Copies an input stream to an output stream.
276 public static void copyStream(InputStream aIs, OutputStream aOs) {
280 while ((c = aIs.read()) != -1) {
286 } catch (IOException e) {
288 Assert.fail(e.getMessage());
293 * Recursively copy a directory.
300 public static void copyDir(File aSrc, File aTarget) {
301 Assert.assertTrue(aSrc.isDirectory());
302 Assert.assertTrue(!aTarget.exists());
304 if (!aTarget.mkdirs()) {
305 Assert.fail("Could not create target directory '" + aTarget + "'");
308 File[] files = aSrc.listFiles();
310 for (int i = 0; i < files.length; i++) {
311 File file = files[i];
313 if (file.isDirectory()) {
314 if (!file.getName().equals(".svn")) {
315 copyDir(new File(aSrc, file.getName()), new File(aTarget,
319 copyFile(file, new File(aTarget, file.getName()));
325 * Copy a file. If copying fails then the testcase will fail.
332 public static void copyFile(File aSrc, File aTarget) {
334 FileInputStream fis = new FileInputStream(aSrc);
335 FileOutputStream fos = new FileOutputStream(aTarget);
336 FileChannel fcin = fis.getChannel();
337 FileChannel fcout = fos.getChannel();
340 MappedByteBuffer mbb = fcin.map(FileChannel.MapMode.READ_ONLY, 0,
351 } catch (IOException e) {
352 Assert.assertTrue("Copying file " + aSrc.getPath() + " to " +
353 aTarget.getPath() + " failed.", false);
358 * Remove all files within a given directory including the directory itself.
359 * This only attempts to remove regular files and not directories within the
360 * directory. If the directory contains a nested directory, the deletion
361 * will fail. The test case will fail if this fails.
364 * Directory to remove.
366 public static void deleteDir(File aDir) {
372 * Remove all regular files within a given directory.
374 * @param aDir Directory to clean.
376 public static void cleanDir(File aDir) {
377 if (!aDir.exists()) {
378 return; // nothing to do.
381 File[] entries = aDir.listFiles();
383 for (int i = 0; i < entries.length; i++) {
384 File file = entries[i];
387 Assert.assertTrue("Could not delete " + entries[i].getPath(),
388 entries[i].delete());