napcok/calamares
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge branch 'fixup-module-weights'

Browse Source
This commit is contained in:
Adriaan de Groot 2019-09-15 20:39:08 +02:00
commit 8652a220e3
9 changed files with 383 additions and 122 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
src/calamares/CalamaresApplication.cpp
View File

@ -39,6 +39,7 @@
#include <QDesktopWidget>
#include <QDir>
#include <QFileInfo>
#include <QTimer>
CalamaresApplication::CalamaresApplication( int& argc, char* argv[] )
@ -354,7 +355,7 @@ CalamaresApplication::initView()
connect( m_moduleManager, &Calamares::ModuleManager::modulesLoaded, this, &CalamaresApplication::initViewSteps );
connect( m_moduleManager, &Calamares::ModuleManager::modulesFailed, this, &CalamaresApplication::initFailed );
m_moduleManager->loadModules();
QTimer::singleShot( 0, m_moduleManager, &Calamares::ModuleManager::loadModules );
m_mainwindow->move( this->desktop()->availableGeometry().center() - m_mainwindow->rect().center() );

10
src/libcalamares/CMakeLists.txt
View File

@ -207,6 +207,16 @@ if ( ECM_FOUND AND BUILD_TESTING )
Qt5::Test
)
calamares_automoc( libcalamaresnetworktest )
ecm_add_test(
modulesystem/Tests.cpp
TEST_NAME
libcalamaresmodulesystemtest
LINK_LIBRARIES
calamares
Qt5::Test
)
calamares_automoc( libcalamaresmodulesystemtest )
endif()
if( BUILD_TESTING )

6
src/libcalamares/Settings.cpp
View File

@ -169,14 +169,14 @@ interpretSequence( const YAML::Node& node, Settings::ModuleSequence& moduleSeque
continue;
}
QString thisActionS = sequenceVListItem.toMap().firstKey();
ModuleAction thisAction;
ModuleSystem::Action thisAction;
if ( thisActionS == "show" )
{
thisAction = ModuleAction::Show;
thisAction = ModuleSystem::Action::Show;
}
else if ( thisActionS == "exec" )
{
thisAction = ModuleAction::Exec;
thisAction = ModuleSystem::Action::Exec;
}
else
{

2
src/libcalamares/Settings.h
View File

@ -46,7 +46,7 @@ public:
using InstanceDescriptionList = QList< InstanceDescription >;
InstanceDescriptionList customModuleInstances() const;
using ModuleSequence = QList< QPair< ModuleAction, QStringList > >;
using ModuleSequence = QList< QPair< ModuleSystem::Action, QStringList > >;
ModuleSequence modulesSequence() const;
QString brandingComponentName() const;

5
src/libcalamares/modulesystem/Actions.h
View File

@ -22,13 +22,16 @@
namespace Calamares
{
namespace ModuleSystem
{
enum class ModuleAction : char
enum class Action : char
{
Show,
Exec
};
} // namespace ModuleSystem
} // namespace Calamares
#endif

111
src/libcalamares/modulesystem/InstanceKey.h Normal file
View File

@ -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

133
src/libcalamares/modulesystem/Tests.cpp Normal file
View File

@ -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"

74
src/libcalamaresui/modulesystem/ModuleManager.cpp
View File

@ -137,7 +137,12 @@ ModuleManager::doInit()
QStringList
ModuleManager::loadedInstanceKeys()
{
return m_loadedModulesByInstanceKey.keys();
QStringList l;
for ( const auto& m : m_loadedModulesByInstanceKey.keys() )
{
l << m.toString();
}
return l;
}
@ -150,7 +155,7 @@ ModuleManager::moduleDescriptor( const QString& name )
Module*
ModuleManager::moduleInstance( const QString& instanceKey )
{
return m_loadedModulesByInstanceKey.value( instanceKey );
return m_loadedModulesByInstanceKey.value( ModuleSystem::InstanceKey::fromString( instanceKey ) );
}
@ -160,12 +165,12 @@ ModuleManager::moduleInstance( const QString& instanceKey )
* @return -1 on failure, otherwise index of the instance that matches.
*/
static int
findCustomInstance( const Settings::InstanceDescriptionList& customInstances, const QString& module, const QString& id )
findCustomInstance( const Settings::InstanceDescriptionList& customInstances, const ModuleSystem::InstanceKey& m )
{
for ( int i = 0; i < customInstances.count(); ++i )
{
const auto& thisInstance = customInstances[ i ];
if ( thisInstance.value( "module" ) == module && thisInstance.value( "id" ) == id )
if ( thisInstance.value( "module" ) == m.module() && thisInstance.value( "id" ) == m.id() )
{
return i;
}
@ -177,7 +182,6 @@ findCustomInstance( const Settings::InstanceDescriptionList& customInstances, co
void
ModuleManager::loadModules()
{
QTimer::singleShot( 0, this, [this]() {
QStringList failedModules = checkDependencies();
Settings::InstanceDescriptionList customInstances = Settings::instance()->customModuleInstances();
@ -185,36 +189,32 @@ ModuleManager::loadModules()
= failedModules.isEmpty() ? Settings::instance()->modulesSequence() : Settings::ModuleSequence();
for ( const auto& modulePhase : modulesSequence )
{
ModuleAction currentAction = modulePhase.first;
ModuleSystem::Action currentAction = modulePhase.first;
foreach ( const QString& moduleEntry, modulePhase.second )
{
QStringList moduleEntrySplit = moduleEntry.split( '@' );
QString moduleName;
QString instanceId;
QString configFileName;
if ( moduleEntrySplit.length() < 1 || moduleEntrySplit.length() > 2 )
auto instanceKey = ModuleSystem::InstanceKey::fromString( moduleEntry );
if ( !instanceKey.isValid() )
{
cError() << "Wrong module entry format for module" << moduleEntry;
failedModules.append( moduleEntry );
continue;
}
moduleName = moduleEntrySplit.first();
instanceId = moduleEntrySplit.last();
configFileName = QString( "%1.conf" ).arg( moduleName );
if ( !m_availableDescriptorsByModuleName.contains( moduleName )
|| m_availableDescriptorsByModuleName.value( moduleName ).isEmpty() )
if ( !m_availableDescriptorsByModuleName.contains( instanceKey.module() )
|| m_availableDescriptorsByModuleName.value( instanceKey.module() ).isEmpty() )
{
cError() << "Module" << moduleName << "not found in module search paths."
cError() << "Module" << instanceKey.toString() << "not found in module search paths."
<< Logger::DebugList( m_paths );
failedModules.append( moduleName );
failedModules.append( instanceKey.toString() );
continue;
}
if ( moduleName != instanceId ) //means this is a custom instance
QString configFileName;
if ( instanceKey.isCustom() )
{
int found = findCustomInstance( customInstances, moduleName, instanceId );
int found = findCustomInstance( customInstances, instanceKey );
if ( found > -1 )
{
@ -227,6 +227,10 @@ ModuleManager::loadModules()
continue;
}
}
else
{
configFileName = QString( "%1.conf" ).arg( instanceKey.module() );
}
// So now we can assume that the module entry is at least valid,
// that we have a descriptor on hand (and therefore that the
@ -235,38 +239,35 @@ ModuleManager::loadModules()
// We still don't know whether the config file for the entry
// exists and is valid, but that's the only thing that could fail
// from this point on. -- Teo 8/2015
QString instanceKey = QString( "%1@%2" ).arg( moduleName ).arg( instanceId );
Module* thisModule = m_loadedModulesByInstanceKey.value( instanceKey, nullptr );
if ( thisModule && !thisModule->isLoaded() )
{
cError() << "Module" << instanceKey << "exists but not loaded.";
failedModules.append( instanceKey );
cError() << "Module" << instanceKey.toString() << "exists but not loaded.";
failedModules.append( instanceKey.toString() );
continue;
}
if ( thisModule && thisModule->isLoaded() )
{
cDebug() << "Module" << instanceKey << "already loaded.";
cDebug() << "Module" << instanceKey.toString() << "already loaded.";
}
else
{
thisModule = Module::fromDescriptor( m_availableDescriptorsByModuleName.value( moduleName ),
instanceId,
thisModule = Module::fromDescriptor( m_availableDescriptorsByModuleName.value( instanceKey.module() ),
instanceKey.id(),
configFileName,
m_moduleDirectoriesByModuleName.value( moduleName ) );
m_moduleDirectoriesByModuleName.value( instanceKey.module() ) );
if ( !thisModule )
{
cError() << "Module" << instanceKey << "cannot be created from descriptor" << configFileName;
failedModules.append( instanceKey );
cError() << "Module" << instanceKey.toString() << "cannot be created from descriptor" << configFileName;
failedModules.append( instanceKey.toString() );
continue;
}
if ( !checkDependencies( *thisModule ) )
{
// Error message is already printed
failedModules.append( instanceKey );
failedModules.append( instanceKey.toString() );
continue;
}
@ -275,15 +276,15 @@ ModuleManager::loadModules()
m_loadedModulesByInstanceKey.insert( instanceKey, thisModule );
if ( !thisModule->isLoaded() )
{
cError() << "Module" << instanceKey << "loading FAILED.";
failedModules.append( instanceKey );
cError() << "Module" << instanceKey.toString() << "loading FAILED.";
failedModules.append( instanceKey.toString() );
continue;
}
}
// At this point we most certainly have a pointer to a loaded module in
// thisModule. We now need to enqueue jobs info into an EVS.
if ( currentAction == ModuleAction::Exec )
if ( currentAction == ModuleSystem::Action::Exec )
{
ExecutionViewStep* evs
= qobject_cast< ExecutionViewStep* >( Calamares::ViewManager::instance()->viewSteps().last() );
@ -293,7 +294,7 @@ ModuleManager::loadModules()
ViewManager::instance()->addViewStep( evs );
}
evs->appendJobModuleInstanceKey( instanceKey );
evs->appendJobModuleInstanceKey( instanceKey.toString() );
}
}
}
@ -306,7 +307,6 @@ ModuleManager::loadModules()
{
emit modulesLoaded();
}
} );
}
void

7
src/libcalamaresui/modulesystem/ModuleManager.h
View File

@ -20,6 +20,8 @@
#ifndef MODULELOADER_H
#define MODULELOADER_H
#include "modulesystem/InstanceKey.h"
#include "Requirement.h"
#include <QObject>
@ -77,8 +79,9 @@ public:
Module* moduleInstance( const QString& instanceKey );
/**
* @brief loadModules initiates the asynchronous module loading operation.
* @brief loadModules does all of the module loading operation.
* When this is done, the signal modulesLoaded is emitted.
* It is recommended to call this from a single-shot QTimer.
*/
void loadModules();
@ -123,7 +126,7 @@ private:
QMap< QString, QVariantMap > m_availableDescriptorsByModuleName;
QMap< QString, QString > m_moduleDirectoriesByModuleName;
QMap< QString, Module* > m_loadedModulesByInstanceKey;
QMap< ModuleSystem::InstanceKey, Module* > m_loadedModulesByInstanceKey;
const QStringList m_paths;
static ModuleManager* s_instance;