Java tutorial
/** * This Source Code Form is subject to the terms of the Mozilla Public License, * v. 2.0. If a copy of the MPL was not distributed with this file, You can * obtain one at http://mozilla.org/MPL/2.0/. OpenMRS is also distributed under * the terms of the Healthcare Disclaimer located at http://openmrs.org/license. * * Copyright (C) OpenMRS Inc. OpenMRS is a registered trademark and the OpenMRS * graphic logo is a trademark of OpenMRS Inc. */ package org.openmrs.api; import junit.framework.Assert; import org.apache.commons.lang.StringUtils; import org.junit.After; import org.junit.Before; import org.junit.Test; import org.openmrs.Concept; import org.openmrs.Encounter; import org.openmrs.Location; import org.openmrs.Patient; import org.openmrs.Visit; import org.openmrs.VisitAttribute; import org.openmrs.VisitAttributeType; import org.openmrs.VisitType; import org.openmrs.api.context.Context; import org.openmrs.customdatatype.datatype.FreeTextDatatype; import org.openmrs.test.BaseContextSensitiveTest; import org.openmrs.test.TestUtil; import org.openmrs.test.Verifies; import org.openmrs.util.GlobalPropertiesTestHelper; import org.openmrs.util.OpenmrsConstants; import java.text.SimpleDateFormat; import java.util.ArrayList; import java.util.Calendar; import java.util.Collection; import java.util.Collections; import java.util.Date; import java.util.HashMap; import java.util.List; import java.util.Map; import static junit.framework.Assert.assertEquals; import static junit.framework.Assert.assertNotNull; import static junit.framework.Assert.assertTrue; /** * Tests methods in the {@link VisitService} * * @since 1.9 */ public class VisitServiceTest extends BaseContextSensitiveTest { protected static final String VISITS_WITH_DATES_XML = "org/openmrs/api/include/VisitServiceTest-otherVisits.xml"; protected static final String VISITS_ATTRIBUTES_XML = "org/openmrs/api/include/VisitServiceTest-visitAttributes.xml"; private GlobalPropertiesTestHelper globalPropertiesTestHelper; private VisitService visitService; @Before public void before() { visitService = Context.getVisitService(); // Allow overlapping visits. Ticket 3963 has introduced optional validation of start and stop dates // based on concurrent visits of the same patient. Turning this validation on (i.e. not allowing // overlapping visits) breaks existing tests of the visit service. // globalPropertiesTestHelper = new GlobalPropertiesTestHelper(Context.getAdministrationService()); globalPropertiesTestHelper.setGlobalProperty(OpenmrsConstants.GLOBAL_PROPERTY_ALLOW_OVERLAPPING_VISITS, "true"); } @Test @Verifies(value = "should get all visit types", method = "getAllVisitTypes()") public void getAllVisitTypes_shouldGetAllVisitTypes() throws Exception { List<VisitType> visitTypes = Context.getVisitService().getAllVisitTypes(); assertEquals(3, visitTypes.size()); } @Test @Verifies(value = "should get correct visit type", method = "getVisitType(Integer)") public void getVisitType_shouldGetCorrectVisitType() throws Exception { VisitType visitType = Context.getVisitService().getVisitType(1); assertNotNull(visitType); assertEquals("Initial HIV Clinic Visit", visitType.getName()); visitType = Context.getVisitService().getVisitType(2); assertNotNull(visitType); assertEquals("Return TB Clinic Visit", visitType.getName()); visitType = Context.getVisitService().getVisitType(3); assertNotNull(visitType); assertEquals("Hospitalization", visitType.getName()); visitType = Context.getVisitService().getVisitType(4); Assert.assertNull(visitType); } @Test @Verifies(value = "should get correct visit type", method = "getVisitTypeByUuid(String)") public void getVisitTypeByUuid_shouldGetCorrentVisitType() throws Exception { VisitType visitType = Context.getVisitService().getVisitTypeByUuid("c0c579b0-8e59-401d-8a4a-976a0b183519"); assertNotNull(visitType); assertEquals("Initial HIV Clinic Visit", visitType.getName()); visitType = Context.getVisitService().getVisitTypeByUuid("759799ab-c9a5-435e-b671-77773ada74e4"); assertNotNull(visitType); assertEquals("Return TB Clinic Visit", visitType.getName()); visitType = Context.getVisitService().getVisitTypeByUuid("759799ab-c9a5-435e-b671-77773ada74e6"); assertNotNull(visitType); assertEquals("Hospitalization", visitType.getName()); visitType = Context.getVisitService().getVisitTypeByUuid("759799ab-c9a5-435e-b671-77773ada74e1"); Assert.assertNull(visitType); } @Test @Verifies(value = "should get correct visit types", method = "getVisitTypes(String)") public void getVisitTypes_shouldGetCorrentVisitTypes() throws Exception { List<VisitType> visitTypes = Context.getVisitService().getVisitTypes("HIV Clinic"); assertNotNull(visitTypes); assertEquals(1, visitTypes.size()); assertEquals("Initial HIV Clinic Visit", visitTypes.get(0).getName()); visitTypes = Context.getVisitService().getVisitTypes("Clinic Visit"); assertNotNull(visitTypes); assertEquals(2, visitTypes.size()); assertEquals("Initial HIV Clinic Visit", visitTypes.get(0).getName()); assertEquals("Return TB Clinic Visit", visitTypes.get(1).getName()); visitTypes = Context.getVisitService().getVisitTypes("ClinicVisit"); assertNotNull(visitTypes); assertEquals(0, visitTypes.size()); } @Test @Verifies(value = "should save new visit type", method = "saveVisitType(VisitType)") public void saveVisitType_shouldSaveNewVisitType() throws Exception { List<VisitType> visitTypes = Context.getVisitService().getVisitTypes("Some Name"); assertEquals(0, visitTypes.size()); VisitType visitType = new VisitType("Some Name", "Description"); Context.getVisitService().saveVisitType(visitType); visitTypes = Context.getVisitService().getVisitTypes("Some Name"); assertEquals(1, visitTypes.size()); //Should create a new visit type row. assertEquals(4, Context.getVisitService().getAllVisitTypes().size()); } @Test @Verifies(value = "should save edited visit type", method = "saveVisitType(VisitType)") public void saveVisitType_shouldSaveEditedVisitType() throws Exception { VisitType visitType = Context.getVisitService().getVisitType(1); assertNotNull(visitType); assertEquals("Initial HIV Clinic Visit", visitType.getName()); visitType.setName("Edited Name"); visitType.setDescription("Edited Description"); Context.getVisitService().saveVisitType(visitType); visitType = Context.getVisitService().getVisitType(1); assertNotNull(visitType); assertEquals("Edited Name", visitType.getName()); assertEquals("Edited Description", visitType.getDescription()); //Should not change the number of visit types. assertEquals(3, Context.getVisitService().getAllVisitTypes().size()); } @Test @Verifies(value = "should retire given visit type", method = "retireVisitType(VisitType, String)") public void retireVisitType_shouldRetireGivenVisitType() throws Exception { VisitType visitType = Context.getVisitService().getVisitType(1); assertNotNull(visitType); Assert.assertFalse(visitType.isRetired()); Assert.assertNull(visitType.getRetireReason()); Context.getVisitService().retireVisitType(visitType, "retire reason"); visitType = Context.getVisitService().getVisitType(1); assertNotNull(visitType); assertTrue(visitType.isRetired()); assertEquals("retire reason", visitType.getRetireReason()); //Should not change the number of visit types. assertEquals(3, Context.getVisitService().getAllVisitTypes().size()); } @Test @Verifies(value = "should unretire given visit type", method = "unretireVisitType(VisitType)") public void unretireVisitType_shouldUnretireGivenVisitType() throws Exception { VisitType visitType = Context.getVisitService().getVisitType(3); assertNotNull(visitType); assertTrue(visitType.isRetired()); assertEquals("Some Retire Reason", visitType.getRetireReason()); Context.getVisitService().unretireVisitType(visitType); visitType = Context.getVisitService().getVisitType(3); assertNotNull(visitType); Assert.assertFalse(visitType.isRetired()); Assert.assertNull(visitType.getRetireReason()); //Should not change the number of visit types. assertEquals(3, Context.getVisitService().getAllVisitTypes().size()); } @Test @Verifies(value = "should delete given visit type", method = "purgeVisitType(VisitType)") public void purgeVisitType_shouldDeleteGivenVisitType() throws Exception { VisitType visitType = Context.getVisitService().getVisitType(3); assertNotNull(visitType); Context.getVisitService().purgeVisitType(visitType); visitType = Context.getVisitService().getVisitType(3); Assert.assertNull(visitType); //Should reduce the existing number of visit types. assertEquals(2, Context.getVisitService().getAllVisitTypes().size()); } /** * @see VisitService#getAllVisits() */ @Test @Verifies(value = "should return all unvoided visits", method = "getAllVisits()") public void getAllVisits_shouldReturnAllUnvoidedVisits() throws Exception { assertEquals(5, Context.getVisitService().getAllVisits().size()); } /** * @see VisitService#getVisitByUuid(String) */ @Test @Verifies(value = "should return a visit matching the specified uuid", method = "getVisitByUuid(String)") public void getVisitByUuid_shouldReturnAVisitMatchingTheSpecifiedUuid() throws Exception { Visit visit = Context.getVisitService().getVisitByUuid("1e5d5d48-6b78-11e0-93c3-18a905e044dc"); assertNotNull(visit); assertEquals(1, visit.getId().intValue()); } /** * @see VisitService#saveVisit(Visit) */ @Test @Verifies(value = "should add a new visit to the database", method = "saveVisit(Visit)") public void saveVisit_shouldAddANewVisitToTheDatabase() throws Exception { VisitService vs = Context.getVisitService(); Integer originalSize = vs.getAllVisits().size(); Visit visit = new Visit(new Patient(2), new VisitType(1), new Date()); visit = vs.saveVisit(visit); assertNotNull(visit.getId()); assertNotNull(visit.getUuid()); assertNotNull(visit.getCreator()); assertNotNull(visit.getDateCreated()); assertEquals(originalSize + 1, vs.getAllVisits().size()); } /** * @see VisitService#saveVisit(Visit) */ @Test @Verifies(value = "should save a visit though changedBy and dateCreated are not set for VisitAttribute explicitly", method = "saveVisit(Visit)") public void saveVisit_shouldSaveAVisitThoughChangedByAndDateCreatedAreNotSetForVisitAttributeExplictly() throws Exception { executeDataSet(VISITS_ATTRIBUTES_XML); VisitService vs = Context.getVisitService(); Visit visit = new Visit(new Patient(2), new VisitType(3), new Date()); VisitAttribute visitAttribute = createVisitAttributeWithoutCreatorAndDateCreated(); visit.setAttribute(visitAttribute); visit = vs.saveVisit(visit); assertNotNull(visit.getId()); } private VisitAttribute createVisitAttributeWithoutCreatorAndDateCreated() { VisitAttribute visitAttribute = new VisitAttribute(); VisitAttributeType attributeType = Context.getVisitService().getVisitAttributeType(1); attributeType.setName("visit type"); visitAttribute.setValue(new Date()); visitAttribute.setAttributeType(attributeType); return visitAttribute; } /** * @see VisitService#saveVisit(Visit) */ @Test @Verifies(value = "should void an attribute if max occurs is 1 and same attribute type already exists", method = "saveVisit(Visit)") public void saveVisit_shouldVoidAnAttributeIfMaxOccursIs1AndSameAttributeTypeAlreadyExists() throws Exception { executeDataSet(VISITS_ATTRIBUTES_XML); VisitService vs = Context.getVisitService(); Visit visit = new Visit(new Patient(2), new VisitType(3), new Date()); visit.setAttribute(createVisitAttribute(new Date())); visit.setAttribute(createVisitAttribute(new Date(System.currentTimeMillis() - 1000000))); assertEquals(1, visit.getAttributes().size()); visit = vs.saveVisit(visit); assertNotNull(visit.getId()); visit.setAttribute(createVisitAttribute("second visit")); assertEquals(2, visit.getAttributes().size()); VisitAttribute firstAttribute = (VisitAttribute) visit.getAttributes().toArray()[0]; assertTrue(firstAttribute.getVoided()); } private VisitAttribute createVisitAttribute(Object typedValue) { VisitAttribute visitAttribute = new VisitAttribute(); VisitAttributeType attributeType = Context.getVisitService().getVisitAttributeType(1); attributeType.setName("visit type"); visitAttribute.setValue(typedValue); visitAttribute.setAttributeType(attributeType); return visitAttribute; } /** * @see VisitService#saveVisit(Visit) */ @Test @Verifies(value = "should update an existing visit in the database", method = "saveVisit(Visit)") public void saveVisit_shouldUpdateAnExistingVisitInTheDatabase() throws Exception { Visit visit = Context.getVisitService().getVisit(2); Assert.assertNull(visit.getLocation());//this is the field we are editing Assert.assertNull(visit.getChangedBy()); Assert.assertNull(visit.getDateChanged()); visit.setLocation(Context.getLocationService().getLocation(1)); visit = Context.getVisitService().saveVisit(visit); Context.flushSession(); assertNotNull(visit.getChangedBy()); assertNotNull(visit.getDateChanged()); assertEquals(Integer.valueOf(1), visit.getLocation().getLocationId()); } /** * @see VisitService#voidVisit(Visit,String) */ @Test @Verifies(value = "should void the visit and set the voidReason", method = "voidVisit(Visit,String)") public void voidVisit_shouldVoidTheVisitAndSetTheVoidReason() throws Exception { Visit visit = Context.getVisitService().getVisit(1); Assert.assertFalse(visit.isVoided()); Assert.assertNull(visit.getVoidReason()); Assert.assertNull(visit.getVoidedBy()); Assert.assertNull(visit.getDateVoided()); visit = Context.getVisitService().voidVisit(visit, "test reason"); assertTrue(visit.isVoided()); assertEquals("test reason", visit.getVoidReason()); assertEquals(Context.getAuthenticatedUser(), visit.getVoidedBy()); assertNotNull(visit.getDateVoided()); } /** * @see VisitService#voidVisit(Visit,String) */ @Test @Verifies(value = "should void encounters with visit", method = "voidVisit(Visit,String)") public void voidVisit_shouldVoidEncountersWithVisit() throws Exception { //given executeDataSet(VISITS_WITH_DATES_XML); Visit visit = visitService.getVisit(7); Assert.assertFalse(visit.isVoided()); List<Encounter> encountersByVisit = Context.getEncounterService().getEncountersByVisit(visit, false); Assert.assertFalse(encountersByVisit.isEmpty()); //when visit = visitService.voidVisit(visit, "test reason"); //then assertTrue(visit.isVoided()); encountersByVisit = Context.getEncounterService().getEncountersByVisit(visit, false); assertTrue(encountersByVisit.isEmpty()); } /** * @see VisitService#unvoidVisit(Visit) */ @Test @Verifies(value = "should unvoid the visit and unset all the void related fields", method = "unvoidVisit(Visit)") public void unvoidVisit_shouldUnvoidTheVisitAndUnsetAllTheVoidRelatedFields() throws Exception { Visit visit = Context.getVisitService().getVisit(6); assertTrue(visit.isVoided()); assertNotNull(visit.getVoidReason()); assertNotNull(visit.getVoidedBy()); assertNotNull(visit.getDateVoided()); visit = Context.getVisitService().unvoidVisit(visit); Assert.assertFalse(visit.isVoided()); Assert.assertNull(visit.getVoidReason()); Assert.assertNull(visit.getVoidedBy()); Assert.assertNull(visit.getDateVoided()); } /** * @see VisitService#unvoidVisit(Visit) */ @Test @Verifies(value = "should unvoid encounters voided with visit", method = "unvoidVisit(Visit)") public void unvoidVisit_shouldUnvoidEncountersVoidedWithVisit() throws Exception { //given executeDataSet(VISITS_WITH_DATES_XML); Visit visit = visitService.getVisit(7); List<Encounter> encountersByVisit = Context.getEncounterService().getEncountersByVisit(visit, true); assertEquals(2, encountersByVisit.size()); visitService.voidVisit(visit, "test reason"); assertTrue(visit.isVoided()); encountersByVisit = Context.getEncounterService().getEncountersByVisit(visit, false); assertTrue(encountersByVisit.isEmpty()); //when visit = visitService.unvoidVisit(visit); //then Assert.assertFalse(visit.isVoided()); encountersByVisit = Context.getEncounterService().getEncountersByVisit(visit, false); assertEquals(1, encountersByVisit.size()); } /** * @see VisitService#purgeVisit(Visit) */ @Test @Verifies(value = "should erase the visit from the database", method = "purgeVisit(Visit)") public void purgeVisit_shouldEraseTheVisitFromTheDatabase() throws Exception { VisitService vs = Context.getVisitService(); Integer originalSize = vs.getVisits(null, null, null, null, null, null, null, null, null, true, true) .size(); Visit visit = Context.getVisitService().getVisit(1); vs.purgeVisit(visit); assertEquals(originalSize - 1, vs.getVisits(null, null, null, null, null, null, null, null, null, true, true).size()); } /** * @see VisitService#getVisitsByPatient(Patient) */ @Test @Verifies(value = "should return all unvoided visits for the specified patient", method = "getVisitsByPatient(Patient)") public void getVisitsByPatient_shouldReturnAllUnvoidedVisitsForTheSpecifiedPatient() throws Exception { assertEquals(3, Context.getVisitService().getVisitsByPatient(new Patient(2)).size()); } /** * @see VisitService#getActiveVisitsByPatient(Patient) */ @Test @Verifies(value = "return all active unvoided visits for the specified patient", method = "getActiveVisitsByPatient(Patient)") public void getActiveVisitsByPatient_shouldReturnAllUnvoidedActiveVisitsForTheSpecifiedPatient() throws Exception { executeDataSet(VISITS_WITH_DATES_XML); assertEquals(4, Context.getVisitService().getActiveVisitsByPatient(new Patient(2)).size()); } @Test @Verifies(value = "return all active visits for the specified patient", method = "getVisitsByPatient(Patient, boolean, boolean)") public void getActiveVisitsByPatient_shouldReturnAllActiveVisitsForTheSpecifiedPatient() throws Exception { executeDataSet(VISITS_WITH_DATES_XML); assertEquals(5, Context.getVisitService().getVisitsByPatient(new Patient(2), false, true).size()); } @Test @Verifies(value = "return all unvoided visits for the specified patient", method = "getVisitsByPatient(Patient, boolean, boolean)") public void getActiveVisitsByPatient_shouldReturnAllUnvoidedVisitsForTheSpecifiedPatient() throws Exception { executeDataSet(VISITS_WITH_DATES_XML); assertEquals(8, Context.getVisitService().getVisitsByPatient(new Patient(2), true, false).size()); } /** * @see VisitService#getVisits(java.util.Collection, java.util.Collection, java.util.Collection, java.util.Collection, Date, Date, Date, Date, boolean) */ @Test @Verifies(value = "should get visits by indications", method = "getVisits(Collection<VisitType>,Collection<Patient>,Collection<Location>,Collection<Concept>,Date,Date,Date,Date,boolean)") public void getVisits_shouldGetVisitsByIndications() throws Exception { assertEquals(1, Context.getVisitService().getVisits(null, null, null, Collections.singletonList(new Concept(5497)), null, null, null, null, null, true, false).size()); } /** * @see VisitService#getVisits(java.util.Collection, java.util.Collection, java.util.Collection, java.util.Collection, Date, Date, Date, Date, boolean) */ @Test @Verifies(value = "should get visits by locations", method = "getVisits(Collection<VisitType>,Collection<Patient>,Collection<Location>,Collection<Concept>,Date,Date,Date,Date,boolean)") public void getVisits_shouldGetVisitsByLocations() throws Exception { List<Location> locations = new ArrayList<Location>(); locations.add(new Location(1)); assertEquals(1, Context.getVisitService() .getVisits(null, null, locations, null, null, null, null, null, null, true, false).size()); } /** * @see VisitService#getVisits(java.util.Collection, java.util.Collection, java.util.Collection, java.util.Collection, Date, Date, Date, Date, boolean) */ @Test @Verifies(value = "should get visits by visit type", method = "getVisits(Collection<VisitType>,Collection<Patient>,Collection<Location>,Collection<Concept>,Date,Date,Date,Date,boolean)") public void getVisits_shouldGetVisitsByVisitType() throws Exception { List<VisitType> visitTypes = new ArrayList<VisitType>(); visitTypes.add(new VisitType(1)); assertEquals(4, Context.getVisitService() .getVisits(visitTypes, null, null, null, null, null, null, null, null, true, false).size()); } /** * @see VisitService#getVisits(java.util.Collection, java.util.Collection, java.util.Collection, java.util.Collection, Date, Date, Date, Date, boolean) */ @Test @Verifies(value = "should get visits ended between the given end dates", method = "getVisits(Collection<VisitType>,Collection<Patient>,Collection<Location>,Collection<Concept>,Date,Date,Date,Date,boolean)") public void getVisits_shouldGetVisitsEndedBetweenTheGivenEndDates() throws Exception { executeDataSet(VISITS_WITH_DATES_XML); Calendar cal = Calendar.getInstance(); cal.set(2005, 1, 1, 0, 0, 0); Date minEndDate = cal.getTime(); cal.set(2005, 1, 2, 23, 59, 0); Date maxEndDate = cal.getTime(); assertEquals(2, Context.getVisitService() .getVisits(null, null, null, null, null, null, minEndDate, maxEndDate, null, true, false).size()); } /** * Test for TRUNK-3630 * @see VisitService#getVisits(Collection,Collection,Collection,Collection,Date,Date,Date,Date,Map,boolean,boolean) * @verifies get visits that are still open even if minStartDatetime is specified */ @Test public void getVisits_shouldGetVisitsThatAreStillOpenEvenIfMinStartDatetimeIsSpecified() throws Exception { Date minEndDatetime = new SimpleDateFormat("yyyy-MM-dd").parse("2061-01-01"); // this should get all open non-voided visits (which are ids 1, 2, 3, 4, 5 in standardTestDataset) List<Visit> visits = Context.getVisitService().getVisits(null, null, null, null, null, null, minEndDatetime, null, null, true, false); assertEquals(5, visits.size()); assertTrue(TestUtil.containsId(visits, 1)); assertTrue(TestUtil.containsId(visits, 2)); assertTrue(TestUtil.containsId(visits, 3)); assertTrue(TestUtil.containsId(visits, 4)); assertTrue(TestUtil.containsId(visits, 5)); } /** * @see VisitService#getVisits(java.util.Collection, java.util.Collection, java.util.Collection, java.util.Collection, Date, Date, Date, Date, boolean) */ @Test @Verifies(value = "should get visits started between the given start dates", method = "getVisits(Collection<VisitType>,Collection<Patient>,Collection<Location>,Collection<Concept>,Date,Date,Date,Date,boolean)") public void getVisits_shouldGetVisitsStartedBetweenTheGivenStartDates() throws Exception { executeDataSet(VISITS_WITH_DATES_XML); Calendar cal = Calendar.getInstance(); cal.set(2005, 0, 1, 1, 0, 0); Date minStartDate = cal.getTime(); cal.set(2005, 0, 1, 4, 0, 0); Date maxStartDate = cal.getTime(); assertEquals(2, Context.getVisitService() .getVisits(null, null, null, null, minStartDate, maxStartDate, null, null, null, true, false) .size()); } /** * @see VisitService#getVisits(java.util.Collection, java.util.Collection, java.util.Collection, java.util.Collection, Date, Date, Date, Date, boolean) */ @Test @Verifies(value = "should return all visits if includeVoided is set to true", method = "getVisits(Collection<VisitType>,Collection<Patient>,Collection<Location>,Collection<Concept>,Date,Date,Date,Date,boolean)") public void getVisits_shouldReturnAllVisitsIfIncludeVoidedIsSetToTrue() throws Exception { assertEquals(6, Context.getVisitService() .getVisits(null, null, null, null, null, null, null, null, null, true, true).size()); } @Test(expected = APIException.class) @Verifies(value = "should throw error when name is null", method = "saveVisitType(VisitType)") public void saveVisitType_shouldThrowErrorWhenNameIsNull() throws Exception { Context.getVisitService().saveVisitType(new VisitType()); } @Test(expected = APIException.class) @Verifies(value = "should throw error when name is empty string", method = "saveVisitType(VisitType)") public void saveVisitType_shouldThrowErrorWhenNameIsEmptyString() throws Exception { VisitType visitType = new VisitType("", null); Context.getVisitService().saveVisitType(visitType); } /** * @see VisitService#getAllVisitAttributeTypes() * @verifies return all visit attribute types including retired ones */ @Test public void getAllVisitAttributeTypes_shouldReturnAllVisitAttributeTypesIncludingRetiredOnes() throws Exception { executeDataSet(VISITS_ATTRIBUTES_XML); assertEquals(3, visitService.getAllVisitAttributeTypes().size()); } /** * @see VisitService#getVisitAttributeType(Integer) * @verifies return the visit attribute type with the given id */ @Test public void getVisitAttributeType_shouldReturnTheVisitAttributeTypeWithTheGivenId() throws Exception { executeDataSet(VISITS_ATTRIBUTES_XML); assertEquals("Audit Date", visitService.getVisitAttributeType(1).getName()); } /** * @see VisitService#getVisitAttributeType(Integer) * @verifies return null if no visit attribute type exists with the given id */ @Test public void getVisitAttributeType_shouldReturnNullIfNoVisitAttributeTypeExistsWithTheGivenId() throws Exception { executeDataSet(VISITS_ATTRIBUTES_XML); Assert.assertNull(visitService.getVisitAttributeType(999)); } /** * @see VisitService#getVisitAttributeTypeByUuid(String) * @verifies return the visit attribute type with the given uuid */ @Test public void getVisitAttributeTypeByUuid_shouldReturnTheVisitAttributeTypeWithTheGivenUuid() throws Exception { executeDataSet(VISITS_ATTRIBUTES_XML); assertEquals("Audit Date", visitService.getVisitAttributeTypeByUuid("9516cc50-6f9f-11e0-8414-001e378eb67e").getName()); } /** * @see VisitService#getVisitAttributeTypeByUuid(String) * @verifies return null if no visit attribute type exists with the given uuid */ @Test public void getVisitAttributeTypeByUuid_shouldReturnNullIfNoVisitAttributeTypeExistsWithTheGivenUuid() throws Exception { executeDataSet(VISITS_ATTRIBUTES_XML); Assert.assertNull(visitService.getVisitAttributeTypeByUuid("not-a-uuid")); } /** * @see VisitService#purgeVisitAttributeType(VisitAttributeType) * @verifies completely remove a visit attribute type */ @Test public void purgeVisitAttributeType_shouldCompletelyRemoveAVisitAttributeType() throws Exception { executeDataSet(VISITS_ATTRIBUTES_XML); assertEquals(3, visitService.getAllVisitAttributeTypes().size()); visitService.purgeVisitAttributeType(visitService.getVisitAttributeType(2)); assertEquals(2, visitService.getAllVisitAttributeTypes().size()); } /** * @see VisitService#retireVisitAttributeType(VisitAttributeType,String) * @verifies retire a visit attribute type */ @Test public void retireVisitAttributeType_shouldRetireAVisitAttributeType() throws Exception { executeDataSet(VISITS_ATTRIBUTES_XML); VisitAttributeType vat = visitService.getVisitAttributeType(1); Assert.assertFalse(vat.isRetired()); visitService.retireVisitAttributeType(vat, "for testing"); vat = visitService.getVisitAttributeType(1); assertTrue(vat.isRetired()); assertNotNull(vat.getRetiredBy()); assertNotNull(vat.getDateRetired()); assertEquals("for testing", vat.getRetireReason()); } /** * @see VisitService#saveVisitAttributeType(VisitAttributeType) * @verifies create a new visit attribute type */ @Test public void saveVisitAttributeType_shouldCreateANewVisitAttributeType() throws Exception { executeDataSet(VISITS_ATTRIBUTES_XML); assertEquals(3, visitService.getAllVisitAttributeTypes().size()); VisitAttributeType vat = new VisitAttributeType(); vat.setName("Another one"); vat.setDatatypeClassname(FreeTextDatatype.class.getName()); visitService.saveVisitAttributeType(vat); assertNotNull(vat.getId()); assertEquals(4, visitService.getAllVisitAttributeTypes().size()); } /** * @see VisitService#saveVisitAttributeType(VisitAttributeType) * @verifies edit an existing visit attribute type */ @Test public void saveVisitAttributeType_shouldEditAnExistingVisitAttributeType() throws Exception { executeDataSet(VISITS_ATTRIBUTES_XML); assertEquals(3, visitService.getAllVisitAttributeTypes().size()); VisitAttributeType vat = visitService.getVisitAttributeType(1); vat.setName("A new name"); visitService.saveVisitAttributeType(vat); assertEquals(3, visitService.getAllVisitAttributeTypes().size()); assertEquals("A new name", visitService.getVisitAttributeType(1).getName()); } /** * @see VisitService#unretireVisitAttributeType(VisitAttributeType) * @verifies unretire a retired visit attribute type */ @Test public void unretireVisitAttributeType_shouldUnretireARetiredVisitAttributeType() throws Exception { executeDataSet(VISITS_ATTRIBUTES_XML); VisitAttributeType vat = visitService.getVisitAttributeType(2); assertTrue(vat.isRetired()); assertNotNull(vat.getDateRetired()); assertNotNull(vat.getRetiredBy()); assertNotNull(vat.getRetireReason()); visitService.unretireVisitAttributeType(vat); Assert.assertFalse(vat.isRetired()); Assert.assertNull(vat.getDateRetired()); Assert.assertNull(vat.getRetiredBy()); Assert.assertNull(vat.getRetireReason()); } /** * @see VisitService#getVisitAttributeByUuid(String) * @verifies get the visit attribute with the given uuid */ @Test public void getVisitAttributeByUuid_shouldGetTheVisitAttributeWithTheGivenUuid() throws Exception { executeDataSet(VISITS_ATTRIBUTES_XML); assertEquals("2011-04-25", visitService.getVisitAttributeByUuid("3a2bdb18-6faa-11e0-8414-001e378eb67e").getValueReference()); } /** * @see VisitService#getVisitAttributeByUuid(String) * @verifies return null if no visit attribute has the given uuid */ @Test public void getVisitAttributeByUuid_shouldReturnNullIfNoVisitAttributeHasTheGivenUuid() throws Exception { executeDataSet(VISITS_ATTRIBUTES_XML); Assert.assertNull(visitService.getVisitAttributeByUuid("not-a-uuid")); } /** * @see VisitService#getVisits(Collection,Collection,Collection,Collection,Date,Date,Date,Date,Map,boolean) * @verifies get all visits with given attribute values */ @Test public void getVisits_shouldGetAllVisitsWithGivenAttributeValues() throws Exception { executeDataSet(VISITS_ATTRIBUTES_XML); Map<VisitAttributeType, Object> attrs = new HashMap<VisitAttributeType, Object>(); attrs.put(visitService.getVisitAttributeType(1), new SimpleDateFormat("yyyy-MM-dd").parse("2011-04-25")); List<Visit> visits = visitService.getVisits(null, null, null, null, null, null, null, null, attrs, true, false); assertEquals(1, visits.size()); assertEquals(Integer.valueOf(1), visits.get(0).getVisitId()); } /** * @see VisitService#getVisits(Collection,Collection,Collection,Collection,Date,Date,Date,Date,Map,boolean) * @verifies not find any visits if none have given attribute values */ @Test public void getVisits_shouldNotFindAnyVisitsIfNoneHaveGivenAttributeValues() throws Exception { executeDataSet(VISITS_ATTRIBUTES_XML); Map<VisitAttributeType, Object> attrs = new HashMap<VisitAttributeType, Object>(); attrs.put(visitService.getVisitAttributeType(1), new SimpleDateFormat("yyyy-MM-dd").parse("1411-04-25")); List<Visit> visits = visitService.getVisits(null, null, null, null, null, null, null, null, attrs, true, false); assertEquals(0, visits.size()); } /** * @see VisitService#saveVisit(Visit) */ @Test(expected = APIException.class) @Verifies(value = "should fail if validation errors are found", method = "saveVisit(Visit)") public void saveVisit_shouldFailIfValidationErrorsAreFound() throws Exception { VisitService vs = Context.getVisitService(); Visit visit = new Visit(); //Not setting the patient so that we get validation errors visit.setVisitType(vs.getVisitType(1)); visit.setStartDatetime(new Date()); Context.getVisitService().saveVisit(visit); } /** * @see VisitService#saveVisit(Visit) */ @Test @Verifies(value = "should pass if no validation errors are found", method = "saveVisit(Visit)") public void saveVisit_shouldPassIfNoValidationErrorsAreFound() throws Exception { VisitService vs = Context.getVisitService(); Visit visit = new Visit(); visit.setPatient(Context.getPatientService().getPatient(2)); visit.setVisitType(vs.getVisitType(1)); visit.setStartDatetime(new Date()); Context.getVisitService().saveVisit(visit); } /** * @see VisitService#endVisit(Visit,Date) */ @Test @Verifies(value = "should set stopDateTime as currentDate if stopDate is null", method = "endVisit(Visit,Date)") public void endVisit_shouldSetStopDateTimeAsCurrentDateIfStopDateIsNull() throws Exception { VisitService vs = Context.getVisitService(); Visit visit = vs.getVisit(1); Assert.assertNull(visit.getStopDatetime()); vs.endVisit(visit, null); assertNotNull(visit.getStopDatetime()); } /** * @see VisitService#endVisit(Visit,Date) */ @Test @Verifies(value = "should not fail if no validation errors are found", method = "endVisit(Visit,Date)") public void endVisit_shouldNotFailIfNoValidationErrorsAreFound() throws Exception { VisitService vs = Context.getVisitService(); Visit visit = vs.getVisit(1); vs.endVisit(visit, new Date()); } /** * @see VisitService#endVisit(Visit,Date) */ @Test(expected = APIException.class) @Verifies(value = "should fail if validation errors are found", method = "endVisit(Visit,Date)") public void endVisit_shouldFailIfValidationErrorsAreFound() throws Exception { VisitService vs = Context.getVisitService(); Visit visit = vs.getVisit(1); Calendar cal = Calendar.getInstance(); cal.setTime(visit.getStartDatetime()); cal.add(Calendar.DAY_OF_MONTH, -1); vs.endVisit(visit, cal.getTime()); } /** * @see VisitService#purgeVisit(Visit) */ @Test(expected = APIException.class) @Verifies(value = "should fail if the visit has encounters associated to it", method = "purgeVisit(Visit)") public void purgeVisit_shouldFailIfTheVisitHasEncountersAssociatedToIt() throws Exception { Visit visit = Context.getVisitService().getVisit(1); Encounter e = Context.getEncounterService().getEncounter(3); e.setVisit(visit); Context.getEncounterService().saveEncounter(e); //sanity check assertTrue(Context.getEncounterService().getEncountersByVisit(visit, false).size() > 0); Context.getVisitService().purgeVisit(visit); } /** * @see VisitService#saveVisit(Visit) * @verifies be able to add an attribute to a visit */ @Test public void saveVisit_shouldBeAbleToAddAnAttributeToAVisit() throws Exception { Date now = new Date(); Visit visit = visitService.getVisit(1); VisitAttributeType attrType = visitService.getVisitAttributeType(1); VisitAttribute attr = new VisitAttribute(); attr.setAttributeType(attrType); attr.setValue(now); visit.addAttribute(attr); visitService.saveVisit(visit); assertEquals(new SimpleDateFormat("yyyy-MM-dd").format(now), attr.getValueReference()); } @Test public void shouldVoidASimpleAttribute() throws Exception { executeDataSet(VISITS_ATTRIBUTES_XML); Visit visit = visitService.getVisit(1); VisitAttributeType attrType = visitService.getVisitAttributeType(1); List<VisitAttribute> attributes = visit.getActiveAttributes(attrType); assertTrue(attributes.size() > 0); VisitAttribute attribute = attributes.get(0); attribute.setVoided(true); visitService.saveVisit(visit); assertNotNull(attribute.getVoidedBy()); assertNotNull(attribute.getDateVoided()); } /** * @see VisitService#stopVisits() */ @Test @Verifies(value = "should close all unvoided active visit matching the specified visit types", method = "stopVisits()") public void stopVisits_shouldCloseAllUnvoidedActiveVisitMatchingTheSpecifiedVisitTypes() throws Exception { executeDataSet("org/openmrs/api/include/VisitServiceTest-includeVisitsAndTypeToAutoClose.xml"); String[] visitTypeNames = StringUtils.split( Context.getAdministrationService().getGlobalProperty(OpenmrsConstants.GP_VISIT_TYPES_TO_AUTO_CLOSE), ","); String openVisitsQuery = "SELECT visit_id FROM visit WHERE voided = 0 AND date_stopped IS NULL AND visit_type_id IN (SELECT visit_type_id FROM visit_type WHERE NAME IN ('" + StringUtils.join(visitTypeNames, "','") + "'))"; int activeVisitCount = Context.getAdministrationService().executeSQL(openVisitsQuery, true).size(); //sanity check assertTrue("There should be some active visits for this test to be valid", activeVisitCount > 0); //close any unvoided open visits visitService.stopVisits(null); activeVisitCount = Context.getAdministrationService().executeSQL(openVisitsQuery, true).size(); //all active unvoided visits should have been closed assertTrue("Not all active unvoided vists were closed", activeVisitCount == 0); } /** * @see VisitService#saveVisit(Visit) */ @Test @Verifies(value = "should save new visit with encounters successfully", method = "saveVisit(Visit)") public void saveVisit_shouldSaveNewVisitWithEncountersSuccessfully() throws Exception { VisitService vs = Context.getVisitService(); Integer originalSize = vs.getAllVisits().size(); Visit visit = new Visit(new Patient(2), new VisitType(1), new Date()); Encounter encounter = Context.getEncounterService().getEncounter(4); visit.addEncounter(encounter); vs.saveVisit(visit); int visitId = visit.getVisitId(); Context.flushSession(); Context.clearSession(); // reload the visit visit = Context.getVisitService().getVisit(visitId); assertNotNull(visit.getId()); assertNotNull(visit.getUuid()); assertNotNull(visit.getCreator()); assertNotNull(visit.getDateCreated()); assertEquals(originalSize + 1, vs.getAllVisits().size()); assertEquals(1, visit.getEncounters().size()); assertEquals(Integer.valueOf(4), ((Encounter) visit.getEncounters().toArray()[0]).getEncounterId()); } /** * @see VisitService#saveVisit(Visit) */ @Test @Verifies(value = "should associate encounter with visit on save encounter", method = "saveVisit(Visit)") public void saveVisit_shouldAssociateEncounterWithVisitOnSaveEncounter() throws Exception { VisitService vs = Context.getVisitService(); Visit visit = vs.getVisit(1); EncounterService es = Context.getEncounterService(); Encounter encounter = new Encounter(); encounter.setEncounterDatetime(new Date()); encounter.setPatient(visit.getPatient()); encounter.setLocation(visit.getLocation()); encounter.setEncounterType(es.getEncounterType(1)); visit.addEncounter(encounter); Context.getEncounterService().saveEncounter(encounter); Integer encounterId = encounter.getEncounterId(); Context.flushSession(); Context.clearSession(); // reload the visit visit = Context.getVisitService().getVisit(1); assertEquals(1, visit.getEncounters().size()); assertEquals(encounterId, ((Encounter) visit.getEncounters().toArray()[0]).getEncounterId()); } /** * @see VisitService#saveVisit(Visit) */ @Test @Verifies(value = "save visit should persist new encounter", method = "saveVisit(Visit)") public void saveVisit_shouldPersistNewEncounter() throws Exception { VisitService vs = Context.getVisitService(); Visit visit = vs.getVisit(1); Encounter encounter = new Encounter(); encounter.setEncounterDatetime(new Date()); encounter.setPatient(visit.getPatient()); encounter.setLocation(visit.getLocation()); visit.addEncounter(encounter); vs.saveVisit(visit); Context.flushSession(); Context.clearSession(); Integer encounterId = encounter.getEncounterId(); // reload the visit visit = Context.getVisitService().getVisit(1); assertEquals(1, visit.getEncounters().size()); assertEquals(encounterId, ((Encounter) visit.getEncounters().toArray()[0]).getEncounterId()); } /** * @see VisitService#getAllVisitTypes(boolean) */ @Test @Verifies(value = "get all visit types based on include retired flag", method = "getAllVisitTypes(boolean)") public void getAllVisitTypes_shouldGetAllVisitTypesBasedOnIncludeRetiredFlag() throws Exception { VisitService visitService = Context.getVisitService(); List<VisitType> visitTypes = visitService.getAllVisitTypes(true); assertEquals("get all visit types including retired", 3, visitTypes.size()); visitTypes = visitService.getAllVisitTypes(false); assertEquals("get all visit types excluding retired", 2, visitTypes.size()); } }