added test coverage and documentation for --showtime=file-total

Author: firewave

cli/cmdlineparser.cpp

@@ -1284,6 +1284,8 @@ void CmdLineParser::printHelp()
     "                                 Show nothing (default)\n"
     "                          * file\n"
     "                                 Show for each processed file\n"
+    "                          * file-total\n"
+    "                                 Show total time only for each processed file\n"
     "                          * summary\n"
     "                                 Show a summary at the end\n"
     "                          * top5_file\n"

man/cppcheck.1.xml

@@ -552,7 +552,7 @@ There are false positives with this option. Each result must be carefully invest
         </term>
         <listitem>
           <para>Show timing information. The available mode are:
-            <glosslist><glossentry><glossterm>none</glossterm><glossdef><para>Show nothing (default)</para></glossdef></glossentry><glossentry><glossterm>file</glossterm><glossdef><para>Show for each processed file</para></glossdef></glossentry><glossentry><glossterm>summary</glossterm><glossdef><para>Show a summary at the end</para></glossdef></glossentry><glossentry><glossterm>top5_file</glossterm><glossdef><para>Show the top 5 for each processed file</para></glossdef></glossentry><glossentry><glossterm>top5_summary</glossterm><glossdef><para>Show the top 5 summary at the end</para></glossdef></glossentry><glossentry><glossterm>top5</glossterm><glossdef><para>Alias for top5_file (deprecated)</para></glossdef></glossentry></glosslist>
+            <glosslist><glossentry><glossterm>none</glossterm><glossdef><para>Show nothing (default)</para></glossdef></glossentry><glossentry><glossterm>file</glossterm><glossdef><para>Show for each processed file</para></glossdef></glossentry><glossentry><glossterm>file-total</glossterm><glossdef><para>Show total time only for each processed file</para></glossdef></glossentry><glossentry><glossterm>summary</glossterm><glossdef><para>Show a summary at the end</para></glossdef></glossentry><glossentry><glossterm>top5_file</glossterm><glossdef><para>Show the top 5 for each processed file</para></glossdef></glossentry><glossentry><glossterm>top5_summary</glossterm><glossdef><para>Show the top 5 summary at the end</para></glossdef></glossentry><glossentry><glossterm>top5</glossterm><glossdef><para>Alias for top5_file (deprecated)</para></glossdef></glossentry></glosslist>
           </para>
         </listitem>
       </varlistentry>

test/testcmdlineparser.cpp

@@ -235,6 +235,7 @@ class TestCmdlineParser : public TestFixture {
         TEST_CASE(xmlverinvalid);
         TEST_CASE(doc);
         TEST_CASE(showtimeFile);
+        TEST_CASE(showtimeFileTotal);
         TEST_CASE(showtimeTop5);
         TEST_CASE(showtimeTop5File);
         TEST_CASE(showtimeTop5Summary);
@@ -1593,6 +1594,15 @@ class TestCmdlineParser : public TestFixture {
         ASSERT_EQUALS("", logger->str());
     }
 
+    void showtimeFileTotal() {
+        REDIRECT;
+        const char * const argv[] = {"cppcheck", "--showtime=file-total", "file.cpp"};
+        settings->showtime = SHOWTIME_MODES::SHOWTIME_NONE;
+        ASSERT(parser->parseFromArgs(3, argv));
+        ASSERT(settings->showtime == SHOWTIME_MODES::SHOWTIME_FILE_TOTAL);
+        ASSERT_EQUALS("", logger->str());
+    }
+
     void showtimeTop5() {
         REDIRECT;
         const char * const argv[] = {"cppcheck", "--showtime=top5", "file.cpp"};

test/testprocessexecutor.cpp

@@ -110,6 +110,7 @@ class TestProcessExecutor : public TestFixture {
         TEST_CASE(showtime_top5_summary);
         TEST_CASE(showtime_file);
         TEST_CASE(showtime_summary);
+        TEST_CASE(showtime_file_total);
 #endif // !WIN32
     }
 
@@ -291,6 +292,17 @@ class TestProcessExecutor : public TestFixture {
         TODO_ASSERT(output_s.find("2 result(s)") != std::string::npos);
     }
 
+    void showtime_file_total() {
+        REDIRECT; // should not cause TSAN failures as the showtime logging is synchronized
+        check(2, 2, 0,
+              "int main() {}",
+              dinit(CheckOptions,
+                    $.showtime = SHOWTIME_MODES::SHOWTIME_FILE_TOTAL));
+        const std::string output_s = GET_REDIRECT_OUTPUT;
+        TODO_ASSERT(output_s.find("Check time: " + fprefix() + "_1.cpp: ") != std::string::npos);
+        TODO_ASSERT(output_s.find("Check time: " + fprefix() + "_2.cpp: ") != std::string::npos);
+    }
+
     // TODO: test clang-tidy
     // TODO: test whole program analysis
 };

test/testsingleexecutor.cpp

@@ -155,6 +155,7 @@ class TestSingleExecutorBase : public TestFixture {
         TEST_CASE(showtime_top5_summary);
         TEST_CASE(showtime_file);
         TEST_CASE(showtime_summary);
+        TEST_CASE(showtime_file_total);
     }
 
     void many_files() {
@@ -346,6 +347,17 @@ class TestSingleExecutorBase : public TestFixture {
         ASSERT(output_s.find("2 result(s)") != std::string::npos);
     }
 
+    void showtime_file_total() {
+        REDIRECT;
+        check(2, 0,
+              "int main() {}",
+              dinit(CheckOptions,
+                    $.showtime = SHOWTIME_MODES::SHOWTIME_FILE_TOTAL));
+        const std::string output_s = GET_REDIRECT_OUTPUT;
+        ASSERT(output_s.find("Check time: " + fprefix() + "_" + zpad3(1) + ".cpp: ") != std::string::npos);
+        ASSERT(output_s.find("Check time: " + fprefix() + "_" + zpad3(2) + ".cpp: ") != std::string::npos);
+    }
+
     // TODO: test whole program analysis
 };
 

test/testthreadexecutor.cpp

@@ -109,6 +109,7 @@ class TestThreadExecutor : public TestFixture {
         TEST_CASE(showtime_top5_summary);
         TEST_CASE(showtime_file);
         TEST_CASE(showtime_summary);
+        TEST_CASE(showtime_file_total);
     }
 
     void deadlock_with_many_errors() {
@@ -290,6 +291,17 @@ class TestThreadExecutor : public TestFixture {
         ASSERT(output_s.find("2 result(s)") != std::string::npos);
     }
 
+    void showtime_file_total() {
+        REDIRECT; // should not cause TSAN failures as the showtime logging is synchronized
+        check(2, 2, 0,
+              "int main() {}",
+              dinit(CheckOptions,
+                    $.showtime = SHOWTIME_MODES::SHOWTIME_FILE_TOTAL));
+        const std::string output_s = GET_REDIRECT_OUTPUT;
+        ASSERT(output_s.find("Check time: " + fprefix() + "_1.cpp: ") != std::string::npos);
+        ASSERT(output_s.find("Check time: " + fprefix() + "_2.cpp: ") != std::string::npos);
+    }
+
     // TODO: test clang-tidy
     // TODO: test whole program analysis
 };