4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
6 // Stefan Bund <g0dil@berlios.de>
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.
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.
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.
24 \brief Packet unit tests */
26 //#include "Packet.test.hh"
27 //#include "Packet.test.ih"
31 #include <boost/static_assert.hpp>
34 #include <senf/Utils/auto_unit_test.hh>
35 #include <boost/test/test_tools.hpp>
38 ///////////////////////////////cc.p////////////////////////////////////////
43 typedef unsigned key_t;
47 : public senf::PacketTypeBase,
48 public senf::PacketTypeMixin<FooPacketType>
50 using senf::PacketTypeMixin<FooPacketType>::nextPacketRange;
51 using senf::PacketTypeMixin<FooPacketType>::initSize;
52 using senf::PacketTypeMixin<FooPacketType>::init;
53 static size_type initSize()
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
60 static size_type initHeadSize()
61 { return initSize(); }
63 typedef senf::ConcretePacket<FooPacketType> FooPacket;
65 struct BarPacketParser : public senf::PacketParserBase
67 # include SENF_FIXED_PARSER()
69 SENF_PARSER_FIELD( type, senf::UInt16Parser );
70 SENF_PARSER_FIELD( length, senf::Int32Parser );
71 SENF_PARSER_FIELD( reserved, senf::UInt16Parser );
74 reserved() << 0xA0A0u;
77 SENF_PARSER_FINALIZE(BarPacketParser);
81 : public senf::PacketTypeBase,
82 public senf::PacketTypeMixin<BarPacketType,RegTag>
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;
91 static void dump(packet p, std::ostream & os) {
93 << senf::fieldName("type") << p->type() << "\n"
94 << senf::fieldName("length") << p->length() << "\n";
96 static void finalize(packet p) {
97 if (p.next(senf::nothrow))
98 p->type() = senf::PacketRegistry<RegTag>::key(p.next());
102 static key_t nextPacketKey(packet p) {
106 typedef BarPacketType::packet BarPacket;
109 senf::PacketRegistry<RegTag>::ScopedRegistrationProxy<FooPacket> registerFoo(1u);
110 senf::PacketRegistry<RegTag>::ScopedRegistrationProxy<BarPacket> registerBar(2u);
113 struct IntAnnotation {
117 std::ostream & operator<<(std::ostream & os, IntAnnotation const & v)
118 { os << v.value; return os; }
120 struct LargeAnnotation {
124 std::ostream & operator<<(std::ostream & os, LargeAnnotation const & v)
125 { os << v.value; return os; }
127 struct ComplexAnnotation : senf::ComplexAnnotation
129 ComplexAnnotation() : s(), i() {}
134 std::ostream & operator<<(std::ostream & os, ComplexAnnotation const & v)
135 { os << "('" << v.s << "' " << v.i << ')'; return os; }
137 struct ComplexEmptyAnnotation : senf::ComplexAnnotation
140 std::ostream & operator<<(std::ostream & os, ComplexEmptyAnnotation const & v)
141 { os << "(empty)"; return os; }
143 struct InvalidAnnotation
148 std::ostream & operator<<(std::ostream & os, InvalidAnnotation const & v)
149 { os << v.value; return os; }
153 SENF_AUTO_UNIT_TEST(packet)
155 BOOST_CHECK(! senf::Packet().is<BarPacket>() );
156 senf::Packet packet (FooPacket::create());
157 BarPacket::createAfter(packet);
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() );
177 senf::Packet p2 (packet.next());
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>() );
184 BOOST_CHECK( packet.next().as<FooPacket>() );
186 p2 = packet.next().clone();
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 );
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>() );
201 BOOST_CHECK_EQUAL( s.str(),
203 " (anonymous namespace)::IntAnnotation : 0\n"
208 packet.finalizeAll();
209 BOOST_CHECK_EQUAL( packet.last().as<BarPacket>()->type(),
210 BarPacket::Parser::type_t::value_type(-1) );
211 packet.last().append(FooPacket::create());
212 packet.finalizeThis();
213 packet.finalizeTo<BarPacket>();
214 packet.finalizeTo(packet.find<BarPacket>());
215 packet.finalizeAll();
216 BOOST_CHECK_EQUAL( packet.find<BarPacket>()->type(), 1u );
218 BOOST_CHECK( packet.factory() == FooPacket::factory() );
220 senf::PacketData::byte data[] = { 0x00, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
223 BarPacket::createAfter(packet, data);
224 BOOST_REQUIRE( packet.next() );
225 BOOST_REQUIRE( packet.next().is<BarPacket>() );
226 BOOST_CHECK( packet.last().is<FooPacket>() );
227 BOOST_CHECK_EQUAL( packet.last().rfind<BarPacket>()->type(), 1u );
228 BOOST_CHECK_EQUAL( packet.next().size(), 11u );
229 BOOST_REQUIRE( packet.next().next() );
230 BOOST_CHECK( packet.next().next().is<FooPacket>() );
231 BOOST_CHECK( ! packet.next().next().next(senf::nothrow) );
232 BOOST_CHECK_EQUAL( packet.next().next().data()[0], 0x81u );
234 BOOST_CHECK( packet.first().find<FooPacket>() == packet );
235 BOOST_CHECK( packet.last().rfind<BarPacket>() == packet.last().prev() );
236 BOOST_CHECK( packet.find<FooPacket>() == packet );
237 BOOST_CHECK( packet.last().rfind<FooPacket>() == packet.last() );
238 BOOST_CHECK( packet.next<BarPacket>() == packet.next() );
239 BOOST_CHECK( packet.last().prev().prev<FooPacket>() == packet );
241 senf::DataPacket::createAfter(packet);
242 BOOST_CHECK_THROW( packet.next().next().next().parseNextAs<BarPacket>(),
243 senf::InvalidPacketChainException );
245 SENF_CHECK_NO_THROW( BarPacket::create(senf::noinit).dump(s));
248 SENF_AUTO_UNIT_TEST(concretePacket)
250 senf::PacketData::byte data[] = { 0x01, 0x02, 0x03, 0x04, 0x05, 0x06 };
252 BOOST_CHECK_EQUAL( FooPacket::create().size(), 4u );
253 BOOST_CHECK_EQUAL( FooPacket::create(senf::noinit).size(), 0u );
254 BOOST_CHECK_THROW( FooPacket::create(2u), senf::TruncatedPacketException );
255 // No 'u' suffix here to check, that the disable_if works ...
256 BOOST_CHECK_EQUAL( FooPacket::create(10).size(), 10u );
257 BOOST_CHECK_EQUAL( FooPacket::create(2u,senf::noinit).size(), 2u );
258 BOOST_CHECK_EQUAL( FooPacket::create(data).size(), 6u );
260 senf::Packet packet (FooPacket::create());
262 BOOST_CHECK_EQUAL( FooPacket::createAfter(packet).size(), 4u );
263 BOOST_CHECK_EQUAL( packet.size(), 8u );
265 BOOST_CHECK_EQUAL( FooPacket::createAfter(packet,senf::noinit).size(), 0u );
266 BOOST_CHECK_EQUAL( packet.size(), 4u );
268 BOOST_CHECK_THROW( FooPacket::createAfter(packet,2u), senf::TruncatedPacketException );
269 // No 'u' suffix here to check, that the disable_if works ...
270 BOOST_CHECK_EQUAL( FooPacket::createAfter(packet,10).size(), 10u );
271 BOOST_CHECK_EQUAL( packet.size(), 14u );
273 BOOST_CHECK_EQUAL( FooPacket::createAfter(packet,2u,senf::noinit).size(), 2u );
274 BOOST_CHECK_EQUAL( packet.size(), 6u );
276 BOOST_CHECK_EQUAL( FooPacket::createAfter(packet,data).size(), 6u );
277 BOOST_CHECK_EQUAL( packet.size(), 10u );
279 BOOST_CHECK_EQUAL( FooPacket::createBefore(packet).size(), 14u );
280 BOOST_CHECK_EQUAL( packet.size(), 10u );
282 BOOST_CHECK_EQUAL( FooPacket::createBefore(packet,senf::noinit).size(), 10u );
283 BOOST_CHECK_EQUAL( packet.size(), 10u );
285 BOOST_CHECK_EQUAL( FooPacket::createInsertBefore(packet).size(), 14u );
286 BOOST_CHECK_EQUAL( packet.size(), 10u );
287 BOOST_REQUIRE( packet.prev() );
288 BOOST_CHECK_EQUAL( packet.prev().size(), 14u );
289 BOOST_REQUIRE( packet.prev().prev() );
290 BOOST_CHECK_EQUAL( packet.prev().prev().size(), 14u );
292 BOOST_CHECK_EQUAL( FooPacket::createInsertBefore(packet,senf::noinit).size(), 10u );
293 BOOST_CHECK_EQUAL( packet.size(), 10u );
294 BOOST_REQUIRE_NO_THROW( packet.prev().prev().prev() );
295 BOOST_CHECK_THROW( packet.prev().prev().prev().prev(), senf::InvalidPacketChainException );
296 BOOST_CHECK_EQUAL( packet.prev().size(), 10u );
297 BOOST_CHECK_EQUAL( packet.prev().prev().size(), 14u );
298 BOOST_CHECK_EQUAL( packet.prev().prev().prev().size(), 14u );
300 SENF_CHECK_NOT_EQUAL( packet.clone(), packet );
301 BOOST_CHECK_EQUAL( BarPacket::create()->reserved(), 0xA0A0u );
304 SENF_AUTO_UNIT_TEST(packetAssign)
306 BarPacket bar1 (BarPacket::create());
307 BarPacket bar2 (BarPacket::create());
309 bar2->type() << 0x2A2Bu;
310 bar1.parser() << bar2;
312 BOOST_CHECK_EQUAL( bar1->type(), 0x2A2Bu );
315 SENF_AUTO_UNIT_TEST(packetAnnotation)
317 typedef senf::detail::AnnotationRegistry Reg;
319 senf::Packet packet (FooPacket::create());
320 BarPacket::createAfter(packet);
322 ComplexAnnotation & ca (packet.annotation<ComplexAnnotation>());
325 SENF_CHECK_NO_THROW( packet.annotation<IntAnnotation>().value = 0xDEADBEEF );
327 senf::Packet p2 (packet.next());
329 BOOST_CHECK_EQUAL( p2.annotation<IntAnnotation>().value, 0xDEADBEEFu );
330 BOOST_CHECK_EQUAL( p2.annotation<ComplexAnnotation>().s, "dead beef" );
331 BOOST_CHECK_EQUAL( p2.annotation<ComplexAnnotation>().i, 0x12345678 );
333 BOOST_CHECK( Reg::lookup<IntAnnotation>() >= 0 );
334 BOOST_CHECK( Reg::lookup<LargeAnnotation>() < 0 );
335 BOOST_CHECK( Reg::lookup<ComplexAnnotation>() < 0 );
336 BOOST_CHECK( Reg::lookup<ComplexEmptyAnnotation>() < 0 );
338 std::stringstream ss;
340 senf::dumpPacketAnnotationRegistry(ss);
343 "SENF_PACKET_ANNOTATION_SLOTS = 8\n"
344 "SENF_PACKET_ANNOTATION_SLOTSIZE = 16\n"
345 "SLOT TYPE COMPLEX SIZE\n"
346 " (anonymous namespace)::ComplexEmptyAnnotation yes 1\n"
347 " (anonymous namespace)::ComplexAnnotation yes 8\n"
348 " (anonymous namespace)::LargeAnnotation no 32\n"
349 " 0 (anonymous namespace)::IntAnnotation no 4\n" );
354 COMPILE_FAIL(invalidAnnotation)
356 #if 0 // The traits check fails for user defined but trivial constructors so ...
357 # ifdef BOOST_HAS_TYPE_TRAITS_INTRINSICS
359 senf::Packet packet (FooPacket::create());
360 senf::IGNORE( packet.annotation<InvalidAnnotation>() );
366 invalid_annotation_check_disabled();
372 ///////////////////////////////cc.e////////////////////////////////////////
379 // c-file-style: "senf"
380 // indent-tabs-mode: nil
381 // ispell-local-dictionary: "american"
382 // compile-command: "scons -u test"
383 // comment-column: 40