TestDescription.java

package com.samknows.measurement.schedule;

import java.io.Serializable;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Comparator;
import java.util.List;
import org.w3c.dom.Element;
import org.w3c.dom.NodeList;

import com.samknows.libcore.SKPorting;
import com.samknows.measurement.util.IdGenerator;
import com.samknows.measurement.util.OtherUtils;
import com.samknows.measurement.util.XmlUtils;
import com.samknows.tests.Param;
import com.samknows.tests.TestFactory;


public class TestDescription implements Serializable{

  // The test ids... as used in the SCHEDULE.XML
  // These are GROUPED tests...
  public enum SCHEDULE_TEST_ID {
    ALL_TESTS(-1), // Used ONLY when selecting a filter of tests to run.
    CLOSEST_TARGET_TEST(1),
    DOWNLOAD_TEST(2),
    UPLOAD_TEST(3),
    LATENCY_TEST(4); // This contains Jitter, Latency, Loss...

    private final int value;

    SCHEDULE_TEST_ID(int value) {
      this.value = value;
    }

    public int getValueAsInt() {
      return value;
    }

    public static SCHEDULE_TEST_ID sGetTestIdForInt(int value) {
      if (value ==  SCHEDULE_TEST_ID.ALL_TESTS.value) {
        return SCHEDULE_TEST_ID.ALL_TESTS;
      } else if (value ==  SCHEDULE_TEST_ID.CLOSEST_TARGET_TEST.value) {
        return SCHEDULE_TEST_ID.CLOSEST_TARGET_TEST;
      } else if (value ==  SCHEDULE_TEST_ID.DOWNLOAD_TEST.value) {
        return SCHEDULE_TEST_ID.DOWNLOAD_TEST;
      } else if (value ==  SCHEDULE_TEST_ID.UPLOAD_TEST.value) {
        return SCHEDULE_TEST_ID.UPLOAD_TEST;
      } else if (value ==  SCHEDULE_TEST_ID.LATENCY_TEST.value) {
        return SCHEDULE_TEST_ID.LATENCY_TEST;
      } else {
        SKPorting.sAssert(false);
        return SCHEDULE_TEST_ID.CLOSEST_TARGET_TEST;
      }
    }
  }

  private static final long serialVersionUID = 1L;
	
	//xml tag definition
	public static final String XML_TYPE = "type";
	public static final String XML_TEST_ID = "test-id";
	public static final String XML_CONDITION_GROUP_ID = "condition-group-id";
	public static final String XML_DISPLAY_NAME = "displayName";
	public static final String XML_IS_PRIMARY = "isPrimary";
	public static final String XML_TIME = "time";
	public static final String XML_PARAMS = "params";
	public static final String XML_PARAM = "param";
	public static final String XML_PARAM_NAME = "name";
	public static final String XML_PARAM_VALUE = "value";
	public static final String XML_POSITION = "position";
	public static final String XML_FIELD = "field";
	public static final String XML_FAILOVER_PARAMS = "failover-params";
	

	public static final long NO_START_TIME = -1;
	
	public final long id = IdGenerator.generate();

	public SCHEDULE_TEST_ID testId;
	public String type;//todo change to enum
	public boolean isPrimary = false;
	public String displayName;
	public String conditionGroupId;
	public long maxUsageBytes;
	public List<Long> times; //test start times during day
	
	public List<Param> params;
	public List<Param> failoverParams;
	public List<OutParamDescription> outParamsDescription;
	
	public static TestDescription parseXml(Element node) {
		TestDescription td = new TestDescription();
		td.type = node.getAttribute(XML_TYPE);
		String string_test_id = node.getAttribute(XML_TEST_ID);

		if(string_test_id != null && !string_test_id.equals("") ){
			int testIdAsInt = Integer.parseInt(string_test_id);
      td.testId = SCHEDULE_TEST_ID.sGetTestIdForInt(testIdAsInt);
		}

		td.conditionGroupId = node.getAttribute(XML_CONDITION_GROUP_ID);
		td.displayName = OtherUtils.stringEncoding(node.getAttribute(XML_DISPLAY_NAME));
		try {
			td.isPrimary = Boolean.valueOf(node.getAttribute(XML_IS_PRIMARY));
			
		} catch (Exception e) {
			td.isPrimary = false;
		}
		
		td.times = new ArrayList<>();
		NodeList list = node.getElementsByTagName(XML_TIME);
		for (int i = 0; i < list.getLength(); i++) {
			Element ep = (Element) list.item(i);
			Long time = XmlUtils.convertTestStartTime(ep.getFirstChild().getNodeValue());
			td.times.add(time);
		}
		Collections.sort(td.times, new Comparator<Long>() {
			@Override
			public int compare(Long lhs, Long rhs) {
				return lhs.compareTo(rhs);
			}
		});
		
		td.params = new ArrayList<>();
		NodeList params = node.getElementsByTagName(XML_PARAMS);
		if(params.getLength() == 1){
			NodeList test_params = ((Element)params.item(0)).getElementsByTagName(XML_PARAM);
			for (int i = 0; i < test_params.getLength(); i++) {
				Element ep = (Element) test_params.item(i);
				td.params.add(new Param(ep.getAttribute(XML_PARAM_NAME), ep.getAttribute(XML_PARAM_VALUE)));
			}
			td.maxUsageBytes = TestFactory.getMaxUsage(td.type,td.params);
		}
		
		
		
		NodeList failoverParams = node.getElementsByTagName(XML_FAILOVER_PARAMS);
		td.failoverParams = new ArrayList<>();
		if(failoverParams.getLength() == 1){
			NodeList test_params = ((Element)failoverParams.item(0)).getElementsByTagName(XML_PARAMS);
			for(int i=0; i< test_params.getLength(); i++){
				Element ep = (Element) test_params.item(i);
				td.failoverParams.add(new Param(ep.getAttribute(XML_PARAM_NAME), ep.getAttribute(XML_PARAM_VALUE)));
			}
		}
		
		td.outParamsDescription = new ArrayList<>();
		NodeList outParams = node.getElementsByTagName(XML_FIELD);
		for (int i = 0; i < outParams.getLength(); i++) {
			Element ep = (Element) outParams.item(i);
			OutParamDescription pd = new OutParamDescription();
			pd.name = ep.getAttribute(XML_PARAM_NAME);
			pd.idx = Integer.parseInt(ep.getAttribute(XML_POSITION));
			td.outParamsDescription.add(pd);
		}
		return td;
	}

	@Override
	public int hashCode() {
		final int prime = 31;
		int result = 1;
		result = prime * result + (int) (id ^ (id >>> 32));
		return result;
	}

	@Override
	public boolean equals(Object obj) {
		if (this == obj) {
      return true;
    }

		if (obj == null) {
      return false;
    }

		if (getClass() != obj.getClass()) {
      return false;
    }

		TestDescription other = (TestDescription) obj;
		return id == other.id;
	}
	
	public String getTypeString(){
		String hlp = TestFactory.getTestString(type, params);
		return hlp;
	}
}