Packets: Packet::clone() clones now also annotations
[senf.git] / senf / Packets / Packet.test.cc
1 // $Id$
2 //
3 // Copyright (C) 2007
4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
6 //     Stefan Bund <g0dil@berlios.de>
7 //
8 // This program is free software; you can redistribute it and/or modify
9 // it under the terms of the GNU General Public License as published by
10 // the Free Software Foundation; either version 2 of the License, or
11 // (at your option) any later version.
12 //
13 // This program is distributed in the hope that it will be useful,
14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 // GNU General Public License for more details.
17 //
18 // You should have received a copy of the GNU General Public License
19 // along with this program; if not, write to the
20 // Free Software Foundation, Inc.,
21 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
22
23 /** \file
24     \brief Packet unit tests */
25
26 //#include "Packet.test.hh"
27 //#include "Packet.test.ih"
28
29 // Custom includes
30 #include <sstream>
31 #include <boost/static_assert.hpp>
32 #include <boost/cstdint.hpp>
33 #include "Packets.hh"
34
35 #include <senf/Utils/auto_unit_test.hh>
36 #include <boost/test/test_tools.hpp>
37
38 #define prefix_
39 ///////////////////////////////cc.p////////////////////////////////////////
40
41 namespace {
42
43     struct RegTag {
44         typedef unsigned key_t;
45     };
46
47     struct FooPacketType
48         : public senf::PacketTypeBase,
49           public senf::PacketTypeMixin<FooPacketType>
50     {
51         using senf::PacketTypeMixin<FooPacketType>::nextPacketRange;
52         using senf::PacketTypeMixin<FooPacketType>::initSize;
53         using senf::PacketTypeMixin<FooPacketType>::init;
54         static size_type initSize()
55             { return 4u; }
56
57         // We need to implement initHeadSize() to force the mixin to switch into 'fixed-size'
58         // mode. Otherwise, mixin::nextPacketRange() would query the parser for it's size to find
59         // the header size. Since the parser is VoidPacketParser, the header size would therefore be
60         // 0
61         static size_type initHeadSize()
62             { return initSize(); }
63     };
64     typedef senf::ConcretePacket<FooPacketType> FooPacket;
65
66     struct BarPacketParser : public senf::PacketParserBase
67     {
68 #       include SENF_FIXED_PARSER()
69
70         SENF_PARSER_FIELD( type,     senf::UInt16Parser );
71         SENF_PARSER_FIELD( length,   senf::Int32Parser  );
72         SENF_PARSER_FIELD( reserved, senf::UInt16Parser );
73
74         SENF_PARSER_INIT() {
75             reserved() << 0xA0A0u;
76         }
77
78         SENF_PARSER_FINALIZE(BarPacketParser);
79     };
80
81     struct BarPacketType
82         : public senf::PacketTypeBase,
83           public senf::PacketTypeMixin<BarPacketType,RegTag>
84     {
85         typedef senf::PacketTypeMixin<BarPacketType,RegTag> mixin;
86         typedef senf::ConcretePacket<BarPacketType> packet;
87         typedef BarPacketParser parser;
88         using mixin::nextPacketRange;
89         using mixin::nextPacketType;
90         using mixin::initSize;
91         using mixin::init;
92         static void dump(packet p, std::ostream & os) {
93             os << "BarPacket:\n"
94                << senf::fieldName("type") << p->type() << "\n"
95                << senf::fieldName("length") << p->length() << "\n";
96         }
97         static void finalize(packet p) {
98             if (p.next(senf::nothrow))
99                 p->type() = senf::PacketRegistry<RegTag>::key(p.next());
100             else
101                 p->type() = -1;
102         }
103         static key_t nextPacketKey(packet p) {
104             return p->type();
105         }
106     };
107     typedef BarPacketType::packet BarPacket;
108
109     namespace reg {
110         senf::PacketRegistry<RegTag>::ScopedRegistrationProxy<FooPacket> registerFoo(1u);
111         senf::PacketRegistry<RegTag>::ScopedRegistrationProxy<BarPacket> registerBar(2u);
112     }
113
114     struct IntAnnotation {
115         boost::uint32_t value;
116     };
117
118     std::ostream & operator<<(std::ostream & os, IntAnnotation const & v)
119     { os << v.value; return os; }
120
121     struct LargeAnnotation {
122         char value[32];
123     };
124
125     std::ostream & operator<<(std::ostream & os, LargeAnnotation const & v)
126     { os << v.value; return os; }
127
128     struct ComplexAnnotation : senf::ComplexAnnotation
129     {
130         ComplexAnnotation() : s("empty"), i(-1) {}
131         std::string s;
132         boost::int32_t i;
133         // padding so the size does not depend on the platform ...
134         struct _ {std::string s;boost::int32_t i;};
135         char __ [32-sizeof(_)];
136     };
137
138     std::ostream & operator<<(std::ostream & os, ComplexAnnotation const & v)
139     { os << "('" << v.s << "' " << v.i << ')'; return os; }
140
141     struct ComplexEmptyAnnotation : senf::ComplexAnnotation
142     {};
143
144     std::ostream & operator<<(std::ostream & os, ComplexEmptyAnnotation const & v)
145     { os << "(empty)"; return os; }
146
147     struct InvalidAnnotation
148     {
149         std::string value;
150     };
151
152     std::ostream & operator<<(std::ostream & os, InvalidAnnotation const & v)
153     { os << v.value; return os; }
154
155 }
156
157 SENF_AUTO_UNIT_TEST(packet)
158 {
159     BOOST_CHECK(! senf::Packet().is<BarPacket>() );
160     senf::Packet packet (FooPacket::create());
161     BarPacket::createAfter(packet);
162
163     BOOST_REQUIRE( packet );
164     BOOST_CHECK( packet.next() );
165     BOOST_CHECK( ! packet.next().next(senf::nothrow) );
166     BOOST_CHECK( ! packet.next().next(senf::nothrow).is<BarPacket>() );
167     BOOST_CHECK( ! packet.prev(senf::nothrow) );
168     BOOST_CHECK( packet.next().prev() == packet );
169     SENF_CHECK_NOT_EQUAL( packet.next(), packet );
170     BOOST_CHECK_EQUAL( std::distance(packet.data().begin(), packet.next().data().begin()), 4 );
171     BOOST_CHECK_EQUAL( std::distance(packet.data().begin(), packet.data().end()), 12 );
172     BOOST_CHECK_EQUAL( std::distance(packet.next().data().begin(), packet.next().data().end()), 8 );
173     BOOST_CHECK( packet.data().end() == packet.next().data().end() );
174     BOOST_CHECK_EQUAL( packet.size(), 12u );
175     BOOST_CHECK_EQUAL( packet.next().size(), 8u );
176     BOOST_CHECK( packet.is<FooPacket>() );
177     BOOST_CHECK( packet.next().is<BarPacket>() );
178     BOOST_CHECK( packet.first() == packet );
179     BOOST_CHECK( packet.last() == packet.next() );
180
181     BOOST_CHECK( ! packet.is_shared() );
182     {
183         senf::Packet p2 (packet);
184         BOOST_CHECK( packet.is_shared() );
185         BOOST_CHECK( p2.is_shared() );
186     }
187     BOOST_CHECK( ! packet.is_shared() );
188
189     senf::Packet p2 (packet.next());
190     BOOST_CHECK( p2 );
191     BOOST_CHECK( packet.is_shared() );
192     BOOST_CHECK( p2.is_shared() );
193     packet.parseNextAs<FooPacket>();
194     BOOST_CHECK_EQUAL( packet.size(), 12u );
195     BOOST_CHECK_EQUAL( packet.next().size(), 8u );
196     BOOST_CHECK( packet.next().is<FooPacket>() );
197     BOOST_CHECK( ! p2 );
198     BOOST_CHECK( packet.next().as<FooPacket>() );
199
200     p2 = packet.next().clone();
201     BOOST_CHECK( ! packet.is_shared() );
202     BOOST_REQUIRE( p2 );
203     packet.next().append( p2 );
204     BOOST_REQUIRE( packet.next().next() );
205     BOOST_CHECK( packet.next().next().next() );
206     BOOST_CHECK( packet.next().next().next().is<senf::DataPacket>() );
207     BOOST_CHECK_EQUAL( packet.size(), 16u );
208
209     // This calls and checks typeId()
210     BOOST_CHECK_EQUAL( senf::PacketRegistry<RegTag>::key(packet), 1u );
211     packet.next().parseNextAs( senf::PacketRegistry<RegTag>::lookup(2u).factory() );
212     BOOST_CHECK( packet.next().next().is<BarPacket>() );
213
214     std::stringstream s;
215     packet.dump(s);
216     BOOST_CHECK_EQUAL( s.str(),
217                        "Annotations:\n"
218                        "  (anonymous namespace)::IntAnnotation : 0\n"
219                        "BarPacket:\n"
220                        "  type                    : 0\n"
221                        "  length                  : 0\n" );
222
223     packet.finalizeAll();
224     BOOST_CHECK_EQUAL( packet.last().as<BarPacket>()->type(),
225                        BarPacket::Parser::type_t::value_type(-1) );
226     packet.last().append(FooPacket::create());
227     packet.finalizeThis();
228     packet.finalizeTo<BarPacket>();
229     packet.finalizeTo(packet.find<BarPacket>());
230     packet.finalizeAll();
231     BOOST_CHECK_EQUAL( packet.find<BarPacket>()->type(), 1u );
232
233     BOOST_CHECK( packet.factory() == FooPacket::factory() );
234
235     senf::PacketData::byte data[] = { 0x00, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
236                                       0x81, 0x82, 0x83 };
237
238     BarPacket::createAfter(packet, data);
239     BOOST_REQUIRE( packet.next() );
240     BOOST_REQUIRE( packet.next().is<BarPacket>() );
241     BOOST_CHECK( packet.last().is<FooPacket>() );
242     BOOST_CHECK_EQUAL( packet.last().rfind<BarPacket>()->type(), 1u );
243     BOOST_CHECK_EQUAL( packet.next().size(), 11u );
244     BOOST_REQUIRE( packet.next().next() );
245     BOOST_CHECK( packet.next().next().is<FooPacket>() );
246     BOOST_CHECK( ! packet.next().next().next(senf::nothrow) );
247     BOOST_CHECK_EQUAL( packet.next().next().data()[0], 0x81u );
248
249     BOOST_CHECK( packet.first().find<FooPacket>() == packet );
250     BOOST_CHECK( packet.last().rfind<BarPacket>() == packet.last().prev() );
251     BOOST_CHECK( packet.find<FooPacket>() == packet );
252     BOOST_CHECK( packet.last().rfind<FooPacket>() == packet.last() );
253     BOOST_CHECK( packet.next<BarPacket>() == packet.next() );
254     BOOST_CHECK( packet.last().prev().prev<FooPacket>() == packet );
255
256     senf::DataPacket::createAfter(packet);
257     BOOST_CHECK_THROW( packet.next().next().next().parseNextAs<BarPacket>(),
258             senf::InvalidPacketChainException );
259
260     SENF_CHECK_NO_THROW( BarPacket::create(senf::noinit).dump(s));
261 }
262
263 SENF_AUTO_UNIT_TEST(concretePacket)
264 {
265     senf::PacketData::byte data[] = { 0x01, 0x02, 0x03, 0x04, 0x05, 0x06 };
266
267     BOOST_CHECK_EQUAL( FooPacket::create().size(), 4u );
268     BOOST_CHECK_EQUAL( FooPacket::create(senf::noinit).size(), 0u );
269     BOOST_CHECK_THROW( FooPacket::create(2u), senf::TruncatedPacketException );
270     // No 'u' suffix here to check, that the disable_if works ...
271     BOOST_CHECK_EQUAL( FooPacket::create(10).size(), 10u );
272     BOOST_CHECK_EQUAL( FooPacket::create(2u,senf::noinit).size(), 2u );
273     BOOST_CHECK_EQUAL( FooPacket::create(data).size(), 6u );
274
275     senf::Packet packet (FooPacket::create());
276
277     BOOST_CHECK_EQUAL( FooPacket::createAfter(packet).size(), 4u );
278     BOOST_CHECK_EQUAL( packet.size(), 8u );
279
280     BOOST_CHECK_EQUAL( FooPacket::createAfter(packet,senf::noinit).size(), 0u );
281     BOOST_CHECK_EQUAL( packet.size(), 4u );
282
283     BOOST_CHECK_THROW( FooPacket::createAfter(packet,2u), senf::TruncatedPacketException );
284     // No 'u' suffix here to check, that the disable_if works ...
285     BOOST_CHECK_EQUAL( FooPacket::createAfter(packet,10).size(), 10u );
286     BOOST_CHECK_EQUAL( packet.size(), 14u );
287
288     BOOST_CHECK_EQUAL( FooPacket::createAfter(packet,2u,senf::noinit).size(), 2u );
289     BOOST_CHECK_EQUAL( packet.size(), 6u );
290
291     BOOST_CHECK_EQUAL( FooPacket::createAfter(packet,data).size(), 6u );
292     BOOST_CHECK_EQUAL( packet.size(), 10u );
293
294     BOOST_CHECK_EQUAL( FooPacket::createBefore(packet).size(), 14u );
295     BOOST_CHECK_EQUAL( packet.size(), 10u );
296
297     BOOST_CHECK_EQUAL( FooPacket::createBefore(packet,senf::noinit).size(), 10u );
298     BOOST_CHECK_EQUAL( packet.size(), 10u );
299
300     BOOST_CHECK_EQUAL( FooPacket::createInsertBefore(packet).size(), 14u );
301     BOOST_CHECK_EQUAL( packet.size(), 10u );
302     BOOST_REQUIRE( packet.prev() );
303     BOOST_CHECK_EQUAL( packet.prev().size(), 14u );
304     BOOST_REQUIRE( packet.prev().prev() );
305     BOOST_CHECK_EQUAL( packet.prev().prev().size(), 14u );
306
307     BOOST_CHECK_EQUAL( FooPacket::createInsertBefore(packet,senf::noinit).size(), 10u );
308     BOOST_CHECK_EQUAL( packet.size(), 10u );
309     BOOST_REQUIRE_NO_THROW( packet.prev().prev().prev() );
310     BOOST_CHECK_THROW( packet.prev().prev().prev().prev(), senf::InvalidPacketChainException );
311     BOOST_CHECK_EQUAL( packet.prev().size(), 10u );
312     BOOST_CHECK_EQUAL( packet.prev().prev().size(), 14u );
313     BOOST_CHECK_EQUAL( packet.prev().prev().prev().size(), 14u );
314
315     SENF_CHECK_NOT_EQUAL( packet.clone(), packet );
316     BOOST_CHECK_EQUAL( BarPacket::create()->reserved(), 0xA0A0u );
317 }
318
319 SENF_AUTO_UNIT_TEST(packetAssign)
320 {
321     BarPacket bar1 (BarPacket::create());
322     BarPacket bar2 (BarPacket::create());
323
324     bar2->type() << 0x2A2Bu;
325     bar1.parser() << bar2;
326
327     BOOST_CHECK_EQUAL( bar1->type(), 0x2A2Bu );
328 }
329
330 SENF_AUTO_UNIT_TEST(packetAnnotation)
331 {
332     typedef senf::detail::AnnotationRegistry Reg;
333
334     senf::Packet packet (FooPacket::create());
335     BarPacket::createAfter(packet);
336
337     ComplexAnnotation & ca (packet.annotation<ComplexAnnotation>());
338
339     BOOST_CHECK_EQUAL( ca.s, "empty" );
340     BOOST_CHECK_EQUAL( ca.i, -1 );
341
342     ca.s = "dead beef";
343     ca.i = 0x12345678;
344     SENF_CHECK_NO_THROW( packet.annotation<IntAnnotation>().value = 0xDEADBEEF );
345
346     senf::Packet p2 (packet.next());
347
348     BOOST_CHECK_EQUAL( p2.annotation<IntAnnotation>().value, 0xDEADBEEFu );
349     BOOST_CHECK_EQUAL( p2.annotation<ComplexAnnotation>().s, "dead beef" );
350     BOOST_CHECK_EQUAL( p2.annotation<ComplexAnnotation>().i, 0x12345678 );
351
352     senf::Packet pClone (packet.clone());
353
354     p2.clearAnnotations();
355     BOOST_CHECK_EQUAL( p2.annotation<ComplexAnnotation>().s, "empty" );
356     BOOST_CHECK_EQUAL( p2.annotation<ComplexAnnotation>().i, -1 );
357     BOOST_CHECK_EQUAL( p2.annotation<IntAnnotation>().value, 0 );
358
359     BOOST_CHECK_EQUAL( pClone.annotation<IntAnnotation>().value, 0xDEADBEEFu );
360     BOOST_CHECK_EQUAL( pClone.annotation<ComplexAnnotation>().s, "dead beef" );
361     BOOST_CHECK_EQUAL( pClone.annotation<ComplexAnnotation>().i, 0x12345678 );
362
363     BOOST_CHECK( Reg::lookup<IntAnnotation>() >= 0 );
364     BOOST_CHECK( Reg::lookup<LargeAnnotation>() < 0 );
365     BOOST_CHECK( Reg::lookup<ComplexAnnotation>() < 0 );
366     BOOST_CHECK( Reg::lookup<ComplexEmptyAnnotation>() < 0 );
367
368     std::stringstream ss;
369     senf::dumpPacketAnnotationRegistry(ss);
370     BOOST_CHECK_EQUAL(
371         ss.str(),
372         "SENF_PACKET_ANNOTATION_SLOTS = 8\n"
373         "SENF_PACKET_ANNOTATION_SLOTSIZE = 16\n"
374         "TYPE                                                      FAST  COMPLEX   SIZE\n"
375         "(anonymous namespace)::ComplexAnnotation                  no    yes         32\n"
376         "(anonymous namespace)::ComplexEmptyAnnotation             no    yes          1\n"
377         "(anonymous namespace)::IntAnnotation                      yes   no           4\n"
378         "(anonymous namespace)::LargeAnnotation                    no    no          32\n" );
379 }
380
381 #ifdef COMPILE_CHECK
382
383 COMPILE_FAIL(invalidAnnotation)
384 {
385 #if 0 // The traits check fails for user defined but trivial constructors so ...
386 #   ifdef BOOST_HAS_TYPE_TRAITS_INTRINSICS
387
388     senf::Packet packet (FooPacket::create());
389     senf::IGNORE( packet.annotation<InvalidAnnotation>() );
390
391 #   else
392 #   endif
393 #endif
394
395     invalid_annotation_check_disabled();
396
397 }
398
399 #endif
400
401 ///////////////////////////////cc.e////////////////////////////////////////
402 #undef prefix_
403
404 \f
405 // Local Variables:
406 // mode: c++
407 // fill-column: 100
408 // c-file-style: "senf"
409 // indent-tabs-mode: nil
410 // ispell-local-dictionary: "american"
411 // compile-command: "scons -u test"
412 // comment-column: 40
413 // End: