parent
7d9ceac239
commit
e6c37c49f9
@ -0,0 +1,41 @@ |
||||
"""Webapp handlers for testing porpoises.""" |
||||
|
||||
import inspect |
||||
|
||||
from flask import request, jsonify, abort |
||||
|
||||
from vasl_templates.webapp import app |
||||
from vasl_templates.webapp.tests.remote import ControlTests |
||||
|
||||
# --------------------------------------------------------------------- |
||||
|
||||
@app.route( "/control-tests/<action>" ) |
||||
def control_tests( action ): |
||||
"""Accept commands from a remote test suite.""" |
||||
|
||||
# check if this functionality has been enabled |
||||
if not app.config.get( "ENABLE_REMOTE_TEST_CONTROL" ): |
||||
abort( 404 ) |
||||
|
||||
# figure out what we're being asked to do |
||||
controller = ControlTests( app ) |
||||
func = getattr( controller, action ) |
||||
if not func: |
||||
abort( 404 ) |
||||
|
||||
# get any parameters |
||||
sig = inspect.signature( func ) |
||||
kwargs = {} |
||||
for param in sig.parameters.values(): |
||||
if param.name in ("vengine","vmod","gpids","ddtype","fname","dname"): |
||||
kwargs[ param.name ] = request.args.get( param.name, param.default ) |
||||
|
||||
# execute the command |
||||
resp = func( **kwargs ) |
||||
|
||||
# return any response |
||||
if isinstance( resp, (str,list,dict) ): |
||||
return jsonify( resp ) |
||||
else: |
||||
assert resp == controller, "Methods should return self if there is no response data." |
||||
return "ok" |
||||
@ -0,0 +1,168 @@ |
||||
"""Allow a remote server to be controlled during tests. |
||||
|
||||
We sometimes make changes to the webapp server during tests, and while we used to do that using pytest's monkeypatch, |
||||
that will not work if we are talking to a remote (i.e. in another process) server. This module defines the things |
||||
that can be changed during the course of tests, and a simple RPC mechanism that lets them be executed remotely. |
||||
It needs to be enabled in the server via the ENABLE_REMOTE_TEST_CONTROL debug switch. |
||||
""" |
||||
|
||||
import os |
||||
import urllib.request |
||||
import json |
||||
import glob |
||||
import logging |
||||
import random |
||||
|
||||
import pytest |
||||
|
||||
from vasl_templates.webapp import app |
||||
from vasl_templates.webapp.config.constants import DATA_DIR |
||||
from vasl_templates.webapp import main as webapp_main |
||||
from vasl_templates.webapp import snippets as webapp_snippets |
||||
from vasl_templates.webapp import files as webapp_files |
||||
from vasl_templates.webapp.file_server import utils as webapp_file_server_utils |
||||
from vasl_templates.webapp.file_server.vasl_mod import VaslMod |
||||
|
||||
_logger = logging.getLogger( "control_tests" ) |
||||
|
||||
# --------------------------------------------------------------------- |
||||
|
||||
class ControlTests: |
||||
"""Control a remote server during tests.""" |
||||
|
||||
def __init__( self, webapp ): |
||||
self.webapp = webapp |
||||
try: |
||||
self.server_url = pytest.config.option.server_url #pylint: disable=no-member |
||||
except AttributeError: |
||||
self.server_url = None |
||||
|
||||
def __getattr__( self, name ): |
||||
"""Generic entry point for handling control requests.""" |
||||
if name.startswith( ("get_","set_") ): |
||||
# check if we are talking to a local or remote server |
||||
if self.server_url: |
||||
# remote: return a function that will invoke the handler function on the remote server |
||||
def call_remote( **kwargs ): #pylint: disable=missing-docstring |
||||
return self._remote_test_control( name, **kwargs ) |
||||
return call_remote |
||||
else: |
||||
# local: return the actual handler function |
||||
return getattr( self, "_"+name ) |
||||
raise AttributeError( name ) |
||||
|
||||
def _remote_test_control( self, action, **kwargs ): |
||||
"""Invoke a handler function on the remote server.""" |
||||
resp = urllib.request.urlopen( |
||||
self.webapp.url_for( "control_tests", action=action, **kwargs ) |
||||
).read() |
||||
if resp == b"ok": |
||||
return self |
||||
else: |
||||
return json.loads( resp.decode( "utf-8" ) ) |
||||
|
||||
def _set_data_dir( self, ddtype=None ): |
||||
"""Set the webapp's data directory.""" |
||||
if ddtype == "real": |
||||
dname = DATA_DIR |
||||
elif ddtype == "test": |
||||
dname = os.path.join( os.path.split(__file__)[0], "fixtures/data" ) |
||||
else: |
||||
raise RuntimeError( "Unknown data dir type: {}".format( ddtype ) ) |
||||
_logger.info( "Setting data dir: %s", dname ) |
||||
self.webapp.config[ "DATA_DIR" ] = dname |
||||
return self |
||||
|
||||
def _set_default_scenario( self, fname=None ): |
||||
"""Set the default scenario.""" |
||||
if fname: |
||||
dname = os.path.join( os.path.split(__file__)[0], "fixtures" ) |
||||
fname = os.path.join( dname, fname ) |
||||
_logger.info( "Setting default scenario: %s", fname ) |
||||
webapp_main.default_scenario = fname |
||||
return self |
||||
|
||||
def _set_default_template_pack( self, dname=None ): |
||||
"""Set the default template pack.""" |
||||
if dname: |
||||
dname2 = os.path.join( os.path.split(__file__)[0], "fixtures" ) |
||||
dname = os.path.join( dname2, dname ) |
||||
_logger.info( "Setting default template pack: %s", dname ) |
||||
webapp_snippets.default_template_pack = dname |
||||
return self |
||||
|
||||
def _set_gpid_remappings( self, gpids=None ): #pylint: disable=no-self-use |
||||
"""Configure the GPID remappings.""" |
||||
if isinstance( gpids, str ): |
||||
gpids = json.loads( gpids.replace( "'", '"' ) ) |
||||
gpids = { int(k): v for k,v in gpids.items() } |
||||
_logger.info( "Setting GPID remappings: %s", gpids ) |
||||
prev_gpid_mappings = webapp_file_server_utils.GPID_REMAPPINGS |
||||
webapp_file_server_utils.GPID_REMAPPINGS = gpids |
||||
return prev_gpid_mappings |
||||
|
||||
def _get_vasl_mods( self ): |
||||
"""Return the available VASL modules.""" |
||||
fnames = self._do_get_vasl_mods() |
||||
_logger.debug( "Returning VASL modules:\n%s", |
||||
"\n".join( "- {}".format( f ) for f in fnames ) |
||||
) |
||||
return fnames |
||||
|
||||
def _do_get_vasl_mods( self ): #pylint: disable=no-self-use |
||||
"""Return the available VASL modules.""" |
||||
try: |
||||
dname = pytest.config.option.vasl_mods #pylint: disable=no-member |
||||
except AttributeError: |
||||
dname = app.config["TEST_VASL_MODS"] |
||||
fspec = os.path.join( dname, "*.vmod" ) |
||||
return glob.glob( fspec ) |
||||
|
||||
def _set_vasl_mod( self, vmod=None ): |
||||
"""Install a VASL module.""" |
||||
if vmod is None: |
||||
_logger.info( "Installing VASL module: %s", vmod ) |
||||
webapp_files.vasl_mod = None |
||||
else: |
||||
fnames = self._do_get_vasl_mods() |
||||
if vmod == "random": |
||||
# NOTE: Some tests require a VASL module to be loaded, and since they should all |
||||
# should behave in the same way, it doesn't matter which one we load. |
||||
fname = random.choice( fnames ) |
||||
else: |
||||
assert vmod in fnames |
||||
fname = vmod |
||||
_logger.info( "Installing VASL module: %s", fname ) |
||||
webapp_files.vasl_mod = VaslMod( fname, DATA_DIR ) |
||||
return self |
||||
|
||||
def _get_vassal_engines( self ): |
||||
"""Get the available VASSAL engines.""" |
||||
vassal_engines = self._do_get_vassal_engines() |
||||
_logger.debug( "Returning VASSAL engines:\n%s", |
||||
"\n".join( "- {}".format( ve ) for ve in vassal_engines ) |
||||
) |
||||
return vassal_engines |
||||
|
||||
def _do_get_vassal_engines( self ): #pylint: disable=no-self-use |
||||
"""Get the available VASSAL engines.""" |
||||
try: |
||||
dname = pytest.config.option.vassal #pylint: disable=no-member |
||||
except AttributeError: |
||||
dname = app.config[ "TEST_VASSAL_ENGINES"] |
||||
vassal_engines = [] |
||||
for root,_,fnames in os.walk( dname ): |
||||
for fname in fnames: |
||||
if fname == "Vengine.jar": |
||||
if root.endswith( "/lib" ): |
||||
root = root[:-4] |
||||
vassal_engines.append( root ) |
||||
return vassal_engines |
||||
|
||||
def _set_vassal_engine( self, vengine=None ): |
||||
"""Install a VASSAL engine.""" |
||||
if vengine: |
||||
assert vengine in self._do_get_vassal_engines() |
||||
_logger.info( "Installing VASSAL engine: %s", vengine ) |
||||
app.config["VASSAL_DIR"] = vengine |
||||
return self |
||||
Loading…
Reference in new issue