Make Settings operation to support _OLD and placeholders

Setting can be a file. The Settings path was hard coded to .dat file,
which made it impossible to move the settings file to a different
location or use some other settings file instead.
This change saves the settings path with placeholder name,
which is resolved before performing settings operation or undo
operation. In case settings path is hard coded to .dat file and the
settings file is relocated, this can be overcome by setting variable
name _OLD to point to the location where the settings file originally
was. Installer uses this _OLD syntax to resolve the new location.

For example in the following example Tools.ini is relocated
from OldLocation to NewLocation. Setting the installer values the
following way will tell installer to use the settings from NewLocation
instead of OldLocation.
installer.setValue("MY_OWN_EXECUTABLE", "C:/Qt/NewLocation/Tools.ini")
installer.setValue("MY_OWN_EXECUTABLE_OLD",
"C:/Qt/OldLocation/Tools.ini")

Task-number: QTIFW-2882
Change-Id: I47dc68dfba8a49f37ab361edc8c64d3e5523e02e
Reviewed-by: Arttu Tarkiainen <arttu.tarkiainen@qt.io>

8 files changed, 141 insertions, 6 deletions

diff --git a/src/libs/installer/settingsoperation.cpp b/src/libs/installer/settingsoperation.cpp
index 4c983b17a..a74161178 100644
--- a/src/libs/installer/settingsoperation.cpp
+++ b/src/libs/installer/settingsoperation.cpp
@@ -46,6 +46,7 @@ SettingsOperation::SettingsOperation(PackageManagerCore *core)
     : UpdateOperation(core)
 {
     setName(QLatin1String("Settings"));
+    setRequiresUnreplacedVariables(true);
 }
 
 void SettingsOperation::backup()
@@ -104,10 +105,17 @@ bool SettingsOperation::performOperation()
 
     if (!checkArguments())
         return false;
-    const QString path = argumentKeyValue(QLatin1String("path"));
+    QString path = argumentKeyValue(QLatin1String("path"));
     const QString method = argumentKeyValue(QLatin1String("method"));
     const QString key = argumentKeyValue(QLatin1String("key"));
-    const QString aValue = argumentKeyValue(QLatin1String("value"));
+    QString aValue = argumentKeyValue(QLatin1String("value"));
+
+    if (requiresUnreplacedVariables()) {
+        if (PackageManagerCore *const core = packageManager()) {
+            path = core->replaceVariables(path);
+            aValue = core->replaceVariables(aValue);
+        }
+    }
 
     // use MkdirOperation to get the path so it can remove it with MkdirOperation::undoOperation later
     KDUpdater::MkdirOperation mkDirOperation;
@@ -152,14 +160,25 @@ bool SettingsOperation::undoOperation()
 {
     if (!checkArguments())
         return false;
-    const QString path = argumentKeyValue(QLatin1String("path"));
+    QString path = argumentKeyValue(QLatin1String("path"));
     const QString method = argumentKeyValue(QLatin1String("method"));
     const QString key = argumentKeyValue(QLatin1String("key"));
-    const QString aValue = argumentKeyValue(QLatin1String("value"));
+    QString aValue = argumentKeyValue(QLatin1String("value"));
 
     if (method.startsWith(QLatin1String("remove")))
         return true;
 
+    if (requiresUnreplacedVariables()) {
+        if (PackageManagerCore *const core = packageManager()) {
+            path = core->replaceVariables(path);
+            aValue = core->replaceVariables(aValue);
+            // Check is different settings file is wanted to be used.
+            // Old settings file name should be set to variable <variable_name>_OLD,
+            // and new path is then read from <variable_name> variable.
+            variableReplacement(&path);
+        }
+    }
+
     bool cleanUp = false;
     { // kill the scope to kill settings object, else remove file will not work
         QSettingsWrapper settings(path, QSettings::IniFormat);
diff --git a/src/libs/kdtools/updateoperation.cpp b/src/libs/kdtools/updateoperation.cpp
index 35629809e..657aab4a4 100644
--- a/src/libs/kdtools/updateoperation.cpp
+++ b/src/libs/kdtools/updateoperation.cpp
@@ -321,6 +321,37 @@ void UpdateOperation::setRequiresUnreplacedVariables(bool isRequired)
     m_requiresUnreplacedVariables = isRequired;
 }
 
+/*!
+    Replaces installer \c value \a variableValue with predefined variable.
+    If \c key is found for the \a variableValue and the \c key ends with string _OLD,
+    the initial \a variableValue is replaced  with the \c value having a key
+    without _OLD ending. This way we can replace the hard coded values defined for operations,
+    if the value has for some reason changed. For example if we set following variables
+    in install script:
+    \snippet installer.setValue("MY_OWN_EXECUTABLE", "C:/Qt/NewLocation/Tools.exe")
+    \snippet installer.setValue("MY_OWN_EXECUTABLE_OLD", "C:/Qt/OldLocation/Tools.exe")
+    and we have moved the Tools.exe from OldLocation to NewLocation, the operation
+    continues to work and use the Tools.exe from NewLocation although original
+    installation has been made with Tools.exe in OldLocation.
+    Returns \c true if \a variableValue is replaced.
+*/
+bool UpdateOperation::variableReplacement(QString *variableValue)
+{
+    bool variableValueChanged = false;
+    const QString valueNormalized = QDir::cleanPath(*variableValue);
+    QString key = m_core->key(valueNormalized);
+    if (key.endsWith(QLatin1String("_OLD"))) {
+        key.chop(4);
+        if (m_core->containsValue(key)) {
+            key.prepend(QLatin1String("@"));
+            key.append(QLatin1String("@"));
+            *variableValue = m_core->replaceVariables(key);
+            variableValueChanged = true;
+        }
+    }
+    return variableValueChanged;
+}
+
 struct StartsWith
 {
     explicit StartsWith(const QString &searchTerm)
diff --git a/src/libs/kdtools/updateoperation.h b/src/libs/kdtools/updateoperation.h
index a39c25747..4a431f107 100644
--- a/src/libs/kdtools/updateoperation.h
+++ b/src/libs/kdtools/updateoperation.h
@@ -114,6 +114,7 @@ protected:
     QStringList parsePerformOperationArguments();
     QStringList parseUndoOperationArguments();
     void setRequiresUnreplacedVariables(bool isRequired);
+    bool variableReplacement(QString *variableValue);
 
 private:
     QString m_name;
diff --git a/tests/auto/installer/settingsoperation/data/repository/B/1.0.0meta.7z b/tests/auto/installer/settingsoperation/data/repository/B/1.0.0meta.7z
new file mode 100644
index 000000000..211bc0e0a
--- /dev/null
+++ b/tests/auto/installer/settingsoperation/data/repository/B/1.0.0meta.7z
diff --git a/tests/auto/installer/settingsoperation/data/repository/C/1.0.0meta.7z b/tests/auto/installer/settingsoperation/data/repository/C/1.0.0meta.7z
new file mode 100644
index 000000000..a990fdbf1
--- /dev/null
+++ b/tests/auto/installer/settingsoperation/data/repository/C/1.0.0meta.7z
diff --git a/tests/auto/installer/settingsoperation/data/repository/Updates.xml b/tests/auto/installer/settingsoperation/data/repository/Updates.xml
index eddb160c0..3e88f849d 100644
--- a/tests/auto/installer/settingsoperation/data/repository/Updates.xml
+++ b/tests/auto/installer/settingsoperation/data/repository/Updates.xml
@@ -8,8 +8,26 @@
   <Description>Example component A</Description>
   <Version>1.0.2-1</Version>
   <ReleaseDate>2015-01-01</ReleaseDate>
-  <Default>true</Default>
+  <Default>false</Default>
   <Script>script.qs</Script>
   <SHA1>5dc8a98f591998de0c555e194e228fa740a15632</SHA1>
  </PackageUpdate>
+ <PackageUpdate>
+  <Name>B</Name>
+  <DisplayName>B</DisplayName>
+  <Description>Example component B</Description>
+  <Version>1.0.0</Version>
+  <ReleaseDate>2015-01-01</ReleaseDate>
+  <Default>false</Default>
+  <Script>script.qs</Script>
+ </PackageUpdate>
+ <PackageUpdate>
+  <Name>C</Name>
+  <DisplayName>C</DisplayName>
+  <Description>Example component C</Description>
+  <Version>1.0.0</Version>
+  <ReleaseDate>2015-01-01</ReleaseDate>
+  <Default>false</Default>
+  <Script>script.qs</Script>
+ </PackageUpdate>
 </Updates>
diff --git a/tests/auto/installer/settingsoperation/settings.qrc b/tests/auto/installer/settingsoperation/settings.qrc
index d030220ab..8da639ad6 100644
--- a/tests/auto/installer/settingsoperation/settings.qrc
+++ b/tests/auto/installer/settingsoperation/settings.qrc
@@ -2,5 +2,7 @@
     <qresource prefix="/">
         <file>data/repository/Updates.xml</file>
         <file>data/repository/A/1.0.2-1meta.7z</file>
+        <file>data/repository/B/1.0.0meta.7z</file>
+        <file>data/repository/C/1.0.0meta.7z</file>
     </qresource>
 </RCC>
diff --git a/tests/auto/installer/settingsoperation/tst_settingsoperation.cpp b/tests/auto/installer/settingsoperation/tst_settingsoperation.cpp
index 9b08d4f6f..2da0870c7 100644
--- a/tests/auto/installer/settingsoperation/tst_settingsoperation.cpp
+++ b/tests/auto/installer/settingsoperation/tst_settingsoperation.cpp
@@ -177,6 +177,7 @@ private slots:
 
         QFile testFile(testFilePath);
         QVERIFY2(testFile.open(QIODevice::WriteOnly | QIODevice::Text), contentFile.errorString().toLatin1());
+        m_cleanupFilePaths << testFilePath;
 
         QTextStream out(&testFile);
 
@@ -244,6 +245,7 @@ private slots:
         QFile testFile(testFilePath);
         QVERIFY2(testFile.open(QIODevice::WriteOnly | QIODevice::Text), contentFile.errorString()
             .toLatin1());
+        m_cleanupFilePaths << testFilePath;
 
         QTextStream out(&testFile);
 
@@ -293,7 +295,7 @@ private slots:
         QCOMPARE(testSettings.value("testcategory/categoryarrayvalue1").toStringList(),
                  QStringList() << "value1" << "value2" << "value3");
 
-        core->installDefaultComponentsSilently();
+        core->installSelectedComponentsSilently(QStringList() << "A");
 
         QCOMPARE(testSettings.value("testcategory/categoryarrayvalue1").toStringList(),
                  QStringList() << "value1" << "value2" << "value3" << "valueFromScript");
@@ -309,6 +311,68 @@ private slots:
         core->deleteLater();
     }
 
+    void testPerformingFromCLIWithPlaceholders()
+    {
+        QString installDir = QInstaller::generateTemporaryFileName();
+        QVERIFY(QDir().mkpath(installDir));
+        PackageManagerCore *core = PackageManager::getPackageManagerWithInit
+            (installDir, ":///data/repository");
+
+        core->installSelectedComponentsSilently(QStringList() << "B");
+        // Path is set in component constructor in install script
+        const QString  settingsFile = core->value("SettingsPathFromVariable");
+        QSettings testSettings(QDir(m_testSettingsDirPath).filePath(settingsFile),
+                               QSettings::IniFormat);
+
+        QCOMPARE(testSettings.value("testcategory/categoryarrayvalue1").toStringList(),
+                 QStringList() << "ValueFromPlaceholder");
+
+        core->commitSessionOperations();
+        core->setPackageManager();
+        core->uninstallComponentsSilently(QStringList() << "B");
+
+        // Settings file is removed as it is empty
+        QVERIFY(!QFile::exists(settingsFile));
+        QDir dir(installDir);
+        QVERIFY(dir.removeRecursively());
+        core->deleteLater();
+    }
+
+    void testPerformingFromCLIWithSettingsFileMoved()
+    {
+        QString installDir = QInstaller::generateTemporaryFileName();
+        QVERIFY(QDir().mkpath(installDir));
+        PackageManagerCore *core = PackageManager::getPackageManagerWithInit
+            (installDir, ":///data/repository");
+
+
+        core->installSelectedComponentsSilently(QStringList() << "C");
+
+        const QString settingsFileName = qApp->applicationDirPath() + "/oldTestSettings.ini";
+        QSettings testSettings(QDir(m_testSettingsDirPath).filePath(settingsFileName),
+                               QSettings::IniFormat);
+
+        QCOMPARE(testSettings.value("testcategory/categoryarrayvalue1").toStringList(),
+                 QStringList() << "valueFromScript");
+
+        QFile settingsFile(settingsFileName);
+        // Move the settings path to new location. Script has set values
+        // ComponentCSettingsPath (@InstallerDirPath@/newTestSettings.ini) and
+        // ComponentCSettingsPath_OLD (@InstallerDirPath@/oldTestSettings.ini) so
+        // UNDO operation should delete the moved newTestSettings.ini file instead.
+        QVERIFY2(settingsFile.rename(qApp->applicationDirPath() + "/newTestSettings.ini"), "Could not move settings file.");
+        core->commitSessionOperations();
+        core->setPackageManager();
+        core->uninstallComponentsSilently(QStringList() << "C");
+
+        // Settings file is removed in uninstall as it is empty
+        QVERIFY2(!QFile::exists(qApp->applicationDirPath() + "/newTestSettings.ini"), "Settings file not deleted correctly");
+
+        QDir dir(installDir);
+        QVERIFY(dir.removeRecursively());
+        core->deleteLater();
+    }
+
     // called after all tests
     void cleanupTestCase()
     {