one.tests.test_alyxclient

Unit tests for the one.webclient module.

Classes

TestAuthentication	Tests for AlyxClient authentication, token storage, login/out methods and user prompts.
TestDownloadHTTP
TestJsonFieldMethods	Tests for AlyxClient methods that modify the JSON field of a REST endpoint.
TestMisc
TestRestCache	Tests for REST caching system, the cache decorator and cache flags.
TestRestDocumentation	Tests for AlyxClient REST API schema parsing and printing.

class TestRestDocumentation(methodName='runTest')

Bases: TestCase

Tests for AlyxClient REST API schema parsing and printing.

setUp() → None

Hook method for setting up the test fixture before exercising it.

test_rest_schema_core_api()

Test parsing of coreapi REST schema.

test_print_endpoint_info()

Test endpoint query params are printed when calling AlyxClient.rest without action.

test_alyx_client_methods()

Test AlyxClient.list_endpoints and AlyxClient.print_endpoint_info.

test_schema_support()

Test that both coreapi and openapiv3 REST schemas are supported.

class TestAuthentication(methodName='runTest')

Bases: TestCase

Tests for AlyxClient authentication, token storage, login/out methods and user prompts.

setUp() → None

Hook method for setting up the test fixture before exercising it.

test_authentication()

Test for AlyxClient.authenticate and AlyxClient.is_logged_in property.

test_auth_methods()

Test behaviour when calling AlyxClient._generic_request when logged out.

test_auth_errors()

Test behaviour when authentication fails.

class TestJsonFieldMethods(methodName='runTest')

Bases: TestCase

Tests for AlyxClient methods that modify the JSON field of a REST endpoint.

These tests are over-engineered in order to test Alyx Django queries with JSON fields. Django queries are also tested in TestRemote.test_search.

setUp()

Hook method for setting up the test fixture before exercising it.

test_json_methods()

Test for AlyxClient.json_field* methods (write, update, remove_key and delete).

test_empty()

Test for AlyxClient.json_field* methods when JSON field is empty.

test_uuid_serialize()

Check that UUID objects are serialized to JSON.

tearDown()

Hook method for deconstructing the test fixture after testing it.

class TestRestCache(methodName='runTest')

Bases: TestCase

Tests for REST caching system, the cache decorator and cache flags.

setUp()

Hook method for setting up the test fixture before exercising it.

test_loads_cached()

Test for one.webclient._cache_response decorator, checks returns cached result.

test_expired_cache()

Test behaviour when cached REST query is expired.

test_caches_response()

Test caches query response before returning.

test_cache_mode()

Test for AlyxClient.cache_mode property.

test_expiry_param()

Test for expires kwarg in one.webclient._cache_response decorator.

test_cache_returned_on_error()

Test behaviour when connection error occurs and cached response exists.

test_decode_error_cache()

Test behaviour when cached file is corrupted.

test_clear_cache()

Test for AlyxClient.clear_rest_cache.

tearDown() → None

Hook method for deconstructing the test fixture after testing it.

class TestDownloadHTTP(methodName='runTest')

Bases: TestCase

setUp()

Hook method for setting up the test fixture before exercising it.

test_download_datasets_with_api()

test_download_datasets()

test_download_cache_tables_auth(download_file_mock, zipfile_mock)

Test for AlyxClient.download_cache_tables with authentication.

NB: This test simply checks that alex is authenticated automatically before downloading the tables.

class TestMisc(methodName='runTest')

Bases: TestCase

test_update_url_params()

Test for one.webclient.update_url_params.

test_validate_file_url()

Test for AlyxClient._validate_file_url.

test_no_cache_context_manager()

Test for one.webclient.no_cache function.

test_cache_dir_setter()

Tests setter for AlyxClient.cache_dir attribute.

test_paginated_response()

Test the _PaginatedResponse class.

test_json_encoder()

Test that the JSONEncoder subclass serializes UUID objects.