Branch data Line data Source code
1 : : // Copyright (c) 2012-2022 The Bitcoin Core developers
2 : : // Distributed under the MIT software license, see the accompanying
3 : : // file COPYING or http://www.opensource.org/licenses/mit-license.php.
4 : :
5 : : #include <hash.h>
6 : : #include <serialize.h>
7 : : #include <streams.h>
8 : : #include <test/util/setup_common.h>
9 : : #include <util/strencodings.h>
10 : :
11 : : #include <stdint.h>
12 : : #include <string>
13 : :
14 : : #include <boost/test/unit_test.hpp>
15 : :
16 : : BOOST_FIXTURE_TEST_SUITE(serialize_tests, BasicTestingSetup)
17 : :
18 : : // For testing move-semantics, declare a version of datastream that can be moved
19 : : // but is not copyable.
20 : 3 : class UncopyableStream : public DataStream
21 : : {
22 : : public:
23 : 1 : using DataStream::DataStream;
24 : : UncopyableStream(const UncopyableStream&) = delete;
25 : : UncopyableStream& operator=(const UncopyableStream&) = delete;
26 : 2 : UncopyableStream(UncopyableStream&&) noexcept = default;
27 : : UncopyableStream& operator=(UncopyableStream&&) noexcept = default;
28 : : };
29 : :
30 : : class CSerializeMethodsTestSingle
31 : : {
32 : : protected:
33 : : int intval;
34 : : bool boolval;
35 : : std::string stringval;
36 : : char charstrval[16];
37 : : CTransactionRef txval;
38 : : public:
39 : 1 : CSerializeMethodsTestSingle() = default;
40 [ + - ]: 2 : CSerializeMethodsTestSingle(int intvalin, bool boolvalin, std::string stringvalin, const uint8_t* charstrvalin, const CTransactionRef& txvalin) : intval(intvalin), boolval(boolvalin), stringval(std::move(stringvalin)), txval(txvalin)
41 : : {
42 : 2 : memcpy(charstrval, charstrvalin, sizeof(charstrval));
43 : 2 : }
44 : :
45 : 6 : SERIALIZE_METHODS(CSerializeMethodsTestSingle, obj)
46 : : {
47 : 3 : READWRITE(obj.intval);
48 : 3 : READWRITE(obj.boolval);
49 : 3 : READWRITE(obj.stringval);
50 : 3 : READWRITE(obj.charstrval);
51 : 3 : READWRITE(TX_WITH_WITNESS(obj.txval));
52 : 3 : }
53 : :
54 : 5 : bool operator==(const CSerializeMethodsTestSingle& rhs) const
55 : : {
56 : 5 : return intval == rhs.intval &&
57 : 5 : boolval == rhs.boolval &&
58 [ + - ]: 5 : stringval == rhs.stringval &&
59 [ + - + - : 10 : strcmp(charstrval, rhs.charstrval) == 0 &&
- + ]
60 [ - + ]: 5 : *txval == *rhs.txval;
61 : : }
62 : : };
63 : :
64 : 0 : class CSerializeMethodsTestMany : public CSerializeMethodsTestSingle
65 : : {
66 : : public:
67 : 1 : using CSerializeMethodsTestSingle::CSerializeMethodsTestSingle;
68 : :
69 : 4 : SERIALIZE_METHODS(CSerializeMethodsTestMany, obj)
70 : : {
71 : 2 : READWRITE(obj.intval, obj.boolval, obj.stringval, obj.charstrval, TX_WITH_WITNESS(obj.txval));
72 : 2 : }
73 : : };
74 : :
75 [ + - + - : 7 : BOOST_AUTO_TEST_CASE(sizes)
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- ]
76 : : {
77 [ + - ]: 1 : BOOST_CHECK_EQUAL(sizeof(unsigned char), GetSerializeSize((unsigned char)0));
78 [ + - ]: 1 : BOOST_CHECK_EQUAL(sizeof(int8_t), GetSerializeSize(int8_t(0)));
79 [ + - ]: 1 : BOOST_CHECK_EQUAL(sizeof(uint8_t), GetSerializeSize(uint8_t(0)));
80 [ + - ]: 1 : BOOST_CHECK_EQUAL(sizeof(int16_t), GetSerializeSize(int16_t(0)));
81 [ + - ]: 1 : BOOST_CHECK_EQUAL(sizeof(uint16_t), GetSerializeSize(uint16_t(0)));
82 [ + - ]: 1 : BOOST_CHECK_EQUAL(sizeof(int32_t), GetSerializeSize(int32_t(0)));
83 [ + - + - ]: 1 : BOOST_CHECK_EQUAL(sizeof(uint32_t), GetSerializeSize(uint32_t(0)));
84 [ + - ]: 1 : BOOST_CHECK_EQUAL(sizeof(int64_t), GetSerializeSize(int64_t(0)));
85 [ + - ]: 1 : BOOST_CHECK_EQUAL(sizeof(uint64_t), GetSerializeSize(uint64_t(0)));
86 : : // Bool is serialized as uint8_t
87 [ + - ]: 1 : BOOST_CHECK_EQUAL(sizeof(uint8_t), GetSerializeSize(bool(0)));
88 : :
89 : : // Sanity-check GetSerializeSize and c++ type matching
90 [ + - ]: 1 : BOOST_CHECK_EQUAL(GetSerializeSize((unsigned char)0), 1U);
91 [ + - ]: 1 : BOOST_CHECK_EQUAL(GetSerializeSize(int8_t(0)), 1U);
92 [ + - ]: 1 : BOOST_CHECK_EQUAL(GetSerializeSize(uint8_t(0)), 1U);
93 [ + - ]: 1 : BOOST_CHECK_EQUAL(GetSerializeSize(int16_t(0)), 2U);
94 [ + - ]: 1 : BOOST_CHECK_EQUAL(GetSerializeSize(uint16_t(0)), 2U);
95 [ + - ]: 1 : BOOST_CHECK_EQUAL(GetSerializeSize(int32_t(0)), 4U);
96 [ + - ]: 1 : BOOST_CHECK_EQUAL(GetSerializeSize(uint32_t(0)), 4U);
97 [ + - ]: 1 : BOOST_CHECK_EQUAL(GetSerializeSize(int64_t(0)), 8U);
98 [ + - ]: 1 : BOOST_CHECK_EQUAL(GetSerializeSize(uint64_t(0)), 8U);
99 [ + - ]: 1 : BOOST_CHECK_EQUAL(GetSerializeSize(bool(0)), 1U);
100 [ + - ]: 1 : BOOST_CHECK_EQUAL(GetSerializeSize(std::array<uint8_t, 1>{0}), 1U);
101 [ + - ]: 1 : BOOST_CHECK_EQUAL(GetSerializeSize(std::array<uint8_t, 2>{0, 0}), 2U);
102 : 1 : }
103 : :
104 [ + - + - : 7 : BOOST_AUTO_TEST_CASE(varints)
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- ]
105 : : {
106 : : // encode
107 : :
108 : 1 : DataStream ss{};
109 : 1 : DataStream::size_type size = 0;
110 [ + + ]: 100001 : for (int i = 0; i < 100000; i++) {
111 [ + - ]: 100000 : ss << VARINT_MODE(i, VarIntMode::NONNEGATIVE_SIGNED);
112 : 100000 : size += ::GetSerializeSize(VARINT_MODE(i, VarIntMode::NONNEGATIVE_SIGNED));
113 [ + - + - ]: 200000 : BOOST_CHECK(size == ss.size());
114 : : }
115 : :
116 [ + + ]: 102 : for (uint64_t i = 0; i < 100000000000ULL; i += 999999937) {
117 [ + - ]: 101 : ss << VARINT(i);
118 : 101 : size += ::GetSerializeSize(VARINT(i));
119 [ + - + - ]: 202 : BOOST_CHECK(size == ss.size());
120 : : }
121 : :
122 : : // decode
123 [ + + ]: 100001 : for (int i = 0; i < 100000; i++) {
124 : 100000 : int j = -1;
125 [ + - ]: 100000 : ss >> VARINT_MODE(j, VarIntMode::NONNEGATIVE_SIGNED);
126 [ + - + - ]: 200000 : BOOST_CHECK_MESSAGE(i == j, "decoded:" << j << " expected:" << i);
127 : : }
128 : :
129 [ + + ]: 102 : for (uint64_t i = 0; i < 100000000000ULL; i += 999999937) {
130 : 101 : uint64_t j = std::numeric_limits<uint64_t>::max();
131 [ + - ]: 101 : ss >> VARINT(j);
132 [ + - + - ]: 202 : BOOST_CHECK_MESSAGE(i == j, "decoded:" << j << " expected:" << i);
133 : : }
134 : 1 : }
135 : :
136 [ + - + - : 7 : BOOST_AUTO_TEST_CASE(varints_bitpatterns)
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- ]
137 : : {
138 [ + - ]: 1 : DataStream ss{};
139 [ + - + - : 2 : ss << VARINT_MODE(0, VarIntMode::NONNEGATIVE_SIGNED); BOOST_CHECK_EQUAL(HexStr(ss), "00"); ss.clear();
+ - + - +
- ]
140 [ + - + - : 2 : ss << VARINT_MODE(0x7f, VarIntMode::NONNEGATIVE_SIGNED); BOOST_CHECK_EQUAL(HexStr(ss), "7f"); ss.clear();
+ - + - +
- ]
141 [ + - + - : 2 : ss << VARINT_MODE(int8_t{0x7f}, VarIntMode::NONNEGATIVE_SIGNED); BOOST_CHECK_EQUAL(HexStr(ss), "7f"); ss.clear();
+ - + - +
- ]
142 [ + - + - : 2 : ss << VARINT_MODE(0x80, VarIntMode::NONNEGATIVE_SIGNED); BOOST_CHECK_EQUAL(HexStr(ss), "8000"); ss.clear();
+ - + - +
- ]
143 [ + - + - : 2 : ss << VARINT(uint8_t{0x80}); BOOST_CHECK_EQUAL(HexStr(ss), "8000"); ss.clear();
+ - + - +
- ]
144 [ + - + - : 2 : ss << VARINT_MODE(0x1234, VarIntMode::NONNEGATIVE_SIGNED); BOOST_CHECK_EQUAL(HexStr(ss), "a334"); ss.clear();
+ - + - +
- ]
145 [ + - + - : 2 : ss << VARINT_MODE(int16_t{0x1234}, VarIntMode::NONNEGATIVE_SIGNED); BOOST_CHECK_EQUAL(HexStr(ss), "a334"); ss.clear();
+ - + - +
- ]
146 [ + - + - : 2 : ss << VARINT_MODE(0xffff, VarIntMode::NONNEGATIVE_SIGNED); BOOST_CHECK_EQUAL(HexStr(ss), "82fe7f"); ss.clear();
+ - + - +
- ]
147 [ + - + - : 2 : ss << VARINT(uint16_t{0xffff}); BOOST_CHECK_EQUAL(HexStr(ss), "82fe7f"); ss.clear();
+ - + - +
- ]
148 [ + - + - : 2 : ss << VARINT_MODE(0x123456, VarIntMode::NONNEGATIVE_SIGNED); BOOST_CHECK_EQUAL(HexStr(ss), "c7e756"); ss.clear();
+ - + - +
- ]
149 [ + - + - : 2 : ss << VARINT_MODE(int32_t{0x123456}, VarIntMode::NONNEGATIVE_SIGNED); BOOST_CHECK_EQUAL(HexStr(ss), "c7e756"); ss.clear();
+ - + - +
- ]
150 [ + - + - : 2 : ss << VARINT(0x80123456U); BOOST_CHECK_EQUAL(HexStr(ss), "86ffc7e756"); ss.clear();
+ - + - +
- ]
151 [ + - + - : 2 : ss << VARINT(uint32_t{0x80123456U}); BOOST_CHECK_EQUAL(HexStr(ss), "86ffc7e756"); ss.clear();
+ - + - +
- ]
152 [ + - + - : 2 : ss << VARINT(0xffffffff); BOOST_CHECK_EQUAL(HexStr(ss), "8efefefe7f"); ss.clear();
+ - + - +
- ]
153 [ + - + - : 2 : ss << VARINT_MODE(0x7fffffffffffffffLL, VarIntMode::NONNEGATIVE_SIGNED); BOOST_CHECK_EQUAL(HexStr(ss), "fefefefefefefefe7f"); ss.clear();
+ - + - +
- ]
154 [ + - + - : 3 : ss << VARINT(0xffffffffffffffffULL); BOOST_CHECK_EQUAL(HexStr(ss), "80fefefefefefefefe7f"); ss.clear();
+ - + - +
- ]
155 : 1 : }
156 : :
157 [ + - + - : 7 : BOOST_AUTO_TEST_CASE(compactsize)
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- ]
158 : : {
159 : 1 : DataStream ss{};
160 : 1 : std::vector<char>::size_type i, j;
161 : :
162 [ + + ]: 27 : for (i = 1; i <= MAX_SIZE; i *= 2)
163 : : {
164 [ + - ]: 26 : WriteCompactSize(ss, i-1);
165 [ + - ]: 26 : WriteCompactSize(ss, i);
166 : : }
167 [ + + ]: 27 : for (i = 1; i <= MAX_SIZE; i *= 2)
168 : : {
169 [ + - ]: 26 : j = ReadCompactSize(ss);
170 [ + - + - : 52 : BOOST_CHECK_MESSAGE((i-1) == j, "decoded:" << j << " expected:" << (i-1));
+ - ]
171 [ + - ]: 26 : j = ReadCompactSize(ss);
172 [ + - + - ]: 52 : BOOST_CHECK_MESSAGE(i == j, "decoded:" << j << " expected:" << i);
173 : : }
174 : 1 : }
175 : :
176 : 6 : static bool isCanonicalException(const std::ios_base::failure& ex)
177 : : {
178 : 6 : std::ios_base::failure expectedException("non-canonical ReadCompactSize()");
179 : :
180 : : // The string returned by what() can be different for different platforms.
181 : : // Instead of directly comparing the ex.what() with an expected string,
182 : : // create an instance of exception to see if ex.what() matches
183 : : // the expected explanatory string returned by the exception instance.
184 : 6 : return strcmp(expectedException.what(), ex.what()) == 0;
185 : 6 : }
186 : :
187 [ + - + - : 7 : BOOST_AUTO_TEST_CASE(vector_bool)
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- ]
188 : : {
189 : 1 : std::vector<uint8_t> vec1{1, 0, 0, 1, 1, 1, 0, 0, 0, 0, 1, 0, 0, 1, 1, 0, 0, 0, 1, 1, 1, 1, 0, 1, 0, 0, 1};
190 [ + - ]: 1 : std::vector<bool> vec2{1, 0, 0, 1, 1, 1, 0, 0, 0, 0, 1, 0, 0, 1, 1, 0, 0, 0, 1, 1, 1, 1, 0, 1, 0, 0, 1};
191 : :
192 [ + - + - : 2 : BOOST_CHECK(vec1 == std::vector<uint8_t>(vec2.begin(), vec2.end()));
+ - + - ]
193 [ + - + - : 2 : BOOST_CHECK((HashWriter{} << vec1).GetHash() == (HashWriter{} << vec2).GetHash());
+ - + - +
- + - + -
+ - ]
194 : 1 : }
195 : :
196 [ + - + - : 7 : BOOST_AUTO_TEST_CASE(array)
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- ]
197 : : {
198 : 1 : std::array<uint8_t, 32> array1{1, 0, 0, 1, 1, 1, 0, 0, 0, 0, 1, 0, 0, 1, 1, 0, 0, 0, 1, 1, 1, 1, 0, 1, 0, 0, 1};
199 [ + - ]: 1 : DataStream ds;
200 [ + - ]: 1 : ds << array1;
201 : 1 : std::array<uint8_t, 32> array2;
202 [ + - ]: 1 : ds >> array2;
203 [ + - + - ]: 2 : BOOST_CHECK(array1 == array2);
204 : 1 : }
205 : :
206 [ + - + - : 7 : BOOST_AUTO_TEST_CASE(noncanonical)
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- ]
207 : : {
208 : : // Write some non-canonical CompactSize encodings, and
209 : : // make sure an exception is thrown when read back.
210 [ + - ]: 1 : DataStream ss{};
211 : 1 : std::vector<char>::size_type n;
212 : :
213 : : // zero encoded with three bytes:
214 [ + - ]: 1 : ss << Span{"\xfd\x00\x00"}.first(3);
215 [ + - - + : 2 : BOOST_CHECK_EXCEPTION(ReadCompactSize(ss), std::ios_base::failure, isCanonicalException);
- - - - -
+ + - + -
+ - ]
216 : :
217 : : // 0xfc encoded with three bytes:
218 [ + - ]: 1 : ss << Span{"\xfd\xfc\x00"}.first(3);
219 [ + - - + : 2 : BOOST_CHECK_EXCEPTION(ReadCompactSize(ss), std::ios_base::failure, isCanonicalException);
- - - - -
+ + - + -
+ - ]
220 : :
221 : : // 0xfd encoded with three bytes is OK:
222 [ + - ]: 1 : ss << Span{"\xfd\xfd\x00"}.first(3);
223 [ + - ]: 1 : n = ReadCompactSize(ss);
224 [ + - + - : 2 : BOOST_CHECK(n == 0xfd);
+ - ]
225 : :
226 : : // zero encoded with five bytes:
227 [ + - ]: 1 : ss << Span{"\xfe\x00\x00\x00\x00"}.first(5);
228 [ + - - + : 2 : BOOST_CHECK_EXCEPTION(ReadCompactSize(ss), std::ios_base::failure, isCanonicalException);
- - - - -
+ + - + -
+ - ]
229 : :
230 : : // 0xffff encoded with five bytes:
231 [ + - ]: 1 : ss << Span{"\xfe\xff\xff\x00\x00"}.first(5);
232 [ + - - + : 2 : BOOST_CHECK_EXCEPTION(ReadCompactSize(ss), std::ios_base::failure, isCanonicalException);
- - - - -
+ + - + -
+ - ]
233 : :
234 : : // zero encoded with nine bytes:
235 [ + - ]: 1 : ss << Span{"\xff\x00\x00\x00\x00\x00\x00\x00\x00"}.first(9);
236 [ + - - + : 2 : BOOST_CHECK_EXCEPTION(ReadCompactSize(ss), std::ios_base::failure, isCanonicalException);
- - - - -
+ + - + -
+ - ]
237 : :
238 : : // 0x01ffffff encoded with nine bytes:
239 [ + - ]: 1 : ss << Span{"\xff\xff\xff\xff\x01\x00\x00\x00\x00"}.first(9);
240 [ + - - + : 2 : BOOST_CHECK_EXCEPTION(ReadCompactSize(ss), std::ios_base::failure, isCanonicalException);
- - - - -
+ + - + -
+ - ]
241 : 1 : }
242 : :
243 [ + - + - : 7 : BOOST_AUTO_TEST_CASE(class_methods)
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- ]
244 : : {
245 : 1 : int intval(100);
246 : 1 : bool boolval(true);
247 : 1 : std::string stringval("testing");
248 : 1 : const uint8_t charstrval[16]{"testing charstr"};
249 [ + - ]: 1 : CMutableTransaction txval;
250 [ + - ]: 1 : CTransactionRef tx_ref{MakeTransactionRef(txval)};
251 [ + - ]: 1 : CSerializeMethodsTestSingle methodtest1(intval, boolval, stringval, charstrval, tx_ref);
252 [ + - ]: 1 : CSerializeMethodsTestMany methodtest2(intval, boolval, stringval, charstrval, tx_ref);
253 [ + - ]: 1 : CSerializeMethodsTestSingle methodtest3;
254 : 1 : CSerializeMethodsTestMany methodtest4;
255 [ + - ]: 1 : DataStream ss;
256 [ + - + - : 2 : BOOST_CHECK(methodtest1 == methodtest2);
+ - ]
257 [ + - ]: 1 : ss << methodtest1;
258 [ + - ]: 1 : ss >> methodtest4;
259 [ + - ]: 1 : ss << methodtest2;
260 [ + - ]: 1 : ss >> methodtest3;
261 [ + - + - : 2 : BOOST_CHECK(methodtest1 == methodtest2);
+ - ]
262 [ + - + - : 2 : BOOST_CHECK(methodtest2 == methodtest3);
+ - ]
263 [ + - + - : 2 : BOOST_CHECK(methodtest3 == methodtest4);
+ - ]
264 : :
265 [ + - ]: 1 : DataStream ss2;
266 [ + - + - : 1 : ss2 << intval << boolval << stringval << charstrval << TX_WITH_WITNESS(txval);
+ - + - +
- ]
267 [ + - ]: 1 : ss2 >> methodtest3;
268 [ + - + - : 2 : BOOST_CHECK(methodtest3 == methodtest4);
+ - ]
269 : 1 : {
270 [ + - ]: 1 : DataStream ds;
271 [ + - ]: 1 : const std::string in{"ab"};
272 [ + - + - ]: 1 : ds << Span{in} << std::byte{'c'};
273 : 1 : std::array<std::byte, 2> out;
274 : 1 : std::byte out_3;
275 [ + - + - ]: 1 : ds >> Span{out} >> out_3;
276 [ + - + - ]: 1 : BOOST_CHECK_EQUAL(out.at(0), std::byte{'a'});
277 [ + - + - ]: 1 : BOOST_CHECK_EQUAL(out.at(1), std::byte{'b'});
278 [ + - + - ]: 1 : BOOST_CHECK_EQUAL(out_3, std::byte{'c'});
279 : 1 : }
280 [ + - ]: 3 : }
281 : :
282 : : struct BaseFormat {
283 : : const enum {
284 : : RAW,
285 : : HEX,
286 : : } m_base_format;
287 : 10 : SER_PARAMS_OPFUNC
288 : : };
289 : : constexpr BaseFormat RAW{BaseFormat::RAW};
290 : : constexpr BaseFormat HEX{BaseFormat::HEX};
291 : :
292 : : /// (Un)serialize a number as raw byte or 2 hexadecimal chars.
293 : : class Base
294 : : {
295 : : public:
296 : : uint8_t m_base_data;
297 : :
298 : 4 : Base() : m_base_data(17) {}
299 : 4 : explicit Base(uint8_t data) : m_base_data(data) {}
300 : :
301 : : template <typename Stream>
302 [ + + ]: 10 : void Serialize(Stream& s) const
303 : : {
304 [ + + ]: 10 : if (s.template GetParams<BaseFormat>().m_base_format == BaseFormat::RAW) {
305 : 6 : s << m_base_data;
306 : : } else {
307 [ + - ]: 4 : s << Span{HexStr(Span{&m_base_data, 1})};
308 : : }
309 : 10 : }
310 : :
311 : : template <typename Stream>
312 [ + + ]: 8 : void Unserialize(Stream& s)
313 : : {
314 [ + + ]: 8 : if (s.template GetParams<BaseFormat>().m_base_format == BaseFormat::RAW) {
315 : 5 : s >> m_base_data;
316 : : } else {
317 : 3 : std::string hex{"aa"};
318 [ + - + - ]: 3 : s >> Span{hex}.first(hex.size());
319 [ + - + - ]: 6 : m_base_data = TryParseHex<uint8_t>(hex).value().at(0);
320 : 3 : }
321 [ - - ]: 8 : }
322 : : };
323 : :
324 : : class DerivedAndBaseFormat
325 : : {
326 : : public:
327 : : BaseFormat m_base_format;
328 : :
329 : : enum class DerivedFormat {
330 : : LOWER,
331 : : UPPER,
332 : : } m_derived_format;
333 : :
334 : 2 : SER_PARAMS_OPFUNC
335 : : };
336 : :
337 : 0 : class Derived : public Base
338 : : {
339 : : public:
340 : : std::string m_derived_data;
341 : :
342 : 4 : SERIALIZE_METHODS(Derived, obj)
343 : : {
344 : 2 : auto& fmt = SER_PARAMS(DerivedAndBaseFormat);
345 : 2 : READWRITE(fmt.m_base_format(AsBase<Base>(obj)));
346 : :
347 : : if (ser_action.ForRead()) {
348 : : std::string str;
349 : : s >> str;
350 : : SER_READ(obj, obj.m_derived_data = str);
351 : : } else {
352 [ + + ]: 4 : s << (fmt.m_derived_format == DerivedAndBaseFormat::DerivedFormat::LOWER ?
353 : : ToLower(obj.m_derived_data) :
354 : : ToUpper(obj.m_derived_data));
355 : : }
356 : 2 : }
357 : : };
358 : :
359 : : struct OtherParam {
360 : : uint8_t param;
361 : 2 : SER_PARAMS_OPFUNC
362 : : };
363 : :
364 : : //! Checker for value of OtherParam. When being serialized, serializes the
365 : : //! param to the stream. When being unserialized, verifies the value in the
366 : : //! stream matches the param.
367 : : class OtherParamChecker
368 : : {
369 : : public:
370 : : template <typename Stream>
371 : 2 : void Serialize(Stream& s) const
372 : : {
373 : 2 : const uint8_t param = s.template GetParams<OtherParam>().param;
374 : 2 : s << param;
375 : : }
376 : :
377 : : template <typename Stream>
378 : 2 : void Unserialize(Stream& s) const
379 : : {
380 : 2 : const uint8_t param = s.template GetParams<OtherParam>().param;
381 : : uint8_t value;
382 : 2 : s >> value;
383 [ + - ]: 2 : BOOST_CHECK_EQUAL(value, param);
384 : 2 : }
385 : : };
386 : :
387 : : //! Test creating a stream with multiple parameters and making sure
388 : : //! serialization code requiring different parameters can retrieve them. Also
389 : : //! test that earlier parameters take precedence if the same parameter type is
390 : : //! specified twice. (Choice of whether earlier or later values take precedence
391 : : //! or multiple values of the same type are allowed was arbitrary, and just
392 : : //! decided based on what would require smallest amount of ugly C++ template
393 : : //! code. Intent of the test is to just ensure there is no unexpected behavior.)
394 [ + - + - : 7 : BOOST_AUTO_TEST_CASE(with_params_multi)
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- ]
395 : : {
396 : 1 : const OtherParam other_param_used{.param = 0x10};
397 : 1 : const OtherParam other_param_ignored{.param = 0x11};
398 : 1 : const OtherParam other_param_override{.param = 0x12};
399 : 1 : const OtherParamChecker check;
400 [ + - ]: 1 : DataStream stream;
401 [ + - ]: 1 : ParamsStream pstream{stream, RAW, other_param_used, other_param_ignored};
402 : :
403 : 1 : Base base1{0x20};
404 [ + - + - : 1 : pstream << base1 << check << other_param_override(check);
+ - ]
405 [ + - + - : 1 : BOOST_CHECK_EQUAL(stream.str(), "\x20\x10\x12");
+ - ]
406 : :
407 : 1 : Base base2;
408 [ + - + - : 1 : pstream >> base2 >> check >> other_param_override(check);
+ - ]
409 [ + - + - ]: 1 : BOOST_CHECK_EQUAL(base2.m_base_data, 0x20);
410 : 1 : }
411 : :
412 : : //! Test creating a ParamsStream that moves from a stream argument.
413 [ + - + - : 7 : BOOST_AUTO_TEST_CASE(with_params_move)
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- ]
414 : : {
415 : 1 : UncopyableStream stream{MakeByteSpan(std::string_view{"abc"})};
416 : 1 : ParamsStream pstream{std::move(stream), RAW, HEX, RAW};
417 [ + - + - : 1 : BOOST_CHECK_EQUAL(pstream.GetStream().str(), "abc");
+ - ]
418 [ + - ]: 1 : pstream.GetStream().clear();
419 : :
420 : 1 : Base base1{0x20};
421 [ + - ]: 1 : pstream << base1;
422 [ + - + - : 1 : BOOST_CHECK_EQUAL(pstream.GetStream().str(), "\x20");
+ - ]
423 : :
424 : 1 : Base base2;
425 [ + - ]: 1 : pstream >> base2;
426 [ + - + - ]: 1 : BOOST_CHECK_EQUAL(base2.m_base_data, 0x20);
427 : 1 : }
428 : :
429 [ + - + - : 7 : BOOST_AUTO_TEST_CASE(with_params_base)
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- ]
430 : : {
431 : 1 : Base b{0x0F};
432 : :
433 [ + - ]: 1 : DataStream stream;
434 : :
435 [ + - ]: 1 : stream << RAW(b);
436 [ + - + - : 1 : BOOST_CHECK_EQUAL(stream.str(), "\x0F");
+ - ]
437 : :
438 : 1 : b.m_base_data = 0;
439 [ + - ]: 1 : stream >> RAW(b);
440 [ + - + - ]: 1 : BOOST_CHECK_EQUAL(b.m_base_data, 0x0F);
441 : :
442 [ - + ]: 1 : stream.clear();
443 : :
444 [ + - ]: 1 : stream << HEX(b);
445 [ + - + - : 1 : BOOST_CHECK_EQUAL(stream.str(), "0f");
+ - ]
446 : :
447 : 1 : b.m_base_data = 0;
448 [ + - ]: 1 : stream >> HEX(b);
449 [ + - + - ]: 1 : BOOST_CHECK_EQUAL(b.m_base_data, 0x0F);
450 : 1 : }
451 : :
452 [ + - + - : 7 : BOOST_AUTO_TEST_CASE(with_params_vector_of_base)
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- ]
453 : : {
454 : 1 : std::vector<Base> v{Base{0x0F}, Base{0xFF}};
455 : :
456 [ + - ]: 1 : DataStream stream;
457 : :
458 [ + - ]: 1 : stream << RAW(v);
459 [ + - + - : 1 : BOOST_CHECK_EQUAL(stream.str(), "\x02\x0F\xFF");
+ - ]
460 : :
461 [ + - ]: 1 : v[0].m_base_data = 0;
462 : 1 : v[1].m_base_data = 0;
463 [ + - ]: 1 : stream >> RAW(v);
464 [ + - + - ]: 1 : BOOST_CHECK_EQUAL(v[0].m_base_data, 0x0F);
465 [ + - + - ]: 1 : BOOST_CHECK_EQUAL(v[1].m_base_data, 0xFF);
466 : :
467 [ - + ]: 1 : stream.clear();
468 : :
469 [ + - ]: 1 : stream << HEX(v);
470 [ + - + - : 1 : BOOST_CHECK_EQUAL(stream.str(), "\x02"
+ - ]
471 : : "0fff");
472 : :
473 [ + - ]: 1 : v[0].m_base_data = 0;
474 : 1 : v[1].m_base_data = 0;
475 [ + - ]: 1 : stream >> HEX(v);
476 [ + - + - ]: 1 : BOOST_CHECK_EQUAL(v[0].m_base_data, 0x0F);
477 [ + - + - ]: 1 : BOOST_CHECK_EQUAL(v[1].m_base_data, 0xFF);
478 : 1 : }
479 : :
480 : : constexpr DerivedAndBaseFormat RAW_LOWER{{BaseFormat::RAW}, DerivedAndBaseFormat::DerivedFormat::LOWER};
481 : : constexpr DerivedAndBaseFormat HEX_UPPER{{BaseFormat::HEX}, DerivedAndBaseFormat::DerivedFormat::UPPER};
482 : :
483 [ + - + - : 7 : BOOST_AUTO_TEST_CASE(with_params_derived)
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- ]
484 : : {
485 [ + - ]: 1 : Derived d;
486 : 1 : d.m_base_data = 0x0F;
487 [ + - ]: 1 : d.m_derived_data = "xY";
488 : :
489 [ + - ]: 1 : DataStream stream;
490 : :
491 [ + - ]: 1 : stream << RAW_LOWER(d);
492 : :
493 [ + - ]: 1 : stream << HEX_UPPER(d);
494 : :
495 [ + - + - : 1 : BOOST_CHECK_EQUAL(stream.str(), "\x0F\x02xy"
+ - ]
496 : : "0f\x02XY");
497 : 1 : }
498 : :
499 : : BOOST_AUTO_TEST_SUITE_END()
|
