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.getName());
45 * Test output directory relative to the sub project.
47 private static final String TEST_OUTPUT_DIR = "../target/testoutput";
50 * Test input directory relative to the sub project.
52 private static final String TEST_INPUT_DIR = "../src/test/resources";
57 private FileSystemUtils() {
62 * Deletes a directory recursively. The test case will fail if the directory
63 * does not exist or if deletion fails.
66 * Directory to delete.
68 public static void deleteDirRecursively(String aDir) {
69 deleteDirRecursively(new File(aDir));
73 * Deletes a directory recursively. See {@link #deleteDirRecursively}.
78 public static void deleteDirRecursively(File aDir) {
79 TestCase.assertTrue(aDir.isDirectory());
81 for (File file : aDir.listFiles()) {
82 if (file.isDirectory()) {
83 deleteDirRecursively(file);
93 * Deletes a file or directory. The test case will fail if the file or
94 * directory does not exist or if deletion fails. Deletion of a non-empty
95 * directory will always fail.
98 * File or directory to delete.
100 public static void delete(File aFile) {
101 TestCase.assertTrue(aFile.delete());
105 * Gets a path relative to a sub project. This utility should be used to
106 * easily access file paths within a subproject without requiring any
107 * specific Eclipse configuration.
109 * @param aRelativePath
114 public static File getPath(String aRelativePath, Class aTestClass) {
115 CodeSource source = aTestClass.getProtectionDomain().getCodeSource();
117 if (source == null) {
118 LOG.warning("Could not obtain path for '" + aRelativePath +
119 "' for class " + aTestClass + ", using relative path as is");
121 return new File(aRelativePath);
124 URL location = source.getLocation();
125 String protocol = location.getProtocol();
127 if (!protocol.equals("file")) {
128 LOG.warning("protocol is not 'file': " + location);
130 return new File(aRelativePath);
133 String path = location.getPath();
136 path = URLDecoder.decode(location.getPath(), "UTF-8");
137 } catch (UnsupportedEncodingException e) {
138 // ignore it.. just don't decode
139 LOG.log(Level.WARNING, "Decoding path failed: '" + location.getPath() + "'", e);
142 return new File(new File(path).getParentFile(), aRelativePath);
146 * Ensures that a directory hierarchy exists (recursively if needed). If it
147 * is not possible to create the directory, then the test case will fail.
150 * Directory to create.
152 public static void createDir(File aDir) {
153 if (aDir.exists() && !aDir.isDirectory()) {
154 TestCase.fail("'" + aDir +
155 "' already exists and is not a directory");
162 createDir(aDir.getParentFile());
163 TestCase.assertTrue("Could not create '" + aDir + "'", aDir.mkdir());
167 * Creates a file in a directory.
170 * Directory path. Will be created if it does not exist.
176 public static void createFile(File aDir, String aName, InputStream aContents) {
180 OutputStream os = new FileOutputStream(new File(aDir, aName));
181 copyStream(aContents, os);
182 } catch (IOException e) {
184 TestCase.fail(e.getMessage());
189 * Gets the test output directory for a specific test class.
193 * @return Test output directory.
195 public static File getTestOutputDir(Class aTestClass) {
196 File file = getPath(TEST_OUTPUT_DIR, aTestClass);
197 String className = aTestClass.getName();
198 String classRelPath = className.replaceAll("\\.", "/");
200 return new File(file, classRelPath);
204 * Gets the test input directory for a specific test class.
208 * @return Test input directory.
210 public static File getTestInputDir(Class aTestClass) {
211 File file = getPath(TEST_INPUT_DIR, aTestClass);
212 String packageName = aTestClass.getPackage().getName();
213 String packagePath = packageName.replaceAll("\\.", "/");
215 return new File(file, packagePath);
219 * Creates a directory hierarchy for the output directory of a test class if
224 * @return Test directory.
226 public static File createTestOutputDir(Class aTestClass) {
227 File file = getTestOutputDir(aTestClass);
234 * Gets a test output file name. This returns a File object representing the
235 * output file and ensures that the directory where the file will be created
244 public static File getTestOutputFile(String aName, Class aTestClass) {
245 File file = new File(getTestOutputDir(aTestClass), aName);
246 createDir(file.getParentFile());
251 public static String read(InputStream aIs) throws IOException {
253 StringBuffer buffer = new StringBuffer();
256 while ((c = aIs.read()) != -1) {
257 buffer.append((char) c);
260 return buffer.toString();
267 * Copies an input stream to an output stream.
274 public static void copyStream(InputStream aIs, OutputStream aOs) {
278 while ((c = aIs.read()) != -1) {
284 } catch (IOException e) {
286 Assert.fail(e.getMessage());
291 * Recursively copy a directory.
298 public static void copyDir(File aSrc, File aTarget) {
299 Assert.assertTrue(aSrc.isDirectory());
300 Assert.assertTrue(!aTarget.exists());
302 if (!aTarget.mkdirs()) {
303 Assert.fail("Could not create target directory '" + aTarget + "'");
306 File[] files = aSrc.listFiles();
308 for (int i = 0; i < files.length; i++) {
309 File file = files[i];
311 if (file.isDirectory()) {
312 if (!file.getName().equals(".svn")) {
313 copyDir(new File(aSrc, file.getName()), new File(aTarget,
317 copyFile(file, new File(aTarget, file.getName()));
323 * Copy a file. If copying fails then the testcase will fail.
330 public static void copyFile(File aSrc, File aTarget) {
332 FileInputStream fis = new FileInputStream(aSrc);
333 FileOutputStream fos = new FileOutputStream(aTarget);
334 FileChannel fcin = fis.getChannel();
335 FileChannel fcout = fos.getChannel();
338 MappedByteBuffer mbb = fcin.map(FileChannel.MapMode.READ_ONLY, 0,
349 } catch (IOException e) {
350 Assert.assertTrue("Copying file " + aSrc.getPath() + " to " +
351 aTarget.getPath() + " failed.", false);
356 * Remove all files within a given directory including the directory itself.
357 * This only attempts to remove regular files and not directories within the
358 * directory. If the directory contains a nested directory, the deletion
359 * will fail. The test case will fail if this fails.
362 * Directory to remove.
364 public static void deleteDir(File aDir) {
370 * Remove all regular files within a given directory.
372 * @param outputDirName
374 public static void cleanDir(File aDir) {
375 if (!aDir.exists()) {
376 return; // nothing to do.
379 File[] entries = aDir.listFiles();
381 for (int i = 0; i < entries.length; i++) {
382 File file = entries[i];
385 Assert.assertTrue("Could not delete " + entries[i].getPath(),
386 entries[i].delete());