mirror of
https://github.com/galaxyproject/galaxy.git
synced 2026-09-24 16:30:27 +08:00
John Chilton
2f775a0a9c
Previous run_as method has some potential limitations, seems testing permission/security things is more correct if actually using normal alternative user key.
119 lines
4.5 KiB
Python
119 lines
4.5 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 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 ):
|
|
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 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 ):
|
|
response_status_code = response.status_code
|
|
if expected_status_code != response_status_code:
|
|
try:
|
|
body = response.json()
|
|
except Exception:
|
|
body = "INVALID JSON RESPONSE <%s>" % response.content
|
|
assertion_message_template = "Request status code (%d) was not expected value %d. Body was %s"
|
|
assertion_message = assertion_message_template % ( response_status_code, expected_status_code, body )
|
|
raise AssertionError( assertion_message )
|
|
|
|
def _assert_has_keys( self, response, *keys ):
|
|
for key in keys:
|
|
assert key in response, "Response [%s] does not contain key [%s]" % ( response, key )
|
|
|
|
def _assert_error_code_is( self, response, error_code ):
|
|
if hasattr( response, "json" ):
|
|
response = response.json()
|
|
self._assert_has_keys( response, "err_code" )
|
|
self.assertEquals( response[ "err_code" ], int( 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 )
|