Migrate old string utils unit tests

Author: thk123

CMakeLists.txt

@@ -75,7 +75,6 @@ set_target_properties(
     mmcc
     pointer-analysis
     solvers
-    string_utils
     test-bigint
     testing-utils
     unit

unit/.gitignore

@@ -1,5 +1,4 @@
 # Unit test binaries
 miniBDD
 sharing_node
-string_utils
 unit_tests

unit/CMakeLists.txt

@@ -5,7 +5,6 @@ file(GLOB_RECURSE testing_utils "testing-utils/*.cpp" "testing-utils/*.h")
 list(REMOVE_ITEM sources
     # Used in executables
     ${CMAKE_CURRENT_SOURCE_DIR}/miniBDD.cpp
-    ${CMAKE_CURRENT_SOURCE_DIR}/string_utils.cpp
 
     # Don't build
     ${CMAKE_CURRENT_SOURCE_DIR}/sharing_map.cpp
@@ -63,14 +62,3 @@ target_include_directories(miniBDD
 target_link_libraries(miniBDD solvers ansi-c)
 add_test(NAME miniBDD COMMAND $<TARGET_FILE:miniBDD>)
 set_tests_properties(miniBDD PROPERTIES LABELS "CORE;CBMC")
-
-add_executable(string_utils string_utils.cpp)
-target_include_directories(string_utils
-    PUBLIC
-    ${CBMC_BINARY_DIR}
-    ${CBMC_SOURCE_DIR}
-    ${CMAKE_CURRENT_SOURCE_DIR}
-)
-target_link_libraries(string_utils solvers ansi-c)
-add_test(NAME string_utils COMMAND $<TARGET_FILE:string_utils>)
-set_tests_properties(string_utils PROPERTIES LABELS "CORE;CBMC")

unit/Makefile

@@ -47,6 +47,8 @@ SRC += unit_tests.cpp \
        util/optional.cpp \
        util/parameter_indices.cpp \
        util/simplify_expr.cpp \
+       util/string_utils/split_string.cpp \
+       util/string_utils/strip_string.cpp \
        util/symbol_table.cpp \
        catch_example.cpp \
        java_bytecode/java_virtual_functions/virtual_functions.cpp \
@@ -85,7 +87,6 @@ OBJ += $(CPROVER_LIBS) testing-utils/testing-utils$(LIBEXT)
 
 TESTS = unit_tests$(EXEEXT) \
         miniBDD$(EXEEXT) \
-        string_utils$(EXEEXT) \
         # Empty last line
 
 CLEANFILES = $(TESTS)
@@ -104,6 +105,3 @@ unit_tests$(EXEEXT): $(OBJ)
 
 miniBDD$(EXEEXT): miniBDD$(OBJEXT) $(CPROVER_LIBS)
 	$(LINKBIN)
-
-string_utils$(EXEEXT): string_utils$(OBJEXT) $(CPROVER_LIBS)
-	$(LINKBIN)

unit/string_utils.cpp

@@ -0,0 +1,92 @@
+/*
+  Author: Diffblue Ltd.
+*/
+
+/// \file
+/// split_string Unit Tests
+
+#include <testing-utils/catch.hpp>
+#include <util/string_utils.h>
+
+SCENARIO("split_string", "[core][utils][string_utils][split_string]")
+{
+  GIVEN("A non whitespace delimited string with two elements")
+  {
+    const char delimiter = ',';
+    const std::string string = " a,, x , ,";
+
+    WHEN("Not stripping, not removing empty")
+    {
+      std::vector<std::string> result;
+      split_string(string, delimiter, result, false, false);
+
+      THEN("All the elements should remain")
+      {
+        std::vector<std::string> expected_result = {" a", "", " x ", " ", ""};
+        REQUIRE_THAT(
+          result,
+          Catch::Matchers::Vector::EqualsMatcher<std::string>{expected_result});
+      }
+    }
+    WHEN("Stripping, not removing empty")
+    {
+      std::vector<std::string> result;
+      split_string(string, delimiter, result, true, false);
+
+      THEN("All whitespace borders should be removed but all elements remain")
+      {
+        std::vector<std::string> expected_result = {"a", "", "x", "", ""};
+        REQUIRE_THAT(
+          result,
+          Catch::Matchers::Vector::EqualsMatcher<std::string>{expected_result});
+      }
+    }
+    WHEN("Not stripping, removing empty")
+    {
+      std::vector<std::string> result;
+      split_string(string, delimiter, result, false, true);
+
+      THEN("All empty elements should be removed")
+      {
+        std::vector<std::string> expected_result = {" a", " x ", " "};
+        REQUIRE_THAT(
+          result,
+          Catch::Matchers::Vector::EqualsMatcher<std::string>{expected_result});
+      }
+    }
+    WHEN("Stripping and removing empty")
+    {
+      std::vector<std::string> result;
+      split_string(string, delimiter, result, true, true);
+
+      THEN("Should get the two parts in the vector")
+      {
+        std::vector<std::string> expected_result = {"a", "x"};
+        REQUIRE_THAT(
+          result,
+          Catch::Matchers::Vector::EqualsMatcher<std::string>{expected_result});
+      }
+    }
+  }
+}
+
+SCENARIO("split_string into two", "[core][utils][string_utils][split_string]")
+{
+  GIVEN("A string with one separator")
+  {
+    const char separator = ':';
+    std::string string = "a:b";
+
+    WHEN("Splitting into two strings")
+    {
+      std::string s1;
+      std::string s2;
+      split_string(string, separator, s1, s2, false);
+      THEN("The string should be split")
+      {
+        REQUIRE(s1 == "a");
+        REQUIRE(s2 == "b");
+      }
+    }
+  }
+}

unit/util/string_utils/split_string.cpp

@@ -0,0 +1,27 @@
+/*
+  Author: Diffblue Ltd.
+*/
+
+/// \file
+/// strip_string Unit Tests
+
+#include <testing-utils/catch.hpp>
+#include <util/string_utils.h>
+
+SCENARIO("strip_string", "[core][utils][string_utils][strip_string]")
+{
+  GIVEN("A string with some whitespace in it")
+  {
+    std::string string = "   x y ";
+    WHEN("Using strip_string")
+    {
+      std::string result = strip_string(string);
+      THEN(
+        "Whitespace at either end should be removed, but not internal "
+        "whitespace")
+      {
+        REQUIRE(result == "x y");
+      }
+    }
+  }
+}