Differential D8059 Diff 21200 kdevplatform/project/tests/abstractfilemanagerpluginimportbenchmark.cpp

Changeset View

Standalone View

View Options

kdevplatform/project/tests/abstractfilemanagerpluginimportbenchmark.cpp

  • This file was added.
1​/* This file is part of KDevelop
2​ Copyright 2017 René J.V. Bertin <rjvbertin@gmail.com>
3​
4​ This library is free software; you can redistribute it and/or
5​ modify it under the terms of the GNU Library General Public
6​ License as published by the Free Software Foundation; either
7​ version 2 of the License, or (at your option) any later version.
8​
9​ This library is distributed in the hope that it will be useful,
10​ but WITHOUT ANY WARRANTY; without even the implied warranty of
11​ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12​ Library General Public License for more details.
13​
14​ You should have received a copy of the GNU Library General Public License
15​ along with this library; see the file COPYING.LIB. If not, write to
16​ the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
17​ Boston, MA 02110-1301, USA.
18​*/
19​
20​#include <project/abstractfilemanagerplugin.h>
21​#include <project/projectmodel.h>
22​
23​#include <tests/autotestshell.h>
24​#include <tests/testcore.h>
25​#include <tests/testproject.h>
26​
27​#include <util/path.h>
28​
29​#include <KJob>
30​#include <KDirWatch>
31​
32​#include <QCoreApplication>
33​#include <QList>
34​#include <QFileInfo>
35​#include <QElapsedTimer>
36​#include <QMap>
37​#include <QDebug>
38​#include <QTextStream>
39​
40​using namespace KDevelop;
41​
42​namespace KDevelop {
mwolffUnsubmitted
Done

remove, once the two new functions are gone

mwolff: remove, once the two new functions are gone
43​
44​class AbstractFileManagerPluginImportBenchmark : public QObject
45​{
mwolffUnsubmitted
Done

Name the class after the file: AbstractFileManagerPluginImportBenchmark

mwolff: Name the class after the file: `AbstractFileManagerPluginImportBenchmark`
46​ Q_OBJECT
47​public:
48​ AbstractFileManagerPluginImportBenchmark(AbstractFileManagerPlugin* manager, const QString& path, QObject* parent)
mwolffUnsubmitted
Done

break long line, add newline after path,

mwolff: break long line, add newline after path,
49​ : QObject(parent)
50​ , m_out(stdout)
mwolffUnsubmitted
Not Done

align with the ( in the line above

mwolff: align with the `(` in the line above
51​ {
52​ m_manager = manager;
53​ m_project = new TestProject(Path(path));
54​ }
55​
mwolffUnsubmitted
Done

{ on its own line

mwolff: { on its own line
56​ void start()
57​ {
58​ m_projectNumber = s_numBenchmarksRunning++;
59​ m_out << "Starting import of project " << m_project->path().toLocalFile() << "\n";
mwolffUnsubmitted
Not Done

here and below: don't use qInfo, it's usually not enabled. Instead, use qDebug or better yet use a QTextStream m_out member and initialize it with m_out(stdout).

mwolff: here and below: don't use qInfo, it's usually not enabled. Instead, use `qDebug` or better yet…
mwolffUnsubmitted
Not Done

instead of using "\n"; m_out.flush(), use << endl; which achieves the same

mwolff: instead of using `"\n"; m_out.flush()`, use `<< endl;` which achieves the same
60​ m_out.flush();
61​ m_timer.start();
mwolffUnsubmitted
Done

should be handled outside the creation of this object (i.e. don't create an instance when this invariant isn't upheld)

mwolff: should be handled outside the creation of this object (i.e. don't create an instance when this…
62​ auto root = m_manager->import(m_project);
63​ int elapsed = m_timer.elapsed();
64​ m_out << "\tcreating dirwatcher took "
65​ << elapsed / 1000.0 << " seconds\n";
66​ m_out.flush();
67​ auto import = m_manager->createImportJob(root);
68​ QObject::connect(import, &KJob::finished, this, &AbstractFileManagerPluginImportBenchmark::projectImportDone);
mwolffUnsubmitted
Done

remove QObject:: prefix, break long line by adding a newline before this,

mwolff: remove `QObject::` prefix, break long line by adding a newline before `this,`
69​ m_timer.restart();
70​ import->start();
71​ }
72​
mwolffUnsubmitted
Done

remove once above is fixed

mwolff: remove once above is fixed
73​ AbstractFileManagerPlugin* m_manager;
74​ TestProject* m_project;
75​ QElapsedTimer m_timer;
76​ int m_projectNumber;
mwolffUnsubmitted
Done

don't output a project number, us the project name/path only

mwolff: don't output a project number, us the project name/path only
rjvbbAuthorUnsubmitted
Not Done

OK here, but not in the other output (knowing the completion order is useful IMHO).

rjvbb: OK here, but not in the other output (knowing the completion order is useful IMHO).
77​ QTextStream m_out;
78​
79​ static int s_numBenchmarksRunning;
80​
81​Q_SIGNALS:
82​ void finished();
83​
84​private Q_SLOTS:
85​ void projectImportDone(KJob* job)
86​ {
87​ Q_UNUSED(job);
88​ int elapsed = m_timer.elapsed();
89​ m_out << "imported project " << m_projectNumber << " took "
90​ << elapsed / 1000.0 << " seconds\n";
91​ m_out.flush();
92​
93​ s_numBenchmarksRunning -= 1;
94​ if (s_numBenchmarksRunning <= 0) {
95​ emit finished();
96​ }
97​ }
98​
99​};
100​
101​int AbstractFileManagerPluginImportBenchmark::s_numBenchmarksRunning = 0;
mwolffUnsubmitted
Done

s_numBenchmarksRunning, but I'd actually remove this as a static here and instead push it to a stack variable in main below

mwolff: `s_numBenchmarksRunning`, but I'd actually remove this as a static here and instead push it to…
102​}
103​
104​int main(int argc, char** argv)
105​{
106​ if (argc < 2) {
107​ qWarning() << "Usage:" << argv[0] << "projectDir1 [...projectDirN]";
108​ return 1;
109​ }
110​ QCoreApplication app(argc, argv);
111​ QTextStream qout(stdout);
112​ // measure the total test time, this provides an indication
mwolffUnsubmitted
Done

imo it's more useful to know the number of files and dirs rather than the number of watched items (that should be an implementation detail, cf. comment above)

mwolff: imo it's more useful to know the number of files and dirs rather than the number of watched…
rjvbbAuthorUnsubmitted
Not Done

What comment are you referring to?

fileSet().size() gives the number of files and dirs. In the follow-up patch only dirs will be watched, so the 2 values being printed will give provide the number of files and the number of dirs in a way that I consider most useful to assess the impact of dirwatcher initialisation. (The benchmark will print the actual time of that step in the current code.)

rjvbb: What comment are you referring to? `fileSet().size()` gives the number of files and dirs. In…
113​ // of overhead and how well multiple projects are imported in parallel
114​ // (= how different is the total time from the import time of the largest
115​ // project). When testing a single project the difference between this
116​ // value and total runtime will provide an estimate of the time required
mwolffUnsubmitted
Done

move down, see "MOVE_TO_HERE" marker below

mwolff: move down, see "MOVE_TO_HERE" marker below
rjvbbAuthorUnsubmitted
Not Done

not entirely certain what to move - probably just the "Done" output?

rjvbb: not entirely certain what to move - probably just the "Done" output?
117​ // to destroy the dirwatcher.
118​ QElapsedTimer runTimer;
119​
120​ AutoTestShell::init({"no plugins"});
121​ auto core = TestCore::initialize(Core::NoUi);
122​ auto manager = new AbstractFileManagerPlugin({}, core);
123​
124​ const char *kdwMethod[] = {"FAM", "Inotify", "Stat", "QFSWatch"};
125​ qout << "KDirWatch backend: " << kdwMethod[KDirWatch().internalMethod()] << "\n";
126​ qout.flush();
127​
128​ QList<AbstractFileManagerPluginImportBenchmark*> benchmarks;
129​
130​ for (int i = 1 ; i < argc ; ++i) {
131​ const QString path = QString::fromUtf8(argv[i]);
132​ if (QFileInfo(path).isDir()) {
133​ const auto benchmark = new AbstractFileManagerPluginImportBenchmark(manager, path, core);
134​ benchmarks << benchmark;
135​ QObject::connect(benchmark, &AbstractFileManagerPluginImportBenchmark::finished,
mwolffUnsubmitted
Done

you could try to init with AutoTestShell::init({"no plugins"}) to ensure no other plugin gets loaded

mwolff: you could try to init with `AutoTestShell::init({"no plugins"})` to ensure no other plugin gets…
136​ &app, [&runTimer, &qout] {
137​ qout << "Done in " << runTimer.elapsed() / 1000.0
138​ << " seconds total\n";
139​ QCoreApplication::instance()->quit();
140​ });
141​ }
142​ }
143​
144​ if (benchmarks.isEmpty()) {
145​ qWarning() << "no projects to import (arguments must be directories)";
146​ return 1;
147​ }
148​
mwolffUnsubmitted
Done

indent align the &app with the benchmark above, increment indent level below (such that }); is again on the same level)

mwolff: indent align the `&app` with the `benchmark` above, increment indent level below (such that `})…
149​ runTimer.start();
150​ for (auto benchmark : benchmarks) {
151​ benchmark->start();
152​ }
mwolffUnsubmitted
Done

MOVE_TO_HERE

mwolff: MOVE_TO_HERE
153​
154​ return app.exec();
155​}
156​
157​#include "abstractfilemanagerpluginimportbenchmark.moc"
158​
159​
mwolffUnsubmitted
Done
if (benchmarks.isEmpty()) {
    qWarning() << "no projects to import";
    return 1;
}
return app.exec();
mwolff: ``` if (benchmarks.isEmpty()) { qWarning() << "no projects to import"; return 1; }…
mwolffUnsubmitted
Not Done

excess newline

mwolff: excess newline