DBRRetrievalTest.java

/*******************************************************************************
 * Copyright (c) 2011 The Board of Trustees of the Leland Stanford Junior University
 * as Operator of the SLAC National Accelerator Laboratory.
 * Copyright (c) 2011 Brookhaven National Laboratory.
 * EPICS archiver appliance is distributed subject to a Software License Agreement found
 * in file LICENSE that is included with this distribution.
 *******************************************************************************/
package org.epics.archiverappliance.retrieval.client;



import static org.junit.Assert.assertTrue;

import java.sql.Timestamp;
import java.util.LinkedList;

import org.apache.log4j.Logger;
import org.epics.archiverappliance.Event;
import org.epics.archiverappliance.EventStream;
import org.epics.archiverappliance.EventStreamDesc;
import org.epics.archiverappliance.TomcatSetup;
import org.epics.archiverappliance.common.TimeUtils;
import org.epics.archiverappliance.config.ArchDBRTypes;
import org.epics.archiverappliance.config.ConfigServiceForTests;
import org.epics.archiverappliance.retrieval.GenerateData;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;

/**
 * Unit test to make sure the client retrieval libraries can retrieval all the DBR types.
 * @author mshankar
 *
 */
public class DBRRetrievalTest {
	private static final Logger logger = Logger.getLogger(DBRRetrievalTest.class.getName());
	TomcatSetup tomcatSetup = new TomcatSetup();
	private final class DataDBR { 
		String pvName;
		ArchDBRTypes type;
		public DataDBR(String pvName, ArchDBRTypes type) {
			this.pvName = pvName;
			this.type = type;
		}
	}
	
	private LinkedList<DataDBR> dataDBRs = new LinkedList<DataDBR>();


	@Before
	public void setUp() throws Exception {
		
		for(ArchDBRTypes type : ArchDBRTypes.values()) {
			dataDBRs.add(new DataDBR(ConfigServiceForTests.ARCH_UNIT_TEST_PVNAME_PREFIX + (type.isWaveForm() ? "V_" : "S_") + type.getPrimitiveName(), type));
		}

		for(DataDBR dataDBR : dataDBRs) {
			GenerateData.generateSineForPV(dataDBR.pvName, 0, dataDBR.type);
		}
		tomcatSetup.setUpWebApps(this.getClass().getSimpleName());	
	}

	@After
	public void tearDown() throws Exception {
		tomcatSetup.tearDown();
	}
	
	@Test
	public void testGetDataForDBRs() {
		RawDataRetrievalAsEventStream rawDataRetrieval = new RawDataRetrievalAsEventStream("http://localhost:" + ConfigServiceForTests.RETRIEVAL_TEST_PORT+ "/retrieval/data/getData.raw");
		Timestamp start = TimeUtils.convertFromISO8601String(TimeUtils.getCurrentYear() + "-02-01T08:00:00.000Z");
		Timestamp end = TimeUtils.convertFromISO8601String(TimeUtils.getCurrentYear() + "-02-02T08:00:00.000Z");
		
		for(DataDBR dataDBR : dataDBRs) {
			EventStream stream = null;
			try {
				logger.info("Testing retrieval for DBR " + dataDBR.type.toString());
				stream = rawDataRetrieval.getDataForPVS(new String[] { dataDBR.pvName }, start, end, new RetrievalEventProcessor() {
					@Override
					public void newPVOnStream(EventStreamDesc desc) {
						logger.info("Getting data for PV " + desc.getPvName());
					}
				});

				long previousEpochSeconds = 0; 
				
				// Make sure we get the DBR type we expect
				assertTrue(stream.getDescription().getArchDBRType().equals(dataDBR.type));

				// We are making sure that the stream we get back has times in sequential order...
				for(Event e : stream) {
					long actualSeconds = e.getEpochSeconds();
					assertTrue(actualSeconds >= previousEpochSeconds);
					previousEpochSeconds = actualSeconds;
				}
			} finally {
				if(stream != null) try { stream.close(); stream = null; } catch(Throwable t) { }
			}
		}
	}

}