one.tests.test_alyxclient

Unit tests for the one.webclient module.

Functions

setUpModule	Point the parameter files at a directory belonging to this module.
tearDownModule

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.
TestThrottleBackoff	Test behaviour when AlyxClient receives a 429 Too Many Requests response.

setUpModule()

Point the parameter files at a directory belonging to this module.

These tests log in and out, which rewrites the parameter file for whichever database they use - the developer’s real ~/.one without this. The test database is then set up silently so no class depends on another having run first.

tearDownModule()

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_authenticate_with_token()

Test authenticating with a token in place of a password.

Accounts that sign in through an identity provider have no password at all, so /auth-token is closed to them and a token is the only credential they have.

test_authenticate_with_token_not_cached()

A token passed with cache_token=False should not be written to the params.

test_authenticate_token_prompt()

A blank password at the prompt should fall through to asking for a token.

test_verify_token_rejects_bad_token()

A token the database refuses must be discarded rather than cached.

test_verify_token_tolerates_unreachable_database()

A network failure while checking must not reject a token that may be perfectly good.

test_verify_token_checks_the_me_endpoint()

The token is checked against /me, which also reports whose it is.

test_token_username_wins_over_the_one_supplied()

The database knows whose token it is; caching it under another name would lie.

test_token_alone_identifies_the_user()

A token is the one credential that can name its owner, so no username is needed.

test_a_token_is_never_asked_who_it_belongs_to()

A token names its own owner, so neither the prompt nor the stored login applies.

test_the_api_version_survives_every_authentication_path()

A database can only see how old its clients are if they all say so.

authenticate rebuilds the header dict, so the version was previously sent only by a client that authenticated through the constructor, and dropped by one that authenticated lazily or from a cached token - the common case by far.

test_the_api_version_is_sent_with_the_request()

The header must reach the wire, not merely sit in the client’s dict.

test_no_username_is_an_error_rather_than_a_prompt_loop()

With a blank default login and no token, there is nothing to authenticate as.

test_a_token_alone_needs_a_database_that_names_its_owner()

An Alyx too old to serve /me as an API cannot say whose token it is.

With a token alone there is no name to cache it under and no way to tell whether it is even the intended account, so it is refused.

test_a_token_alone_is_refused_when_the_database_is_unreachable()

The other way the check comes back empty: it never reached the database.

test_a_username_resolved_once_is_remembered()

Otherwise the cached token, which is keyed by username, could never be found again.

test_auth_methods()

Test behaviour when calling AlyxClient._generic_request when logged out.

test_download_cache_tables_authenticates()

Downloading the cache tables must authenticate first, like any other request.

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.

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.

class TestThrottleBackoff(methodName='runTest')

Bases: TestCase

Test behaviour when AlyxClient receives a 429 Too Many Requests response.

setUp()

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

test_backoff_with_retry_after(sleep_mock)

Test that AlyxClient respects Retry-After header.

test_backoff_without_retry_after(sleep_mock)

Test that AlyxClient uses exponential backoff when Retry-After header is missing.

test_maximum_thresholds(sleep_mock)

Test that AlyxClient raises an error after maximum retry attempts.

test_retry_after_date(sleep_mock)

Test that AlyxClient correctly parses Retry-After header when it is a date.

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_creates_a_missing_target_directory()

The default target is ~/Downloads, which plenty of machines do not have.

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 alyx is authenticated automatically before downloading the tables.

test_http_server_auth(open_mock, urllib_mock)

Test for http_download_file authentication and headers.

class TestMisc(methodName='runTest')

Bases: TestCase

setUp()

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

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_alyx_advice_header()

Test that the Alyx-API-Notice response header is logged or raised as a warning.

test_lifecycle_headers()

Test that the Deprecation and Sunset response headers are logged.

test_paginated_response()

Test the _PaginatedResponse class.

test_paginated_response_count_changed()

Test _PaginatedResponse when records are added/removed by another process.

The remote count is fixed at instantiation, so a -ve index is resolved against a count that may be stale by the time the page is fetched. Previously this left None values in the cache when records were removed.

test_json_encoder()

Test that the JSONEncoder subclass serializes UUID objects.