Alexander Afanasyev | c169a81 | 2014-05-20 20:37:29 -0400 | [diff] [blame] | 1 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */ |
Davide Pesavento | 8a8c01b | 2018-03-11 00:07:52 -0500 | [diff] [blame] | 2 | /* |
Davide Pesavento | 152ef44 | 2023-04-22 02:02:29 -0400 | [diff] [blame^] | 3 | * Copyright (c) 2013-2023 Regents of the University of California. |
Alexander Afanasyev | dfa52c4 | 2014-04-24 21:10:11 -0700 | [diff] [blame] | 4 | * |
| 5 | * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions). |
Alexander Afanasyev | dfa52c4 | 2014-04-24 21:10:11 -0700 | [diff] [blame] | 6 | * |
Alexander Afanasyev | c169a81 | 2014-05-20 20:37:29 -0400 | [diff] [blame] | 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. |
Junxiao Shi | af8eeea | 2014-03-31 20:10:56 -0700 | [diff] [blame] | 20 | */ |
| 21 | |
Davide Pesavento | 7e78064 | 2018-11-24 15:51:34 -0500 | [diff] [blame] | 22 | #include "ndn-cxx/key-locator.hpp" |
| 23 | #include "ndn-cxx/encoding/block-helpers.hpp" |
Junxiao Shi | af8eeea | 2014-03-31 20:10:56 -0700 | [diff] [blame] | 24 | |
Davide Pesavento | 7e78064 | 2018-11-24 15:51:34 -0500 | [diff] [blame] | 25 | #include "tests/boost-test.hpp" |
Davide Pesavento | 152ef44 | 2023-04-22 02:02:29 -0400 | [diff] [blame^] | 26 | |
Alexander Afanasyev | 5f1820e | 2017-01-04 18:12:42 -0800 | [diff] [blame] | 27 | #include <boost/lexical_cast.hpp> |
Junxiao Shi | af8eeea | 2014-03-31 20:10:56 -0700 | [diff] [blame] | 28 | |
| 29 | namespace ndn { |
Spyridon Mastorakis | 429634f | 2015-02-19 17:35:33 -0800 | [diff] [blame] | 30 | namespace tests { |
Junxiao Shi | af8eeea | 2014-03-31 20:10:56 -0700 | [diff] [blame] | 31 | |
Davide Pesavento | 152ef44 | 2023-04-22 02:02:29 -0400 | [diff] [blame^] | 32 | BOOST_CONCEPT_ASSERT((boost::EqualityComparable<KeyLocator>)); |
| 33 | BOOST_CONCEPT_ASSERT((WireEncodable<KeyLocator>)); |
| 34 | BOOST_CONCEPT_ASSERT((WireEncodableWithEncodingBuffer<KeyLocator>)); |
| 35 | BOOST_CONCEPT_ASSERT((WireDecodable<KeyLocator>)); |
| 36 | static_assert(std::is_convertible_v<KeyLocator::Error*, tlv::Error*>, |
| 37 | "KeyLocator::Error must inherit from tlv::Error"); |
| 38 | |
Junxiao Shi | af8eeea | 2014-03-31 20:10:56 -0700 | [diff] [blame] | 39 | BOOST_AUTO_TEST_SUITE(TestKeyLocator) |
| 40 | |
Junxiao Shi | bc5030d | 2014-09-01 11:53:12 -0700 | [diff] [blame] | 41 | BOOST_AUTO_TEST_CASE(TypeNone) |
| 42 | { |
| 43 | KeyLocator a; |
Davide Pesavento | 5149350 | 2019-07-17 02:26:44 -0400 | [diff] [blame] | 44 | BOOST_CHECK_EQUAL(a.empty(), true); |
| 45 | BOOST_CHECK_EQUAL(a.getType(), tlv::Invalid); |
Junxiao Shi | bc5030d | 2014-09-01 11:53:12 -0700 | [diff] [blame] | 46 | BOOST_CHECK_THROW(a.getName(), KeyLocator::Error); |
| 47 | BOOST_CHECK_THROW(a.getKeyDigest(), KeyLocator::Error); |
| 48 | |
Davide Pesavento | 5149350 | 2019-07-17 02:26:44 -0400 | [diff] [blame] | 49 | Block wire = a.wireEncode(); |
| 50 | // These octets are obtained from the snippet below. |
Junxiao Shi | bc5030d | 2014-09-01 11:53:12 -0700 | [diff] [blame] | 51 | // This check is intended to detect unexpected encoding change in the future. |
Davide Pesavento | 8a8c01b | 2018-03-11 00:07:52 -0500 | [diff] [blame] | 52 | // for (auto it = wire.begin(); it != wire.end(); ++it) { |
Junxiao Shi | bc5030d | 2014-09-01 11:53:12 -0700 | [diff] [blame] | 53 | // printf("0x%02x, ", *it); |
| 54 | // } |
| 55 | static const uint8_t expected[] = { |
| 56 | 0x1c, 0x00 |
| 57 | }; |
| 58 | BOOST_CHECK_EQUAL_COLLECTIONS(expected, expected + sizeof(expected), |
| 59 | wire.begin(), wire.end()); |
| 60 | |
Junxiao Shi | bc5030d | 2014-09-01 11:53:12 -0700 | [diff] [blame] | 61 | KeyLocator b(wire); |
Junxiao Shi | 72c0c64 | 2018-04-20 15:41:09 +0000 | [diff] [blame] | 62 | BOOST_CHECK_EQUAL(a, b); |
Davide Pesavento | 5149350 | 2019-07-17 02:26:44 -0400 | [diff] [blame] | 63 | BOOST_CHECK_EQUAL(a.empty(), true); |
| 64 | BOOST_CHECK_EQUAL(b.getType(), tlv::Invalid); |
Junxiao Shi | bc5030d | 2014-09-01 11:53:12 -0700 | [diff] [blame] | 65 | BOOST_CHECK_THROW(b.getName(), KeyLocator::Error); |
| 66 | BOOST_CHECK_THROW(b.getKeyDigest(), KeyLocator::Error); |
Alexander Afanasyev | 5f1820e | 2017-01-04 18:12:42 -0800 | [diff] [blame] | 67 | BOOST_CHECK_EQUAL(boost::lexical_cast<std::string>(b), "None"); |
Junxiao Shi | bc5030d | 2014-09-01 11:53:12 -0700 | [diff] [blame] | 68 | } |
| 69 | |
| 70 | BOOST_AUTO_TEST_CASE(TypeName) |
| 71 | { |
| 72 | KeyLocator a; |
| 73 | a.setName("/N"); |
Davide Pesavento | 5149350 | 2019-07-17 02:26:44 -0400 | [diff] [blame] | 74 | BOOST_CHECK_EQUAL(a.empty(), false); |
| 75 | BOOST_CHECK_EQUAL(a.getType(), tlv::Name); |
Junxiao Shi | bc5030d | 2014-09-01 11:53:12 -0700 | [diff] [blame] | 76 | BOOST_CHECK_EQUAL(a.getName(), Name("/N")); |
| 77 | BOOST_CHECK_THROW(a.getKeyDigest(), KeyLocator::Error); |
| 78 | |
Davide Pesavento | 5149350 | 2019-07-17 02:26:44 -0400 | [diff] [blame] | 79 | Block wire = a.wireEncode(); |
| 80 | // These octets are obtained from the snippet below. |
Junxiao Shi | bc5030d | 2014-09-01 11:53:12 -0700 | [diff] [blame] | 81 | // This check is intended to detect unexpected encoding change in the future. |
Davide Pesavento | 8a8c01b | 2018-03-11 00:07:52 -0500 | [diff] [blame] | 82 | // for (auto it = wire.begin(); it != wire.end(); ++it) { |
Junxiao Shi | bc5030d | 2014-09-01 11:53:12 -0700 | [diff] [blame] | 83 | // printf("0x%02x, ", *it); |
| 84 | // } |
| 85 | static const uint8_t expected[] = { |
| 86 | 0x1c, 0x05, 0x07, 0x03, 0x08, 0x01, 0x4e |
| 87 | }; |
| 88 | BOOST_CHECK_EQUAL_COLLECTIONS(expected, expected + sizeof(expected), |
| 89 | wire.begin(), wire.end()); |
| 90 | |
Junxiao Shi | bc5030d | 2014-09-01 11:53:12 -0700 | [diff] [blame] | 91 | KeyLocator b(wire); |
Junxiao Shi | 72c0c64 | 2018-04-20 15:41:09 +0000 | [diff] [blame] | 92 | BOOST_CHECK_EQUAL(a, b); |
Davide Pesavento | 5149350 | 2019-07-17 02:26:44 -0400 | [diff] [blame] | 93 | BOOST_CHECK_EQUAL(b.getType(), tlv::Name); |
Junxiao Shi | bc5030d | 2014-09-01 11:53:12 -0700 | [diff] [blame] | 94 | BOOST_CHECK_EQUAL(b.getName(), Name("/N")); |
| 95 | BOOST_CHECK_THROW(b.getKeyDigest(), KeyLocator::Error); |
Alexander Afanasyev | 5f1820e | 2017-01-04 18:12:42 -0800 | [diff] [blame] | 96 | BOOST_CHECK_EQUAL(boost::lexical_cast<std::string>(b), "Name=/N"); |
Davide Pesavento | 5149350 | 2019-07-17 02:26:44 -0400 | [diff] [blame] | 97 | |
| 98 | KeyLocator c("/N"); |
| 99 | BOOST_CHECK_EQUAL(a, c); |
Junxiao Shi | bc5030d | 2014-09-01 11:53:12 -0700 | [diff] [blame] | 100 | } |
| 101 | |
| 102 | BOOST_AUTO_TEST_CASE(TypeKeyDigest) |
| 103 | { |
Davide Pesavento | 765abc9 | 2021-12-27 00:44:04 -0500 | [diff] [blame] | 104 | static const uint8_t digestOctets[] = { |
| 105 | 0x12, 0x34, 0x56, 0x78, 0x9a, 0xbc, 0xde, 0xf1, 0x23, 0x45 |
| 106 | }; |
| 107 | ConstBufferPtr digestBuffer = std::make_shared<Buffer>(digestOctets, sizeof(digestOctets)); |
| 108 | Block expectedDigestBlock = makeBinaryBlock(tlv::KeyDigest, digestOctets); |
Junxiao Shi | bc5030d | 2014-09-01 11:53:12 -0700 | [diff] [blame] | 109 | |
| 110 | KeyLocator a; |
| 111 | a.setKeyDigest(digestBuffer); |
Davide Pesavento | 5149350 | 2019-07-17 02:26:44 -0400 | [diff] [blame] | 112 | BOOST_CHECK_EQUAL(a.empty(), false); |
| 113 | BOOST_CHECK_EQUAL(a.getType(), tlv::KeyDigest); |
Junxiao Shi | 72c0c64 | 2018-04-20 15:41:09 +0000 | [diff] [blame] | 114 | BOOST_CHECK_EQUAL(a.getKeyDigest(), expectedDigestBlock); |
Junxiao Shi | bc5030d | 2014-09-01 11:53:12 -0700 | [diff] [blame] | 115 | BOOST_CHECK_THROW(a.getName(), KeyLocator::Error); |
| 116 | |
Davide Pesavento | 5149350 | 2019-07-17 02:26:44 -0400 | [diff] [blame] | 117 | Block wire = a.wireEncode(); |
| 118 | // These octets are obtained from the snippet below. |
Junxiao Shi | bc5030d | 2014-09-01 11:53:12 -0700 | [diff] [blame] | 119 | // This check is intended to detect unexpected encoding change in the future. |
Davide Pesavento | 8a8c01b | 2018-03-11 00:07:52 -0500 | [diff] [blame] | 120 | // for (auto it = wire.begin(); it != wire.end(); ++it) { |
Junxiao Shi | bc5030d | 2014-09-01 11:53:12 -0700 | [diff] [blame] | 121 | // printf("0x%02x, ", *it); |
| 122 | // } |
| 123 | static const uint8_t expected[] = { |
Alexander Afanasyev | 5f1820e | 2017-01-04 18:12:42 -0800 | [diff] [blame] | 124 | 0x1c, 0x0c, 0x1d, 0x0a, 0x12, 0x34, 0x56, 0x78, 0x9a, 0xbc, 0xde, 0xf1, 0x23, 0x45 |
Junxiao Shi | bc5030d | 2014-09-01 11:53:12 -0700 | [diff] [blame] | 125 | }; |
| 126 | BOOST_CHECK_EQUAL_COLLECTIONS(expected, expected + sizeof(expected), |
| 127 | wire.begin(), wire.end()); |
| 128 | |
Junxiao Shi | bc5030d | 2014-09-01 11:53:12 -0700 | [diff] [blame] | 129 | KeyLocator b(wire); |
Junxiao Shi | 72c0c64 | 2018-04-20 15:41:09 +0000 | [diff] [blame] | 130 | BOOST_CHECK_EQUAL(a, b); |
Davide Pesavento | 5149350 | 2019-07-17 02:26:44 -0400 | [diff] [blame] | 131 | BOOST_CHECK_EQUAL(b.getType(), tlv::KeyDigest); |
Junxiao Shi | 72c0c64 | 2018-04-20 15:41:09 +0000 | [diff] [blame] | 132 | BOOST_CHECK_EQUAL(b.getKeyDigest(), expectedDigestBlock); |
Junxiao Shi | bc5030d | 2014-09-01 11:53:12 -0700 | [diff] [blame] | 133 | BOOST_CHECK_THROW(b.getName(), KeyLocator::Error); |
Davide Pesavento | dd0724b | 2022-04-18 00:30:05 -0400 | [diff] [blame] | 134 | BOOST_CHECK_EQUAL(boost::lexical_cast<std::string>(b), "KeyDigest=123456789ABCDEF1..."); |
Alexander Afanasyev | 5f1820e | 2017-01-04 18:12:42 -0800 | [diff] [blame] | 135 | |
Davide Pesavento | dd0724b | 2022-04-18 00:30:05 -0400 | [diff] [blame] | 136 | b.setKeyDigest("1D050123456789"_block); |
Davide Pesavento | 5149350 | 2019-07-17 02:26:44 -0400 | [diff] [blame] | 137 | BOOST_CHECK_EQUAL(b.getType(), tlv::KeyDigest); |
Davide Pesavento | dd0724b | 2022-04-18 00:30:05 -0400 | [diff] [blame] | 138 | BOOST_CHECK_EQUAL(b.getKeyDigest(), "1D050123456789"_block); |
Davide Pesavento | 5149350 | 2019-07-17 02:26:44 -0400 | [diff] [blame] | 139 | BOOST_CHECK_THROW(b.getName(), KeyLocator::Error); |
Davide Pesavento | dd0724b | 2022-04-18 00:30:05 -0400 | [diff] [blame] | 140 | BOOST_CHECK_EQUAL(boost::lexical_cast<std::string>(b), "KeyDigest=0123456789"); |
Junxiao Shi | bc5030d | 2014-09-01 11:53:12 -0700 | [diff] [blame] | 141 | } |
| 142 | |
Davide Pesavento | 5149350 | 2019-07-17 02:26:44 -0400 | [diff] [blame] | 143 | BOOST_AUTO_TEST_CASE(TypeUnknown) |
| 144 | { |
| 145 | const auto wire = "1C037F01CC"_block; |
| 146 | KeyLocator a(wire); |
| 147 | BOOST_CHECK_EQUAL(a.empty(), false); |
| 148 | BOOST_CHECK_EQUAL(a.getType(), 127); |
| 149 | |
| 150 | KeyLocator b(wire); |
| 151 | BOOST_CHECK_EQUAL(a, b); |
| 152 | BOOST_CHECK_EQUAL(b.getType(), 127); |
| 153 | BOOST_CHECK_EQUAL(boost::lexical_cast<std::string>(b), "Unknown(127)"); |
| 154 | |
| 155 | b.setName("/N"); |
| 156 | BOOST_CHECK_NE(a, b); |
| 157 | } |
| 158 | |
| 159 | BOOST_AUTO_TEST_CASE(Clear) |
| 160 | { |
| 161 | KeyLocator a("/foo"); |
| 162 | BOOST_CHECK_EQUAL(a.empty(), false); |
| 163 | |
| 164 | a.clear(); |
| 165 | BOOST_CHECK_EQUAL(a.empty(), true); |
| 166 | BOOST_CHECK_EQUAL(a.getType(), tlv::Invalid); |
| 167 | BOOST_CHECK_EQUAL(a, KeyLocator{}); |
| 168 | } |
| 169 | |
Junxiao Shi | af8eeea | 2014-03-31 20:10:56 -0700 | [diff] [blame] | 170 | BOOST_AUTO_TEST_CASE(Equality) |
| 171 | { |
Junxiao Shi | af8eeea | 2014-03-31 20:10:56 -0700 | [diff] [blame] | 172 | KeyLocator a; |
| 173 | KeyLocator b; |
| 174 | BOOST_CHECK_EQUAL(a == b, true); |
| 175 | BOOST_CHECK_EQUAL(a != b, false); |
| 176 | |
| 177 | a.setName("ndn:/A"); |
| 178 | BOOST_CHECK_EQUAL(a == b, false); |
| 179 | BOOST_CHECK_EQUAL(a != b, true); |
| 180 | |
| 181 | b.setName("ndn:/B"); |
| 182 | BOOST_CHECK_EQUAL(a == b, false); |
| 183 | BOOST_CHECK_EQUAL(a != b, true); |
| 184 | |
| 185 | b.setName("ndn:/A"); |
| 186 | BOOST_CHECK_EQUAL(a == b, true); |
| 187 | BOOST_CHECK_EQUAL(a != b, false); |
Junxiao Shi | bc5030d | 2014-09-01 11:53:12 -0700 | [diff] [blame] | 188 | |
Davide Pesavento | dd0724b | 2022-04-18 00:30:05 -0400 | [diff] [blame] | 189 | const uint8_t digestOctets[] = "\xDD\xDD\xDD\xDD\xDD\xDD\xDD\xDD"; |
| 190 | auto digestBuffer = std::make_shared<Buffer>(digestOctets, sizeof(digestOctets) - 1); |
Junxiao Shi | bc5030d | 2014-09-01 11:53:12 -0700 | [diff] [blame] | 191 | |
| 192 | a.setKeyDigest(digestBuffer); |
| 193 | BOOST_CHECK_EQUAL(a == b, false); |
| 194 | BOOST_CHECK_EQUAL(a != b, true); |
| 195 | |
| 196 | b.setKeyDigest(digestBuffer); |
| 197 | BOOST_CHECK_EQUAL(a == b, true); |
| 198 | BOOST_CHECK_EQUAL(a != b, false); |
| 199 | } |
| 200 | |
Davide Pesavento | eee3e82 | 2016-11-26 19:19:34 +0100 | [diff] [blame] | 201 | BOOST_AUTO_TEST_SUITE_END() // TestKeyLocator |
Junxiao Shi | af8eeea | 2014-03-31 20:10:56 -0700 | [diff] [blame] | 202 | |
Spyridon Mastorakis | 429634f | 2015-02-19 17:35:33 -0800 | [diff] [blame] | 203 | } // namespace tests |
Junxiao Shi | af8eeea | 2014-03-31 20:10:56 -0700 | [diff] [blame] | 204 | } // namespace ndn |