RAD-385 MrrtReportTemplate.dcTermsDate should be a Date object not a …

…string
openmrs · Nov 27, 2016 · ac55bff · ac55bff
1 parent f072080
commit ac55bff
Show file tree

Hide file tree

Showing 11 changed files with 115 additions and 12 deletions.
diff --git a/...ava/org/openmrs/module/radiology/report/template/DefaultMrrtReportTemplateFileParser.java b/...ava/org/openmrs/module/radiology/report/template/DefaultMrrtReportTemplateFileParser.java
@@ -12,6 +12,8 @@
 import java.io.ByteArrayInputStream;
 import java.io.IOException;
 import java.io.InputStream;
+import java.text.ParseException;
+import java.text.SimpleDateFormat;
 import java.util.HashSet;
 import java.util.List;
 import java.util.Set;
@@ -78,7 +80,12 @@ public MrrtReportTemplate parse(String mrrtTemplate) throws IOException {
 
         final Document doc = Jsoup.parse(mrrtTemplate, "");
         final MrrtReportTemplate result = new MrrtReportTemplate();
-        initializeTemplate(result, doc);
+        try {
+            initializeTemplate(result, doc);
+        }
+        catch (ParseException e) {
+            throw new APIException("radiology.report.template.parser.error", null, e);
+        }
         try {
             addTermsToTemplate(result, doc.getElementsByTag("script")
                     .get(0)
@@ -90,7 +97,7 @@ public MrrtReportTemplate parse(String mrrtTemplate) throws IOException {
         return result;
     }
 
-    private final void initializeTemplate(MrrtReportTemplate template, Document doc) {
+    private final void initializeTemplate(MrrtReportTemplate template, Document doc) throws ParseException {
         final Elements metaTags = doc.getElementsByTag("meta");
 
         template.setPath(doc.baseUri());
@@ -125,7 +132,7 @@ private final void initializeTemplate(MrrtReportTemplate template, Document doc)
                     template.setDcTermsLicense(content);
                     break;
                 case DCTERMS_DATE:
-                    template.setDcTermsDate(content);
+                    template.setDcTermsDate(new SimpleDateFormat(MrrtReportTemplateConstants.DATE_FORMAT).parse(content));
                     break;
                 case DCTERMS_CREATOR:
                     template.setDcTermsCreator(content);

diff --git a/api/src/main/java/org/openmrs/module/radiology/report/template/MetaTagsValidationEngine.java b/api/src/main/java/org/openmrs/module/radiology/report/template/MetaTagsValidationEngine.java
@@ -9,23 +9,31 @@
  */
 package org.openmrs.module.radiology.report.template;
 
-import org.jsoup.select.Elements;
-
+import java.text.ParseException;
+import java.text.SimpleDateFormat;
 import java.util.ArrayList;
 import java.util.List;
 
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
+import org.jsoup.nodes.Element;
+import org.jsoup.select.Elements;
+
 /**
  * Validates <meta> tags of an Mrrt Report Template.
  */
 class MetaTagsValidationEngine implements ValidationEngine<Elements> {
-
-
+
     static String SELECTOR_QUERY_META_ATTRIBUTE_CHARSET = "meta[charset]";
 
     static String SELECTOR_QUERY_META_ATTRIBUTE_NAME = "meta[name]";
 
+    static String SELECTOR_QUERY_META_ATTRIBUTE_DATE = "meta[name=dcterms.date]";
+
     private List<ValidationRule<Elements>> rules;
 
+    private static final Log log = LogFactory.getLog(MetaTagsValidationEngine.class);
+
     public MetaTagsValidationEngine() {
         rules = new ArrayList<>();
         rules.add(new ElementsExpressionValidationRule("One 'meta' element with attribute 'charset' expected",
@@ -35,6 +43,9 @@ public MetaTagsValidationEngine() {
             new ElementsExpressionValidationRule("At least one 'meta' element encoding dublin core attributes expected",
                     "radiology.MrrtReportTemplate.validation.error.meta.dublinCore.missing",
                     SELECTOR_QUERY_META_ATTRIBUTE_NAME, subject -> subject.isEmpty()));
+        rules.add(new ElementsExpressionValidationRule("dcterms.date element should be a valid date",
+                "radiology.MrrtReportTemplate.validation.error.date.invalid", SELECTOR_QUERY_META_ATTRIBUTE_DATE,
+                subject -> validateDate(subject)));
     }
 
     /**
@@ -53,4 +64,18 @@ public ValidationResult run(Elements subject) {
         }
         return validationResult;
     }
+
+    private final boolean validateDate(Elements elements) {
+        boolean result = false;
+        if (!elements.isEmpty()) {
+            Element dcTermsDateElement = elements.get(0);
+            try {
+                new SimpleDateFormat(MrrtReportTemplateConstants.DATE_FORMAT).parse(dcTermsDateElement.attr("content"));
+            }
+            catch (ParseException ex) {
+                result = true;
+            }
+        }
+        return result;
+    }
 }
diff --git a/api/src/main/java/org/openmrs/module/radiology/report/template/MrrtReportTemplate.java b/api/src/main/java/org/openmrs/module/radiology/report/template/MrrtReportTemplate.java
@@ -9,6 +9,7 @@
  */
 package org.openmrs.module.radiology.report.template;
 
+import java.util.Date;
 import java.util.Set;
 
 import org.openmrs.BaseOpenmrsData;
@@ -44,7 +45,7 @@ public class MrrtReportTemplate extends BaseOpenmrsData {
 
     private String dcTermsLicense;
 
-    private String dcTermsDate;
+    private Date dcTermsDate;
 
     private String dcTermsCreator;
 
@@ -148,11 +149,11 @@ public void setDcTermsLicense(String dcTermsLicense) {
         this.dcTermsLicense = dcTermsLicense;
     }
 
-    public String getDcTermsDate() {
+    public Date getDcTermsDate() {
         return dcTermsDate;
     }
 
-    public void setDcTermsDate(String dcTermsDate) {
+    public void setDcTermsDate(Date dcTermsDate) {
         this.dcTermsDate = dcTermsDate;
     }
 

diff --git a/...c/main/java/org/openmrs/module/radiology/report/template/MrrtReportTemplateConstants.java b/...c/main/java/org/openmrs/module/radiology/report/template/MrrtReportTemplateConstants.java
@@ -0,0 +1,7 @@
+package org.openmrs.module.radiology.report.template;
+
+public final class MrrtReportTemplateConstants {
+
+	public static final String DATE_FORMAT = "yyyy-MM-dd";
+
+}
diff --git a/...c/main/java/org/openmrs/module/radiology/report/template/MrrtReportTemplateValidator.java b/...c/main/java/org/openmrs/module/radiology/report/template/MrrtReportTemplateValidator.java
@@ -50,6 +50,7 @@ public interface MrrtReportTemplateValidator {
      * @should throw api exception if html element does not have a body element
      * @should throw api exception if html element has more than one body element 
      * @should catch all violation errors and throw an mrrt report template exception
+     * @should throw an mrrt report template exception if dcterms date of template file is not valid
      */
     public void validate(String mrrtTemplate) throws IOException;
 }
diff --git a/api/src/main/resources/MrrtReportTemplate.hbm.xml b/api/src/main/resources/MrrtReportTemplate.hbm.xml
@@ -33,7 +33,7 @@
 		<property name="dcTermsPublisher" column="dcterms_publisher" type="java.lang.String"/>
 		<property name="dcTermsRights" column="dcterms_rights" type="java.lang.String"/>
 		<property name="dcTermsLicense" column="dcterms_license" type="java.lang.String"/>
-		<property name="dcTermsDate" column="dcterms_date" type="java.lang.String"/>
+		<property name="dcTermsDate" column="dcterms_date" type="java.util.Date"/>
 		<property name="dcTermsCreator" column="dcterms_creator" type="java.lang.String"/>
 
 		<!-- bi-directional many-to-many association to ConceptReferenceTerm -->

diff --git a/api/src/main/resources/liquibase.xml b/api/src/main/resources/liquibase.xml
@@ -568,4 +568,8 @@
 			<column name="uuid" value="d9015276-b7b1-45f1-ad72-323896e75a52" />
 		</insert>
 	</changeSet>
+	<changeSet id="radiology-46" author="ivange94">
+		<comment>Change the datatype of dcterms_date from varchar(32) to date</comment>
+		<modifyDataType tableName="radiology_report_template" columnName="dcterms_date" newDataType="datetime"/>
+	</changeSet>
 </databaseChangeLog>
diff --git a/...g/openmrs/module/radiology/report/template/MrrtReportTemplateFileParserComponentTest.java b/...g/openmrs/module/radiology/report/template/MrrtReportTemplateFileParserComponentTest.java
@@ -18,6 +18,8 @@
 import java.io.FileInputStream;
 import java.io.IOException;
 import java.io.InputStream;
+import java.text.SimpleDateFormat;
+import java.util.Date;
 
 import org.apache.commons.io.IOUtils;
 import org.junit.Before;
@@ -120,6 +122,7 @@ public void parse_shouldReturnAnMrrtTemplateObjectIfFileIsValid() throws Excepti
         String templateContent = getFileContent("mrrttemplates/ihe/connectathon/2015/CTChestAbdomen.html");
 
         MrrtReportTemplate template = parser.parse(templateContent);
+        Date dcTermsDate = new SimpleDateFormat("yyyy-MM-dd").parse(TEST_DCTERMS_DATE);
 
         assertNotNull(template);
         assertThat(template.getCharset(), is(CHARSET));
@@ -132,7 +135,7 @@ public void parse_shouldReturnAnMrrtTemplateObjectIfFileIsValid() throws Excepti
         assertThat(template.getDcTermsPublisher(), is(TEST_DCTERMS_PUBLISHER));
         assertThat(template.getDcTermsRights(), is(TEST_DCTERMS_RIGHTS));
         assertThat(template.getDcTermsLicense(), is(TEST_DCTERMS_LICENSE));
-        assertThat(template.getDcTermsDate(), is(TEST_DCTERMS_DATE));
+        assertThat(template.getDcTermsDate(), is(dcTermsDate));
         assertThat(template.getDcTermsCreator(), is(TEST_DCTERMS_CREATOR));
     }
 

diff --git a/...rg/openmrs/module/radiology/report/template/MrrtReportTemplateValidatorComponentTest.java b/...rg/openmrs/module/radiology/report/template/MrrtReportTemplateValidatorComponentTest.java
@@ -407,4 +407,17 @@ public void validate_catchAllViolationErrorsAndThrowAnMrrtReportTemplateExceptio
                 is(4));
         }
     }
+
+    /**
+     * @see MrrtReportTemplateValidator#validate(String)
+     * @verifies throw an mrrt report template exception if dcterms date of template file is not valid
+     */
+    @Test
+    public void validate_shouldThrowAnMrrtReportTemplateExceptionIfDctermsDateOfTemplateFileIsNotValid() throws Exception {
+
+        String templateContent = getFileContent(
+            "mrrttemplates/ihe/connectathon/2015/invalidMrrtReportTemplate-dcTermsDateIsNotAValidDateObject.html");
+        expectedException.expect(MrrtReportTemplateValidationException.class);
+        validator.validate(templateContent);
+    }
 }
diff --git a/...tes/ihe/connectathon/2015/invalidMrrtReportTemplate-dcTermsDateIsNotAValidDateObject.html b/...tes/ihe/connectathon/2015/invalidMrrtReportTemplate-dcTermsDateIsNotAValidDateObject.html
@@ -0,0 +1,41 @@
+<!DOCTYPE html>
+<html>
+	<head>
+		<title>CT Chest-Abdomen</title>
+		<meta charset="UTF-8"/>
+		<meta name="dcterms.title" content="CT Chest-Abdomen"/>
+		<meta name="dcterms.identifier" content="1.3.6.1.4.1.21367.13.199.1015"/>
+        <meta name="dcterms.description" content="CT Chest-Abdomen"/>
+		<meta name="dcterms.type" content="IMAGE_REPORT_TEMPLATE"/>
+		<meta name="dcterms.publisher" content="IHE CAT Publisher"/>
+		<meta name="dcterms.rights" content="IHE Connectathon Rights"/>
+		<meta name="dcterms.license" content="IHE Connectathon License"/>
+		<meta name="dcterms.date" content="2013"/>
+		<meta name="dcterms.creator" content="Creator James, et al."/>
+		<meta name="dcterms.language" content="en"/>
+		<link rel="stylesheet" type="text/css" href="IHE_Template_Style.css" />
+		<script type="text/xml">
+			<template_attributes>
+				<top-level-flag>true</top-level-flag> 
+				<status>ACTIVE</status>
+				<coding_schemes>					  <coding_scheme name="RADLEX" designator="2.16.840.1.113883.6.256" />                </coding_schemes>					
+				<term type="modality">
+					<code meaning="computed tomography" value="RID10321" scheme="RADLEX" />
+				</term>
+				<term type="body part">
+					<code meaning="abdomen" value="RID56" scheme="RADLEX" />			
+				</term>
+				<term type="body part">
+					<code meaning="thorax" value="RID1243" scheme="RADLEX" />			
+				</term>
+				<coded_content> </coded_content>
+			</template_attributes>
+		</script>
+	</head>
+	<body>
+		<section data-section-name="The Only Section">
+			<header class="level1">Section Header</header>			
+				<p> This is the CT Chest-Abdomen report template</p>
+		</section>
+	</body>
+</html>

diff --git a/omod/src/main/resources/messages.properties b/omod/src/main/resources/messages.properties
@@ -181,6 +181,7 @@
 @MODULE_ID@.MrrtReportTemplate.not.imported.empty=Failed to import report template because it was empty
 @MODULE_ID@.MrrtReportTemplate.validation.error.meta.charset.occurence=Template file should have exactly one 'meta' element with attribute 'charset'
 @MODULE_ID@.MrrtReportTemplate.validation.error.meta.dublinCore.missing=Template file should have at least one 'meta' element encoding dublin core attributes
+@MODULE_ID@.MrrtReportTemplate.validation.error.date.invalid=dcterms.date needs to be of format yyyy-MM-dd like for example 2016-01-24
 
 @MODULE_ID@.patientId=Patient Id
 @MODULE_ID@.patientFullName=Patient Full Name