2 * Copyright 2006 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;
18 import junit.framework.Assert;
19 import junit.framework.TestCase;
21 import org.apache.commons.logging.Log;
22 import org.apache.commons.logging.LogFactory;
25 import java.io.FileInputStream;
26 import java.io.FileOutputStream;
27 import java.io.IOException;
28 import java.io.InputStream;
29 import java.io.OutputStream;
30 import java.io.UnsupportedEncodingException;
33 import java.net.URLDecoder;
35 import java.nio.MappedByteBuffer;
36 import java.nio.channels.FileChannel;
38 import java.security.CodeSource;
42 * File system utilities.
44 * @author Erik Brakkee
46 public final class FileSystemUtils {
47 private static final Log LOG = LogFactory.getLog(FileSystemUtils.class);
50 * Test output directory relative to the sub project.
52 private static final String TEST_OUTPUT_DIR = "../target/testoutput";
55 * Test input directory relative to the sub project.
57 private static final String TEST_INPUT_DIR = "../src/test/resources";
63 private FileSystemUtils() {
68 * Deletes a directory recursively. The test case will fail if the directory
69 * does not exist or if deletion fails.
72 * Directory to delete.
74 public static void deleteDirRecursively(String aDir) {
75 deleteDirRecursively(new File(aDir));
79 * Deletes a directory recursively. See {@link #deleteDirRecursively}.
84 public static void deleteDirRecursively(File aDir) {
85 TestCase.assertTrue(aDir.isDirectory());
87 for (File file : aDir.listFiles()) {
88 if (file.isDirectory()) {
89 deleteDirRecursively(file);
99 * Deletes a file or directory. The test case will fail if the file or
100 * directory does not exist or if deletion fails. Deletion of a non-empty
101 * directory will always fail.
104 * File or directory to delete.
106 public static void delete(File aFile) {
107 TestCase.assertTrue(aFile.delete());
111 * Gets a path relative to a sub project. This utility should be used to
112 * easily access file paths within a subproject without requiring any
113 * specific Eclipse configuration.
115 * @param aRelativePath
120 public static File getPath(String aRelativePath, Class aTestClass) {
121 CodeSource source = aTestClass.getProtectionDomain().getCodeSource();
123 if (source == null) {
124 LOG.warn("Could not obtain path for '" + aRelativePath +
125 "' for class " + aTestClass + ", using relative path as is");
127 return new File(aRelativePath);
130 URL location = source.getLocation();
131 String protocol = location.getProtocol();
133 if (!protocol.equals("file")) {
134 LOG.warn("protocol is not 'file': " + location);
136 return new File(aRelativePath);
139 String path = location.getPath();
142 path = URLDecoder.decode(location.getPath(), "UTF-8");
143 } catch (UnsupportedEncodingException e) {
144 // ignore it.. just don't decode
145 LOG.warn("Decoding path failed: '" + location.getPath() + "'", e);
148 return new File(new File(path).getParentFile(), aRelativePath);
152 * Ensures that a directory hierarchy exists (recursively if needed). If it
153 * is not possible to create the directory, then the test case will fail.
156 * Directory to create.
158 public static void createDir(File aDir) {
159 if (aDir.exists() && !aDir.isDirectory()) {
160 TestCase.fail("'" + aDir +
161 "' already exists and is not a directory");
168 createDir(aDir.getParentFile());
169 TestCase.assertTrue("Could not create '" + aDir + "'", aDir.mkdir());
173 * Creates a file in a directory.
174 * @param aDir Directory path. Will be created if it does not exist.
175 * @param aName Filename.
176 * @param aContents Contents.
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());
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()),
314 new File(aTarget, file.getName()));
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());