applying editor part of patch, see #15003

[wxWidgets.git] / tests / log / logtest.cpp

diff --git a/tests/log/logtest.cpp b/tests/log/logtest.cpp
index 089ef82c51182d3429c05f15c5ca5b3fddff3e04..4ee9b2b38faa0443bc24a82a56742ea48859cc58 100644 (file)
--- a/tests/log/logtest.cpp
+++ b/tests/log/logtest.cpp
@@ -19,10 +19,22 @@
 
 #ifndef WX_PRECOMP
     #include "wx/log.h"
 
 #ifndef WX_PRECOMP
     #include "wx/log.h"

+    #include "wx/filefn.h"

 #endif // WX_PRECOMP
 
 #include "wx/scopeguard.h"
 
 #endif // WX_PRECOMP
 
 #include "wx/scopeguard.h"
 

+#if WXWIN_COMPATIBILITY_2_8
+    // we override deprecated DoLog() and DoLogString() in this test, suppress
+    // warnings about it
+    #if wxCHECK_VISUALC_VERSION(7)
+        #pragma warning(disable: 4996)
+    #endif // VC++ 7+
+#endif // WXWIN_COMPATIBILITY_2_8
+
+// all calls to wxLogXXX() functions from this file will use this log component
+#define wxLOG_COMPONENT "test"
+

 // ----------------------------------------------------------------------------
 // test loggers
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // test loggers
 // ----------------------------------------------------------------------------


@@ -34,19 +46,28 @@ class TestLogBase : public wxLog
 public:
     TestLogBase() { }
 
 public:
     TestLogBase() { }
 

-    wxString GetLog(wxLogLevel level) const
+    const wxString& GetLog(wxLogLevel level) const

     {
         return m_logs[level];
     }
 
     {
         return m_logs[level];
     }
 

+    const wxLogRecordInfo& GetInfo(wxLogLevel level) const
+    {
+        return m_logsInfo[level];
+    }
+

     void Clear()
     {
         for ( unsigned n = 0; n < WXSIZEOF(m_logs); n++ )
     void Clear()
     {
         for ( unsigned n = 0; n < WXSIZEOF(m_logs); n++ )

+        {

             m_logs[n].clear();
             m_logs[n].clear();

+            m_logsInfo[n] = wxLogRecordInfo();
+        }

     }
 
 protected:
     wxString m_logs[wxLOG_Trace + 1];
     }
 
 protected:
     wxString m_logs[wxLOG_Trace + 1];

+    wxLogRecordInfo m_logsInfo[wxLOG_Trace + 1];

 
     wxDECLARE_NO_COPY_CLASS(TestLogBase);
 };
 
     wxDECLARE_NO_COPY_CLASS(TestLogBase);
 };


@@ -60,9 +81,10 @@ public:
 protected:
     virtual void DoLogRecord(wxLogLevel level,
                              const wxString& msg,
 protected:
     virtual void DoLogRecord(wxLogLevel level,
                              const wxString& msg,

-                             const wxLogRecordInfo& WXUNUSED(info))
+                             const wxLogRecordInfo& info)

     {
         m_logs[level] = msg;
     {
         m_logs[level] = msg;

+        m_logsInfo[level] = info;

     }
 
 private:
     }
 
 private:


@@ -139,6 +161,7 @@ private:
     CPPUNIT_TEST_SUITE( LogTestCase );
         CPPUNIT_TEST( Functions );
         CPPUNIT_TEST( Null );
     CPPUNIT_TEST_SUITE( LogTestCase );
         CPPUNIT_TEST( Functions );
         CPPUNIT_TEST( Null );

+        CPPUNIT_TEST( Component );

 #if wxDEBUG_LEVEL
         CPPUNIT_TEST( Trace );
 #endif // wxDEBUG_LEVEL
 #if wxDEBUG_LEVEL
         CPPUNIT_TEST( Trace );
 #endif // wxDEBUG_LEVEL


@@ -146,10 +169,12 @@ private:
         CPPUNIT_TEST( CompatLogger );
         CPPUNIT_TEST( CompatLogger2 );
 #endif // WXWIN_COMPATIBILITY_2_8
         CPPUNIT_TEST( CompatLogger );
         CPPUNIT_TEST( CompatLogger2 );
 #endif // WXWIN_COMPATIBILITY_2_8

+        CPPUNIT_TEST( SysError );

     CPPUNIT_TEST_SUITE_END();
 
     void Functions();
     void Null();
     CPPUNIT_TEST_SUITE_END();
 
     void Functions();
     void Null();

+    void Component();

 #if wxDEBUG_LEVEL
     void Trace();
 #endif // wxDEBUG_LEVEL
 #if wxDEBUG_LEVEL
     void Trace();
 #endif // wxDEBUG_LEVEL


@@ -157,6 +182,7 @@ private:
     void CompatLogger();
     void CompatLogger2();
 #endif // WXWIN_COMPATIBILITY_2_8
     void CompatLogger();
     void CompatLogger2();
 #endif // WXWIN_COMPATIBILITY_2_8

+    void SysError();

 
     TestLog *m_log;
     wxLog *m_logOld;
 
     TestLog *m_log;
     wxLog *m_logOld;


@@ -168,7 +194,7 @@ private:
 // register in the unnamed registry so that these tests are run by default
 CPPUNIT_TEST_SUITE_REGISTRATION( LogTestCase );
 
 // register in the unnamed registry so that these tests are run by default
 CPPUNIT_TEST_SUITE_REGISTRATION( LogTestCase );
 

-// also include in it's own registry so that these tests can be run alone
+// also include in its own registry so that these tests can be run alone

 CPPUNIT_TEST_SUITE_NAMED_REGISTRATION( LogTestCase, "LogTestCase" );
 
 void LogTestCase::setUp()
 CPPUNIT_TEST_SUITE_NAMED_REGISTRATION( LogTestCase, "LogTestCase" );
 
 void LogTestCase::setUp()


@@ -212,24 +238,78 @@ void LogTestCase::Null()
     CPPUNIT_ASSERT_EQUAL( "Important warning", m_log->GetLog(wxLOG_Warning) );
 }
 
     CPPUNIT_ASSERT_EQUAL( "Important warning", m_log->GetLog(wxLOG_Warning) );
 }
 

+void LogTestCase::Component()
+{
+    wxLogMessage("Message");
+    CPPUNIT_ASSERT_EQUAL( wxLOG_COMPONENT,
+                          m_log->GetInfo(wxLOG_Message).component );
+
+    // completely disable logging for this component
+    wxLog::SetComponentLevel("test/ignore", wxLOG_FatalError);
+
+    // but enable it for one of its subcomponents
+    wxLog::SetComponentLevel("test/ignore/not", wxLOG_Max);
+
+    #undef wxLOG_COMPONENT
+    #define wxLOG_COMPONENT "test/ignore"
+
+    // this shouldn't be output as this component is ignored
+    wxLogError("Error");
+    CPPUNIT_ASSERT_EQUAL( "", m_log->GetLog(wxLOG_Error) );
+
+    // and so are its subcomponents
+    #undef wxLOG_COMPONENT
+    #define wxLOG_COMPONENT "test/ignore/sub/subsub"
+    wxLogError("Error");
+    CPPUNIT_ASSERT_EQUAL( "", m_log->GetLog(wxLOG_Error) );
+
+    // but one subcomponent is not
+    #undef wxLOG_COMPONENT
+    #define wxLOG_COMPONENT "test/ignore/not"
+    wxLogError("Error");
+    CPPUNIT_ASSERT_EQUAL( "Error", m_log->GetLog(wxLOG_Error) );
+
+    // restore the original value
+    #undef wxLOG_COMPONENT
+    #define wxLOG_COMPONENT "test"
+}
+

 #if wxDEBUG_LEVEL
 
 #if wxDEBUG_LEVEL
 

+namespace
+{
+
+const char *TEST_MASK = "test";
+
+// this is a test vararg function (a real one, not a variadic-template-like as
+// wxVLogTrace(), so care should be taken with its arguments)
+void TraceTest(const char *format, ...)
+{
+    va_list argptr;
+    va_start(argptr, format);
+    wxVLogTrace(TEST_MASK, format, argptr);
+    va_end(argptr);
+}
+
+} // anonymous namespace
+

 void LogTestCase::Trace()
 {
 void LogTestCase::Trace()
 {

-    static const char *TEST_MASK = "test";
+    // we use wxLogTrace() or wxVLogTrace() from inside TraceTest()
+    // interchangeably here, it shouldn't make any difference

 
     wxLogTrace(TEST_MASK, "Not shown");
     CPPUNIT_ASSERT_EQUAL( "", m_log->GetLog(wxLOG_Trace) );
 
     wxLog::AddTraceMask(TEST_MASK);
 
     wxLogTrace(TEST_MASK, "Not shown");
     CPPUNIT_ASSERT_EQUAL( "", m_log->GetLog(wxLOG_Trace) );
 
     wxLog::AddTraceMask(TEST_MASK);

-    wxLogTrace(TEST_MASK, "Shown");
+    TraceTest("Shown");

     CPPUNIT_ASSERT_EQUAL( wxString::Format("(%s) Shown", TEST_MASK),
                           m_log->GetLog(wxLOG_Trace) );
 
     wxLog::RemoveTraceMask(TEST_MASK);
     m_log->Clear();
 
     CPPUNIT_ASSERT_EQUAL( wxString::Format("(%s) Shown", TEST_MASK),
                           m_log->GetLog(wxLOG_Trace) );
 
     wxLog::RemoveTraceMask(TEST_MASK);
     m_log->Clear();
 

-    wxLogTrace(TEST_MASK, "Not shown again");
+    TraceTest("Not shown again");

     CPPUNIT_ASSERT_EQUAL( "", m_log->GetLog(wxLOG_Trace) );
 }
 
     CPPUNIT_ASSERT_EQUAL( "", m_log->GetLog(wxLOG_Trace) );
 }
 


@@ -258,3 +338,28 @@ void LogTestCase::CompatLogger2()
 }
 
 #endif // WXWIN_COMPATIBILITY_2_8
 }
 
 #endif // WXWIN_COMPATIBILITY_2_8

+
+void LogTestCase::SysError()
+{
+    wxString s;
+
+    wxLogSysError(17, "Error");
+    CPPUNIT_ASSERT( m_log->GetLog(wxLOG_Error).StartsWith("Error (", &s) );
+    WX_ASSERT_MESSAGE( ("Error message is \"(%s\"", s), s.StartsWith("error 17") );
+
+    // The last error code seems to be set somewhere in MinGW CRT as its value
+    // is just not what we expect (ERROR_INVALID_PARAMETER instead of 0 and 0
+    // instead of ERROR_FILE_NOT_FOUND) so exclude the tests which rely on last
+    // error being preserved for this compiler.
+#ifndef __MINGW32__
+    wxLogSysError("Success");
+    CPPUNIT_ASSERT( m_log->GetLog(wxLOG_Error).StartsWith("Success (", &s) );
+    WX_ASSERT_MESSAGE( ("Error message is \"(%s\"", s), s.StartsWith("error 0") );
+
+    wxOpen("no-such-file", 0, 0);
+    wxLogSysError("Not found");
+    CPPUNIT_ASSERT( m_log->GetLog(wxLOG_Error).StartsWith("Not found (", &s) );
+    WX_ASSERT_MESSAGE( ("Error message is \"(%s\"", s), s.StartsWith("error 2") );
+#endif // __MINGW32__
+}
+