mirror of
https://github.com/galaxyproject/galaxy.git
synced 2026-09-24 16:30:27 +08:00
John Chilton
285896dfe1
Add tests for new date range and history filtering as well as to ensure only admins get to see external_id and command_line and that users cannot see each other's jobs. Always allow admins to views all jobs on index (instead of only when user_details is specified) and show. Add user_email and external_id to show (for admins) to bring it inline with index and add command_line to index (for admins) to bring it in line with show. Show still allow more details including job standard error and output as well as job metrics.
116 lines
4.0 KiB
Python
116 lines
4.0 KiB
Python
from contextlib import contextmanager
|
|
|
|
# TODO: We don't need all of TwillTestCase, strip down to a common super class
|
|
# shared by API and Twill test cases.
|
|
from .twilltestcase import TwillTestCase
|
|
|
|
from base.interactor import GalaxyInteractorApi as BaseInteractor
|
|
|
|
from .api_util import get_master_api_key
|
|
from .api_util import get_user_api_key
|
|
from .api_asserts import (
|
|
assert_status_code_is,
|
|
assert_has_keys,
|
|
assert_not_has_keys,
|
|
assert_error_code_is,
|
|
)
|
|
|
|
from urllib import urlencode
|
|
|
|
|
|
TEST_USER = "user@bx.psu.edu"
|
|
DEFAULT_OTHER_USER = "otheruser@bx.psu.edu" # A second user for API testing.
|
|
|
|
|
|
# TODO: Allow these to point at existing Galaxy instances.
|
|
class ApiTestCase( TwillTestCase ):
|
|
|
|
def setUp( self ):
|
|
super( ApiTestCase, self ).setUp( )
|
|
self.user_api_key = get_user_api_key()
|
|
self.master_api_key = get_master_api_key()
|
|
self.galaxy_interactor = ApiTestInteractor( self )
|
|
|
|
def _api_url( self, path, params=None, use_key=None ):
|
|
if not params:
|
|
params = {}
|
|
url = "%s/api/%s" % ( self.url, path )
|
|
if use_key:
|
|
params[ "key" ] = self.galaxy_interactor.api_key
|
|
query = urlencode( params )
|
|
if query:
|
|
url = "%s?%s" % ( url, query )
|
|
return url
|
|
|
|
def _setup_user( self, email, password=None ):
|
|
self.galaxy_interactor.ensure_user_with_email( email, password=password )
|
|
users = self._get( "users", admin=True ).json()
|
|
user = [ user for user in users if user["email"] == email ][0]
|
|
return user
|
|
|
|
def _setup_user_get_key( self, email ):
|
|
self.galaxy_interactor.ensure_user_with_email( email )
|
|
users = self._get( "users", admin=True ).json()
|
|
user = [ user for user in users if user["email"] == email ][0]
|
|
return self._post( "users/%s/api_key" % user[ "id" ], admin=True ).json()
|
|
|
|
@contextmanager
|
|
def _different_user( self, email=DEFAULT_OTHER_USER ):
|
|
""" Use in test cases to switch get/post operations to act as new user,
|
|
|
|
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
|
|
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
|
|
|
|
def _get( self, *args, **kwds ):
|
|
return self.galaxy_interactor.get( *args, **kwds )
|
|
|
|
def _post( self, *args, **kwds ):
|
|
return self.galaxy_interactor.post( *args, **kwds )
|
|
|
|
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
|
|
|
|
|
|
class ApiTestInteractor( BaseInteractor ):
|
|
""" Specialized variant of the API interactor (originally developed for
|
|
tool functional tests) for testing the API generally.
|
|
"""
|
|
|
|
def __init__( self, test_case ):
|
|
super( ApiTestInteractor, self ).__init__( test_case, test_user=TEST_USER )
|
|
|
|
# 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.
|
|
def get( self, *args, **kwds ):
|
|
return self._get( *args, **kwds )
|
|
|
|
def post( self, *args, **kwds ):
|
|
return self._post( *args, **kwds )
|