tests/unit/link.t.cpp

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2013-2023 Regents of the University of California.
 *
 * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
 *
 * ndn-cxx library is free software: you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License as published by the Free Software
 * Foundation, either version 3 of the License, or (at your option) any later version.
 *
 * ndn-cxx library is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
 * PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more details.
 *
 * You should have received copies of the GNU General Public License and GNU Lesser
 * General Public License along with ndn-cxx, e.g., in COPYING.md file.  If not, see
 * <http://www.gnu.org/licenses/>.
 *
 * See AUTHORS.md for complete list of ndn-cxx authors and contributors.
 */

#include "ndn-cxx/link.hpp"

#include "tests/test-common.hpp"

namespace ndn::tests {

BOOST_CONCEPT_ASSERT((boost::EqualityComparable<Link>));
BOOST_CONCEPT_ASSERT((WireEncodable<Link>));
BOOST_CONCEPT_ASSERT((WireEncodableWithEncodingBuffer<Link>));
BOOST_CONCEPT_ASSERT((WireDecodable<Link>));
static_assert(std::is_convertible_v<Link::Error*, Data::Error*>,
              "Link::Error should inherit from Data::Error");

BOOST_AUTO_TEST_SUITE(TestLink)

const uint8_t GOOD_LINK[] = {
  0x06, 0xd0, // Data
    0x07, 0x14, // Name
        0x08, 0x05,
            0x6c, 0x6f, 0x63, 0x61, 0x6c,
        0x08, 0x03,
            0x6e, 0x64, 0x6e,
        0x08, 0x06,
            0x70, 0x72, 0x65, 0x66, 0x69, 0x78,
    0x14, 0x07, // MetaInfo
        0x18, 0x01, // ContentType
            0x01,
        0x19, 0x02, // FreshnessPeriod
            0x27, 0x10,
    0x15, 0x10, // Content
        0x07, 0x07, // Name
            0x08, 0x05,
                0x6c, 0x6f, 0x63, 0x61, 0x6c,
        0x07, 0x05, // Name
            0x08, 0x03,
                0x6e, 0x64, 0x6e,
    0x16, 0x1b, // SignatureInfo
        0x1b, 0x01, // SignatureType
            0x01,
        0x1c, 0x16, // KeyLocator
            0x07, 0x14, // Name
                0x08, 0x04,
                    0x74, 0x65, 0x73, 0x74,
                0x08, 0x03,
                    0x6b, 0x65, 0x79,
                0x08, 0x07,
                    0x6c, 0x6f, 0x63, 0x61, 0x74, 0x6f, 0x72,
    0x17, 0x80, // SignatureValue
        0x2f, 0xd6, 0xf1, 0x6e, 0x80, 0x6f, 0x10, 0xbe, 0xb1, 0x6f, 0x3e, 0x31, 0xec,
        0xe3, 0xb9, 0xea, 0x83, 0x30, 0x40, 0x03, 0xfc, 0xa0, 0x13, 0xd9, 0xb3, 0xc6,
        0x25, 0x16, 0x2d, 0xa6, 0x58, 0x41, 0x69, 0x62, 0x56, 0xd8, 0xb3, 0x6a, 0x38,
        0x76, 0x56, 0xea, 0x61, 0xb2, 0x32, 0x70, 0x1c, 0xb6, 0x4d, 0x10, 0x1d, 0xdc,
        0x92, 0x8e, 0x52, 0xa5, 0x8a, 0x1d, 0xd9, 0x96, 0x5e, 0xc0, 0x62, 0x0b, 0xcf,
        0x3a, 0x9d, 0x7f, 0xca, 0xbe, 0xa1, 0x41, 0x71, 0x85, 0x7a, 0x8b, 0x5d, 0xa9,
        0x64, 0xd6, 0x66, 0xb4, 0xe9, 0x8d, 0x0c, 0x28, 0x43, 0xee, 0xa6, 0x64, 0xe8,
        0x55, 0xf6, 0x1c, 0x19, 0x0b, 0xef, 0x99, 0x25, 0x1e, 0xdc, 0x78, 0xb3, 0xa7,
        0xaa, 0x0d, 0x14, 0x58, 0x30, 0xe5, 0x37, 0x6a, 0x6d, 0xdb, 0x56, 0xac, 0xa3,
        0xfc, 0x90, 0x7a, 0xb8, 0x66, 0x9c, 0x0e, 0xf6, 0xb7, 0x64, 0xd1
};

BOOST_AUTO_TEST_SUITE(EncodeDecode)

BOOST_AUTO_TEST_CASE(Decode)
{
  Link link(Block{GOOD_LINK});
  BOOST_TEST(link.getName() == "/local/ndn/prefix");
  BOOST_TEST(link.getDelegationList() == std::vector<Name>({"/local", "/ndn"}),
             boost::test_tools::per_element());
}

BOOST_AUTO_TEST_CASE(DecodeBadContentType)
{
  Data linkData(Block{GOOD_LINK});
  linkData.setContentType(tlv::ContentType_Key);
  Block badLink = linkData.wireEncode();

  BOOST_CHECK_THROW(Link{badLink}, Link::Error);
  Link link;
  BOOST_CHECK_THROW(link.wireDecode(badLink), Link::Error);
}

BOOST_AUTO_TEST_CASE(Encode)
{
  Link link1("/test", {"/test1", "/test2", "/test3"});
  signData(link1);
  BOOST_TEST(link1.getName() == "/test");
  BOOST_TEST(link1.getContentType() == tlv::ContentType_Link);

  Link link2(link1.wireEncode());
  BOOST_TEST(link2.getName() == "/test");
  BOOST_TEST(link2.getDelegationList() == std::vector<Name>({"/test1", "/test2", "/test3"}),
             boost::test_tools::per_element());
}

BOOST_AUTO_TEST_CASE(EncodeEmpty)
{
  Link link("/L");
  signData(link);
  BOOST_TEST(link.getName() == "/L");
  BOOST_TEST(link.getContentType() == tlv::ContentType_Link);
  BOOST_TEST(link.getContent() == "1500"_block);
  BOOST_TEST(link.getDelegationList().empty() == true);
}

BOOST_AUTO_TEST_SUITE_END() // EncodeDecode

BOOST_AUTO_TEST_SUITE(Modify)

BOOST_AUTO_TEST_CASE(SetDelegationList)
{
  Link link("/test");
  BOOST_CHECK(link.getDelegationList().empty());

  link.setDelegationList(std::vector<Name>({"/test1", "/test2"}));
  BOOST_TEST(link.getDelegationList() == std::vector<Name>({"/test1", "/test2"}),
             boost::test_tools::per_element());
}

BOOST_AUTO_TEST_CASE(AddDelegation)
{
  Link link1("/test", {"/test1", "/test2", "/test3"});
  BOOST_TEST(link1.getDelegationList() == std::vector<Name>({"/test1", "/test2", "/test3"}),
             boost::test_tools::per_element());

  BOOST_CHECK(link1.addDelegation("/test4"));
  BOOST_TEST(link1.getDelegationList() == std::vector<Name>({"/test1", "/test2", "/test3", "/test4"}),
             boost::test_tools::per_element());

  BOOST_CHECK(!link1.addDelegation("/test2"));
  BOOST_TEST(link1.getDelegationList() == std::vector<Name>({"/test1", "/test2", "/test3", "/test4"}),
             boost::test_tools::per_element());

  signData(link1);
  Link link2(link1.wireEncode());
  BOOST_TEST(link2.getDelegationList() == std::vector<Name>({"/test1", "/test2", "/test3", "/test4"}),
             boost::test_tools::per_element());
}

BOOST_AUTO_TEST_CASE(RemoveDelegation)
{
  Link link1("/test", {"/test1", "/test2", "/test3"});
  BOOST_TEST(link1.getDelegationList() == std::vector<Name>({"/test1", "/test2", "/test3"}),
             boost::test_tools::per_element());

  BOOST_CHECK(!link1.removeDelegation("/test4")); // non-existent
  BOOST_TEST(link1.getDelegationList() == std::vector<Name>({"/test1", "/test2", "/test3"}),
             boost::test_tools::per_element());

  BOOST_CHECK(link1.removeDelegation("/test2"));
  BOOST_TEST(link1.getDelegationList() == std::vector<Name>({"/test1", "/test3"}),
             boost::test_tools::per_element());

  signData(link1);
  Link link2(link1.wireEncode());
  BOOST_TEST(link2.getDelegationList() == std::vector<Name>({"/test1", "/test3"}),
             boost::test_tools::per_element());

  link1.removeDelegation("/test1");
  link1.removeDelegation("/test3");
  BOOST_CHECK(link1.getDelegationList().empty());
}

BOOST_AUTO_TEST_SUITE_END() // Modify

BOOST_AUTO_TEST_SUITE_END() // TestLink

} // namespace ndn::tests