feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity
Files
dfadc17cb59cf479fe48b5cb15bf3d6bebb023eb
qt-creator/tests/auto/environment/tst_environment.cpp

355 lines
10 KiB
C++
Raw Normal View History

Adjust license headers Change-Id: Ice592c6de9951ee3b2c4cb52ed0bb3b6770e0825 Reviewed-by: Eike Ziller <eike.ziller@digia.com>
2012-10-02 09:12:39 +02:00
/****************************************************************************
change Environment::expandVariables() semantics instead of being os-agnostic, interpret the os-native expansion style, so it is consistent with proper (shell) command lines. don't interpret quotes, as this function is meant for expanding isolated filepaths, where nobody would expect quoting. instead, use the windows style of simply not doing an expansion if a referenced variable is not found, which should be good enough - it's rather unlikely that something which happens to be an expansion of an existing variable is actually not meant to be one.
2010-10-19 11:10:58 +02:00
**
Update License according to agreement with Free Qt Foundation * Update license information in tests directory Change-Id: I311441dd37d053ca3175e44b284258e232ee93e0 Reviewed-by: Tobias Hunger <tobias.hunger@theqtcompany.com>
2016-01-15 14:55:33 +01:00
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
change Environment::expandVariables() semantics instead of being os-agnostic, interpret the os-native expansion style, so it is consistent with proper (shell) command lines. don't interpret quotes, as this function is meant for expanding isolated filepaths, where nobody would expect quoting. instead, use the windows style of simply not doing an expansion if a referenced variable is not found, which should be good enough - it's rather unlikely that something which happens to be an expansion of an existing variable is actually not meant to be one.
2010-10-19 11:10:58 +02:00
**
Adjust license headers Change-Id: Ice592c6de9951ee3b2c4cb52ed0bb3b6770e0825 Reviewed-by: Eike Ziller <eike.ziller@digia.com>
2012-10-02 09:12:39 +02:00
** This file is part of Qt Creator.
change Environment::expandVariables() semantics instead of being os-agnostic, interpret the os-native expansion style, so it is consistent with proper (shell) command lines. don't interpret quotes, as this function is meant for expanding isolated filepaths, where nobody would expect quoting. instead, use the windows style of simply not doing an expansion if a referenced variable is not found, which should be good enough - it's rather unlikely that something which happens to be an expansion of an existing variable is actually not meant to be one.
2010-10-19 11:10:58 +02:00
**
Adjust license headers Change-Id: Ice592c6de9951ee3b2c4cb52ed0bb3b6770e0825 Reviewed-by: Eike Ziller <eike.ziller@digia.com>
2012-10-02 09:12:39 +02:00
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
Update License according to agreement with Free Qt Foundation * Update license information in tests directory Change-Id: I311441dd37d053ca3175e44b284258e232ee93e0 Reviewed-by: Tobias Hunger <tobias.hunger@theqtcompany.com>
2016-01-15 14:55:33 +01:00
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
change Environment::expandVariables() semantics instead of being os-agnostic, interpret the os-native expansion style, so it is consistent with proper (shell) command lines. don't interpret quotes, as this function is meant for expanding isolated filepaths, where nobody would expect quoting. instead, use the windows style of simply not doing an expansion if a referenced variable is not found, which should be good enough - it's rather unlikely that something which happens to be an expansion of an existing variable is actually not meant to be one.
2010-10-19 11:10:58 +02:00
**
Update License according to agreement with Free Qt Foundation * Update license information in tests directory Change-Id: I311441dd37d053ca3175e44b284258e232ee93e0 Reviewed-by: Tobias Hunger <tobias.hunger@theqtcompany.com>
2016-01-15 14:55:33 +01:00
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
License headers, part 2
2010-12-17 17:14:20 +01:00
**
Adjust license headers Change-Id: Ice592c6de9951ee3b2c4cb52ed0bb3b6770e0825 Reviewed-by: Eike Ziller <eike.ziller@digia.com>
2012-10-02 09:12:39 +02:00
****************************************************************************/
change Environment::expandVariables() semantics instead of being os-agnostic, interpret the os-native expansion style, so it is consistent with proper (shell) command lines. don't interpret quotes, as this function is meant for expanding isolated filepaths, where nobody would expect quoting. instead, use the windows style of simply not doing an expansion if a referenced variable is not found, which should be good enough - it's rather unlikely that something which happens to be an expansion of an existing variable is actually not meant to be one.
2010-10-19 11:10:58 +02:00
#include <utils/environment.h>
Removed module names from #include directives. Getting the #include directives ready for Qt5. This includes the new-project wizards. Change-Id: Ia9261f1e8faec06b9285b694d2b7e9a095978d2b Reviewed-by: Eike Ziller <eike.ziller@nokia.com>
2012-02-15 10:42:41 +01:00
#include <QtTest>
change Environment::expandVariables() semantics instead of being os-agnostic, interpret the os-native expansion style, so it is consistent with proper (shell) command lines. don't interpret quotes, as this function is meant for expanding isolated filepaths, where nobody would expect quoting. instead, use the windows style of simply not doing an expansion if a referenced variable is not found, which should be good enough - it's rather unlikely that something which happens to be an expansion of an existing variable is actually not meant to be one.
2010-10-19 11:10:58 +02:00
using namespace Utils;
Environment.constFind added test Change-Id: I6213650b811960fa67545df4b6531aafcca05c81 Reviewed-by: hjk <hjk@qt.io> Reviewed-by: David Schulz <david.schulz@qt.io>
2018-01-31 18:52:24 +03:00
Q_DECLARE_METATYPE(Utils::OsType)
change Environment::expandVariables() semantics instead of being os-agnostic, interpret the os-native expansion style, so it is consistent with proper (shell) command lines. don't interpret quotes, as this function is meant for expanding isolated filepaths, where nobody would expect quoting. instead, use the windows style of simply not doing an expansion if a referenced variable is not found, which should be good enough - it's rather unlikely that something which happens to be an expansion of an existing variable is actually not meant to be one.
2010-10-19 11:10:58 +02:00
class tst_Environment : public QObject
{
Q_OBJECT
private slots:
void initTestCase();
void environment_data();
void environment();
Environment: Keep case of environment variables on windows Task-number: QTCREATORBUG-18915 Change-Id: I4c389155e03dde423d1ed578409baa1f38fc26db Reviewed-by: Eike Ziller <eike.ziller@qt.io> Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io>
2017-09-15 11:20:53 +02:00
void environmentSetup_data();
void environmentSetup();
void environmentSetWindows();
void environmentSetWindowsFuzzy();
void environmentSetUnix();
void environmentSetNewWindows();
void environmentSetNewUnix();
void environmentUnsetWindows();
void environmentUnsetWindowsFuzzy();
void environmentUnsetUnix();
void environmentUnsetUnknownWindows();
void environmentUnsetUnknownUnix();
Utils::Environment: Use expanded values The Environment class is supposed to support values with references to other variables, but we failed to actually expand them in most places. Fixes: QTCREATORBUG-22687 Change-Id: I108cb59d3b4571471423455240f6f4f1cf64bf05 Reviewed-by: hjk <hjk@qt.io>
2019-08-19 14:29:14 +02:00
void expansion_data();
void expansion();
Utils::Environment: Extend autotest ... to cover the diff/apply mechanism. Change-Id: I7d9e794792d6730e935c99c66062ea417dc65fe7 Reviewed-by: hjk <hjk@qt.io>
2020-07-17 08:59:19 +02:00
void incrementalChanges();
Environment.constFind added test Change-Id: I6213650b811960fa67545df4b6531aafcca05c81 Reviewed-by: hjk <hjk@qt.io> Reviewed-by: David Schulz <david.schulz@qt.io>
2018-01-31 18:52:24 +03:00
void find_data();
void find();
change Environment::expandVariables() semantics instead of being os-agnostic, interpret the os-native expansion style, so it is consistent with proper (shell) command lines. don't interpret quotes, as this function is meant for expanding isolated filepaths, where nobody would expect quoting. instead, use the windows style of simply not doing an expansion if a referenced variable is not found, which should be good enough - it's rather unlikely that something which happens to be an expansion of an existing variable is actually not meant to be one.
2010-10-19 11:10:58 +02:00
private:
Environment env;
};
void tst_Environment::initTestCase()
{
env.set("word", "hi");
}
void tst_Environment::environment_data()
{
QTest::addColumn<QString>("in");
QTest::addColumn<QString>("out");
static const struct {
const char * const in;
const char * const out;
} vals[] = {
#ifdef Q_OS_WIN
Remove spaces in initializer lists Format initializer lists code style like. Change-Id: Ib82c235e4ba7dc75ee96a7abc0c47eff7b0a9013 Reviewed-by: hjk <hjk@qt.io>
2017-02-22 15:09:35 +01:00
{"", ""},
{"hi", "hi"},
{"hi%", "hi%"},
{"hi% ho", "hi% ho"},
{"hi%here ho", "hi%here ho"},
{"hi%here%ho", "hi%here%ho"},
{"hi%word%", "hihi"},
{"hi%foo%word%", "hi%foohi"},
{"%word%word%ho", "hiword%ho"},
{"hi%word%x%word%ho", "hihixhiho"},
{"hi%word%xx%word%ho", "hihixxhiho"},
{"hi%word%%word%ho", "hihihiho"},
change Environment::expandVariables() semantics instead of being os-agnostic, interpret the os-native expansion style, so it is consistent with proper (shell) command lines. don't interpret quotes, as this function is meant for expanding isolated filepaths, where nobody would expect quoting. instead, use the windows style of simply not doing an expansion if a referenced variable is not found, which should be good enough - it's rather unlikely that something which happens to be an expansion of an existing variable is actually not meant to be one.
2010-10-19 11:10:58 +02:00
#else
Remove spaces in initializer lists Format initializer lists code style like. Change-Id: Ib82c235e4ba7dc75ee96a7abc0c47eff7b0a9013 Reviewed-by: hjk <hjk@qt.io>
2017-02-22 15:09:35 +01:00
{"", ""},
{"hi", "hi"},
{"hi$", "hi$"},
{"hi${", "hi${"},
{"hi${word", "hi${word"},
{"hi${word}", "hihi"},
{"hi${word}ho", "hihiho"},
{"hi$wo", "hi$wo"},
{"hi$word", "hihi"},
{"hi$word ho", "hihi ho"},
{"$word", "hi"},
{"hi${word}$word", "hihihi"},
change Environment::expandVariables() semantics instead of being os-agnostic, interpret the os-native expansion style, so it is consistent with proper (shell) command lines. don't interpret quotes, as this function is meant for expanding isolated filepaths, where nobody would expect quoting. instead, use the windows style of simply not doing an expansion if a referenced variable is not found, which should be good enough - it's rather unlikely that something which happens to be an expansion of an existing variable is actually not meant to be one.
2010-10-19 11:10:58 +02:00
#endif
};
for (unsigned i = 0; i < sizeof(vals)/sizeof(vals[0]); i++)
QTest::newRow(vals[i].in) << QString::fromLatin1(vals[i].in)
<< QString::fromLatin1(vals[i].out);
}
void tst_Environment::environment()
{
QFETCH(QString, in);
QFETCH(QString, out);
QCOMPARE(env.expandVariables(in), out);
}
Environment: Keep case of environment variables on windows Task-number: QTCREATORBUG-18915 Change-Id: I4c389155e03dde423d1ed578409baa1f38fc26db Reviewed-by: Eike Ziller <eike.ziller@qt.io> Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io>
2017-09-15 11:20:53 +02:00
void tst_Environment::environmentSetup_data()
{
QTest::addColumn<int>("osType");
QTest::addColumn<QStringList>("in");
QTest::addColumn<QStringList>("out");
QTest::newRow("EmptyWin")
<< static_cast<int>(Utils::OsTypeWindows) << QStringList() << QStringList();
QTest::newRow("EmptyLinux")
<< static_cast<int>(Utils::OsTypeLinux) << QStringList() << QStringList();
QTest::newRow("SimpleWin")
<< static_cast<int>(Utils::OsTypeWindows) << QStringList({"Foo=bar"}) << QStringList({"Foo=bar"});
QTest::newRow("EmptyLinux")
<< static_cast<int>(Utils::OsTypeLinux) << QStringList({"Foo=bar"}) << QStringList({"Foo=bar"});
QTest::newRow("MultiWin")
<< static_cast<int>(Utils::OsTypeWindows)
<< QStringList({"Foo=bar", "Hi=HO"}) << QStringList({"Foo=bar", "Hi=HO"});
QTest::newRow("MultiLinux")
<< static_cast<int>(Utils::OsTypeLinux)
<< QStringList({"Foo=bar", "Hi=HO"}) << QStringList({"Foo=bar", "Hi=HO"});
QTest::newRow("DuplicateWin")
<< static_cast<int>(Utils::OsTypeWindows)
<< QStringList({"Foo=bar", "FOO=HO"}) << QStringList({"Foo=HO"});
QTest::newRow("DuplicateLinux")
<< static_cast<int>(Utils::OsTypeLinux)
<< QStringList({"Foo=bar", "FOO=HO"}) << QStringList({"FOO=HO", "Foo=bar"});
}
void tst_Environment::environmentSetup()
{
QFETCH(int, osType);
QFETCH(QStringList, in);
QFETCH(QStringList, out);
Environment env(in, static_cast<Utils::OsType>(osType));
QCOMPARE(env.toStringList(), out);
}
void tst_Environment::environmentSetWindows()
{
Environment env(QStringList({"Foo=bar", "Hi=HO"}), Utils::OsTypeWindows);
env.set("Foo", "baz");
QCOMPARE(env.toStringList(), QStringList({"Foo=baz", "Hi=HO"}));
}
void tst_Environment::environmentSetWindowsFuzzy()
{
Environment env(QStringList({"Foo=bar", "Hi=HO"}), Utils::OsTypeWindows);
env.set("FOO", "baz");
QCOMPARE(env.toStringList(), QStringList({"Foo=baz", "Hi=HO"}));
}
void tst_Environment::environmentSetUnix()
{
Environment env(QStringList({"Foo=bar", "Hi=HO"}), Utils::OsTypeLinux);
env.set("Foo", "baz");
QCOMPARE(env.toStringList(), QStringList({"Foo=baz", "Hi=HO"}));
}
void tst_Environment::environmentSetNewWindows()
{
Environment env(QStringList({"Foo=bar", "Hi=HO"}), Utils::OsTypeWindows);
env.set("bar", "baz");
Utils::Environment: Consider target OS type when sorting That is, use case-insensitive sorting on Windows, so that e.g. "Path" will not appear after "PROCESSOR_REVISION". Fixes: QTCREATORBUG-22786 Change-Id: I42d469b6079037d1062dbd5b273f5aa8ade25e79 Reviewed-by: hjk <hjk@qt.io>
2019-08-16 16:42:14 +02:00
QCOMPARE(env.toStringList(), QStringList({"bar=baz", "Foo=bar", "Hi=HO"}));
Environment: Keep case of environment variables on windows Task-number: QTCREATORBUG-18915 Change-Id: I4c389155e03dde423d1ed578409baa1f38fc26db Reviewed-by: Eike Ziller <eike.ziller@qt.io> Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io>
2017-09-15 11:20:53 +02:00
}
void tst_Environment::environmentSetNewUnix()
{
Environment env(QStringList({"Foo=bar", "Hi=HO"}), Utils::OsTypeLinux);
env.set("bar", "baz");
QCOMPARE(env.toStringList(), QStringList({"Foo=bar", "Hi=HO", "bar=baz"}));
}
void tst_Environment::environmentUnsetWindows()
{
Environment env(QStringList({"Foo=bar", "Hi=HO"}), Utils::OsTypeWindows);
env.unset("Foo");
QCOMPARE(env.toStringList(), QStringList({"Hi=HO"}));
}
void tst_Environment::environmentUnsetWindowsFuzzy()
{
Environment env(QStringList({"Foo=bar", "Hi=HO"}), Utils::OsTypeWindows);
env.unset("FOO");
QCOMPARE(env.toStringList(), QStringList({"Hi=HO"}));
}
void tst_Environment::environmentUnsetUnix()
{
Environment env(QStringList({"Foo=bar", "Hi=HO"}), Utils::OsTypeLinux);
env.unset("Foo");
QCOMPARE(env.toStringList(), QStringList({"Hi=HO"}));
}
void tst_Environment::environmentUnsetUnknownWindows()
{
Environment env(QStringList({"Foo=bar", "Hi=HO"}), Utils::OsTypeWindows);
env.unset("baz");
QCOMPARE(env.toStringList(), QStringList({"Foo=bar", "Hi=HO"}));
}
void tst_Environment::environmentUnsetUnknownUnix()
{
Environment env(QStringList({"Foo=bar", "Hi=HO"}), Utils::OsTypeLinux);
env.unset("baz");
QCOMPARE(env.toStringList(), QStringList({"Foo=bar", "Hi=HO"}));
}
Utils::Environment: Use expanded values The Environment class is supposed to support values with references to other variables, but we failed to actually expand them in most places. Fixes: QTCREATORBUG-22687 Change-Id: I108cb59d3b4571471423455240f6f4f1cf64bf05 Reviewed-by: hjk <hjk@qt.io>
2019-08-19 14:29:14 +02:00
void tst_Environment::expansion_data()
{
QTest::addColumn<Utils::OsType>("osType");
QTest::addColumn<QString>("eu");
QTest::addColumn<QString>("ew");
QTest::newRow("win") << Utils::OsTypeWindows << "${v}" << "blubb";
QTest::newRow("lin") << Utils::OsTypeLinux << "blubb" << "%v%";
}
void tst_Environment::expansion()
{
QFETCH(Utils::OsType, osType);
QFETCH(QString, eu);
QFETCH(QString, ew);
const Environment env(QStringList{"eu=${v}", "ew=%v%", "v=blubb"}, osType);
QCOMPARE(env.expandedValueForKey("eu"), eu);
QCOMPARE(env.expandedValueForKey("ew"), ew);
}
Utils::Environment: Extend autotest ... to cover the diff/apply mechanism. Change-Id: I7d9e794792d6730e935c99c66062ea417dc65fe7 Reviewed-by: hjk <hjk@qt.io>
2020-07-17 08:59:19 +02:00
void tst_Environment::incrementalChanges()
{
const Environment origEnv({{"VAR1", "VALUE1"}, {"VAR2", "VALUE2"}, {"PATH", "/usr/bin"}});
const NameValueItems changes({
{"VAR1", QString(), NameValueItem::Unset},
{"VAR2", "VALUE2", NameValueItem::SetDisabled},
{"PATH", "/usr/local/bin", NameValueItem::Append},
{"PATH", "/tmp", NameValueItem::Prepend}});
// Check values after change application.
Environment newEnv = origEnv;
newEnv.modify(changes);
QVERIFY(!newEnv.hasKey("VAR1"));
QCOMPARE(newEnv.value("VAR2"), QString());
QCOMPARE(newEnv.constFind("VAR2")->first, "VALUE2");
QVERIFY(!newEnv.isEnabled(newEnv.constFind("VAR2")));
const QChar sep = HostOsInfo::pathListSeparator();
QCOMPARE(newEnv.value("PATH"),
QString("/tmp").append(sep).append("/usr/bin").append(sep).append("/usr/local/bin"));
// Check apply/diff round-trips.
const NameValueItems diff = origEnv.diff(newEnv);
const NameValueItems reverseDiff = newEnv.diff(origEnv);
Environment newEnv2 = origEnv;
newEnv2.modify(diff);
QCOMPARE(newEnv, newEnv2);
newEnv2.modify(reverseDiff);
QCOMPARE(newEnv2, origEnv);
// Check conversion round-trips.
QCOMPARE(NameValueItem::fromStringList(NameValueItem::toStringList(changes)), changes);
QCOMPARE(NameValueItem::fromStringList(NameValueItem::toStringList(diff)), diff);
QCOMPARE(NameValueItem::fromStringList(NameValueItem::toStringList(reverseDiff)), reverseDiff);
QCOMPARE(NameValueItem::itemsFromVariantList(NameValueItem::toVariantList(changes)), changes);
QCOMPARE(NameValueItem::itemsFromVariantList(NameValueItem::toVariantList(diff)), diff);
QCOMPARE(NameValueItem::itemsFromVariantList(NameValueItem::toVariantList(reverseDiff)),
reverseDiff);
}
Environment.constFind added test Change-Id: I6213650b811960fa67545df4b6531aafcca05c81 Reviewed-by: hjk <hjk@qt.io> Reviewed-by: David Schulz <david.schulz@qt.io>
2018-01-31 18:52:24 +03:00
void tst_Environment::find_data()
{
QTest::addColumn<Utils::OsType>("osType");
QTest::addColumn<bool>("contains");
QTest::addColumn<QString>("variable");
QTest::newRow("win") << Utils::OsTypeWindows << true << "foo";
QTest::newRow("win") << Utils::OsTypeWindows << true << "Foo";
QTest::newRow("lin") << Utils::OsTypeLinux << true << "Foo";
QTest::newRow("lin") << Utils::OsTypeLinux << false << "foo";
}
void tst_Environment::find()
{
QFETCH(Utils::OsType, osType);
QFETCH(bool, contains);
QFETCH(QString, variable);
Environment env(QStringList({"Foo=bar", "Hi=HO"}), osType);
auto end = env.constEnd();
auto it = env.constFind(variable);
QCOMPARE((end != it), contains);
if (contains)
Let users disable environment entries It's helpful to be able to temporarily disable environment variables, as opposed to having to remove (and then re-add) them entirely. Fixes: QTCREATORBUG-20984 Change-Id: Ib0d287035b9357507c4c19faaf3a1517382506b5 Reviewed-by: hjk <hjk@qt.io>
2019-07-09 17:41:30 +02:00
QCOMPARE(env.value(it), QString("bar"));
Environment.constFind added test Change-Id: I6213650b811960fa67545df4b6531aafcca05c81 Reviewed-by: hjk <hjk@qt.io> Reviewed-by: David Schulz <david.schulz@qt.io>
2018-01-31 18:52:24 +03:00
}
change Environment::expandVariables() semantics instead of being os-agnostic, interpret the os-native expansion style, so it is consistent with proper (shell) command lines. don't interpret quotes, as this function is meant for expanding isolated filepaths, where nobody would expect quoting. instead, use the windows style of simply not doing an expansion if a referenced variable is not found, which should be good enough - it's rather unlikely that something which happens to be an expansion of an existing variable is actually not meant to be one.
2010-10-19 11:10:58 +02:00
QTEST_MAIN(tst_Environment)
#include "tst_environment.moc"
Copy Permalink