qiurui
/
qtdeclarative
mirror of https://github.com/qt/qtdeclarative.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
qtdeclarative/tests/auto/qml/qmlformat/tst_qmlformat.cpp

394 lines
17 KiB
C++
Raw Normal View History

Use SPDX license identifiers Replace the current license disclaimer in files by a SPDX-License-Identifier. Files that have to be modified by hand are modified. License files are organized under LICENSES directory. Pick-to: 6.4 Task-number: QTBUG-67283 Change-Id: I63563bbeb6f60f89d2c99660400dca7fab78a294 Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io>
2022-05-13 13:12:05 +00:00
// Copyright (C) 2019 The Qt Company Ltd.
Correct license for test files According to QUIP-18 [1], all test files should be LicenseRef-Qt-Commercial OR GPL-3.0-only [1]: https://contribute.qt-project.org/quips/18 Pick-to: 6.7 Task-number: QTBUG-121787 Change-Id: I26d72e8de04d4c7c57b3b7838af5d033265de5ba Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io> Reviewed-by: Kai Köhne <kai.koehne@qt.io> Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2024-02-22 14:51:16 +00:00
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only
qtdeclarative/tools: Implement qmlformat qmlformat is a tool that formats qml files according to the QML coding conventions (https://doc.qt.io/qt-5/qml-codingconventions.html). Change-Id: I359c4bd3b51f60614535f0e857d7e0b21b1d9033 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2019-12-13 15:10:46 +00:00
Tests: include QTest, not QtTest Never use module-wide inclusions. They blow up build times. For QtTest this is usually just a typo (QTest was meant instead). Add missing includes as needed. In the diffs I've spotted other huge inclusions (QtQuick, QtQml), but those need more attention. Task-number: QTQAINFRA-7110 Pick-to: 6.9 6.8 Change-Id: I74bf3fe212f50a7a3a6af2b1c80bbcaabc2516d7 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2025-04-10 12:00:44 +00:00
#include <QtTest/QTest>
qmlformat: Add option for alternative line endings Allows user to decide between native (default), macos (\r), unix (\n) or windows (\r\n) line endings. Fixes: QTBUG-82258 Change-Id: Ie1eb365085815cbbebbf0d026c6f72f0ef2acb9d Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2020-03-18 08:19:31 +00:00
#include <QDir>
#include <QFile>
qtdeclarative/tools: Implement qmlformat qmlformat is a tool that formats qml files according to the QML coding conventions (https://doc.qt.io/qt-5/qml-codingconventions.html). Change-Id: I359c4bd3b51f60614535f0e857d7e0b21b1d9033 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2019-12-13 15:10:46 +00:00
#include <QProcess>
#include <QString>
qmlformat: Add option for alternative line endings Allows user to decide between native (default), macos (\r), unix (\n) or windows (\r\n) line endings. Fixes: QTBUG-82258 Change-Id: Ie1eb365085815cbbebbf0d026c6f72f0ef2acb9d Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2020-03-18 08:19:31 +00:00
#include <QTemporaryDir>
qmlformat: use QmlDom Replace qmlformat with the formatter using qml dom Change-Id: Ie90814260f2d3b9e589ce04381d5ad1880c5b519 Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-04-19 14:43:21 +00:00
#include <QtTest/private/qemulationdetector_p.h>
Consolidate test helpers into private libraries Previously each test would include and build sources from the shared folder. Now we make those sources a library, build it once, then have each test link to it instead. We also take the opportunity to move some helpers that qtquickcontrols2 had added into the quicktestutils library where it makes sense, and for the helpers that don't make sense to be there, move them into quickcontrolstestutils. We add the libraries to src/ so that they are internal modules built as part of Qt, rather than tests. That way we can use them in a standalone test outside of qtdeclarative. Task-number: QTBUG-95621 Pick-to: 6.2 Change-Id: I0a2ab3976fdbff2e4414df7bdc0808f16453b80a Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-08-06 10:27:35 +00:00
#include <QtQuickTestUtils/private/qmlutils_p.h>
tst_qmlformat: in memory formatting when reformatting all qmlfiles avoid copying the file, and calling the qmlformat tool when scanning all qmlfiles. Improvements in the reformatting made some more incorrect files fail, adding them to the invalid files. Change-Id: I007654340ac325be89188c1680c38c2bc37a0340 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-09-15 07:38:49 +00:00
#include <QtQmlDom/private/qqmldomitem_p.h>
#include <QtQmlDom/private/qqmldomlinewriter_p.h>
#include <QtQmlDom/private/qqmldomoutwriter_p.h>
#include <QtQmlDom/private/qqmldomtop_p.h>
qmlformat: fix --write-defaults Prior to this commit, --write-defaults was only writing the subset of the existing settings. In fact, each setting has a default value and those should be seen in the .qmlformat.ini file to be written. Pick-to: 6.8 6.9 Change-Id: Ie7f8fac653d0bc7099821136f5ad8ce8ee14c714 Reviewed-by: Sami Shalayel <sami.shalayel@qt.io>
2025-01-21 16:08:42 +00:00
#include <QtQmlToolingSettings/private/qqmltoolingsettings_p.h>
qmlformat: move configuration functions into library ...Then we can add tests for them. More tests to be added in the next commit. Pick-to: 6.8 6.9 Task-number: QTBUG-133225 Change-Id: I3f40ddc3d0895a785d6bce359c63ad6ad4d70606 Reviewed-by: Sami Shalayel <sami.shalayel@qt.io>
2025-01-27 11:06:07 +00:00
#include <QtQmlFormat/private/qqmlformatoptions_p.h>
tst_qmlformat: in memory formatting when reformatting all qmlfiles avoid copying the file, and calling the qmlformat tool when scanning all qmlfiles. Improvements in the reformatting made some more incorrect files fail, adding them to the invalid files. Change-Id: I007654340ac325be89188c1680c38c2bc37a0340 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-09-15 07:38:49 +00:00
tst_qmlformat: move common functionality into header Prepare for the splitting of tst_qmlformat into tst_qmlformat_cli by moving the base into a header. Task-number: QTBUG-134669 Change-Id: I76fbdf2f9d31a2e160d6ae0389a409c2214d36da Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2025-03-17 09:10:38 +00:00
#include "tst_qmlformat_base.h"
tst_qmlformat: in memory formatting when reformatting all qmlfiles avoid copying the file, and calling the qmlformat tool when scanning all qmlfiles. Improvements in the reformatting made some more incorrect files fail, adding them to the invalid files. Change-Id: I007654340ac325be89188c1680c38c2bc37a0340 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-09-15 07:38:49 +00:00
using namespace QQmlJS::Dom;
qtdeclarative/tools: Implement qmlformat qmlformat is a tool that formats qml files according to the QML coding conventions (https://doc.qt.io/qt-5/qml-codingconventions.html). Change-Id: I359c4bd3b51f60614535f0e857d7e0b21b1d9033 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2019-12-13 15:10:46 +00:00
tst_qmlformat: extract common code into base class Prepare for the splitting of tst_qmlformat into tst_qmlformat_cli by extracting common functionality into a base class. Task-number: QTBUG-134669 Change-Id: I66a72b128802a51b0289320e6022bd69c6cfe4ff Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2025-03-13 08:53:29 +00:00
class TestQmlformat : public TestQmlformatBase
qtdeclarative/tools: Implement qmlformat qmlformat is a tool that formats qml files according to the QML coding conventions (https://doc.qt.io/qt-5/qml-codingconventions.html). Change-Id: I359c4bd3b51f60614535f0e857d7e0b21b1d9033 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2019-12-13 15:10:46 +00:00
{
Q_OBJECT
Consolidate test helpers into private libraries Previously each test would include and build sources from the shared folder. Now we make those sources a library, build it once, then have each test link to it instead. We also take the opportunity to move some helpers that qtquickcontrols2 had added into the quicktestutils library where it makes sense, and for the helpers that don't make sense to be there, move them into quickcontrolstestutils. We add the libraries to src/ so that they are internal modules built as part of Qt, rather than tests. That way we can use them in a standalone test outside of qtdeclarative. Task-number: QTBUG-95621 Pick-to: 6.2 Change-Id: I0a2ab3976fdbff2e4414df7bdc0808f16453b80a Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-08-06 10:27:35 +00:00
public:
qmlformat: improve testing of file based options Add an option to run qmlformat from the original file to a copy, thus picking up automatically settings related to those options. This does not in place replacing, but does not need any special setup to run the test. Ensure that git preserves the old macos line endings (CR) in the reference file by renaming it to *_mac_cr.* and change .gitattributes accordingly. Change-Id: Ibd9685613fc737146d67abcae19c67300343aa88 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-11-03 14:39:00 +00:00
enum class RunOption { OnCopy, OrigToCopy };
Consolidate test helpers into private libraries Previously each test would include and build sources from the shared folder. Now we make those sources a library, build it once, then have each test link to it instead. We also take the opportunity to move some helpers that qtquickcontrols2 had added into the quicktestutils library where it makes sense, and for the helpers that don't make sense to be there, move them into quickcontrolstestutils. We add the libraries to src/ so that they are internal modules built as part of Qt, rather than tests. That way we can use them in a standalone test outside of qtdeclarative. Task-number: QTBUG-95621 Pick-to: 6.2 Change-Id: I0a2ab3976fdbff2e4414df7bdc0808f16453b80a Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-08-06 10:27:35 +00:00
TestQmlformat();
qtdeclarative/tools: Implement qmlformat qmlformat is a tool that formats qml files according to the QML coding conventions (https://doc.qt.io/qt-5/qml-codingconventions.html). Change-Id: I359c4bd3b51f60614535f0e857d7e0b21b1d9033 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2019-12-13 15:10:46 +00:00
private Q_SLOTS:
qmlformat: Fix some language features being unsupported qmlformat now supports: - arrow functions - generator functions - this expressions - object patterns - regex literals - type expressions - plain expressions Aborts if an error occurs during dumping now. Also now automatically tests qmlformat against all example / test qml files. Change-Id: Idc24004c6f2c1cd65289bcad75985a1ef047c8d2 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2020-01-15 10:25:18 +00:00
#if !defined(QTEST_CROSS_COMPILED) // sources not available when cross compiled
void testExample();
void testExample_data();
qmlformat: test normalize on some examples runs the normalization (AttributesSequence::Normalize) on some examples, and do not just test the AttributesSequence::Preserve reformatting. Change-Id: I7d53f84174e841de1d63e8d3e1bdc339cf727f5f Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-09-15 08:35:16 +00:00
void normalizeExample();
void normalizeExample_data();
qmlformat: Fix some language features being unsupported qmlformat now supports: - arrow functions - generator functions - this expressions - object patterns - regex literals - type expressions - plain expressions Aborts if an error occurs during dumping now. Also now automatically tests qmlformat against all example / test qml files. Change-Id: Idc24004c6f2c1cd65289bcad75985a1ef047c8d2 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2020-01-15 10:25:18 +00:00
#endif
QmlFormat: Support .js files (in memory formatting) Previous commits in the stack introduced the possibility of loading .js files to the DOM environments and keeping the content inside the corresponding JSFile abstraction. This commit introduces 1. writeOut method for the JSFile required by the qmlformat 2. formatting of .import .pragma library directives & helper objects 3. Adding support of JSFile in OutWriter::updatedFile 4. Tests covering in Memory formatting Task-number: QTBUG-117849 Change-Id: I741f06058aec8a280f64b05a755d25fc8fe1d1f7 Reviewed-by: Sami Shalayel <sami.shalayel@qt.io> Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2023-11-20 11:57:54 +00:00
void plainJS_data();
void plainJS();
QMLFormat | Support ESM formatting Adding tests for Ecmascript Module formatting Change-Id: Iaac7be13d9c1ed1119afc5ebdd9b09a990ed944a Task-number: QTBUG-123386 Reviewed-by: Sami Shalayel <sami.shalayel@qt.io> Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2024-03-14 11:48:38 +00:00
void ecmascriptModule();
tst_qmlformat: prefer in-process formatting instead of out-of-process Move all the tests from testFormat() to a newly added qml() function that do not seem to test any command line parameters. The qml() function runs the tests in-process instead of spawning extra qmlformat processes. Task-number: QTBUG-134669 Change-Id: I99bfd8a840c31cd2b0a4c889c0f0ca39b8c73eb2 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2025-03-17 08:48:53 +00:00
void qml_data();
void qml();
qmlformat: fix precedence of settings Options set through commandline should have the precedence over the settings read from .ini file. Introduce a mapper in the setting, that marks the option if set by command line input. Add more tests. Pick-to: 6.8 6.9 Fixes: QTBUG-133225 Change-Id: Id0b18655f7bf64670dab4e38f5aff2fdaa889f1b Reviewed-by: Sami Shalayel <sami.shalayel@qt.io>
2025-01-24 12:51:04 +00:00
qtdeclarative/tools: Implement qmlformat qmlformat is a tool that formats qml files according to the QML coding conventions (https://doc.qt.io/qt-5/qml-codingconventions.html). Change-Id: I359c4bd3b51f60614535f0e857d7e0b21b1d9033 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2019-12-13 15:10:46 +00:00
private:
tst_qmlformat: in memory formatting when reformatting all qmlfiles avoid copying the file, and calling the qmlformat tool when scanning all qmlfiles. Improvements in the reformatting made some more incorrect files fail, adding them to the invalid files. Change-Id: I007654340ac325be89188c1680c38c2bc37a0340 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-09-15 07:38:49 +00:00
QString formatInMemory(const QString &fileToFormat, bool *didSucceed = nullptr,
LineWriterOptions options = LineWriterOptions(),
WriteOutChecks extraChecks = WriteOutCheck::ReparseCompare,
WriteOutChecks largeChecks = WriteOutCheck::None);
qtdeclarative/tools: Implement qmlformat qmlformat is a tool that formats qml files according to the QML coding conventions (https://doc.qt.io/qt-5/qml-codingconventions.html). Change-Id: I359c4bd3b51f60614535f0e857d7e0b21b1d9033 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2019-12-13 15:10:46 +00:00
};
Add convenience API for making QQmlDataTest-based tests fail on warnings After this patch, if a QQmlDataTest-derived class passes FailOnWarningsPolicy::FailOnWarnings to the base constructor, any non-empty warning encountered by that test will result in a test failure. This avoids the need to duplicate the catch-all regex in tests that want to fail on warnings. The goal is to gradually enable failure-on-warnings over time. Leave comments and explicitly pass DoNotFailOnWarnings for tests that should never fail on warnings. Task-number: QTBUG-98718 Pick-to: 6.2 6.3 6.4 Change-Id: I4b647d93a0f28ac891c4bdb19ef74569f2918e8f Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2022-06-07 02:23:31 +00:00
// Don't fail on warnings because we read a lot of QML files that might intentionally be malformed.
Consolidate test helpers into private libraries Previously each test would include and build sources from the shared folder. Now we make those sources a library, build it once, then have each test link to it instead. We also take the opportunity to move some helpers that qtquickcontrols2 had added into the quicktestutils library where it makes sense, and for the helpers that don't make sense to be there, move them into quickcontrolstestutils. We add the libraries to src/ so that they are internal modules built as part of Qt, rather than tests. That way we can use them in a standalone test outside of qtdeclarative. Task-number: QTBUG-95621 Pick-to: 6.2 Change-Id: I0a2ab3976fdbff2e4414df7bdc0808f16453b80a Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-08-06 10:27:35 +00:00
TestQmlformat::TestQmlformat()
tst_qmlformat: extract common code into base class Prepare for the splitting of tst_qmlformat into tst_qmlformat_cli by extracting common functionality into a base class. Task-number: QTBUG-134669 Change-Id: I66a72b128802a51b0289320e6022bd69c6cfe4ff Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2025-03-13 08:53:29 +00:00
: TestQmlformatBase(QT_QMLTEST_DATADIR, FailOnWarningsPolicy::DoNotFailOnWarnings)
Consolidate test helpers into private libraries Previously each test would include and build sources from the shared folder. Now we make those sources a library, build it once, then have each test link to it instead. We also take the opportunity to move some helpers that qtquickcontrols2 had added into the quicktestutils library where it makes sense, and for the helpers that don't make sense to be there, move them into quickcontrolstestutils. We add the libraries to src/ so that they are internal modules built as part of Qt, rather than tests. That way we can use them in a standalone test outside of qtdeclarative. Task-number: QTBUG-95621 Pick-to: 6.2 Change-Id: I0a2ab3976fdbff2e4414df7bdc0808f16453b80a Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-08-06 10:27:35 +00:00
{
}
QmlFormat: Support .js files (in memory formatting) Previous commits in the stack introduced the possibility of loading .js files to the DOM environments and keeping the content inside the corresponding JSFile abstraction. This commit introduces 1. writeOut method for the JSFile required by the qmlformat 2. formatting of .import .pragma library directives & helper objects 3. Adding support of JSFile in OutWriter::updatedFile 4. Tests covering in Memory formatting Task-number: QTBUG-117849 Change-Id: I741f06058aec8a280f64b05a755d25fc8fe1d1f7 Reviewed-by: Sami Shalayel <sami.shalayel@qt.io> Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2023-11-20 11:57:54 +00:00
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";
qmlformat: Preserve "?." tokens for various member access expressions Fixes: QTBUG-132280 Pick-to: 6.9 6.8 Change-Id: I9307a70eea4640da19124f65e49cb3c661d443a1 Reviewed-by: Sami Shalayel <sami.shalayel@qt.io>
2025-01-28 09:33:45 +00:00
QTest::newRow("preserveOptionalTokens") << "preserveOptionalTokens.js"
<< "preserveOptionalTokens.formatted.js";
qmlformat: Have the outWriter ensure spaces instead of adding them When formatting comments we try to preserve the spacing that the user used around them. We keep track of how many spaces come before and after a comment and insert them back accordingly. However, when we continue to write out the following tokens we add spaces to separate them. This space was being inserted unconditionally. This could lead to a space being accounted for twice for certain comment configurations. Once by the recorded amount of spaces after the comment and once by the standard space to separate tokens. This would lead to spaces being inserted in the formatted code that weren't there originally in the user's code. One space would be inserted like this for every format call. To solve this, don't unconditionally insert a space to separate the tokens but only make sure there is a space. This issue can be reproduced in many "places" of the grammar. This patch eliminates a good amount of them but not all. Created QTBUG-133315 and QTBUG-133316. Fixes: QTBUG-131386 Pick-to: 6.9 6.8 Change-Id: I25ac67f49a0198047912ef3f04dda3afc5cb9f66 Reviewed-by: Sami Shalayel <sami.shalayel@qt.io>
2025-01-28 15:45:28 +00:00
QTest::newRow("noSuperfluousSpaceInsertions.fail_pragma")
<< "noSuperfluousSpaceInsertions.fail_pragma.js"
<< "noSuperfluousSpaceInsertions.fail_pragma.formatted.js";
qmlformat: Accept `from` as an identifier From is defined as an identifier with a special meaning in the context of imports. This means it should generally be accepted as an identifier in other contexts. This fixes weird line indentation issues with the IndentingLineWriter. Fixes: QTBUG-132065 Pick-to: 6.9 6.8 Change-Id: Iea5bf3af5d43af9a97f0f8e7867d12337e4041ca Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2025-01-29 14:51:09 +00:00
QTest::newRow("fromAsIdentifier") << "fromAsIdentifier.js"
<< "fromAsIdentifier.formatted.js";
qmlformat: add custom comment anchoring for case Add a way to customize where comments are anchored. Prior to this commit, comments could only be anchored to an AST::Node firstSourceLocation() or lastSourceLocation(). This commit extends the current functionality to be able to anchor comments somewhere between firstSourceLocation() and lastSourceLocation(). This allows to fix the bug where comments would be printed before the ":" in case statements, because they would get attached to the expression inside the case-statement, instead of getting attached to the colon of the case-statement. Extend AstRangesVisitor to add the sourcelocation of the ":" in case- statements to the list of sourcelocations where comments can be attached to. The anchors enum is not meant to be extended: instead, an anchor is either DefaultAnchor for comments attached to AST::Node*, or token.begin() for some QQmlJS::SourceLocation token inside an AST::Node*. Pick-to: 6.9 6.8 6.5 Fixes: QTBUG-132886 Change-Id: I0a18f09b3631b8798b6697298e532b47ddc7cb20 Reviewed-by: Dmitrii Akshintsev <dmitrii.akshintsev@qt.io> Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2025-01-20 13:29:58 +00:00
QTest::newRow("caseWithComment") << "caseWithComment.js"
<< "caseWithComment.formatted.js";
QmlFormat: Support .js files (in memory formatting) Previous commits in the stack introduced the possibility of loading .js files to the DOM environments and keeping the content inside the corresponding JSFile abstraction. This commit introduces 1. writeOut method for the JSFile required by the qmlformat 2. formatting of .import .pragma library directives & helper objects 3. Adding support of JSFile in OutWriter::updatedFile 4. Tests covering in Memory formatting Task-number: QTBUG-117849 Change-Id: I741f06058aec8a280f64b05a755d25fc8fe1d1f7 Reviewed-by: Sami Shalayel <sami.shalayel@qt.io> Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2023-11-20 11:57:54 +00:00
}
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-119770)
QEXPECT_FAIL("legacyDirectivesWithComments", "see QTBUG-119770", Abort);
qmlformat: Have the outWriter ensure spaces instead of adding them When formatting comments we try to preserve the spacing that the user used around them. We keep track of how many spaces come before and after a comment and insert them back accordingly. However, when we continue to write out the following tokens we add spaces to separate them. This space was being inserted unconditionally. This could lead to a space being accounted for twice for certain comment configurations. Once by the recorded amount of spaces after the comment and once by the standard space to separate tokens. This would lead to spaces being inserted in the formatted code that weren't there originally in the user's code. One space would be inserted like this for every format call. To solve this, don't unconditionally insert a space to separate the tokens but only make sure there is a space. This issue can be reproduced in many "places" of the grammar. This patch eliminates a good amount of them but not all. Created QTBUG-133315 and QTBUG-133316. Fixes: QTBUG-131386 Pick-to: 6.9 6.8 Change-Id: I25ac67f49a0198047912ef3f04dda3afc5cb9f66 Reviewed-by: Sami Shalayel <sami.shalayel@qt.io>
2025-01-28 15:45:28 +00:00
QEXPECT_FAIL("noSuperfluousSpaceInsertions.fail_pragma",
"Not all cases have been covered yet (QTBUG-133315)", Abort);
QmlFormat: Support .js files (in memory formatting) Previous commits in the stack introduced the possibility of loading .js files to the DOM environments and keeping the content inside the corresponding JSFile abstraction. This commit introduces 1. writeOut method for the JSFile required by the qmlformat 2. formatting of .import .pragma library directives & helper objects 3. Adding support of JSFile in OutWriter::updatedFile 4. Tests covering in Memory formatting Task-number: QTBUG-117849 Change-Id: I741f06058aec8a280f64b05a755d25fc8fe1d1f7 Reviewed-by: Sami Shalayel <sami.shalayel@qt.io> Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2023-11-20 11:57:54 +00:00
auto exp = readTestFile(fileFormatted);
QMLFormat | Support ESM formatting Adding tests for Ecmascript Module formatting Change-Id: Iaac7be13d9c1ed1119afc5ebdd9b09a990ed944a Task-number: QTBUG-123386 Reviewed-by: Sami Shalayel <sami.shalayel@qt.io> Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2024-03-14 11:48:38 +00:00
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));
QmlFormat: Support .js files (in memory formatting) Previous commits in the stack introduced the possibility of loading .js files to the DOM environments and keeping the content inside the corresponding JSFile abstraction. This commit introduces 1. writeOut method for the JSFile required by the qmlformat 2. formatting of .import .pragma library directives & helper objects 3. Adding support of JSFile in OutWriter::updatedFile 4. Tests covering in Memory formatting Task-number: QTBUG-117849 Change-Id: I741f06058aec8a280f64b05a755d25fc8fe1d1f7 Reviewed-by: Sami Shalayel <sami.shalayel@qt.io> Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2023-11-20 11:57:54 +00:00
}
qmlformat: Fix some language features being unsupported qmlformat now supports: - arrow functions - generator functions - this expressions - object patterns - regex literals - type expressions - plain expressions Aborts if an error occurs during dumping now. Also now automatically tests qmlformat against all example / test qml files. Change-Id: Idc24004c6f2c1cd65289bcad75985a1ef047c8d2 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2020-01-15 10:25:18 +00:00
#if !defined(QTEST_CROSS_COMPILED) // sources not available when cross compiled
void TestQmlformat::testExample_data()
{
qmlformat: use QmlDom Replace qmlformat with the formatter using qml dom Change-Id: Ie90814260f2d3b9e589ce04381d5ad1880c5b519 Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-04-19 14:43:21 +00:00
if (QTestPrivate::isRunningArmOnX86())
QSKIP("Crashes in QEMU. (timeout)");
qmlformat: Fix some language features being unsupported qmlformat now supports: - arrow functions - generator functions - this expressions - object patterns - regex literals - type expressions - plain expressions Aborts if an error occurs during dumping now. Also now automatically tests qmlformat against all example / test qml files. Change-Id: Idc24004c6f2c1cd65289bcad75985a1ef047c8d2 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2020-01-15 10:25:18 +00:00
QTest::addColumn<QString>("file");
QString examples = QLatin1String(SRCDIR) + "/../../../../examples/";
QString tests = QLatin1String(SRCDIR) + "/../../../../tests/";
qmlformat: "Move" testExample e2e tests to /manual testExample, normalizeExample and actually most of the tests in tst_qmlformat are e2e tests and in general QmlFormat lacks unit test coverage, compensating it with e2e. The biggest problem atm that some of those tests (namely testExample) take too much time to execute because it runs QmlFormat over almost all files in examples and tests directories. Unfortunately atm our QA&QE infra can't provide tools for an easy automated setup of potentially time-consuming tests. As a workaround this commit: 1. "Moves" testExample and normalizeExample to the /manual tests 2. Preserves a very small fraction of testData for automated testing "just in case" Steps to repro: 1. configure with the flag `-make manual-tests` 2. `ninja e2e_qmlformat` 3. run ;) Fixes: QTBUG-122990 Change-Id: Id41baee15e8826f4def5787f62790ed46f00e5dc Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2024-04-22 14:49:00 +00:00
QStringList exampleFiles;
QStringList testFiles;
qmlformat: Fix some language features being unsupported qmlformat now supports: - arrow functions - generator functions - this expressions - object patterns - regex literals - type expressions - plain expressions Aborts if an error occurs during dumping now. Also now automatically tests qmlformat against all example / test qml files. Change-Id: Idc24004c6f2c1cd65289bcad75985a1ef047c8d2 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2020-01-15 10:25:18 +00:00
QStringList files;
qmlformat: "Move" testExample e2e tests to /manual testExample, normalizeExample and actually most of the tests in tst_qmlformat are e2e tests and in general QmlFormat lacks unit test coverage, compensating it with e2e. The biggest problem atm that some of those tests (namely testExample) take too much time to execute because it runs QmlFormat over almost all files in examples and tests directories. Unfortunately atm our QA&QE infra can't provide tools for an easy automated setup of potentially time-consuming tests. As a workaround this commit: 1. "Moves" testExample and normalizeExample to the /manual tests 2. Preserves a very small fraction of testData for automated testing "just in case" Steps to repro: 1. configure with the flag `-make manual-tests` 2. `ninja e2e_qmlformat` 3. run ;) Fixes: QTBUG-122990 Change-Id: Id41baee15e8826f4def5787f62790ed46f00e5dc Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2024-04-22 14:49:00 +00:00
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);
qmlformat: Fix some language features being unsupported qmlformat now supports: - arrow functions - generator functions - this expressions - object patterns - regex literals - type expressions - plain expressions Aborts if an error occurs during dumping now. Also now automatically tests qmlformat against all example / test qml files. Change-Id: Idc24004c6f2c1cd65289bcad75985a1ef047c8d2 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2020-01-15 10:25:18 +00:00
for (const QString &file : files)
QTest::newRow(qPrintable(file)) << file;
}
qmlformat: test normalize on some examples runs the normalization (AttributesSequence::Normalize) on some examples, and do not just test the AttributesSequence::Preserve reformatting. Change-Id: I7d53f84174e841de1d63e8d3e1bdc339cf727f5f Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-09-15 08:35:16 +00:00
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;
}
qmlformat: Fix some language features being unsupported qmlformat now supports: - arrow functions - generator functions - this expressions - object patterns - regex literals - type expressions - plain expressions Aborts if an error occurs during dumping now. Also now automatically tests qmlformat against all example / test qml files. Change-Id: Idc24004c6f2c1cd65289bcad75985a1ef047c8d2 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2020-01-15 10:25:18 +00:00
#endif
#if !defined(QTEST_CROSS_COMPILED) // sources not available when cross compiled
void TestQmlformat::testExample()
{
QFETCH(QString, file);
Use QFileInfo constructor explicitly Prepare for upcoming changes in qtbase. Change-Id: I592fe857dde13ce570f1525b5f327a07773be123 Reviewed-by: Giuseppe D'Angelo <giuseppe.dangelo@kdab.com>
2020-11-14 13:30:42 +00:00
const bool isInvalid = isInvalidFile(QFileInfo(file));
tst_qmlformat: in memory formatting when reformatting all qmlfiles avoid copying the file, and calling the qmlformat tool when scanning all qmlfiles. Improvements in the reformatting made some more incorrect files fail, adding them to the invalid files. Change-Id: I007654340ac325be89188c1680c38c2bc37a0340 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-09-15 07:38:49 +00:00
bool wasSuccessful;
LineWriterOptions opts;
opts.attributesSequence = LineWriterOptions::AttributesSequence::Preserve;
QString output = formatInMemory(file, &wasSuccessful, opts);
qmlformat: Fix some language features being unsupported qmlformat now supports: - arrow functions - generator functions - this expressions - object patterns - regex literals - type expressions - plain expressions Aborts if an error occurs during dumping now. Also now automatically tests qmlformat against all example / test qml files. Change-Id: Idc24004c6f2c1cd65289bcad75985a1ef047c8d2 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2020-01-15 10:25:18 +00:00
Use QFileInfo constructor explicitly Prepare for upcoming changes in qtbase. Change-Id: I592fe857dde13ce570f1525b5f327a07773be123 Reviewed-by: Giuseppe D'Angelo <giuseppe.dangelo@kdab.com>
2020-11-14 13:30:42 +00:00
if (!isInvalid)
tst_qmlformat: in memory formatting when reformatting all qmlfiles avoid copying the file, and calling the qmlformat tool when scanning all qmlfiles. Improvements in the reformatting made some more incorrect files fail, adding them to the invalid files. Change-Id: I007654340ac325be89188c1680c38c2bc37a0340 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-09-15 07:38:49 +00:00
QVERIFY(wasSuccessful && !output.isEmpty());
qmlformat: Fix some language features being unsupported qmlformat now supports: - arrow functions - generator functions - this expressions - object patterns - regex literals - type expressions - plain expressions Aborts if an error occurs during dumping now. Also now automatically tests qmlformat against all example / test qml files. Change-Id: Idc24004c6f2c1cd65289bcad75985a1ef047c8d2 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2020-01-15 10:25:18 +00:00
}
qmlformat: test normalize on some examples runs the normalization (AttributesSequence::Normalize) on some examples, and do not just test the AttributesSequence::Preserve reformatting. Change-Id: I7d53f84174e841de1d63e8d3e1bdc339cf727f5f Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-09-15 08:35:16 +00:00
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());
}
qmlformat: Fix some language features being unsupported qmlformat now supports: - arrow functions - generator functions - this expressions - object patterns - regex literals - type expressions - plain expressions Aborts if an error occurs during dumping now. Also now automatically tests qmlformat against all example / test qml files. Change-Id: Idc24004c6f2c1cd65289bcad75985a1ef047c8d2 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2020-01-15 10:25:18 +00:00
#endif
tst_qmlformat: in memory formatting when reformatting all qmlfiles avoid copying the file, and calling the qmlformat tool when scanning all qmlfiles. Improvements in the reformatting made some more incorrect files fail, adding them to the invalid files. Change-Id: I007654340ac325be89188c1680c38c2bc37a0340 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-09-15 07:38:49 +00:00
QString TestQmlformat::formatInMemory(const QString &fileToFormat, bool *didSucceed,
LineWriterOptions options, WriteOutChecks extraChecks,
WriteOutChecks largeChecks)
{
DOM refactoring. Remove DomItem::loadItem. enable_shared_from_this for DomEnv* As it was mentioned in the previous commits in the chain one of the goals of the refactoring is to introduce clearer separation of concerns. Only DomTop types are allowed to load files, hence it's arguable should be reflected in the interfaces explicitly. With the help of previous commits the relevant pieces of this function were moved to the corresponding DomEnvironment and DomUniverse types. This commit finally removes loadFile from the DomItem API. *It's also worth noting that in order to minimaze refactoring efforts and to keep the public API simple (not requiring DomItem &self argument on the top level), this commit also makes DomEnvironment a child of the std::enable_shared_from_this. This somewhat "breaks" the initial design approach inscribed in the DOM API allowing DomEnvironemt to get a shared_ptr to itself bypassing corresponding DomItem.ownerAs<> API. However, in the tradeoff of preserving consistency of the previous design and the explicitness of the interface, I would value the latter, hence I find this change acceptable. Change-Id: Ic2ce3fc80876be6bdbec93e4d273e4c6b7a2b218 Task-number: QTBUG-119550 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2023-12-28 20:31:13 +00:00
auto env = DomEnvironment::create(
tst_qmlformat: in memory formatting when reformatting all qmlfiles avoid copying the file, and calling the qmlformat tool when scanning all qmlfiles. Improvements in the reformatting made some more incorrect files fail, adding them to the invalid files. Change-Id: I007654340ac325be89188c1680c38c2bc37a0340 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-09-15 07:38:49 +00:00
QStringList(), // as we load no dependencies we do not need any paths
QQmlJS::Dom::DomEnvironment::Option::SingleThreaded
| QQmlJS::Dom::DomEnvironment::Option::NoDependencies);
DomItem tFile;
DOM refactoring. Remove LoadOptions Only defaultLoad is being used, hence it doesn't make sense to have them at all at the current stage Task-number: QTBUG-119550 Change-Id: I761e7c55d6aaafa29d234ace4b4b65bcc46a9855 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2024-01-24 13:39:30 +00:00
env->loadFile(FileToLoad::fromFileSystem(env, fileToFormat),
[&tFile](Path, const DomItem &, const DomItem &newIt) { tFile = newIt; });
DOM refactoring. Move loadPendingDependencies to DomEnvironment One of the goals of this refactoring is to move DomTop specific functionality from DomItem API to the corresponding DomEnvironment and DomUniverse. This commit moves loading of the dependencies (which are added to the pending load queue implicitly as part of the callbacks of the loadFile when DomEnv is created without the flag "NoDependencies") to the DomEnvironment interface Moreover, once work with dependencies is happening through the DomEnvironment explicitly, it allows us to get rid of "self" parameter. Task-number: QTBUG-119550 Change-Id: Ib3deb97eabe091ffded8c8c782ee08f8024468f2 Reviewed-by: Sami Shalayel <sami.shalayel@qt.io>
2024-01-08 16:52:18 +00:00
env->loadPendingDependencies();
tst_qmlformat: in memory formatting when reformatting all qmlfiles avoid copying the file, and calling the qmlformat tool when scanning all qmlfiles. Improvements in the reformatting made some more incorrect files fail, adding them to the invalid files. Change-Id: I007654340ac325be89188c1680c38c2bc37a0340 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-09-15 07:38:49 +00:00
MutableDomItem myFile = tFile.field(Fields::currentItem);
tst_qmlformat: fix an uninitialized variable usage GCC rightfully complains that /home/qt/work/qt/qtdeclarative/tests/auto/qml/qmlformat/tst_qmlformat.cpp:263:21: warning: ‘writtenOut’ may be used uninitialized in this function [-Wmaybe-uninitialized] 263 | *didSucceed = writtenOut; | ~~~~~~~~~~~~^~~~~~~~~~~~ because if we don't enter the if, we never initialize writtenOut. Initialize it. Pick-to: 6.9 6.8 Change-Id: I6d3bb8038e524773a11b3333bf65654593f01da9 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2025-04-10 13:43:17 +00:00
bool writtenOut = false;
tst_qmlformat: in memory formatting when reformatting all qmlfiles avoid copying the file, and calling the qmlformat tool when scanning all qmlfiles. Improvements in the reformatting made some more incorrect files fail, adding them to the invalid files. Change-Id: I007654340ac325be89188c1680c38c2bc37a0340 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-09-15 07:38:49 +00:00
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)
QQmlJS::Dom::OutWriter. Refactoring The refactoring consists of: - Changing writeOut & writeOutForFile API to return boolean instead of MutableDomItem, which better reflects the existing usecases improving consistency of the data model* Moreover, previous API was exposing DomItem, which was not "committed to base" (MutableDomItem.commitToBase()), meaning it was exposing the "unmerged" Item alongside with the "temporary environment" - Refactoring & renaming OutWriter::updatedFile breaking it into smaller chunks preserving only necessary functionality - Adding some comments / documentation Before this commit, the writeOut API was "exposing",so called, "updatedFile", which is basically the copy of the original fileItem + renewed scriptExpressions which were modified during the writeOut of the original fileItem. The idea behind the "mutating" Dom API is that one has to create a MutableDomItem, do some changes to it and then "commit" them. This process is also facilitated by the creation of separate Env. (git analogy might be handy here: We create a separate branch, where all the mutation will happen and then we "merge" this branch) However, in the writeOutForFile usecase this "updatedFile" was needed only for the verifying of the consistency of the "writtenOut" DOM, however the API was exposing it further back to the caller sites, without "committing". The potential issue here is inconsistency of the data Model. On one side we have an original File Item owned by the Base Env, on the other side we have an "updatedFile" which is owned by another Env. Taking into account that there are no usecases requiring "exposing" "updatedFile", but also no need for "committing" the changes, It's arguably better to keep that temporary "updatedFile" locally, not exposing it outside the writeOutForFile function. Thereby improving consistency of the data model. Change-Id: If45eca4b4d6d703e2a76d0580f124d0292af5ed8 Reviewed-by: Semih Yavuz <semih.yavuz@qt.io>
2023-12-05 09:42:23 +00:00
*didSucceed = writtenOut;
tst_qmlformat: in memory formatting when reformatting all qmlfiles avoid copying the file, and calling the qmlformat tool when scanning all qmlfiles. Improvements in the reformatting made some more incorrect files fail, adding them to the invalid files. Change-Id: I007654340ac325be89188c1680c38c2bc37a0340 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2021-09-15 07:38:49 +00:00
return resultStr;
}
tst_qmlformat: prefer in-process formatting instead of out-of-process Move all the tests from testFormat() to a newly added qml() function that do not seem to test any command line parameters. The qml() function runs the tests in-process instead of spawning extra qmlformat processes. Task-number: QTBUG-134669 Change-Id: I99bfd8a840c31cd2b0a4c889c0f0ca39b8c73eb2 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2025-03-17 08:48:53 +00:00
void TestQmlformat::qml_data()
{
QTest::addColumn<QString>("file");
QTest::addColumn<QString>("fileFormatted");
QTest::newRow("example1") << "Example1.qml"
tst_qmlformat: clean up in-process formatting method Remove the unused arguments and run clang-format on it. Task-number: QTBUG-134669 Change-Id: I1aff620feb26a160f4330807a56a5985c7c5fc12 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2025-03-17 08:52:52 +00:00
<< "Example1.formatted.qml";
tst_qmlformat: prefer in-process formatting instead of out-of-process Move all the tests from testFormat() to a newly added qml() function that do not seem to test any command line parameters. The qml() function runs the tests in-process instead of spawning extra qmlformat processes. Task-number: QTBUG-134669 Change-Id: I99bfd8a840c31cd2b0a4c889c0f0ca39b8c73eb2 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2025-03-17 08:48:53 +00:00
QTest::newRow("annotation") << "Annotations.qml"
tst_qmlformat: clean up in-process formatting method Remove the unused arguments and run clang-format on it. Task-number: QTBUG-134669 Change-Id: I1aff620feb26a160f4330807a56a5985c7c5fc12 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2025-03-17 08:52:52 +00:00
<< "Annotations.formatted.qml";
tst_qmlformat: prefer in-process formatting instead of out-of-process Move all the tests from testFormat() to a newly added qml() function that do not seem to test any command line parameters. The qml() function runs the tests in-process instead of spawning extra qmlformat processes. Task-number: QTBUG-134669 Change-Id: I99bfd8a840c31cd2b0a4c889c0f0ca39b8c73eb2 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2025-03-17 08:48:53 +00:00
QTest::newRow("front inline") << "FrontInline.qml"
tst_qmlformat: clean up in-process formatting method Remove the unused arguments and run clang-format on it. Task-number: QTBUG-134669 Change-Id: I1aff620feb26a160f4330807a56a5985c7c5fc12 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2025-03-17 08:52:52 +00:00
<< "FrontInline.formatted.qml";
tst_qmlformat: prefer in-process formatting instead of out-of-process Move all the tests from testFormat() to a newly added qml() function that do not seem to test any command line parameters. The qml() function runs the tests in-process instead of spawning extra qmlformat processes. Task-number: QTBUG-134669 Change-Id: I99bfd8a840c31cd2b0a4c889c0f0ca39b8c73eb2 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2025-03-17 08:48:53 +00:00
QTest::newRow("if blocks") << "IfBlocks.qml"
tst_qmlformat: clean up in-process formatting method Remove the unused arguments and run clang-format on it. Task-number: QTBUG-134669 Change-Id: I1aff620feb26a160f4330807a56a5985c7c5fc12 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2025-03-17 08:52:52 +00:00
<< "IfBlocks.formatted.qml";
QTest::newRow("read-only properties") << "readOnlyProps.qml"
<< "readOnlyProps.formatted.qml";
QTest::newRow("states and transitions") << "statesAndTransitions.qml"
<< "statesAndTransitions.formatted.qml";
QTest::newRow("large bindings") << "largeBindings.qml"
<< "largeBindings.formatted.qml";
QTest::newRow("verbatim strings") << "verbatimString.qml"
<< "verbatimString.formatted.qml";
QTest::newRow("inline components") << "inlineComponents.qml"
<< "inlineComponents.formatted.qml";
tst_qmlformat: prefer in-process formatting instead of out-of-process Move all the tests from testFormat() to a newly added qml() function that do not seem to test any command line parameters. The qml() function runs the tests in-process instead of spawning extra qmlformat processes. Task-number: QTBUG-134669 Change-Id: I99bfd8a840c31cd2b0a4c889c0f0ca39b8c73eb2 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2025-03-17 08:48:53 +00:00
QTest::newRow("nested ifs") << "nestedIf.qml"
tst_qmlformat: clean up in-process formatting method Remove the unused arguments and run clang-format on it. Task-number: QTBUG-134669 Change-Id: I1aff620feb26a160f4330807a56a5985c7c5fc12 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2025-03-17 08:52:52 +00:00
<< "nestedIf.formatted.qml";
tst_qmlformat: prefer in-process formatting instead of out-of-process Move all the tests from testFormat() to a newly added qml() function that do not seem to test any command line parameters. The qml() function runs the tests in-process instead of spawning extra qmlformat processes. Task-number: QTBUG-134669 Change-Id: I99bfd8a840c31cd2b0a4c889c0f0ca39b8c73eb2 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2025-03-17 08:48:53 +00:00
QTest::newRow("QTBUG-85003") << "QtBug85003.qml"
tst_qmlformat: clean up in-process formatting method Remove the unused arguments and run clang-format on it. Task-number: QTBUG-134669 Change-Id: I1aff620feb26a160f4330807a56a5985c7c5fc12 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2025-03-17 08:52:52 +00:00
<< "QtBug85003.formatted.qml";
QTest::newRow("nested functions") << "nestedFunctions.qml"
<< "nestedFunctions.formatted.qml";
QTest::newRow("multiline comments") << "multilineComment.qml"
<< "multilineComment.formatted.qml";
tst_qmlformat: prefer in-process formatting instead of out-of-process Move all the tests from testFormat() to a newly added qml() function that do not seem to test any command line parameters. The qml() function runs the tests in-process instead of spawning extra qmlformat processes. Task-number: QTBUG-134669 Change-Id: I99bfd8a840c31cd2b0a4c889c0f0ca39b8c73eb2 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2025-03-17 08:48:53 +00:00
QTest::newRow("for of") << "forOf.qml"
tst_qmlformat: clean up in-process formatting method Remove the unused arguments and run clang-format on it. Task-number: QTBUG-134669 Change-Id: I1aff620feb26a160f4330807a56a5985c7c5fc12 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2025-03-17 08:52:52 +00:00
<< "forOf.formatted.qml";
QTest::newRow("property names") << "propertyNames.qml"
<< "propertyNames.formatted.qml";
tst_qmlformat: prefer in-process formatting instead of out-of-process Move all the tests from testFormat() to a newly added qml() function that do not seem to test any command line parameters. The qml() function runs the tests in-process instead of spawning extra qmlformat processes. Task-number: QTBUG-134669 Change-Id: I99bfd8a840c31cd2b0a4c889c0f0ca39b8c73eb2 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2025-03-17 08:48:53 +00:00
QTest::newRow("empty object") << "emptyObject.qml"
tst_qmlformat: clean up in-process formatting method Remove the unused arguments and run clang-format on it. Task-number: QTBUG-134669 Change-Id: I1aff620feb26a160f4330807a56a5985c7c5fc12 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2025-03-17 08:52:52 +00:00
<< "emptyObject.formatted.qml";
QTest::newRow("arrow functions") << "arrowFunctions.qml"
<< "arrowFunctions.formatted.qml";
QTest::newRow("forWithLet") << "forWithLet.qml"
<< "forWithLet.formatted.qml";
QTest::newRow("dontRemoveComments") << "dontRemoveComments.qml"
<< "dontRemoveComments.formatted.qml";
QTest::newRow("ecmaScriptClassInQml") << "ecmaScriptClassInQml.qml"
<< "ecmaScriptClassInQml.formatted.qml";
QTest::newRow("arrowFunctionWithBinding") << "arrowFunctionWithBinding.qml"
<< "arrowFunctionWithBinding.formatted.qml";
QTest::newRow("blanklinesAfterComment") << "blanklinesAfterComment.qml"
<< "blanklinesAfterComment.formatted.qml";
QTest::newRow("pragmaValueList") << "pragma.qml"
<< "pragma.formatted.qml";
QTest::newRow("objectDestructuring") << "objectDestructuring.qml"
<< "objectDestructuring.formatted.qml";
tst_qmlformat: prefer in-process formatting instead of out-of-process Move all the tests from testFormat() to a newly added qml() function that do not seem to test any command line parameters. The qml() function runs the tests in-process instead of spawning extra qmlformat processes. Task-number: QTBUG-134669 Change-Id: I99bfd8a840c31cd2b0a4c889c0f0ca39b8c73eb2 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2025-03-17 08:48:53 +00:00
QTest::newRow("destructuringFunctionParameter")
<< "destructuringFunctionParameter.qml"
tst_qmlformat: clean up in-process formatting method Remove the unused arguments and run clang-format on it. Task-number: QTBUG-134669 Change-Id: I1aff620feb26a160f4330807a56a5985c7c5fc12 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2025-03-17 08:52:52 +00:00
<< "destructuringFunctionParameter.formatted.qml";
QTest::newRow("ellipsisFunctionArgument") << "ellipsisFunctionArgument.qml"
<< "ellipsisFunctionArgument.formatted.qml";
QTest::newRow("importStatements") << "importStatements.qml"
<< "importStatements.formatted.qml";
QTest::newRow("arrayEndComma") << "arrayEndComma.qml"
<< "arrayEndComma.formatted.qml";
QTest::newRow("escapeChars") << "escapeChars.qml"
<< "escapeChars.formatted.qml";
QTest::newRow("javascriptBlock") << "javascriptBlock.qml"
<< "javascriptBlock.formatted.qml";
QTest::newRow("enumWithValues") << "enumWithValues.qml"
<< "enumWithValues.formatted.qml";
QTest::newRow("typeAnnotatedSignal") << "signal.qml"
<< "signal.formatted.qml";
// plainJS
QTest::newRow("nestedLambdaWithIfElse") << "lambdaWithIfElseInsideLambda.js"
<< "lambdaWithIfElseInsideLambda.formatted.js";
QTest::newRow("noSuperfluousSpaceInsertions") << "noSuperfluousSpaceInsertions.qml"
<< "noSuperfluousSpaceInsertions.formatted.qml";
tst_qmlformat: prefer in-process formatting instead of out-of-process Move all the tests from testFormat() to a newly added qml() function that do not seem to test any command line parameters. The qml() function runs the tests in-process instead of spawning extra qmlformat processes. Task-number: QTBUG-134669 Change-Id: I99bfd8a840c31cd2b0a4c889c0f0ca39b8c73eb2 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2025-03-17 08:48:53 +00:00
QTest::newRow("noSuperfluousSpaceInsertions.fail_id")
<< "noSuperfluousSpaceInsertions.fail_id.qml"
tst_qmlformat: clean up in-process formatting method Remove the unused arguments and run clang-format on it. Task-number: QTBUG-134669 Change-Id: I1aff620feb26a160f4330807a56a5985c7c5fc12 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2025-03-17 08:52:52 +00:00
<< "noSuperfluousSpaceInsertions.fail_id.formatted.qml";
tst_qmlformat: prefer in-process formatting instead of out-of-process Move all the tests from testFormat() to a newly added qml() function that do not seem to test any command line parameters. The qml() function runs the tests in-process instead of spawning extra qmlformat processes. Task-number: QTBUG-134669 Change-Id: I99bfd8a840c31cd2b0a4c889c0f0ca39b8c73eb2 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2025-03-17 08:48:53 +00:00
QTest::newRow("noSuperfluousSpaceInsertions.fail_QtObject")
<< "noSuperfluousSpaceInsertions.fail_QtObject.qml"
tst_qmlformat: clean up in-process formatting method Remove the unused arguments and run clang-format on it. Task-number: QTBUG-134669 Change-Id: I1aff620feb26a160f4330807a56a5985c7c5fc12 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2025-03-17 08:52:52 +00:00
<< "noSuperfluousSpaceInsertions.fail_QtObject.formatted.qml";
tst_qmlformat: prefer in-process formatting instead of out-of-process Move all the tests from testFormat() to a newly added qml() function that do not seem to test any command line parameters. The qml() function runs the tests in-process instead of spawning extra qmlformat processes. Task-number: QTBUG-134669 Change-Id: I99bfd8a840c31cd2b0a4c889c0f0ca39b8c73eb2 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2025-03-17 08:48:53 +00:00
QTest::newRow("noSuperfluousSpaceInsertions.fail_signal")
<< "noSuperfluousSpaceInsertions.fail_signal.qml"
tst_qmlformat: clean up in-process formatting method Remove the unused arguments and run clang-format on it. Task-number: QTBUG-134669 Change-Id: I1aff620feb26a160f4330807a56a5985c7c5fc12 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2025-03-17 08:52:52 +00:00
<< "noSuperfluousSpaceInsertions.fail_signal.formatted.qml";
tst_qmlformat: prefer in-process formatting instead of out-of-process Move all the tests from testFormat() to a newly added qml() function that do not seem to test any command line parameters. The qml() function runs the tests in-process instead of spawning extra qmlformat processes. Task-number: QTBUG-134669 Change-Id: I99bfd8a840c31cd2b0a4c889c0f0ca39b8c73eb2 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2025-03-17 08:48:53 +00:00
QTest::newRow("noSuperfluousSpaceInsertions.fail_enum")
<< "noSuperfluousSpaceInsertions.fail_enum.qml"
tst_qmlformat: clean up in-process formatting method Remove the unused arguments and run clang-format on it. Task-number: QTBUG-134669 Change-Id: I1aff620feb26a160f4330807a56a5985c7c5fc12 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2025-03-17 08:52:52 +00:00
<< "noSuperfluousSpaceInsertions.fail_enum.formatted.qml";
tst_qmlformat: prefer in-process formatting instead of out-of-process Move all the tests from testFormat() to a newly added qml() function that do not seem to test any command line parameters. The qml() function runs the tests in-process instead of spawning extra qmlformat processes. Task-number: QTBUG-134669 Change-Id: I99bfd8a840c31cd2b0a4c889c0f0ca39b8c73eb2 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2025-03-17 08:48:53 +00:00
QTest::newRow("noSuperfluousSpaceInsertions.fail_parameters")
<< "noSuperfluousSpaceInsertions.fail_parameters.qml"
tst_qmlformat: clean up in-process formatting method Remove the unused arguments and run clang-format on it. Task-number: QTBUG-134669 Change-Id: I1aff620feb26a160f4330807a56a5985c7c5fc12 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2025-03-17 08:52:52 +00:00
<< "noSuperfluousSpaceInsertions.fail_parameters.formatted.qml";
tst_qmlformat: prefer in-process formatting instead of out-of-process Move all the tests from testFormat() to a newly added qml() function that do not seem to test any command line parameters. The qml() function runs the tests in-process instead of spawning extra qmlformat processes. Task-number: QTBUG-134669 Change-Id: I99bfd8a840c31cd2b0a4c889c0f0ca39b8c73eb2 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2025-03-17 08:48:53 +00:00
QTest::newRow("nonInitializedPropertyInComponent")
<< "nonInitializedPropertyInComponent.qml"
tst_qmlformat: clean up in-process formatting method Remove the unused arguments and run clang-format on it. Task-number: QTBUG-134669 Change-Id: I1aff620feb26a160f4330807a56a5985c7c5fc12 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2025-03-17 08:52:52 +00:00
<< "nonInitializedPropertyInComponent.formatted.qml";
QTest::newRow("fromAsIdentifier") << "fromAsIdentifier.qml"
<< "fromAsIdentifier.formatted.qml";
QTest::newRow("finalProperties") << "finalProperties.qml"
<< "finalProperties.formatted.qml";
tst_qmlformat: prefer in-process formatting instead of out-of-process Move all the tests from testFormat() to a newly added qml() function that do not seem to test any command line parameters. The qml() function runs the tests in-process instead of spawning extra qmlformat processes. Task-number: QTBUG-134669 Change-Id: I99bfd8a840c31cd2b0a4c889c0f0ca39b8c73eb2 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2025-03-17 08:48:53 +00:00
}
void TestQmlformat::qml()
{
QFETCH(QString, file);
QFETCH(QString, fileFormatted);
bool wasSuccessful;
LineWriterOptions opts;
opts.attributesSequence = LineWriterOptions::AttributesSequence::Preserve;
#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(fileFormatted);
QEXPECT_FAIL("noSuperfluousSpaceInsertions.fail_id",
"Not all cases have been covered yet (QTBUG-133315, QTBUG-123386)", Abort);
QEXPECT_FAIL("noSuperfluousSpaceInsertions.fail_QtObject",
"Not all cases have been covered yet (QTBUG-133315, QTBUG-123386)", Abort);
QEXPECT_FAIL("noSuperfluousSpaceInsertions.fail_signal",
"Not all cases have been covered yet (QTBUG-133315, QTBUG-123386)", Abort);
QEXPECT_FAIL("noSuperfluousSpaceInsertions.fail_enum",
"Not all cases have been covered yet (QTBUG-133315, QTBUG-123386)", Abort);
QEXPECT_FAIL("noSuperfluousSpaceInsertions.fail_parameters",
"Not all cases have been covered yet (QTBUG-133315, QTBUG-123386)", Abort);
QCOMPARE(output, exp);
}
qtdeclarative/tools: Implement qmlformat qmlformat is a tool that formats qml files according to the QML coding conventions (https://doc.qt.io/qt-5/qml-codingconventions.html). Change-Id: I359c4bd3b51f60614535f0e857d7e0b21b1d9033 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2019-12-13 15:10:46 +00:00
QTEST_MAIN(TestQmlformat)
#include "tst_qmlformat.moc"