kdelibs/kdecore/tests/kdebugtest.cpp

/*  This file is part of the KDE libraries
    Copyright (C) 2022 Ivailo Monev <xakepa10@gmail.com>

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License version 2, as published by the Free Software Foundation.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
*/

#include "qtest_kde.h"
#include "kconfig.h"
#include "kconfiggroup.h"
#include "kdebug.h"

static const int s_areanumber = 123;
static const char* s_areaname = "123";
static const QString s_areafilename = QFile::encodeName(KDEBINDIR "/123.log");

static void setupArea(const char* area, const int output, const QString &filename)
{
    QFile::remove(s_areafilename);
    {
        KConfig kconfig(QString::fromLatin1("kdebugrc"), KConfig::NoGlobals);
        KConfigGroup kconfiggroup = kconfig.group(area);
        kconfiggroup.writeEntry("InfoOutput", output);
        kconfiggroup.writePathEntry("InfoFilename", filename);
        kconfiggroup.writeEntry("WarnOutput", output);
        kconfiggroup.writePathEntry("WarnFilename", filename);
        kconfiggroup.writeEntry("ErrorOutput", output);
        kconfiggroup.writePathEntry("ErrorFilename", filename);
        kconfiggroup.writeEntry("FatalOutput", output);
        kconfiggroup.writePathEntry("FatalFilename", filename);
        kconfiggroup.writeEntry("AbortFatal", false);
    }
    kClearDebugConfig();
}

static void testArea(const int area)
{
    kDebug(area) << "foo" << "info";
    kWarning(area) << "bar" << "warning";
    kError(area) << "foo" << "error";
    kFatal(area) << "bar" << "fatal";
}

class KDebugTest : public QObject
{
    Q_OBJECT
private Q_SLOTS:
    void initTestCase();
    void cleanupTestCase();

    void output_data();
    void output();

    void to_file();
    void different_output_type();
};

QTEST_KDEMAIN_CORE(KDebugTest)

void KDebugTest::initTestCase()
{
}

void KDebugTest::cleanupTestCase()
{
    QFile::remove(s_areafilename);
    ::unsetenv("KDE_DEBUG_METHODNAME");
    ::unsetenv("KDE_DEBUG_TIMESTAMP");
    ::unsetenv("KDE_DEBUG_COLOR");
}

void KDebugTest::output_data()
{
    QTest::addColumn<int>("areaoutput");
    QTest::addColumn<bool>("areafancy");
    QTest::newRow("file") << 0 << false;
    QTest::newRow("file (fancy)") << 0 << true;
    QTest::newRow("shell") << 1 << false;
    QTest::newRow("shell (fancy)") << 1 << true;
    QTest::newRow("syslog") << 2 << false;
    QTest::newRow("syslog (fancy)") << 2 << true;
    QTest::newRow("off") << 3 << false;
    QTest::newRow("off (fancy)") << 3 << true;
}

void KDebugTest::output()
{
    QFETCH(int, areaoutput);
    QFETCH(bool, areafancy);

    if (areafancy) {
        ::setenv("KDE_DEBUG_METHODNAME", "1", 1);
        ::setenv("KDE_DEBUG_TIMESTAMP", "1", 1);
        ::setenv("KDE_DEBUG_COLOR", "1", 1);
    } else {
        ::unsetenv("KDE_DEBUG_METHODNAME");
        ::unsetenv("KDE_DEBUG_TIMESTAMP");
        ::unsetenv("KDE_DEBUG_COLOR");
    }

    setupArea(s_areaname, areaoutput, s_areafilename);

    testArea(s_areanumber);
}

void KDebugTest::to_file()
{
    setupArea(s_areaname, 0, s_areafilename);

    testArea(s_areanumber);

    QFile areafile(s_areafilename);
    QVERIFY(areafile.open(QFile::ReadOnly));
    QList<QByteArray> areafilelines;
    while (!areafile.atEnd()) {
        areafilelines.append(areafile.readLine());
    }
    QCOMPARE(areafilelines.size(), 4);
}

void KDebugTest::different_output_type()
{
    QFile::remove(s_areafilename);
    {
        KConfig kconfig(QString::fromLatin1("kdebugrc"), KConfig::NoGlobals);
        KConfigGroup kconfiggroup = kconfig.group(s_areaname);
        kconfiggroup.writeEntry("InfoOutput", 0);
        kconfiggroup.writePathEntry("InfoFilename", s_areafilename);
        kconfiggroup.writeEntry("WarnOutput", 1);
        kconfiggroup.writePathEntry("WarnFilename", s_areafilename);
        kconfiggroup.writeEntry("ErrorOutput", 2);
        kconfiggroup.writePathEntry("ErrorFilename", s_areafilename);
        kconfiggroup.writeEntry("FatalOutput", 3);
        kconfiggroup.writePathEntry("FatalFilename", s_areafilename);
        kconfiggroup.writeEntry("AbortFatal", false);
    }
    kClearDebugConfig();

    testArea(s_areanumber);
}

#include "kdebugtest.moc"