Unverified Commit aba36868 authored by Nicolas Harrand's avatar Nicolas Harrand Committed by GitHub
Browse files

test(DefaultPrettyPrinter): Check that DefaultPrettyPrinter is checkstyle compliant (#3634)

Co-authored-by: Martin Monperrus's avatarMartin Monperrus <martin.monperrus@gnieh.org>
parent 54914867
......@@ -516,7 +516,11 @@ public class SpoonPom implements SpoonResource {
return classpathElements.toArray(new String[0]);
private static String guessMavenHome() {
* Try to guess Maven home when none is provided.
* @return the path toward maven install on the local machine.
public static String guessMavenHome() {
String mvnHome = null;
try {
String[] cmd;
......@@ -16,13 +16,32 @@
package spoon.test.prettyprinter;
import org.apache.commons.io.FileUtils;
import org.apache.commons.io.IOUtils;
import org.apache.logging.log4j.Logger;
import org.apache.maven.model.Model;
import org.apache.maven.model.Plugin;
import org.apache.maven.model.Profile;
import org.apache.maven.model.io.xpp3.MavenXpp3Reader;
import org.apache.maven.model.io.xpp3.MavenXpp3Writer;
import org.apache.maven.shared.invoker.DefaultInvocationRequest;
import org.apache.maven.shared.invoker.DefaultInvoker;
import org.apache.maven.shared.invoker.InvocationRequest;
import org.apache.maven.shared.invoker.InvocationResult;
import org.apache.maven.shared.invoker.Invoker;
import org.apache.maven.shared.invoker.MavenInvocationException;
import org.codehaus.plexus.util.xml.Xpp3Dom;
import org.codehaus.plexus.util.xml.pull.XmlPullParserException;
import org.junit.Ignore;
import org.junit.Test;
import spoon.Launcher;
import spoon.MavenLauncher;
import spoon.SpoonException;
import spoon.SpoonModelBuilder;
import spoon.compiler.Environment;
import spoon.compiler.SpoonResource;
import spoon.compiler.SpoonResourceHelper;
import spoon.pattern.Match;
import spoon.reflect.CtModel;
import spoon.reflect.code.CtCodeSnippetStatement;
import spoon.reflect.code.CtConstructorCall;
......@@ -42,19 +61,35 @@ import spoon.reflect.visitor.Query;
import spoon.reflect.visitor.filter.NamedElementFilter;
import spoon.reflect.visitor.filter.TypeFilter;
import spoon.support.JavaOutputProcessor;
import spoon.support.compiler.SpoonPom;
import spoon.test.imports.ImportTest;
import spoon.test.prettyprinter.testclasses.AClass;
import spoon.testing.utils.ModelUtils;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.FileReader;
import java.io.IOException;
import java.nio.file.Paths;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.Date;
import java.util.HashMap;
import java.util.HashSet;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Properties;
import java.util.Set;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertTrue;
import static spoon.testing.utils.ModelUtils.build;
......@@ -416,4 +451,101 @@ public class DefaultPrettyPrinterTest {
assertEquals(expected, result);
* This test parses Spoon sources (src/main/java) and pretty prints them in a temporary directory
* to check the compliance of the pretty printer to the set of checkstyle rules used by the Spoon repo.
* As the test takes a long time to run, it is only meant to detect exemples of violation that can, then, be
* used as unit test.
* Note that this test can be reused to check the compliance of any pretty printer with any set of styling rules.
@Ignore // ignored as long as 1) it is too long 2) we don't implement a SpoonCompliantPrettyPrinter
public void testCheckstyleCompliance() throws IOException, XmlPullParserException {
File tmpDir = new File("./target/tmp-checkstyle");
if(tmpDir.exists()) {
//Build spoon AST and pretty print it in tmpDir
Launcher launcher = new Launcher();
launcher.setSourceOutputDirectory(tmpDir.getPath() + "/src/main/java");
//copy pom and modify relative path
File originalPom = new File("pom.xml");
File tmpPom = new File(tmpDir, "pom.xml");
MavenXpp3Reader pomReader = new MavenXpp3Reader();
try (FileReader reader = new FileReader(originalPom)) {
Model model = pomReader.read(reader);
model.getParent().setRelativePath("../../" + model.getParent().getRelativePath());
Plugin checkstyle = null;
for(Plugin p : model.getBuild().getPlugins()) {
if(p.getArtifactId().equals("maven-checkstyle-plugin")) {
checkstyle = p;
Xpp3Dom config = (Xpp3Dom) checkstyle.getConfiguration();
//config.setAttribute("configLocation", "../../checkstyle.xml");
MavenXpp3Writer writer = new MavenXpp3Writer();
writer.write(new FileOutputStream(tmpPom), model);
//run checkstyle
//contract: PrettyPrinted sources should not contain errors
assertTrue(runCheckstyle(new File(SpoonPom.guessMavenHome()),tmpPom));
} catch (FileNotFoundException e) {
throw new IOException("Pom does not exists.");
private boolean runCheckstyle(File mvnHome, File pomFile) {
InvocationRequest request = new DefaultInvocationRequest();
Invoker invoker = new DefaultInvoker();
Map<String, List<String>> errors = new HashMap<>();
Pattern checkstylViolationPattern = Pattern.compile("\\[ERROR] [^\\s]* .* \\[[^\\s]*]");
invoker.setOutputHandler(s -> {
Matcher m = checkstylViolationPattern.matcher(s);
//System.out.println("r: " + s);
if(m.matches()) {
String fileName = s.split(" ")[1];
String violationName = "[" + s.split("\\[")[2];
List<String> files = errors.computeIfAbsent(violationName, str -> new LinkedList<>());
try {
InvocationResult result = invoker.execute(request);
System.err.println("Violations: ");
for(String violationName: errors.keySet()) {
System.err.println("V: " + violationName + " -> " + errors.get(violationName).size());
System.err.println(" Ex: " + errors.get(violationName).get(0));
return result.getExitCode() == 0;
} catch (MavenInvocationException e) {
return false;
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment