ObjectUtilTest.java

/**
 * The contents of this file are subject to the OpenMRS Public License
 * Version 1.0 (the "License"); you may not use this file except in
 * compliance with the License. You may obtain a copy of the License at
 * http://license.openmrs.org
 *
 * Software distributed under the License is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the
 * License for the specific language governing rights and limitations
 * under the License.
 *
 * Copyright (C) OpenMRS, LLC.  All Rights Reserved.
 */
package org.openmrs.module.reporting.common;

import org.junit.Assert;
import org.junit.Before;
import org.junit.Test;
import org.openmrs.Concept;
import org.openmrs.ConceptClass;
import org.openmrs.ConceptName;
import org.openmrs.Encounter;
import org.openmrs.Location;
import org.openmrs.Obs;
import org.openmrs.PatientIdentifierType;
import org.openmrs.PersonName;
import org.openmrs.User;
import org.openmrs.api.ConceptNameType;
import org.openmrs.api.LocationService;
import org.openmrs.api.context.Context;
import org.openmrs.module.reporting.ReportingConstants;
import org.openmrs.module.reporting.ReportingModuleActivator;
import org.openmrs.test.BaseModuleContextSensitiveTest;
import org.openmrs.test.Verifies;

import java.util.Arrays;
import java.util.Date;
import java.util.List;
import java.util.Locale;
import java.util.Map;


/**
 * Tests methods on on ObjectUtil
 */
public class ObjectUtilTest extends BaseModuleContextSensitiveTest {

    protected static final String XML_DATASET_PATH = "org/openmrs/module/reporting/include/";

    protected static final String XML_REPORT_TEST_DATASET = "ReportTestDataset";

	@Before
	public void setupObjectUtilTest() {
        new ReportingModuleActivator().contextRefreshed();
        ReportingConstants.clearGlobalPropertyCache();
	}
    
	@Test
	public void sortShouldSortSimpleStrings() throws Exception {
		List<String> list = Arrays.asList(new String[] { "Daniel", "Abbas", "Kizito" });
		list = ObjectUtil.sort((list), null);
		Assert.assertEquals("Abbas", list.get(0));
		Assert.assertEquals("Daniel", list.get(1));
		Assert.assertEquals("Kizito", list.get(2));
	}
	
	@Test
	public void shouldSortObjectThatImplementComparable() throws Exception {
		PersonName personName1 = new PersonName("givenNamec", "middleName", "familyName");
		PersonName personName2 = new PersonName("givenNameb", "middleName", "familyName");
		PersonName personName3 = new PersonName("givenNamea", "middleName", "familyName");
		
		List<PersonName> list = Arrays.asList(new PersonName[] { personName1, personName2, personName3 });
		list = ObjectUtil.sort((list), null);
		Assert.assertEquals(personName3, list.get(0));
		Assert.assertEquals(personName2, list.get(1));
		Assert.assertEquals(personName1, list.get(2));
	}
	
	@Test
	public void shouldSortObjectThatImplementComparableAsc() throws Exception {
		PersonName personName1 = new PersonName("givenNamec", "middleName", "familyName");
		PersonName personName2 = new PersonName("givenNameb", "middleName", "familyName");
		PersonName personName3 = new PersonName("givenNamea", "middleName", "familyName");
		
		List<PersonName> list = Arrays.asList(new PersonName[] { personName1, personName2, personName3 });
		list = ObjectUtil.sort((list), "asc");
		Assert.assertEquals(personName3, list.get(0));
		Assert.assertEquals(personName2, list.get(1));
		Assert.assertEquals(personName1, list.get(2));
	}
	
	@Test
	public void shouldSortObjectThatImplementComparableDesc() throws Exception {
		PersonName personName1 = new PersonName("givenNameb", "middleName", "familyName");
		PersonName personName2 = new PersonName("givenNamea", "middleName", "familyName");
		PersonName personName3 = new PersonName("givenNamec", "middleName", "familyName");
		
		List<PersonName> list = Arrays.asList(new PersonName[] { personName1, personName2, personName3 });
		list = ObjectUtil.sort((list), "desc");
		Assert.assertEquals(personName3, list.get(0));
		Assert.assertEquals(personName1, list.get(1));
		Assert.assertEquals(personName2, list.get(2));
	}
	
	@Test
	public void shouldSortOnSinglePropertyWithDefaultSortOrder() throws Exception {
		PersonName personName1 = new PersonName("givenNamec", "middleNamea", "familyName");
		PersonName personName2 = new PersonName("givenNameb", "middleNameb", "familyName");
		PersonName personName3 = new PersonName("givenNamea", "middleNamec", "familyName");
		
		List<PersonName> list = Arrays.asList(new PersonName[] { personName1, personName2, personName3 });
		list = ObjectUtil.sort((list), "givenName");
		Assert.assertEquals(personName3, list.get(0));
		Assert.assertEquals(personName2, list.get(1));
		Assert.assertEquals(personName1, list.get(2));
	}
	
	@Test
	public void shouldSortOnSinglePropertyAsc() throws Exception {
		PersonName personName1 = new PersonName("givenNamec", "middleNamea", "familyName");
		PersonName personName2 = new PersonName("givenNameb", "middleNameb", "familyName");
		PersonName personName3 = new PersonName("givenNamea", "middleNamec", "familyName");
		
		List<PersonName> list = Arrays.asList(new PersonName[] { personName1, personName2, personName3 });
		list = ObjectUtil.sort((list), "givenName asc");
		Assert.assertEquals(personName3, list.get(0));
		Assert.assertEquals(personName2, list.get(1));
		Assert.assertEquals(personName1, list.get(2));
	}
	
	@Test
	public void shouldSortOnSinglePropertyDesc() throws Exception {
		PersonName personName1 = new PersonName("givenNamec", "middleNamea", "familyName");
		PersonName personName2 = new PersonName("givenNameb", "middleNameb", "familyName");
		PersonName personName3 = new PersonName("givenNamea", "middleNamec", "familyName");
		
		List<PersonName> list = Arrays.asList(new PersonName[] { personName1, personName2, personName3 });
		list = ObjectUtil.sort((list), "givenName desc");
		Assert.assertEquals(personName1, list.get(0));
		Assert.assertEquals(personName2, list.get(1));
		Assert.assertEquals(personName3, list.get(2));
	}
	
	@Test
	public void shouldSortOnTwoProperties() throws Exception {
		PersonName personName1 = new PersonName("givenNamec", "middleNamea", "familyName");
		PersonName personName2 = new PersonName("givenNameb", "middleNameb", "familyName");
		PersonName personName3 = new PersonName("givenNamea", "middleNamec", "familyName");
		
		List<PersonName> list = Arrays.asList(new PersonName[] { personName1, personName2, personName3 });
		list = ObjectUtil.sort((list), "middleName, givenName");
		Assert.assertEquals(personName1, list.get(0));
		Assert.assertEquals(personName2, list.get(1));
		Assert.assertEquals(personName3, list.get(2));
	}
	
	@Test
	public void shouldSortOnThreeProperties() throws Exception {
		PersonName personName1 = new PersonName("givenNamec", "middleNamea", "familyName");
		PersonName personName2 = new PersonName("givenNameb", "middleNameb", "familyName");
		PersonName personName3 = new PersonName("givenNamea", "middleNamec", "familyName");
		
		List<PersonName> list = Arrays.asList(new PersonName[] { personName1, personName2, personName3 });
		list = ObjectUtil.sort((list), "familyName, middleName, givenName");
		Assert.assertEquals(personName1, list.get(0));
		Assert.assertEquals(personName2, list.get(1));
		Assert.assertEquals(personName3, list.get(2));
	}
	
	@Test
	public void shouldSortOnNestedProperties() throws Exception {
		PersonName personName1 = new PersonName("givenNamec", "middleNamea", "familyName");
		PersonName personName2 = new PersonName("givenNameb", "middleNameb", "familyName");
		PersonName personName3 = new PersonName("givenNamea", "middleNamec", "familyName");
		
		personName1.setCreator(new User(3));
		personName2.setCreator(new User(1));
		personName3.setCreator(new User(2));
		
		List<PersonName> list = Arrays.asList(new PersonName[] { personName1, personName2, personName3 });
		list = ObjectUtil.sort((list), "familyName, creator.userId");
		Assert.assertEquals(personName2, list.get(0));
		Assert.assertEquals(personName3, list.get(1));
		Assert.assertEquals(personName1, list.get(2));
	}
	
	@Test
	public void shouldSortOnNestedPropertiesDesc() throws Exception {
		PersonName personName1 = new PersonName("givenNamec", "middleNamea", "familyName");
		PersonName personName2 = new PersonName("givenNameb", "middleNameb", "familyName");
		PersonName personName3 = new PersonName("givenNamea", "middleNamec", "familyName");
		
		personName1.setCreator(new User(3));
		personName2.setCreator(new User(1));
		personName3.setCreator(new User(2));
		
		List<PersonName> list = Arrays.asList(new PersonName[] { personName1, personName2, personName3 });
		list = ObjectUtil.sort((list), "familyName, creator.userId desc");
		Assert.assertEquals(personName1, list.get(0));
		Assert.assertEquals(personName3, list.get(1));
		Assert.assertEquals(personName2, list.get(2));
	}
	
	@Test
	public void shouldSortNullsLastAsc() throws Exception {
		PersonName personName1 = new PersonName(null, "middleNamea", "familyName");
		PersonName personName2 = new PersonName("givenNameb", "middleNameb", "familyName");
		PersonName personName3 = new PersonName("givenNamea", "middleNamec", "familyName");
		
		List<PersonName> list = Arrays.asList(new PersonName[] { personName1, personName2, personName3 });
		list = ObjectUtil.sort((list), "givenName");
		Assert.assertEquals(personName3, list.get(0));
		Assert.assertEquals(personName2, list.get(1));
		Assert.assertEquals(personName1, list.get(2));
	}
	
	@Test
	public void shouldSortNullsLastDesc() throws Exception {
		PersonName personName1 = new PersonName(null, "middleNamea", "familyName");
		PersonName personName2 = new PersonName("givenNameb", "middleNameb", "familyName");
		PersonName personName3 = new PersonName("givenNamea", "middleNamec", "familyName");
		
		List<PersonName> list = Arrays.asList(new PersonName[] { personName1, personName2, personName3 });
		list = ObjectUtil.sort((list), "givenName desc");
		Assert.assertEquals(personName2, list.get(0));
		Assert.assertEquals(personName3, list.get(1));
		Assert.assertEquals(personName1, list.get(2));
	}
	
	@Test
	public void shouldSortObjectThatDontImplementComparable() throws Exception {
		ConceptClass conceptClass1 = new ConceptClass(3);
		ConceptClass conceptClass2 = new ConceptClass(1);
		ConceptClass conceptClass3 = new ConceptClass(4);
		ConceptClass conceptClass4 = new ConceptClass(2);
		
		List<ConceptClass> list = Arrays.asList(new ConceptClass[] { conceptClass1, conceptClass2, conceptClass3, conceptClass4 });
		list = org.openmrs.module.reporting.common.ObjectUtil.sort((list), "conceptClassId");
		Assert.assertEquals(conceptClass2, list.get(0));
		Assert.assertEquals(conceptClass4, list.get(1));
		Assert.assertEquals(conceptClass1, list.get(2));
		Assert.assertEquals(conceptClass3, list.get(3));
	}

    @Test
    @Verifies(value="shouldReturnNullIfNoFormatterPresent", method="getLocalization(OpenmrsMetadata md)")
    public void shouldReturnNullIfNoFormatterPresent() {
        Location location = new Location();
        location.setName("Test name");
        Assert.assertNull(ObjectUtil.getLocalization(location, new Locale("en")));
    }

    @Test
    @Verifies(value="shouldReturnTheDefaultOpenmrsMetadataNames", method="format(OpenmrsMetadata md)")
    public void shouldReturnTheDefaultOpenmrsMetadataNames() throws Exception {
        String metadataName = "Never Never Land";
        executeDataSet(XML_DATASET_PATH + new TestUtil().getTestDatasetFilename(XML_REPORT_TEST_DATASET));
		LocationService locationService = Context.getLocationService();
		Location location = locationService.getLocation(metadataName);
        String formattedName = ObjectUtil.format(location);
        Assert.assertEquals(metadataName, formattedName);

        metadataName = "OpenMRS Identification Number";
        PatientIdentifierType patientIdentifierType = Context.getPatientService().getPatientIdentifierTypeByName(metadataName);
        formattedName = ObjectUtil.format(patientIdentifierType);
        Assert.assertEquals(metadataName, formattedName);
    }

    @Test
    public void shouldLocalizedObsBasedOnDefaultLocale() throws Exception {
        executeDataSet(XML_DATASET_PATH + new TestUtil().getTestDatasetFilename(XML_REPORT_TEST_DATASET));
        addLocalizedNamesToYesConcept();
        Assert.assertEquals("YES", ObjectUtil.format(createObsWithValueCodedYes()));
    }

    @Test
    public void shouldLocalizeObsBasedOnLocaleGlobalProperty() throws Exception {
        executeDataSet(XML_DATASET_PATH + new TestUtil().getTestDatasetFilename(XML_REPORT_TEST_DATASET));
        addLocalizedNamesToYesConcept();
		String previousLocale = TestUtil.getGlobalProperty(ReportingConstants.DEFAULT_LOCALE_GP_NAME);
		TestUtil.updateGlobalProperty(ReportingConstants.DEFAULT_LOCALE_GP_NAME, "es");
        Assert.assertEquals("Si", ObjectUtil.format(createObsWithValueCodedYes()));
		TestUtil.updateGlobalProperty(ReportingConstants.DEFAULT_LOCALE_GP_NAME, previousLocale);
    }

	@Test
	public void shouldCreateAMapFromAString() throws Exception {
		String toParse = "Key1=Value1,Key2=Value2";
		Map<String, String> m = ObjectUtil.toMap(toParse);
		Assert.assertEquals(2, m.size());
		Assert.assertEquals("Value1", m.get("Key1"));
		Assert.assertEquals("Value2", m.get("Key2"));

		toParse = "Key1:Value1|Key2:Value2";
		m = ObjectUtil.toMap(toParse, ":", "|");
		Assert.assertEquals(2, m.size());
		Assert.assertEquals("Value1", m.get("Key1"));
		Assert.assertEquals("Value2", m.get("Key2"));
	}

	@Test
	public void shouldFormatMultiplePropertiesOnOpenmrsData() {
		// <encounter encounter_id="3" encounter_type="2" patient_id="7" location_id="1" form_id="1" encounter_datetime="2008-08-01 00:00:00.0" creator="1" date_created="2008-08-18 14:09:05.0" voided="false" void_reason="" uuid="6519d653-393b-4118-9c83-a3715b82d4ac"/>
		Encounter e = Context.getEncounterService().getEncounter(3);
		String s = ObjectUtil.format(e, "Encounter {encounterId} has type {encounterType} and date {encounterDatetime|yyyy-MM-dd}");
		Assert.assertEquals("Encounter 3 has type Emergency and date 2008-08-01", s);
	}

	@Test
	public void shouldFormatDateWithAppropriateFormat() {
		String previousLocale = TestUtil.getGlobalProperty(ReportingConstants.DEFAULT_LOCALE_GP_NAME);
		String previousFormat = TestUtil.getGlobalProperty(ReportingConstants.GLOBAL_PROPERTY_DEFAULT_DATE_FORMAT);

		Date d = DateUtil.getDateTime(2014,1,14);
		Assert.assertEquals("14-Jan-2014", ObjectUtil.format(d, "dd-MMM-yyyy"));
		Assert.assertEquals("14/01/2014", ObjectUtil.format(d));
		TestUtil.updateGlobalProperty(ReportingConstants.GLOBAL_PROPERTY_DEFAULT_DATE_FORMAT, "MMMM dd, yyyy");
		Assert.assertEquals("January 14, 2014", ObjectUtil.format(d));
		TestUtil.updateGlobalProperty(ReportingConstants.DEFAULT_LOCALE_GP_NAME, "es");
		Assert.assertEquals("enero 14, 2014", ObjectUtil.format(d));

		TestUtil.updateGlobalProperty(ReportingConstants.GLOBAL_PROPERTY_DEFAULT_DATE_FORMAT, previousFormat);
		TestUtil.updateGlobalProperty(ReportingConstants.DEFAULT_LOCALE_GP_NAME, previousLocale);
	}

	@Test
	public void shouldFormatConcept() throws Exception {
		Concept wt = Context.getConceptService().getConcept(5089);
		Assert.assertEquals("WEIGHT (KG)", ObjectUtil.format(wt));
		LoadConceptThread t = new LoadConceptThread(5497);
		t.start();
		t.join();
		Assert.assertEquals("Concept#5497", ObjectUtil.format(t.getConcept()));
	}

    @Test
    public void shouldNotFailIfNoMessageSourceBeanPresent() throws Exception {
        MessageUtil.setMessageSource(null);
        Location location = Context.getLocationService().getLocation(2);
        Assert.assertEquals("Xanadu", ObjectUtil.format(location));
    }

    // hack to add a few localized names to concept
    private void addLocalizedNamesToYesConcept() {

        Concept yes = Context.getConceptService().getConcept(7);
	    yes.getPreferredName(Locale.ENGLISH).setConceptNameType(ConceptNameType.FULLY_SPECIFIED);
        
        ConceptName oui = new ConceptName();
        oui.setName("Oui");
        oui.setLocale(new Locale("fr"));

        ConceptName si = new ConceptName();
        si.setName("Si");
        si.setLocale(new Locale("es"));
        
        yes.addName(oui);
        yes.addName(si);
        
        Context.getConceptService().saveConcept(yes);        
    }

    private Obs createObsWithValueCodedYes() {
        Obs yes = new Obs();
        yes.setConcept(Context.getConceptService().getConcept(12));
        yes.setValueCoded(Context.getConceptService().getConcept(7));
        return yes;
    }

	private class LoadConceptThread extends Thread {
		Integer conceptId = null;
		Concept cd4 = null;

		public LoadConceptThread(Integer conceptId) {
			this.conceptId = conceptId;
		}

		public void run() {
			try {
				Context.openSession();
				Context.authenticate("admin", "test");
				cd4 = Context.getConceptService().getConcept(conceptId);
			}
			finally {
				Context.clearSession();
				Context.closeSession();
			}
		}
		public Concept getConcept() {
			return cd4;
		}
	}
}