mirror of https://github.com/cutefishos/calamares
Merge branch 'fixup-module-weights'
Adriaan de Groot
6 years ago
commit
8652a220e3
@ -0,0 +1,111 @@
|
||||
/* === This file is part of Calamares - <https://github.com/calamares> ===
|
||||
*
|
||||
* Copyright 2014-2015, Teo Mrnjavac <teo@kde.org>
|
||||
* Copyright 2018-2019, Adriaan de Groot <groot@kde.org>
|
||||
*
|
||||
* Calamares 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 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* Calamares 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 Calamares. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
#ifndef MODULESYSTEM_INSTANCEKEY_H
|
||||
#define MODULESYSTEM_INSTANCEKEY_H
|
||||
|
||||
#include <QList>
|
||||
#include <QPair>
|
||||
#include <QString>
|
||||
#include <QStringList>
|
||||
|
||||
namespace Logger
|
||||
{
|
||||
class CLog;
|
||||
}
|
||||
|
||||
namespace Calamares
|
||||
{
|
||||
namespace ModuleSystem
|
||||
{
|
||||
|
||||
/** @brief A module instance's key (`module@id`)
|
||||
*
|
||||
* A module instance is identified by both the module's name
|
||||
* (a Calamares module, e.g. `users`) and an instance id.
|
||||
* Usually, the instance id is the same as the module name
|
||||
* and the whole module instance key is `users@users`, but
|
||||
* it is possible to use the same module more than once
|
||||
* and then you distinguish those module instances by their
|
||||
* secondary id (e.g. `users@one`).
|
||||
*
|
||||
* This is supported by the *instances* configuration entry
|
||||
* in `settings.conf`.
|
||||
*/
|
||||
class InstanceKey : public QPair< QString, QString >
|
||||
{
|
||||
public:
|
||||
/// @brief Create an instance key from explicit module and id.
|
||||
InstanceKey( const QString& module, const QString& id )
|
||||
: QPair( module, id )
|
||||
{
|
||||
if ( second.isEmpty() )
|
||||
{
|
||||
second = first;
|
||||
}
|
||||
validate();
|
||||
}
|
||||
|
||||
/// @brief Create unusual, invalid instance key
|
||||
InstanceKey()
|
||||
: QPair( QString(), QString() )
|
||||
{
|
||||
}
|
||||
|
||||
/// @brief A valid module has both name and id
|
||||
bool isValid() const { return !first.isEmpty() && !second.isEmpty(); }
|
||||
|
||||
/// @brief A custom module has a non-default id
|
||||
bool isCustom() const { return first != second; }
|
||||
|
||||
QString module() const { return first; }
|
||||
QString id() const { return second; }
|
||||
|
||||
/// @brief Create instance key from stringified version
|
||||
static InstanceKey fromString( const QString& s )
|
||||
{
|
||||
QStringList moduleEntrySplit = s.split( '@' );
|
||||
if ( moduleEntrySplit.length() < 1 || moduleEntrySplit.length() > 2 )
|
||||
{
|
||||
return InstanceKey();
|
||||
}
|
||||
// For length 1, first == last
|
||||
return InstanceKey( moduleEntrySplit.first(), moduleEntrySplit.last() );
|
||||
}
|
||||
|
||||
QString toString() const
|
||||
{
|
||||
return first + '@' + second;
|
||||
}
|
||||
|
||||
private:
|
||||
/** @brief Check validity and reset module and id if needed. */
|
||||
void validate()
|
||||
{
|
||||
if ( first.contains( '@' ) || second.contains( '@' ) )
|
||||
{
|
||||
first = QString();
|
||||
second = QString();
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
} // namespace ModuleSystem
|
||||
} // namespace Calamares
|
||||
|
||||
#endif
|
||||
@ -0,0 +1,133 @@
|
||||
/* === This file is part of Calamares - <https://github.com/calamares> ===
|
||||
*
|
||||
* Copyright 2019, Adriaan de Groot <groot@kde.org>
|
||||
*
|
||||
* Calamares 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 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* Calamares 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 Calamares. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
#include "modulesystem/InstanceKey.h"
|
||||
|
||||
#include <QtTest/QtTest>
|
||||
|
||||
using Calamares::ModuleSystem::InstanceKey;
|
||||
|
||||
class ModuleSystemTests : public QObject
|
||||
{
|
||||
Q_OBJECT
|
||||
public:
|
||||
ModuleSystemTests() {}
|
||||
virtual ~ModuleSystemTests() {}
|
||||
|
||||
private Q_SLOTS:
|
||||
void initTestCase();
|
||||
|
||||
void testEmptyInstanceKey();
|
||||
void testCustomInstanceKey();
|
||||
void testFromStringInstanceKey();
|
||||
|
||||
void testBadSimpleCases();
|
||||
void testBadFromStringCases();
|
||||
};
|
||||
|
||||
void
|
||||
ModuleSystemTests::initTestCase()
|
||||
{
|
||||
}
|
||||
|
||||
void
|
||||
assert_is_invalid( const InstanceKey& k )
|
||||
{
|
||||
QVERIFY( !k.isValid() );
|
||||
QVERIFY( !k.isCustom() );
|
||||
QVERIFY( k.module().isEmpty() );
|
||||
QVERIFY( k.id().isEmpty() );
|
||||
QVERIFY( k.toString().isEmpty() );
|
||||
}
|
||||
|
||||
void
|
||||
ModuleSystemTests::testEmptyInstanceKey()
|
||||
{
|
||||
InstanceKey k0;
|
||||
assert_is_invalid( k0 );
|
||||
}
|
||||
|
||||
void
|
||||
ModuleSystemTests::testCustomInstanceKey()
|
||||
{
|
||||
InstanceKey k0( "derp", "derp" );
|
||||
QVERIFY( k0.isValid() );
|
||||
QVERIFY( !k0.isCustom() );
|
||||
QCOMPARE( k0.module(), QStringLiteral( "derp" ) );
|
||||
QCOMPARE( k0.id(), QStringLiteral( "derp" ) );
|
||||
QCOMPARE( k0.toString(), QStringLiteral( "derp@derp" ) );
|
||||
|
||||
InstanceKey k1( "derp", "horse" );
|
||||
QVERIFY( k1.isValid() );
|
||||
QVERIFY( k1.isCustom() );
|
||||
QCOMPARE( k1.module(), QStringLiteral( "derp" ) );
|
||||
QCOMPARE( k1.id(), QStringLiteral( "horse" ) );
|
||||
QCOMPARE( k1.toString(), QStringLiteral( "derp@horse" ) );
|
||||
|
||||
InstanceKey k4( "derp", QString() );
|
||||
QVERIFY( k4.isValid() );
|
||||
QVERIFY( !k4.isCustom() );
|
||||
QCOMPARE( k4.module(), QStringLiteral( "derp" ) );
|
||||
QCOMPARE( k4.id(), QStringLiteral( "derp" ) );
|
||||
QCOMPARE( k4.toString(), QStringLiteral( "derp@derp" ) );
|
||||
}
|
||||
|
||||
void
|
||||
ModuleSystemTests::testFromStringInstanceKey()
|
||||
{
|
||||
InstanceKey k0 = InstanceKey::fromString( "derp@derp" );
|
||||
QVERIFY( k0.isValid() );
|
||||
QVERIFY( !k0.isCustom() );
|
||||
QCOMPARE( k0.module(), QStringLiteral( "derp" ) );
|
||||
QCOMPARE( k0.id(), QStringLiteral( "derp" ) );
|
||||
|
||||
InstanceKey k1 = InstanceKey::fromString( "derp@horse" );
|
||||
QVERIFY( k1.isValid() );
|
||||
QVERIFY( k1.isCustom() );
|
||||
QCOMPARE( k1.module(), QStringLiteral( "derp" ) );
|
||||
QCOMPARE( k1.id(), QStringLiteral( "horse" ) );
|
||||
|
||||
InstanceKey k2 = InstanceKey::fromString( "derp" );
|
||||
QVERIFY( k2.isValid() );
|
||||
QVERIFY( !k2.isCustom() );
|
||||
QCOMPARE( k2.module(), QStringLiteral( "derp" ) );
|
||||
QCOMPARE( k2.id(), QStringLiteral( "derp" ) );
|
||||
}
|
||||
|
||||
/// @brief These are expected to fail since they show bugs in the code
|
||||
void
|
||||
ModuleSystemTests::testBadSimpleCases()
|
||||
{
|
||||
InstanceKey k4( "derp", "derp@derp" );
|
||||
assert_is_invalid( k4 );
|
||||
}
|
||||
|
||||
void
|
||||
ModuleSystemTests::testBadFromStringCases()
|
||||
{
|
||||
InstanceKey k0 = InstanceKey::fromString( QString() );
|
||||
assert_is_invalid( k0 );
|
||||
|
||||
k0 = InstanceKey::fromString( "derp@derp@derp" );
|
||||
assert_is_invalid( k0 );
|
||||
}
|
||||
|
||||
|
||||
QTEST_GUILESS_MAIN( ModuleSystemTests )
|
||||
|
||||
#include "Tests.moc"
|
||||
Loading…
Reference in New Issue