PreferredIdentifierDataEvaluatorTest.java

package org.openmrs.module.reporting.data.patient.evaluator;

import org.junit.Assert;

import org.junit.Before;
import org.junit.Test;
import org.openmrs.Cohort;
import org.openmrs.PatientIdentifier;
import org.openmrs.api.context.Context;
import org.openmrs.module.reporting.common.TestUtil;
import org.openmrs.module.reporting.data.patient.EvaluatedPatientData;
import org.openmrs.module.reporting.data.patient.definition.PatientDataDefinition;
import org.openmrs.module.reporting.data.patient.definition.PreferredIdentifierDataDefinition;
import org.openmrs.module.reporting.data.patient.service.PatientDataService;
import org.openmrs.module.reporting.evaluation.EvaluationContext;
import org.openmrs.test.BaseContextSensitiveTest;
import org.openmrs.test.BaseModuleContextSensitiveTest;

public class PreferredIdentifierDataEvaluatorTest extends BaseModuleContextSensitiveTest {
	
	protected static final String XML_DATASET_PATH = "org/openmrs/module/reporting/include/";
	
	protected static final String XML_REPORT_TEST_DATASET = "ReportTestDataset";
	
	/**
	 * Run this before each unit test in this class. The "@Before" method in
	 * {@link BaseContextSensitiveTest} is run right before this method.
	 * 
	 * @throws Exception
	 */
	@Before
	public void setup() throws Exception {
		executeDataSet(XML_DATASET_PATH + new TestUtil().getTestDatasetFilename(XML_REPORT_TEST_DATASET));
	}
	
	/**
	 * @see PatientIdentifierDataEvaluator#evaluate(PatientDataDefinition,EvaluationContext)
	 * @verifies return the preferred identifier of the passed type for each patient in the passed context
	 */
	@Test
	public void evaluate_shouldReturnThePreferredIdentifierOfThePassedTypeForEachPatientInThePassedContext() throws Exception {
		
		EvaluationContext context = new EvaluationContext();
		context.setBaseCohort(new Cohort("2,6,7,8"));
		
		PreferredIdentifierDataDefinition d = new PreferredIdentifierDataDefinition();
		d.setIdentifierType(Context.getPatientService().getPatientIdentifierType(1));
		EvaluatedPatientData pd = Context.getService(PatientDataService.class).evaluate(d, context);
		
		Assert.assertEquals(3, pd.getData().size()); // TODO: Is this what we want, or do we want all 4 patients returned, with potential null results?
		Assert.assertEquals("101-6", getIdentifier(pd, 2));
		Assert.assertNull(pd.getData().get(6));
		Assert.assertEquals("6TS-4", getIdentifier(pd, 7));
		Assert.assertEquals("7TU-8",  getIdentifier(pd, 8));
	}

	/**
	 * @see PatientIdentifierDataEvaluator#evaluate(PatientDataDefinition,EvaluationContext)
	 * @verifies should limit the returned identifier to the configured location if set
	 */
	@Test
	public void evaluate_shouldLimitTheReturnedIdentifierToTheConfiguredLocationIfSet() throws Exception {

		EvaluationContext context = new EvaluationContext();
		context.setBaseCohort(new Cohort("2,6,7,8"));

		PreferredIdentifierDataDefinition d = new PreferredIdentifierDataDefinition();
		d.setIdentifierType(Context.getPatientService().getPatientIdentifierType(2));
		d.setLocation(Context.getLocationService().getLocation(1));

		EvaluatedPatientData pd = Context.getService(PatientDataService.class).evaluate(d, context);
		Assert.assertNull(getIdentifier(pd, 6));

		d.setLocation(null);
		pd = Context.getService(PatientDataService.class).evaluate(d, context);
		Assert.assertEquals("12345K", getIdentifier(pd, 6));

		d.setLocation(Context.getLocationService().getLocation(3));
		pd = Context.getService(PatientDataService.class).evaluate(d, context);
		Assert.assertEquals("12345K", getIdentifier(pd, 6));
	}

	private String getIdentifier(EvaluatedPatientData pd, Integer pId) {
		PatientIdentifier pi = (PatientIdentifier)pd.getData().get(pId);
		if (pi != null) {
			return pi.getIdentifier();
		}
		return null;
	}
}