@micro-os-plus/micro-test-plus 3.1.0 → 3.1.2

package/src/micro-test-plus.cpp

@@ -33,6 +33,7 @@
 #pragma clang diagnostic ignored "-Wc++98-compat"
 #pragma clang diagnostic ignored "-Wexit-time-destructors"
 #pragma clang diagnostic ignored "-Wglobal-constructors"
+#pragma clang diagnostic ignored "-Wunknown-warning-option"
 #endif
 
 namespace micro_os_plus::micro_test_plus
@@ -40,6 +41,18 @@ namespace micro_os_plus::micro_test_plus
   // --------------------------------------------------------------------------
   // Public API.
 
+  /**
+   * @details
+   * All tests include a default test suite, which runs the test cases
+   * defined in the main function.
+   *
+   * This function forwards the process arguments to the test framework
+   * and initialises the runner.
+   *
+   * The name is used to identify the default test suite.
+   *
+   * The arguments can be used to control the verbosity level.
+   */
   void
   initialize (int argc, char* argv[], const char* name)
   {
@@ -49,6 +62,18 @@ namespace micro_os_plus::micro_test_plus
     runner.initialize (argc, argv, name);
   }
 
+  /**
+   * @details
+   * In addition to the test cases defined in `main()`, there can be
+   * more separate **test suites**, defined as static objects in the same
+   * file or in other files,
+   * and self-registered via the static constructors mechanism.
+   *
+   * This function triggers the execution of the globally
+   * registered test suites
+   * (if any) and returns the test result as the process exit code
+   * (0 = success).
+   */
   int
   exit_code (void)
   {
@@ -63,7 +88,12 @@ namespace micro_os_plus::micro_test_plus
     const char*
     short_name (const char* name)
     {
+#pragma GCC diagnostic push
+#if defined(__clang__)
+#pragma clang diagnostic ignored "-Wunsafe-buffer-usage"
+#endif
       const char* p = strrchr (name, '/');
+#pragma GCC diagnostic pop
       if (p != nullptr)
         return p + 1;
       else
@@ -74,6 +104,19 @@ namespace micro_os_plus::micro_test_plus
 
   namespace utility
   {
+    /**
+     * @details
+     * For tests comparing strings, in addition to exact matches,
+     * it is also possible to check matches with patterns like `*`
+     * (for any characters) and `?` (for a single character)
+     *
+     * @par Examples
+     *
+     * ```cpp
+     * expect (utility::is_match ("abc", "a?c")) << "abc matches a?c";
+     * expect (utility::is_match ("abc", "a*c")) << "abc matches a*c";
+     * ```
+     */
     [[nodiscard]] bool
     is_match (std::string_view input, std::string_view pattern)
     {

package/src/test-reporter.cpp

@@ -84,8 +84,18 @@ namespace micro_os_plus::micro_test_plus
         *this << " ";
       }
     *this << colors_.fail << "FAILED" << colors_.none;
+#pragma GCC diagnostic push
+#if defined(__clang__)
+#pragma clang diagnostic ignored "-Wsign-conversion"
+#elif defined(__GNUC__)
+#pragma GCC diagnostic ignored "-Wnarrowing"
+#pragma GCC diagnostic ignored "-Wsign-conversion"
+#endif
     *this << " (" << reflection::short_name (location.file_name ()) << ":"
-          << type_traits::genuine_integral_value<int>{ location.line () };
+          << type_traits::genuine_integral_value<unsigned int>{
+               location.line ()
+             };
+#pragma GCC diagnostic pop
   }
 
   void

package/src/test-runner.cpp

@@ -31,6 +31,7 @@
 #if defined(__clang__)
 #pragma clang diagnostic ignored "-Wc++98-compat"
 #pragma clang diagnostic ignored "-Wc++98-c++11-c++14-compat"
+#pragma clang diagnostic ignored "-Wunknown-warning-option"
 #endif
 
 namespace micro_os_plus::micro_test_plus
@@ -44,6 +45,10 @@ namespace micro_os_plus::micro_test_plus
 #endif // MICRO_TEST_PLUS_TRACE
   }
 
+#pragma GCC diagnostic push
+#if defined(__clang__)
+#pragma clang diagnostic ignored "-Wunsafe-buffer-usage"
+#endif
   void
   test_runner::initialize (int argc, char* argv[], const char* name)
   {
@@ -56,6 +61,7 @@ namespace micro_os_plus::micro_test_plus
 
     default_suite_name_ = name;
 
+#if !(defined(MICRO_OS_PLUS_INCLUDE_STARTUP) && defined(MICRO_OS_PLUS_TRACE))
 #if defined(MICRO_OS_PLUS_DEBUG)
     printf ("argv[");
     for (int i = 0; i < argc; ++i)
@@ -67,7 +73,8 @@ namespace micro_os_plus::micro_test_plus
         printf ("'%s'", argv[i]);
       }
     puts ("]");
-#endif
+#endif // defined(MICRO_OS_PLUS_DEBUG)
+#endif // !defined(MICRO_OS_PLUS_INCLUDE_STARTUP)
 
     verbosity_t verbosity = verbosity::normal;
     for (int i = 0; i < argc; ++i)
@@ -91,6 +98,7 @@ namespace micro_os_plus::micro_test_plus
 
     // ------------------------------------------------------------------------
 
+#if !(defined(MICRO_OS_PLUS_INCLUDE_STARTUP) && defined(MICRO_OS_PLUS_TRACE))
     if (verbosity == verbosity::normal || verbosity == verbosity::verbose)
       {
 #if defined(__clang__)
@@ -103,7 +111,8 @@ namespace micro_os_plus::micro_test_plus
 #else
         printf ("Built with an unknown compiler");
 #endif
-#if !(defined(__APPLE__) || defined(__linux__) || defined(__unix__) || defined(WIN32))
+#if !(defined(__APPLE__) || defined(__linux__) || defined(__unix__) \
+      || defined(WIN32))
 // This is relevant only on bare-metal.
 #if defined(__ARM_PCS_VFP) || defined(__ARM_FP)
         printf (", with FP");
@@ -121,6 +130,7 @@ namespace micro_os_plus::micro_test_plus
 #endif
         puts (".");
       }
+#endif // !defined(MICRO_OS_PLUS_INCLUDE_STARTUP)
 
     // ------------------------------------------------------------------------
 
@@ -131,6 +141,7 @@ namespace micro_os_plus::micro_test_plus
     // initialisations to display their messages.
     // default_test_suite_->begin_test_suite ();
   }
+#pragma GCC diagnostic pop
 
   int
   test_runner::exit_code (void)
@@ -151,13 +162,13 @@ namespace micro_os_plus::micro_test_plus
 
             suite->begin_test_suite ();
             suite->run ();
-            suite->end_test_suite();
+            suite->end_test_suite ();
 
             was_successful &= suite->was_successful ();
           }
         if (reporter.verbosity != verbosity::silent)
           {
-            printf ("\n");
+            // printf ("\n");
           }
       }
     return was_successful ? 0 : 1;