com.itextpdf.test.WrappedSamplesRunner Maven / Gradle / Ivy
The newest version!
/*
This file is part of the iText (R) project.
Copyright (c) 1998-2021 iText Group NV
Authors: Bruno Lowagie, Paulo Soares, et al.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License version 3
as published by the Free Software Foundation with the addition of the
following permission added to Section 15 as permitted in Section 7(a):
FOR ANY PART OF THE COVERED WORK IN WHICH THE COPYRIGHT IS OWNED BY
ITEXT GROUP. ITEXT GROUP DISCLAIMS THE WARRANTY OF NON INFRINGEMENT
OF THIRD PARTY RIGHTS
This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program; if not, see http://www.gnu.org/licenses or write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA, 02110-1301 USA, or download the license from the following URL:
http://itextpdf.com/terms-of-use/
The interactive user interfaces in modified source and object code versions
of this program must display Appropriate Legal Notices, as required under
Section 5 of the GNU Affero General Public License.
In accordance with Section 7(b) of the GNU Affero General Public License,
a covered work must retain the producer line in every PDF that is created
or manipulated using iText.
You can be released from the requirements of the license by purchasing
a commercial license. Buying such a license is mandatory as soon as you
develop commercial activities involving the iText software without
disclosing the source code of your own applications.
These activities include: offering paid services to customers as an ASP,
serving PDFs on the fly in a web application, shipping iText with a closed
source product.
For more information, please contact iText Software Corp. at this
address: [email protected]
*/
package com.itextpdf.test;
import org.junit.Assert;
import org.junit.Assume;
import org.junit.runner.RunWith;
import org.junit.runners.Parameterized;
import java.io.File;
import java.lang.reflect.Field;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.nio.file.Paths;
import java.text.MessageFormat;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
@RunWith(Parameterized.class)
public abstract class WrappedSamplesRunner {
@Parameterized.Parameter
public RunnerParams sampleClassParams;
protected Class sampleClass;
private String errorMessage;
public static Collection generateTestsList() {
return generateTestsList(new RunnerSearchConfig().addPackageToRunnerSearchPath(""));
}
public static Collection generateTestsList(RunnerSearchConfig searchConfig) {
List params = new ArrayList();
for (String searchPath : searchConfig.getSearchPackages()) {
File classesFolder = Paths.get("target/classes", searchPath.replace(".", "/")).toFile();
File testClassesFolder = Paths.get("target/test-classes", searchPath.replace(".", "/")).toFile();
if (!searchPath.isEmpty()) searchPath += ".";
List samplesParamsList = getClassNamesRecursively(classesFolder, searchPath, searchConfig);
samplesParamsList.addAll(getClassNamesRecursively(testClassesFolder, searchPath, searchConfig));
for (RunnerParams sampleParam : samplesParamsList) {
params.add(new RunnerParams[] {sampleParam});
}
}
for (String className : searchConfig.getSearchClasses()) {
params.add(new RunnerParams[] {checkIfTestAndCreateParams(className, searchConfig)});
}
return params;
}
public void runSamples() throws Exception {
Assume.assumeTrue(sampleClassParams.ignoreMessage, sampleClassParams.ignoreMessage == null);
initClass();
System.out.println("Starting test " + sampleClassParams);
runMain();
String dest = getDest();
String cmp = getCmpPdf(dest);
if (dest == null || dest.isEmpty()) {
throw new IllegalArgumentException("Can't verify results, DEST field must not be empty!");
}
String outPath = getOutPath(dest);
new File(outPath).mkdirs();
System.out.println("Test executed successfully, comparing results...");
comparePdf(outPath, dest, cmp);
if (errorMessage != null)
Assert.fail(errorMessage);
System.out.println("Test complete.");
}
/**
* Compares two PDF files using iText's CompareTool.
* @param outPath The path to the working folder where comparison results and temp files will be created
* @param dest The PDF that resulted from the test
* @param cmp The reference PDF
* @throws Exception If there is a problem opening the compare files
*/
protected abstract void comparePdf(String outPath, String dest, String cmp) throws Exception;
/**
* Gets the path to the resulting PDF from the sample class;
* @return a path to a resulting PDF
*/
protected String getDest() {
return getStringField(sampleClass, "DEST");
}
protected String getCmpPdf(String dest) {
if (dest == null)
return null;
int i = dest.lastIndexOf("/");
return "./cmpfiles/" + dest.substring(8, i + 1) + "cmp_" + dest.substring(i + 1);
}
protected String getOutPath(String dest) {
return "./target/" + new File(dest).getParent();
}
/**
* Returns a string value that is stored as a static variable
* inside an example class.
* @param c The example class
* @param name The name of the variable
* @return The value of the variable
*/
protected static String getStringField(Class c, String name) {
try {
Field field = c.getField(name);
if (field == null)
return null;
Object obj = field.get(null);
if (obj == null || ! (obj instanceof String))
return null;
return (String)obj;
}
catch(Exception e) {
return null;
}
}
/**
* Creates a Class object for the example you want to test.
*/
protected void initClass() {
if (sampleClass == null) {
try {
sampleClass = Class.forName(sampleClassParams.className);
} catch (ClassNotFoundException e) {
throw new RuntimeException(sampleClassParams.className + " not found");
}
}
}
/**
* Helper method to construct error messages.
* @param error part of an error message.
*/
protected void addError(String error) {
if (error != null && error.length() > 0) {
if (errorMessage == null)
errorMessage = "";
else
errorMessage += "\n";
errorMessage += error;
}
}
private void runMain() throws IllegalAccessException, InvocationTargetException {
Method mainMethod = getMain(sampleClass);
if (mainMethod == null) {
throw new IllegalArgumentException("Class must have main method.");
}
mainMethod.invoke(null, new Object[] {null});
}
private static Method getMain(Class c) {
try {
return c.getDeclaredMethod("main", String[].class);
} catch (NoSuchMethodException e) {
return null;
}
}
private static List getClassNamesRecursively(File path, String currentFullName, RunnerSearchConfig searchConfig) {
List runnerParams = new ArrayList();
File[] files = path.listFiles();
if (files == null)
return runnerParams;
for (File file : files) {
if (file.isDirectory()) {
String[] splitted = file.getAbsolutePath().replace("\\", "/").split("/");
String packageName = splitted[splitted.length - 1];
runnerParams.addAll(getClassNamesRecursively(file, currentFullName + packageName + ".", searchConfig));
} else {
String fileName = file.getName();
if (fileName.endsWith(".class") && !fileName.contains("$")) {
String className = currentFullName + fileName.replace(".class", "");
RunnerParams params = checkIfTestAndCreateParams(className, searchConfig);
if (params != null) {
runnerParams.add(params);
}
}
}
}
return runnerParams;
}
private static RunnerParams checkIfTestAndCreateParams(String className, RunnerSearchConfig searchConfig) {
if (isIgnoredClassOrPackage(className, searchConfig)) {
return null;
}
Class c;
try {
c = Class.forName(className);
} catch (ClassNotFoundException e) {
throw new RuntimeException(MessageFormat.format("Cannot find class {0}", className), e);
}
RunnerParams params = new RunnerParams();
params.className = className;
return params;
}
private static boolean isIgnoredClassOrPackage(String fullName, RunnerSearchConfig searchConfig) {
for (String ignoredPath : searchConfig.getIgnoredPaths()) {
File currentFile = getFileByLocation("target/classes", ignoredPath);
if (currentFile == null) {
currentFile = getFileByLocation("target/test-classes", ignoredPath);
}
if (currentFile != null) {
if ((currentFile.isDirectory() && fullName.contains(ignoredPath))
|| (currentFile.isFile() && fullName.equals(ignoredPath))) {
return true;
}
}
}
return false;
}
private static File getFileByLocation(String targetSubDirectory, String filePath) {
File currentFile = Paths.get(targetSubDirectory, filePath.replace(".", "/")).toFile();
if (currentFile.exists()) {
return currentFile;
}
currentFile = Paths.get(targetSubDirectory, (filePath.replace(".", "/")) + ".class").toFile();
if (currentFile.exists()) {
return currentFile;
}
return null;
}
private static class RunnerParams {
String className;
String ignoreMessage;
@Override
public String toString() {
return className;
}
}
}