Add cleanup/finalization tests

Introduce tests to verify proper cleanup and finalization across different
scenarios.

Backport notes:
- Adapted to include `PythonQt_QtAll.h` and call `PythonQt_QtAll::init()`
  instead of `PythonQt_QtBindings.h` and `PythonQt_init_QtBindings()`,
  which are specific to the commontk fork.
- Replaced NULL with nullptr and remove unused `PythonQt.h` include
  from `PythonQtTestCleanup.h`.

(cherry picked from commit commontk/PythonQt@4ad7e74)

Co-authored-by: Jean-Christophe Fillion-Robin <jchris.fillionr@kitware.com>
Co-authored-by: Pat Marion <james.patrick.marion@gmail.com>

Author: msmolens

tests/PythonQtTestCleanup.cpp

@@ -0,0 +1,69 @@
+#include "PythonQtTestCleanup.h"
+#include "PythonQt.h"
+#include "PythonQt_QtAll.h"
+
+void PythonQtTestCleanup::initTestCase()
+{
+}
+
+void PythonQtTestCleanup::cleanupTestCase()
+{
+}
+
+void PythonQtTestCleanup::init()
+{
+  // Initialize before each test
+
+  PythonQt::init(PythonQt::IgnoreSiteModule);
+  PythonQt_QtAll::init();
+
+  _helper = new PythonQtTestCleanupHelper();
+  PythonQtObjectPtr main = PythonQt::self()->getMainModule();
+  PythonQt::self()->addObject(main, "obj", _helper);
+}
+
+void PythonQtTestCleanup::cleanup()
+{
+  // Finalize and cleanup after each test
+
+  PythonQtObjectPtr main = PythonQt::self()->getMainModule();
+  PythonQt::self()->removeVariable(main, "obj");
+  delete _helper;
+  _helper = nullptr;
+
+  if (Py_IsInitialized()) {
+    Py_Finalize();
+  }
+
+  PythonQt::cleanup();
+}
+
+void PythonQtTestCleanup::testQtEnum()
+{
+  QVERIFY(_helper->runScript(
+    "import PythonQt.QtCore\n" \
+    "x = PythonQt.QtCore.QFile.ReadOnly\n" \
+    "obj.setPassed()"
+    ));
+}
+
+void PythonQtTestCleanup::testCallQtMethodInDel()
+{
+  QVERIFY(_helper->runScript(
+    "import PythonQt.QtCore\n" \
+    "class TimerWrapper(object):\n" \
+    "  def __init__(self):\n" \
+    "    self.timer = PythonQt.QtCore.QTimer()\n" \
+    "  def __del__(self):\n" \
+    "    self.timer.setSingleShot(True)\n" \
+    "x = TimerWrapper()\n" \
+    "obj.setPassed()\n"
+    ));
+}
+
+bool PythonQtTestCleanupHelper::runScript(const char* script)
+{
+  _passed = false;
+  PyRun_SimpleString(script);
+  return _passed;
+}

tests/PythonQtTestCleanup.h

@@ -0,0 +1,44 @@
+#ifndef _PYTHONQTTESTCLEANUP_H
+#define _PYTHONQTTESTCLEANUP_H
+
+#include <QtTest/QtTest>
+
+class PythonQtTestCleanupHelper;
+
+//! Test PythonQt cleanup and Python interpreter finalization
+class PythonQtTestCleanup : public QObject
+{
+  Q_OBJECT
+
+private Q_SLOTS:
+  void initTestCase();
+  void cleanupTestCase();
+  void init();
+  void cleanup();
+
+  void testQtEnum();
+  void testCallQtMethodInDel();
+
+private:
+  PythonQtTestCleanupHelper* _helper;
+};
+
+//! Test helper class
+class PythonQtTestCleanupHelper : public QObject
+{
+  Q_OBJECT
+public:
+  PythonQtTestCleanupHelper() :
+    _passed(false) {
+  };
+
+  bool runScript(const char* script);
+
+public Q_SLOTS:
+  void setPassed() { _passed = true; }
+
+private:
+  bool _passed;
+};
+
+#endif

tests/PythonQtTestMain.cpp

@@ -41,6 +41,7 @@
 
 #include "PythonQt.h"
 #include "PythonQtTests.h"
+#include "PythonQtTestCleanup.h"
 
 #include <QApplication>
 
@@ -65,6 +66,13 @@ int main( int argc, char **argv )
 
   PythonQt::cleanup();
 
+  if (Py_IsInitialized()) {
+    Py_Finalize();
+  }
+
+  PythonQtTestCleanup cleanup;
+  failCount += QTest::qExec(&cleanup, argc, argv);
+
   if (failCount) {
     std::cerr << "Tests failed: " << failCount << std::endl;
   } else {

tests/tests.pro

@@ -23,10 +23,13 @@ QT += widgets
 
 include ( ../build/common.prf )
 include ( ../build/PythonQt.prf )
+include ( ../build/PythonQt_QtAll.prf )
 
 HEADERS +=                    \
+  PythonQtTestCleanup.h       \
   PythonQtTests.h
 
 SOURCES +=                    \
+  PythonQtTestCleanup.cpp     \
   PythonQtTestMain.cpp        \
   PythonQtTests.cpp