org.testng.JarFileUtils Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of testng Show documentation
A testing framework for the JVM
There is a newer version: 7.10.1
package org.testng;

import org.testng.collections.Lists;
import org.testng.internal.Utils;
import org.testng.reporters.Files;
import org.testng.util.Strings;
import org.testng.xml.IPostProcessor;
import org.testng.xml.Parser;
import org.testng.xml.XmlSuite;
import org.testng.xml.internal.TestNamesMatcher;
import org.testng.xml.internal.XmlSuiteUtils;

import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.util.Collection;
import java.util.Enumeration;
import java.util.List;
import java.util.jar.JarEntry;
import java.util.jar.JarFile;

/**
 * A Utility for extracting {@link XmlSuite} from a jar.
 */
class JarFileUtils {
    private final IPostProcessor processor;
    private final String xmlPathInJar;
    private final List testNames;
    private final List suites = Lists.newLinkedList();

    JarFileUtils(IPostProcessor processor, String xmlPathInJar, List testNames) {
        this.processor = processor;
        this.xmlPathInJar = xmlPathInJar;
        this.testNames = testNames;
    }

    List extractSuitesFrom(File jarFile) {
        try {

            Utils.log("TestNG", 2, "Trying to open jar file:" + jarFile);

            List classes = Lists.newArrayList();
            boolean foundTestngXml = testngXmlExistsInJar(jarFile, classes);
            if (!foundTestngXml) {
                Utils.log("TestNG", 1,
                        "Couldn't find the " + xmlPathInJar + " in the jar file, running all the classes");
                suites.add(XmlSuiteUtils.newXmlSuiteUsing(classes));
            }
        } catch (IOException ex) {
            throw new TestNGException(ex);
        }
        return suites;
    }

    private boolean testngXmlExistsInJar(File jarFile, List classes) throws IOException {
        boolean foundTestngXml = false;
        try (JarFile jf = new JarFile(jarFile)) {
            Enumeration entries = jf.entries();
            File file = java.nio.file.Files.createTempDirectory("testngXmlPathInJar-").toFile();
            String suitePath = null;
            while (entries.hasMoreElements()) {
                JarEntry je = entries.nextElement();
                String jeName = je.getName();
                if (Parser.canParse(jeName.toLowerCase())){ 
                    InputStream  inputStream = jf.getInputStream(je);
                    File copyFile = new File(file, jeName);
                    Files.copyFile(inputStream, copyFile);
                    if (matchesXmlPathInJar(je)) {
                        suitePath = copyFile.toString();
                    }
                } else if (isJavaClass(je)) {
                    classes.add(constructClassName(je));
                }
            }
            if (Strings.isNullOrEmpty(suitePath)) {
                return foundTestngXml;
            }
            Collection parsedSuites = Parser.parse(suitePath, processor); 
            for (XmlSuite suite : parsedSuites) {
                // If test names were specified, only run these test names
                if (testNames != null) {
                  TestNamesMatcher testNamesMatcher = new TestNamesMatcher(suite, testNames);
                  List missMatchedTestname = testNamesMatcher.getMissMatchedTestNames();
                  if (!missMatchedTestname.isEmpty()) {
                    throw new TestNGException("The test(s) <" + missMatchedTestname+ "> cannot be found.");
                  }
                  suites.addAll(testNamesMatcher.getSuitesMatchingTestNames());
                } else {
                  suites.add(suite);
                }
                return true;
              }
        }
        return foundTestngXml;
    }

    private boolean matchesXmlPathInJar(JarEntry je) {
        return je.getName().equals(xmlPathInJar);
    }

    private static boolean isJavaClass(JarEntry je) {
        return je.getName().endsWith(".class");
    }

    private static String constructClassName(JarEntry je) {
        int n = je.getName().length() - ".class".length();
        return je.getName().replace("/", ".").substring(0, n);
    }

}