5639

pending completion

Build # 5639

Build Type

push

travis-ci

Committed by

dkayiwa

Commit Message

<a href="https://github.com/openmrs/openmrs-core/commit/<a class=hub.com/openmrs/openmrs-core/commit/712a688e8dc70f07c3cf02c595ccfca765039ff9">712a688e8<a href="https://github.com/openmrs/openmrs-core/commit/712a688e8dc70f07c3cf02c595ccfca765039ff9">&quot;&gt;StartModule cannot be used with more than one test case - TRUNK-5216
(cherry picked from commit </a><a class="double-link" href="https://github.com/openmrs/openmrs-core/commit/<a class="double-link" href="https://github.com/openmrs/openmrs-core/commit/95b6148964ebcc435e86bbbdee374904d1a3429e">95b614896</a>">95b614896</a><a href="https://github.com/openmrs/openmrs-core/commit/712a688e8dc70f07c3cf02c595ccfca765039ff9">)

Run Details

18087 of 32540 relevant lines covered (55.58%)

0.56 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

80.85

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

/**
 * 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 java.util.Collection;
import java.util.HashSet;
import java.util.Locale;
import java.util.Set;

import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang.StringUtils;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.openmrs.Concept;
import org.openmrs.ConceptAnswer;
import org.openmrs.ConceptMap;
import org.openmrs.ConceptName;
import org.openmrs.annotation.Handler;
import org.openmrs.api.APIException;
import org.openmrs.api.DuplicateConceptNameException;
import org.openmrs.api.context.Context;
import org.springframework.validation.Errors;
import org.springframework.validation.ValidationUtils;
import org.springframework.validation.Validator;

/**
 * Validates {@link Concept} objects. <br>
 * These validations are also documented at <a
 * href="https://wiki.openmrs.org/x/-gkdAg">https://wiki.openmrs.org/x/-gkdAg</a>. Any changes made
 * to this source also need to be reflected on that page.
 */
@Handler(supports = { Concept.class }, order = 50)
public class ConceptValidator extends BaseCustomizableValidator implements Validator {
        
        // Log for this class
        private static final Log log = LogFactory.getLog(ConceptValidator.class);
        
        /**
         * Determines if the command object being submitted is a valid type
         *
         * @see org.springframework.validation.Validator#supports(java.lang.Class)
         */
        @Override
        public boolean supports(Class<?> c) {
                return Concept.class.isAssignableFrom(c);
        }
        
        /**
         * Checks that a given concept object is valid.
         *
         * @see org.springframework.validation.Validator#validate(java.lang.Object,
         *      org.springframework.validation.Errors)
         * @should pass if the concept has at least one fully specified name added to it
         * @should fail if there is a duplicate unretired concept name in the locale
         * @should fail if there is a duplicate unretired preferred name in the same locale
         * @should fail if there is a duplicate unretired fully specified name in the same locale
         * @should fail if any names in the same locale for this concept are similar
         * @should pass if the concept with a duplicate name is retired
         * @should pass if the concept being validated is retired and has a duplicate name
         * @should fail if any name is an empty string
         * @should fail if the object parameter is null
         * @should pass if the concept is being updated with no name change
         * @should fail if any name is a null value
         * @should not allow multiple preferred names in a given locale
         * @should not allow multiple fully specified conceptNames in a given locale
         * @should not allow multiple short names in a given locale
         * @should not allow an index term to be a locale preferred name
         * @should fail if there is no name explicitly marked as fully specified
         * @should pass if the duplicate ConceptName is neither preferred nor fully Specified
         * @should pass if the concept has a synonym that is also a short name
         * @should fail if a term is mapped multiple times to the same concept
         * @should not fail if a term has two new mappings on it
         * @should fail if there is a duplicate unretired concept name in the same locale different than
         *         the system locale
         * @should pass for a new concept with a map created with deprecated concept map methods
         * @should pass for an edited concept with a map created with deprecated concept map methods
         * @should pass validation if field lengths are correct
         * @should fail validation if field lengths are not correct
         * @should pass if fully specified name is the same as short name
         * @should pass if different concepts have the same short name
         * @should fail if the concept datatype is null
         * @should fail if the concept class is null
         */
        @Override
        public void validate(Object obj, Errors errors) throws APIException, DuplicateConceptNameException {
                
                if (obj == null || !(obj instanceof Concept)) {
                        throw new IllegalArgumentException("The parameter obj should not be null and must be of type" + Concept.class);
                }
                
                Concept conceptToValidate = (Concept) obj;
                //no name to validate, but why is this the case?
                if (conceptToValidate.getNames().isEmpty()) {
                        errors.reject("Concept.name.atLeastOneRequired");
                        return;
                }

                ValidationUtils.rejectIfEmpty(errors, "datatype", "Concept.datatype.empty");
                ValidationUtils.rejectIfEmpty(errors, "conceptClass", "Concept.conceptClass.empty");

                boolean hasFullySpecifiedName = false;
                for (Locale conceptNameLocale : conceptToValidate.getAllConceptNameLocales()) {
                        boolean fullySpecifiedNameForLocaleFound = false;
                        boolean preferredNameForLocaleFound = false;
                        boolean shortNameForLocaleFound = false;
                        Set<String> validNamesFoundInLocale = new HashSet<>();
                        Collection<ConceptName> namesInLocale = conceptToValidate.getNames(conceptNameLocale);
                        for (ConceptName nameInLocale : namesInLocale) {
                                if (StringUtils.isBlank(nameInLocale.getName())) {
                                        log.debug("Name in locale '" + conceptNameLocale.toString()
                                                + "' cannot be an empty string or white space");
                                        errors.reject("Concept.name.empty");
                                }
                                if (nameInLocale.getLocalePreferred() != null) {
                                        if (nameInLocale.getLocalePreferred() && !preferredNameForLocaleFound) {
                                                if (nameInLocale.isIndexTerm()) {
                                                        log.warn("Preferred name in locale '" + conceptNameLocale.toString()
                                                                + "' shouldn't be an index term");
                                                        errors.reject("Concept.error.preferredName.is.indexTerm");
                                                } else if (nameInLocale.isShort()) {
                                                        log.warn("Preferred name in locale '" + conceptNameLocale.toString()
                                                                + "' shouldn't be a short name");
                                                        errors.reject("Concept.error.preferredName.is.shortName");
                                                } else if (nameInLocale.getVoided()) {
                                                        log.warn("Preferred name in locale '" + conceptNameLocale.toString()
                                                                + "' shouldn't be a voided name");
                                                        errors.reject("Concept.error.preferredName.is.voided");
                                                }
                                                
                                                preferredNameForLocaleFound = true;
                                        }
                                        //should have one preferred name per locale
                                        else if (nameInLocale.getLocalePreferred() && preferredNameForLocaleFound) {
                                                log.warn("Found multiple preferred names in locale '" + conceptNameLocale.toString() + "'");
                                                errors.reject("Concept.error.multipleLocalePreferredNames");
                                        }
                                }
                                
                                if (nameInLocale.isFullySpecifiedName()) {
                                        if (!hasFullySpecifiedName) {
                                                hasFullySpecifiedName = true;
                                        }
                                        if (!fullySpecifiedNameForLocaleFound) {
                                                fullySpecifiedNameForLocaleFound = true;
                                        } else {
                                                log.warn("Found multiple fully specified names in locale '" + conceptNameLocale.toString() + "'");
                                                errors.reject("Concept.error.multipleFullySpecifiedNames");
                                        }
                                        if (nameInLocale.getVoided()) {
                                                log.warn("Fully Specified name in locale '" + conceptNameLocale.toString()
                                                        + "' shouldn't be a voided name");
                                                errors.reject("Concept.error.fullySpecifiedName.is.voided");
                                        }
                                }
                                
                                if (nameInLocale.isShort()) {
                                        if (!shortNameForLocaleFound) {
                                                shortNameForLocaleFound = true;
                                        }
                                        //should have one short name per locale
                                        else {
                                                log.warn("Found multiple short names in locale '" + conceptNameLocale.toString() + "'");
                                                errors.reject("Concept.error.multipleShortNames");
                                        }
                                }
                                
                                //find duplicate names for a non-retired concept
                                if (Context.getConceptService().isConceptNameDuplicate(nameInLocale)) {
                                        throw new DuplicateConceptNameException("'" + nameInLocale.getName()
                                                + "' is a duplicate name in locale '" + conceptNameLocale.toString() + "'");
                                }
                                
                                //
                                if (errors.hasErrors()) {
                                        log.debug("Concept name '" + nameInLocale.getName() + "' for locale '" + conceptNameLocale
                                                + "' is invalid");
                                        //if validation fails for any conceptName in current locale, don't proceed
                                        //This helps not to have multiple messages shown that are identical though they might be
                                        //for different conceptNames
                                        return;
                                }
                                
                                //No duplicate names allowed for the same locale and concept, keep the case the same
                                //except for short names
                                if (!nameInLocale.isShort() && !validNamesFoundInLocale.add(nameInLocale.getName().toLowerCase())) {
                                        throw new DuplicateConceptNameException("'" + nameInLocale.getName()
                                                + "' is a duplicate name in locale '" + conceptNameLocale.toString() + "' for the same concept");
                                }
                                
                                if (log.isDebugEnabled()) {
                                        log.debug("Valid name found: " + nameInLocale.getName());
                                }
                        }
                }
                
                //Ensure that each concept has at least a fully specified name
                if (!hasFullySpecifiedName) {
                        log.debug("Concept has no fully specified name");
                        errors.reject("Concept.error.no.FullySpecifiedName");
                }
                
                if (CollectionUtils.isNotEmpty(conceptToValidate.getConceptMappings())) {
                        //validate all the concept maps
                        int index = 0;
                        Set<Integer> mappedTermIds = null;
                        for (ConceptMap map : conceptToValidate.getConceptMappings()) {
                                if (map.getConceptReferenceTerm().getConceptReferenceTermId() == null) {
                                        //if this term is getting created on the fly e.g. from old legacy code, validate it
                                        try {
                                                errors.pushNestedPath("conceptMappings[" + index + "].conceptReferenceTerm");
                                                ValidationUtils.invokeValidator(new ConceptReferenceTermValidator(), map.getConceptReferenceTerm(),
                                                    errors);
                                        }
                                        finally {
                                                errors.popNestedPath();
                                        }
                                        
                                }
                                /*if (map.getConceptMapType() == null) {
                                        errors.rejectValue("conceptMappings[" + index + "].conceptMapType", "Concept.map.typeRequired",
                                            "The concept map type is required for a concept map");
                                        return;
                                }*/

                                //don't proceed to the next maps since the current one already has errors
                                if (errors.hasErrors()) {
                                        return;
                                }
                                
                                if (mappedTermIds == null) {
                                        mappedTermIds = new HashSet<>();
                                }
                                
                                //if we already have a mapping to this term, reject it this map
                                if (map.getConceptReferenceTerm().getId() != null
                                        && !mappedTermIds.add(map.getConceptReferenceTerm().getId())) {
                                        errors.rejectValue("conceptMappings[" + index + "]", "ConceptReferenceTerm.term.alreadyMapped",
                                            "Cannot map a reference term multiple times to the same concept");
                                }
                                
                                index++;
                        }
                }
                if (CollectionUtils.isNotEmpty(conceptToValidate.getAnswers())) {
                        for (ConceptAnswer conceptAnswer : conceptToValidate.getAnswers()) {
                                if (conceptAnswer.getAnswerConcept().equals(conceptToValidate)) {
                                        errors.reject("Concept.contains.itself.as.answer");
                                }
                        }
                }
                ValidateUtil.validateFieldLengths(errors, obj.getClass(), "version", "retireReason");
                super.validateAttributes(conceptToValidate, errors, Context.getConceptService().getAllConceptAttributeTypes());
        }
}

1	/**
2	* This Source Code Form is subject to the terms of the Mozilla Public License,
3	* v. 2.0. If a copy of the MPL was not distributed with this file, You can
4	* obtain one at http://mozilla.org/MPL/2.0/. OpenMRS is also distributed under
5	* the terms of the Healthcare Disclaimer located at http://openmrs.org/license.
6	*
7	* Copyright (C) OpenMRS Inc. OpenMRS is a registered trademark and the OpenMRS
8	* graphic logo is a trademark of OpenMRS Inc.
9	*/
10	package org.openmrs.validator;
11
12	import java.util.Collection;
13	import java.util.HashSet;
14	import java.util.Locale;
15	import java.util.Set;
16
17	import org.apache.commons.collections.CollectionUtils;
18	import org.apache.commons.lang.StringUtils;
19	import org.apache.commons.logging.Log;
20	import org.apache.commons.logging.LogFactory;
21	import org.openmrs.Concept;
22	import org.openmrs.ConceptAnswer;
23	import org.openmrs.ConceptMap;
24	import org.openmrs.ConceptName;
25	import org.openmrs.annotation.Handler;
26	import org.openmrs.api.APIException;
27	import org.openmrs.api.DuplicateConceptNameException;
28	import org.openmrs.api.context.Context;
29	import org.springframework.validation.Errors;
30	import org.springframework.validation.ValidationUtils;
31	import org.springframework.validation.Validator;
32
33	/**
34	* Validates {@link Concept} objects. <br>
35	* These validations are also documented at <a
36	* href="https://wiki.openmrs.org/x/-gkdAg">https://wiki.openmrs.org/x/-gkdAg</a>. Any changes made
37	* to this source also need to be reflected on that page.
38	*/
39	@Handler(supports = { Concept.class }, order = 50)
40	public class ConceptValidator extends BaseCustomizableValidator implements Validator {	1✔
41
42	// Log for this class
43	private static final Log log = LogFactory.getLog(ConceptValidator.class);	1✔
44
45	/**
46	* Determines if the command object being submitted is a valid type
47	*
48	* @see org.springframework.validation.Validator#supports(java.lang.Class)
49	*/
50	@Override
51	public boolean supports(Class<?> c) {
52	return Concept.class.isAssignableFrom(c);	1✔
53	}
54
55	/**
56	* Checks that a given concept object is valid.
57	*
58	* @see org.springframework.validation.Validator#validate(java.lang.Object,
59	* org.springframework.validation.Errors)
60	* @should pass if the concept has at least one fully specified name added to it
61	* @should fail if there is a duplicate unretired concept name in the locale
62	* @should fail if there is a duplicate unretired preferred name in the same locale
63	* @should fail if there is a duplicate unretired fully specified name in the same locale
64	* @should fail if any names in the same locale for this concept are similar
65	* @should pass if the concept with a duplicate name is retired
66	* @should pass if the concept being validated is retired and has a duplicate name
67	* @should fail if any name is an empty string
68	* @should fail if the object parameter is null
69	* @should pass if the concept is being updated with no name change
70	* @should fail if any name is a null value
71	* @should not allow multiple preferred names in a given locale
72	* @should not allow multiple fully specified conceptNames in a given locale
73	* @should not allow multiple short names in a given locale
74	* @should not allow an index term to be a locale preferred name
75	* @should fail if there is no name explicitly marked as fully specified
76	* @should pass if the duplicate ConceptName is neither preferred nor fully Specified
77	* @should pass if the concept has a synonym that is also a short name
78	* @should fail if a term is mapped multiple times to the same concept
79	* @should not fail if a term has two new mappings on it
80	* @should fail if there is a duplicate unretired concept name in the same locale different than
81	* the system locale
82	* @should pass for a new concept with a map created with deprecated concept map methods
83	* @should pass for an edited concept with a map created with deprecated concept map methods
84	* @should pass validation if field lengths are correct
85	* @should fail validation if field lengths are not correct
86	* @should pass if fully specified name is the same as short name
87	* @should pass if different concepts have the same short name
88	* @should fail if the concept datatype is null
89	* @should fail if the concept class is null
90	*/
91	@Override
92	public void validate(Object obj, Errors errors) throws APIException, DuplicateConceptNameException {
93
94	if (obj == null \|\| !(obj instanceof Concept)) {	1✔
95	throw new IllegalArgumentException("The parameter obj should not be null and must be of type" + Concept.class);	×
96	}
97
98	Concept conceptToValidate = (Concept) obj;	1✔
99	//no name to validate, but why is this the case?
100	if (conceptToValidate.getNames().isEmpty()) {	1✔
101	errors.reject("Concept.name.atLeastOneRequired");	×
102	return;	×
103	}
104
105	ValidationUtils.rejectIfEmpty(errors, "datatype", "Concept.datatype.empty");	1✔
106	ValidationUtils.rejectIfEmpty(errors, "conceptClass", "Concept.conceptClass.empty");	1✔
107
108	boolean hasFullySpecifiedName = false;	1✔
109	for (Locale conceptNameLocale : conceptToValidate.getAllConceptNameLocales()) {	1✔
110	boolean fullySpecifiedNameForLocaleFound = false;	1✔
111	boolean preferredNameForLocaleFound = false;	1✔
112	boolean shortNameForLocaleFound = false;	1✔
113	Set<String> validNamesFoundInLocale = new HashSet<>();	1✔
114	Collection<ConceptName> namesInLocale = conceptToValidate.getNames(conceptNameLocale);	1✔
115	for (ConceptName nameInLocale : namesInLocale) {	1✔
116	if (StringUtils.isBlank(nameInLocale.getName())) {	1✔
117	log.debug("Name in locale '" + conceptNameLocale.toString()	×
118	+ "' cannot be an empty string or white space");
119	errors.reject("Concept.name.empty");	×
120	}
121	if (nameInLocale.getLocalePreferred() != null) {	1✔
122	if (nameInLocale.getLocalePreferred() && !preferredNameForLocaleFound) {	1✔
123	if (nameInLocale.isIndexTerm()) {	1✔
124	log.warn("Preferred name in locale '" + conceptNameLocale.toString()	1✔
125	+ "' shouldn't be an index term");
126	errors.reject("Concept.error.preferredName.is.indexTerm");	1✔
127	} else if (nameInLocale.isShort()) {	1✔
128	log.warn("Preferred name in locale '" + conceptNameLocale.toString()	×
129	+ "' shouldn't be a short name");
130	errors.reject("Concept.error.preferredName.is.shortName");	×
131	} else if (nameInLocale.getVoided()) {	1✔
132	log.warn("Preferred name in locale '" + conceptNameLocale.toString()	×
133	+ "' shouldn't be a voided name");
134	errors.reject("Concept.error.preferredName.is.voided");	×
135	}
136
137	preferredNameForLocaleFound = true;	1✔
138	}
139	//should have one preferred name per locale
140	else if (nameInLocale.getLocalePreferred() && preferredNameForLocaleFound) {	1✔
141	log.warn("Found multiple preferred names in locale '" + conceptNameLocale.toString() + "'");	×
142	errors.reject("Concept.error.multipleLocalePreferredNames");	×
143	}
144	}
145
146	if (nameInLocale.isFullySpecifiedName()) {	1✔
147	if (!hasFullySpecifiedName) {	1✔
148	hasFullySpecifiedName = true;	1✔
149	}
150	if (!fullySpecifiedNameForLocaleFound) {	1✔
151	fullySpecifiedNameForLocaleFound = true;	1✔
152	} else {
153	log.warn("Found multiple fully specified names in locale '" + conceptNameLocale.toString() + "'");	×
154	errors.reject("Concept.error.multipleFullySpecifiedNames");	×
155	}
156	if (nameInLocale.getVoided()) {	1✔
157	log.warn("Fully Specified name in locale '" + conceptNameLocale.toString()	×
158	+ "' shouldn't be a voided name");
159	errors.reject("Concept.error.fullySpecifiedName.is.voided");	×
160	}
161	}
162
163	if (nameInLocale.isShort()) {	1✔
164	if (!shortNameForLocaleFound) {	1✔
165	shortNameForLocaleFound = true;	1✔
166	}
167	//should have one short name per locale
168	else {
169	log.warn("Found multiple short names in locale '" + conceptNameLocale.toString() + "'");	×
170	errors.reject("Concept.error.multipleShortNames");	×
171	}
172	}
173
174	//find duplicate names for a non-retired concept
175	if (Context.getConceptService().isConceptNameDuplicate(nameInLocale)) {	1✔
176	throw new DuplicateConceptNameException("'" + nameInLocale.getName()	1✔
177	+ "' is a duplicate name in locale '" + conceptNameLocale.toString() + "'");	1✔
178	}
179
180	//
181	if (errors.hasErrors()) {	1✔
182	log.debug("Concept name '" + nameInLocale.getName() + "' for locale '" + conceptNameLocale	1✔
183	+ "' is invalid");
184	//if validation fails for any conceptName in current locale, don't proceed
185	//This helps not to have multiple messages shown that are identical though they might be
186	//for different conceptNames
187	return;	1✔
188	}
189
190	//No duplicate names allowed for the same locale and concept, keep the case the same
191	//except for short names
192	if (!nameInLocale.isShort() && !validNamesFoundInLocale.add(nameInLocale.getName().toLowerCase())) {	1✔
193	throw new DuplicateConceptNameException("'" + nameInLocale.getName()	1✔
194	+ "' is a duplicate name in locale '" + conceptNameLocale.toString() + "' for the same concept");	1✔
195	}
196
197	if (log.isDebugEnabled()) {	1✔
198	log.debug("Valid name found: " + nameInLocale.getName());	×
199	}
200	}	1✔
201	}	1✔
202
203	//Ensure that each concept has at least a fully specified name
204	if (!hasFullySpecifiedName) {	1✔
205	log.debug("Concept has no fully specified name");	1✔
206	errors.reject("Concept.error.no.FullySpecifiedName");	1✔
207	}
208
209	if (CollectionUtils.isNotEmpty(conceptToValidate.getConceptMappings())) {	1✔
210	//validate all the concept maps
211	int index = 0;	1✔
212	Set<Integer> mappedTermIds = null;	1✔
213	for (ConceptMap map : conceptToValidate.getConceptMappings()) {	1✔
214	if (map.getConceptReferenceTerm().getConceptReferenceTermId() == null) {	1✔
215	//if this term is getting created on the fly e.g. from old legacy code, validate it
216	try {
217	errors.pushNestedPath("conceptMappings[" + index + "].conceptReferenceTerm");	1✔
218	ValidationUtils.invokeValidator(new ConceptReferenceTermValidator(), map.getConceptReferenceTerm(),	1✔
219	errors);
220	}
221	finally {
222	errors.popNestedPath();	1✔
223	}	1✔
224
225	}
226	/*if (map.getConceptMapType() == null) {
227	errors.rejectValue("conceptMappings[" + index + "].conceptMapType", "Concept.map.typeRequired",
228	"The concept map type is required for a concept map");
229	return;
230	}*/
231
232	//don't proceed to the next maps since the current one already has errors
233	if (errors.hasErrors()) {	1✔
234	return;	1✔
235	}
236
237	if (mappedTermIds == null) {	1✔
238	mappedTermIds = new HashSet<>();	1✔
239	}
240
241	//if we already have a mapping to this term, reject it this map
242	if (map.getConceptReferenceTerm().getId() != null	1✔
243	&& !mappedTermIds.add(map.getConceptReferenceTerm().getId())) {	1✔
244	errors.rejectValue("conceptMappings[" + index + "]", "ConceptReferenceTerm.term.alreadyMapped",	1✔
245	"Cannot map a reference term multiple times to the same concept");
246	}
247
248	index++;	1✔
249	}	1✔
250	}
251	if (CollectionUtils.isNotEmpty(conceptToValidate.getAnswers())) {	1✔
252	for (ConceptAnswer conceptAnswer : conceptToValidate.getAnswers()) {	1✔
253	if (conceptAnswer.getAnswerConcept().equals(conceptToValidate)) {	1✔
254	errors.reject("Concept.contains.itself.as.answer");	1✔
255	}
256	}	1✔
257	}
258	ValidateUtil.validateFieldLengths(errors, obj.getClass(), "version", "retireReason");	1✔
259	super.validateAttributes(conceptToValidate, errors, Context.getConceptService().getAllConceptAttributeTypes());	1✔
260	}	1✔
261	}

openmrs / openmrs-core / 5639

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous