CMake GUI: Add environment editor

7 files changed, 218 insertions, 0 deletions

diff --git a/Tests/CMakeGUI/CMakeGUITest.cmake b/Tests/CMakeGUI/CMakeGUITest.cmake
index 632ab09..b60ec35 100644
--- a/Tests/CMakeGUI/CMakeGUITest.cmake
+++ b/Tests/CMakeGUI/CMakeGUITest.cmake
@@ -112,3 +112,9 @@ run_cmake_gui_test(sourceBinaryArgs:noExistConfigExists
 
 run_cmake_gui_test(simpleConfigure:success)
 run_cmake_gui_test(simpleConfigure:fail)
+
+unset(ENV{ADDED_VARIABLE})
+set(ENV{KEPT_VARIABLE} "Kept variable")
+set(ENV{CHANGED_VARIABLE} "This variable will be changed")
+set(ENV{REMOVED_VARIABLE} "Removed variable")
+run_cmake_gui_test(environment)
diff --git a/Tests/CMakeGUI/CMakeGUITest.cxx b/Tests/CMakeGUI/CMakeGUITest.cxx
index 4087d6b..80ea08d 100644
--- a/Tests/CMakeGUI/CMakeGUITest.cxx
+++ b/Tests/CMakeGUI/CMakeGUITest.cxx
@@ -143,6 +143,35 @@ void CMakeGUITest::simpleConfigure_data()
                         << -1;
 }
 
+void CMakeGUITest::environment()
+{
+  auto* cmake = this->m_window->findChild<QCMakeThread*>()->cmakeInstance();
+
+  this->m_window->SourceDirectory->setText(CMakeGUITest_BINARY_DIR
+                                           "/environment/src");
+  this->m_window->BinaryDirectory->setCurrentText(CMakeGUITest_BINARY_DIR
+                                                  "/environment/build");
+
+  // We are already testing EnvironmentDialog, so just trust that it's
+  // connected correctly and modify the environment directly.
+  auto env = cmake->environment();
+  env.insert("ADDED_VARIABLE", "Added variable");
+  env.insert("CHANGED_VARIABLE", "Changed variable");
+  env.remove("REMOVED_VARIABLE");
+  cmake->setEnvironment(env);
+
+  // Wait a bit for everything to update
+  loopSleep();
+
+  this->tryConfigure();
+
+  auto penv = QProcessEnvironment::systemEnvironment();
+  QVERIFY(!penv.contains("ADDED_VARIABLE"));
+  QCOMPARE(penv.value("KEPT_VARIABLE"), "Kept variable");
+  QCOMPARE(penv.value("CHANGED_VARIABLE"), "This variable will be changed");
+  QCOMPARE(penv.value("REMOVED_VARIABLE"), "Removed variable");
+}
+
 void SetupDefaultQSettings()
 {
   QSettings::setDefaultFormat(QSettings::IniFormat);
diff --git a/Tests/CMakeGUI/CMakeGUITest.h b/Tests/CMakeGUI/CMakeGUITest.h
index f39dcc1..891cf62 100644
--- a/Tests/CMakeGUI/CMakeGUITest.h
+++ b/Tests/CMakeGUI/CMakeGUITest.h
@@ -22,4 +22,5 @@ private slots:
   void sourceBinaryArgs_data();
   void simpleConfigure();
   void simpleConfigure_data();
+  void environment();
 };
diff --git a/Tests/CMakeGUI/CMakeLists.txt b/Tests/CMakeGUI/CMakeLists.txt
index ea97fa0..c6bc88a 100644
--- a/Tests/CMakeGUI/CMakeLists.txt
+++ b/Tests/CMakeGUI/CMakeLists.txt
@@ -58,6 +58,13 @@ add_cmake_gui_lib_test(CatchShow
   MOC_SOURCES
     CatchShowTest.h
   )
+add_cmake_gui_lib_test(EnvironmentDialog
+  SOURCES
+    EnvironmentDialogTest.cxx
+    EnvironmentDialogTest.h
+  MOC_SOURCES
+    EnvironmentDialogTest.h
+  )
 add_cmake_gui_lib_test(QCMakeCacheModel
   SOURCES
     QCMakeCacheModelTest.cxx
diff --git a/Tests/CMakeGUI/EnvironmentDialogTest.cxx b/Tests/CMakeGUI/EnvironmentDialogTest.cxx
new file mode 100644
index 0000000..9ec4996
--- /dev/null
+++ b/Tests/CMakeGUI/EnvironmentDialogTest.cxx
@@ -0,0 +1,142 @@
+/* Distributed under the OSI-approved BSD 3-Clause License.  See accompanying
+   file Copyright.txt or https://cmake.org/licensing for details.  */
+#include "EnvironmentDialogTest.h"
+
+#include <QDialogButtonBox>
+#include <QMessageBox>
+#include <QObject>
+#include <QPushButton>
+#include <QString>
+#include <QtTest>
+
+#include "CatchShow.h"
+#include "EnvironmentDialog.h"
+
+EnvironmentDialogTest::EnvironmentDialogTest(QObject* parent)
+  : QObject(parent)
+{
+}
+
+void EnvironmentDialogTest::environmentDialog()
+{
+  CatchShow catcher;
+  catcher.setCallback<QMessageBox>([](QMessageBox* box) { box->accept(); });
+
+  QProcessEnvironment env;
+  env.insert("DELETED_VARIABLE_1", "Deleted variable 1");
+  env.insert("DELETED_VARIABLE_2", "Deleted variable 2");
+  env.insert("KEPT_VARIABLE", "Kept variable");
+  env.insert("CHANGED_VARIABLE", "This will be changed");
+
+  EnvironmentDialog dialog(env);
+
+  {
+    QStringList expected{
+      "CHANGED_VARIABLE=This will be changed",
+      "DELETED_VARIABLE_1=Deleted variable 1",
+      "DELETED_VARIABLE_2=Deleted variable 2",
+      "KEPT_VARIABLE=Kept variable",
+    };
+    QCOMPARE(dialog.environment().toStringList(), expected);
+    QCOMPARE(catcher.count(), 0);
+  }
+
+  {
+    CatchShow catcher2;
+    bool done = false;
+    catcher2.setCallback<QDialog>([&catcher, &done](QDialog* box) {
+      if (done) {
+        return;
+      }
+      done = true;
+
+      auto name = box->findChild<QLineEdit*>("name");
+      auto value = box->findChild<QLineEdit*>("value");
+      auto acceptReject = box->findChild<QDialogButtonBox*>();
+
+      name->setText("");
+      value->setText("");
+      acceptReject->button(QDialogButtonBox::Ok)->click();
+      QCOMPARE(catcher.count(), 1);
+
+      name->setText("KEPT_VARIABLE");
+      value->setText("");
+      acceptReject->button(QDialogButtonBox::Ok)->click();
+      QCOMPARE(catcher.count(), 2);
+
+      name->setText("ADDED_VARIABLE");
+      value->setText("Added variable");
+      acceptReject->button(QDialogButtonBox::Ok)->click();
+      QCOMPARE(catcher.count(), 2);
+    });
+    dialog.AddEntry->click();
+
+    QStringList expected{
+      "ADDED_VARIABLE=Added variable",
+      "CHANGED_VARIABLE=This will be changed",
+      "DELETED_VARIABLE_1=Deleted variable 1",
+      "DELETED_VARIABLE_2=Deleted variable 2",
+      "KEPT_VARIABLE=Kept variable",
+    };
+    QCOMPARE(dialog.environment().toStringList(), expected);
+    QCOMPARE(catcher.count(), 2);
+    QVERIFY(done);
+  }
+
+  {
+    CatchShow catcher2;
+    bool done = false;
+    catcher2.setCallback<QDialog>([&done](QDialog* box) {
+      if (done) {
+        return;
+      }
+      done = true;
+
+      auto name = box->findChild<QLineEdit*>("name");
+      auto value = box->findChild<QLineEdit*>("value");
+      auto acceptReject = box->findChild<QDialogButtonBox*>();
+
+      name->setText("DISCARDED_VARIABLE");
+      value->setText("Discarded variable");
+      acceptReject->button(QDialogButtonBox::Cancel)->click();
+    });
+    dialog.AddEntry->click();
+
+    QStringList expected{
+      "ADDED_VARIABLE=Added variable",
+      "CHANGED_VARIABLE=This will be changed",
+      "DELETED_VARIABLE_1=Deleted variable 1",
+      "DELETED_VARIABLE_2=Deleted variable 2",
+      "KEPT_VARIABLE=Kept variable",
+    };
+    QCOMPARE(dialog.environment().toStringList(), expected);
+    QCOMPARE(catcher.count(), 2);
+    QVERIFY(done);
+  }
+
+  {
+    auto* model = dialog.Environment->model();
+    auto* selectionModel = dialog.Environment->selectionModel();
+    for (int i = 0; i < model->rowCount(); ++i) {
+      auto index1 = model->index(i, 0);
+      auto index2 = model->buddy(index1);
+      auto name = model->data(index1, Qt::DisplayRole).toString();
+      if (name == "DELETED_VARIABLE_1" || name == "DELETED_VARIABLE_2") {
+        selectionModel->select(index1, QItemSelectionModel::Select);
+        selectionModel->select(index2, QItemSelectionModel::Select);
+      } else if (name == "CHANGED_VARIABLE") {
+        model->setData(index2, "Changed variable", Qt::DisplayRole);
+      }
+    }
+    dialog.RemoveEntry->click();
+
+    QStringList expected{
+      "ADDED_VARIABLE=Added variable",
+      "CHANGED_VARIABLE=Changed variable",
+      "KEPT_VARIABLE=Kept variable",
+    };
+    QCOMPARE(dialog.environment().toStringList(), expected);
+  }
+}
+
+QTEST_MAIN(EnvironmentDialogTest)
diff --git a/Tests/CMakeGUI/EnvironmentDialogTest.h b/Tests/CMakeGUI/EnvironmentDialogTest.h
new file mode 100644
index 0000000..bcba2c5
--- /dev/null
+++ b/Tests/CMakeGUI/EnvironmentDialogTest.h
@@ -0,0 +1,15 @@
+/* Distributed under the OSI-approved BSD 3-Clause License.  See accompanying
+   file Copyright.txt or https://cmake.org/licensing for details.  */
+#pragma once
+
+#include <QObject>
+
+class EnvironmentDialogTest : public QObject
+{
+  Q_OBJECT
+public:
+  EnvironmentDialogTest(QObject* parent = nullptr);
+
+private slots:
+  void environmentDialog();
+};
diff --git a/Tests/CMakeGUI/environment/CMakeLists.txt.in b/Tests/CMakeGUI/environment/CMakeLists.txt.in
new file mode 100644
index 0000000..1eeeb85
--- /dev/null
+++ b/Tests/CMakeGUI/environment/CMakeLists.txt.in
@@ -0,0 +1,18 @@
+cmake_minimum_required(VERSION 3.18)
+project(environment NONE)
+
+if(NOT "$ENV{KEPT_VARIABLE}" STREQUAL "Kept variable")
+  message(SEND_ERROR "KEPT_VARIABLE is \"$ENV{KEPT_VARIABLE}\", should be \"Kept variable\"")
+endif()
+
+if(NOT "$ENV{ADDED_VARIABLE}" STREQUAL "Added variable")
+  message(SEND_ERROR "ADDED_VARIABLE is \"$ENV{ADDED_VARIABLE}\", should be \"Added variable\"")
+endif()
+
+if(NOT "$ENV{CHANGED_VARIABLE}" STREQUAL "Changed variable")
+  message(SEND_ERROR "CHANGED_VARIABLE is \"$ENV{CHANGED_VARIABLE}\", should be \"Changed variable\"")
+endif()
+
+if(DEFINED ENV{REMOVED_VARIABLE})
+  message(SEND_ERROR "REMOVED_VARIABLE should not be defined")
+endif()