Added comment for new test case in TimTransmogrifierTest

CDOT-CV · Nov 5, 2024 · e57ccb3 · e57ccb3
1 parent 031d16c
commit e57ccb3
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/jpo-ode-svcs/src/test/java/us/dot/its/jpo/ode/traveler/TimTransmogrifierTest.java b/jpo-ode-svcs/src/test/java/us/dot/its/jpo/ode/traveler/TimTransmogrifierTest.java
@@ -282,6 +282,13 @@ public void testConvertToXMLMessageFrame(@Capturing DateTimeUtils capturingDateT
         assertEquals(expected,actualXML);
     }
 
+    /**
+     * It should be noted that the 'prepare' section of this test largely follows the
+     * logic in the TimDepositController.depositTim() method. This is because the
+     * TimTransmogrifier.convertToXml() method is called by the TimDepositController
+     * and the TimDepositController is responsible for preparing the data that is
+     * passed to the TimTransmogrifier.convertToXml() method.
+     */
     @Test
     public void testConvertToXML_VerifyPositionElementNotInCircleElementAfterConversion() throws IOException, JsonUtilsException, XmlUtilsException, ParseException {
         // prepare