[#277] - CSV parser to save cached objects once file has been loaded.

Amos Laboso · Ruhanga · commit 7b1b14c79716 · 2024-09-13T11:15:19.000+03:00
diff --git a/.vscode/settings.json b/.vscode/settings.json
diff --git a/api-2.4/src/main/java/org/openmrs/module/initializer/api/billing/PaymentModesCsvParser.java b/api-2.4/src/main/java/org/openmrs/module/initializer/api/billing/PaymentModesCsvParser.java
@@ -18,7 +18,7 @@ public class PaymentModesCsvParser extends CsvParser<PaymentMode, BaseLineProces
 	
 	@Autowired
 	public PaymentModesCsvParser(@Qualifier("cashierPaymentModeService") IPaymentModeService paymentModeService,
-			PaymentModesLineProcessor processor) {
+	    PaymentModesLineProcessor processor) {
 		super(processor);
 		this.paymentModeService = paymentModeService;
 	}
diff --git a/api-2.4/src/main/java/org/openmrs/module/initializer/api/billing/PaymentModesLineProcessor.java b/api-2.4/src/main/java/org/openmrs/module/initializer/api/billing/PaymentModesLineProcessor.java
@@ -21,18 +21,21 @@ public PaymentMode fill(PaymentMode paymentMode, CsvLine line) throws IllegalArg
 		
 		String attributes = line.get(HEADER_ATTRIBUTES, false);
 		if (StringUtils.isNotBlank(attributes)) {
-			paymentMode.getAttributeTypes().clear();
+			if (paymentMode.getAttributeTypes() != null) {
+				paymentMode.getAttributeTypes().clear();
+			}
 			for (String attribute : attributes.split(BaseLineProcessor.LIST_SEPARATOR)) {
 				String[] parts = attribute.trim().split("::");
 				if (parts.length > 3) {
-					paymentMode.addAttributeType(parts[0].trim(), parts[1].trim(), parts[2].trim(), Boolean.parseBoolean(parts[3].trim()));
+					paymentMode.addAttributeType(parts[0].trim(), parts[1].trim(), parts[2].trim(),
+					    Boolean.parseBoolean(parts[3].trim()));
 				} else if (parts.length > 2) {
 					paymentMode.addAttributeType(parts[0].trim(), parts[1].trim(), parts[2].trim(), false);
 				} else if (parts.length > 1) {
 					paymentMode.addAttributeType(parts[0].trim(), parts[1].trim(), null, false);
 				} else {
 					paymentMode.addAttributeType(parts[0].trim(), null, null, false);
-				} 
+				}
 			}
 		}
 		
diff --git a/api-2.4/src/test/java/org/openmrs/module/initializer/api/PaymentModesLoaderIntegrationTest.java b/api-2.4/src/test/java/org/openmrs/module/initializer/api/PaymentModesLoaderIntegrationTest.java
@@ -49,16 +49,16 @@ public void load_shouldLoadPaymentModesAccordingToCsvFiles() {
 		{
 			PaymentMode paymentMode = paymentModeService.getByUuid("e168c141-f5fd-4eec-bd3e-633bed1c9606");
 			assertNotNull(paymentMode);
-			assertEquals("Paypal", paymentMode.getName()); 
+			assertEquals("Paypal", paymentMode.getName());
 			
 			paymentMode.getAttributeTypes().forEach(attributeType -> {
-	            if (attributeType.getName().equals("Maximum")) {
-	            	assertEquals("Numeric", attributeType.getFormat());
-	            	assertTrue(attributeType.getRequired());
-	            } else {
-	            	assertEquals("Minimum", attributeType.getName());
-	            }
-	        });
+				if (attributeType.getName().equals("Maximum")) {
+					assertEquals("Numeric", attributeType.getFormat());
+					assertTrue(attributeType.getRequired());
+				} else {
+					assertEquals("Minimum", attributeType.getName());
+				}
+			});
 		}
 		
 		// Verify edition
diff --git a/api-2.4/src/test/resources/testAppDataDir/configuration/paymentmodes/paymentModes.csv b/api-2.4/src/test/resources/testAppDataDir/configuration/paymentmodes/paymentModes.csv
@@ -1,4 +1,4 @@
-uuid, Void/Retire, name, attributes
-526bf278-ba81-4436-b867-c2f6641d060a, , Visa card edited,
-2b1b9aae-5d35-43dd-9214-3fd370fd7737, true, Bank transfer,
-e168c141-f5fd-4eec-bd3e-633bed1c9606, , Paypal, Maximum::Numeric::::True;Minimum
+uuid,Void/Retire,name,attributes
+526bf278-ba81-4436-b867-c2f6641d060a,,Visa card edited,
+2b1b9aae-5d35-43dd-9214-3fd370fd7737,true,Bank transfer,
+e168c141-f5fd-4eec-bd3e-633bed1c9606,,Paypal,Maximum::Numeric::::True;Minimum
diff --git a/api/src/main/java/org/openmrs/module/initializer/api/CsvParser.java b/api/src/main/java/org/openmrs/module/initializer/api/CsvParser.java
@@ -189,6 +189,10 @@ public List<String[]> getLines() {
 	 * @return The resulting CsvParserResult instance.
 	 */
 	public CsvFailingLines process(List<String[]> lines) {
+		// Save cached objects to avoid losing them prematurely by other Parsers
+		// See DisplaysCsvParser#save(OpenmrsObject)
+		Context.flushSession();
+		Context.clearSession();
 		
 		CsvFailingLines result = new CsvFailingLines();
 		int saved = 0;
diff --git a/api/src/test/java/org/openmrs/module/initializer/api/ProgramWorkflowStatesLoaderIntegrationTest.java b/api/src/test/java/org/openmrs/module/initializer/api/ProgramWorkflowStatesLoaderIntegrationTest.java
@@ -1,11 +1,14 @@
 package org.openmrs.module.initializer.api;
 
+import java.util.Arrays;
+import java.util.Collections;
 import java.util.Locale;
 
 import org.junit.Assert;
 import org.junit.Before;
 import org.junit.Test;
 import org.openmrs.Concept;
+import org.openmrs.ConceptDescription;
 import org.openmrs.ConceptName;
 import org.openmrs.ProgramWorkflow;
 import org.openmrs.ProgramWorkflowState;
@@ -50,6 +53,7 @@ public void setup() {
 		{
 			Concept c = new Concept();
 			c.setShortName(new ConceptName("Active treatment (initial)", Locale.ENGLISH));
+			c.setDescriptions(Collections.singleton(new ConceptDescription("Active treatment (initial)", Locale.ENGLISH)));
 			c.setConceptClass(cs.getConceptClassByName("State"));
 			c.setDatatype(cs.getConceptDatatypeByName("Text"));
 			c = cs.saveConcept(c);
@@ -124,8 +128,8 @@ public void load_shouldLoadProgramWorkflowStatesAccordingToCsvFiles() {
 			Assert.assertEquals(wf, state.getProgramWorkflow());
 			
 			Assert.assertEquals(cs.getConceptByName("Active treatment (initial)"), state.getConcept());
-			Assert.assertEquals("Active treatment (initial)", state.getName());
-			Assert.assertEquals("Active treatment (initial)", state.getDescription());
+			Assert.assertEquals("Active treatment (initial)", state.getConcept().getName().getName());
+			Assert.assertEquals("Active treatment (initial)", state.getConcept().getDescription().getDescription());
 			Assert.assertFalse(state.isRetired());
 			Assert.assertTrue(state.getInitial());
 			Assert.assertFalse(state.getTerminal());
diff --git a/api/src/test/java/org/openmrs/module/initializer/api/ProgramWorkflowsLoaderIntegrationTest.java b/api/src/test/java/org/openmrs/module/initializer/api/ProgramWorkflowsLoaderIntegrationTest.java
@@ -1,11 +1,13 @@
 package org.openmrs.module.initializer.api;
 
+import java.util.Collections;
 import java.util.Locale;
 
 import org.junit.Assert;
 import org.junit.Before;
 import org.junit.Test;
 import org.openmrs.Concept;
+import org.openmrs.ConceptDescription;
 import org.openmrs.ConceptName;
 import org.openmrs.Program;
 import org.openmrs.ProgramWorkflow;
@@ -39,6 +41,8 @@ public static void setupWorkflows(ConceptService cs, ProgramWorkflowService pws)
 		{
 			Concept c = new Concept();
 			c.setShortName(new ConceptName("TB Treatment Status (workflow)", Locale.ENGLISH));
+			c.setDescriptions(
+			    Collections.singleton(new ConceptDescription("TB Treatment Status (workflow)", Locale.ENGLISH)));
 			c.setConceptClass(cs.getConceptClassByName("Workflow"));
 			c.setDatatype(cs.getConceptDatatypeByName("Text"));
 			c = cs.saveConcept(c);
@@ -133,8 +137,8 @@ public void load_shouldLoadProgramWorkflowsAccordingToCsvFiles() {
 			Program prog = pws.getProgramByName("TB Program");
 			Assert.assertEquals(prog, wf.getProgram());
 			Assert.assertEquals(cs.getConceptByName("TB Treatment Status (workflow)"), wf.getConcept());
-			Assert.assertEquals("TB Treatment Status (workflow)", wf.getName());
-			Assert.assertEquals("TB Treatment Status (workflow)", wf.getDescription());
+			Assert.assertEquals("TB Treatment Status (workflow)", wf.getConcept().getName().getName());
+			Assert.assertEquals("TB Treatment Status (workflow)", wf.getConcept().getDescription().getDescription());
 			Assert.assertFalse(wf.isRetired());
 			Assert.assertEquals(wf, prog.getWorkflow(wf.getId()));
 		}
diff --git a/api/src/test/java/org/openmrs/module/initializer/api/RelationshipTypesLoaderIntegrationTest.java b/api/src/test/java/org/openmrs/module/initializer/api/RelationshipTypesLoaderIntegrationTest.java
@@ -29,7 +29,7 @@ public void load_shouldLoadRelationshipTypesAccordingToCsvFiles() {
 		{
 			RelationshipType rt = ps.getRelationshipTypeByUuid("c86d9979-b8ac-4d8c-85cf-cc04e7f16315");
 			Assert.assertNotNull(rt);
-			Assert.assertEquals("Uncle/Nephew", rt.getName());
+			Assert.assertEquals("Uncle/Nephew", rt.toString());
 			Assert.assertEquals("A relationship of an uncle and his nephew", rt.getDescription());
 			Assert.assertEquals("Uncle", rt.getaIsToB());
 			Assert.assertEquals("Nephew", rt.getbIsToA());
@@ -41,7 +41,7 @@ public void load_shouldLoadRelationshipTypesAccordingToCsvFiles() {
 		{
 			RelationshipType rt = ps.getRelationshipTypeByUuid("53d8a8f3-0084-4a52-8666-c655f5bd2689");
 			Assert.assertNotNull(rt);
-			Assert.assertEquals("Supervisor/Supervisee", rt.getName());
+			Assert.assertEquals("Supervisor/Supervisee", rt.toString());
 			Assert.assertEquals("A new description for supervisor to supervisee relationship", rt.getDescription());
 		}
 		
diff --git a/pom.xml b/pom.xml
@@ -73,6 +73,7 @@
         <openconceptlabVersion>1.2.9</openconceptlabVersion>
         <fhir2Version>1.6.0</fhir2Version>
         <billingVersion>1.1.0</billingVersion>
+        <stockmanagementVersion>2.0.2-SNAPSHOT</stockmanagementVersion>
 
         <!-- Modules compatibility > Core 2.3.0 -->
         <datafilterVersion>1.0.0</datafilterVersion>
diff --git a/validator/pom.xml b/validator/pom.xml
@@ -382,6 +382,22 @@
         <version>${mysqlTestContainerVersion}</version>
     </dependency>
 
+    <dependency>
+      <groupId>org.openmrs.module</groupId>
+      <artifactId>exti18n-api</artifactId>
+      <version>${exti18nVersion}</version>
+      <scope>runtime</scope>
+      <type>jar</type>
+    </dependency>
+
+    <dependency>
+      <groupId>org.openmrs.module</groupId>
+      <artifactId>stockmanagement-api</artifactId>
+      <version>${stockmanagementVersion}</version>
+      <scope>runtime</scope>
+      <type>jar</type>
+    </dependency>
+
   </dependencies>
 
   <build>

Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ public class PaymentModesCsvParser extends CsvParser<PaymentMode, BaseLineProces`
`18`	`18`
`19`	`19`	`@Autowired`
`20`	`20`	`public PaymentModesCsvParser(@Qualifier("cashierPaymentModeService") IPaymentModeService paymentModeService,`
`21`		`- PaymentModesLineProcessor processor) {`
	`21`	`+ PaymentModesLineProcessor processor) {`
`22`	`22`	`super(processor);`
`23`	`23`	`this.paymentModeService = paymentModeService;`
`24`	`24`	`}`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ public void load_shouldLoadRelationshipTypesAccordingToCsvFiles() {`
`29`	`29`	`{`
`30`	`30`	`RelationshipType rt = ps.getRelationshipTypeByUuid("c86d9979-b8ac-4d8c-85cf-cc04e7f16315");`
`31`	`31`	`Assert.assertNotNull(rt);`
`32`		`- Assert.assertEquals("Uncle/Nephew", rt.getName());`
	`32`	`+ Assert.assertEquals("Uncle/Nephew", rt.toString());`
`33`	`33`	`Assert.assertEquals("A relationship of an uncle and his nephew", rt.getDescription());`
`34`	`34`	`Assert.assertEquals("Uncle", rt.getaIsToB());`
`35`	`35`	`Assert.assertEquals("Nephew", rt.getbIsToA());`
`@@ -41,7 +41,7 @@ public void load_shouldLoadRelationshipTypesAccordingToCsvFiles() {`
`41`	`41`	`{`
`42`	`42`	`RelationshipType rt = ps.getRelationshipTypeByUuid("53d8a8f3-0084-4a52-8666-c655f5bd2689");`
`43`	`43`	`Assert.assertNotNull(rt);`
`44`		`- Assert.assertEquals("Supervisor/Supervisee", rt.getName());`
	`44`	`+ Assert.assertEquals("Supervisor/Supervisee", rt.toString());`
`45`	`45`	`Assert.assertEquals("A new description for supervisor to supervisee relationship", rt.getDescription());`
`46`	`46`	`}`
`47`	`47`