Rename PacketRegistry::RegistrationProxy to ScopedRegistrationProxy
[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 "Packets.hh"
33
34 #include <senf/Utils/auto_unit_test.hh>
35 #include <boost/test/test_tools.hpp>
36
37 #define prefix_
38 ///////////////////////////////cc.p////////////////////////////////////////
39
40 namespace {
41
42     struct RegTag {
43         typedef unsigned key_t;
44     };
45
46     struct FooPacketType
47         : public senf::PacketTypeBase,
48           public senf::PacketTypeMixin<FooPacketType>
49     {
50         using senf::PacketTypeMixin<FooPacketType>::nextPacketRange;
51         using senf::PacketTypeMixin<FooPacketType>::initSize;
52         using senf::PacketTypeMixin<FooPacketType>::init;
53         static size_type initSize()
54             { return 4u; }
55
56         // We need to implement initHeadSize() to force the mixin to switch into 'fixed-size'
57         // mode. Otherwise, mixin::nextPacketRange() would query the parser for it's size to find
58         // the header size. Since the parser is VoidPacketParser, the header size would therefore be
59         // 0
60         static size_type initHeadSize()
61             { return initSize(); }
62     };
63     typedef senf::ConcretePacket<FooPacketType> FooPacket;
64
65     struct BarPacketParser : public senf::PacketParserBase
66     {
67 #       include SENF_FIXED_PARSER()
68
69         SENF_PARSER_FIELD( type,     senf::UInt16Parser );
70         SENF_PARSER_FIELD( length,   senf::Int32Parser  );
71         SENF_PARSER_FIELD( reserved, senf::UInt16Parser );
72
73         SENF_PARSER_INIT() {
74             reserved() << 0xA0A0u;
75         }
76
77         SENF_PARSER_FINALIZE(BarPacketParser);
78     };
79
80     struct BarPacketType
81         : public senf::PacketTypeBase,
82           public senf::PacketTypeMixin<BarPacketType,RegTag>
83     {
84         typedef senf::PacketTypeMixin<BarPacketType,RegTag> mixin;
85         typedef senf::ConcretePacket<BarPacketType> packet;
86         typedef BarPacketParser parser;
87         using mixin::nextPacketRange;
88         using mixin::nextPacketType;
89         using mixin::initSize;
90         using mixin::init;
91         static void dump(packet p, std::ostream & os) {
92             os << "BarPacket:\n"
93                << "  type: " << p->type() << "\n"
94                << "  length: " << p->length() << "\n";
95         }
96         static void finalize(packet p) {
97             if (p.next(senf::nothrow))
98                 p->type() = senf::PacketRegistry<RegTag>::key(p.next());
99             else
100                 p->type() = -1;
101         }
102         static key_t nextPacketKey(packet p) {
103             return p->type();
104         }
105     };
106     typedef BarPacketType::packet BarPacket;
107
108     namespace reg {
109         senf::PacketRegistry<RegTag>::ScopedRegistrationProxy<FooPacket> registerFoo(1u);
110         senf::PacketRegistry<RegTag>::ScopedRegistrationProxy<BarPacket> registerBar(2u);
111     }
112
113     struct IntAnnotation {
114         unsigned value;
115     };
116
117     std::ostream & operator<<(std::ostream & os, IntAnnotation const & v)
118     { os << v.value; return os; }
119
120     struct LargeAnnotation {
121         char value[32];
122     };
123
124     std::ostream & operator<<(std::ostream & os, LargeAnnotation const & v)
125     { os << v.value; return os; }
126
127     struct ComplexAnnotation : senf::ComplexAnnotation
128     {
129         ComplexAnnotation() : s(), i() {}
130         std::string s;
131         int i;
132     };
133
134     std::ostream & operator<<(std::ostream & os, ComplexAnnotation const & v)
135     { os << "('" << v.s << "' " << v.i << ')'; return os; }
136
137     struct ComplexEmptyAnnotation : senf::ComplexAnnotation
138     {};
139
140     std::ostream & operator<<(std::ostream & os, ComplexEmptyAnnotation const & v)
141     { os << "(empty)"; return os; }
142
143     struct InvalidAnnotation
144     {
145         std::string value;
146     };
147
148     std::ostream & operator<<(std::ostream & os, InvalidAnnotation const & v)
149     { os << v.value; return os; }
150
151 }
152
153 SENF_AUTO_UNIT_TEST(packet)
154 {
155     BOOST_CHECK(! senf::Packet().is<BarPacket>() );
156     senf::Packet packet (FooPacket::create());
157     BarPacket::createAfter(packet);
158
159     BOOST_REQUIRE( packet );
160     BOOST_CHECK( packet.next() );
161     BOOST_CHECK( ! packet.next().next(senf::nothrow) );
162     BOOST_CHECK( ! packet.next().next(senf::nothrow).is<BarPacket>() );
163     BOOST_CHECK( ! packet.prev(senf::nothrow) );
164     BOOST_CHECK( packet.next().prev() == packet );
165     SENF_CHECK_NOT_EQUAL( packet.next(), packet );
166     BOOST_CHECK_EQUAL( std::distance(packet.data().begin(), packet.next().data().begin()), 4 );
167     BOOST_CHECK_EQUAL( std::distance(packet.data().begin(), packet.data().end()), 12 );
168     BOOST_CHECK_EQUAL( std::distance(packet.next().data().begin(), packet.next().data().end()), 8 );
169     BOOST_CHECK( packet.data().end() == packet.next().data().end() );
170     BOOST_CHECK_EQUAL( packet.size(), 12u );
171     BOOST_CHECK_EQUAL( packet.next().size(), 8u );
172     BOOST_CHECK( packet.is<FooPacket>() );
173     BOOST_CHECK( packet.next().is<BarPacket>() );
174     BOOST_CHECK( packet.first() == packet );
175     BOOST_CHECK( packet.last() == packet.next() );
176
177     senf::Packet p2 (packet.next());
178     BOOST_CHECK( p2 );
179     packet.parseNextAs<FooPacket>();
180     BOOST_CHECK_EQUAL( packet.size(), 12u );
181     BOOST_CHECK_EQUAL( packet.next().size(), 8u );
182     BOOST_CHECK( packet.next().is<FooPacket>() );
183     BOOST_CHECK( ! p2 );
184     BOOST_CHECK( packet.next().as<FooPacket>() );
185
186     p2 = packet.next().clone();
187     BOOST_REQUIRE( p2 );
188     packet.next().append( p2 );
189     BOOST_REQUIRE( packet.next().next() );
190     BOOST_CHECK( packet.next().next().next() );
191     BOOST_CHECK( packet.next().next().next().is<senf::DataPacket>() );
192     BOOST_CHECK_EQUAL( packet.size(), 16u );
193
194     // This calls and checks typeId()
195     BOOST_CHECK_EQUAL( senf::PacketRegistry<RegTag>::key(packet), 1u );
196     packet.next().parseNextAs( senf::PacketRegistry<RegTag>::lookup(2u).factory() );
197     BOOST_CHECK( packet.next().next().is<BarPacket>() );
198
199     std::stringstream s;
200     packet.dump(s);
201     BOOST_CHECK_EQUAL( s.str(),
202                        "Annotations:\n"
203                        "  (anonymous namespace)::ComplexAnnotation: no value\n"
204                        "  (anonymous namespace)::IntAnnotation: 0\n"
205                        "BarPacket:\n"
206                        "  type: 0\n"
207                        "  length: 0\n" );
208
209     packet.finalizeAll();
210     BOOST_CHECK_EQUAL( packet.last().as<BarPacket>()->type(),
211                        BarPacket::Parser::type_t::value_type(-1) );
212     packet.last().append(FooPacket::create());
213     packet.finalizeThis();
214     packet.finalizeTo<BarPacket>();
215     packet.finalizeTo(packet.find<BarPacket>());
216     packet.finalizeAll();
217     BOOST_CHECK_EQUAL( packet.find<BarPacket>()->type(), 1u );
218
219     BOOST_CHECK( packet.factory() == FooPacket::factory() );
220
221     senf::PacketData::byte data[] = { 0x00, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
222                                       0x81, 0x82, 0x83 };
223
224     BarPacket::createAfter(packet, data);
225     BOOST_REQUIRE( packet.next() );
226     BOOST_REQUIRE( packet.next().is<BarPacket>() );
227     BOOST_CHECK( packet.last().is<FooPacket>() );
228     BOOST_CHECK_EQUAL( packet.last().rfind<BarPacket>()->type(), 1u );
229     BOOST_CHECK_EQUAL( packet.next().size(), 11u );
230     BOOST_REQUIRE( packet.next().next() );
231     BOOST_CHECK( packet.next().next().is<FooPacket>() );
232     BOOST_CHECK( ! packet.next().next().next(senf::nothrow) );
233     BOOST_CHECK_EQUAL( packet.next().next().data()[0], 0x81u );
234
235     BOOST_CHECK( packet.first().find<FooPacket>() == packet );
236     BOOST_CHECK( packet.last().rfind<BarPacket>() == packet.last().prev() );
237     BOOST_CHECK( packet.find<FooPacket>() == packet );
238     BOOST_CHECK( packet.last().rfind<FooPacket>() == packet.last() );
239     BOOST_CHECK( packet.next<BarPacket>() == packet.next() );
240     BOOST_CHECK( packet.last().prev().prev<FooPacket>() == packet );
241
242     senf::DataPacket::createAfter(packet);
243     BOOST_CHECK_THROW( packet.next().next().next().parseNextAs<BarPacket>(),
244             senf::InvalidPacketChainException );
245
246     SENF_CHECK_NO_THROW( BarPacket::create(senf::noinit).dump(s));
247 }
248
249 SENF_AUTO_UNIT_TEST(concretePacket)
250 {
251     senf::PacketData::byte data[] = { 0x01, 0x02, 0x03, 0x04, 0x05, 0x06 };
252
253     BOOST_CHECK_EQUAL( FooPacket::create().size(), 4u );
254     BOOST_CHECK_EQUAL( FooPacket::create(senf::noinit).size(), 0u );
255     BOOST_CHECK_THROW( FooPacket::create(2u), senf::TruncatedPacketException );
256     // No 'u' suffix here to check, that the disable_if works ...
257     BOOST_CHECK_EQUAL( FooPacket::create(10).size(), 10u );
258     BOOST_CHECK_EQUAL( FooPacket::create(2u,senf::noinit).size(), 2u );
259     BOOST_CHECK_EQUAL( FooPacket::create(data).size(), 6u );
260
261     senf::Packet packet (FooPacket::create());
262
263     BOOST_CHECK_EQUAL( FooPacket::createAfter(packet).size(), 4u );
264     BOOST_CHECK_EQUAL( packet.size(), 8u );
265
266     BOOST_CHECK_EQUAL( FooPacket::createAfter(packet,senf::noinit).size(), 0u );
267     BOOST_CHECK_EQUAL( packet.size(), 4u );
268
269     BOOST_CHECK_THROW( FooPacket::createAfter(packet,2u), senf::TruncatedPacketException );
270     // No 'u' suffix here to check, that the disable_if works ...
271     BOOST_CHECK_EQUAL( FooPacket::createAfter(packet,10).size(), 10u );
272     BOOST_CHECK_EQUAL( packet.size(), 14u );
273
274     BOOST_CHECK_EQUAL( FooPacket::createAfter(packet,2u,senf::noinit).size(), 2u );
275     BOOST_CHECK_EQUAL( packet.size(), 6u );
276
277     BOOST_CHECK_EQUAL( FooPacket::createAfter(packet,data).size(), 6u );
278     BOOST_CHECK_EQUAL( packet.size(), 10u );
279
280     BOOST_CHECK_EQUAL( FooPacket::createBefore(packet).size(), 14u );
281     BOOST_CHECK_EQUAL( packet.size(), 10u );
282
283     BOOST_CHECK_EQUAL( FooPacket::createBefore(packet,senf::noinit).size(), 10u );
284     BOOST_CHECK_EQUAL( packet.size(), 10u );
285
286     BOOST_CHECK_EQUAL( FooPacket::createInsertBefore(packet).size(), 14u );
287     BOOST_CHECK_EQUAL( packet.size(), 10u );
288     BOOST_REQUIRE( packet.prev() );
289     BOOST_CHECK_EQUAL( packet.prev().size(), 14u );
290     BOOST_REQUIRE( packet.prev().prev() );
291     BOOST_CHECK_EQUAL( packet.prev().prev().size(), 14u );
292
293     BOOST_CHECK_EQUAL( FooPacket::createInsertBefore(packet,senf::noinit).size(), 10u );
294     BOOST_CHECK_EQUAL( packet.size(), 10u );
295     BOOST_REQUIRE_NO_THROW( packet.prev().prev().prev() );
296     BOOST_CHECK_THROW( packet.prev().prev().prev().prev(), senf::InvalidPacketChainException );
297     BOOST_CHECK_EQUAL( packet.prev().size(), 10u );
298     BOOST_CHECK_EQUAL( packet.prev().prev().size(), 14u );
299     BOOST_CHECK_EQUAL( packet.prev().prev().prev().size(), 14u );
300
301     SENF_CHECK_NOT_EQUAL( packet.clone(), packet );
302     BOOST_CHECK_EQUAL( BarPacket::create()->reserved(), 0xA0A0u );
303 }
304
305 SENF_AUTO_UNIT_TEST(packetAssign)
306 {
307     BarPacket bar1 (BarPacket::create());
308     BarPacket bar2 (BarPacket::create());
309
310     bar2->type() << 0x2A2Bu;
311     bar1.parser() << bar2;
312
313     BOOST_CHECK_EQUAL( bar1->type(), 0x2A2Bu );
314 }
315
316 SENF_AUTO_UNIT_TEST(packetAnnotation)
317 {
318     senf::Packet packet (FooPacket::create());
319     BarPacket::createAfter(packet);
320
321     ComplexAnnotation & ca (packet.annotation<ComplexAnnotation>());
322     ca.s = "dead beef";
323     ca.i = 0x12345678;
324     SENF_CHECK_NO_THROW( packet.annotation<IntAnnotation>().value = 0xDEADBEEF );
325
326     senf::Packet p2 (packet.next());
327
328     BOOST_CHECK_EQUAL( p2.annotation<IntAnnotation>().value, 0xDEADBEEFu );
329     BOOST_CHECK_EQUAL( p2.annotation<ComplexAnnotation>().s, "dead beef" );
330     BOOST_CHECK_EQUAL( p2.annotation<ComplexAnnotation>().i, 0x12345678 );
331
332     BOOST_CHECK( senf::detail::AnnotationIndexer<IntAnnotation>::Small );
333     BOOST_CHECK( ! senf::detail::AnnotationIndexer<LargeAnnotation>::Small );
334     BOOST_CHECK( ! senf::detail::AnnotationIndexer<ComplexAnnotation>::Small );
335     BOOST_CHECK( ! senf::detail::AnnotationIndexer<ComplexEmptyAnnotation>::Small );
336 }
337
338 #ifdef COMPILE_CHECK
339
340 COMPILE_FAIL(invalidAnnotation)
341 {
342 #if 0 // The traits check fails for user defined but trivial constructors so ...
343 #   ifdef BOOST_HAS_TYPE_TRAITS_INTRINSICS
344
345     senf::Packet packet (FooPacket::create());
346     senf::IGNORE( packet.annotation<InvalidAnnotation>() );
347
348 #   else
349 #   endif
350 #endif
351
352     invalid_annotation_check_disabled();
353
354 }
355
356 #endif
357
358 ///////////////////////////////cc.e////////////////////////////////////////
359 #undef prefix_
360
361 \f
362 // Local Variables:
363 // mode: c++
364 // fill-column: 100
365 // c-file-style: "senf"
366 // indent-tabs-mode: nil
367 // ispell-local-dictionary: "american"
368 // compile-command: "scons -u test"
369 // comment-column: 40
370 // End: