Warning

This document is for an in-development version of Galaxy. You can alternatively view this page in the latest release if it exists or view the top of the latest release's documentation.

Source code for galaxy_test.base.api

import os
from contextlib import contextmanager
from typing import (
    Any,
    Dict,
    Optional,
)
from urllib.parse import (
    urlencode,
    urljoin,
)

import pytest
import requests
from typing_extensions import Protocol

from galaxy.util.properties import get_from_env
from .api_asserts import (
    assert_error_code_is,
    assert_has_keys,
    assert_not_has_keys,
    assert_status_code_is,
    assert_status_code_is_ok,
)
from .api_util import (
    ADMIN_TEST_USER,
    get_admin_api_key,
    get_user_api_key,
    OTHER_USER,
    TEST_USER,
)
from .interactor import TestCaseGalaxyInteractor as BaseInteractor

CONFIG_PREFIXES = ["GALAXY_TEST_CONFIG_", "GALAXY_CONFIG_OVERRIDE_", "GALAXY_CONFIG_"]
CELERY_BROKER = get_from_env("CELERY_BROKER", CONFIG_PREFIXES, "memory://")
CELERY_BACKEND = get_from_env("CELERY_BACKEND", CONFIG_PREFIXES, "rpc://localhost")

DEFAULT_CELERY_CONFIG = {
    "broker_url": CELERY_BROKER,
    "result_backend": CELERY_BACKEND,
}


[docs]@pytest.fixture(scope="session") def celery_config(): return DEFAULT_CELERY_CONFIG
[docs]class UsesCeleryTasks:
[docs] @classmethod def handle_galaxy_config_kwds(cls, config: Dict[str, Any]) -> None: config["enable_celery_tasks"] = True config["metadata_strategy"] = f'{config.get("metadata_strategy", "directory")}_celery' celery_conf: Dict[str, Any] = config.get("celery_conf", {}) celery_conf.update(DEFAULT_CELERY_CONFIG) config["celery_conf"] = celery_conf
@pytest.fixture(autouse=True, scope="session") def _request_celery_app(self, celery_session_app, celery_config): try: self._celery_app = celery_session_app yield finally: if os.environ.get("GALAXY_TEST_EXTERNAL") is None: from galaxy.celery import celery_app celery_app.fork_pool.stop() celery_app.fork_pool.join(timeout=5) @pytest.fixture(autouse=True, scope="session") def _request_celery_worker(self, celery_session_worker, celery_config, celery_worker_parameters): self._celery_worker = celery_session_worker
[docs] @pytest.fixture(scope="session", autouse=True) def celery_worker_parameters(self): return { "queues": ("galaxy.internal", "galaxy.external"), }
[docs] @pytest.fixture(scope="session") def celery_parameters(self): return { "task_create_missing_queues": True, "task_default_queue": "galaxy.internal", }
[docs]class HasAnonymousGalaxyInteractor(Protocol): @property def anonymous_galaxy_interactor(self) -> "ApiTestInteractor": """Return an optionally anonymous galaxy interactor."""
[docs]class UsesApiTestCaseMixin: url: str _galaxy_interactor: Optional["ApiTestInteractor"] = None
[docs] def tearDown(self): if os.environ.get("GALAXY_TEST_EXTERNAL") is None: # Only kill running jobs after test for managed test instances response = self.galaxy_interactor.get("jobs?state=running") if response.ok: for job in response.json(): self._delete(f"jobs/{job['id']}")
def _api_url(self, path, params=None, use_key=None, use_admin_key=None): if not params: params = {} url = urljoin(self.url, f"api/{path}") if use_key: params["key"] = self.galaxy_interactor.api_key if use_admin_key: params["key"] = self.galaxy_interactor.master_api_key if query := urlencode(params): url = f"{url}?{query}" return url def _setup_interactor(self): self.user_api_key = get_user_api_key() self.master_api_key = get_admin_api_key() self._galaxy_interactor = self._get_interactor() @property def anonymous_galaxy_interactor(self) -> "ApiTestInteractor": """Return an optionally anonymous galaxy interactor. Lighter requirements for use with API requests that may not required an API key. """ return self.galaxy_interactor @property def galaxy_interactor(self) -> "ApiTestInteractor": assert self._galaxy_interactor is not None return self._galaxy_interactor def _get_interactor(self, api_key=None, allow_anonymous=False) -> "ApiTestInteractor": if allow_anonymous and api_key is None: return AnonymousGalaxyInteractor(self) else: return ApiTestInteractor(self, api_key=api_key) def _setup_user(self, email, password=None): return self.galaxy_interactor.ensure_user_with_email(email, password=password) def _setup_user_get_key(self, email, password=None): user = self._setup_user(email, password) return user, self._post(f"users/{user['id']}/api_key", admin=True).json() @contextmanager def _different_user(self, email=OTHER_USER, anon=False): """Use in test cases to switch get/post operations to act as new user ..code-block:: python with self._different_user("other_user@bx.psu.edu"): self._get("histories") # Gets other_user@bx.psu.edu histories. """ original_api_key = self.user_api_key original_interactor_key = self.galaxy_interactor.api_key original_cookies = self.galaxy_interactor.cookies if anon: cookies = requests.get(self.url).cookies self.galaxy_interactor.cookies = cookies new_key = None else: _, new_key = self._setup_user_get_key(email) try: self.user_api_key = new_key self.galaxy_interactor.api_key = new_key yield finally: self.user_api_key = original_api_key self.galaxy_interactor.api_key = original_interactor_key self.galaxy_interactor.cookies = original_cookies def _get(self, *args, **kwds): return self.galaxy_interactor.get(*args, **kwds) def _head(self, *args, **kwds): return self.galaxy_interactor.head(*args, **kwds) def _post(self, *args, **kwds): return self.galaxy_interactor.post(*args, **kwds) def _delete(self, *args, **kwds): return self.galaxy_interactor.delete(*args, **kwds) def _put(self, *args, **kwds): return self.galaxy_interactor.put(*args, **kwds) def _patch(self, *args, **kwds): return self.galaxy_interactor.patch(*args, **kwds) def _assert_status_code_is_ok(self, response): assert_status_code_is_ok(response) def _assert_status_code_is(self, response, expected_status_code): assert_status_code_is(response, expected_status_code) def _assert_has_keys(self, response, *keys): assert_has_keys(response, *keys) def _assert_not_has_keys(self, response, *keys): assert_not_has_keys(response, *keys) def _assert_error_code_is(self, response, error_code): assert_error_code_is(response, error_code) def _random_key(self): # Used for invalid request testing... return "1234567890123456" _assert_has_key = _assert_has_keys
[docs]class ApiTestInteractor(BaseInteractor): """Specialized variant of the API interactor (originally developed for tool functional tests) for testing the API generally. """
[docs] def __init__(self, test_case, api_key=None): self.cookies = None admin = getattr(test_case, "require_admin_user", False) test_user = TEST_USER if not admin else ADMIN_TEST_USER super().__init__(test_case, test_user=test_user, api_key=api_key)
# This variant the lower level get and post methods are meant to be used # directly to test API - instead of relying on higher-level constructs for # specific pieces of the API (the way it is done with the variant for tool) # testing.
[docs] def get(self, *args, **kwds): return self._get(*args, **kwds)
[docs] def head(self, *args, **kwds): return self._head(*args, **kwds)
[docs] def post(self, *args, **kwds): return self._post(*args, **kwds)
[docs] def delete(self, *args, **kwds): return self._delete(*args, **kwds)
[docs] def patch(self, *args, **kwds): return self._patch(*args, **kwds)
[docs] def put(self, *args, **kwds): return self._put(*args, **kwds)
[docs]class AnonymousGalaxyInteractor(ApiTestInteractor):
[docs] def __init__(self, test_case): super().__init__(test_case)
def _get_user_key( self, user_key: Optional[str], admin_key: Optional[str], test_user: Optional[str] = None ) -> Optional[str]: return None