Source code for galaxy.tool_util.unittest_utils

import os
from typing import (
    Callable,
    Dict,
    Optional,
    Union,
)
from unittest.mock import Mock

from galaxy.tool_util.parser.factory import get_tool_source
from galaxy.tool_util.parser.interface import ToolSource
from galaxy.util import galaxy_directory



[docs]
def mock_trans(has_user=True, is_admin=False):
    """A mock ``trans`` object for exposing user info to toolbox filter unit tests."""
    trans = Mock(user_is_admin=is_admin)
    if has_user:
        trans.user = Mock(preferences={})
    else:
        trans.user = None
    return trans




[docs]
def t_data_downloader_for(content: Union[Dict[Optional[str], bytes], bytes]) -> Callable[[str], bytes]:
    def get_content(filename: Optional[str]) -> bytes:
        if isinstance(content, dict):
            assert filename in content, f"failed to find {filename} in {content}"
            return content[filename]
        else:
            return content

    return get_content




[docs]
def functional_test_tool_directory() -> str:
    return os.path.join(galaxy_directory(), "test/functional/tools")




[docs]
def functional_test_tool_path(test_path: str) -> str:
    return os.path.join(functional_test_tool_directory(), test_path)




[docs]
def functional_test_tool_source(tool_name: str) -> ToolSource:
    test_tool_directory = functional_test_tool_directory()
    if tool_name.endswith("_y"):
        yaml_name = tool_name[:-2]
        tool_path = os.path.join(test_tool_directory, f"{yaml_name}.yml")
    else:
        tool_path = os.path.join(test_tool_directory, f"{tool_name}.xml")
    tool_source = get_tool_source(tool_path)
    return tool_source