Environment.java
/*
* Copyright (c) 2011-2024 Qulice.com
*
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met: 1) Redistributions of source code must retain the above
* copyright notice, this list of conditions and the following
* disclaimer. 2) Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following
* disclaimer in the documentation and/or other materials provided
* with the distribution. 3) Neither the name of the Qulice.com nor
* the names of its contributors may be used to endorse or promote
* products derived from this software without specific prior written
* permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
* NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
* FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
* THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
* INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
* OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package com.qulice.spi;
import java.io.File;
import java.io.IOException;
import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.LinkedList;
import java.util.Map;
import java.util.Set;
import org.apache.commons.io.FileUtils;
import org.apache.commons.io.filefilter.DirectoryFileFilter;
import org.apache.commons.io.filefilter.IOFileFilter;
import org.apache.commons.io.filefilter.WildcardFileFilter;
/**
* Environment.
*
* @since 0.3
*/
@SuppressWarnings("PMD.TooManyMethods")
public interface Environment {
/**
* Get project's basedir.
* @return The directory
*/
File basedir();
/**
* Get directory to keep temporary files in.
* @return The directory
*/
File tempdir();
/**
* Get directory where <tt>.class</tt> files are stored.
* @return The directory
*/
File outdir();
/**
* Get parameter by name, and return default if it's not set.
* @param name The name of parameter
* @param value Default value to return as default
* @return The value
*/
String param(String name, String value);
/**
* Get classloader for this project.
* @return The classloader
*/
ClassLoader classloader();
/**
* Get list of paths in classpath.
* @return The collection of paths
*/
Collection<String> classpath();
/**
* Returns the files matching the specified pattern.
*
* <p>The pattern matching scheme used is wildcard matching. The characters
* '?' and '*' represents single or multiple wildcard characters,
* respectively. Pattern matching is case sensitive.
*
* @param pattern File name pattern.
* @return Collection of files, matching the specified pattern.
*/
Collection<File> files(String pattern);
/**
* Shall this item be excluded from report?
* @param check Name of the check that is asking
* @param name File or any other item, which is subject of validation
* @return TRUE if it should be ignored
*/
boolean exclude(String check, String name);
/**
* List of exclude patterns for given checker.
* Each list element will contain exactly one exclude pattern which,
* depending on the plugin that uses the excludes might be either wildcard
* (CodeNarc) pattern or regex pattern (FindBugs).
* @param checker Name of the checker that is asking (pmd, codenarc ...)
* @return Exclude patterns
*/
Collection<String> excludes(String checker);
/**
* Encoding for the files.
* @return Source files charset
*/
Charset encoding();
/**
* Mock of {@link Environment}.
*
* @since 0.1
*/
final class Mock implements Environment {
/**
* The basedir.
*/
private final File basedir;
/**
* Files for classpath.
*/
private final Set<String> classpath;
/**
* Map of params.
*/
private final Map<String, String> params;
/**
* Exclude patterns.
*/
private String excl;
/**
* Public ctor.
* @throws IOException If some IO problem
*/
@SuppressWarnings(
"PMD.ConstructorOnlyInitializesOrCallOtherConstructors"
)
public Mock() throws IOException {
this.params = new HashMap<>();
this.classpath = new HashSet<>(1);
final File temp = File.createTempFile(
"mock", ".qulice",
new File(System.getProperty("java.io.tmpdir"))
);
if (!temp.delete()) {
throw new IllegalStateException("files collision");
}
if (!temp.mkdirs()) {
throw new IllegalStateException("mkdir failed");
}
FileUtils.forceDeleteOnExit(temp);
this.basedir = new File(temp, "basedir");
if (this.basedir.mkdirs()) {
assert this.basedir != null;
}
this.classpath.add(
this.outdir().getAbsolutePath().replace(File.separatorChar, '/')
);
}
/**
* With this param and its value.
* @param name Param name
* @param value Param value
* @return This object
*/
public Environment.Mock withParam(final String name,
final String value) {
this.params.put(name, value);
return this;
}
/**
* With this file on board.
* @param name File name related to basedir
* @param content File content to write
* @return This object
* @throws IOException If some IO problem
*/
public Environment.Mock withFile(final String name,
final String content) throws IOException {
final File file = new File(this.basedir, name);
FileUtils.writeStringToFile(
file,
content,
StandardCharsets.UTF_8
);
return this;
}
/**
* With this file on board.
* @param name File name related to basedir
* @param bytes File content to write
* @return This object
* @throws IOException If some IO problem
*/
public Environment.Mock withFile(final String name,
final byte[] bytes) throws IOException {
final File file = new File(this.basedir, name);
FileUtils.writeByteArrayToFile(file, bytes);
return this;
}
/**
* With exclude patterns.
* @param excludes Exclude patterns
* @return This object
*/
public Environment.Mock withExcludes(final String excludes) {
this.excl = excludes;
return this;
}
/**
* With default classpath.
* @return This object
*/
@SuppressWarnings("PMD.AvoidInstantiatingObjectsInLoops")
public Environment.Mock withDefaultClasspath() {
Collections.addAll(
this.classpath,
System.getProperty("java.class.path")
.split(System.getProperty("path.separator"))
);
return this;
}
@Override
public File basedir() {
return this.basedir;
}
@Override
public File tempdir() {
final File file = new File(this.basedir, "target/tempdir");
if (file.mkdirs()) {
assert file != null;
}
return file;
}
@Override
public File outdir() {
final File file = new File(this.basedir, "target/classes");
if (file.mkdirs()) {
assert file != null;
}
return file;
}
@Override
public String param(final String name, final String value) {
String val = this.params.get(name);
if (val == null) {
val = value;
}
return val;
}
@Override
public ClassLoader classloader() {
return Thread.currentThread().getContextClassLoader();
}
@Override
public Collection<String> classpath() {
return Collections.unmodifiableCollection(this.classpath);
}
@Override
@SuppressWarnings("PMD.AvoidInstantiatingObjectsInLoops")
public Collection<File> files(final String pattern) {
final Collection<File> files = new LinkedList<>();
final IOFileFilter filter = WildcardFileFilter.builder().setWildcards(pattern).get();
for (final String dir : new String[]{"src"}) {
final File sources = new File(this.basedir(), dir);
if (sources.exists()) {
files.addAll(
FileUtils.listFiles(
sources,
filter,
DirectoryFileFilter.INSTANCE
)
);
}
}
return files;
}
@Override
public boolean exclude(final String check, final String name) {
return false;
}
@Override
public Collection<String> excludes(final String checker) {
final Collection<String> exc;
if (this.excl == null) {
exc = Collections.emptyList();
} else {
exc = Arrays.asList(this.excl.split(","));
}
return exc;
}
@Override
public Charset encoding() {
return StandardCharsets.UTF_8;
}
}
}