mudlet/test/ProfileNameValidationTest.cpp

/***************************************************************************
 *   Copyright (C) 2026 by Vadim Peretokin - vadim.peretokin@mudlet.org    *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program 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 General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/

#include "dlgConnectionProfiles.h"
#include "utils.h"

#include <QDir>
#include <QtTest/QtTest>

/*
 * Tests for the profile name character validation used by the connection
 * dialog. Guards the character-set half of the fix for profile folders
 * duplicated outside of Mudlet (e.g. a file manager appending " (2)" to a
 * copied folder), which Mudlet must not reject - doing so greys out the
 * Connect/Offline buttons - and the rule that a name has to address a folder
 * of its own, as "." and ".." name the profiles directory and Mudlet's
 * configuration directory instead. The on-disk exemption half is covered by
 * ProfileFolderNameTest, and the deletion path by ProfileDeletionSafetyTest.
 */
class ProfileNameValidationTest : public QObject
{
    Q_OBJECT

private slots:
    void acceptableNames_data()
    {
        QTest::addColumn<QString>("name");

        QTest::newRow("plain") << qsl("Achaea");
        QTest::newRow("leading digit") << qsl("3Scapes");
        QTest::newRow("default new name") << qsl("new profile name");
        QTest::newRow("parenthesised copy suffix") << qsl("test (2)");
        QTest::newRow("parenthesised word") << qsl("StickMUD (backup)");
        QTest::newRow("windows copy suffix") << qsl("test - Copy");
        QTest::newRow("all punctuation") << qsl("a.b_c-d#e&f (g)");
        QTest::newRow("empty") << QString();
    }

    void acceptableNames()
    {
        QFETCH(QString, name);
        QVERIFY(dlgConnectionProfiles::firstInvalidProfileNameChar(name).isNull());
    }

    void rejectedNames_data()
    {
        QTest::addColumn<QString>("name");
        QTest::addColumn<QChar>("badChar");

        QTest::newRow("path separator") << qsl("test/2") << QChar('/');
        QTest::newRow("windows path separator") << qsl("test\\2") << QChar('\\');
        QTest::newRow("first of several invalid") << qsl("a/b:c") << QChar('/');
        QTest::newRow("windows drive colon") << qsl("test:2") << QChar(':');
        QTest::newRow("double quote") << qsl("test\"2") << QChar('"');
        QTest::newRow("tab") << qsl("test\t2") << QChar('\t');
        QTest::newRow("non-ascii") << qsl("café") << QChar(0x00e9);
    }

    void rejectedNames()
    {
        QFETCH(QString, name);
        QFETCH(QChar, badChar);
        QCOMPARE(dlgConnectionProfiles::firstInvalidProfileNameChar(name), badChar);
    }

    // Folders created outside of Mudlet keep their name only if the rest of
    // Mudlet can work with it - notably CredentialManager, which returns an
    // empty path rather than a sanitised one for these, leaving the profile
    // unable to store or retrieve its password.
    void usableAsIs_data()
    {
        QTest::addColumn<QString>("name");
        QTest::addColumn<bool>("usable");

        QTest::newRow("plain") << qsl("Achaea") << true;
        QTest::newRow("parenthesised copy suffix") << qsl("test (2)") << true;
        // not permitted for a new name, but harmless on disk and in a
        // credential path, so an existing folder keeps it
        QTest::newRow("non-ascii") << qsl("café") << true;
        QTest::newRow("exclamation mark") << qsl("test!") << true;
        QTest::newRow("single dot") << qsl("my.profile") << true;
        QTest::newRow("version number") << qsl("Achaea 2.0") << true;

        QTest::newRow("empty") << QString() << false;
        QTest::newRow("current directory") << qsl(".") << false;
        QTest::newRow("parent directory") << qsl("..") << false;
        QTest::newRow("parent directory in a path") << qsl("../..") << false;
        QTest::newRow("embedded parent directory") << qsl("test..2") << false;
        QTest::newRow("path separator") << qsl("test/2") << false;
        QTest::newRow("windows path separator") << qsl("test\\2") << false;
        QTest::newRow("colon") << qsl("test:2") << false;
        QTest::newRow("pipe") << qsl("test|2") << false;
        QTest::newRow("asterisk") << qsl("test*2") << false;
        QTest::newRow("question mark") << qsl("test?2") << false;
        QTest::newRow("angle brackets") << qsl("<test>") << false;
        QTest::newRow("double quote") << qsl("test\"2") << false;
        QTest::newRow("control character") << qsl("test\x01 2") << false;
    }

    void usableAsIs()
    {
        QFETCH(QString, name);
        QFETCH(bool, usable);
        QCOMPARE(dlgConnectionProfiles::profileNameUsableAsIs(name), usable);
    }

    // No path at all means nothing for the deletion to act on
    void folderPath_data()
    {
        QTest::addColumn<QString>("name");
        QTest::addColumn<QString>("expectedPath");

        const QString profilesPath = qsl("/home/user/.config/mudlet/profiles");

        QTest::newRow("plain") << qsl("Achaea") << qsl("%1/Achaea").arg(profilesPath);
        QTest::newRow("version number") << qsl("Achaea 2.0") << qsl("%1/Achaea 2.0").arg(profilesPath);
        QTest::newRow("parentheses") << qsl("test (2)") << qsl("%1/test (2)").arg(profilesPath);
        QTest::newRow("non-ascii") << qsl("café") << qsl("%1/café").arg(profilesPath);
        QTest::newRow("cyrillic") << qsl("Мудлет") << qsl("%1/Мудлет").arg(profilesPath);
        QTest::newRow("leading dot") << qsl(".hidden") << qsl("%1/.hidden").arg(profilesPath);

        QTest::newRow("current directory") << qsl(".") << QString();
        QTest::newRow("parent directory") << qsl("..") << QString();
        QTest::newRow("grandparent directory") << qsl("../..") << QString();
        QTest::newRow("traversal back in") << qsl("../profiles/Achaea") << QString();
        QTest::newRow("nested") << qsl("Achaea/current") << QString();
        QTest::newRow("windows separator") << qsl("Achaea\\current") << QString();
        QTest::newRow("absolute path") << qsl("/etc") << QString();
        QTest::newRow("empty") << QString() << QString();
    }

    void folderPath()
    {
        QFETCH(QString, name);
        QFETCH(QString, expectedPath);
        QCOMPARE(dlgConnectionProfiles::profileFolderPath(qsl("/home/user/.config/mudlet/profiles"), name), expectedPath);
    }

    // The profiles directory is a native path, so every platform's root counts
    void folderPathHandlesNativeRoots_data()
    {
        QTest::addColumn<QString>("profilesPath");

        QTest::newRow("posix") << qsl("/home/user/.config/mudlet/profiles");
        QTest::newRow("windows drive") << qsl("C:/Users/user/.config/mudlet/profiles");
        QTest::newRow("windows unc") << qsl("//server/share/mudlet/profiles");
        QTest::newRow("macos") << qsl("/Users/user/Library/Application Support/mudlet/profiles");
    }

    void folderPathHandlesNativeRoots()
    {
        QFETCH(QString, profilesPath);

        // a UNC root keeps its leading "//" on Windows and loses it elsewhere,
        // so compare against the cleaned root rather than what was passed in
        const QString root = QDir::cleanPath(profilesPath);
        QCOMPARE(dlgConnectionProfiles::profileFolderPath(profilesPath, qsl("Achaea")), qsl("%1/Achaea").arg(root));
        QVERIFY(dlgConnectionProfiles::profileFolderPath(profilesPath, qsl(".")).isEmpty());
        QVERIFY(dlgConnectionProfiles::profileFolderPath(profilesPath, qsl("..")).isEmpty());
        QVERIFY(dlgConnectionProfiles::profileFolderPath(profilesPath, qsl("../..")).isEmpty());
    }

    void folderPathIgnoresTrailingSeparator()
    {
        QCOMPARE(dlgConnectionProfiles::profileFolderPath(qsl("/home/user/.config/mudlet/profiles/"), qsl("Achaea")), qsl("/home/user/.config/mudlet/profiles/Achaea"));
        QCOMPARE(dlgConnectionProfiles::profileFolderPath(qsl("/home/user/.config/mudlet/profiles/"), qsl(".")), QString());
    }
};

QTEST_GUILESS_MAIN(ProfileNameValidationTest)
#include "ProfileNameValidationTest.moc"