org.sahagin.share.srctree.TestClass Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sahagin Show documentation
Sahagin makes your Selenium script more readable and maintainable.
There is a newer version: 0.10.1
package org.sahagin.share.srctree;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import org.sahagin.share.yaml.YamlUtils;
import org.sahagin.share.yaml.YamlConvertException;
import org.sahagin.share.yaml.YamlConvertible;

// class or interface
public class TestClass implements YamlConvertible {
    public static final String MSG_INVALID_TYPE = "invalid type: %s";
    public static final String TYPE = "class";
    private static final String DEFAULT_TYPE = TYPE;

    private String key;
    private String qualifiedName;
    private String testDoc;
    private List testMethodKeys = new ArrayList(16);
    private List testMethods = new ArrayList(16);

    public String getKey() {
        return key;
    }

    public void setKey(String key) {
        this.key = key;
    }

    public String getSimpleName() {
        if (qualifiedName == null) {
            return null;
        }
        int lastIndex = qualifiedName.lastIndexOf("."); // TODO name separator is always dot ??
        if (lastIndex == -1) {
            return qualifiedName;
        }
        return qualifiedName.substring(lastIndex + 1);
    }

    public String getQualifiedName() {
        return qualifiedName;
    }

    public void setQualifiedName(String qualifiedName) {
        this.qualifiedName = qualifiedName;
    }

    public String getTestDoc() {
        return testDoc;
    }

    public void setTestDoc(String testDoc) {
        this.testDoc = testDoc;
    }

    public List getTestMethodKeys() {
        return testMethodKeys;
    }

    public void addTestMethodKey(String testMethodKey) {
        this.testMethodKeys.add(testMethodKey);
    }

    public List getTestMethods() {
        return testMethods;
    }

    public void addTestMethod(TestMethod testMethod) {
        testMethods.add(testMethod);
    }

    public void clearTestMethods() {
        testMethods.clear();
    }

    protected String getType() {
        return TYPE;
    }

    @Override
    public Map toYamlObject() {
        Map result = new HashMap(8);
        result.put("key", key);
        result.put("qname", qualifiedName);
        if (!getType().equals(DEFAULT_TYPE)) {
            result.put("type", getType());
        }
        if (testDoc != null) {
            result.put("testDoc", testDoc);
        }
        if (!testMethodKeys.isEmpty()) {
            result.put("methodKeys", testMethodKeys);
        }
        return result;
    }

    @Override
    public void fromYamlObject(Map yamlObject)
            throws YamlConvertException {
        YamlUtils.strValueEqualsCheck(yamlObject, "type", getType(), DEFAULT_TYPE);
        key = YamlUtils.getStrValue(yamlObject, "key");
        qualifiedName = YamlUtils.getStrValue(yamlObject, "qname");
        testDoc = YamlUtils.getStrValue(yamlObject, "testDoc", true);
        testMethodKeys = YamlUtils.getStrListValue(yamlObject, "methodKeys", true);
        testMethods.clear();
    }

    public static TestClass newInstanceFromYamlObject(Map yamlObject)
            throws YamlConvertException {
        String type = YamlUtils.getStrValue(yamlObject, "type", true);
        if (type == null) {
            type = DEFAULT_TYPE;
        }
        TestClass result;
        if (TestClass.TYPE.equals(type)) {
            result = new TestClass();
        } else if (PageClass.TYPE.equals(type)) {
            result = new PageClass();
        } else {
            throw new YamlConvertException(String.format(MSG_INVALID_TYPE, type));
        }
        result.fromYamlObject(yamlObject);
        return result;
    }

}