BED-23: Bed Tags should be uniquely identified by name

Author: jwnasambu

api/src/main/java/org/openmrs/validator/BedTagValidator.java

@@ -0,0 +1,57 @@
+/**
+ * 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.validator;
+
+import org.openmrs.module.bedmanagement.entity.BedTag;
+import org.openmrs.module.bedmanagement.service.BedManagementService;
+import org.springframework.validation.Errors;
+import org.springframework.validation.Validator;
+
+import java.util.List;
+
+public class BedTagValidator implements Validator {
+	
+	private final BedManagementService bedManagementService;
+	
+	public BedTagValidator(BedManagementService bedManagementService) {
+		this.bedManagementService = bedManagementService;
+	}
+	
+	@Override
+	public boolean supports(Class<?> clazz) {
+		return BedTag.class.isAssignableFrom(clazz);
+	}
+	
+	@Override
+	public void validate(Object target, Errors errors) {
+		if (!(target instanceof BedTag)) {
+			errors.reject("bedtag.invalid", "Object is not a BedTag");
+			return;
+		}
+		
+		BedTag tag = (BedTag) target;
+		
+		if (tag.getName() == null || tag.getName().trim().isEmpty()) {
+			errors.rejectValue("name", "bedtag.name.required", "Name is required");
+		}
+		
+		if (tag.getName() != null && tag.getName().length() > 50) {
+			errors.rejectValue("name", "bedtag.name.length", "Name is too long");
+		}
+		
+		List<BedTag> existingTags = bedManagementService.getAllBedTags();
+		for (BedTag existingTag : existingTags) {
+			boolean isVoidedOrExpired = existingTag.isVoided() || existingTag.getDateVoided() != null;
+			if (!isVoidedOrExpired && existingTag.getName().equals(tag.getName())) {
+				errors.rejectValue("name", "bedtag.name.exists", "Name already in use");
+			}
+		}
+	}
+}

api/src/test/java/org/openmrs/validator/BedTagValidatorTest.java

@@ -0,0 +1,130 @@
+/**
+ * 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.validator;
+
+import org.junit.Before;
+import org.junit.Test;
+import org.openmrs.module.bedmanagement.entity.BedTag;
+import org.openmrs.module.bedmanagement.service.BedManagementService;
+import org.springframework.validation.BindException;
+import org.springframework.validation.Errors;
+
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.Date;
+
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertTrue;
+import static org.mockito.Mockito.*;
+
+public class BedTagValidatorTest {
+	
+	private BedTagValidator validator;
+	
+	private BedManagementService bedManagementService;
+	
+	private BedTag activeTag;
+	
+	private BedTag expiredTag;
+	
+	@Before
+	public void setup() {
+		bedManagementService = mock(BedManagementService.class);
+		validator = new BedTagValidator(bedManagementService);
+		
+		activeTag = new BedTag();
+		activeTag.setName("ICU-1");
+		activeTag.setUuid("active-uuid");
+		
+		expiredTag = new BedTag();
+		expiredTag.setName("ExpiredTag");
+		expiredTag.setUuid("expired-uuid");
+		expiredTag.setDateVoided(new Date());
+	}
+	
+	@Test
+	public void validate_shouldFailIfNameIsNullOrEmptyOrWhitespace() {
+		BedTag tag = new BedTag();
+		
+		tag.setName(null);
+		Errors errors = new BindException(tag, "tag");
+		validator.validate(tag, errors);
+		assertTrue(errors.hasFieldErrors("name"));
+		
+		tag.setName("");
+		errors = new BindException(tag, "tag");
+		validator.validate(tag, errors);
+		assertTrue(errors.hasFieldErrors("name"));
+		
+		tag.setName(" ");
+		errors = new BindException(tag, "tag");
+		validator.validate(tag, errors);
+		assertTrue(errors.hasFieldErrors("name"));
+	}
+	
+	@Test
+	public void validate_shouldFailIfNonExpiredNameAlreadyInUse() {
+		when(bedManagementService.getAllBedTags()).thenReturn(Arrays.asList(activeTag));
+		
+		BedTag tag = new BedTag();
+		tag.setName("ICU-1");
+		
+		Errors errors = new BindException(tag, "tag");
+		validator.validate(tag, errors);
+		
+		assertTrue(errors.hasFieldErrors("name"));
+	}
+	
+	@Test
+	public void validate_shouldPassIfExistingNameIsExpired() {
+		when(bedManagementService.getAllBedTags()).thenReturn(Arrays.asList(expiredTag));
+		
+		BedTag tag = new BedTag();
+		tag.setName("ExpiredTag");
+		
+		Errors errors = new BindException(tag, "tag");
+		validator.validate(tag, errors);
+		
+		assertFalse(errors.hasFieldErrors("name"));
+	}
+	
+	@Test
+	public void validate_shouldPassIfAllRequiredFieldsAreValid() {
+		when(bedManagementService.getAllBedTags()).thenReturn(Collections.emptyList());
+		
+		BedTag tag = new BedTag();
+		tag.setName("NewTag");
+		
+		Errors errors = new BindException(tag, "tag");
+		validator.validate(tag, errors);
+		
+		assertFalse(errors.hasErrors());
+	}
+	
+	@Test
+	public void validate_shouldFailIfFieldLengthsAreInvalid() {
+		BedTag tag = new BedTag();
+		tag.setName("ThisNameIsWayTooLongForABedTagAndShouldFailValidationAccordingToFieldLengthRules");
+		
+		Errors errors = new BindException(tag, "tag");
+		validator.validate(tag, errors);
+		
+		assertTrue(errors.hasFieldErrors("name"));
+	}
+	
+	@Test
+	public void validate_shouldRejectNonBedTagObjects() {
+		Object notABedTag = new Object();
+		Errors errors = new BindException(notABedTag, "notABedTag");
+		validator.validate(notABedTag, errors);
+		
+		assertTrue(errors.hasGlobalErrors());
+	}
+}