blob: 7b74f35ae11fdafbf6d772fd468e4205cc2fbcf3 [file] [log] [blame]
Jiewen Tan99135962014-09-20 02:18:53 -07001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
Junxiao Shid701e5b2017-07-26 01:30:41 +00002/*
Davide Pesaventof6b45892023-03-13 15:00:51 -04003 * Copyright (c) 2013-2023 Regents of the University of California.
Jiewen Tan99135962014-09-20 02:18:53 -07004 *
5 * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
6 *
7 * ndn-cxx library is free software: you can redistribute it and/or modify it under the
8 * terms of the GNU Lesser General Public License as published by the Free Software
9 * Foundation, either version 3 of the License, or (at your option) any later version.
10 *
11 * ndn-cxx library is distributed in the hope that it will be useful, but WITHOUT ANY
12 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
13 * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
14 *
15 * You should have received copies of the GNU General Public License and GNU Lesser
16 * General Public License along with ndn-cxx, e.g., in COPYING.md file. If not, see
17 * <http://www.gnu.org/licenses/>.
18 *
19 * See AUTHORS.md for complete list of ndn-cxx authors and contributors.
Spyridon Mastorakis429634f2015-02-19 17:35:33 -080020 */
Jiewen Tan99135962014-09-20 02:18:53 -070021
Davide Pesavento4c1ad4c2020-11-16 21:12:02 -050022#ifndef NDN_CXX_TESTS_TEST_COMMON_HPP
23#define NDN_CXX_TESTS_TEST_COMMON_HPP
Jiewen Tan99135962014-09-20 02:18:53 -070024
Davide Pesavento7e780642018-11-24 15:51:34 -050025#include "ndn-cxx/data.hpp"
26#include "ndn-cxx/interest.hpp"
Davide Pesavento7e780642018-11-24 15:51:34 -050027#include "ndn-cxx/lp/nack.hpp"
Davide Pesavento4c1ad4c2020-11-16 21:12:02 -050028#include "tests/boost-test.hpp"
Jiewen Tan99135962014-09-20 02:18:53 -070029
30namespace ndn {
Junxiao Shi85d90832016-08-04 03:19:46 +000031namespace tests {
Jiewen Tan99135962014-09-20 02:18:53 -070032
Davide Pesavento287a7fa2020-10-01 22:46:43 -040033/**
34 * \brief Create an Interest
Junxiao Shi85d90832016-08-04 03:19:46 +000035 */
36shared_ptr<Interest>
Junxiao Shib55e5d32018-07-18 13:32:00 -060037makeInterest(const Name& name, bool canBePrefix = false,
Davide Pesaventof6b45892023-03-13 15:00:51 -040038 std::optional<time::milliseconds> lifetime = std::nullopt,
39 std::optional<Interest::Nonce> nonce = std::nullopt);
Jiewen Tan99135962014-09-20 02:18:53 -070040
Davide Pesavento287a7fa2020-10-01 22:46:43 -040041/**
42 * \brief Create a Data with a null (i.e., empty) signature
43 *
Davide Pesavento4c1ad4c2020-11-16 21:12:02 -050044 * If a "real" signature is desired, use KeyChainFixture and sign again with `m_keyChain`.
Junxiao Shi85d90832016-08-04 03:19:46 +000045 */
46shared_ptr<Data>
47makeData(const Name& name);
48
Davide Pesavento287a7fa2020-10-01 22:46:43 -040049/**
50 * \brief Add a null signature to \p data
Junxiao Shi85d90832016-08-04 03:19:46 +000051 */
52Data&
53signData(Data& data);
54
Davide Pesavento287a7fa2020-10-01 22:46:43 -040055/**
56 * \brief Add a null signature to \p data
Junxiao Shi85d90832016-08-04 03:19:46 +000057 */
Jiewen Tan99135962014-09-20 02:18:53 -070058inline shared_ptr<Data>
Junxiao Shib1990df2015-11-05 00:14:44 +000059signData(shared_ptr<Data> data)
Jiewen Tan99135962014-09-20 02:18:53 -070060{
Junxiao Shi85d90832016-08-04 03:19:46 +000061 signData(*data);
Jiewen Tan99135962014-09-20 02:18:53 -070062 return data;
63}
64
Davide Pesavento287a7fa2020-10-01 22:46:43 -040065/**
66 * \brief Create a Nack
Junxiao Shi85d90832016-08-04 03:19:46 +000067 */
68lp::Nack
Davide Pesavento53533942020-03-04 23:10:06 -050069makeNack(Interest interest, lp::NackReason reason);
Junxiao Shib1990df2015-11-05 00:14:44 +000070
Davide Pesavento287a7fa2020-10-01 22:46:43 -040071/**
72 * \brief Replace a name component in a packet
Davide Pesaventof6b45892023-03-13 15:00:51 -040073 * \param[in,out] pkt the packet
Davide Pesavento287a7fa2020-10-01 22:46:43 -040074 * \param index the index of the name component to replace
75 * \param args arguments to name::Component constructor
Junxiao Shi198c3812016-08-12 19:24:18 +000076 */
Davide Pesaventoadc9aa22019-06-30 19:00:20 -040077template<typename Packet, typename ...Args>
Junxiao Shi198c3812016-08-12 19:24:18 +000078void
Davide Pesaventoadc9aa22019-06-30 19:00:20 -040079setNameComponent(Packet& pkt, ssize_t index, Args&& ...args)
Junxiao Shi198c3812016-08-12 19:24:18 +000080{
81 Name name = pkt.getName();
Davide Pesaventoadc9aa22019-06-30 19:00:20 -040082 name.set(index, name::Component(std::forward<Args>(args)...));
Junxiao Shi198c3812016-08-12 19:24:18 +000083 pkt.setName(name);
84}
85
Junxiao Shi85d90832016-08-04 03:19:46 +000086} // namespace tests
Jiewen Tan99135962014-09-20 02:18:53 -070087} // namespace ndn
88
Davide Pesavento4c1ad4c2020-11-16 21:12:02 -050089#endif // NDN_CXX_TESTS_TEST_COMMON_HPP