log-manager: enable non-standard path for local tests

Enable the log-manager to be launched with a path other than
`/var/phosphor-logging` to allow it to be ran on a development system
for test purposes.  This required some refactoring throughout as to
how paths were handled.

Tested:

After running tests, `/tmp/phosphor-logging` is populated with
entries.  Launching `./builddir/phosphor-log-manager
/tmp/phosphor-logging`, the log-manager will have the entries on
dbus:

```
$ busctl --user tree xyz.openbmc_project.Logging
└─ /xyz
  └─ /xyz/openbmc_project
    └─ /xyz/openbmc_project/logging
      ├─ /xyz/openbmc_project/logging/entry
      │ ├─ /xyz/openbmc_project/logging/entry/100
      │ ├─ /xyz/openbmc_project/logging/entry/101
      │ ├─ /xyz/openbmc_project/logging/entry/102
      │ ├─ /xyz/openbmc_project/logging/entry/103
```

Signed-off-by: Patrick Williams <[email protected]>
Change-Id: I84968edeed0dcf73aaf8bb653060b6d3400b9b7b

Author: williamspatrick

config/config.h.meson

@@ -25,8 +25,6 @@
 
 #define RSYSLOG_SERVER_CONFIG_FILE "@rsyslog_server_conf@"
 
-extern const char *ERRLOG_PERSIST_PATH;
-extern const char *EXTENSION_PERSIST_DIR;
 extern const bool IS_UNIT_TEST;
 
 static constexpr size_t ERROR_CAP = @error_cap@;

config_main.h

@@ -1,5 +1,4 @@
 #pragma once
 
-const char* ERRLOG_PERSIST_PATH = "/var/lib/phosphor-logging/errors";
-const char* EXTENSION_PERSIST_DIR = "/var/lib/phosphor-logging/extensions";
+const char* PERSIST_PATH_ROOT = "/var/lib/phosphor-logging";
 const bool IS_UNIT_TEST = false;

elog_entry.cpp

@@ -3,6 +3,7 @@
 #include "elog_serialize.hpp"
 #include "extensions.hpp"
 #include "log_manager.hpp"
+#include "paths.hpp"
 
 #include <fcntl.h>
 #include <unistd.h>

elog_serialize.hpp

@@ -3,6 +3,7 @@
 #include "config.h"
 
 #include "elog_entry.hpp"
+#include "paths.hpp"
 
 #include <filesystem>
 #include <string>
@@ -22,7 +23,7 @@ namespace fs = std::filesystem;
  *  @return fs::path - pathname of persisted error file
  */
 fs::path serialize(const Entry& e,
-                   const fs::path& dir = fs::path(ERRLOG_PERSIST_PATH));
+                   const fs::path& dir = fs::path(paths::error()));
 
 /** @brief Deserialze a persisted error into a d-bus object
  *  @param[in] path - pathname of persisted error file
@@ -38,8 +39,8 @@ bool deserialize(const fs::path& path, Entry& e);
  *                   be placed.
  *  @return fs::path - pathname of persisted error file
  */
-fs::path getEntrySerializePath(
-    uint32_t id, const fs::path& dir = fs::path(ERRLOG_PERSIST_PATH));
+fs::path getEntrySerializePath(uint32_t id,
+                               const fs::path& dir = fs::path(paths::error()));
 
 } // namespace logging
 } // namespace phosphor

extensions/openpower-pels/meson.build

@@ -68,6 +68,7 @@ libpel_sources = files(
     'severity.cpp',
     'user_header.cpp',
     'temporary_file.cpp',
+    '../../paths.cpp',
     '../../util.cpp',
     extra_sources,
 )
@@ -86,7 +87,7 @@ libpel_deps = [
 libpel_lib = static_library(
     'pel',
     libpel_sources,
-    'paths.cpp', # paths is separate because it is overridden during test.
+    'pel_paths.cpp', # paths is separate because it is overridden during test.
     include_directories: include_directories('../..', '../../gen'),
     cpp_args: extra_args,
     dependencies: [

extensions/openpower-pels/paths.hpp

@@ -1,4 +1,6 @@
 #pragma once
+#include "../../paths.hpp"
+
 #include <filesystem>
 
 namespace openpower

extensions/openpower-pels/paths.cpp renamed to extensions/openpower-pels/pel_paths.cpp

@@ -30,14 +30,14 @@ static constexpr size_t defaultMaxNumPELs = 3000;
 
 fs::path getPELIDFile()
 {
-    fs::path logIDPath{EXTENSION_PERSIST_DIR};
+    fs::path logIDPath{phosphor::logging::paths::extension()};
     logIDPath /= fs::path{"pels"} / fs::path{"pelID"};
     return logIDPath;
 }
 
 fs::path getPELRepoPath()
 {
-    std::filesystem::path repoPath{EXTENSION_PERSIST_DIR};
+    std::filesystem::path repoPath{phosphor::logging::paths::extension()};
     repoPath /= "pels";
     return repoPath;
 }

extensions/openpower-pels/tools/peltool.cpp

@@ -65,7 +65,7 @@ constexpr auto logging = "/xyz/openbmc_project/logging";
 
 std::string pelLogDir()
 {
-    return std::string(EXTENSION_PERSIST_DIR) + "/pels/logs";
+    return std::string(phosphor::logging::paths::extension()) + "/pels/logs";
 }
 
 /**

log_manager.cpp

@@ -6,6 +6,7 @@
 #include "elog_meta.hpp"
 #include "elog_serialize.hpp"
 #include "extensions.hpp"
+#include "paths.hpp"
 #include "util.hpp"
 
 #include <systemd/sd-bus.h>
@@ -584,7 +585,7 @@ void Manager::erase(uint32_t entryId)
         }
 
         // Delete the persistent representation of this error.
-        fs::path errorPath(ERRLOG_PERSIST_PATH);
+        fs::path errorPath(paths::error());
         errorPath /= std::to_string(entryId);
         fs::remove(errorPath);
 
@@ -633,7 +634,7 @@ void Manager::restore()
         return id == restoredId;
     };
 
-    fs::path dir(ERRLOG_PERSIST_PATH);
+    fs::path dir(paths::error());
     if (!fs::exists(dir) || fs::is_empty(dir))
     {
         return;

log_manager_main.cpp

@@ -4,6 +4,7 @@
 
 #include "extensions.hpp"
 #include "log_manager.hpp"
+#include "paths.hpp"
 
 #include <phosphor-logging/lg2.hpp>
 #include <sdbusplus/bus.hpp>
@@ -12,10 +13,16 @@
 
 #include <filesystem>
 
-int main(int /*argc*/, char* /*argv*/[])
+int main(int argc, char* argv[])
 {
     PHOSPHOR_LOG2_USING_WITH_FLAGS;
 
+    if (argc >= 1)
+    {
+        PERSIST_PATH_ROOT = strdup(argv[1]);
+        info("Using temporary {PATH} for logs", "PATH", PERSIST_PATH_ROOT);
+    }
+
     auto bus = sdbusplus::bus::new_default();
     auto event = sdeventplus::Event::get_default();
     bus.attach_event(event.get(), SD_EVENT_PRIORITY_NORMAL);
@@ -28,7 +35,7 @@ int main(int /*argc*/, char* /*argv*/[])
     phosphor::logging::Manager mgr(bus, OBJ_LOGGING, iMgr);
 
     // Create a directory to persist errors.
-    std::filesystem::create_directories(ERRLOG_PERSIST_PATH);
+    std::filesystem::create_directories(phosphor::logging::paths::error());
 
     // Recreate error d-bus objects from persisted errors.
     iMgr.restore();

meson.build

@@ -128,6 +128,7 @@ log_manager_sources = [
         'elog_serialize.cpp',
         'extensions.cpp',
         'log_manager.cpp',
+        'paths.cpp',
         'util.cpp',
     )
 ]

paths.cpp

@@ -0,0 +1,15 @@
+#include "config.h"
+
+#include "paths.hpp"
+
+namespace phosphor::logging::paths
+{
+auto error() -> std::filesystem::path
+{
+    return std::filesystem::path(PERSIST_PATH_ROOT) / "errors";
+}
+auto extension() -> std::filesystem::path
+{
+    return std::filesystem::path(PERSIST_PATH_ROOT) / "extensions";
+}
+} // namespace phosphor::logging::paths

paths.hpp

@@ -0,0 +1,14 @@
+#pragma once
+
+#include <filesystem>
+#include <string>
+
+extern const char* PERSIST_PATH_ROOT;
+
+namespace phosphor::logging::paths
+{
+
+auto error() -> std::filesystem::path;
+auto extension() -> std::filesystem::path;
+
+} // namespace phosphor::logging::paths

test/common.cpp

@@ -1,5 +1,4 @@
 #include "config.h"
 
-const char* ERRLOG_PERSIST_PATH = "/tmp/errors";
-const char* EXTENSION_PERSIST_DIR = "/tmp/extensions";
+const char* PERSIST_PATH_ROOT = "/tmp/phosphor-logging";
 const bool IS_UNIT_TEST = true;

test/elog_errorwrap_test.hpp

@@ -2,6 +2,7 @@
 
 #include "elog_serialize.hpp"
 #include "log_manager.hpp"
+#include "paths.hpp"
 #include "xyz/openbmc_project/Common/error.hpp"
 
 #include <phosphor-logging/elog-errors.hpp>
@@ -87,7 +88,7 @@ class TestLogManager : public testing::Test
         bus(sdbusplus::bus::new_default()),
         manager(bus, "/xyz/openbmc_test/abc")
     {
-        fs::create_directories(ERRLOG_PERSIST_PATH);
+        fs::create_directories(paths::error());
     }
 
     ~TestLogManager()

test/elog_quiesce_test.cpp

@@ -2,6 +2,7 @@
 
 #include "elog_entry.hpp"
 #include "log_manager.hpp"
+#include "paths.hpp"
 
 #include <sdbusplus/bus.hpp>
 #include <sdbusplus/test/sdbus_mock.hpp>
@@ -28,7 +29,7 @@ class TestQuiesceOnError : public testing::Test
     TestQuiesceOnError() : manager(mockedBus, OBJ_INTERNAL)
     {
         // Ensure any errors serializing to filesystem have directory created
-        std::filesystem::create_directory(ERRLOG_PERSIST_PATH);
+        std::filesystem::create_directories(paths::error());
     }
 };
 

test/elog_update_ts_test.cpp

@@ -4,6 +4,7 @@
 #include "elog_serialize.hpp"
 #include "extensions.hpp"
 #include "log_manager.hpp"
+#include "paths.hpp"
 
 #include <filesystem>
 #include <thread>
@@ -34,11 +35,11 @@ void deleteIsNotProhibitedMock(uint32_t /*id*/, bool& prohibited)
 TEST(TestUpdateTS, testChangeResolved)
 {
     // Setting resolved will serialize, so need this directory.
-    fs::create_directory(ERRLOG_PERSIST_PATH);
+    fs::create_directories(paths::error());
 
-    if (!fs::exists(ERRLOG_PERSIST_PATH))
+    if (!fs::exists(paths::error()))
     {
-        ADD_FAILURE() << "Could not create " << ERRLOG_PERSIST_PATH << "\n";
+        ADD_FAILURE() << "Could not create " << paths::error() << "\n";
         exit(1);
     }
 
@@ -50,7 +51,7 @@ TEST(TestUpdateTS, testChangeResolved)
     std::srand(std::time(nullptr));
     uint32_t id = std::rand();
 
-    if (fs::exists(fs::path{ERRLOG_PERSIST_PATH} / std::to_string(id)))
+    if (fs::exists(fs::path{paths::error()} / std::to_string(id)))
     {
         std::cerr << "Another testcase is using ID " << id << "\n";
         id = std::rand();
@@ -96,7 +97,7 @@ TEST(TestUpdateTS, testChangeResolved)
     EXPECT_EQ(updateTS, elog.updateTimestamp());
 
     // Leave the directory in case other CI instances are running
-    fs::remove(fs::path{ERRLOG_PERSIST_PATH} / std::to_string(id));
+    fs::remove(fs::path{paths::error()} / std::to_string(id));
 }
 
 TEST(TestResolveProhibited, testResolveFlagChange)

test/openpower-pels/meson.build

@@ -67,7 +67,7 @@ openpower_pels = {
 openpower_test_lib = static_library(
     'openpower_test_lib',
     'pel_utils.cpp',
-    'paths.cpp',
+    'pel_paths.cpp',
     libpel_sources,
     peltool_sources,
     '../common.cpp',