1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
|
// Copyright (C) 2019 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only
#include <QtTest/QtTest>
#include <QDir>
#include <QFile>
#include <QProcess>
#include <QString>
#include <QTemporaryDir>
#include <QtTest/private/qemulationdetector_p.h>
#include <QtQuickTestUtils/private/qmlutils_p.h>
#include <QtQmlDom/private/qqmldomitem_p.h>
#include <QtQmlDom/private/qqmldomlinewriter_p.h>
#include <QtQmlDom/private/qqmldomoutwriter_p.h>
#include <QtQmlDom/private/qqmldomtop_p.h>
using namespace QQmlJS::Dom;
// TODO refactor extension helpers
const QString QML_EXT = ".qml";
const QString JS_EXT = ".js";
const QString MJS_EXT = ".mjs";
static QStringView fileExt(QStringView filename)
{
if (filename.endsWith(QML_EXT)) {
return QML_EXT;
}
if (filename.endsWith(JS_EXT)) {
return JS_EXT;
}
if (filename.endsWith(MJS_EXT)) {
return MJS_EXT;
}
Q_UNREACHABLE();
};
class TestQmlformat: public QQmlDataTest
{
Q_OBJECT
public:
enum class RunOption { OnCopy, OrigToCopy };
TestQmlformat();
private Q_SLOTS:
void initTestCase() override;
//actually testFormat tests CLI of qmlformat
void testFormat();
void testFormat_data();
void testLineEndings();
#if !defined(QTEST_CROSS_COMPILED) // sources not available when cross compiled
void testExample();
void testExample_data();
void normalizeExample();
void normalizeExample_data();
#endif
void testBackupFileLimit();
void testFilesOption_data();
void testFilesOption();
void plainJS_data();
void plainJS();
void ecmascriptModule();
private:
QString readTestFile(const QString &path);
//TODO(QTBUG-117849) refactor this helper function
QString runQmlformat(const QString &fileToFormat, QStringList args, bool shouldSucceed = true,
RunOption rOption = RunOption::OnCopy, QStringView ext = QML_EXT);
QString formatInMemory(const QString &fileToFormat, bool *didSucceed = nullptr,
LineWriterOptions options = LineWriterOptions(),
WriteOutChecks extraChecks = WriteOutCheck::ReparseCompare,
WriteOutChecks largeChecks = WriteOutCheck::None);
QString m_qmlformatPath;
QStringList m_excludedDirs;
QStringList m_invalidFiles;
QStringList m_ignoreFiles;
QStringList findFiles(const QDir &);
bool isInvalidFile(const QFileInfo &fileName) const;
bool isIgnoredFile(const QFileInfo &fileName) const;
};
// Don't fail on warnings because we read a lot of QML files that might intentionally be malformed.
TestQmlformat::TestQmlformat()
: QQmlDataTest(QT_QMLTEST_DATADIR, FailOnWarningsPolicy::DoNotFailOnWarnings)
{
}
void TestQmlformat::initTestCase()
{
QQmlDataTest::initTestCase();
m_qmlformatPath = QLibraryInfo::path(QLibraryInfo::BinariesPath) + QLatin1String("/qmlformat");
#ifdef Q_OS_WIN
m_qmlformatPath += QLatin1String(".exe");
#endif
if (!QFileInfo(m_qmlformatPath).exists()) {
QString message = QStringLiteral("qmlformat executable not found (looked for %0)").arg(m_qmlformatPath);
QFAIL(qPrintable(message));
}
// Add directories you want excluded here
// These snippets are not expected to run on their own.
m_excludedDirs << "doc/src/snippets/qml/visualdatamodel_rootindex";
m_excludedDirs << "doc/src/snippets/qml/qtbinding";
m_excludedDirs << "doc/src/snippets/qml/imports";
m_excludedDirs << "doc/src/snippets/qtquick1/visualdatamodel_rootindex";
m_excludedDirs << "doc/src/snippets/qtquick1/qtbinding";
m_excludedDirs << "doc/src/snippets/qtquick1/imports";
m_excludedDirs << "tests/manual/v4";
m_excludedDirs << "tests/manual/qmllsformatter";
m_excludedDirs << "tests/auto/qml/ecmascripttests";
m_excludedDirs << "tests/auto/qml/qmllint";
// Add invalid files (i.e. files with syntax errors)
m_invalidFiles << "tests/auto/quick/qquickloader/data/InvalidSourceComponent.qml";
m_invalidFiles << "tests/auto/qml/qqmllanguage/data/signal.2.qml";
m_invalidFiles << "tests/auto/qml/qqmllanguage/data/signal.3.qml";
m_invalidFiles << "tests/auto/qml/qqmllanguage/data/signal.5.qml";
m_invalidFiles << "tests/auto/qml/qqmllanguage/data/property.4.qml";
m_invalidFiles << "tests/auto/qml/qqmllanguage/data/empty.qml";
m_invalidFiles << "tests/auto/qml/qqmllanguage/data/missingObject.qml";
m_invalidFiles << "tests/auto/qml/qqmllanguage/data/insertedSemicolon.1.qml";
m_invalidFiles << "tests/auto/qml/qqmllanguage/data/nonexistantProperty.5.qml";
m_invalidFiles << "tests/auto/qml/qqmllanguage/data/invalidRoot.1.qml";
m_invalidFiles << "tests/auto/qml/qqmllanguage/data/invalidQmlEnumValue.1.qml";
m_invalidFiles << "tests/auto/qml/qqmllanguage/data/invalidQmlEnumValue.2.qml";
m_invalidFiles << "tests/auto/qml/qqmllanguage/data/invalidQmlEnumValue.3.qml";
m_invalidFiles << "tests/auto/qml/qqmllanguage/data/invalidID.4.qml";
m_invalidFiles << "tests/auto/qml/qqmllanguage/data/questionDotEOF.qml";
m_invalidFiles << "tests/auto/qml/qquickfolderlistmodel/data/dummy.qml";
m_invalidFiles << "tests/auto/qml/qqmlecmascript/data/stringParsing_error.1.qml";
m_invalidFiles << "tests/auto/qml/qqmlecmascript/data/stringParsing_error.2.qml";
m_invalidFiles << "tests/auto/qml/qqmlecmascript/data/stringParsing_error.3.qml";
m_invalidFiles << "tests/auto/qml/qqmlecmascript/data/stringParsing_error.4.qml";
m_invalidFiles << "tests/auto/qml/qqmlecmascript/data/stringParsing_error.5.qml";
m_invalidFiles << "tests/auto/qml/qqmlecmascript/data/stringParsing_error.6.qml";
m_invalidFiles << "tests/auto/qml/qqmlecmascript/data/numberParsing_error.1.qml";
m_invalidFiles << "tests/auto/qml/qqmlecmascript/data/numberParsing_error.2.qml";
m_invalidFiles << "tests/auto/qml/qqmlecmascript/data/incrDecrSemicolon_error1.qml";
m_invalidFiles << "tests/auto/qml/qqmlecmascript/data/incrDecrSemicolon_error1.qml";
m_invalidFiles << "tests/auto/qml/debugger/qqmlpreview/data/broken.qml";
m_invalidFiles << "tests/auto/qml/qqmllanguage/data/fuzzed.2.qml";
m_invalidFiles << "tests/auto/qml/qqmllanguage/data/fuzzed.3.qml";
m_invalidFiles << "tests/auto/qml/qqmllanguage/data/requiredProperties.2.qml";
m_invalidFiles << "tests/auto/qml/qqmllanguage/data/nullishCoalescing_LHS_And.qml";
m_invalidFiles << "tests/auto/qml/qqmllanguage/data/nullishCoalescing_LHS_And.qml";
m_invalidFiles << "tests/auto/qml/qqmllanguage/data/nullishCoalescing_LHS_Or.qml";
m_invalidFiles << "tests/auto/qml/qqmllanguage/data/nullishCoalescing_RHS_And.qml";
m_invalidFiles << "tests/auto/qml/qqmllanguage/data/nullishCoalescing_RHS_Or.qml";
m_invalidFiles << "tests/auto/qml/qqmllanguage/data/typeAnnotations.2.qml";
m_invalidFiles << "tests/auto/qml/qqmlparser/data/disallowedtypeannotations/qmlnestedfunction.qml";
m_invalidFiles << "tests/auto/qmlls/utils/data/emptyFile.qml";
m_invalidFiles << "tests/auto/qmlls/utils/data/completions/missingRHS.qml";
m_invalidFiles << "tests/auto/qmlls/utils/data/completions/missingRHS.parserfail.qml";
m_invalidFiles << "tests/auto/qmlls/utils/data/completions/attachedPropertyMissingRHS.qml";
m_invalidFiles << "tests/auto/qmlls/utils/data/completions/groupedPropertyMissingRHS.qml";
m_invalidFiles << "tests/auto/qmlls/utils/data/completions/afterDots.qml";
m_invalidFiles << "tests/auto/qmlls/modules/data/completions/bindingAfterDot.qml";
m_invalidFiles << "tests/auto/qmlls/modules/data/completions/defaultBindingAfterDot.qml";
m_invalidFiles << "tests/auto/qmlls/utils/data/qualifiedModule.qml";
// Files that get changed:
// rewrite of import "bla/bla/.." to import "bla"
m_invalidFiles << "tests/auto/qml/qqmlcomponent/data/componentUrlCanonicalization.4.qml";
// block -> object in internal update
m_invalidFiles << "tests/auto/qml/qqmlpromise/data/promise-executor-throw-exception.qml";
// removal of unsupported indexing of Object declaration
m_invalidFiles << "tests/auto/qml/qqmllanguage/data/hangOnWarning.qml";
// removal of duplicated id
m_invalidFiles << "tests/auto/qml/qqmllanguage/data/component.3.qml";
// Optional chains are not permitted on the left-hand-side in assignments
m_invalidFiles << "tests/auto/qml/qqmllanguage/data/optionalChaining.LHS.qml";
// object literal with = assignements
m_invalidFiles << "tests/auto/quickcontrols/controls/data/tst_scrollbar.qml";
// These files rely on exact formatting
m_invalidFiles << "tests/auto/qml/qqmlecmascript/data/incrDecrSemicolon1.qml";
m_invalidFiles << "tests/auto/qml/qqmlecmascript/data/incrDecrSemicolon_error1.qml";
m_invalidFiles << "tests/auto/qml/qqmlecmascript/data/incrDecrSemicolon2.qml";
// These files are too big
m_ignoreFiles << "tests/benchmarks/qml/qmldom/data/longQmlFile.qml";
m_ignoreFiles << "tests/benchmarks/qml/qmldom/data/deeplyNested.qml";
}
QStringList TestQmlformat::findFiles(const QDir &d)
{
for (int ii = 0; ii < m_excludedDirs.size(); ++ii) {
QString s = m_excludedDirs.at(ii);
if (d.absolutePath().endsWith(s))
return QStringList();
}
QStringList rv;
const QStringList files = d.entryList(QStringList() << QLatin1String("*.qml"),
QDir::Files);
for (const QString &file: files) {
QString absoluteFilePath = d.absoluteFilePath(file);
if (!isIgnoredFile(QFileInfo(absoluteFilePath)))
rv << absoluteFilePath;
}
const QStringList dirs = d.entryList(QDir::Dirs | QDir::NoDotAndDotDot |
QDir::NoSymLinks);
for (const QString &dir: dirs) {
QDir sub = d;
sub.cd(dir);
rv << findFiles(sub);
}
return rv;
}
bool TestQmlformat::isInvalidFile(const QFileInfo &fileName) const
{
for (const QString &invalidFile : m_invalidFiles) {
if (fileName.absoluteFilePath().endsWith(invalidFile))
return true;
}
return false;
}
bool TestQmlformat::isIgnoredFile(const QFileInfo &fileName) const
{
for (const QString &file : m_ignoreFiles) {
if (fileName.absoluteFilePath().endsWith(file))
return true;
}
return false;
}
QString TestQmlformat::readTestFile(const QString &path)
{
QFile file(testFile(path));
if (!file.open(QIODevice::ReadOnly))
return "";
return QString::fromUtf8(file.readAll());
}
void TestQmlformat::testLineEndings()
{
// macos
const QString macosContents =
runQmlformat(testFile("Example1.formatted.qml"), { "-l", "macos" });
QVERIFY(!macosContents.contains("\n"));
QVERIFY(macosContents.contains("\r"));
// windows
const QString windowsContents =
runQmlformat(testFile("Example1.formatted.qml"), { "-l", "windows" });
QVERIFY(windowsContents.contains("\r\n"));
// unix
const QString unixContents = runQmlformat(testFile("Example1.formatted.qml"), { "-l", "unix" });
QVERIFY(unixContents.contains("\n"));
QVERIFY(!unixContents.contains("\r"));
}
void TestQmlformat::testFormat_data()
{
QTest::addColumn<QString>("file");
QTest::addColumn<QString>("fileFormatted");
QTest::addColumn<QStringList>("args");
QTest::addColumn<RunOption>("runOption");
QTest::newRow("example1") << "Example1.qml"
<< "Example1.formatted.qml" << QStringList {} << RunOption::OnCopy;
QTest::newRow("example1 (tabs)")
<< "Example1.qml"
<< "Example1.formatted.tabs.qml" << QStringList { "-t" } << RunOption::OnCopy;
QTest::newRow("example1 (two spaces)")
<< "Example1.qml"
<< "Example1.formatted.2spaces.qml" << QStringList { "-w", "2" } << RunOption::OnCopy;
QTest::newRow("annotation") << "Annotations.qml"
<< "Annotations.formatted.qml" << QStringList {}
<< RunOption::OnCopy;
QTest::newRow("front inline") << "FrontInline.qml"
<< "FrontInline.formatted.qml" << QStringList {}
<< RunOption::OnCopy;
QTest::newRow("if blocks") << "IfBlocks.qml"
<< "IfBlocks.formatted.qml" << QStringList {} << RunOption::OnCopy;
QTest::newRow("read-only properties")
<< "readOnlyProps.qml"
<< "readOnlyProps.formatted.qml" << QStringList {} << RunOption::OnCopy;
QTest::newRow("states and transitions")
<< "statesAndTransitions.qml"
<< "statesAndTransitions.formatted.qml" << QStringList {} << RunOption::OnCopy;
QTest::newRow("large bindings")
<< "largeBindings.qml"
<< "largeBindings.formatted.qml" << QStringList {} << RunOption::OnCopy;
QTest::newRow("verbatim strings")
<< "verbatimString.qml"
<< "verbatimString.formatted.qml" << QStringList {} << RunOption::OnCopy;
QTest::newRow("inline components")
<< "inlineComponents.qml"
<< "inlineComponents.formatted.qml" << QStringList {} << RunOption::OnCopy;
QTest::newRow("nested ifs") << "nestedIf.qml"
<< "nestedIf.formatted.qml" << QStringList {} << RunOption::OnCopy;
QTest::newRow("QTBUG-85003") << "QtBug85003.qml"
<< "QtBug85003.formatted.qml" << QStringList {}
<< RunOption::OnCopy;
QTest::newRow("nested functions")
<< "nestedFunctions.qml"
<< "nestedFunctions.formatted.qml" << QStringList {} << RunOption::OnCopy;
QTest::newRow("multiline comments")
<< "multilineComment.qml"
<< "multilineComment.formatted.qml" << QStringList {} << RunOption::OnCopy;
QTest::newRow("for of") << "forOf.qml"
<< "forOf.formatted.qml" << QStringList {} << RunOption::OnCopy;
QTest::newRow("property names")
<< "propertyNames.qml"
<< "propertyNames.formatted.qml" << QStringList {} << RunOption::OnCopy;
QTest::newRow("empty object") << "emptyObject.qml"
<< "emptyObject.formatted.qml" << QStringList {}
<< RunOption::OnCopy;
QTest::newRow("arrow functions")
<< "arrowFunctions.qml"
<< "arrowFunctions.formatted.qml" << QStringList {} << RunOption::OnCopy;
QTest::newRow("settings") << "settings/Example1.qml"
<< "settings/Example1.formatted_mac_cr.qml" << QStringList {}
<< RunOption::OrigToCopy;
QTest::newRow("forWithLet")
<< "forWithLet.qml"
<< "forWithLet.formatted.qml" << QStringList {} << RunOption::OnCopy;
QTest::newRow("objects spacing (no changes)")
<< "objectsSpacing.qml"
<< "objectsSpacing.formatted.qml" << QStringList { "--objects-spacing" } << RunOption::OnCopy;
QTest::newRow("normalize + objects spacing")
<< "normalizedObjectsSpacing.qml"
<< "normalizedObjectsSpacing.formatted.qml" << QStringList { "-n", "--objects-spacing" } << RunOption::OnCopy;
QTest::newRow("ids new lines")
<< "checkIdsNewline.qml"
<< "checkIdsNewline.formatted.qml" << QStringList { "-n" } << RunOption::OnCopy;
QTest::newRow("functions spacing (no changes)")
<< "functionsSpacing.qml"
<< "functionsSpacing.formatted.qml" << QStringList { "--functions-spacing" } << RunOption::OnCopy;
QTest::newRow("normalize + functions spacing")
<< "normalizedFunctionsSpacing.qml"
<< "normalizedFunctionsSpacing.formatted.qml" << QStringList { "-n", "--functions-spacing" } << RunOption::OnCopy;
QTest::newRow("dontRemoveComments")
<< "dontRemoveComments.qml"
<< "dontRemoveComments.formatted.qml" << QStringList {} << RunOption::OnCopy;
QTest::newRow("ecmaScriptClassInQml")
<< "ecmaScriptClassInQml.qml"
<< "ecmaScriptClassInQml.formatted.qml" << QStringList{} << RunOption::OnCopy;
QTest::newRow("arrowFunctionWithBinding")
<< "arrowFunctionWithBinding.qml"
<< "arrowFunctionWithBinding.formatted.qml" << QStringList{} << RunOption::OnCopy;
QTest::newRow("blanklinesAfterComment")
<< "blanklinesAfterComment.qml"
<< "blanklinesAfterComment.formatted.qml" << QStringList{} << RunOption::OnCopy;
QTest::newRow("pragmaValueList")
<< "pragma.qml"
<< "pragma.formatted.qml" << QStringList{} << RunOption::OnCopy;
QTest::newRow("objectDestructuring")
<< "objectDestructuring.qml"
<< "objectDestructuring.formatted.qml" << QStringList{} << RunOption::OnCopy;
QTest::newRow("destructuringFunctionParameter")
<< "destructuringFunctionParameter.qml"
<< "destructuringFunctionParameter.formatted.qml" << QStringList{} << RunOption::OnCopy;
QTest::newRow("ellipsisFunctionArgument")
<< "ellipsisFunctionArgument.qml"
<< "ellipsisFunctionArgument.formatted.qml" << QStringList{} << RunOption::OnCopy;
QTest::newRow("importStatements")
<< "importStatements.qml"
<< "importStatements.formatted.qml" << QStringList{} << RunOption::OnCopy;
QTest::newRow("arrayEndComma")
<< "arrayEndComma.qml"
<< "arrayEndComma.formatted.qml" << QStringList{} << RunOption::OnCopy;
QTest::newRow("escapeChars")
<< "escapeChars.qml"
<< "escapeChars.formatted.qml" << QStringList{} << RunOption::OnCopy;
QTest::newRow("javascriptBlock")
<< "javascriptBlock.qml"
<< "javascriptBlock.formatted.qml" << QStringList{} << RunOption::OnCopy;
QTest::newRow("enumWithValues")
<< "enumWithValues.qml"
<< "enumWithValues.formatted.qml" << QStringList{} << RunOption::OnCopy;
QTest::newRow("typeAnnotatedSignal")
<< "signal.qml"
<< "signal.formatted.qml" << QStringList{} << RunOption::OnCopy;
//plainJS
QTest::newRow("nestedLambdaWithIfElse")
<< "lambdaWithIfElseInsideLambda.js"
<< "lambdaWithIfElseInsideLambda.formatted.js" << QStringList{} << RunOption::OnCopy;
QTest::newRow("indentEquals2")
<< "threeFunctionsOneLine.js"
<< "threeFunctions.formattedW2.js" << QStringList{"-w=2"} << RunOption::OnCopy;
QTest::newRow("tabIndents")
<< "threeFunctionsOneLine.js"
<< "threeFunctions.formattedTabs.js" << QStringList{"-t"} << RunOption::OnCopy;
QTest::newRow("normalizedFunctionSpacing")
<< "threeFunctionsOneLine.js"
<< "threeFunctions.formattedFuncSpacing.js"
<< QStringList{ "-n", "--functions-spacing" } << RunOption::OnCopy;
QTest::newRow("esm_tabIndents")
<< "mini_esm.mjs"
<< "mini_esm.formattedTabs.mjs" << QStringList{ "-t" } << RunOption::OnCopy;
}
void TestQmlformat::testFormat()
{
QFETCH(QString, file);
QFETCH(QString, fileFormatted);
QFETCH(QStringList, args);
QFETCH(RunOption, runOption);
auto formatted = runQmlformat(testFile(file), args, true, runOption, fileExt(file));
QEXPECT_FAIL("normalizedFunctionSpacing",
"Normalize && function spacing are not yet supported for JS", Abort);
auto exp = readTestFile(fileFormatted);
QCOMPARE(formatted, exp);
}
void TestQmlformat::plainJS_data()
{
QTest::addColumn<QString>("file");
QTest::addColumn<QString>("fileFormatted");
QTest::newRow("simpleStatement") << "simpleJSStatement.js"
<< "simpleJSStatement.formatted.js";
QTest::newRow("simpleFunction") << "simpleOnelinerJSFunc.js"
<< "simpleOnelinerJSFunc.formatted.js";
QTest::newRow("simpleLoop") << "simpleLoop.js"
<< "simpleLoop.formatted.js";
QTest::newRow("messyIfStatement") << "messyIfStatement.js"
<< "messyIfStatement.formatted.js";
QTest::newRow("lambdaFunctionWithLoop") << "lambdaFunctionWithLoop.js"
<< "lambdaFunctionWithLoop.formatted.js";
QTest::newRow("lambdaWithIfElse") << "lambdaWithIfElse.js"
<< "lambdaWithIfElse.formatted.js";
QTest::newRow("nestedLambdaWithIfElse") << "lambdaWithIfElseInsideLambda.js"
<< "lambdaWithIfElseInsideLambda.formatted.js";
QTest::newRow("twoFunctions") << "twoFunctions.js"
<< "twoFunctions.formatted.js";
QTest::newRow("pragma") << "pragma.js"
<< "pragma.formatted.js";
QTest::newRow("classConstructor") << "class.js"
<< "class.formatted.js";
QTest::newRow("legacyDirectives") << "directives.js"
<< "directives.formatted.js";
QTest::newRow("legacyDirectivesWithComments") << "directivesWithComments.js"
<< "directivesWithComments.formatted.js";
}
void TestQmlformat::plainJS()
{
QFETCH(QString, file);
QFETCH(QString, fileFormatted);
bool wasSuccessful;
LineWriterOptions opts;
#ifdef Q_OS_WIN
opts.lineEndings = QQmlJS::Dom::LineWriterOptions::LineEndings::Windows;
#endif
QString output = formatInMemory(testFile(file), &wasSuccessful, opts, WriteOutCheck::None);
QVERIFY(wasSuccessful && !output.isEmpty());
// TODO(QTBUG-119404)
QEXPECT_FAIL("classConstructor", "see QTBUG-119404", Abort);
// TODO(QTBUG-119770)
QEXPECT_FAIL("legacyDirectivesWithComments", "see QTBUG-119770", Abort);
auto exp = readTestFile(fileFormatted);
QCOMPARE(output, exp);
}
void TestQmlformat::ecmascriptModule()
{
QString file("esm.mjs");
QString formattedFile("esm.formatted.mjs");
bool wasSuccessful;
LineWriterOptions opts;
#ifdef Q_OS_WIN
opts.lineEndings = QQmlJS::Dom::LineWriterOptions::LineEndings::Windows;
#endif
QString output = formatInMemory(testFile(file), &wasSuccessful, opts, WriteOutCheck::None);
QVERIFY(wasSuccessful && !output.isEmpty());
auto exp = readTestFile(formattedFile);
QCOMPARE(output, readTestFile(formattedFile));
}
#if !defined(QTEST_CROSS_COMPILED) // sources not available when cross compiled
void TestQmlformat::testExample_data()
{
if (QTestPrivate::isRunningArmOnX86())
QSKIP("Crashes in QEMU. (timeout)");
QTest::addColumn<QString>("file");
QString examples = QLatin1String(SRCDIR) + "/../../../../examples/";
QString tests = QLatin1String(SRCDIR) + "/../../../../tests/";
QStringList exampleFiles;
QStringList testFiles;
QStringList files;
exampleFiles << findFiles(QDir(examples));
testFiles << findFiles(QDir(tests));
// Actually this test is an e2e test and not the unit test.
// At the moment of writing, CI lacks providing instruments for the automated tests
// which might be time-consuming, as for example this one.
// Therefore as part of QTBUG-122990 this test was copied to the /manual/e2e/qml/qmlformat
// however very small fraction of the test data is still preserved here for the sake of
// testing automatically at least a small part of the examples
const int nBatch = 10;
files << exampleFiles.mid(0, nBatch) << exampleFiles.mid(exampleFiles.size() / 2, nBatch)
<< exampleFiles.mid(exampleFiles.size() - nBatch, nBatch);
files << testFiles.mid(0, nBatch) << testFiles.mid(exampleFiles.size() / 2, nBatch)
<< testFiles.mid(exampleFiles.size() - nBatch, nBatch);
for (const QString &file : files)
QTest::newRow(qPrintable(file)) << file;
}
void TestQmlformat::normalizeExample_data()
{
if (QTestPrivate::isRunningArmOnX86())
QSKIP("Crashes in QEMU. (timeout)");
QTest::addColumn<QString>("file");
QString examples = QLatin1String(SRCDIR) + "/../../../../examples/";
QString tests = QLatin1String(SRCDIR) + "/../../../../tests/";
// normalizeExample is similar to testExample, so we test it only on nExamples + nTests
// files to avoid making too many
QStringList files;
const int nExamples = 10;
int i = 0;
for (const auto &f : findFiles(QDir(examples))) {
files << f;
if (++i == nExamples)
break;
}
const int nTests = 10;
i = 0;
for (const auto &f : findFiles(QDir(tests))) {
files << f;
if (++i == nTests)
break;
}
for (const QString &file : files)
QTest::newRow(qPrintable(file)) << file;
}
#endif
#if !defined(QTEST_CROSS_COMPILED) // sources not available when cross compiled
void TestQmlformat::testExample()
{
QFETCH(QString, file);
const bool isInvalid = isInvalidFile(QFileInfo(file));
bool wasSuccessful;
LineWriterOptions opts;
opts.attributesSequence = LineWriterOptions::AttributesSequence::Preserve;
QString output = formatInMemory(file, &wasSuccessful, opts);
if (!isInvalid)
QVERIFY(wasSuccessful && !output.isEmpty());
}
void TestQmlformat::normalizeExample()
{
QFETCH(QString, file);
const bool isInvalid = isInvalidFile(QFileInfo(file));
bool wasSuccessful;
LineWriterOptions opts;
opts.attributesSequence = LineWriterOptions::AttributesSequence::Normalize;
QString output = formatInMemory(file, &wasSuccessful, opts);
if (!isInvalid)
QVERIFY(wasSuccessful && !output.isEmpty());
}
#endif
void TestQmlformat::testBackupFileLimit()
{
// Create a temporary directory
QTemporaryDir tempDir;
// Unformatted file to format
const QString fileToFormat{ testFile("Annotations.qml") };
{
const QString tempFile = tempDir.path() + QDir::separator() + "test_0.qml";
const QString backupFile = tempFile + QStringLiteral("~");
QFile::copy(fileToFormat, tempFile);
QProcess process;
process.start(m_qmlformatPath, QStringList{ "--verbose", "--inplace", tempFile });
QVERIFY(process.waitForFinished());
QCOMPARE(process.exitStatus(), QProcess::NormalExit);
QCOMPARE(process.exitCode(), 0);
QVERIFY(QFileInfo::exists(tempFile));
QVERIFY(!QFileInfo::exists(backupFile));
};
}
void TestQmlformat::testFilesOption_data()
{
QTest::addColumn<QString>("containerFile");
QTest::addColumn<QStringList>("individualFiles");
QTest::newRow("initial") << "fileListToFormat"
<< QStringList{"valid1.qml", "invalidEntry:cannot be parsed", "valid2.qml"};
}
void TestQmlformat::testFilesOption()
{
QFETCH(QString, containerFile);
QFETCH(QStringList, individualFiles);
// Create a temporary directory
QTemporaryDir tempDir;
tempDir.setAutoRemove(false);
QStringList actualFormattedFilesPath;
// Iterate through files in the source directory and copy them to the temporary directory
const auto sourceDir = dataDirectory() + QDir::separator() + "filesOption";
// Create a file that contains the list of files to be formatted
const QString tempFilePath = tempDir.path() + QDir::separator() + containerFile;
QFile container(tempFilePath);
if (container.open(QIODevice::Text | QIODevice::WriteOnly)) {
QTextStream out(&container);
for (const auto &file : individualFiles) {
QString destinationFilePath = tempDir.path() + QDir::separator() + file;
if (QFile::copy(sourceDir + QDir::separator() + file, destinationFilePath))
actualFormattedFilesPath << destinationFilePath;
out << destinationFilePath << "\n";
}
container.close();
} else {
QFAIL("Cannot create temp test file\n");
return;
}
{
QProcess process;
process.start(m_qmlformatPath, QStringList{"-F", tempFilePath});
QVERIFY(process.waitForFinished());
QCOMPARE(process.exitStatus(), QProcess::NormalExit);
}
const auto readFile = [](const QString &filePath){
QFile file(filePath);
if (!file.open(QIODevice::ReadOnly)) {
qWarning() << "Error on opening the file " << filePath;
return QByteArray{};
}
return file.readAll();
};
for (const auto &filePath : actualFormattedFilesPath) {
auto expectedFormattedFile = QFileInfo(filePath).fileName();
const auto expectedFormattedFilePath = sourceDir + QDir::separator() +
expectedFormattedFile.replace(".qml", ".formatted.qml");
QCOMPARE(readFile(filePath), readFile(expectedFormattedFilePath));
}
}
QString TestQmlformat::runQmlformat(const QString &fileToFormat, QStringList args,
bool shouldSucceed, RunOption rOptions, QStringView ext)
{
// Copy test file to temporary location
QTemporaryDir tempDir;
const QString tempFile = (tempDir.path() + QDir::separator() + "to_format") % ext;
if (rOptions == RunOption::OnCopy) {
QFile::copy(fileToFormat, tempFile);
args << QLatin1String("-i");
args << tempFile;
} else {
args << fileToFormat;
}
auto verify = [&]() {
QProcess process;
if (rOptions == RunOption::OrigToCopy)
process.setStandardOutputFile(tempFile);
process.start(m_qmlformatPath, args);
QVERIFY(process.waitForFinished());
QCOMPARE(process.exitStatus(), QProcess::NormalExit);
if (shouldSucceed)
QCOMPARE(process.exitCode(), 0);
};
verify();
QFile temp(tempFile);
if (!temp.open(QIODevice::ReadOnly))
qFatal("Could not open %s", qPrintable(tempFile));
QString formatted = QString::fromUtf8(temp.readAll());
return formatted;
}
QString TestQmlformat::formatInMemory(const QString &fileToFormat, bool *didSucceed,
LineWriterOptions options, WriteOutChecks extraChecks,
WriteOutChecks largeChecks)
{
auto env = DomEnvironment::create(
QStringList(), // as we load no dependencies we do not need any paths
QQmlJS::Dom::DomEnvironment::Option::SingleThreaded
| QQmlJS::Dom::DomEnvironment::Option::NoDependencies);
DomItem tFile;
env->loadFile(FileToLoad::fromFileSystem(env, fileToFormat),
[&tFile](Path, const DomItem &, const DomItem &newIt) { tFile = newIt; });
env->loadPendingDependencies();
MutableDomItem myFile = tFile.field(Fields::currentItem);
bool writtenOut;
QString resultStr;
if (myFile.field(Fields::isValid).value().toBool()) {
WriteOutChecks checks = extraChecks;
const qsizetype largeFileSize = 32000;
if (tFile.field(Fields::code).value().toString().size() > largeFileSize)
checks = largeChecks;
QTextStream res(&resultStr);
LineWriter lw([&res](QStringView s) { res << s; }, QLatin1String("*testStream*"), options);
OutWriter ow(lw);
ow.indentNextlines = true;
DomItem qmlFile = tFile.field(Fields::currentItem);
writtenOut = qmlFile.writeOutForFile(ow, checks);
lw.eof();
res.flush();
}
if (didSucceed)
*didSucceed = writtenOut;
return resultStr;
}
QTEST_MAIN(TestQmlformat)
#include "tst_qmlformat.moc"
|
