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

Merge branch 'module-weight' into calamares

Browse Source 
Re-jig the module-weight calculations.

- modules can have a weight
- module instances can have a weight
- jobs, from the module, can have a weight

This is now configurable on a case-by-case basis, rather than having
C++ only as an option and a weird hack for unpackfs.
This commit is contained in:
Adriaan de Groot 2020-08-19 16:20:28 +02:00
commit ade7a22314
15 changed files with 383 additions and 137 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
CMakeModules/CalamaresAddPlugin.cmake
View File

@ -41,6 +41,7 @@
# [NO_CONFIG]
# [SHARED_LIB]
# [EMERGENCY]
# [WEIGHT w]
# )
#
# Function parameters:
@ -63,6 +64,9 @@
# - EMERGENCY
# If this is set, the module is marked as an *emergency* module in the
# descriptor. See *Emergency Modules* in the module documentation.
# - WEIGHT
# If this is set, writes an explicit weight into the module.desc;
# module weights are used in progress reporting.
#
include( CMakeParseArguments )
@ -73,7 +77,7 @@ function( calamares_add_plugin )
# parse arguments ( name needs to be saved before passing ARGN into the macro )
set( NAME ${ARGV0} )
set( options NO_CONFIG NO_INSTALL SHARED_LIB EMERGENCY )
set( oneValueArgs NAME TYPE EXPORT_MACRO RESOURCES )
set( oneValueArgs NAME TYPE EXPORT_MACRO RESOURCES WEIGHT )
set( multiValueArgs SOURCES UI LINK_LIBRARIES LINK_PRIVATE_LIBRARIES COMPILE_DEFINITIONS REQUIRES )
cmake_parse_arguments( PLUGIN "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN} )
set( PLUGIN_NAME ${NAME} )
@ -181,6 +185,9 @@ function( calamares_add_plugin )
if ( PLUGIN_NO_CONFIG )
file( APPEND ${_file} "noconfig: true\n" )
endif()
if ( PLUGIN_WEIGHT )
file( APPEND ${_file} "weight: ${PLUGIN_WEIGHT}\n" )
endif()
endif()
if ( NOT PLUGIN_NO_INSTALL )

6
src/libcalamares/Job.cpp
View File

@ -1,5 +1,5 @@
/* === This file is part of Calamares - <https://github.com/calamares> ===
*
*
* SPDX-FileCopyrightText: 2014-2015 Teo Mrnjavac <teo@kde.org>
*
* Calamares is free software: you can redistribute it and/or modify
@ -101,10 +101,10 @@ Job::Job( QObject* parent )
Job::~Job() {}
qreal
int
Job::getJobWeight() const
{
return qreal( 1.0 );
return 1;
}

10
src/libcalamares/Job.h
View File

@ -100,13 +100,19 @@ public:
/** @brief The job's (relative) weight.
*
* The default implementation returns 1.0, which gives all jobs
* The default implementation returns 1, which gives all jobs
* the same weight, so they advance the overall progress the same
* amount. This is nonsense, since some jobs take much longer than
* others; it's up to the individual jobs to say something about
* how much work is (relatively) done.
*
* Since jobs are caused by **modules** from the sequence, the
* overall weight of the module is taken into account: its weight
* is divided among the jobs based on each jobs relative weight.
* This can be used in a module that runs a bunch of jobs to indicate
* which of the jobs is "heavy" and which is not.
*/
virtual qreal getJobWeight() const;
virtual int getJobWeight() const;
/** @brief The human-readable name of this job
*
* This should be a very short statement of what the job does.

216
src/libcalamares/JobQueue.cpp
View File

@ -28,11 +28,34 @@
#include "Job.h"
#include "utils/Logger.h"
#include <QMutex>
#include <QMutexLocker>
#include <QThread>
namespace Calamares
{
struct WeightedJob
{
/** @brief Cumulative weight **before** this job starts
*
* This is calculated as jobs come in.
*/
qreal cumulative = 0.0;
/** @brief Weight of the job within the module's jobs
*
* When a list of jobs is added from a particular module,
* the jobs are weighted relative to that module's overall weight
* **and** the other jobs in the list, so that each job
* gets its share:
* ( job-weight / total-job-weight ) * module-weight
*/
qreal weight = 0.0;
job_ptr job;
};
using WeightedJobList = QList< WeightedJob >;
class JobThread : public QThread
{
public:
@ -45,106 +68,121 @@ public:
virtual ~JobThread() override;
void setJobs( JobList&& jobs )
void finalize()
{
m_jobs = jobs;
qreal totalJobsWeight = 0.0;
for ( auto job : m_jobs )
Q_ASSERT( m_runningJobs->isEmpty() );
QMutexLocker qlock( &m_enqueMutex );
QMutexLocker rlock( &m_runMutex );
std::swap( m_runningJobs, m_queuedJobs );
m_overallQueueWeight
= m_runningJobs->isEmpty() ? 0.0 : ( m_runningJobs->last().cumulative + m_runningJobs->last().weight );
if ( m_overallQueueWeight < 1 )
{
totalJobsWeight += job->getJobWeight();
m_overallQueueWeight = 1.0;
}
for ( auto job : m_jobs )
}
void enqueue( int moduleWeight, const JobList& jobs )
{
QMutexLocker qlock( &m_enqueMutex );
qreal cumulative
= m_queuedJobs->isEmpty() ? 0.0 : ( m_queuedJobs->last().cumulative + m_queuedJobs->last().weight );
qreal totalJobWeight
= std::accumulate( jobs.cbegin(), jobs.cend(), qreal( 0.0 ), []( qreal total, const job_ptr& j ) {
return total + j->getJobWeight();
} );
if ( totalJobWeight < 1 )
{
qreal jobWeight = qreal( job->getJobWeight() / totalJobsWeight );
m_jobWeights.append( jobWeight );
totalJobWeight = 1.0;
}
for ( const auto& j : jobs )
{
qreal jobContribution = ( j->getJobWeight() / totalJobWeight ) * moduleWeight;
m_queuedJobs->append( WeightedJob { cumulative, jobContribution, j } );
cumulative += jobContribution;
}
}
void run() override
{
bool anyFailed = false;
QString message;
QMutexLocker rlock( &m_runMutex );
bool failureEncountered = false;
QString message; ///< Filled in with errors
QString details;
m_jobIndex = 0;
for ( auto job : m_jobs )
for ( const auto& jobitem : *m_runningJobs )
{
if ( anyFailed && !job->isEmergency() )
if ( failureEncountered && !jobitem.job->isEmergency() )
{
cDebug() << "Skipping non-emergency job" << job->prettyName();
++m_jobIndex;
continue;
cDebug() << "Skipping non-emergency job" << jobitem.job->prettyName();
}
emitProgress();
cDebug() << "Starting" << ( anyFailed ? "EMERGENCY JOB" : "job" ) << job->prettyName() << "(there are"
<< ( m_jobs.count() - m_jobIndex ) << "left)";
connect( job.data(), &Job::progress, this, &JobThread::emitProgress );
JobResult result = job->exec();
if ( !anyFailed && !result )
else
{
anyFailed = true;
message = result.message();
details = result.details();
emitProgress( 0.0 ); // 0% for *this job*
cDebug() << "Starting" << ( failureEncountered ? "EMERGENCY JOB" : "job" ) << jobitem.job->prettyName()
<< '(' << ( m_jobIndex + 1 ) << '/' << m_runningJobs->count() << ')';
connect( jobitem.job.data(), &Job::progress, this, &JobThread::emitProgress );
auto result = jobitem.job->exec();
if ( !failureEncountered && !result )
{
// so this is the first failure
failureEncountered = true;
message = result.message();
details = result.details();
}
QThread::msleep( 16 ); // Very brief rest before reporting the job as complete
emitProgress( 1.0 ); // 100% for *this job*
}
emitProgress( 1.0 );
++m_jobIndex;
m_jobIndex++;
}
if ( anyFailed )
if ( failureEncountered )
{
emitFailed( message, details );
QMetaObject::invokeMethod(
m_queue, "failed", Qt::QueuedConnection, Q_ARG( QString, message ), Q_ARG( QString, details ) );
}
else
{
emitProgress();
emitProgress( 1.0 );
}
emitFinished();
QMetaObject::invokeMethod( m_queue, "finish", Qt::QueuedConnection );
}
void emitProgress( qreal percentage ) const
{
percentage = qBound( 0.0, percentage, 1.0 );
QString message;
qreal progress = 0.0;
if ( m_jobIndex < m_runningJobs->count() )
{
const auto& jobitem = m_runningJobs->at( m_jobIndex );
progress = ( jobitem.cumulative + jobitem.weight * percentage ) / m_overallQueueWeight;
message = jobitem.job->prettyStatusMessage();
}
else
{
progress = 1.0;
message = tr( "Done" );
}
QMetaObject::invokeMethod(
m_queue, "progress", Qt::QueuedConnection, Q_ARG( qreal, progress ), Q_ARG( QString, message ) );
}
private:
JobList m_jobs;
QList< qreal > m_jobWeights;
QMutex m_runMutex;
QMutex m_enqueMutex;
std::unique_ptr< WeightedJobList > m_runningJobs = std::make_unique< WeightedJobList >();
std::unique_ptr< WeightedJobList > m_queuedJobs = std::make_unique< WeightedJobList >();
JobQueue* m_queue;
int m_jobIndex;
void emitProgress( qreal jobPercent = 0 )
{
// Make sure jobPercent is reasonable, in case a job messed up its
// percentage computations.
jobPercent = qBound( qreal( 0 ), jobPercent, qreal( 1 ) );
int jobCount = m_jobs.size();
QString message = m_jobIndex < jobCount ? m_jobs.at( m_jobIndex )->prettyStatusMessage() : tr( "Done" );
qreal percent = 1.0; // Pretend we're done, since the if will reset it
if ( m_jobIndex < jobCount )
{
qreal cumulativeProgress = 0.0;
for ( auto jobWeight : m_jobWeights.mid( 0, m_jobIndex ) )
{
cumulativeProgress += jobWeight;
}
percent = cumulativeProgress + ( ( m_jobWeights.at( m_jobIndex ) ) * jobPercent );
Logger::CDebug( Logger::LOGVERBOSE )
<< "[JOBQUEUE]: Progress for Job[" << m_jobIndex << "]: " << ( jobPercent * 100 ) << "% completed";
Logger::CDebug( Logger::LOGVERBOSE )
<< "[JOBQUEUE]: Progress Overall: " << ( cumulativeProgress * 100 ) << "% (accumulated) + "
<< ( ( ( m_jobWeights.at( m_jobIndex ) ) * jobPercent ) * 100 )
<< "% (this job) = " << ( percent * 100 ) << "% (total)";
}
QMetaObject::invokeMethod(
m_queue, "progress", Qt::QueuedConnection, Q_ARG( qreal, percent ), Q_ARG( QString, message ) );
}
void emitFailed( const QString& message, const QString& details )
{
QMetaObject::invokeMethod(
m_queue, "failed", Qt::QueuedConnection, Q_ARG( QString, message ), Q_ARG( QString, details ) );
}
void emitFinished() { QMetaObject::invokeMethod( m_queue, "finish", Qt::QueuedConnection ); }
int m_jobIndex = 0; ///< Index into m_runningJobs
qreal m_overallQueueWeight = 0.0; ///< cumulation when **all** the jobs are done
};
JobThread::~JobThread() {}
@ -152,7 +190,6 @@ JobThread::~JobThread() {}
JobQueue* JobQueue::s_instance = nullptr;
JobQueue*
JobQueue::instance()
{
@ -164,13 +201,6 @@ JobQueue::instance()
}
GlobalStorage*
JobQueue::globalStorage() const
{
return m_storage;
}
JobQueue::JobQueue( QObject* parent )
: QObject( parent )
, m_thread( new JobThread( this ) )
@ -201,28 +231,18 @@ void
JobQueue::start()
{
Q_ASSERT( !m_thread->isRunning() );
m_thread->setJobs( std::move( m_jobs ) );
m_jobs.clear();
m_thread->finalize();
m_finished = false;
m_thread->start();
}
void
JobQueue::enqueue( const job_ptr& job )
JobQueue::enqueue( int moduleWeight, const JobList& jobs )
{
Q_ASSERT( !m_thread->isRunning() );
m_jobs.append( job );
emit queueChanged( m_jobs );
}
void
JobQueue::enqueue( const JobList& jobs )
{
Q_ASSERT( !m_thread->isRunning() );
m_jobs.append( jobs );
emit queueChanged( m_jobs );
m_thread->enqueue( moduleWeight, jobs );
emit queueChanged( jobs ); // FIXME: bogus
}
void
@ -232,4 +252,10 @@ JobQueue::finish()
emit finished();
}
GlobalStorage*
JobQueue::globalStorage() const
{
return m_storage;
}
} // namespace Calamares

12
src/libcalamares/JobQueue.h
View File

@ -1,5 +1,5 @@
/* === This file is part of Calamares - <https://github.com/calamares> ===
*
*
* SPDX-FileCopyrightText: 2014-2015 Teo Mrnjavac <teo@kde.org>
*
* Calamares is free software: you can redistribute it and/or modify
@ -30,7 +30,6 @@
namespace Calamares
{
class GlobalStorage;
class JobThread;
@ -45,8 +44,12 @@ public:
GlobalStorage* globalStorage() const;
void enqueue( const job_ptr& job );
void enqueue( const JobList& jobs );
/** @brief Queues up jobs from a single module source
*
* The total weight of the jobs is spread out to fill the weight
* of the module.
*/
void enqueue( int moduleWeight, const JobList& jobs );
void start();
bool isRunning() const { return !m_finished; }
@ -63,7 +66,6 @@ signals:
private:
static JobQueue* s_instance;
JobList m_jobs;
JobThread* m_thread;
GlobalStorage* m_storage;
bool m_finished = true; ///< Initially, not running

9
src/libcalamares/PythonJob.cpp
View File

@ -1,5 +1,5 @@
/* === This file is part of Calamares - <https://github.com/calamares> ===
*
*
* SPDX-FileCopyrightText: 2014-2016 Teo Mrnjavac <teo@kde.org>
* SPDX-FileCopyrightText: 2018-2020 Adriaan de Groot <groot@kde.org>
*
@ -184,19 +184,12 @@ PythonJob::PythonJob( const ModuleSystem::InstanceKey& instance,
, m_workingPath( workingPath )
, m_description()
, m_configurationMap( moduleConfiguration )
, m_weight( ( instance.module() == QStringLiteral( "unpackfs" ) ) ? 12.0 : 1.0 )
{
}
PythonJob::~PythonJob() {}
qreal
PythonJob::getJobWeight() const
{
return m_weight;
}
QString
PythonJob::prettyName() const
{

5
src/libcalamares/PythonJob.h
View File

@ -1,5 +1,5 @@
/* === This file is part of Calamares - <https://github.com/calamares> ===
*
*
* SPDX-FileCopyrightText: 2014 Teo Mrnjavac <teo@kde.org>
* SPDX-FileCopyrightText: 2020 Adriaan de Groot <groot@kde.org>
*
@ -55,8 +55,6 @@ public:
QString prettyStatusMessage() const override;
JobResult exec() override;
virtual qreal getJobWeight() const override;
private:
struct Private;
@ -68,7 +66,6 @@ private:
QString m_workingPath;
QString m_description;
QVariantMap m_configurationMap;
qreal m_weight;
};
} // namespace Calamares

163
src/libcalamares/Tests.cpp
View File

@ -20,9 +20,9 @@
*/
#include "GlobalStorage.h"
#include "JobQueue.h"
#include "Settings.h"
#include "modulesystem/InstanceKey.h"
#include "utils/Logger.h"
#include <QObject>
@ -46,6 +46,8 @@ private Q_SLOTS:
void testInstanceDescription();
void testSettings();
void testJobQueue();
};
void
@ -341,7 +343,7 @@ TestLibCalamares::testInstanceDescription()
{
QVariantMap m;
m.insert( "module", "welcome" );
m.insert( "weight", 1);
m.insert( "weight", 1 );
InstanceDescription d = InstanceDescription::fromSettings( m );
QVERIFY( d.isValid() );
@ -480,6 +482,163 @@ sequence:
}
}
constexpr const std::chrono::milliseconds MAX_TEST_DURATION( 3000 );
constexpr const int MAX_TEST_SLEEP( 2 ); // seconds, < MAX_TEST_DURATION
Q_STATIC_ASSERT( std::chrono::seconds( MAX_TEST_SLEEP ) < MAX_TEST_DURATION );
class DummyJob : public Calamares::Job
{
public:
DummyJob( QObject* parent )
: Calamares::Job( parent )
{
}
virtual ~DummyJob() override;
QString prettyName() const override;
Calamares::JobResult exec() override;
};
DummyJob::~DummyJob() {}
QString
DummyJob::prettyName() const
{
return QString( "DummyJob" );
}
Calamares::JobResult
DummyJob::exec()
{
cDebug() << "Starting DummyJob";
progress( 0.5 );
QThread::sleep( MAX_TEST_SLEEP );
cDebug() << ".. continuing DummyJob";
progress( 0.75 );
return Calamares::JobResult::ok();
}
void
TestLibCalamares::testJobQueue()
{
// Run an empty queue
{
Calamares::JobQueue q;
QVERIFY( !q.isRunning() );
QSignalSpy spy_progress( &q, &Calamares::JobQueue::progress );
QSignalSpy spy_finished( &q, &Calamares::JobQueue::finished );
QSignalSpy spy_failed( &q, &Calamares::JobQueue::failed );
QEventLoop loop;
connect( &q, &Calamares::JobQueue::finished, &loop, &QEventLoop::quit );
QTimer::singleShot( MAX_TEST_DURATION, &loop, &QEventLoop::quit );
q.start();
QVERIFY( q.isRunning() );
loop.exec();
QVERIFY( !q.isRunning() );
QCOMPARE( spy_finished.count(), 1 );
QCOMPARE( spy_failed.count(), 0 );
QCOMPARE( spy_progress.count(), 1 ); // just one, 100% at queue end
}
// Run a dummy queue
{
Calamares::JobQueue q;
QVERIFY( !q.isRunning() );
q.enqueue( 8, Calamares::JobList() << Calamares::job_ptr( new DummyJob( this ) ) );
QSignalSpy spy_progress( &q, &Calamares::JobQueue::progress );
QSignalSpy spy_finished( &q, &Calamares::JobQueue::finished );
QSignalSpy spy_failed( &q, &Calamares::JobQueue::failed );
QEventLoop loop;
connect( &q, &Calamares::JobQueue::finished, &loop, &QEventLoop::quit );
QTimer::singleShot( MAX_TEST_DURATION, &loop, &QEventLoop::quit );
q.start();
QVERIFY( q.isRunning() );
loop.exec();
QVERIFY( !q.isRunning() );
QCOMPARE( spy_finished.count(), 1 );
QCOMPARE( spy_failed.count(), 0 );
// 0% by the queue at job start
// 50% by the job itself
// 90% by the job itself
// 100% by the queue at job end
// 100% by the queue at queue end
QCOMPARE( spy_progress.count(), 5 );
}
{
Calamares::JobQueue q;
QVERIFY( !q.isRunning() );
q.enqueue( 8, Calamares::JobList() << Calamares::job_ptr( new DummyJob( this ) ) );
q.enqueue( 12,
Calamares::JobList() << Calamares::job_ptr( new DummyJob( this ) )
<< Calamares::job_ptr( new DummyJob( this ) ) );
QSignalSpy spy_progress( &q, &Calamares::JobQueue::progress );
QSignalSpy spy_finished( &q, &Calamares::JobQueue::finished );
QSignalSpy spy_failed( &q, &Calamares::JobQueue::failed );
QEventLoop loop;
connect( &q, &Calamares::JobQueue::finished, &loop, &QEventLoop::quit );
// Run the loop longer because the jobs take longer (there are 3 of them)
QTimer::singleShot( 3 * MAX_TEST_DURATION, &loop, &QEventLoop::quit );
q.start();
QVERIFY( q.isRunning() );
loop.exec();
QVERIFY( !q.isRunning() );
QCOMPARE( spy_finished.count(), 1 );
QCOMPARE( spy_failed.count(), 0 );
// 0% by the queue at job start
// 50% by the job itself
// 90% by the job itself
// 100% by the queue at job end
// 4 more for the next job
// 4 more for the next job
// 100% by the queue at queue end
QCOMPARE( spy_progress.count(), 13 );
/* Consider how progress will be reported:
*
* - the first module has weight 8, so the 1 job it has has weight 8
* - the second module has weight 12, so each of its two jobs has weight 6
*
* Total weight of the modules is 20. So the events are
*
* Job Progress Overall Weight Consumed Overall Progress
* 1 0 0 0.00
* 1 50 4 0.20
* 1 75 6 0.30
* 1 100 8 0.40
* 2 0 8 0.40
* 2 50 11 (8 + 50% of 6) 0.55
* 2 75 12.5 0.625
* 2 100 14 0.70
* 3 0 14 0.70
* 3 50 17 0.85
* 3 75 18.5 0.925
* 3 100 20 1.00
* - 100 20 1.00
*/
cDebug() << "Progress signals:";
qreal overallProgress = 0.0;
for ( const auto& e : spy_progress )
{
QCOMPARE( e.count(), 2 );
const auto v = e.first();
QVERIFY( v.canConvert< qreal >() );
qreal progress = v.toReal();
cDebug() << Logger::SubEntry << progress;
QVERIFY( progress >= overallProgress ); // Doesn't go backwards
overallProgress = progress;
}
}
}
QTEST_GUILESS_MAIN( TestLibCalamares )

27
src/libcalamares/modulesystem/Descriptor.cpp
View File

@ -87,8 +87,9 @@ Descriptor::fromDescriptorData( const QVariantMap& moduleDesc )
d.m_isEmergeny = CalamaresUtils::getBool( moduleDesc, "emergency", false );
d.m_hasConfig = !CalamaresUtils::getBool( moduleDesc, "noconfig", false ); // Inverted logic during load
d.m_requiredModules = CalamaresUtils::getStringList( moduleDesc, "requiredModules" );
d.m_weight = int( CalamaresUtils::getInteger( moduleDesc, "weight", -1 ) );
QStringList consumedKeys { "type", "interface", "name", "emergency", "noconfig", "requiredModules" };
QStringList consumedKeys { "type", "interface", "name", "emergency", "noconfig", "requiredModules", "weight" };
switch ( d.interface() )
{
@ -99,23 +100,37 @@ Descriptor::fromDescriptorData( const QVariantMap& moduleDesc )
case Interface::Python:
case Interface::PythonQt:
d.m_script = CalamaresUtils::getString( moduleDesc, "script" );
if ( d.m_script.isEmpty() )
{
cWarning() << "Module descriptor contains no *script*" << d.name();
d.m_isValid = false;
}
consumedKeys << "script";
break;
case Interface::Process:
d.m_script = CalamaresUtils::getString( moduleDesc, "command" );
d.m_processTimeout = CalamaresUtils::getInteger( moduleDesc, "timeout", 30 );
d.m_processTimeout = int( CalamaresUtils::getInteger( moduleDesc, "timeout", 30 ) );
d.m_processChroot = CalamaresUtils::getBool( moduleDesc, "chroot", false );
consumedKeys << "command"
<< "timeout"
<< "chroot";
if ( d.m_processTimeout < 0 )
{
d.m_processTimeout = 0;
}
if ( d.m_script.isEmpty() )
{
cWarning() << "Module descriptor contains no *script*" << d.name();
d.m_isValid = false;
}
consumedKeys << "command"
<< "timeout"
<< "chroot";
break;
}
if ( !d.m_isValid )
{
return d;
}
QStringList superfluousKeys;
for ( auto kv = moduleDesc.keyBegin(); kv != moduleDesc.keyEnd(); ++kv )
{

4
src/libcalamares/modulesystem/Descriptor.h
View File

@ -80,6 +80,9 @@ public:
bool isEmergency() const { return m_isEmergeny; }
bool hasConfig() const { return m_hasConfig; }
int weight() const { return m_weight < 1 ? 1 : m_weight; }
bool explicitWeight() const { return m_weight > 0; }
/// @brief The directory where the module.desc lives
QString directory() const { return m_directory; }
@ -125,6 +128,7 @@ private:
QString m_name;
QString m_directory;
QStringList m_requiredModules;
int m_weight = -1;
Type m_type;
Interface m_interface;
bool m_isValid = false;

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

@ -71,6 +71,16 @@ public:
*/
ModuleSystem::Descriptor moduleDescriptor( const QString& name );
/** @brief returns the module descriptor structure for the module @p instance
*
* Descriptors are for the module, which may have multiple instances;
* this is the same as moduleDescriptor( instance.module() ).
*/
ModuleSystem::Descriptor moduleDescriptor( const ModuleSystem::InstanceKey& instanceKey )
{
return moduleDescriptor( instanceKey.module() );
}
/**
* @brief moduleInstance returns a Module object for a given instance key.
* @param instanceKey the instance key for a module instance.

18
src/libcalamaresui/viewpages/ExecutionViewStep.cpp
View File

@ -146,10 +146,24 @@ ExecutionViewStep::onActivate()
{
m_slideshow->changeSlideShowState( Slideshow::Start );
const auto instanceDescriptors = Calamares::Settings::instance()->moduleInstances();
JobQueue* queue = JobQueue::instance();
for( const auto& instanceKey : m_jobInstanceKeys )
for ( const auto& instanceKey : m_jobInstanceKeys )
{
const auto& moduleDescriptor = Calamares::ModuleManager::instance()->moduleDescriptor( instanceKey );
Calamares::Module* module = Calamares::ModuleManager::instance()->moduleInstance( instanceKey );
const auto instanceDescriptor
= std::find_if( instanceDescriptors.constBegin(),
instanceDescriptors.constEnd(),
[=]( const Calamares::InstanceDescription& d ) { return d.key() == instanceKey; } );
int weight = moduleDescriptor.weight();
if ( instanceDescriptor != instanceDescriptors.constEnd() && instanceDescriptor->explicitWeight() )
{
weight = instanceDescriptor->weight();
}
weight = qBound( 1, weight, 100 );
if ( module )
{
auto jl = module->jobs();
@ -160,7 +174,7 @@ ExecutionViewStep::onActivate()
j->setEmergency( true );
}
}
queue->enqueue( jl );
queue->enqueue( weight, jl );
}
}

12
src/modules/README.md
View File

@ -46,9 +46,19 @@ Module descriptors **must** have the following keys:
- *interface* (see below for the different interfaces; generally we
refer to the kinds of modules by their interface)
Module descriptors for C++ modules **may** have the following key:
- *load* (the name of the shared library to load; if empty, uses a
standard library name derived from the module name)
Module descriptors for Python modules **must** have the following key:
- *script* (the name of the Python script to load, nearly always `main.py`)
Module descriptors for process modules **must** have the following key:
- *command* (the command to run)
Module descriptors for process modules **may** have the following keys:
- *timeout* (how long, in seconds, to wait for the command to run)
- *chroos* (if true, run the command in the target system rather than the host)
Module descriptors **may** have the following keys:
- *emergency* (a boolean value, set to true to mark the module
as an emergency module)
@ -56,6 +66,8 @@ Module descriptors **may** have the following keys:
has no configuration file; defaults to false)
- *requiredModules* (a list of modules which are required for this module
to operate properly)
- *weight* (a relative module weight, used to scale progress reporting)
### Required Modules

18
src/modules/partition/tests/PartitionJobTests.cpp
View File

@ -223,7 +223,7 @@ PartitionJobTests::queuePartitionTableCreation( PartitionTable::TableType type )
{
auto job = new CreatePartitionTableJob( m_device.data(), type );
job->updatePreview();
m_queue.enqueue( job_ptr( job ) );
m_queue.enqueue( 1, JobList() << job_ptr( job ) );
}
CreatePartitionJob*
@ -275,7 +275,7 @@ PartitionJobTests::testCreatePartition()
Partition* partition1 = job->partition();
QVERIFY( partition1 );
job->updatePreview();
m_queue.enqueue( job_ptr( job ) );
m_queue.enqueue( 1, JobList() << job_ptr( job ) );
freePartition = firstFreePartition( m_device->partitionTable() );
QVERIFY( freePartition );
@ -283,7 +283,7 @@ PartitionJobTests::testCreatePartition()
Partition* partition2 = job->partition();
QVERIFY( partition2 );
job->updatePreview();
m_queue.enqueue( job_ptr( job ) );
m_queue.enqueue( 1, JobList() << job_ptr( job ) );
freePartition = firstFreePartition( m_device->partitionTable() );
QVERIFY( freePartition );
@ -291,7 +291,7 @@ PartitionJobTests::testCreatePartition()
Partition* partition3 = job->partition();
QVERIFY( partition3 );
job->updatePreview();
m_queue.enqueue( job_ptr( job ) );
m_queue.enqueue( 1, JobList() << job_ptr( job ) );
QVERIFY( m_runner.run() );
@ -316,14 +316,14 @@ PartitionJobTests::testCreatePartitionExtended()
Partition* partition1 = job->partition();
QVERIFY( partition1 );
job->updatePreview();
m_queue.enqueue( job_ptr( job ) );
m_queue.enqueue( 1, JobList() << job_ptr( job ) );
freePartition = firstFreePartition( m_device->partitionTable() );
QVERIFY( freePartition );
job = newCreatePartitionJob(
freePartition, PartitionRole( PartitionRole::Extended ), FileSystem::Extended, 10_MiB );
job->updatePreview();
m_queue.enqueue( job_ptr( job ) );
m_queue.enqueue( 1, JobList() << job_ptr( job ) );
Partition* extendedPartition = job->partition();
freePartition = firstFreePartition( extendedPartition );
@ -332,7 +332,7 @@ PartitionJobTests::testCreatePartitionExtended()
Partition* partition2 = job->partition();
QVERIFY( partition2 );
job->updatePreview();
m_queue.enqueue( job_ptr( job ) );
m_queue.enqueue( 1, JobList() << job_ptr( job ) );
QVERIFY( m_runner.run() );
@ -394,7 +394,7 @@ PartitionJobTests::testResizePartition()
KPM_PARTITION_FLAG( None ) );
CreatePartitionJob* job = new CreatePartitionJob( m_device.data(), partition );
job->updatePreview();
m_queue.enqueue( job_ptr( job ) );
m_queue.enqueue( 1, JobList() << job_ptr( job ) );
QVERIFY( m_runner.run() );
}
@ -418,7 +418,7 @@ PartitionJobTests::testResizePartition()
// Resize
ResizePartitionJob* job = new ResizePartitionJob( m_device.data(), partition, newFirst, newLast );
job->updatePreview();
m_queue.enqueue( job_ptr( job ) );
m_queue.enqueue( 1, JobList() << job_ptr( job ) );
QVERIFY( m_runner.run() );
QCOMPARE( partition->firstSector(), newFirst );

1
src/modules/unpackfs/module.desc
View File

@ -5,3 +5,4 @@ name: "unpackfs"
interface: "python"
script: "main.py"
requiredModules: [ mount ]
weight: 12