Add tests for calling OpenModelica via ZMQ

We now create a process group so we can kill OMC properly including all
child processes. This makes the tests run more stable.

Author: sjoelund

Jenkinsfile

@@ -1,32 +1,46 @@
 pipeline {
-  agent any
+  agent {
+    docker {
+      // Large image with full OpenModelica build dependencies; lacks omc and OMPython
+      image 'openmodelica/build-deps'
+    }
+  }
   stages {
+    stage('setup') {
+      steps {
+        sh '''
+# Install the omc package; should only take a few seconds
+apt-get update
+apt-get install -qy gnupg wget ca-certificates apt-transport-https sudo
+echo "deb https://build.openmodelica.org/apt `lsb_release -sc`  release" > /etc/apt/sources.list.d/openmodelica.list
+wget https://build.openmodelica.org/apt/openmodelica.asc -O- | apt-key add -
+apt-get update
+apt-get install -qy --no-install-recommends omc
+'''
+      }
+    }
     stage('build') {
       parallel {
         stage('python2') {
-          agent {
-            docker {
-              image 'python:2'
-            }
-          }
           steps {
-            sh 'cat /etc/resolv.conf'
-            sh 'python2 setup.py build'
-            sh 'python2 setup.py test'
-            sh 'python2 setup.py install'
+            timeout(1) {
+              // OpenModelica does not like running as root
+              sh 'chown -R nobody .'
+              sh 'sudo -u nobody python2 setup.py build'
+              sh 'sudo -u nobody python2 setup.py test'
+              sh 'python2 setup.py install'
+            }
           }
         }
         stage('python3') {
-          agent {
-            docker {
-              image 'python:3'
-            }
-          }
           steps {
-            sh 'cat /etc/resolv.conf'
-            sh 'python3 setup.py build'
-            sh 'python3 setup.py test'
-            sh 'python3 setup.py install'
+            timeout(1) {
+              // OpenModelica does not like running as root
+              sh 'chown -R nobody .'
+              sh 'sudo -u nobody python3 setup.py build'
+              sh 'sudo -u nobody python3 setup.py test'
+              sh 'python3 setup.py install'
+            }
           }
         }
       }

OMPython/__init__.py

@@ -41,6 +41,7 @@ class which means it will use OMCSessionZMQ by default. If you want to use
 import logging
 import os
 import platform
+import signal
 import subprocess
 import sys
 import tempfile
@@ -120,11 +121,28 @@ def __init__(self, readonly=False):
         self._omc_log_file = None
 
     def __del__(self):
-        self.sendExpression("quit()")
+        try:
+          self.sendExpression("quit()")
+        except:
+          pass
         self._omc_log_file.close()
+        if sys.version_info.major >= 3:
+          self._omc_process.wait(timeout=1.0)
+        else:
+          for i in range(0,100):
+            time.sleep(0.01)
+            if self._omc_process.poll() is not None:
+              break
         # kill self._omc_process process if it is still running/exists
         if self._omc_process.returncode is None:
-            self._omc_process.kill()
+            print("OMC did not exit after being sent the quit() command; killing the process with pid=%s" % str(self._omc_process.pid))
+            if sys.platform=="win32":
+                self._omc_process.kill()
+                self._omc_process.wait()
+            else:
+                os.killpg(os.getpgid(self._omc_process.pid), signal.SIGTERM)
+                self._omc_process.kill()
+                self._omc_process.wait()
 
     def _create_omc_log_file(self, suffix):
         if sys.platform == 'win32':
@@ -143,7 +161,8 @@ def _start_omc_process(self):
             my_env["PATH"] = omhome_bin + os.pathsep + my_env["PATH"]
             self._omc_process = subprocess.Popen(self._omc_command, shell=True, stdout=self._omc_log_file, stderr=self._omc_log_file, env=my_env)
         else:
-            self._omc_process = subprocess.Popen(self._omc_command, shell=True, stdout=self._omc_log_file, stderr=self._omc_log_file)
+            # Because we spawned a shell, and we need to be able to kill OMC, create a new process group for this
+            self._omc_process = subprocess.Popen(self._omc_command, shell=True, stdout=self._omc_log_file, stderr=self._omc_log_file, preexec_fn=os.setsid)
         return self._omc_process
 
     def _set_omc_command(self, omc_path, args):
@@ -513,24 +532,21 @@ def _connect_to_omc(self, timeout):
         self._port_file = os.path.join(self._temp_dir, self._port_file).replace("\\", "/")
         self._omc_zeromq_uri = "file:///" + self._port_file
         # See if the omc server is running
-        if os.path.isfile(self._port_file):
-            logger.info("OMC Server is up and running at {0}".format(self._omc_zeromq_uri))
-        else:
-            attempts = 0
-            while True:
-                if not os.path.isfile(self._port_file):
-                    time.sleep(timeout)
-                    attempts += 1
-                    if attempts == 10:
-                        name = self._omc_log_file.name
-                        self._omc_log_file.close()
-                        logger.error("OMC Server is down. Please start it! Log-file says:\n%s" % open(name).read())
-                        raise Exception
-                    else:
-                        continue
+        attempts = 0
+        while True:
+            if not os.path.isfile(self._port_file):
+                time.sleep(timeout)
+                attempts += 1
+                if attempts == 10:
+                    name = self._omc_log_file.name
+                    self._omc_log_file.close()
+                    logger.error("OMC Server is down. Please start it! Log-file says:\n%s" % open(name).read())
+                    raise Exception("OMC Server is down. Could not open file %s" % self._port_file)
                 else:
-                    logger.info("OMC Server is up and running at {0}".format(self._omc_zeromq_uri))
-                    break
+                    continue
+            else:
+                logger.info("OMC Server is up and running at {0} pid={1}".format(self._omc_zeromq_uri, self._omc_process.pid))
+                break
 
         # Read the port file
         with open(self._port_file, 'r') as f_p:

tests/__init__.py

@@ -1 +1 @@
-__all__ = ['tests.test_OMParser']
+__all__ = ['tests.test_OMParser', 'tests.test_ZMQ']

tests/test_ZMQ.py

@@ -0,0 +1,37 @@
+import OMPython
+import unittest
+import tempfile, shutil, os
+
+class ZMQTester(unittest.TestCase):
+  def __init__(self, *args, **kwargs):
+    super(ZMQTester, self).__init__(*args, **kwargs)
+    self.simpleModel = """model M
+  Real r = time;
+end M;"""
+    self.tmp = tempfile.mkdtemp(prefix='tmpOMPython.tests')
+    self.origDir = os.getcwd()
+    os.chdir(self.tmp)
+    self.om = OMPython.OMCSessionZMQ()
+    os.chdir(self.origDir)
+  def __del__(self):
+    shutil.rmtree(self.tmp, ignore_errors=True)
+    del(self.om)
+  def clean(self):
+    del(self.om)
+    self.om = None
+
+  def testHelloWorld(self):
+    self.assertEqual("HelloWorld!", self.om.sendExpression('"HelloWorld!"'))
+    self.clean()
+  def testTranslate(self):
+    self.assertEqual(("M",), self.om.sendExpression(self.simpleModel))
+    self.assertEqual(True, self.om.sendExpression('translateModel(M)'))
+    self.clean()
+  def testSimulate(self):
+    self.assertEqual(True, self.om.sendExpression('loadString("%s")' % self.simpleModel))
+    self.om.sendExpression('res:=simulate(M, stopTime=2.0)')
+    self.assertNotEqual("", self.om.sendExpression('res.resultFile'))
+    self.clean()
+
+if __name__ == '__main__':
+    unittest.main()