1f57a99ff2
- "custom" is a misnomer, so drop that from the name - tests adjusted: all instances are returned, not just the "custom" ones.
454 lines
13 KiB
C++
454 lines
13 KiB
C++
/* === This file is part of Calamares - <https://github.com/calamares> ===
|
|
*
|
|
* SPDX-FileCopyrightText: 2018-2020 Adriaan de Groot <groot@kde.org>
|
|
* SPDX-License-Identifier: GPL-3.0-or-later
|
|
*
|
|
*
|
|
* 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 "GlobalStorage.h"
|
|
#include "Settings.h"
|
|
#include "modulesystem/InstanceKey.h"
|
|
|
|
#include "utils/Logger.h"
|
|
|
|
#include <QObject>
|
|
#include <QSignalSpy>
|
|
#include <QtTest/QtTest>
|
|
|
|
class TestLibCalamares : public QObject
|
|
{
|
|
Q_OBJECT
|
|
public:
|
|
TestLibCalamares() {}
|
|
virtual ~TestLibCalamares() {}
|
|
|
|
private Q_SLOTS:
|
|
void testGSModify();
|
|
void testGSLoadSave();
|
|
void testGSLoadSave2();
|
|
void testGSLoadSaveYAMLStringList();
|
|
|
|
void testInstanceKey();
|
|
void testInstanceDescription();
|
|
|
|
void testSettings();
|
|
};
|
|
|
|
void
|
|
TestLibCalamares::testGSModify()
|
|
{
|
|
Calamares::GlobalStorage gs;
|
|
QSignalSpy spy( &gs, &Calamares::GlobalStorage::changed );
|
|
|
|
const QString key( "derp" );
|
|
|
|
QCOMPARE( gs.count(), 0 );
|
|
QVERIFY( !gs.contains( key ) );
|
|
|
|
const int value = 17;
|
|
gs.insert( key, value );
|
|
QCOMPARE( gs.count(), 1 );
|
|
QVERIFY( gs.contains( key ) );
|
|
QCOMPARE( gs.value( key ).type(), QVariant::Int );
|
|
QCOMPARE( gs.value( key ).toString(), QString( "17" ) ); // It isn't a string, but does convert
|
|
QCOMPARE( gs.value( key ).toInt(), value );
|
|
|
|
gs.remove( key );
|
|
QCOMPARE( gs.count(), 0 );
|
|
QVERIFY( !gs.contains( key ) );
|
|
|
|
QCOMPARE( spy.count(), 2 ); // one insert, one remove
|
|
}
|
|
|
|
void
|
|
TestLibCalamares::testGSLoadSave()
|
|
{
|
|
Calamares::GlobalStorage gs;
|
|
const QString jsonfilename( "gs.test.json" );
|
|
const QString yamlfilename( "gs.test.yaml" );
|
|
|
|
gs.insert( "derp", 17 );
|
|
gs.insert( "cow", "moo" );
|
|
|
|
QVariantList l;
|
|
for ( const auto& s : QStringList { "dopey", "sneezy" } )
|
|
{
|
|
l.append( s );
|
|
}
|
|
gs.insert( "dwarfs", l );
|
|
|
|
QCOMPARE( gs.count(), 3 );
|
|
|
|
QVERIFY( gs.saveJson( jsonfilename ) );
|
|
Calamares::GlobalStorage gs2;
|
|
QCOMPARE( gs2.count(), 0 );
|
|
QVERIFY( gs2.loadJson( jsonfilename ) );
|
|
QCOMPARE( gs2.count(), 3 );
|
|
QCOMPARE( gs2.data(), gs.data() );
|
|
|
|
QVERIFY( gs.saveYaml( yamlfilename ) );
|
|
Calamares::GlobalStorage gs3;
|
|
QCOMPARE( gs3.count(), 0 );
|
|
QVERIFY( gs3.loadYaml( jsonfilename ) );
|
|
QCOMPARE( gs3.count(), 3 );
|
|
QCOMPARE( gs3.data(), gs.data() );
|
|
|
|
// YAML can load as JSON!
|
|
QVERIFY( gs3.loadYaml( jsonfilename ) );
|
|
QCOMPARE( gs3.count(), 3 );
|
|
QCOMPARE( gs3.data(), gs.data() );
|
|
|
|
// Failures in loading
|
|
QVERIFY( !gs3.loadJson( yamlfilename ) );
|
|
|
|
Calamares::GlobalStorage gs4;
|
|
gs4.insert( "derp", 32 );
|
|
gs4.insert( "dorp", "Varsseveld" );
|
|
QCOMPARE( gs4.count(), 2 );
|
|
QVERIFY( gs4.contains( "dorp" ) );
|
|
QCOMPARE( gs4.value( "derp" ).toInt(), 32 );
|
|
QVERIFY( gs4.loadJson( jsonfilename ) );
|
|
// 3 keys from the file, but one overwrite
|
|
QCOMPARE( gs4.count(), 4 );
|
|
QVERIFY( gs4.contains( "dorp" ) );
|
|
QCOMPARE( gs4.value( "derp" ).toInt(), 17 ); // This one was overwritten
|
|
}
|
|
|
|
void
|
|
TestLibCalamares::testGSLoadSave2()
|
|
{
|
|
Logger::setupLogLevel( Logger::LOGDEBUG );
|
|
|
|
const QString filename( "../src/libcalamares/testdata/yaml-list.conf" );
|
|
if ( !QFile::exists( filename ) )
|
|
{
|
|
return;
|
|
}
|
|
|
|
Calamares::GlobalStorage gs1;
|
|
const QString key( "dwarfs" );
|
|
|
|
QVERIFY( gs1.loadYaml( filename ) );
|
|
QCOMPARE( gs1.count(), 3 ); // From examining the file
|
|
QVERIFY( gs1.contains( key ) );
|
|
cDebug() << gs1.value( key ).type() << gs1.value( key );
|
|
QCOMPARE( gs1.value( key ).type(), QVariant::List );
|
|
|
|
const QString yamlfilename( "gs.test.yaml" );
|
|
QVERIFY( gs1.saveYaml( yamlfilename ) );
|
|
|
|
Calamares::GlobalStorage gs2;
|
|
QVERIFY( gs2.loadYaml( yamlfilename ) );
|
|
QVERIFY( gs2.contains( key ) );
|
|
QCOMPARE( gs2.value( key ).type(), QVariant::List );
|
|
}
|
|
|
|
void
|
|
TestLibCalamares::testGSLoadSaveYAMLStringList()
|
|
{
|
|
Calamares::GlobalStorage gs;
|
|
const QString yamlfilename( "gs.test.yaml" );
|
|
|
|
gs.insert( "derp", 17 );
|
|
gs.insert( "cow", "moo" );
|
|
gs.insert( "dwarfs", QStringList { "happy", "dopey", "sleepy", "sneezy", "doc", "thorin", "balin" } );
|
|
|
|
QCOMPARE( gs.count(), 3 );
|
|
QCOMPARE( gs.value( "dwarfs" ).toList().count(), 7 ); // There's seven dwarfs, right?
|
|
QVERIFY( gs.value( "dwarfs" ).toStringList().contains( "thorin" ) );
|
|
QVERIFY( !gs.value( "dwarfs" ).toStringList().contains( "gimli" ) );
|
|
|
|
|
|
QVERIFY( gs.saveYaml( yamlfilename ) );
|
|
|
|
Calamares::GlobalStorage gs2;
|
|
QCOMPARE( gs2.count(), 0 );
|
|
QVERIFY( gs2.loadYaml( yamlfilename ) );
|
|
QCOMPARE( gs2.count(), 3 );
|
|
QEXPECT_FAIL( "", "QStringList doesn't write out nicely", Continue );
|
|
QCOMPARE( gs2.value( "dwarfs" ).toList().count(), 7 ); // There's seven dwarfs, right?
|
|
QCOMPARE( gs2.value( "dwarfs" ).toString(), QStringLiteral( "<QStringList>" ) ); // .. they're gone
|
|
}
|
|
|
|
void
|
|
TestLibCalamares::testInstanceKey()
|
|
{
|
|
using InstanceKey = Calamares::ModuleSystem::InstanceKey;
|
|
{
|
|
InstanceKey k;
|
|
QVERIFY( !k.isValid() );
|
|
QVERIFY( !k.isCustom() );
|
|
QVERIFY( k.module().isEmpty() );
|
|
}
|
|
{
|
|
InstanceKey k( QStringLiteral( "welcome" ), QString() );
|
|
QVERIFY( k.isValid() );
|
|
QVERIFY( !k.isCustom() );
|
|
QCOMPARE( k.module(), QStringLiteral( "welcome" ) );
|
|
QCOMPARE( k.id(), QStringLiteral( "welcome" ) );
|
|
}
|
|
{
|
|
InstanceKey k( QStringLiteral( "shellprocess" ), QStringLiteral( "zfssetup" ) );
|
|
QVERIFY( k.isValid() );
|
|
QVERIFY( k.isCustom() );
|
|
QCOMPARE( k.module(), QStringLiteral( "shellprocess" ) );
|
|
QCOMPARE( k.id(), QStringLiteral( "zfssetup" ) );
|
|
}
|
|
|
|
{
|
|
// This is a bad idea, names and ids with odd punctuation
|
|
InstanceKey k( QStringLiteral( " o__O " ), QString() );
|
|
QVERIFY( k.isValid() );
|
|
QVERIFY( !k.isCustom() );
|
|
QCOMPARE( k.module(), QStringLiteral( " o__O " ) );
|
|
}
|
|
{
|
|
// .. but @ is disallowed
|
|
InstanceKey k( QStringLiteral( "welcome@hi" ), QString() );
|
|
QVERIFY( !k.isValid() );
|
|
QVERIFY( !k.isCustom() );
|
|
QVERIFY( k.module().isEmpty() );
|
|
}
|
|
|
|
{
|
|
InstanceKey k = InstanceKey::fromString( "welcome" );
|
|
QVERIFY( k.isValid() );
|
|
QVERIFY( !k.isCustom() );
|
|
QCOMPARE( k.module(), QStringLiteral( "welcome" ) );
|
|
QCOMPARE( k.id(), QStringLiteral( "welcome" ) );
|
|
}
|
|
{
|
|
InstanceKey k = InstanceKey::fromString( "welcome@welcome" );
|
|
QVERIFY( k.isValid() );
|
|
QVERIFY( !k.isCustom() );
|
|
QCOMPARE( k.module(), QStringLiteral( "welcome" ) );
|
|
QCOMPARE( k.id(), QStringLiteral( "welcome" ) );
|
|
}
|
|
|
|
{
|
|
InstanceKey k = InstanceKey::fromString( "welcome@hi" );
|
|
QVERIFY( k.isValid() );
|
|
QVERIFY( k.isCustom() );
|
|
QCOMPARE( k.module(), QStringLiteral( "welcome" ) );
|
|
QCOMPARE( k.id(), QStringLiteral( "hi" ) );
|
|
}
|
|
{
|
|
InstanceKey k = InstanceKey::fromString( "welcome@hi@hi" );
|
|
QVERIFY( !k.isValid() );
|
|
QVERIFY( !k.isCustom() );
|
|
QVERIFY( k.module().isEmpty() );
|
|
QVERIFY( k.id().isEmpty() );
|
|
}
|
|
}
|
|
|
|
void
|
|
TestLibCalamares::testInstanceDescription()
|
|
{
|
|
using InstanceDescription = Calamares::InstanceDescription;
|
|
using InstanceKey = Calamares::ModuleSystem::InstanceKey;
|
|
|
|
// With invalid keys
|
|
//
|
|
//
|
|
{
|
|
InstanceDescription d;
|
|
QVERIFY( !d.isValid() );
|
|
QVERIFY( !d.isCustom() );
|
|
QCOMPARE( d.weight(), 0 );
|
|
QVERIFY( d.configFileName().isEmpty() );
|
|
}
|
|
|
|
{
|
|
InstanceDescription d( InstanceKey(), 0 );
|
|
QVERIFY( !d.isValid() );
|
|
QVERIFY( !d.isCustom() );
|
|
QCOMPARE( d.weight(), 0 );
|
|
QVERIFY( d.configFileName().isEmpty() );
|
|
}
|
|
|
|
{
|
|
InstanceDescription d( InstanceKey(), 100 );
|
|
QVERIFY( !d.isValid() );
|
|
QVERIFY( !d.isCustom() );
|
|
QCOMPARE( d.weight(), 0 );
|
|
QVERIFY( d.configFileName().isEmpty() );
|
|
}
|
|
|
|
// Private constructor
|
|
//
|
|
// This doesn't set up the config file yet.
|
|
{
|
|
InstanceDescription d( InstanceKey::fromString( "welcome" ), 0 );
|
|
QVERIFY( d.isValid() );
|
|
QVERIFY( !d.isCustom() );
|
|
QCOMPARE( d.weight(), 1 ); // **now** the constraints kick in
|
|
QVERIFY( d.configFileName().isEmpty() );
|
|
}
|
|
|
|
{
|
|
InstanceDescription d( InstanceKey::fromString( "welcome@hi" ), 0 );
|
|
QVERIFY( d.isValid() );
|
|
QVERIFY( d.isCustom() );
|
|
QCOMPARE( d.weight(), 1 ); // **now** the constraints kick in
|
|
QVERIFY( d.configFileName().isEmpty() );
|
|
}
|
|
|
|
{
|
|
InstanceDescription d( InstanceKey::fromString( "welcome@hi" ), 75 );
|
|
QCOMPARE( d.weight(), 75 );
|
|
}
|
|
{
|
|
InstanceDescription d( InstanceKey::fromString( "welcome@hi" ), 105 );
|
|
QCOMPARE( d.weight(), 100 );
|
|
}
|
|
|
|
|
|
// From settings, normal program flow
|
|
//
|
|
//
|
|
{
|
|
QVariantMap m;
|
|
|
|
InstanceDescription d = InstanceDescription::fromSettings( m );
|
|
QVERIFY( !d.isValid() );
|
|
}
|
|
{
|
|
QVariantMap m;
|
|
m.insert( "name", "welcome" );
|
|
|
|
InstanceDescription d = InstanceDescription::fromSettings( m );
|
|
QVERIFY( !d.isValid() );
|
|
}
|
|
{
|
|
QVariantMap m;
|
|
m.insert( "module", "welcome" );
|
|
|
|
InstanceDescription d = InstanceDescription::fromSettings( m );
|
|
QVERIFY( d.isValid() );
|
|
QVERIFY( !d.isCustom() );
|
|
QCOMPARE( d.weight(), 1 );
|
|
QCOMPARE( d.key().module(), QString( "welcome" ) );
|
|
QCOMPARE( d.key().id(), QString( "welcome" ) );
|
|
QCOMPARE( d.configFileName(), QString( "welcome.conf" ) );
|
|
}
|
|
{
|
|
QVariantMap m;
|
|
m.insert( "module", "welcome" );
|
|
m.insert( "id", "hi" );
|
|
m.insert( "weight", "17" ); // String, that's kind of bogus
|
|
|
|
InstanceDescription d = InstanceDescription::fromSettings( m );
|
|
QVERIFY( d.isValid() );
|
|
QVERIFY( d.isCustom() );
|
|
QCOMPARE( d.weight(), 17 );
|
|
QCOMPARE( d.key().module(), QString( "welcome" ) );
|
|
QCOMPARE( d.key().id(), QString( "hi" ) );
|
|
QCOMPARE( d.configFileName(), QString( "welcome.conf" ) );
|
|
}
|
|
{
|
|
QVariantMap m;
|
|
m.insert( "module", "welcome" );
|
|
m.insert( "id", "hi" );
|
|
m.insert( "weight", 134 );
|
|
m.insert( "config", "hi.conf" );
|
|
|
|
InstanceDescription d = InstanceDescription::fromSettings( m );
|
|
QVERIFY( d.isValid() );
|
|
QVERIFY( d.isCustom() );
|
|
QCOMPARE( d.weight(), 100 );
|
|
QCOMPARE( d.key().module(), QString( "welcome" ) );
|
|
QCOMPARE( d.key().id(), QString( "hi" ) );
|
|
QCOMPARE( d.configFileName(), QString( "hi.conf" ) );
|
|
}
|
|
}
|
|
|
|
void
|
|
TestLibCalamares::testSettings()
|
|
{
|
|
{
|
|
Calamares::Settings s( false );
|
|
QVERIFY( !s.debugMode() );
|
|
}
|
|
{
|
|
Calamares::Settings s( true );
|
|
QVERIFY( s.debugMode() );
|
|
QVERIFY( s.moduleInstances().isEmpty() );
|
|
QVERIFY( s.modulesSequence().isEmpty() );
|
|
QVERIFY( s.brandingComponentName().isEmpty() );
|
|
|
|
s.setConfiguration( R"(---
|
|
instances:
|
|
- module: welcome
|
|
id: hi
|
|
weight: 75
|
|
- module: welcome
|
|
id: yo
|
|
config: yolo.conf
|
|
sequence:
|
|
- show:
|
|
- welcome@hi
|
|
- welcome@yo
|
|
- dummycpp
|
|
- summary
|
|
- exec:
|
|
- welcome@hi
|
|
)",
|
|
QStringLiteral( "<testdata>" ) );
|
|
|
|
QVERIFY( s.debugMode() );
|
|
QCOMPARE( s.moduleInstances().count(), 4 ); // there are 4 module instances mentioned
|
|
QCOMPARE( s.modulesSequence().count(), 2 ); // 2 steps (show, exec)
|
|
QVERIFY( s.brandingComponentName().isEmpty() );
|
|
|
|
// Make a lambda where we can adjust what it looks for from the outside,
|
|
// by capturing a reference.
|
|
QString moduleKey = QString( "welcome" );
|
|
auto moduleFinder = [&moduleKey]( const Calamares::InstanceDescription& d ) {
|
|
return d.isValid() && d.key().module() == moduleKey;
|
|
};
|
|
|
|
const auto it0 = std::find_if(
|
|
s.moduleInstances().constBegin(), s.moduleInstances().constEnd(), moduleFinder );
|
|
QVERIFY( it0 != s.moduleInstances().constEnd() );
|
|
|
|
moduleKey = QString( "derp" );
|
|
const auto it1 = std::find_if(
|
|
s.moduleInstances().constBegin(), s.moduleInstances().constEnd(), moduleFinder );
|
|
QVERIFY( it1 == s.moduleInstances().constEnd() );
|
|
|
|
int validCount = 0;
|
|
int customCount = 0;
|
|
for ( const auto& d : s.moduleInstances() )
|
|
{
|
|
if ( d.isValid() )
|
|
validCount++;
|
|
if ( d.isCustom() )
|
|
customCount++;
|
|
QVERIFY( d.isCustom() ? d.isValid() : true ); // All custom entries are valid
|
|
}
|
|
QCOMPARE( customCount, 2 );
|
|
QCOMPARE( validCount, 4 ); // welcome@hi is listed twice, in *show* and *exec*
|
|
}
|
|
}
|
|
|
|
|
|
QTEST_GUILESS_MAIN( TestLibCalamares )
|
|
|
|
#include "utils/moc-warnings.h"
|
|
|
|
#include "Tests.moc"
|