From 8f45be99dcb8088769f88358b65e22ffbc757fd7 Mon Sep 17 00:00:00 2001
From: Nathan <95725385+treefern@users.noreply.github.com>
Date: Tue, 24 Dec 2024 01:35:28 +0000
Subject: [PATCH] NPI-3669 add notes on important unit tests which remain to be
 added to test_sp3.py

---
 tests/test_sp3.py | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/tests/test_sp3.py b/tests/test_sp3.py
index 8f16230..1906cb4 100644
--- a/tests/test_sp3.py
+++ b/tests/test_sp3.py
@@ -136,6 +136,10 @@ def test_read_sp3_header_svs_detailed(self):
             end_line2_acc, 18, msg="Last ACC on test line 2 (pos 30) should be 18"
         )
 
+    # TODO Add test(s) for correctly reading header fundamentals (ACC, ORB_TYPE, etc.)
+    # TODO add tests for correctly reading the actual content of the SP3 in addition to the header.
+    # TODO add tests for correctly generating sp3 output content with gen_sp3_content() and gen_sp3_header()
+
     def test_sp3_clock_nodata_to_nan(self):
         sp3_df = pd.DataFrame(
             {("EST", "CLK"): [999999.999999, 123456.789, 999999.999999, 987654.321]}
@@ -176,6 +180,7 @@ def test_velinterpolation(self, mock_file):
         """
         Checking if the velocity interpolation works, right now there is no data to validate, the only thing done
         is to check if the function runs without errors
+        TODO: update that to check actual expected values
         """
         result = sp3.read_sp3("mock_path", pOnly=True)
         r = sp3.getVelSpline(result)
@@ -300,6 +305,11 @@ def test_trim_df(self, mock_file):
             "Should be two epochs after trimming with keep_first_delta_amount parameter",
         )
 
+    # Don't bother trying to unit test transform_df(). It is a wrapper which basically does:
+    # - read (parse)
+    # - apply function
+    # - write (generate content)
+    # TODO notes added above to implement those bits separately
 
 class TestMergeSP3(TestCase):
     def setUp(self):