[lmi-commits] [6003] Refactor, replacing std::pair with a test-results class

[Greg Chicares]

Revision: 6003
          http://svn.sv.gnu.org/viewvc/?view=rev&root=lmi&revision=6003
Author:   chicares
Date:     2014-10-28 11:49:26 +0000 (Tue, 28 Oct 2014)
Log Message:
-----------
Refactor, replacing std::pair with a test-results class

Modified Paths:
--------------
    lmi/trunk/ChangeLog
    lmi/trunk/main_wx_test.cpp

Modified: lmi/trunk/ChangeLog
===================================================================
--- lmi/trunk/ChangeLog 2014-10-27 14:35:32 UTC (rev 6002)
+++ lmi/trunk/ChangeLog 2014-10-28 11:49:26 UTC (rev 6003)
@@ -34423,3 +34423,9 @@
 Don't use base class handler for log frame menu. See:
   http://lists.nongnu.org/archive/html/lmi/2014-10/msg00086.html
 
+20141028T1149Z <address@hidden> [532]
+
+  main_wx_test.cpp
+Refactor, replacing std::pair with a test-results class. See:
+  http://lists.nongnu.org/archive/html/lmi/2014-10/msg00087.html
+

Modified: lmi/trunk/main_wx_test.cpp
===================================================================
--- lmi/trunk/main_wx_test.cpp  2014-10-27 14:35:32 UTC (rev 6002)
+++ lmi/trunk/main_wx_test.cpp  2014-10-28 11:49:26 UTC (rev 6003)
@@ -52,7 +52,6 @@
 #include <iostream>
 #include <sstream>
 #include <stdexcept>
-#include <utility>                      // std::pair
 #include <vector>
 
 LMI_FORCE_LINKING_EX_SITU(file_command_wx)
@@ -109,6 +108,21 @@
         }
 };
 
+/// Simple struct collecting the statistics about the tests we ran.
+///
+/// Implicitly-declared special member functions do the right thing.
+struct TestsResults
+{
+    TestsResults()
+        :total(0)
+        ,failed(0)
+    {
+    }
+
+    int total,
+        failed;
+};
+
 /// Run the tests.
 ///
 /// This is a simple Meyers singleton.
@@ -131,10 +145,7 @@
     //
     // This function consumes all the exceptions thrown during its execution
     // and never throws itself.
-    //
-    // Return the number of tests executed as the first pair component and the
-    // number of failed tests as the second component.
-    std::pair<int, int> run() /* noexcept */;
+    TestsResults run() /* noexcept */;
 
     // Used by LMI_WX_TEST_CASE() macro to register the individual test cases.
     void add_test(wx_base_test_case* test);
@@ -312,14 +323,14 @@
     return true;
 }
 
-std::pair<int, int> application_test::run()
+TestsResults application_test::run()
 {
     // Always run the tests in the same, predictable order (we may want to add
     // a "random shuffle" option later, but even then predictable behaviour
     // should arguably remain the default).
     sort_tests();
 
-    std::pair<int, int> results(0, 0);
+    TestsResults results;
 
     // Indent the test status reports to make them stand out.
     char const* const indent = "    ";
@@ -330,7 +341,7 @@
         if ((run_all_ && i->run != run_no) || i->run == run_yes)
             {
             std::string error;
-            results.first++;
+            results.total++;
 
             try
                 {
@@ -349,7 +360,7 @@
 
             if (!error.empty())
                 {
-                results.second++;
+                results.failed++;
 
                 // When logging to a log window, it's better to have everything
                 // on a single line to avoid breaking the output structure.
@@ -579,18 +590,18 @@
     // some RAII-based pattern because of application_test::run() noexcept
     // guarantee.
     is_running_tests_ = true;
-    std::pair<int, int> const results = application_test::instance().run();
+    TestsResults const results = application_test::instance().run();
     is_running_tests_ = false;
 
-    if (results.first == 0)
+    if (results.total == 0)
         {
         wxLogMessage("WARNING: no tests have been executed.");
         }
-    else if (results.second == 0)
+    else if (results.failed == 0)
         {
         wxLogMessage
             ("SUCCESS: %d tests successfully completed in %ldms."
-            ,results.first
+            ,results.total
             ,sw.Time()
             );
         }
@@ -598,8 +609,8 @@
         {
         wxLogMessage
             ("FAILURE: %d out of %d tests failed."
-            ,results.second
-            ,results.first
+            ,results.failed
+            ,results.total
             );
         }