blob: af5e83941d7a2bf0c650c220cf126691b2407a75 [file] [log] [blame]
Alexander Afanasyeve4f8c3b2016-06-23 16:03:48 -07001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
Davide Pesavento7e780642018-11-24 15:51:34 -05002/*
Davide Pesavento09904412021-03-24 16:40:53 -04003 * Copyright (c) 2013-2021 Regents of the University of California.
Alexander Afanasyeve4f8c3b2016-06-23 16:03:48 -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.
20 */
21
Davide Pesavento09904412021-03-24 16:40:53 -040022#ifndef NDN_CXX_TESTS_TEST_HOME_FIXTURE_HPP
23#define NDN_CXX_TESTS_TEST_HOME_FIXTURE_HPP
Alexander Afanasyeve4f8c3b2016-06-23 16:03:48 -070024
Alexander Afanasyev09236c22020-06-03 13:42:38 -040025#include "ndn-cxx/security/key-chain.hpp"
Alexander Afanasyeve4f8c3b2016-06-23 16:03:48 -070026
Davide Pesavento7e780642018-11-24 15:51:34 -050027#include <cstdlib>
Alexander Afanasyevcf490552016-06-27 22:51:36 -070028#include <fstream>
Davide Pesavento7e780642018-11-24 15:51:34 -050029#include <initializer_list>
30
Davide Pesavento25d4f1c2020-04-29 23:31:04 -040031#include <boost/algorithm/string/replace.hpp>
Davide Pesavento7e780642018-11-24 15:51:34 -050032#include <boost/filesystem.hpp>
Alexander Afanasyeve4f8c3b2016-06-23 16:03:48 -070033
34namespace ndn {
35namespace tests {
36
37/**
38 * @brief Fixture to adjust/restore NDN_CLIENT_PIB and NDN_CLIENT_TPM paths
39 *
40 * Note that the specified PATH will be removed after fixture is destroyed.
41 * **Do not specify non-temporary paths.**
42 */
43template<class Path>
44class PibDirFixture
45{
46public:
47 PibDirFixture()
48 : m_pibDir(Path().PATH)
49 {
Davide Pesavento7e780642018-11-24 15:51:34 -050050 if (std::getenv("NDN_CLIENT_PIB") != nullptr) {
51 m_oldPib = std::getenv("NDN_CLIENT_PIB");
Alexander Afanasyeve4f8c3b2016-06-23 16:03:48 -070052 }
Davide Pesavento7e780642018-11-24 15:51:34 -050053 if (std::getenv("NDN_CLIENT_TPM") != nullptr) {
54 m_oldTpm = std::getenv("NDN_CLIENT_TPM");
Alexander Afanasyeve4f8c3b2016-06-23 16:03:48 -070055 }
56
57 /// @todo Consider change to an in-memory PIB/TPM
58 setenv("NDN_CLIENT_PIB", ("pib-sqlite3:" + m_pibDir).c_str(), true);
59 setenv("NDN_CLIENT_TPM", ("tpm-file:" + m_pibDir).c_str(), true);
60 }
61
62 ~PibDirFixture()
63 {
64 if (!m_oldPib.empty()) {
Davide Pesavento7e780642018-11-24 15:51:34 -050065 setenv("NDN_CLIENT_PIB", m_oldPib.data(), true);
Alexander Afanasyeve4f8c3b2016-06-23 16:03:48 -070066 }
67 else {
68 unsetenv("NDN_CLIENT_PIB");
69 }
70
71 if (!m_oldTpm.empty()) {
Davide Pesavento7e780642018-11-24 15:51:34 -050072 setenv("NDN_CLIENT_TPM", m_oldTpm.data(), true);
Alexander Afanasyeve4f8c3b2016-06-23 16:03:48 -070073 }
74 else {
75 unsetenv("NDN_CLIENT_TPM");
76 }
77
78 boost::filesystem::remove_all(m_pibDir);
Alexander Afanasyev09236c22020-06-03 13:42:38 -040079 const_cast<std::string&>(KeyChain::getDefaultPibLocator()).clear();
80 const_cast<std::string&>(KeyChain::getDefaultTpmLocator()).clear();
Alexander Afanasyeve4f8c3b2016-06-23 16:03:48 -070081 }
82
83protected:
84 const std::string m_pibDir;
85
86private:
87 std::string m_oldPib;
88 std::string m_oldTpm;
89};
90
Alexander Afanasyevcf490552016-06-27 22:51:36 -070091/**
92 * @brief Extension of PibDirFixture to set TEST_HOME variable and allow config file creation
93 */
94template<class Path>
95class TestHomeFixture : public PibDirFixture<Path>
96{
97public:
98 TestHomeFixture()
99 {
100 setenv("TEST_HOME", this->m_pibDir.c_str(), true);
101 }
102
103 ~TestHomeFixture()
104 {
105 unsetenv("TEST_HOME");
106 }
107
108 void
Davide Pesavento7e780642018-11-24 15:51:34 -0500109 createClientConf(std::initializer_list<std::string> lines) const
Alexander Afanasyevcf490552016-06-27 22:51:36 -0700110 {
111 boost::filesystem::create_directories(boost::filesystem::path(this->m_pibDir) / ".ndn");
112 std::ofstream of((boost::filesystem::path(this->m_pibDir) / ".ndn" / "client.conf").c_str());
113 for (auto line : lines) {
114 boost::replace_all(line, "%PATH%", this->m_pibDir);
115 of << line << std::endl;
116 }
117 }
118};
119
Alexander Afanasyeve4f8c3b2016-06-23 16:03:48 -0700120struct DefaultPibDir
121{
122 const std::string PATH = "build/keys";
123};
124
Alexander Afanasyeve4f8c3b2016-06-23 16:03:48 -0700125} // namespace tests
126} // namespace ndn
127
Davide Pesavento09904412021-03-24 16:40:53 -0400128#endif // NDN_CXX_TESTS_TEST_HOME_FIXTURE_HPP