improve TRE unitesting (#599)

* merge develop/preload-TREs * fix build errors * #including some TREs * "export" TRE routines as "static" * struct for pre-loaded TREs rather than "void*" * start working on resolving preloaded TREs * retrievePreloadedTREHandler() to match nitf_PluginRegistry_retrieveTREHandler() * preload a TRE * preload several TREs * fix duplicate defs * fix compiler warning * use macros to remove multiple-defined symbols * keep a few TREs as plugins for testing * preloaded TRE stuff needs to be in PluginHandler so that nitf_PluginRegistry_retrieveTREHandler() "just works" * remove another multiple-defined symbols * assume plug-in that fails is "preloaded" * remove VCXPROJ for TREs that are preloaded * don't preload ANY TREs to preserve existing behavior * be sure all nrt_DLL fields are initialized * revert whitespace changes * added a preloaded TEST_PRELOADED_DES TRE * the TRE id could have underscores in it, so search from the end. * preload TREs, but disable them * allow preloaded TREs to be enabled/disabled * allow all TREs to be enabled (or disabled) * don't need to call setNitfPluginPath() as much with preloaded TREs * always build TEST_DES as a DLL * strongly-typed TEST_DES TRE * strongly-typed TEST_DES TRE * set things up so a different set of preloaded handlers could be used * call nitf_PluginRegistry_PreloadedTREHandlerEnable() for TREs used in unittests * only one chance to set NITF_PLUGIN_PATH
mdaus · Nov 15, 2023 · de4686a · de4686a
1 parent a4d0a51
commit de4686a
Show file tree

Hide file tree

Showing 8 changed files with 97 additions and 53 deletions.
diff --git a/UnitTest/UnitTest.cpp b/UnitTest/UnitTest.cpp
@@ -7,8 +7,7 @@
 // https://learn.microsoft.com/en-us/visualstudio/test/microsoft-visualstudio-testtools-cppunittestframework-api-reference?view=vs-2022
 TEST_MODULE_INITIALIZE(methodName)
 {
-    nitf_PluginRegistry_PreloadedTREHandlersEnable(NRT_TRUE);
-
     // module initialization code
+    nitf_PluginRegistry_PreloadedTREHandlersEnable(NRT_TRUE);
     nitf::Test::j2kSetNitfPluginPath();
 }
diff --git a/modules/c++/nitf/unittests/test_load_plugins.cpp b/modules/c++/nitf/unittests/test_load_plugins.cpp
@@ -78,10 +78,12 @@ TEST_CASE(test_retrieveTREHandler)
 
 TEST_CASE(test_load_PTPRAA)
 {
+    TEST_ASSERT_TRUE(nitf_PluginRegistry_PreloadedTREHandlerEnable("PTPRAA", NRT_TRUE));
     retrieveTREHandler(testName, "PTPRAA");
 }
 TEST_CASE(test_load_ENGRDA)
 {
+    TEST_ASSERT_TRUE(nitf_PluginRegistry_PreloadedTREHandlerEnable("ENGRDA", NRT_TRUE));
     retrieveTREHandler(testName, "ENGRDA");
 }
 

diff --git a/modules/c++/nitf/unittests/test_tre_create++.cpp b/modules/c++/nitf/unittests/test_tre_create++.cpp
@@ -9,6 +9,7 @@ TEST_CASE(test_tre_create_329)
 {
     // https://github.com/mdaus/nitro/issues/329
 
+    TEST_ASSERT_TRUE(nitf_PluginRegistry_PreloadedTREHandlerEnable("HISTOA", NRT_TRUE));
     nitf::TRE tre("HISTOA", "HISTOA"); // allocates fields SYSTEM .. NEVENTS
     tre.setField("SYSTYPE", "M1");
     TEST_ASSERT_TRUE(true);
@@ -39,8 +40,6 @@ TEST_CASE(test_tre_clone_329)
 }
 
 TEST_MAIN(
-    nitf::Test::setNitfPluginPath();
-
     TEST_CHECK(test_tre_create_329);
     TEST_CHECK(test_tre_clone_329);
     )
diff --git a/modules/c++/nitf/unittests/test_tre_mods++.cpp b/modules/c++/nitf/unittests/test_tre_mods++.cpp
@@ -160,7 +160,7 @@ struct /*namespace*/ TREs
 
 TEST_CASE(setFields)
 {
-    // create an ACFTA TRE
+    TEST_ASSERT_TRUE( nitf_PluginRegistry_PreloadedTREHandlerEnable("ACFTA", NRT_TRUE) );
     nitf::TRE tre("ACFTA");
 
     // set a field
@@ -179,6 +179,7 @@ TEST_CASE(setFields)
 
 TEST_CASE(setBinaryFields)
 {
+    TEST_ASSERT_TRUE( nitf_PluginRegistry_PreloadedTREHandlerEnable("RPFHDR", NRT_TRUE) );
     nitf::TRE tre("RPFHDR");
     const int value = 123;
     tre.setField("LOCSEC", value);
@@ -190,6 +191,7 @@ TEST_CASE(setBinaryFields)
 
 TEST_CASE(cloneTRE)
 {
+    TEST_ASSERT_TRUE( nitf_PluginRegistry_PreloadedTREHandlerEnable("JITCID", NRT_TRUE) );
     nitf::TRE tre("JITCID");
     tre.setField("FILCMT", "fyi");
 
@@ -203,6 +205,7 @@ TEST_CASE(cloneTRE)
 
 TEST_CASE(basicIteration)
 {
+    TEST_ASSERT_TRUE( nitf_PluginRegistry_PreloadedTREHandlerEnable("ACCPOB", NRT_TRUE) );
     nitf::TRE tre("ACCPOB");
 
     // The entire TRE is one loop, and we haven't told it
@@ -253,7 +256,6 @@ TEST_CASE(use_TEST_DES)
     TEST_ASSERT_EQ(test_preloaded_des.INCREMENT, 67);
 
     /***********************************************************/
-    nitf::Test::setNitfPluginPath();
 
     nitf::TRE des("TEST_DES", "TEST_DES");
     test_des_(testName, des, "TEST_DES_");
@@ -269,6 +271,7 @@ TEST_CASE(use_TEST_DES)
 
 TEST_CASE(use_ENGRDA)
 {
+    TEST_ASSERT_TRUE( nitf_PluginRegistry_PreloadedTREHandlerEnable("ENGRDA", NRT_TRUE) );
     nitf::TRE engrda("ENGRDA", "ENGRDA");
 
     engrda.setField("RESRC", "HSS");
@@ -293,6 +296,7 @@ TEST_CASE(use_ENGRDA)
 
 TEST_CASE(use_ENGRDA_typed_fields)
 {
+    TEST_ASSERT_TRUE( nitf_PluginRegistry_PreloadedTREHandlerEnable("ENGRDA", NRT_TRUE) );
     nitf::TRE engrda("ENGRDA", "ENGRDA");
 
     nitf::TREField_BCS_A<20> RESRC(engrda, "RESRC");
@@ -325,6 +329,7 @@ TEST_CASE(use_ENGRDA_typed_fields)
 
 TEST_CASE(use_typed_ENGRDA)
 {
+    TEST_ASSERT_TRUE( nitf_PluginRegistry_PreloadedTREHandlerEnable("ENGRDA", NRT_TRUE) );
     TREs::ENGRDA engrda; // nitf::TRE engrda("ENGRDA", "ENGRDA");
 
     engrda.RESRC = "HSS"; // engrda.setField("RESRC", "HSS");
@@ -373,6 +378,7 @@ TEST_CASE(use_typed_ENGRDA)
 
 TEST_CASE(use_CSEXRB_typed_fields)
 {
+    TEST_ASSERT_TRUE( nitf_PluginRegistry_PreloadedTREHandlerEnable("CSEXRB", NRT_TRUE) );
     nitf::TRE tre("CSEXRB", "CSEXRB");
 
     constexpr auto length = 12;
@@ -386,6 +392,7 @@ TEST_CASE(use_CSEXRB_typed_fields)
 
 TEST_CASE(populateWhileIterating)
 {
+    TEST_ASSERT_TRUE( nitf_PluginRegistry_PreloadedTREHandlerEnable("ACCPOB", NRT_TRUE) );
     nitf::TRE tre("ACCPOB");
     size_t numFields = 0;
     for (auto it = tre.begin(); it != tre.end(); ++it)
@@ -410,6 +417,7 @@ TEST_CASE(populateWhileIterating)
 
 TEST_CASE(overflowingNumericFields)
 {
+    TEST_ASSERT_TRUE( nitf_PluginRegistry_PreloadedTREHandlerEnable("CSCRNA", NRT_TRUE) );
     nitf::TRE tre("CSCRNA");
 
     // This field has a length of 9, so check that it's properly
@@ -438,6 +446,7 @@ TEST_CASE(overflowingNumericFields)
 }
 
 TEST_MAIN(
+    // must be set before making any NITRO calls
     nitf::Test::setNitfPluginPath();
 
     TEST_CHECK(setFields);

diff --git a/modules/c++/nitf/unittests/test_tre_mods.cpp b/modules/c++/nitf/unittests/test_tre_mods.cpp
@@ -26,6 +26,8 @@
 
 TEST_CASE(testNestedMod)
 {
+    TEST_ASSERT_TRUE( nitf_PluginRegistry_PreloadedTREHandlerEnable("ACCHZB", NRT_TRUE) );
+
     nitf_Error error;
     NITF_BOOL exists;
     nitf_TRE* tre = nitf_TRE_construct("ACCHZB", NULL, &error);
@@ -59,6 +61,8 @@ TEST_CASE(testNestedMod)
 
 TEST_CASE(testIncompleteCondMod)
 {
+    TEST_ASSERT_TRUE( nitf_PluginRegistry_PreloadedTREHandlerEnable("ACCPOB", NRT_TRUE) );
+
     nitf_Error error;
     NITF_BOOL exists;
     nitf_TRE* tre = nitf_TRE_construct("ACCPOB", NULL, &error);
@@ -90,6 +94,7 @@ TEST_CASE(testClone)
     nitf_Field* clonedField = NULL;
     nitf_Error error;
 
+    TEST_ASSERT_TRUE( nitf_PluginRegistry_PreloadedTREHandlerEnable("JITCID", NRT_TRUE) );
     nitf_TRE* tre = nitf_TRE_construct("JITCID", NULL, &error);
     TEST_ASSERT(tre != NULL);
 
@@ -110,13 +115,14 @@ TEST_CASE(testClone)
 
 TEST_CASE(testBasicMod)
 {
+    TEST_ASSERT_TRUE( nitf_PluginRegistry_PreloadedTREHandlerEnable("ACFTA", NRT_TRUE) );
+
     /* construct a tre */
     NITF_BOOL exists;
     nitf_Error error;
-    nitf_Field* field;
     nitf_TRE *tre = nitf_TRE_construct("ACFTA", "ACFTA_132", &error);
     TEST_ASSERT(tre != NULL);
-    field = (nitf_TRE_getField(tre, "AC_MSN_ID"));
+    nitf_Field* field = (nitf_TRE_getField(tre, "AC_MSN_ID"));
     TEST_ASSERT_EQ_STR(field->raw, "          ");
 
     exists = nitf_TRE_setField(tre, "AC_MSN_ID", "fly-by", 6, &error);
@@ -139,6 +145,7 @@ TEST_CASE(testBasicMod)
 
 TEST_CASE(testSize)
 {
+    TEST_ASSERT_TRUE( nitf_PluginRegistry_PreloadedTREHandlerEnable("AIMIDB", NRT_TRUE) );
     nitf_Error error;
     int treLength;
     nitf_TRE* tre = nitf_TRE_construct("AIMIDB", NULL, &error);
@@ -174,18 +181,17 @@ TEST_CASE(iterateUnfilled)
 
 TEST_CASE(populateThenIterate)
 {
+    TEST_ASSERT_TRUE( nitf_PluginRegistry_PreloadedTREHandlerEnable("ACCPOB", NRT_TRUE) );
     nitf_Error error;
-    nitf_TRECursor cursor;
     nitf_TRE* tre = nitf_TRE_construct("ACCPOB", NULL, &error);
-    uint32_t numFields = 0;
-    TEST_ASSERT(tre != NULL);
+    TEST_ASSERT_NOT_NULL(tre);
 
+    uint32_t numFields = 0;
     nitf_TRE_setField(tre, "NUMACPO", "2", 1, &error);
     nitf_TRE_setField(tre, "NUMPTS[0]", "3", 1, &error);
     nitf_TRE_setField(tre, "NUMPTS[1]", "2", 1, &error);
 
-    cursor = nitf_TRECursor_begin(tre);
-
+    nitf_TRECursor cursor = nitf_TRECursor_begin(tre);
     while (!nitf_TRECursor_isDone(&cursor))
     {
         TEST_ASSERT(nitf_TRECursor_iterate(&cursor, &error) != 0);
@@ -200,13 +206,13 @@ TEST_CASE(populateThenIterate)
 
 TEST_CASE(populateWhileIterating)
 {
+    TEST_ASSERT_TRUE( nitf_PluginRegistry_PreloadedTREHandlerEnable("ACCPOB", NRT_TRUE) );
     nitf_Error error;
-    nitf_TRECursor cursor;
     nitf_TRE* tre = nitf_TRE_construct("ACCPOB", NULL, &error);
-    uint32_t numFields = 0;
-    TEST_ASSERT(tre != NULL);
+    TEST_ASSERT_NOT_NULL(tre);
 
-    cursor = nitf_TRECursor_begin(tre);
+    uint32_t numFields = 0;
+    nitf_TRECursor cursor = nitf_TRECursor_begin(tre);
     while (!nitf_TRECursor_isDone(&cursor))
     {
         TEST_ASSERT(nitf_TRECursor_iterate(&cursor, &error) != 0);
@@ -231,8 +237,6 @@ TEST_CASE(populateWhileIterating)
 }
 
 TEST_MAIN(
-    nitf::Test::setNitfPluginPath();
-
     TEST_CHECK(testClone);
     TEST_CHECK(testSize);
     TEST_CHECK(testBasicMod);

diff --git a/modules/c/nitf/include/nitf/PluginIdentifier.h b/modules/c/nitf/include/nitf/PluginIdentifier.h
@@ -72,7 +72,6 @@ typedef struct _nitf_TREPreloaded
     NITF_PLUGIN_TRE_HANDLER_FUNCTION handler;
     NITF_BOOL enabled; // most preloaded TREs are disabled by default
 } nitf_TREPreloaded;
-extern nitf_TREPreloaded preloadedTREs[];
 
 /*
   \brief NITF_PLUGIN_COMPRESSION_HANDLER_FUNCTION - Function pointer for