org.testng.internal.Yaml Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of testng Show documentation
Show all versions of testng Show documentation
A testing framework for the JVM
package org.testng.internal;
import org.testng.xml.XmlClass;
import org.testng.xml.XmlInclude;
import org.testng.xml.XmlPackage;
import org.testng.xml.XmlSuite;
import org.testng.xml.XmlTest;
import org.yaml.snakeyaml.TypeDescription;
import org.yaml.snakeyaml.constructor.Constructor;
import org.yaml.snakeyaml.nodes.Node;
import org.yaml.snakeyaml.nodes.NodeId;
import org.yaml.snakeyaml.nodes.ScalarNode;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.InputStream;
import java.util.List;
import java.util.Map;
/**
* YAML support for TestNG.
*
* @author Cedric Beust
*/
public class Yaml {
public static XmlSuite parse(String filePath, InputStream is)
throws FileNotFoundException {
Constructor constructor = new TestNGConstructor(XmlSuite.class);
{
TypeDescription suiteDescription = new TypeDescription(XmlSuite.class);
suiteDescription.putListPropertyType("packages", XmlPackage.class);
suiteDescription.putListPropertyType("listeners", String.class);
suiteDescription.putListPropertyType("tests", XmlTest.class);
suiteDescription.putListPropertyType("method-selectors", XmlMethodSelector.class);
constructor.addTypeDescription(suiteDescription);
}
{
TypeDescription testDescription = new TypeDescription(XmlTest.class);
testDescription.putListPropertyType("classes", XmlClass.class);
testDescription.putMapPropertyType("metaGroups", String.class, List.class);
testDescription.putListPropertyType("method-selectors", XmlMethodSelector.class);
constructor.addTypeDescription(testDescription);
}
org.yaml.snakeyaml.Yaml y = new org.yaml.snakeyaml.Yaml(constructor);
if (is == null) is = new FileInputStream(new File(filePath));
XmlSuite result = (XmlSuite) y.load(is);
result.setFileName(filePath);
// DEBUG
// System.out.println("[Yaml] " + result.toXml());
// Adjust XmlTest parents and indices
for (XmlTest t : result.getTests()) {
t.setSuite(result);
int index = 0;
for (XmlClass c : t.getClasses()) {
c.setIndex(index++);
}
}
return result;
}
private static void maybeAdd(StringBuilder sb, String key, Object value, Object def) {
maybeAdd(sb, "", key, value, def);
}
private static void maybeAdd(StringBuilder sb, String sp, String key, Object value, Object def) {
if (value != null && ! value.equals(def)) {
sb.append(sp).append(key).append(": ").append(value.toString()).append("\n");
}
}
/**
* The main entry point to convert an XmlSuite into YAML. This method is allowed to be used
* by external tools (e.g. Eclipse).
*/
public static StringBuilder toYaml(XmlSuite suite) {
StringBuilder result = new StringBuilder();
maybeAdd(result, "name", suite.getName(), null);
maybeAdd(result, "junit", suite.isJUnit(), XmlSuite.DEFAULT_JUNIT);
maybeAdd(result, "verbose", suite.getVerbose(), XmlSuite.DEFAULT_VERBOSE);
maybeAdd(result, "threadCount", suite.getThreadCount(), XmlSuite.DEFAULT_THREAD_COUNT);
maybeAdd(result, "dataProviderThreadCount", suite.getDataProviderThreadCount(),
XmlSuite.DEFAULT_DATA_PROVIDER_THREAD_COUNT);
maybeAdd(result, "timeOut", suite.getTimeOut(), null);
maybeAdd(result, "parallel", suite.getParallel(), XmlSuite.DEFAULT_PARALLEL);
maybeAdd(result, "skipFailedInvocationCounts", suite.skipFailedInvocationCounts(),
XmlSuite.DEFAULT_SKIP_FAILED_INVOCATION_COUNTS);
toYaml(result, "parameters", "", suite.getParameters());
toYaml(result, suite.getPackages());
if (suite.getListeners().size() > 0) {
result.append("listeners:\n");
toYaml(result, " ", suite.getListeners());
}
if (suite.getPackages().size() > 0) {
result.append("packages:\n");
toYaml(result, suite.getPackages());
}
if (suite.getTests().size() > 0) {
result.append("tests:\n");
for (XmlTest t : suite.getTests()) {
toYaml(result, " ", t);
}
}
if (suite.getChildSuites().size() > 0) {
result.append("suite-files:\n");
toYaml(result, " ", suite.getSuiteFiles());
}
return result;
}
private static void toYaml(StringBuilder result, String sp, XmlTest t) {
String sp2 = sp + " ";
result.append(sp).append("- name: ").append(t.getName()).append("\n");
maybeAdd(result, sp2, "junit", t.isJUnit(), XmlSuite.DEFAULT_JUNIT);
maybeAdd(result, sp2, "verbose", t.getVerbose(), XmlSuite.DEFAULT_VERBOSE);
maybeAdd(result, sp2, "timeOut", t.getTimeOut(), null);
maybeAdd(result, sp2, "parallel", t.getParallel(), XmlSuite.DEFAULT_PARALLEL);
maybeAdd(result, sp2, "skipFailedInvocationCounts", t.skipFailedInvocationCounts(),
XmlSuite.DEFAULT_SKIP_FAILED_INVOCATION_COUNTS);
maybeAdd(result, "preserveOrder", sp2, t.getPreserveOrder(), XmlSuite.DEFAULT_PRESERVE_ORDER);
toYaml(result, "parameters", sp2, t.getLocalParameters());
if (t.getIncludedGroups().size() > 0) {
result.append(sp2).append("includedGroups: [ ")
.append(Utils.join(t.getIncludedGroups(), ","))
.append(" ]\n");
}
if (t.getExcludedGroups().size() > 0) {
result.append(sp2).append("excludedGroups: [ ")
.append(Utils.join(t.getExcludedGroups(), ","))
.append(" ]\n");
}
Map> mg = t.getMetaGroups();
if (mg.size() > 0) {
result.append(sp2).append("metaGroups: { ");
boolean first = true;
for (Map.Entry> entry : mg.entrySet()) {
if (! first) result.append(", ");
result.append(entry.getKey()).append(": [ ")
.append(Utils.join(entry.getValue(), ",")).append(" ] ");
first = false;
}
result.append(" }\n");
}
if (t.getXmlPackages().size() > 0) {
result.append(sp2).append("xmlPackages:\n");
for (XmlPackage xp : t.getXmlPackages()) {
toYaml(result, sp2 + " - ", xp);
}
}
if (t.getXmlClasses().size() > 0) {
result.append(sp2).append("classes:\n");
for (XmlClass xc : t.getXmlClasses()) {
toYaml(result, sp2 + " ", xc);
}
}
result.append("\n");
}
private static void toYaml(StringBuilder result, String sp2, XmlClass xc) {
List im = xc.getIncludedMethods();
List em = xc.getExcludedMethods();
String name = im.size() > 0 || em.size() > 0 ? "name: " : "";
result.append(sp2).append("- " + name).append(xc.getName()).append("\n");
if (im.size() > 0) {
result.append(sp2 + " includedMethods:\n");
for (XmlInclude xi : im) {
toYaml(result, sp2 + " ", xi);
}
}
if (em.size() > 0) {
result.append(sp2 + " excludedMethods:\n");
toYaml(result, sp2 + " ", em);
}
}
private static void toYaml(StringBuilder result, String sp2, XmlInclude xi) {
result.append(sp2 + "- " + xi.getName()).append("\n");
}
private static void toYaml(StringBuilder result, String sp, List strings) {
for (String l : strings) {
result.append(sp).append("- ").append(l).append("\n");
}
}
private static final String SP = " ";
private static void toYaml(StringBuilder sb, List packages) {
if (packages.size() > 0) {
sb.append("packages:\n");
for (XmlPackage p : packages) {
toYaml(sb, " ", p);
}
}
for (XmlPackage p : packages) {
toYaml(sb, " ", p);
}
}
private static void toYaml(StringBuilder sb, String sp, XmlPackage p) {
sb.append(sp).append("name: ").append(p.getName()).append("\n");
generateIncludeExclude(sb, sp, "includes", p.getInclude());
generateIncludeExclude(sb, sp, "excludes", p.getExclude());
}
private static void generateIncludeExclude(StringBuilder sb, String sp,
String key, List includes) {
if (includes.size() > 0) {
sb.append(sp).append(" ").append(key).append("\n");
for (String inc : includes) {
sb.append(sp).append(" ").append(inc);
}
}
}
private static void mapToYaml(Map map, StringBuilder out) {
if (map.size() > 0) {
out.append("{ ");
boolean first = true;
for (Map.Entry e : map.entrySet()) {
if (! first) out.append(", ");
first = false;
out.append(e.getKey() + ": " + e.getValue());
}
out.append(" }\n");
}
}
private static void toYaml(StringBuilder sb, String key, String sp,
Map parameters) {
if (parameters.size() > 0) {
sb.append(sp).append(key).append(": ");
mapToYaml(parameters, sb);
}
}
private static class TestNGConstructor extends Constructor {
public TestNGConstructor(Class theRoot) {
super(theRoot);
yamlClassConstructors.put(NodeId.scalar, new ConstructParallelMode());
}
private class ConstructParallelMode extends ConstructScalar {
public Object construct(Node node) {
if (node.getType().equals(XmlSuite.ParallelMode.class)) {
String parallel = (String) constructScalar((ScalarNode) node);
return XmlSuite.ParallelMode.getValidParallel(parallel);
}
return super.construct(node);
}
}
}
}