security: modernize Key and KeyContainer; add logging
Change-Id: Ibbe6a4ea54e2a1cc7ad7a7e00ea88a29ab1f6c3d
diff --git a/tests/unit/security/pib/key-container.t.cpp b/tests/unit/security/pib/key-container.t.cpp
index 25188a2..3e51424 100644
--- a/tests/unit/security/pib/key-container.t.cpp
+++ b/tests/unit/security/pib/key-container.t.cpp
@@ -1,6 +1,6 @@
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
- * Copyright (c) 2013-2021 Regents of the University of California.
+ * Copyright (c) 2013-2022 Regents of the University of California.
*
* This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
*
@@ -21,7 +21,6 @@
#include "ndn-cxx/security/pib/key-container.hpp"
#include "ndn-cxx/security/pib/impl/pib-memory.hpp"
-#include "ndn-cxx/security/pib/pib.hpp"
#include "tests/boost-test.hpp"
#include "tests/unit/security/pib/pib-data-fixture.hpp"
@@ -37,94 +36,86 @@
BOOST_AUTO_TEST_SUITE(Pib)
BOOST_FIXTURE_TEST_SUITE(TestKeyContainer, PibDataFixture)
-using pib::Pib;
-
-BOOST_AUTO_TEST_CASE(Basic)
+BOOST_AUTO_TEST_CASE(AddGetRemove)
{
auto pibImpl = make_shared<PibMemory>();
- // start with an empty container
- KeyContainer container(id1, pibImpl);
- BOOST_CHECK_EQUAL(container.size(), 0);
- BOOST_CHECK_EQUAL(container.getLoadedKeys().size(), 0);
+ {
+ // start with an empty container
+ KeyContainer container(id1, pibImpl);
+ BOOST_CHECK_EQUAL(container.size(), 0);
+ BOOST_CHECK_EQUAL(container.m_keys.size(), 0);
- // add the first key
- Key key11 = container.add(id1Key1, id1Key1Name);
- BOOST_CHECK_EQUAL(key11.getName(), id1Key1Name);
- BOOST_CHECK_EQUAL_COLLECTIONS(key11.getPublicKey().begin(), key11.getPublicKey().end(),
- id1Key1.begin(), id1Key1.end());
- BOOST_CHECK_EQUAL(container.size(), 1);
- BOOST_CHECK_EQUAL(container.getLoadedKeys().size(), 1);
- BOOST_CHECK(container.find(id1Key1Name) != container.end());
+ // add the first key
+ Key key11 = container.add(id1Key1, id1Key1Name);
+ BOOST_CHECK_EQUAL(key11.getName(), id1Key1Name);
+ BOOST_TEST(key11.getPublicKey() == id1Key1, boost::test_tools::per_element());
+ BOOST_CHECK_EQUAL(container.size(), 1);
+ BOOST_CHECK_EQUAL(container.m_keys.size(), 1);
+ BOOST_CHECK(container.find(id1Key1Name) != container.end());
- // add the same key again
- Key key12 = container.add(id1Key1, id1Key1Name);
- BOOST_CHECK_EQUAL(key12.getName(), id1Key1Name);
- BOOST_CHECK_EQUAL_COLLECTIONS(key12.getPublicKey().begin(), key12.getPublicKey().end(),
- id1Key1.begin(), id1Key1.end());
- BOOST_CHECK_EQUAL(container.size(), 1);
- BOOST_CHECK_EQUAL(container.getLoadedKeys().size(), 1);
- BOOST_CHECK(container.find(id1Key1Name) != container.end());
+ // add the same key again
+ Key key12 = container.add(id1Key1, id1Key1Name);
+ BOOST_CHECK_EQUAL(key12.getName(), id1Key1Name);
+ BOOST_TEST(key12.getPublicKey() == id1Key1, boost::test_tools::per_element());
+ BOOST_CHECK_EQUAL(container.size(), 1);
+ BOOST_CHECK_EQUAL(container.m_keys.size(), 1);
+ BOOST_CHECK(container.find(id1Key1Name) != container.end());
- // add the second key
- Key key21 = container.add(id1Key2, id1Key2Name);
- BOOST_CHECK_EQUAL(key21.getName(), id1Key2Name);
- BOOST_CHECK_EQUAL_COLLECTIONS(key21.getPublicKey().begin(), key21.getPublicKey().end(),
- id1Key2.begin(), id1Key2.end());
- BOOST_CHECK_EQUAL(container.size(), 2);
- BOOST_CHECK_EQUAL(container.getLoadedKeys().size(), 2);
- BOOST_CHECK(container.find(id1Key1Name) != container.end());
- BOOST_CHECK(container.find(id1Key2Name) != container.end());
+ // add the second key
+ Key key21 = container.add(id1Key2, id1Key2Name);
+ BOOST_CHECK_EQUAL(key21.getName(), id1Key2Name);
+ BOOST_TEST(key21.getPublicKey() == id1Key2, boost::test_tools::per_element());
+ BOOST_CHECK_EQUAL(container.size(), 2);
+ BOOST_CHECK_EQUAL(container.m_keys.size(), 2);
+ BOOST_CHECK(container.find(id1Key1Name) != container.end());
+ BOOST_CHECK(container.find(id1Key2Name) != container.end());
- // get keys
- BOOST_REQUIRE_NO_THROW(container.get(id1Key1Name));
- BOOST_REQUIRE_NO_THROW(container.get(id1Key2Name));
- Name id1Key3Name = constructKeyName(id1, name::Component("non-existing-id"));
- BOOST_CHECK_THROW(container.get(id1Key3Name), Pib::Error);
+ // check keys
+ Key key1 = container.get(id1Key1Name);
+ Key key2 = container.get(id1Key2Name);
+ BOOST_CHECK_EQUAL(key1.getName(), id1Key1Name);
+ BOOST_TEST(key1.getPublicKey() == id1Key1, boost::test_tools::per_element());
+ BOOST_CHECK_EQUAL(key2.getName(), id1Key2Name);
+ BOOST_TEST(key2.getPublicKey() == id1Key2, boost::test_tools::per_element());
+ Name id1Key3Name = constructKeyName(id1, name::Component("non-existing-id"));
+ BOOST_CHECK_THROW(container.get(id1Key3Name), pib::Pib::Error);
+ }
- // check key
- Key key1 = container.get(id1Key1Name);
- Key key2 = container.get(id1Key2Name);
- BOOST_CHECK_EQUAL(key1.getName(), id1Key1Name);
- BOOST_CHECK_EQUAL_COLLECTIONS(key1.getPublicKey().begin(), key1.getPublicKey().end(),
- id1Key1.begin(), id1Key1.end());
- BOOST_CHECK_EQUAL(key2.getName(), id1Key2Name);
- BOOST_CHECK_EQUAL_COLLECTIONS(key2.getPublicKey().begin(), key2.getPublicKey().end(),
- id1Key2.begin(), id1Key2.end());
+ {
+ // create a container from an existing (non-empty) PibImpl
+ // names are loaded immediately but the key cache should initially be empty
+ KeyContainer container2(id1, pibImpl);
+ BOOST_CHECK_EQUAL(container2.size(), 2);
+ BOOST_CHECK_EQUAL(container2.m_keys.size(), 0);
- // create another container from the same PibImpl
- // cache should be empty
- KeyContainer container2(id1, pibImpl);
- BOOST_CHECK_EQUAL(container2.size(), 2);
- BOOST_CHECK_EQUAL(container2.getLoadedKeys().size(), 0);
+ // fetching the keys should populate the cache
+ BOOST_CHECK_EQUAL(container2.get(id1Key1Name).getName(), id1Key1Name);
+ BOOST_CHECK_EQUAL(container2.size(), 2);
+ BOOST_CHECK_EQUAL(container2.m_keys.size(), 1);
- // get key, cache should be filled
- BOOST_REQUIRE_NO_THROW(container2.get(id1Key1Name));
- BOOST_CHECK_EQUAL(container2.size(), 2);
- BOOST_CHECK_EQUAL(container2.getLoadedKeys().size(), 1);
+ BOOST_CHECK_EQUAL(container2.get(id1Key2Name).getName(), id1Key2Name);
+ BOOST_CHECK_EQUAL(container2.size(), 2);
+ BOOST_CHECK_EQUAL(container2.m_keys.size(), 2);
- BOOST_REQUIRE_NO_THROW(container2.get(id1Key2Name));
- BOOST_CHECK_EQUAL(container2.size(), 2);
- BOOST_CHECK_EQUAL(container2.getLoadedKeys().size(), 2);
+ // remove a key
+ container2.remove(id1Key1Name);
+ BOOST_CHECK_EQUAL(container2.size(), 1);
+ BOOST_CHECK_EQUAL(container2.m_keys.size(), 1);
+ BOOST_CHECK(container2.find(id1Key1Name) == container2.end());
+ BOOST_CHECK(container2.find(id1Key2Name) != container2.end());
- // remove a key
- container2.remove(id1Key1Name);
- BOOST_CHECK_EQUAL(container2.size(), 1);
- BOOST_CHECK_EQUAL(container2.getLoadedKeys().size(), 1);
- BOOST_CHECK(container2.find(id1Key1Name) == container2.end());
- BOOST_CHECK(container2.find(id1Key2Name) != container2.end());
-
- // remove another key
- container2.remove(id1Key2Name);
- BOOST_CHECK_EQUAL(container2.size(), 0);
- BOOST_CHECK_EQUAL(container2.getLoadedKeys().size(), 0);
- BOOST_CHECK(container2.find(id1Key2Name) == container2.end());
+ // remove another key
+ container2.remove(id1Key2Name);
+ BOOST_CHECK_EQUAL(container2.size(), 0);
+ BOOST_CHECK_EQUAL(container2.m_keys.size(), 0);
+ BOOST_CHECK(container2.find(id1Key2Name) == container2.end());
+ }
}
BOOST_AUTO_TEST_CASE(Errors)
{
auto pibImpl = make_shared<PibMemory>();
-
KeyContainer container(id1, pibImpl);
BOOST_CHECK_THROW(container.add(id2Key1, id2Key1Name), std::invalid_argument);
@@ -136,16 +127,13 @@
{
auto pibImpl = make_shared<PibMemory>();
KeyContainer container(id1, pibImpl);
-
container.add(id1Key1, id1Key1Name);
container.add(id1Key2, id1Key2Name);
- std::set<Name> keyNames;
- keyNames.insert(id1Key1Name);
- keyNames.insert(id1Key2Name);
+ const std::set<Name> keyNames{id1Key1Name, id1Key2Name};
KeyContainer::const_iterator it = container.begin();
- std::set<Name>::const_iterator testIt = keyNames.begin();
+ auto testIt = keyNames.begin();
BOOST_CHECK_EQUAL((*it).getName(), *testIt);
it++;
testIt++;
@@ -154,7 +142,8 @@
testIt++;
BOOST_CHECK(it == container.end());
- size_t count = 0;
+ // test range-based for
+ int count = 0;
testIt = keyNames.begin();
for (const auto& key : container) {
BOOST_CHECK_EQUAL(key.getIdentity(), id1);