Merge pull request #3486 from hnakamur/v3/do_not_add_newline_to_test_body_lines

V3/do not add newline to test body lines

Author: airween

test/common/modsecurity_test.cc

@@ -68,15 +68,22 @@ bool ModSecurityTest<T>::load_test_json(const std::string &file) {
         return false;
     }
 
-    size_t num_tests = node->u.array.len;
-    for ( int i = 0; i < num_tests; i++ ) {
-        yajl_val obj = node->u.array.values[i];
-
-        auto u = std::unique_ptr<T>(T::from_yajl_node(obj));
+    if (m_format) {
+        auto u = T::from_yajl_node(node);
         u->filename = file;
 
-        const auto key = u->filename + ":" + u->name;
-        (*this)[key].push_back(std::move(u));
+        (*this)[file].push_back(std::move(u));
+    } else {
+        size_t num_tests = node->u.array.len;
+        for ( int i = 0; i < num_tests; i++ ) {
+            yajl_val obj = node->u.array.values[i];
+
+            auto u = T::from_yajl_node(obj);
+            u->filename = file;
+
+            const auto key = u->filename + ":" + u->name;
+            (*this)[key].push_back(std::move(u));
+        }
     }
 
     yajl_tree_free(node);
@@ -140,6 +147,13 @@ void ModSecurityTest<T>::cmd_options(int argc, char **argv) {
         i++;
         m_test_multithreaded = true;
     }
+    if (argc > i && strcmp(argv[i], "format") == 0) {
+        i++;
+        m_format = true;
+    }
+    if (std::getenv("UPDATE_CONTENT_LENGTH")) {
+        m_update_content_length = true;
+    }
     if (std::getenv("AUTOMAKE_TESTS")) {
         m_automake_output = true;
     }

test/common/modsecurity_test.h

@@ -17,7 +17,7 @@
 #include <utility>
 #include <string>
 #include <vector>
-#include <unordered_map>
+#include <map>
 
 #ifndef TEST_COMMON_MODSECURITY_TEST_H_
 #define TEST_COMMON_MODSECURITY_TEST_H_
@@ -29,13 +29,9 @@ extern std::string default_test_path;
 namespace modsecurity_test {
 
 template <class T> class ModSecurityTest :
-    public std::unordered_map<std::string, std::vector<std::unique_ptr<T>>> {
+    public std::map<std::string, std::vector<std::unique_ptr<T>>> {
  public:
-    ModSecurityTest()
-        : m_test_number(0),
-        m_automake_output(false),
-        m_count_all(false),
-        m_test_multithreaded(false) { }
+    ModSecurityTest() = default;
 
     std::string header();
     void cmd_options(int, char **);
@@ -44,12 +40,14 @@ template <class T> class ModSecurityTest :
     bool load_test_json(const std::string &file);
 
     std::string target;
-    bool verbose = false;
-    bool color = false;
-    int m_test_number;
-    bool m_automake_output;
-    bool m_count_all;
-    bool m_test_multithreaded;
+    bool verbose{false};
+    bool color{false};
+    int m_test_number{0};
+    bool m_automake_output{false};
+    bool m_count_all{false};
+    bool m_test_multithreaded{false};
+    bool m_format{false};
+    bool m_update_content_length{false};
 };
 
 }  // namespace modsecurity_test

test/common/modsecurity_test_results.h

@@ -14,7 +14,6 @@
  */
 
 #include <iostream>
-#include <unordered_map>
 #include <vector>
 #include <string>
 

test/regression/regression.cc

@@ -41,6 +41,7 @@ using modsecurity_test::CustomDebugLog;
 using modsecurity_test::ModSecurityTest;
 using modsecurity_test::ModSecurityTestResults;
 using modsecurity_test::RegressionTest;
+using modsecurity_test::RegressionTests;
 using modsecurity_test::RegressionTestResult;
 
 using modsecurity::Utils::regex_search;
@@ -436,6 +437,35 @@ int main(int argc, char **argv)
     return 0;
 #else
     test.cmd_options(argc, argv);
+
+    if (test.m_format) {
+#ifdef WITH_YAJL
+        std::cout << "start formatting test case JSON files" << std::endl;
+        ModSecurityTest<RegressionTests> test2;
+        test2.cmd_options(argc, argv);
+        test2.load_tests();
+        for (const auto &[name, tests] : test2) {
+            std::ofstream ofs{name};
+            if (!ofs.is_open()) {
+                std::cerr << "cannot open " << name << " for writing." << std::endl;
+                return 1;
+            }
+            if (test2.m_update_content_length) {
+                tests[0]->update_content_lengths();
+            }
+            ofs << tests[0]->toJSON();
+            ofs.close();
+            std::cout << "written formatted JSON to " << name << std::endl;
+        }
+        std::cout << "finished formatting files." << std::endl;
+        return 0;
+#else
+        std::cout << "Test utility cannot format test case JSON files without being built with YAJL." \
+            << std::endl;
+        return 1;
+#endif
+    }
+
     if (!test.m_automake_output && !test.m_count_all) {
         std::cout << test.header();
     }