Add cleanup/finalization tests

Add tests that check for clean cleanup and finalization in different scenarios.

Co-authored-by: Jean-Christophe Fillion-Robin <[email protected]>
Co-authored-by: Pat Marion <[email protected]>

Author: 3 people

CMakeLists.txt

@@ -279,6 +279,18 @@ if(BUILD_TESTING)
     tests/PythonQtTests.h
     )
 
+  if(PythonQt_Wrap_Qtcore)
+    include_directories(generated_cpp${generated_cpp_suffix})
+
+    list(APPEND test_sources
+      tests/PythonQtTestCleanup.cpp
+      tests/PythonQtTestCleanup.h
+      )
+    QT4_WRAP_CPP(test_sources
+      tests/PythonQtTestCleanup.h
+      )
+  endif()
+
   set_property(SOURCE tests/PythonQtTestMain.cpp PROPERTY COMPILE_DEFINITIONS "main=tests_PythonQtTestMain")
 
   add_executable(PythonQtCppTests ${test_sources})

tests/PythonQtTestCleanup.cpp

@@ -0,0 +1,69 @@
+#include "PythonQtTestCleanup.h"
+#include "PythonQt.h"
+#include "PythonQt_QtBindings.h"
+
+void PythonQtTestCleanup::initTestCase()
+{
+}
+
+void PythonQtTestCleanup::cleanupTestCase()
+{
+}
+
+void PythonQtTestCleanup::init()
+{
+  // Initialize before each test
+
+  PythonQt::init(PythonQt::IgnoreSiteModule);
+  PythonQt_init_QtBindings();
+
+  _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 = NULL;
+
+  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,45 @@
+#ifndef _PYTHONQTTESTCLEANUP_H
+#define _PYTHONQTTESTCLEANUP_H
+
+#include "PythonQt.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>
 
@@ -60,6 +61,13 @@ int main(int argc, char *argv[])
 
   PythonQt::cleanup();
 
+  if (Py_IsInitialized()) {
+    Py_Finalize();
+  }
+
+  PythonQtTestCleanup cleanup;
+  failCount += QTest::qExec(&cleanup, argc, argv);
+
   if (failCount>0) {
     std::cerr << "Tests failed: " << failCount << std::endl;
   } else {