pib: Adapt code into ndn-tools conventions
Changes include:
1. license boilerplate
2. include guards
3. test suite names
4. return value of main function
5. README.md
Change-Id: I14289402475b591d7cdce7390cec5e3c0b6befe5
Refs: #3018
diff --git a/tests/pib/cert-publicher.t.cpp b/tests/pib/cert-publicher.t.cpp
index f33f325..a14731c 100644
--- a/tests/pib/cert-publicher.t.cpp
+++ b/tests/pib/cert-publicher.t.cpp
@@ -1,26 +1,26 @@
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/**
- * Copyright (c) 2013-2015 Regents of the University of California.
+ * Copyright (c) 2014-2015, Regents of the University of California.
*
- * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
+ * This file is part of ndn-tools (Named Data Networking Essential Tools).
+ * See AUTHORS.md for complete list of ndn-tools authors and contributors.
*
- * 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-tools is free software: you can redistribute it and/or modify it under the terms
+ * of the GNU 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.
+ * ndn-tools 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 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/>.
+ * You should have received a copy of the GNU General Public License along with
+ * ndn-tools, 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.
+ * @author Yingdi Yu <yingdi@cs.ucla.edu>
*/
#include "tools/pib/cert-publisher.hpp"
-#include "identity-management-time-fixture.hpp"
+#include "../identity-management-time-fixture.hpp"
#include <ndn-cxx/util/dummy-client-face.hpp>
#include <boost/filesystem.hpp>
@@ -31,7 +31,7 @@
namespace pib {
namespace tests {
-class CertPublisherFixture : public ndn::security::IdentityManagementTimeFixture
+class CertPublisherFixture : public ndn::tests::IdentityManagementTimeFixture
{
public:
CertPublisherFixture()
@@ -52,7 +52,7 @@
shared_ptr<util::DummyClientFace> face;
};
-BOOST_FIXTURE_TEST_SUITE(TestCertPublisher, CertPublisherFixture)
+BOOST_FIXTURE_TEST_SUITE(PibCertPublisher, CertPublisherFixture)
BOOST_AUTO_TEST_CASE(Basic)
{
diff --git a/tests/pib/identity-management-time-fixture.cpp b/tests/pib/identity-management-time-fixture.cpp
deleted file mode 100644
index 526a2e6..0000000
--- a/tests/pib/identity-management-time-fixture.cpp
+++ /dev/null
@@ -1,58 +0,0 @@
-/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
-/**
- * Copyright (c) 2013-2015 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 "identity-management-time-fixture.hpp"
-
-namespace ndn {
-namespace security {
-
-IdentityManagementTimeFixture::IdentityManagementTimeFixture()
- : m_keyChainTmpPath(boost::filesystem::path(TMP_TESTS_PATH) / "PibIdMgmtTimeTest")
- , m_keyChain(std::string("pib-sqlite3:").append(m_keyChainTmpPath.string()),
- std::string("tpm-file:").append(m_keyChainTmpPath.string()))
-{
-}
-
-IdentityManagementTimeFixture::~IdentityManagementTimeFixture()
-{
- for (const auto& identity : m_identities) {
- m_keyChain.deleteIdentity(identity);
- }
-
- boost::filesystem::remove_all(m_keyChainTmpPath);
-}
-
-bool
-IdentityManagementTimeFixture::addIdentity(const Name& identity, const KeyParams& params)
-{
- try {
- m_keyChain.createIdentity(identity, params);
- m_identities.push_back(identity);
- return true;
- }
- catch (std::runtime_error&) {
- return false;
- }
-}
-
-
-} // namespace security
-} // namespace ndn
diff --git a/tests/pib/identity-management-time-fixture.hpp b/tests/pib/identity-management-time-fixture.hpp
deleted file mode 100644
index 4ac2e63..0000000
--- a/tests/pib/identity-management-time-fixture.hpp
+++ /dev/null
@@ -1,61 +0,0 @@
-/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
-/**
- * Copyright (c) 2013-2015 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.
- */
-
-#ifndef NDN_TESTS_IDENTITY_MANAGEMENT_TIME_FIXTURE_HPP
-#define NDN_TESTS_IDENTITY_MANAGEMENT_TIME_FIXTURE_HPP
-
-#include <ndn-cxx/security/key-chain.hpp>
-#include <vector>
-#include <boost/filesystem.hpp>
-
-#include "tests/test-common.hpp"
-
-namespace ndn {
-namespace security {
-
-/**
- * @brief IdentityManagementTimeFixture is a test suite level fixture.
- * Test cases in the suite can use this fixture to create identities.
- * Identities added via addIdentity method are automatically deleted
- * during test teardown.
- */
-class IdentityManagementTimeFixture : public tests::UnitTestTimeFixture
-{
-public:
- IdentityManagementTimeFixture();
-
- ~IdentityManagementTimeFixture();
-
- /// @brief add identity, return true if succeed.
- bool
- addIdentity(const Name& identity, const KeyParams& params = KeyChain::DEFAULT_KEY_PARAMS);
-
-protected:
- boost::filesystem::path m_keyChainTmpPath;
-
- KeyChain m_keyChain;
- std::vector<Name> m_identities;
-};
-
-} // namespace security
-} // namespace ndn
-
-#endif // NDN_TESTS_IDENTITY_MANAGEMENT_TIME_FIXTURE_HPP
diff --git a/tests/pib/key-cache.t.cpp b/tests/pib/key-cache.t.cpp
index 936c132..0b88410 100644
--- a/tests/pib/key-cache.t.cpp
+++ b/tests/pib/key-cache.t.cpp
@@ -1,22 +1,22 @@
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/**
- * Copyright (c) 2013-2014 Regents of the University of California.
+ * Copyright (c) 2014-2015, Regents of the University of California.
*
- * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
+ * This file is part of ndn-tools (Named Data Networking Essential Tools).
+ * See AUTHORS.md for complete list of ndn-tools authors and contributors.
*
- * 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-tools is free software: you can redistribute it and/or modify it under the terms
+ * of the GNU 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.
+ * ndn-tools 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 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/>.
+ * You should have received a copy of the GNU General Public License along with
+ * ndn-tools, 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.
+ * @author Yingdi Yu <yingdi@cs.ucla.edu>
*/
#include "tools/pib/key-cache.hpp"
@@ -27,7 +27,7 @@
namespace pib {
namespace tests {
-BOOST_AUTO_TEST_SUITE(TestKeyCache)
+BOOST_AUTO_TEST_SUITE(PibKeyCache)
BOOST_AUTO_TEST_CASE(Basic)
{
diff --git a/tests/pib/pib-db.t.cpp b/tests/pib/pib-db.t.cpp
index 6d826d2..ac20f89 100644
--- a/tests/pib/pib-db.t.cpp
+++ b/tests/pib/pib-db.t.cpp
@@ -1,26 +1,26 @@
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/**
- * Copyright (c) 2013-2015 Regents of the University of California.
+ * Copyright (c) 2014-2015, Regents of the University of California.
*
- * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
+ * This file is part of ndn-tools (Named Data Networking Essential Tools).
+ * See AUTHORS.md for complete list of ndn-tools authors and contributors.
*
- * 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-tools is free software: you can redistribute it and/or modify it under the terms
+ * of the GNU 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.
+ * ndn-tools 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 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/>.
+ * You should have received a copy of the GNU General Public License along with
+ * ndn-tools, 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.
+ * @author Yingdi Yu <yingdi@cs.ucla.edu>
*/
#include "tools/pib/pib-db.hpp"
-#include "identity-management-time-fixture.hpp"
+#include "../identity-management-time-fixture.hpp"
#include <boost/filesystem.hpp>
@@ -30,7 +30,7 @@
namespace pib {
namespace tests {
-class PibDbTestFixture : public ndn::security::IdentityManagementTimeFixture
+class PibDbTestFixture : public ndn::tests::IdentityManagementTimeFixture
{
public:
PibDbTestFixture()
@@ -54,7 +54,7 @@
};
-BOOST_FIXTURE_TEST_SUITE(TestPibDb, PibDbTestFixture)
+BOOST_FIXTURE_TEST_SUITE(PibPibDb, PibDbTestFixture)
BOOST_AUTO_TEST_CASE(MgmtTest)
{
diff --git a/tests/pib/pib-validator.t.cpp b/tests/pib/pib-validator.t.cpp
index 06fd373..c00761b 100644
--- a/tests/pib/pib-validator.t.cpp
+++ b/tests/pib/pib-validator.t.cpp
@@ -1,22 +1,22 @@
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/**
- * Copyright (c) 2013-2015 Regents of the University of California.
+ * Copyright (c) 2014-2015, Regents of the University of California.
*
- * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
+ * This file is part of ndn-tools (Named Data Networking Essential Tools).
+ * See AUTHORS.md for complete list of ndn-tools authors and contributors.
*
- * 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-tools is free software: you can redistribute it and/or modify it under the terms
+ * of the GNU 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.
+ * ndn-tools 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 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/>.
+ * You should have received a copy of the GNU General Public License along with
+ * ndn-tools, 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.
+ * @author Yingdi Yu <yingdi@cs.ucla.edu>
*/
#include "tools/pib/pib-validator.hpp"
@@ -24,7 +24,7 @@
#include "tools/pib/encoding/delete-param.hpp"
#include <ndn-cxx/security/key-chain.hpp>
-#include "identity-management-time-fixture.hpp"
+#include "../identity-management-time-fixture.hpp"
#include <boost/filesystem.hpp>
#include "tests/test-common.hpp"
@@ -32,7 +32,7 @@
namespace pib {
namespace tests {
-class PibValidatorFixture : public ndn::security::IdentityManagementTimeFixture
+class PibValidatorFixture : public ndn::tests::IdentityManagementTimeFixture
{
public:
PibValidatorFixture()
@@ -52,7 +52,7 @@
bool isProcessed;
};
-BOOST_FIXTURE_TEST_SUITE(TestPibValidator, PibValidatorFixture)
+BOOST_FIXTURE_TEST_SUITE(PibPibValidator, PibValidatorFixture)
BOOST_AUTO_TEST_CASE(Basic)
{
diff --git a/tests/pib/pib.t.cpp b/tests/pib/pib.t.cpp
index f4c4e6f..0bbeca9 100644
--- a/tests/pib/pib.t.cpp
+++ b/tests/pib/pib.t.cpp
@@ -1,26 +1,26 @@
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/**
- * Copyright (c) 2013-2014 Regents of the University of California.
+ * Copyright (c) 2014-2015, Regents of the University of California.
*
- * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
+ * This file is part of ndn-tools (Named Data Networking Essential Tools).
+ * See AUTHORS.md for complete list of ndn-tools authors and contributors.
*
- * 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-tools is free software: you can redistribute it and/or modify it under the terms
+ * of the GNU 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.
+ * ndn-tools 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 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/>.
+ * You should have received a copy of the GNU General Public License along with
+ * ndn-tools, 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.
+ * @author Yingdi Yu <yingdi@cs.ucla.edu>
*/
#include "tools/pib/pib.hpp"
-#include "identity-management-time-fixture.hpp"
+#include "../identity-management-time-fixture.hpp"
#include <ndn-cxx/security/sec-tpm-file.hpp>
#include "tools/pib/encoding/pib-encoding.hpp"
#include <ndn-cxx/util/io.hpp>
@@ -34,7 +34,7 @@
namespace pib {
namespace tests {
-class PibTestFixture : public ndn::security::IdentityManagementTimeFixture
+class PibTestFixture : public ndn::tests::IdentityManagementTimeFixture
{
public:
PibTestFixture()
@@ -75,7 +75,7 @@
shared_ptr<util::DummyClientFace> face;
};
-BOOST_FIXTURE_TEST_SUITE(TestPib, PibTestFixture)
+BOOST_FIXTURE_TEST_SUITE(PibPib, PibTestFixture)
BOOST_AUTO_TEST_CASE(InitCertTest1)
{
diff --git a/tests/pib/response-cache.t.cpp b/tests/pib/response-cache.t.cpp
index 2653579..782a9f2 100644
--- a/tests/pib/response-cache.t.cpp
+++ b/tests/pib/response-cache.t.cpp
@@ -1,22 +1,22 @@
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/**
- * Copyright (c) 2013-2014 Regents of the University of California.
+ * Copyright (c) 2014-2015, Regents of the University of California.
*
- * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
+ * This file is part of ndn-tools (Named Data Networking Essential Tools).
+ * See AUTHORS.md for complete list of ndn-tools authors and contributors.
*
- * 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-tools is free software: you can redistribute it and/or modify it under the terms
+ * of the GNU 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.
+ * ndn-tools 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 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/>.
+ * You should have received a copy of the GNU General Public License along with
+ * ndn-tools, 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.
+ * @author Yingdi Yu <yingdi@cs.ucla.edu>
*/
#include "tools/pib/response-cache.hpp"
@@ -27,7 +27,7 @@
namespace pib {
namespace tests {
-BOOST_AUTO_TEST_SUITE(TestResponseCache)
+BOOST_AUTO_TEST_SUITE(PibResponseCache)
BOOST_AUTO_TEST_CASE(Basic)
{