File: split_string.cpp

package info (click to toggle)
cbmc 6.6.0-4
  • links: PTS
  • area: main
  • in suites: forky, sid, trixie
  • size: 153,852 kB
  • sloc: cpp: 386,459; ansic: 114,466; java: 28,405; python: 6,003; yacc: 4,552; makefile: 4,041; lex: 2,487; xml: 2,388; sh: 2,050; perl: 557; pascal: 184; javascript: 163; ada: 36
file content (206 lines) | stat: -rw-r--r-- 5,872 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
/*******************************************************************\

Module: Unit tests of split_string

Author: Diffblue Ltd.

\*******************************************************************/

/// \file
/// split_string Unit Tests

#include <testing-utils/use_catch.h>
#include <util/string_utils.h>

struct expected_resultst
{
  std::vector<std::string> no_strip_no_remove;
  std::vector<std::string> strip_no_remove;
  std::vector<std::string> no_strip_remove_empty;
  std::vector<std::string> strip_remove_empty;
};

/// For a given string and delimiter, use the split_string function with all
/// the possible combinations of stripping whitespace and removing empty
/// elements.
/// \param string: The string to split
/// \param delimiter: The delimter to split on
/// \param expected_results: The results expected for each of the versions of
///   the method
void run_on_all_variants(
  std::string string,
  char delimiter,
  const expected_resultst &expected_results)
{
  WHEN("Not stripping, not removing empty")
  {
    std::vector<std::string> result =
      split_string(string, delimiter, false, false);

    THEN("Should get expected vector")
    {
      REQUIRE_THAT(
        result,
        // NOLINTNEXTLINE(whitespace/braces)
        Catch::Matchers::Equals(
          std::vector<std::string>(expected_results.no_strip_no_remove)));
    }
  }
  WHEN("Not stripping, removing empty")
  {
    std::vector<std::string> result =
      split_string(string, delimiter, false, true);

    THEN("Should get expected vector")
    {
      REQUIRE_THAT(
        result,
        // NOLINTNEXTLINE(whitespace/braces)
        Catch::Matchers::Equals(
          std::vector<std::string>(expected_results.no_strip_remove_empty)));
    }
  }
  WHEN("Stripping, not removing empty")
  {
    std::vector<std::string> result =
      split_string(string, delimiter, true, false);

    THEN("Should get expected vector")
    {
      REQUIRE_THAT(
        result,
        // NOLINTNEXTLINE(whitespace/braces)
        Catch::Matchers::Equals(
          std::vector<std::string>(expected_results.strip_no_remove)));
    }
  }
  WHEN("Stripping and removing empty")
  {
    std::vector<std::string> result =
    split_string(string, delimiter, true, true);

    THEN("Should get expected vector")
    {
      REQUIRE_THAT(
        result,
        // NOLINTNEXTLINE(whitespace/braces)
        Catch::Matchers::Equals(
          std::vector<std::string>(expected_results.strip_remove_empty)));
    }
  }
}

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 , ,";

    expected_resultst expected_results;
    expected_results.no_strip_no_remove = {" a", "", " x ", " ", ""};
    expected_results.strip_no_remove = {"a", "", "x", "", ""};
    expected_results.no_strip_remove_empty = {" a", " x ", " "};
    expected_results.strip_remove_empty = {"a", "x"};

    run_on_all_variants(string, delimiter, expected_results);
  }
  GIVEN("An empty string")
  {
    std::string string;
    WHEN("Splitting it")
    {
      expected_resultst expected_results;
      expected_results.no_strip_no_remove = {""};
      expected_results.strip_no_remove = {""};
      expected_results.no_strip_remove_empty = {};
      expected_results.strip_remove_empty = {};

      run_on_all_variants(string, ',', expected_results);
    }
  }
  GIVEN("A whitespace only string")
  {
    std::string string = "    ";
    WHEN("Splitting it")
    {
      expected_resultst expected_results;
      expected_results.no_strip_no_remove = {"    "};
      expected_results.strip_no_remove = {""};
      expected_results.no_strip_remove_empty = {"    "};
      expected_results.strip_remove_empty = {};

      run_on_all_variants(string, ',', expected_results);
    }
  }
  GIVEN("A whitespace delimter")
  {
    std::string string = "a\nb\nc";
    const char delimiter = '\n';

    WHEN("Not stripping, not removing empty")
    {
      std::vector<std::string> result =
        split_string(string, delimiter, false, false);

      THEN("Should get expected vector")
      {
        std::vector<std::string> expected_result = {"a", "b", "c"};
        REQUIRE_THAT(result, Catch::Matchers::Equals(expected_result));
      }
    }
    WHEN("Not stripping, removing empty")
    {
      std::vector<std::string> result =
        split_string(string, delimiter, false, true);

      THEN("Should get expected vector")
      {
        std::vector<std::string> expected_result = {"a", "b", "c"};
        REQUIRE_THAT(result, Catch::Matchers::Equals(expected_result));
      }
    }
    // TODO(tkiley): here we should check what happens when trying to enable
    // TODO(tkiley): strip, but currently the behaviour terminates the unit test
  }
}

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");
      }
    }
  }
  GIVEN("A string and a whitespace delimiter")
  {
    std::string string = "a\nb";
    const char delimiter = '\n';

    WHEN("Splitting in two and not stripping")
    {
      std::string s1;
      std::string s2;
      split_string(string, delimiter, s1, s2, false);
      THEN("The string should be split")
      {
        REQUIRE(s1 == "a");
        REQUIRE(s2 == "b");
      }
    }
    // TODO(tkiley): here we should check what happens when trying to enable
    // TODO(tkiley): strip, but currently the behaviour terminates the unit test
  }
}