Merge branch 'integration_tests_crash_log' into 'master'

Use proper log paths and print crash log in integration tests CI job

See merge request OpenMW/openmw!2668

.gitlab-ci.yml

@@ -364,6 +364,8 @@ Ubuntu_Clang_integration_tests:
     - pip3 install --user numpy matplotlib termtables click
   script:
     - CI/run_integration_tests.sh
+  after_script:
+    - if [[ -f /tmp/openmw-crash.log ]]; then cat /tmp/openmw-crash.log; fi
 
 .MacOS:
   image: macos-11-xcode-12

CI/install_debian_deps.sh

@@ -46,6 +46,7 @@ declare -rA GROUPED_DEPS=(
 
   [openmw-integration-tests]="
     ca-certificates
+    gdb
     git
     git-lfs
     libavcodec58

apps/bulletobjecttool/main.cpp

@@ -48,6 +48,8 @@ namespace
 
     using StringsVector = std::vector<std::string>;
 
+    constexpr std::string_view applicationName = "BulletObjectTool";
+
     bpo::options_description makeOptionsDescription()
     {
         using Fallback::FallbackMap;
@@ -177,8 +179,9 @@ namespace
 
         VFS::registerArchives(&vfs, fileCollections, archives, true);
 
-        Settings::Manager settings;
-        settings.load(config);
+        Settings::Manager::load(config);
+
+        setupLogging(config.getLogPath(), applicationName);
 
         ESM::ReadersCache readers;
         EsmLoader::Query query;
@@ -221,5 +224,5 @@ namespace
 
 int main(int argc, char* argv[])
 {
-    return wrapApplication(runBulletObjectTool, argc, argv, "BulletObjectTool");
+    return wrapApplication(runBulletObjectTool, argc, argv, applicationName);
 }

apps/launcher/maindialog.cpp

@@ -13,6 +13,7 @@
 #include <boost/program_options/options_description.hpp>
 #include <boost/program_options/variables_map.hpp>
 
+#include <components/debug/debugging.hpp>
 #include <components/files/conversion.hpp>
 #include <components/files/qtconfigpath.hpp>
 #include <components/files/qtconversion.hpp>
@@ -424,6 +425,7 @@ bool Launcher::MainDialog::setupGraphicsSettings()
         mCfgMgr.addCommonOptions(desc);
         mCfgMgr.readConfiguration(variables, desc, true);
         Settings::Manager::load(mCfgMgr);
+        setupLogging(mCfgMgr.getLogPath(), "Launcher");
         return true;
     }
     catch (std::exception& e)

apps/navmeshtool/main.cpp

@@ -57,6 +57,8 @@ namespace NavMeshTool
 
         using StringsVector = std::vector<std::string>;
 
+        constexpr std::string_view applicationName = "NavMeshTool";
+
         bpo::options_description makeOptionsDescription()
         {
             using Fallback::FallbackMap;
@@ -197,8 +199,9 @@ namespace NavMeshTool
 
             VFS::registerArchives(&vfs, fileCollections, archives, true);
 
-            Settings::Manager settings;
-            settings.load(config);
+            Settings::Manager::load(config);
+
+            setupLogging(config.getLogPath(), applicationName);
 
             const auto agentCollisionShape = DetourNavigator::toCollisionShapeType(
                 Settings::Manager::getInt("actor collision shape type", "Game"));
@@ -263,5 +266,5 @@ namespace NavMeshTool
 
 int main(int argc, char* argv[])
 {
-    return wrapApplication(NavMeshTool::runNavMeshTool, argc, argv, "NavMeshTool");
+    return wrapApplication(NavMeshTool::runNavMeshTool, argc, argv, NavMeshTool::applicationName);
 }

apps/opencs/main.cpp

@@ -85,5 +85,5 @@ int runApplication(int argc, char* argv[])
 
 int main(int argc, char* argv[])
 {
-    return wrapApplication(&runApplication, argc, argv, "OpenMW-CS", false);
+    return wrapApplication(&runApplication, argc, argv, "OpenMW-CS");
 }

apps/openmw/main.cpp

@@ -256,7 +256,7 @@ extern "C" int SDL_main(int argc, char** argv)
 int main(int argc, char** argv)
 #endif
 {
-    return wrapApplication(&runApplication, argc, argv, "OpenMW", false);
+    return wrapApplication(&runApplication, argc, argv, "OpenMW");
 }
 
 // Platform specific for Windows when there is no console built into the executable.

components/crashcatcher/crashcatcher.hpp

@@ -1,6 +1,7 @@
 #ifndef CRASHCATCHER_H
 #define CRASHCATCHER_H
 
+#include <filesystem>
 #include <string>
 
 #if (defined(__APPLE__) || (defined(__linux) && !defined(ANDROID)) || (defined(__unix) && !defined(ANDROID))           \

components/debug/debugging.cpp

@@ -2,13 +2,16 @@
 
 #include <chrono>
 #include <fstream>
+#include <iostream>
+#include <map>
 #include <memory>
 
 #include <boost/iostreams/stream.hpp>
 
 #include <components/crashcatcher/crashcatcher.hpp>
-#include <components/files/configurationmanager.hpp>
 #include <components/files/conversion.hpp>
+#include <components/misc/strings/lower.hpp>
+
 #ifdef _WIN32
 #include <components/crashcatcher/windows_crashcatcher.hpp>
 #include <components/files/conversion.hpp>
@@ -280,7 +283,7 @@ Misc::Locked<std::ostream&> getLockedRawStderr()
 }
 
 // Redirect cout and cerr to the log file
-void setupLogging(const std::filesystem::path& logDir, const std::string& appName, std::ios_base::openmode mode)
+void setupLogging(const std::filesystem::path& logDir, std::string_view appName, std::ios_base::openmode mode)
 {
 #if defined(_WIN32) && defined(_DEBUG)
     // Redirect cout and cerr to VS debug output when running in debug mode
@@ -299,8 +302,7 @@ void setupLogging(const std::filesystem::path& logDir, const std::string& appNam
 #endif
 }
 
-int wrapApplication(int (*innerApplication)(int argc, char* argv[]), int argc, char* argv[], const std::string& appName,
-    bool autoSetupLogging)
+int wrapApplication(int (*innerApplication)(int argc, char* argv[]), int argc, char* argv[], std::string_view appName)
 {
 #if defined _WIN32
     (void)Debug::attachParentConsole();
@@ -312,29 +314,17 @@ int wrapApplication(int (*innerApplication)(int argc, char* argv[]), int argc, c
     int ret = 0;
     try
     {
-        Files::ConfigurationManager cfgMgr;
-
-        if (autoSetupLogging)
-        {
-            std::ios_base::openmode mode = std::ios::out;
-
-            // If we are collecting a stack trace, append to existing log file
-            if (argc == 2 && strcmp(argv[1], crash_switch) == 0)
-                mode |= std::ios::app;
-
-            setupLogging(cfgMgr.getLogPath(), appName, mode);
-        }
-
         if (const auto env = std::getenv("OPENMW_DISABLE_CRASH_CATCHER"); env == nullptr || std::atol(env) == 0)
         {
 #if defined(_WIN32)
             const std::string crashLogName = Misc::StringUtils::lowerCase(appName) + "-crash.dmp";
-            Crash::CrashCatcher crashy(argc, argv, Files::pathToUnicodeString(cfgMgr.getLogPath() / crashLogName));
+            Crash::CrashCatcher crashy(
+                argc, argv, Files::pathToUnicodeString(std::filesystem::temp_directory_path() / crashLogName));
 #else
             const std::string crashLogName = Misc::StringUtils::lowerCase(appName) + "-crash.log";
-            // install the crash handler as soon as possible. note that the log path
-            // does not depend on config being read.
-            crashCatcherInstall(argc, argv, Files::pathToUnicodeString(cfgMgr.getLogPath() / crashLogName));
+            // install the crash handler as soon as possible.
+            crashCatcherInstall(
+                argc, argv, Files::pathToUnicodeString(std::filesystem::temp_directory_path() / crashLogName));
 #endif
             ret = innerApplication(argc, argv);
         }
@@ -346,7 +336,7 @@ int wrapApplication(int (*innerApplication)(int argc, char* argv[]), int argc, c
 #if (defined(__APPLE__) || defined(__linux) || defined(__unix) || defined(__posix))
         if (!isatty(fileno(stdin)))
 #endif
-            SDL_ShowSimpleMessageBox(0, (appName + ": Fatal error").c_str(), e.what(), nullptr);
+            SDL_ShowSimpleMessageBox(0, (std::string(appName) + ": Fatal error").c_str(), e.what(), nullptr);
 
         Log(Debug::Error) << "Error: " << e.what();
 

components/debug/debugging.hpp

@@ -3,6 +3,7 @@
 
 #include <filesystem>
 #include <functional>
+#include <string_view>
 
 #include <components/misc/guarded.hpp>
 
@@ -35,9 +36,8 @@ std::ostream& getRawStderr();
 Misc::Locked<std::ostream&> getLockedRawStderr();
 
 void setupLogging(
-    const std::filesystem::path& logDir, const std::string& appName, std::ios_base::openmode mode = std::ios::out);
+    const std::filesystem::path& logDir, std::string_view appName, std::ios_base::openmode mode = std::ios::out);
 
-int wrapApplication(int (*innerApplication)(int argc, char* argv[]), int argc, char* argv[], const std::string& appName,
-    bool autoSetupLogging = true);
+int wrapApplication(int (*innerApplication)(int argc, char* argv[]), int argc, char* argv[], std::string_view appName);
 
 #endif