one.tests.test_one

Unit tests for the one.api module.

Wherever possible the ONE tests should not rely on an internet connection.

Fixture locations:

• The cache tables for the public test instance are in tests/fixtures/

• The test db parameters can be found in tests/fixtures/params/

• Some REST GET requests can be found in tests/fixtures/rest_responses/

• These can be copied over to a temporary directory using the functions in tests/util.py, then construct ONE with the directory as cache_dir, mode=’local’ and silent=True

Imported constants:

• For tests that do require a remote connection use the tests.OFFLINE_ONLY flag in the skipIf decorator.

• For testing REST POST requests use TEST_DB_1 (test.alyx.internationalbrainlab.org).

• For testing download functions, use TEST_DB_2 (openalyx.internationalbrainlab.org).

Note ONE and AlyxClient use caching:

• When verifying remote changes via the rest method, use the no_cache flag to ensure the remote databaseis queried. You can clear the cache using AlyxClient.clear_rest_cache(), or mock iblutil.io.params.getfile to return a temporary cache directory.

• An One object created through the one.api.ONE function, make sure you restore the properties to their original state on teardown, or call one.api.ONE.cache_clear().

Classes

TestONECache	Test methods that use sessions and datasets tables.
TestOneAlyx	This could be an offline test.
TestOneDownload	Test downloading datasets using OpenAlyx.
TestOneMisc	Test functions in one.util.
TestOneRemote	Test remote queries using OpenAlyx
TestOneSetup	Test parameter setup upon ONE instantiation and calling setup methods.

class TestONECache(methodName='runTest')

Bases: TestCase

Test methods that use sessions and datasets tables.

This class loads the parquet tables from the fixtures and builds a file tree in a temp folder

tempdir = None

setUp() → None

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

tearDown() → None

Hook method for deconstructing the test fixture after testing it.

test_list_subjects()

Test One.list_subejcts

test_offline_repr()

Test for One.offline property

test_one_search()

Test for One.search

test_filter()

Test one.util.filter_datasets

test_filter_wildcards()

Test one.util.filter_datasets with wildcards flag set to True

test_list_datasets()

Test One.list_datasets

test_list_collections()

Test One.list_collections

test_list_revisions()

Test One.list_revisions

test_get_details()

Test One.get_details

test_check_filesystem()

Test for One._check_filesystem.

Most is already covered by other tests, this checks that it can deal with dataset frame without eid index and without a session_path column.

test_load_dataset()

Test One.load_dataset

test_load_datasets()

Test One.load_datasets

test_load_dataset_from_id()

Test One.load_dataset_from_id

test_load_object()

Test One.load_object

test_load_collection()

Test One.load_collection

test_load_cache()

Test One._load_cache

test_refresh_cache()

Test One.refresh_cache

test_save_cache()

Test one.util.save_cache

test_reset_cache()

Test One._reset_cache method, namely that cache types are correct.

test_update_cache_from_records()

Test One._update_cache_from_records

test_save_loaded_ids()

Test One.save_loaded_ids and logic within One._check_filesystem

test_remove_cache_table_files()

Test One._remove_cache_table_files method.

class TestOneAlyx(methodName='runTest')

Bases: TestCase

This could be an offline test. Would need to add /docs REST cache fixture.

tempdir = None

one = None

classmethod setUpClass() → None

Hook method for setting up class fixture before running tests in the class.

tearDown() → None

Hook method for deconstructing the test fixture after testing it.

test_type2datasets()

Test OneAlyx.type2datasets

test_dataset2type()

Test for OneAlyx.dataset2type

test_pid2eid()

Test OneAlyx.pid2eid

test_describe_revision(mock_stdout)

Test OneAlyx.describe_revision

test_describe_dataset(mock_stdout)

Test OneAlyx.describe_dataset. NB This could be offline: REST responses in fixtures.

test_url_from_path()

Test OneAlyx.path2url

test_url_from_record()

Test ConversionMixin.record2url

test_load_cache()

Test loading the remote cache

test_check_filesystem()

Test for One._check_filesystem. Most is already covered by other tests, this just checks that it can deal with dataset dicts as input.

test_download_aws(boto3_mock)

Tests for the OneAlyx._download_aws method

test_list_aggregates()

Test OneAlyx.list_aggregates

test_load_aggregate()

Test OneAlyx.load_aggregate

classmethod tearDownClass() → None

Hook method for deconstructing the class fixture after running all tests in the class.

class TestOneRemote(methodName='runTest')

Bases: TestCase

Test remote queries using OpenAlyx

setUp() → None

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

test_online_repr()

Tests OneAlyx.__repr__

test_list_datasets()

Test OneAlyx.list_datasets

test_search()

Test OneAlyx.search method in remote mode.

test_search_insertions()

Test OneAlyx.search_insertion method in remote mode.

test_search_terms()

Test OneAlyx.search_terms.

test_load_dataset()

Test OneAlyx.load_dataset.

test_load_object()

Test OneAlyx.load_object.

test_get_details()

Test OneAlyx.get_details.

class TestOneDownload(methodName='runTest')

Bases: TestCase

Test downloading datasets using OpenAlyx.

tempdir = None

one = None

setUp() → None

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

test_download_datasets()

Test OneAlyx._download_dataset, _download_file and _dset2url.

test_download_aws()

Test for OneAlyx._download_aws method.

test_tag_mismatched_file_record()

Test for OneAlyx._tag_mismatched_file_record.

This method is also tested in test_download_datasets.

tearDown() → None

Hook method for deconstructing the test fixture after testing it.

class TestOneSetup(methodName='runTest')

Bases: TestCase

Test parameter setup upon ONE instantiation and calling setup methods.

setUp() → None

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

test_local_cache_setup_prompt()

Test One.setup.

test_local_tables_only()

Test first time instantiation of ONE with only tables_dir arg.

Previously this would have raised and AttributeError as cache_map.DEFAULT doesn’t exist on a new install.

test_setup_silent()

Test setting up parameters with silent flag.

• Mock getfile to return temp dir as param file location

• Mock input function as fail safe in case function erroneously prompts user for input

test_setup_username()

Test setting up parameters with a provided username.

• Mock getfile to return temp dir as param file location

• Mock input function as fail safe in case function erroneously prompts user for input

• Mock requests.post returns a fake user authentication response

test_static_setup()

Test OneAlyx.setup.

test_setup()

Test one.params.setup.

test_patch_params()

Test patching legacy params to the new location.

test_one_factory()

Tests the ONE class factory.

class TestOneMisc(methodName='runTest')

Bases: TestCase

Test functions in one.util.

test_validate_date_range()

Test one.util.validate_date_range.

test_index_last_before()

Test one.util.index_last_before.

test_collection_spec()

Test one.util._collection_spec.

test_revision_last_before()

Test one.util.filter_revision_last_before.

test_parse_id()

Test one.util.parse_id.

test_autocomplete()

Test one.util.autocomplete.

test_LazyID()

Test one.util.LazyID.

test_ensure_list()

Test one.util.ensure_list.

This function has now moved therefore we simply check for deprecation warning.