Basic coverage of migwsgi.

Author: albu-diku

mig/wsgi-bin/migwsgi.py

@@ -193,6 +193,13 @@ def application(environ, start_response):
     *start_response* is a helper function used to deliver the client response.
     """
 
+    def _set_os_environ(value):
+        os.environ = value
+
+    return _application(environ, start_response, _format_output=format_output, _set_environ=_set_os_environ, _wrap_wsgi_errors=wrap_wsgi_errors)
+
+def _application(environ, start_response, _format_output, _set_environ, _wrap_wsgi_errors=True, _config_file=None, _skip_log=False):
+
     # NOTE: pass app environ including apache and query args on to sub handlers
     #       through the usual 'os.environ' channel expected in functionality
     #       handlers. Special care is needed to avoid various sub-interpreter
@@ -235,18 +242,18 @@ def application(environ, start_response):
                                                              os_env_value))
 
     # Assign updated environ to LOCAL os.environ for the rest of this session
-    os.environ = environ
+    _set_environ(environ)
 
     # NOTE: redirect stdout to stderr in python 2 only. It breaks logger in 3
     #       and stdout redirection apparently is already handled there.
     if sys.version_info[0] < 3:
         sys.stdout = sys.stderr
 
-    configuration = get_configuration_object()
+    configuration = get_configuration_object(_config_file, _skip_log)
     _logger = configuration.logger
 
     # NOTE: replace default wsgi errors to apache error log with our own logs
-    wrap_wsgi_errors(environ, configuration)
+    _wrap_wsgi_errors(environ, configuration)
 
     for line in env_sync_status:
         _logger.debug(line)
@@ -363,7 +370,7 @@ def application(environ, start_response):
     output_objs.append(wsgi_entry)
 
     _logger.debug("call format %r output to %s" % (backend, output_format))
-    output = format_output(configuration, backend, ret_code, ret_msg,
+    output = _format_output(configuration, backend, ret_code, ret_msg,
                            output_objs, output_format)
     # _logger.debug("formatted %s output to %s" % (backend, output_format))
     # _logger.debug("output:\n%s" % [output])
@@ -396,7 +403,14 @@ def application(environ, start_response):
     # NOTE: send response to client but don't crash e.g. on closed connection
     try:
         start_response(status, response_headers)
+    except IOError as ioe:
+        _logger.warning("WSGI %s for %s could not deliver output: %s" %
+                        (backend, client_id, ioe))
+    except Exception as exc:
+        _logger.error("WSGI %s for %s crashed during response: %s" %
+                      (backend, client_id, exc))
 
+    try:
         # NOTE: we consistently hit download error for archive files reaching ~2GB
         #       with showfreezefile.py on wsgi but the same on cgi does NOT suffer
         #       the problem for the exact same files. It seems wsgi has a limited
@@ -410,7 +424,7 @@ def application(environ, start_response):
             _logger.info("WSGI %s yielding %d output parts (%db)" %
                          (backend, chunk_parts, content_length))
         # _logger.debug("send chunked %r response to client" % backend)
-        for i in xrange(chunk_parts):
+        for i in list(range(chunk_parts)):
             # _logger.debug("WSGI %s yielding part %d / %d output parts" %
             #              (backend, i+1, chunk_parts))
             # end index may be after end of content - but no problem

tests/test_mig_wsgi-bin_migwsgi.py

@@ -0,0 +1,139 @@
+# -*- coding: utf-8 -*-
+#
+# --- BEGIN_HEADER ---
+#
+# Copyright (C) 2003-2024  The MiG Project by the Science HPC Center at UCPH
+#
+# This file is part of MiG.
+#
+# MiG is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# MiG is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
+# USA.
+#
+# --- END_HEADER ---
+#
+
+"""Unit tests for the MiG WSGI glue"""
+
+from configparser import ConfigParser
+import importlib
+import os
+import stat
+import sys
+
+from tests.support import MIG_BASE, MigTestCase, testmain
+
+
+def create_output_returner(arranged=None):
+    def test_format_output(*args):
+        return arranged
+    return test_format_output
+
+def create_wsgi_environ(config_file, env_http_host=None, env_path_info=None):
+    environ = {}
+    environ['MIG_CONF'] = config_file
+    environ['HTTP_HOST'] = env_http_host
+    environ['PATH_INFO'] = env_path_info
+    environ['SCRIPT_URI'] = ''.join(('http://', environ['HTTP_HOST'], environ['PATH_INFO']))
+    return environ
+
+
+def noop(*args):
+    pass
+
+
+from tests.support import PY2, is_path_within
+from mig.shared.base import client_id_dir, client_dir_id, get_short_id, \
+    invisible_path, allow_script, brief_list
+
+
+_LOCAL_MIG_BASE = '/usr/src/app' if PY2 else MIG_BASE # account for execution in container
+_PYTHON_MAJOR = '2' if PY2 else '3'
+_TEST_CONF_DIR = os.path.join(MIG_BASE, "envhelp/output/testconfs-py%s" % (_PYTHON_MAJOR,))
+_TEST_CONF_FILE = os.path.join(_TEST_CONF_DIR, "MiGserver.conf")
+_TEST_CONF_SYMLINK = os.path.join(MIG_BASE, "envhelp/output/testconfs")
+
+
+def _assert_local_config():
+    try:
+        link_stat = os.lstat(_TEST_CONF_SYMLINK)
+        assert stat.S_ISLNK(link_stat.st_mode)
+        configdir_stat = os.stat(_TEST_CONF_DIR)
+        assert stat.S_ISDIR(configdir_stat.st_mode)
+        config = ConfigParser()
+        config.read([_TEST_CONF_FILE])
+        return config
+    except Exception as exc:
+        raise AssertionError('local configuration invalid or missing: %s' % (str(exc),))
+
+
+def _assert_local_config_global_values(config):
+    config_global_values = dict(config.items('GLOBAL'))
+
+    for path in ('mig_path', 'certs_path', 'state_path'):
+        path_value = config_global_values.get(path)
+        if not is_path_within(path_value, start=_LOCAL_MIG_BASE):
+            raise AssertionError('local config contains bad path: %s=%s' % (path, path_value))
+
+    return config_global_values
+
+
+_WSGI_BIN = os.path.join(MIG_BASE, 'mig/wsgi-bin')
+
+def _import_migwsgi():
+    sys.path.append(_WSGI_BIN)
+    migwsgi = importlib.import_module('migwsgi')
+    sys.path.pop(-1)
+    return migwsgi
+
+
+migwsgi = _import_migwsgi()
+
+
+class MigSharedConfiguration(MigTestCase):
+    def test_xxx(self):
+        config = _assert_local_config()
+        config_global_values = _assert_local_config_global_values(config)
+
+        def fake_start_response(status, headers, exc=None):
+            fake_start_response.calls.append((status, headers, exc))
+        fake_start_response.calls = []
+
+        def fake_set_environ(value):
+            fake_set_environ.value = value
+        fake_set_environ.value = None
+
+        wsgi_environ = create_wsgi_environ(
+            _TEST_CONF_FILE,
+            env_http_host='localhost',
+            env_path_info='/'
+        )
+
+        test_output_returner = create_output_returner(b'')
+
+        yielder = migwsgi._application(wsgi_environ, fake_start_response,
+            _format_output=test_output_returner,
+            _set_environ=fake_set_environ,
+            _wrap_wsgi_errors=noop,
+            _config_file=_TEST_CONF_FILE,
+            _skip_log=True,
+        )
+        chunks = list(yielder)
+
+        self.assertGreater(len(chunks), 0)
+
+
+
+if __name__ == '__main__':
+    testmain()