mirror of
https://github.com/galaxyproject/galaxy.git
synced 2026-11-22 23:10:20 +08:00
Migrates integration tests to use the modern upload activity helper instead of legacy upload methods. This standardizes how files, pasted content, and remote resources are staged in selenium tests, improving maintainability and reliability of the test suite.
104 lines
4.1 KiB
Python
104 lines
4.1 KiB
Python
import os
|
|
import shutil
|
|
import tempfile
|
|
|
|
from galaxy.selenium.navigates_galaxy import (
|
|
ConfigTemplateParameter,
|
|
FileSourceInstance,
|
|
)
|
|
from galaxy_test.selenium.upload_activity_helpers import UsesUploadActivity
|
|
from ._base_user_file_sources import BaseUserObjectStoreSeleniumIntegration
|
|
from ._sftp_server import SFTPServerMixin
|
|
from .framework import (
|
|
managed_history,
|
|
selenium_test,
|
|
)
|
|
|
|
|
|
class TestObjectStoreSelectionSeleniumIntegration(
|
|
BaseUserObjectStoreSeleniumIntegration, SFTPServerMixin, UsesUploadActivity
|
|
):
|
|
"""Selenium tests for the SSH user file source template.
|
|
|
|
A single in-process SFTP server is started for the whole class and torn
|
|
down afterwards. The server's host/port/credentials are passed as
|
|
template parameters when creating the file source instance in the Galaxy UI.
|
|
"""
|
|
|
|
example_filename = "ssh.yml"
|
|
_sftp_root: str
|
|
|
|
@classmethod
|
|
def handle_galaxy_config_kwds(cls, config):
|
|
super().handle_galaxy_config_kwds(config)
|
|
cls._populate_sftp_root()
|
|
cls.start_sftp_server(cls._sftp_root)
|
|
|
|
@classmethod
|
|
def tearDownClass(cls):
|
|
cls.stop_sftp_server()
|
|
if hasattr(cls, "_sftp_root"):
|
|
shutil.rmtree(cls._sftp_root, ignore_errors=True)
|
|
super().tearDownClass()
|
|
|
|
@classmethod
|
|
def _populate_sftp_root(cls) -> None:
|
|
"""Create the SFTP root directory with files used by the tests."""
|
|
|
|
cls._sftp_root = tempfile.mkdtemp(prefix="galaxy_test_sftp_")
|
|
|
|
# Create a root-level file to upload.
|
|
with open(os.path.join(cls._sftp_root, "test_file.txt"), "w") as fh:
|
|
fh.write("Hello from SSH file source test\n")
|
|
|
|
# Create a subdirectory with its own file to exercise the path parameter.
|
|
sftp_subdir = os.path.join(cls._sftp_root, "subdir")
|
|
os.makedirs(sftp_subdir, exist_ok=True)
|
|
with open(os.path.join(sftp_subdir, "subdir_file.txt"), "w") as fh:
|
|
fh.write("Hello from SSH subdir test\n")
|
|
|
|
@selenium_test
|
|
@managed_history
|
|
def test_create_and_use(self):
|
|
random_name = self._get_random_name(prefix="ssh test")
|
|
instance = FileSourceInstance(
|
|
template_id="ssh",
|
|
name=random_name,
|
|
description="SSH file source backed by a local in-process SFTP server",
|
|
parameters=[
|
|
ConfigTemplateParameter("string", "host", "127.0.0.1"),
|
|
ConfigTemplateParameter("integer", "port", self._sftp_server.port),
|
|
ConfigTemplateParameter("string", "user", self._sftp_server.username),
|
|
ConfigTemplateParameter("string", "path", "/"),
|
|
ConfigTemplateParameter("string", "password", self._sftp_server.password),
|
|
],
|
|
)
|
|
uri_root = self.create_file_source_template(instance)
|
|
self.upload_context("paste-links").stage_paste_link(f"{uri_root}/test_file.txt").start()
|
|
self.wait_for_history()
|
|
|
|
@selenium_test
|
|
@managed_history
|
|
def test_path_subdirectory(self):
|
|
"""Verify that the path parameter scopes the file source to a subdirectory.
|
|
|
|
When path='/subdir', Galaxy resolves internal file paths relative to that
|
|
subdirectory on the SFTP server, so only files under subdir/ are accessible.
|
|
"""
|
|
random_name = self._get_random_name(prefix="ssh subdir test")
|
|
instance = FileSourceInstance(
|
|
template_id="ssh",
|
|
name=random_name,
|
|
description="SSH file source scoped to a subdirectory via the path parameter",
|
|
parameters=[
|
|
ConfigTemplateParameter("string", "host", "127.0.0.1"),
|
|
ConfigTemplateParameter("integer", "port", self._sftp_server.port),
|
|
ConfigTemplateParameter("string", "user", self._sftp_server.username),
|
|
ConfigTemplateParameter("string", "path", "/subdir"),
|
|
ConfigTemplateParameter("string", "password", self._sftp_server.password),
|
|
],
|
|
)
|
|
uri_root = self.create_file_source_template(instance)
|
|
self.upload_context("paste-links").stage_paste_link(f"{uri_root}/subdir_file.txt").start()
|
|
self.wait_for_history()
|