Skip to content

Commit

Permalink
Move tool shed specific driver function to tool_shed.test
Browse files Browse the repository at this point in the history
Should fix #18282
  • Loading branch information
mvdbeek committed May 31, 2024
1 parent 8dd7a9e commit a8ac6fd
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 27 deletions.
24 changes: 0 additions & 24 deletions lib/galaxy_test/driver/driver_util.py
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,6 @@
DEFAULT_WEB_HOST,
target_url_parts,
)
from tool_shed.webapp.app import UniverseApplication as ToolshedUniverseApplication
from tool_shed.webapp.fast_app import initialize_fast_app as init_tool_shed_fast_app
from .test_logging import logging_config_file

galaxy_root = galaxy_directory()
Expand Down Expand Up @@ -583,26 +581,6 @@ def build_galaxy_app(simple_kwargs) -> GalaxyUniverseApplication:
return app


def build_shed_app(simple_kwargs):
"""Build a Galaxy app object from a simple keyword arguments.
Construct paste style complex dictionary. Also setup "global" reference
to sqlalchemy database context for tool shed database.
"""
log.info("Tool shed database connection: %s", simple_kwargs["database_connection"])
# TODO: Simplify global_conf to match Galaxy above...
simple_kwargs["__file__"] = "tool_shed_wsgi.yml.sample"
simple_kwargs["global_conf"] = get_webapp_global_conf()

app = ToolshedUniverseApplication(**simple_kwargs)
log.info("Embedded Toolshed application started")

global tool_shed_context
tool_shed_context = app.model.context

return app


def explicitly_configured_host_and_port(prefix, config_object):
host_env_key = f"{prefix}_TEST_HOST"
port_env_key = f"{prefix}_TEST_PORT"
Expand Down Expand Up @@ -794,8 +772,6 @@ def launch_server(app_factory, webapp_factory, prefix=DEFAULT_CONFIG_PREFIX, gal
)
if name == "galaxy":
asgi_app = init_galaxy_fast_app(wsgi_webapp, app)
elif name == "tool_shed":
asgi_app = init_tool_shed_fast_app(wsgi_webapp, app)
else:
raise NotImplementedError(f"Launching {name} not implemented")

Expand Down
49 changes: 46 additions & 3 deletions lib/tool_shed/test/base/driver.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@
from galaxy_test.driver import driver_util
from tool_shed.test.base.api_util import get_admin_api_key
from tool_shed.webapp import buildapp as toolshedbuildapp
from tool_shed.webapp.app import UniverseApplication as ToolshedUniverseApplication
from tool_shed.webapp.fast_app import initialize_fast_app as init_tool_shed_fast_app

log = driver_util.build_logger()

Expand Down Expand Up @@ -38,6 +40,48 @@
"""


def build_shed_app(simple_kwargs):
"""Build a Galaxy app object from a simple keyword arguments.
Construct paste style complex dictionary. Also setup "global" reference
to sqlalchemy database context for tool shed database.
"""
log.info("Tool shed database connection: %s", simple_kwargs["database_connection"])
# TODO: Simplify global_conf to match Galaxy above...
simple_kwargs["__file__"] = "tool_shed_wsgi.yml.sample"
simple_kwargs["global_conf"] = driver_util.get_webapp_global_conf()

app = ToolshedUniverseApplication(**simple_kwargs)
log.info("Embedded Toolshed application started")

global tool_shed_context
tool_shed_context = app.model.context

return app


def launch_shed_server(app_factory, webapp_factory, prefix="TOOL_SHED", galaxy_config=None, config_object=None):
name = prefix.lower()
host, port = driver_util.explicitly_configured_host_and_port(prefix, config_object)
port = driver_util.attempt_ports(port)

app = app_factory()
url_prefix = getattr(app.config, f"{name}_url_prefix", "/")
wsgi_webapp = webapp_factory(
galaxy_config["global_conf"],
app=app,
use_translogger=False,
static_enabled=True,
register_shutdown_at_exit=False,
)
asgi_app = init_tool_shed_fast_app(wsgi_webapp, app)

server, port, thread = driver_util.uvicorn_serve(asgi_app, host=host, port=port)
driver_util.set_and_wait_for_http_target(prefix, host, port, url_prefix=url_prefix)
log.debug(f"Embedded uvicorn web server for {name} started at {host}:{port}{url_prefix}")
return driver_util.EmbeddedServerWrapper(app, server, name, host, port, thread=thread, prefix=url_prefix)


class ToolShedTestDriver(driver_util.TestDriver):
"""Instantiate a Galaxy-style TestDriver for testing the tool shed."""

Expand Down Expand Up @@ -116,11 +160,10 @@ def _setup_local(self):
os.environ["TOOL_SHED_TEST_TOOL_DATA_TABLE_CONF"] = shed_tool_data_table_conf_file
# ---- Run tool shed webserver ------------------------------------------------------
# TODO: Needed for hg middleware ('lib/galaxy/webapps/tool_shed/framework/middleware/hg.py')
tool_shed_server_wrapper = driver_util.launch_server(
app_factory=lambda: driver_util.build_shed_app(kwargs),
tool_shed_server_wrapper = launch_shed_server(
app_factory=lambda: build_shed_app(kwargs),
webapp_factory=toolshedbuildapp.app_factory,
galaxy_config=kwargs,
prefix="TOOL_SHED",
)
self.server_wrappers.append(tool_shed_server_wrapper)
tool_shed_test_host = tool_shed_server_wrapper.host
Expand Down

0 comments on commit a8ac6fd

Please sign in to comment.