tests: add simple test for HTML generation

Author: striezel

code/html_generation.cpp

@@ -34,7 +34,7 @@
 #include "../libstriezel/filesystem/directory.hpp"
 #include "../libstriezel/filesystem/file.hpp"
 
-int generateHtmlFiles(const MessageDatabase& mdb, const FolderMap& fm, const HTMLOptions htmlOptions)
+int generateHtmlFiles(const MessageDatabase& mdb, const FolderMap& fm, const HTMLOptions htmlOptions, std::string htmlDir)
 {
   MessageDatabase::Iterator msgIter = mdb.getBegin();
   if (msgIter == mdb.getEnd())
@@ -44,7 +44,10 @@ int generateHtmlFiles(const MessageDatabase& mdb, const FolderMap& fm, const HTM
   }
 
   // directory creation
-  std::string htmlDir = pmdb::paths::html();
+  if (htmlDir.empty())
+  {
+    htmlDir = pmdb::paths::html();
+  }
   if (!libstriezel::filesystem::directory::exists(htmlDir))
   {
     std::cout << "Trying to create HTML directory \"" << htmlDir << "\" ...";

code/html_generation.hpp

@@ -30,9 +30,10 @@
  * \param mdb          the database containing the messages
  * \param fm           folder mappings for the message database
  * \param htmlOptions  the options for HTML file generation
+ * \param htmlDir      directory where the HTML files reside
  * \return Returns zero, if all HTML files could be created.
  *         Returns non-zero exit code, if an error occurred.
  */
-int generateHtmlFiles(const MessageDatabase& mdb, const FolderMap& fm, const HTMLOptions htmlOptions);
+int generateHtmlFiles(const MessageDatabase& mdb, const FolderMap& fm, const HTMLOptions htmlOptions, std::string htmlDir = "");
 
 #endif // PMDB_HTML_GENERATION_HPP

tests/components/CMakeLists.txt

@@ -32,6 +32,7 @@ set(component_tests_sources
     ../../code/bbcode/quotes.cpp
     ../../code/browser_detection.cpp
     ../../code/filters/FilterUser.cpp
+    ../../code/html_generation.cpp
     ../../code/paths.cpp
     ../../code/templates/defaults.hpp
     ../../code/templates/functions.cpp
@@ -71,6 +72,7 @@ set(component_tests_sources
     bbcode/quotes.cpp
     browser_detection.cpp
     filter/FilterUser.cpp
+    html_generation.cpp
     names_to_controlsequences.cpp
     paths.cpp
     templates/defaults.cpp

tests/components/component_tests.cbp

@@ -90,6 +90,8 @@
 		<Unit filename="../../code/filters/Filter.hpp" />
 		<Unit filename="../../code/filters/FilterUser.cpp" />
 		<Unit filename="../../code/filters/FilterUser.hpp" />
+		<Unit filename="../../code/html_generation.cpp" />
+		<Unit filename="../../code/html_generation.hpp" />
 		<Unit filename="../../code/paths.cpp" />
 		<Unit filename="../../code/paths.hpp" />
 		<Unit filename="../../code/templates/defaults.hpp" />
@@ -141,6 +143,7 @@
 		<Unit filename="bbcode/quotes.cpp" />
 		<Unit filename="browser_detection.cpp" />
 		<Unit filename="filter/FilterUser.cpp" />
+		<Unit filename="html_generation.cpp" />
 		<Unit filename="main.cpp" />
 		<Unit filename="names_to_controlsequences.cpp" />
 		<Unit filename="paths.cpp" />

tests/components/html_generation.cpp

@@ -0,0 +1,61 @@
+/*
+ -------------------------------------------------------------------------------
+    This file is part of the Private Message Database test suite.
+    Copyright (C) 2025  Dirk Stolle
+
+    This program 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.
+
+    This program 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 a copy of the GNU General Public License
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ -------------------------------------------------------------------------------
+*/
+
+#include "../locate_catch.hpp"
+#include <filesystem>
+#include "../../code/html_generation.hpp"
+
+TEST_CASE("HTML generation")
+{
+  SECTION("generateHtmlFiles")
+  {
+    FolderMap fm;
+    MessageDatabase mdb;
+
+    PrivateMessage pm;
+    pm.setDatestamp("2007-06-14 12:34");
+    pm.setTitle("This is the title");
+    pm.setFromUser("Hermes");
+    pm.setFromUserID(234);
+    pm.setToUser("Poseidon");
+    pm.setMessage("This is a [b]bold[/b] text.");
+
+    fm.add(pm.getHash(), "Inbox");
+    mdb.addMessage(pm);
+
+    HTMLOptions options;
+    options.standard = HTMLStandard::HTML4_01;
+
+    std::filesystem::path html_path = std::filesystem::temp_directory_path() / "pmdb_test_html_directory";
+
+    int exit_code = generateHtmlFiles(mdb, fm, options, html_path.string());
+    REQUIRE( exit_code == 0 );
+
+    auto message_path = html_path / (pm.getHash().toHexString() + ".html");
+    REQUIRE( std::filesystem::is_regular_file(message_path) );
+
+    auto folder_path = html_path / "folder_94835ea2fcf775cd77cb9c9cee01b5cbd9bc515467aab1215f48a5ade9ca5274.html";
+    REQUIRE( std::filesystem::is_regular_file(message_path) );
+
+    REQUIRE( std::filesystem::remove(message_path) );
+    REQUIRE( std::filesystem::remove(folder_path) );
+    REQUIRE( std::filesystem::remove(html_path) );
+  }
+}