SingleEventTimeBasedIteratorTest.java

package edu.stanford.slac.archiverappliance.PlainPB;

import static org.junit.Assert.assertTrue;

import java.io.File;
import java.nio.file.Path;

import org.apache.commons.io.FileUtils;
import org.epics.archiverappliance.Event;
import org.epics.archiverappliance.common.BasicContext;
import org.epics.archiverappliance.common.PartitionGranularity;
import org.epics.archiverappliance.common.TimeUtils;
import org.epics.archiverappliance.common.YearSecondTimestamp;
import org.epics.archiverappliance.config.ArchDBRTypes;
import org.epics.archiverappliance.config.ConfigService;
import org.epics.archiverappliance.config.ConfigServiceForTests;
import org.epics.archiverappliance.config.StoragePluginURLParser;
import org.epics.archiverappliance.data.ScalarValue;
import org.epics.archiverappliance.engine.membuf.ArrayListEventStream;
import org.epics.archiverappliance.retrieval.RemotableEventStreamDesc;
import org.epics.archiverappliance.utils.simulation.SimulationEvent;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;

import edu.stanford.slac.archiverappliance.PlainPB.PlainPBStoragePlugin.CompressionMode;

/**
 * Bug where we could not get data for 015-PSD1:VoltRef.
 * This had one event in the STS/MTS which was between the starttime and the end time. 
 * The FileBackedPBEventStreamTimeBasedIterator should return a one event stream at least in this case.
 * @author mshankar
 *
 */
public class SingleEventTimeBasedIteratorTest {
	String rootFolderName = ConfigServiceForTests.getDefaultPBTestFolder() + "/" + "SingleEventTimeBasedIteratorTest/";
	File rootFolder = new File(rootFolderName);
	static String pvName = ConfigServiceForTests.ARCH_UNIT_TEST_PVNAME_PREFIX + "SingleEventTimeBasedIteratorTest";
	PlainPBStoragePlugin pbplugin;
	private ConfigService configService;
	static ArchDBRTypes type = ArchDBRTypes.DBR_SCALAR_DOUBLE;

	@Before
	public void setUp() throws Exception {
		configService = new ConfigServiceForTests(new File("./bin"));
		pbplugin = (PlainPBStoragePlugin) StoragePluginURLParser.parseStoragePlugin("pb://localhost?name=STS&rootFolder=" + rootFolderName + "&partitionGranularity=PARTITION_HOUR", configService);
	}

	@After
	public void tearDown() throws Exception {
		File rootFolder = new File(pbplugin.getRootFolder());
		if(rootFolder.exists()) { 
			FileUtils.deleteDirectory(rootFolder);
		}
	}

	@Test
	public void testSingleEvent() throws Exception {
		File rootFolder = new File(pbplugin.getRootFolder());
		if(rootFolder.exists()) { 
			FileUtils.deleteDirectory(rootFolder);
		}
		
		// Generate one event on Feb 21 in the current year.
		try(BasicContext context = new BasicContext()) {
			ArrayListEventStream testData = new ArrayListEventStream(24*60*60, new RemotableEventStreamDesc(type, pvName, (short) 2013));
			YearSecondTimestamp eventTs = TimeUtils.convertToYearSecondTimestamp(TimeUtils.convertFromISO8601String("2013-02-21T18:45:08.570Z"));
			testData.add(new SimulationEvent(eventTs, type, new ScalarValue<Double>((double) 6.855870246887207)));
			pbplugin.appendData(context, pvName, testData);
		}
		
		try(BasicContext context = new BasicContext()) {
			Path[] paths = PlainPBPathNameUtility.getAllPathsForPV(context.getPaths(), rootFolderName, pvName, ".pb", PartitionGranularity.PARTITION_HOUR, CompressionMode.NONE, configService.getPVNameToKeyConverter());
			assertTrue("We should get only one file, instead we got " + paths.length, paths.length == 1);
			long eventCount = 0;
			try(FileBackedPBEventStream strm = new FileBackedPBEventStream(pvName, paths[0], type, 
					TimeUtils.convertFromISO8601String("2013-02-19T10:45:08.570Z"),
					TimeUtils.convertFromISO8601String("2013-02-22T10:45:08.570Z"),	false)) { 
				for(@SuppressWarnings("unused") Event event : strm) { 
					eventCount++;
				}
			}
			assertTrue("We should get at least one event; instead we got " + eventCount, eventCount == 1);
		}
	}

}