one.tests.test_one

Tests for the one.api module

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

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

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 This class loads the parquet tables from the fixtures and builds a file tree in a temp folder
TestOneAlyx	This could be an offline test.
TestOneDownload	Test downloading datasets using OpenAlyx
TestOneMisc
TestOneRemote	Test remote queries
TestOneSetup

class TestONECache(methodName='runTest')

Bases: unittest.case.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

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.

classmethod tearDownClass() → None

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

test_list_subjects()

test_offline_repr()

test_one_search()

test_check_exists()

test_filter()

test_filter_wildcards()

test_list_datasets()

test_list_collections()

test_list_revisions()

No revisions in cache fixture so generate our own

test_get_details()

test_index_type()

test_load_dataset()

test_load_datasets()

test_load_dataset_from_id()

test_load_object()

test_load_cache()

test_refresh_cache()

class TestOneAlyx(methodName='runTest')

Bases: unittest.case.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.

test_type2datasets()

test_ses2records()

test_datasets2records()

test_pid2eid()

test_describe_revision(mock_stdout)

test_describe_dataset(mock_stdout)

NB This could be offline: REST responses in fixtures

test_url_from_path()

test_url_from_record()

classmethod tearDownClass() → None

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

class TestOneRemote(methodName='runTest')

Bases: unittest.case.TestCase

Test remote queries

setUp() → None

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

test_online_repr()

test_list_datasets()

test_search()

test_load_dataset()

test_load_object()

class TestOneDownload(methodName='runTest')

Bases: unittest.case.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()

tearDown() → None

Hook method for deconstructing the test fixture after testing it.

class TestOneSetup(methodName='runTest')

Bases: unittest.case.TestCase

setUp() → None

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

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

test_patch_params()

Test patching legacy params to the new location

test_one_factory()

Tests the ONE class factory

class TestOneMisc(methodName='runTest')

Bases: unittest.case.TestCase

test_validate_date_range()

test_index_last_before()

test_collection_spec()

test_revision_last_before()

test_parse_id()

test_autocomplete()

test_LazyID()