Refactor JsonFormUtils 💚

- Add unit tests - Overload Init method to add appVersionName
opensrp · Jul 19, 2022 · a575176 · a575176
1 parent e1bdaa5
commit a575176
Show file tree

Hide file tree

Showing 8 changed files with 253 additions and 19 deletions.
diff --git a/gradle.properties b/gradle.properties
@@ -1,4 +1,4 @@
-VERSION_NAME=3.0.0-ALPHA-SNAPSHOT
+VERSION_NAME=3.0.0-BETA-SNAPSHOT
 VERSION_CODE=1
 GROUP=org.smartregister
 POM_SETTING_DESCRIPTION=OpenSRP Client Growth Monitoring Application

diff --git a/opensrp-growth-monitoring/build.gradle b/opensrp-growth-monitoring/build.gradle
@@ -98,7 +98,7 @@ allprojects {
 
 dependencies {
 
-    implementation('org.smartregister:opensrp-client-core:6.0.0-ALPHA-SNAPSHOT@aar') {
+    implementation('org.smartregister:opensrp-client-core:6.0.0-BETA2-SNAPSHOT@aar') {
         transitive = true
         exclude group: 'com.github.bmelnychuk', module: 'atv'
         exclude group: 'com.ibm.fhir', module: 'fhir-model'

diff --git a/...-monitoring/src/main/java/org/smartregister/growthmonitoring/GrowthMonitoringLibrary.java b/...-monitoring/src/main/java/org/smartregister/growthmonitoring/GrowthMonitoringLibrary.java
@@ -32,30 +32,51 @@ public class GrowthMonitoringLibrary {
     private EventClientRepository eventClientRepository;
     private int applicationVersion;
     private int databaseVersion;
+    private String applicationVersionName;
     private AppProperties appProperties;
 
     private long growthMonitoringSyncTime = -1;
 
-    private GrowthMonitoringLibrary(Context context, Repository repository, int applicationVersion, int databaseVersion) {
+    private GrowthMonitoringLibrary(Context context, Repository repository, int applicationVersion, String applicationVersionName, int databaseVersion) {
         this.repository = repository;
         this.context = context;
         this.applicationVersion = applicationVersion;
         this.databaseVersion = databaseVersion;
+        this.applicationVersionName = applicationVersionName;
         this.appProperties = GrowthMonitoringUtils.getProperties(this.context.applicationContext());
     }
 
-    public static void init(Context context, Repository repository, int applicationVersion, int databaseVersion,
-                            GrowthMonitoringConfig growthMonitoringConfig) {
+    /**
+     * This init is deprecated, use {@link #init(Context context, Repository repository, int applicationVersion, int databaseVersion, GrowthMonitoringConfig growthMonitoringConfig)} instead which adds application version name.
+     */
+    @Deprecated
+    public static void init(Context context, Repository repository, int applicationVersion, int databaseVersion, GrowthMonitoringConfig growthMonitoringConfig) {
 
         init(context, repository, applicationVersion, databaseVersion);
 
         config = growthMonitoringConfig != null ? growthMonitoringConfig : config;
 
     }
 
+    public static void init(Context context, Repository repository, int applicationVersion, String applicationVersionName, int databaseVersion, GrowthMonitoringConfig growthMonitoringConfig) {
+
+        init(context, repository, applicationVersion, applicationVersionName, databaseVersion);
+
+        config = growthMonitoringConfig != null ? growthMonitoringConfig : config;
+
+    }
+
+    /**
+     * This init is deprecated, use {@link #init(Context, Repository, int, String, int)} instead which adds application version name.
+     */
+    @Deprecated
     public static void init(Context context, Repository repository, int applicationVersion, int databaseVersion) {
+        init(context, repository, applicationVersion, null, databaseVersion);
+    }
+
+    public static void init(Context context, Repository repository, int applicationVersion, String applicationVersionName, int databaseVersion) {
         if (instance == null) {
-            instance = new GrowthMonitoringLibrary(context, repository, applicationVersion, databaseVersion);
+            instance = new GrowthMonitoringLibrary(context, repository, applicationVersion, applicationVersionName, databaseVersion);
         }
     }
 
@@ -129,6 +150,10 @@ public int getDatabaseVersion() {
         return databaseVersion;
     }
 
+    public String getApplicationVersionName() {
+        return applicationVersionName;
+    }
+
     public GrowthMonitoringConfig getConfig() {
         return config;
     }
@@ -156,4 +181,12 @@ public void setGrowthMonitoringSyncTime(int growthMonitoringSyncTimeInHours) {
     public void setGrowthMonitoringSyncTime(int growthMonitoringSyncTime, @NonNull TimeUnit timeUnit) {
         this.growthMonitoringSyncTime = timeUnit.toMinutes(growthMonitoringSyncTime);
     }
+
+    /**
+     * Public method to clear the instance/destroy useful for testing
+     */
+    public static void destroy() {
+        instance = null;
+    }
+
 }
diff --git a/...rowth-monitoring/src/main/java/org/smartregister/growthmonitoring/util/JsonFormUtils.java b/...rowth-monitoring/src/main/java/org/smartregister/growthmonitoring/util/JsonFormUtils.java
@@ -2,12 +2,15 @@
 
 import org.apache.commons.lang3.StringUtils;
 import org.json.JSONArray;
+import org.json.JSONException;
 import org.json.JSONObject;
+import org.smartregister.AllConstants;
+import org.smartregister.Context;
 import org.smartregister.clientandeventmodel.Event;
+import org.smartregister.domain.Observation;
 import org.smartregister.growthmonitoring.GrowthMonitoringLibrary;
 import org.smartregister.growthmonitoring.domain.Height;
 import org.smartregister.growthmonitoring.domain.Weight;
-import org.smartregister.repository.EventClientRepository;
 
 import java.util.Date;
 
@@ -17,9 +20,15 @@
  * Created by keyman on 26/07/2017.
  */
 public class JsonFormUtils extends org.smartregister.util.JsonFormUtils {
+
     public static void createWeightEvent(Weight weight, String eventType, String entityType, JSONArray fields) {
+
+        Context context = GrowthMonitoringLibrary.getInstance().context();
+        createWeightEvent(weight, eventType, entityType, fields, context);
+    }
+
+    public static void createWeightEvent(Weight weight, String eventType, String entityType, JSONArray fields, Context context) {
         try {
-            EventClientRepository db = GrowthMonitoringLibrary.getInstance().eventClientRepository();
 
             Event event =
                     (Event) new Event().withBaseEntityId(weight.getBaseEntityId()).withIdentifiers(weight.getIdentifiers())
@@ -31,8 +40,16 @@ public static void createWeightEvent(Weight weight, String eventType, String ent
             event.setTeam(weight.getTeam());
             event.setTeamId(weight.getTeamId());
             event.setChildLocationId(weight.getChildLocationId());
+            event.addDetails(AllConstants.DATA_STRATEGY, context.allSharedPreferences().fetchCurrentDataStrategy());
+
+            try {
+                addFormSubmissionFieldObservation(AllConstants.DATA_STRATEGY, context.allSharedPreferences().fetchCurrentDataStrategy(), Observation.TYPE.TEXT, event);
+            } catch (JSONException jsonException) {
+                Timber.e(jsonException);
+            }
 
             event.setClientApplicationVersion(GrowthMonitoringLibrary.getInstance().getApplicationVersion());
+            event.setClientApplicationVersionName(GrowthMonitoringLibrary.getInstance().getApplicationVersionName());
             event.setClientDatabaseVersion(GrowthMonitoringLibrary.getInstance().getDatabaseVersion());
 
             if (fields != null && fields.length() != 0) for (int i = 0; i < fields.length(); i++) {
@@ -43,18 +60,17 @@ public static void createWeightEvent(Weight weight, String eventType, String ent
                 }
             }
 
-
             if (event != null) {
                 JSONObject eventJson = new JSONObject(org.smartregister.util.JsonFormUtils.gson.toJson(event));
 
                 //check if an event already exists and update instead
                 if (weight.getEventId() != null) {
-                    JSONObject existingEvent = db.getEventsByEventId(weight.getEventId());
+                    JSONObject existingEvent = context.getEventClientRepository().getEventsByEventId(weight.getEventId());
                     eventJson = merge(existingEvent, eventJson);
                 }
 
                 //merge if event exists
-                db.addEvent(event.getBaseEntityId(), eventJson);
+                context.getEventClientRepository().addEvent(event.getBaseEntityId(), eventJson);
 
             }
         } catch (Exception e) {
@@ -63,8 +79,13 @@ public static void createWeightEvent(Weight weight, String eventType, String ent
     }
 
     public static void createHeightEvent(Height height, String eventType, String entityType, JSONArray fields) {
+
+        Context context = GrowthMonitoringLibrary.getInstance().context();
+        createHeightEvent(height, eventType, entityType, fields, context);
+    }
+
+    public static void createHeightEvent(Height height, String eventType, String entityType, JSONArray fields, Context context) {
         try {
-            EventClientRepository db = GrowthMonitoringLibrary.getInstance().eventClientRepository();
 
             Event event =
                     (Event) new Event().withBaseEntityId(height.getBaseEntityId()).withIdentifiers(height.getIdentifiers())
@@ -76,8 +97,16 @@ public static void createHeightEvent(Height height, String eventType, String ent
             event.setTeam(height.getTeam());
             event.setTeamId(height.getTeamId());
             event.setChildLocationId(height.getChildLocationId());
+            event.addDetails(AllConstants.DATA_STRATEGY, context.allSharedPreferences().fetchCurrentDataStrategy());
+
+            try {
+                addFormSubmissionFieldObservation(AllConstants.DATA_STRATEGY, context.allSharedPreferences().fetchCurrentDataStrategy(), Observation.TYPE.TEXT, event);
+            } catch (JSONException jsonException) {
+                Timber.e(jsonException);
+            }
 
             event.setClientApplicationVersion(GrowthMonitoringLibrary.getInstance().getApplicationVersion());
+            event.setClientApplicationVersionName(GrowthMonitoringLibrary.getInstance().getApplicationVersionName());
             event.setClientDatabaseVersion(GrowthMonitoringLibrary.getInstance().getDatabaseVersion());
 
             if (fields != null && fields.length() != 0) for (int i = 0; i < fields.length(); i++) {
@@ -88,17 +117,16 @@ public static void createHeightEvent(Height height, String eventType, String ent
                 }
             }
 
-
             if (event != null) {
                 JSONObject eventJson = new JSONObject(org.smartregister.util.JsonFormUtils.gson.toJson(event));
                 //check if an event already exists and update instead
                 if (height.getEventId() != null) {
-                    JSONObject existingEvent = db.getEventsByEventId(height.getEventId());
+                    JSONObject existingEvent = context.getEventClientRepository().getEventsByEventId(height.getEventId());
                     eventJson = merge(existingEvent, eventJson);
                 }
 
                 //merge if event exists
-                db.addEvent(event.getBaseEntityId(), eventJson);
+                context.getEventClientRepository().addEvent(event.getBaseEntityId(), eventJson);
 
             }
         } catch (Exception e) {

diff --git a/opensrp-growth-monitoring/src/test/java/org/smartregister/growthmonitoring/BaseUnitTest.java b/opensrp-growth-monitoring/src/test/java/org/smartregister/growthmonitoring/BaseUnitTest.java
@@ -67,6 +67,7 @@ protected List<Height> getHeights() {
         height.setAnmId("demo");
         height.setBaseEntityId(TEST_BASE_ENTITY_ID);
         height.setChildLocationId(TEST_STRING);
+        height.setLocationId(TEST_STRING);
         height.setCm(30.4f);
         heightArrayList.add(height);
 
@@ -118,6 +119,7 @@ protected List<Weight> getWeights() {
         weight.setAnmId("demo");
         weight.setBaseEntityId(TEST_BASE_ENTITY_ID);
         weight.setChildLocationId(TEST_STRING);
+        weight.setLocationId(TEST_STRING);
         weight.setKg(3.4f);
 
         weightArrayList.add(weight);

diff --git a/...itoring/src/test/java/org/smartregister/growthmonitoring/GrowthMonitoringLibraryTest.java b/...itoring/src/test/java/org/smartregister/growthmonitoring/GrowthMonitoringLibraryTest.java
@@ -1,8 +1,11 @@
 package org.smartregister.growthmonitoring;
 
+import static org.junit.Assert.assertEquals;
+
 import android.os.Build;
 
 import org.junit.After;
+import org.junit.Assert;
 import org.junit.Before;
 import org.junit.Rule;
 import org.junit.Test;
@@ -16,8 +19,6 @@
 import org.smartregister.Context;
 import org.smartregister.repository.Repository;
 
-import static org.junit.Assert.assertEquals;
-
 @RunWith(RobolectricTestRunner.class)
 @Config(sdk = {Build.VERSION_CODES.P})
 public class GrowthMonitoringLibraryTest {
@@ -31,12 +32,21 @@ public void setUp() throws Exception {
     }
 
     @After
-    public void tearDown() throws Exception {
+    public void tearDown() {
         ReflectionHelpers.setStaticField(GrowthMonitoringLibrary.class, "instance", null);
     }
 
     @Test
     public void getGrowthMonitoringSyncTimeShouldReturnDefault15hoursInMinutes() {
         assertEquals(60 * 15, GrowthMonitoringLibrary.getInstance().getGrowthMonitoringSyncTime());
     }
+
+    @Test
+    public void testGrowthMonitoringLibraryClassInitsCorrectly() {
+        GrowthMonitoringLibrary.destroy();
+        GrowthMonitoringLibrary.init(Mockito.mock(Context.class), Mockito.mock(Repository.class), 1, "1.0.0", 1);
+        Assert.assertEquals(1, GrowthMonitoringLibrary.getInstance().getApplicationVersion());
+        Assert.assertEquals("1.0.0", GrowthMonitoringLibrary.getInstance().getApplicationVersionName());
+        Assert.assertEquals(1, GrowthMonitoringLibrary.getInstance().getDatabaseVersion());
+    }
 }