software/theia: Test shell/supervisord environment

Add a test to check that the PATH is the same for the interactive shell
and the supervisord services. This is important because slapos commands
like 'slapos node software' may behave differently in the shell and the
as supervisord services otherwise - each undoing what the other builds.

software/theia/test/dummy/README.md

+# Dummy Software
+
+A very simple SR that dumps the environment in JSON format during installation.

software/theia/test/dummy/software.cfg

+[buildout]
+
+newest = false
+
+versions = versions
+
+parts =
+  log-env
+
+[log-env]
+recipe = slapos.recipe.build
+init =
+  import json
+  import os
+  with open("${buildout:directory}/../env.json", 'w') as f:
+    json.dump(dict(os.environ), f)
+
+[versions]
+slapos.recipe.build = 0.46

software/theia/test/test.py

@@ -33,6 +33,7 @@ import subprocess
 import tempfile
 import time
 import re
+import json
 from six.moves.urllib.parse import urlparse, urljoin
 
 import pexpect
@@ -237,3 +238,77 @@ class TestTheiaWithSR(TheiaTestCase):
 
     self.assertIsNotNone(re.search(r"%s\s+slaprunner\s+available" % (self.sr_url,), info), info)
     self.assertIsNotNone(re.search(r"%s\s+%s\s+%s" % (self.sr_url, self.sr_type, instance_name), info), info)
+
+
+class TestTheiaEnv(TheiaTestCase):
+  dummy_software_path = os.path.abspath('dummy/software.cfg')
+
+  @classmethod
+  def getInstanceParameterDict(cls):
+    return {
+      'embedded-sr': cls.dummy_software_path,
+      'autorun': 'stopped',
+    }
+
+  def test_theia_env(self):
+    # The path of the env.json file expected to be generated by building the dummy software release
+    env_json_path = os.path.join(self.computer_partition_root_path, 'srv', 'runner', 'software', 'env.json')
+
+    # Get the pid of the theia process from the test node's instance-supervisord
+    with self.slap.instance_supervisor_rpc as supervisor:
+      all_process_info = supervisor.getAllProcessInfo()
+      for p in all_process_info:
+        if p['name'].startswith('theia-instance'):
+          theia_process = p
+          break
+      else:
+        self.fail("Could not find theia process")
+    theia_pid = theia_process['pid']
+
+    # Get the environment of the theia process
+    theia_env = psutil.Process(theia_pid).environ()
+
+    # Start a theia shell that inherits the environment of the theia process
+    # This simulates the environment of a shell launched from the browser application
+    theia_shell_process = pexpect.spawnu('{}/bin/theia-shell'.format(self.computer_partition_root_path), env=theia_env)
+    theia_shell_process.expect_exact('Standalone SlapOS for computer `slaprunner` activated')
+
+    # Launch slapos node software from theia shell
+    theia_shell_process.sendline('slapos node software')
+    theia_shell_process.expect('Installing software release %s' % self.dummy_software_path)
+    theia_shell_process.expect('Finished software releases.')
+
+    # Get the theia shell environment
+    with open(env_json_path) as f:
+      theia_shell_env = json.load(f)
+
+    # Remove the env.json file to later be sure that a new one has been generated
+    os.remove(env_json_path)
+
+    # Launch slapos-node-software from the embedded supervisord
+    embedded_run_path = os.path.join(self.computer_partition_root_path, 'srv', 'runner', 'var', 'run')
+    embedded_supervisord_socket_path = _getSupervisordSocketPath(embedded_run_path, self.logger)
+    with getSupervisorRPC(embedded_supervisord_socket_path) as embedded_supervisor:
+      previous_stop_time = embedded_supervisor.getProcessInfo('slapos-node-software')['stop']
+      embedded_supervisor.startProcess('slapos-node-software')
+      for _retries in range(20):
+        time.sleep(1)
+        if embedded_supervisor.getProcessInfo('slapos-node-software')['stop'] != previous_stop_time:
+          break
+      else:
+        self.fail("the supervisord service 'slapos-node-software' takes too long to finish")
+
+    # Get the supervisord environment
+    with open(env_json_path) as f:
+      supervisord_env = json.load(f)
+
+    # Compare relevant variables from both environments
+    self.maxDiff = None
+    self.assertEqual(theia_shell_env['PATH'].split(':'), supervisord_env['PATH'].split(':'))
+    self.assertEqual(theia_shell_env['SLAPOS_CONFIGURATION'], supervisord_env['SLAPOS_CONFIGURATION'])
+    self.assertEqual(theia_shell_env['SLAPOS_CLIENT_CONFIGURATION'], supervisord_env['SLAPOS_CLIENT_CONFIGURATION'])
+    self.assertEqual(theia_shell_env['HOME'], supervisord_env['HOME'])
+
+    # Cleanup the theia shell process
+    theia_shell_process.terminate()
+    theia_shell_process.wait()