Skip to content

Commit

Permalink
TEST: Add unit test to check for proper parameter key values.
Browse files Browse the repository at this point in the history 
Checks for _path, _name, 's' for parameter types

Signed-off-by: Michael Jackson <[email protected]>
  • Loading branch information
@imikejackson
imikejackson committed Apr 17, 2024
1 parent 8c107e6 commit 173e272
Show file tree
Hide file tree
Showing 2 changed files with 100 additions and 11 deletions.
18 changes: 8 additions & 10 deletions src/Plugins/TestOne/src/TestOne/Filters/ExampleFilter2.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,18 +21,16 @@ constexpr StringLiteral k_Param1 = "param1";
constexpr StringLiteral k_Param2 = "param2";
constexpr StringLiteral k_Param3 = "param3";
constexpr StringLiteral k_Param4 = "param4";
constexpr StringLiteral k_Param5 = "param5";
constexpr StringLiteral k_Param6 = "param6";
constexpr StringLiteral k_Param5 = "param5_path";
constexpr StringLiteral k_Param6 = "param6_path";
constexpr StringLiteral k_Param7 = "param7";
constexpr StringLiteral k_Param8 = "param8";
constexpr StringLiteral k_Param9 = "param9";
constexpr StringLiteral k_Param10 = "param10";
constexpr StringLiteral k_Param11 = "param11";
constexpr StringLiteral k_Param12 = "param12";
constexpr StringLiteral k_Param8 = "param8_path";
constexpr StringLiteral k_Param9 = "param9_path";
constexpr StringLiteral k_Param10 = "param10_path";
constexpr StringLiteral k_Param11 = "param11_path";
constexpr StringLiteral k_Param12 = "param12s";
constexpr StringLiteral k_Param13 = "param13";
constexpr StringLiteral k_Param14 = "param14";
constexpr StringLiteral k_Param15 = "param15";
constexpr StringLiteral k_Param16 = "param16";

} // namespace

namespace nx::core
Expand Down
93 changes: 92 additions & 1 deletion test/PluginTest.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
#include "simplnx/DataStructure/DataStructure.hpp"
#include "simplnx/Filter/FilterHandle.hpp"
#include "simplnx/Filter/IFilter.hpp"
#include "simplnx/Utilities/StringUtilities.hpp"
#include "simplnx/unit_test/simplnx_test_dirs.hpp"

#include <catch2/catch.hpp>
Expand All @@ -21,8 +22,78 @@ constexpr Uuid k_TestTwoPluginId = *Uuid::FromString("05cc618b-781f-4ac0-b9ac-43
constexpr Uuid k_Test2FilterId = *Uuid::FromString("ad9cf22b-bc5e-41d6-b02e-bb49ffd12c04");
const FilterHandle k_Test2FilterHandle(k_Test2FilterId, k_TestTwoPluginId);

std::map<nx::core::Uuid, std::string> s_ParameterMap;

} // namespace

#define ADD_PARAMETER_TRAIT(thing1, thing2) \
{ \
auto uuidResult = nx::core::Uuid::FromString(thing2); \
if(uuidResult.has_value()) \
{ \
::s_ParameterMap[uuidResult.value()] = #thing1; \
} \
}

void GenerateParameterList()
{
::s_ParameterMap.clear();
ADD_PARAMETER_TRAIT(simplnx.OEMEbsdScanSelectionParameter, "3935c833-aa51-4a58-81e9-3a51972c05ea")
ADD_PARAMETER_TRAIT(simplnx.ReadH5EbsdFileParameter, "FAC15aa6-b367-508e-bf73-94ab6be0058b")
ADD_PARAMETER_TRAIT(simplnx.NumericTypeParameter, "a8ff9dbd-45e7-4ed6-8537-12dd53069bce")
ADD_PARAMETER_TRAIT(simplnx.StringParameter, "5d6d1868-05f8-11ec-9a03-0242ac130003")
ADD_PARAMETER_TRAIT(simplnx.DataStoreFormatParameter, "cfd5c150-2938-42a7-b023-4a9288fb6899")
ADD_PARAMETER_TRAIT(simplnx.MultiPathSelectionParameter, "b5632f4f-fc13-4234-beb2-8fd8820eb6b6")
ADD_PARAMETER_TRAIT(simplnx.DataTypeParameter, "d31358d5-3253-4c69-aff0-eb98618f851b")
ADD_PARAMETER_TRAIT(simplnx.EnsembleInfoParameter, "10d3924f-b4c9-4e06-9225-ce11ec8dff89")
ADD_PARAMETER_TRAIT(simplnx.ArrayThresholdsParameter, "e93251bc-cdad-44c2-9332-58fe26aedfbe")
ADD_PARAMETER_TRAIT(simplnx.GenerateColorTableParameter, "7b0e5b25-564e-4797-b154-4324ef276bf0")
ADD_PARAMETER_TRAIT(simplnx.DataObjectNameParameter, "fbc89375-3ca4-4eb2-8257-aad9bf8e1c94")
ADD_PARAMETER_TRAIT(simplnx.NeighborListSelectionParameter, "ab0b7a7f-f9ab-4e6f-99b5-610e7b69fc5b")
ADD_PARAMETER_TRAIT(simplnx.ChoicesParameter, "ee4d5ce2-9582-48fa-b182-8a766ce0feff")
ADD_PARAMETER_TRAIT(simplnx.GeneratedFileListParameter, "aac15aa6-b367-508e-bf73-94ab6be0058b")
ADD_PARAMETER_TRAIT(simplnx.DataPathSelectionParameter, "cd12d081-fbf0-46c4-8f4a-15e2e06e98b8")
ADD_PARAMETER_TRAIT(simplnx.CalculatorParameter, "ba2d4937-dbec-5536-8c5c-c0a406e80f77")
ADD_PARAMETER_TRAIT(simplnx.ReadCSVFileParameter, "4f6d6a33-48da-427a-8b17-61e07d1d5b45")

ADD_PARAMETER_TRAIT(simplnx.MultiArraySelectionParameter, "d11e0bd8-f227-4fd1-b618-b6f16b259fc8")
ADD_PARAMETER_TRAIT(simplnx.ArraySelectionParameter, "ab047a7f-f9ab-4e6f-99b5-610e7b69fc5b")
ADD_PARAMETER_TRAIT(simplnx.DataGroupSelectionParameter, "bff3d4ac-04a6-5251-b178-4f83f7865074")
ADD_PARAMETER_TRAIT(simplnx.AttributeMatrixSelectionParameter, "a3619d74-a1d9-4bc2-9e03-ca001d65b119")
ADD_PARAMETER_TRAIT(simplnx.GeometrySelectionParameter, "3804cd7f-4ee4-400f-80ad-c5af17735de2")

ADD_PARAMETER_TRAIT(simplnx.DataGroupCreationParameter, "bff2d4ac-04a6-5251-b188-4f83f7865074")
ADD_PARAMETER_TRAIT(simplnx.ArrayCreationParameter, "ab047a7d-f81b-4e6f-99b5-610e7b69fc5b")

ADD_PARAMETER_TRAIT(simplnx.FileSystemPathParameter, "f9a93f3d-21ef-43a1-a958-e57cbf3b2909")
ADD_PARAMETER_TRAIT(simplnx.BoolParameter, "b6936d18-7476-4855-9e13-e795d717c50f")
ADD_PARAMETER_TRAIT(simplnx.ReadHDF5DatasetParameter, "32e83e13-ee4c-494e-8bab-4e699df74a5a")
ADD_PARAMETER_TRAIT(simplnx.Dream3dImportParameter, "170a257d-5952-4854-9a91-4281cd06f4f5")
ADD_PARAMETER_TRAIT(simplnx.DynamicTableParameter, "eea76f1a-fab9-4704-8da5-4c21057cf44e")

ADD_PARAMETER_TRAIT(simplnx.Int8Parameter, "cae73834-68f8-4235-b010-8bea87d8ff7a")
ADD_PARAMETER_TRAIT(simplnx.UInt8Parameter, "6c3efeff-ce8f-47c0-83d1-262f2b2dd6cc")
ADD_PARAMETER_TRAIT(simplnx.Int16Parameter, "44ae56e8-e6e7-4e4d-8128-dd3dc2c6696e")
ADD_PARAMETER_TRAIT(simplnx.UInt16Parameter, "156a6f46-77e5-41d8-8f5a-65ba1da52f2a")
ADD_PARAMETER_TRAIT(simplnx.Int32Parameter, "21acff45-a653-45db-a0d1-f43cd344b93a")
ADD_PARAMETER_TRAIT(simplnx.UInt32Parameter, "e9521130-276c-40c7-95d7-0b4cb4f80649")
ADD_PARAMETER_TRAIT(simplnx.Int64Parameter, "b2039349-bd3a-4dbb-93d2-b4b5c633e697")
ADD_PARAMETER_TRAIT(simplnx.UInt64Parameter, "36d91b23-5500-4ed4-bdf3-d680f54ee5d1")
ADD_PARAMETER_TRAIT(simplnx.Float32Parameter, "e4452dfe-2f70-4833-819e-0cbbec21289b")
ADD_PARAMETER_TRAIT(simplnx.Float64Parameter, "f2a18fff-a095-47d7-b436-ede41b5ea21a")

ADD_PARAMETER_TRAIT(simplnx.VectorInt8Parameter, "9f5f9683-e492-4a79-8378-79d727b2356a")
ADD_PARAMETER_TRAIT(simplnx.VectorUInt8Parameter, "bff78ff3-35ef-482a-b3b1-df8806e7f7ef")
ADD_PARAMETER_TRAIT(simplnx.VectorInt16Parameter, "43810a29-1a5f-4472-bec6-41de9ffe27f7")
ADD_PARAMETER_TRAIT(simplnx.VectorUInt16Parameter, "2f1ba2f4-c5d5-403c-8b90-0bf60d2bde9b")
ADD_PARAMETER_TRAIT(simplnx.VectorInt32Parameter, "d3188e18-e383-4727-ab32-88b5fda56ae8")
ADD_PARAMETER_TRAIT(simplnx.VectorUInt32Parameter, "37322aa6-1a2f-4ecb-9aa1-8922d7ac1e49")
ADD_PARAMETER_TRAIT(simplnx.VectorInt64Parameter, "4ceaffc1-7326-4f65-a33a-eae263dc22d1")
ADD_PARAMETER_TRAIT(simplnx.VectorUInt64Parameter, "17309744-c4e8-4d1e-807e-e7012387f1ec")
ADD_PARAMETER_TRAIT(simplnx.VectorFloat32Parameter, "88f231a1-7956-41f5-98b7-4471705d2805")
ADD_PARAMETER_TRAIT(simplnx.VectorFloat64Parameter, "57cbdfdf-9d1a-4de8-95d7-71d0c01c5c96")
}

TEST_CASE("Test Loading Plugins")
{
auto app = Application::GetOrCreateInstance();
Expand Down Expand Up @@ -106,8 +177,9 @@ TEST_CASE("Test Singleton")
REQUIRE(Application::Instance() == nullptr);
}

TEST_CASE("Test Filter Help Text")
TEST_CASE("Test Filter Parameter Keys")
{
GenerateParameterList();
auto appPtr = Application::GetOrCreateInstance();
appPtr->loadPlugins(unit_test::k_BuildDir.view());
REQUIRE(appPtr != nullptr);
Expand Down Expand Up @@ -149,6 +221,25 @@ TEST_CASE("Test Filter Help Text")
break;
}
}

std::string pType = s_ParameterMap[paramValue->uuid()];
if(!nx::core::StringUtilities::ends_with(parameter.first, "_path") &&
(pType == "simplnx.ArraySelectionParameter" || pType == "simplnx.ArrayCreationParameter" || pType == "simplnx.AttributeMatrixSelectionParameter" ||
pType == "simplnx.DataGroupCreationParameter" || pType == "simplnx.DataGroupSelectionParameter" || pType == "simplnx.DataPathSelectionParameter" ||
pType == "simplnx.GeometrySelectionParameter" || pType == "simplnx.NeighborListSelectionParameter" || pType == "simplnx.DataGroupCreationParameter"))
{
output << plugName << "->" << filter->name() << "->" << paramValue->name() << " The parameter key should end with '_path' for a Parameter of Type " << pType << std::endl;
}

if(pType == "simplnx.MultiArraySelectionParameter" && !nx::core::StringUtilities::ends_with(parameter.first, "s"))
{
output << plugName << "->" << filter->name() << "->" << paramValue->name() << " The parameter key should end with 's' for a Parameter of Type " << pType << std::endl;
}

if(pType == "simplnx.DataObjectNameParameter" && !nx::core::StringUtilities::ends_with(parameter.first, "_name"))
{
output << plugName << "->" << filter->name() << "->" << paramValue->name() << " The parameter key should end with '_name' for a Parameter of Type " << pType << std::endl;
}
}
}
}
Expand Down

0 comments on commit 173e272

Please sign in to comment.