| package org.apache.maven.plugin.assembly.testutils; |
| |
| /* |
| * 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. |
| */ |
| |
| import org.codehaus.plexus.util.FileUtils; |
| import org.codehaus.plexus.util.IOUtil; |
| |
| import java.io.File; |
| import java.io.FileReader; |
| import java.io.FileWriter; |
| import java.io.IOException; |
| import java.util.ArrayList; |
| import java.util.Iterator; |
| import java.util.List; |
| |
| public class TestFileManager |
| { |
| |
| public static final String TEMP_DIR_PATH = System.getProperty( "java.io.tmpdir" ); |
| |
| private final List<File> filesToDelete = new ArrayList<File>(); |
| |
| private final String baseFilename; |
| |
| private final String fileSuffix; |
| |
| private StackTraceElement callerInfo; |
| |
| private boolean warnAboutCleanup = false; |
| |
| public TestFileManager( final String baseFilename, final String fileSuffix ) |
| { |
| this.baseFilename = baseFilename; |
| this.fileSuffix = fileSuffix; |
| |
| initializeCleanupMonitoring(); |
| } |
| |
| private void initializeCleanupMonitoring() |
| { |
| callerInfo = new NullPointerException().getStackTrace()[2]; |
| |
| final Runnable warning = new Runnable() |
| { |
| |
| public void run() |
| { |
| maybeWarnAboutCleanUp(); |
| } |
| |
| }; |
| |
| Thread cleanupWarning = new Thread( warning ); |
| |
| Runtime.getRuntime() |
| .addShutdownHook( cleanupWarning ); |
| } |
| |
| private void maybeWarnAboutCleanUp() |
| { |
| if ( warnAboutCleanup ) |
| { |
| System.out.println( "[WARNING] TestFileManager from: " + callerInfo.getClassName() + " not cleaned up!" ); |
| } |
| } |
| |
| public void markForDeletion( final File toDelete ) |
| { |
| filesToDelete.add( toDelete ); |
| warnAboutCleanup = true; |
| } |
| |
| public synchronized File createTempDir() |
| { |
| try |
| { |
| Thread.sleep( 20 ); |
| } |
| catch ( final InterruptedException ignore ) |
| { |
| } |
| |
| final File dir = new File( TEMP_DIR_PATH, baseFilename + System.currentTimeMillis() ); |
| |
| //noinspection ResultOfMethodCallIgnored |
| dir.mkdirs(); |
| markForDeletion( dir ); |
| |
| return dir; |
| } |
| |
| public synchronized File createTempFile() throws IOException |
| { |
| final File tempFile = File.createTempFile( baseFilename, fileSuffix ); |
| tempFile.deleteOnExit(); |
| markForDeletion( tempFile ); |
| |
| return tempFile; |
| } |
| |
| public void cleanUp() |
| { |
| for ( final Iterator<File> it = filesToDelete.iterator(); it.hasNext(); ) |
| { |
| final File file = it.next(); |
| |
| if ( file.exists() ) |
| { |
| try |
| { |
| FileUtils.forceDelete( file ); |
| } |
| catch ( final Exception e ) |
| { |
| System.err.println( "Error while deleting test file/dir: " + file + "; ignoring." ); |
| } |
| } |
| |
| it.remove(); |
| } |
| |
| warnAboutCleanup = false; |
| } |
| |
| /** |
| * NOTE: the file content is written using platform encoding. |
| */ |
| @SuppressWarnings( "ResultOfMethodCallIgnored" ) |
| public File createFile( final File dir, final String filename, final String contents ) throws IOException |
| { |
| final File file = new File( dir, filename ); |
| |
| file.getParentFile() |
| .mkdirs(); |
| |
| FileWriter writer = null; |
| |
| try |
| { |
| writer = new FileWriter( file ); // platform encoding |
| |
| writer.write( contents ); |
| } |
| finally |
| { |
| IOUtil.close( writer ); |
| } |
| |
| markForDeletion( file ); |
| |
| return file; |
| } |
| |
| /** |
| * NOTE: the file content is read using platform encoding. |
| */ |
| public String getFileContents( final File file ) throws IOException |
| { |
| String result = null; |
| |
| FileReader reader = null; |
| try |
| { |
| reader = new FileReader( file ); // platform encoding |
| |
| result = IOUtil.toString( reader ); |
| } |
| finally |
| { |
| IOUtil.close( reader ); |
| } |
| |
| return result; |
| } |
| |
| @Override |
| protected void finalize() throws Throwable |
| { |
| maybeWarnAboutCleanUp(); |
| |
| super.finalize(); |
| } |
| |
| } |