log4j-api-test/src/main/java/org/apache/logging/log4j/test/junit/AbstractExternalFileCleaner.java

/*
 * 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.logging.log4j.test.junit;

import java.io.File;
import java.io.IOException;
import java.io.PrintStream;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.Arrays;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;

import org.junit.Assert;
import org.junit.rules.ExternalResource;

/**
 * This class should not perform logging using Log4j to avoid accidentally
 * loading or re-loading Log4j configurations.
 */
public abstract class AbstractExternalFileCleaner extends ExternalResource {

	protected static final String CLEANER_MARKER = "CLEANER";

	private static final int SLEEP_RETRY_MILLIS = 200;
	private final boolean cleanAfter;
	private final boolean cleanBefore;
	private final Set<Path> files;
	private final int maxTries;
	private final PrintStream printStream;

	public AbstractExternalFileCleaner(final boolean before, final boolean after, final int maxTries,
			final PrintStream logger, final File... files) {
		this.cleanBefore = before;
		this.cleanAfter = after;
		this.maxTries = maxTries;
		this.files = new HashSet<>(files.length);
		this.printStream = logger;
		for (final File file : files) {
			this.files.add(file.toPath());
		}
	}

	public AbstractExternalFileCleaner(final boolean before, final boolean after, final int maxTries,
			final PrintStream logger, final Path... files) {
		this.cleanBefore = before;
		this.cleanAfter = after;
		this.maxTries = maxTries;
		this.printStream = logger;
		this.files = new HashSet<>(Arrays.asList(files));
	}

	public AbstractExternalFileCleaner(final boolean before, final boolean after, final int maxTries,
			final PrintStream logger, final String... fileNames) {
		this.cleanBefore = before;
		this.cleanAfter = after;
		this.maxTries = maxTries;
		this.printStream = logger;
		this.files = new HashSet<>(fileNames.length);
		for (final String fileName : fileNames) {
			this.files.add(Paths.get(fileName));
		}
	}

	@Override
	protected void after() {
		if (cleanAfter()) {
			this.clean();
		}
	}

	@Override
	protected void before() {
		if (cleanBefore()) {
			this.clean();
		}
	}

	protected void clean() {
		final Map<Path, IOException> failures = new HashMap<>();
		// Clean and gather failures
		for (final Path path : getPaths()) {
			if (Files.exists(path)) {
				for (int i = 0; i < getMaxTries(); i++) {
					try {
						if (clean(path, i)) {
							if (failures.containsKey(path)) {
								failures.remove(path);
							}
							break;
						}
					} catch (final IOException e) {
						println(CLEANER_MARKER + ": Caught exception cleaning: " + this);
						printStackTrace(e);
						// We will try again.
						failures.put(path, e);
					}
					try {
						Thread.sleep(SLEEP_RETRY_MILLIS);
					} catch (final InterruptedException ignored) {
						// ignore
					}
				}
			}
		}
		// Fail on failures
		if (failures.size() > 0) {
			final StringBuilder sb = new StringBuilder();
			boolean first = true;
			for (final Map.Entry<Path, IOException> failure : failures.entrySet()) {
				failure.getValue().printStackTrace();
				if (!first) {
					sb.append(", ");
				}
				sb.append(failure.getKey()).append(" failed with ").append(failure.getValue());
				first = false;
			}
			Assert.fail(sb.toString());
		}
	}

	protected abstract boolean clean(Path path, int tryIndex) throws IOException;

	public boolean cleanAfter() {
		return cleanAfter;
	}

	public boolean cleanBefore() {
		return cleanBefore;
	}

	public int getMaxTries() {
		return maxTries;
	}

	public Set<Path> getPaths() {
		return files;
	}

	public PrintStream getPrintStream() {
		return printStream;
	}

	protected void printf(final String format, final Object... args) {
		if (printStream != null) {
		    printStream.printf(format, args);
		}
	}

	protected void println(final String msg) {
		if (printStream != null) {
		    printStream.println(msg);
		}
	}

	protected void printStackTrace(final Throwable t) {
		if (printStream != null) {
			t.printStackTrace(printStream);
		}
	}

	@Override
	public String toString() {
		return getClass().getSimpleName() + " [files=" + files + ", cleanAfter=" + cleanAfter + ", cleanBefore="
				+ cleanBefore + "]";
	}

}