test_arctic.py

import time
from datetime import datetime as dt

import pytest
from mock import patch, MagicMock
from pandas.util.testing import assert_frame_equal
from pymongo.errors import OperationFailure

from arctic.arctic import Arctic, VERSION_STORE
from arctic.exceptions import LibraryNotFoundException, QuotaExceededException
from ..util import get_large_ts


def test_connect_to_Arctic_string(mongo_host):
    arctic = Arctic(mongo_host=mongo_host)
    assert arctic.list_libraries() == []
    assert arctic.mongo_host == mongo_host


def test_connect_to_Arctic_connection(mongo_server, mongo_host):
    arctic = Arctic(mongo_server.api)
    assert arctic.list_libraries() == []
    assert arctic.mongo_host == mongo_host


def test_reset_Arctic(mongo_host, library_name):
    arctic = Arctic(mongo_host=mongo_host)
    arctic.list_libraries()
    arctic.initialize_library(library_name, VERSION_STORE)
    c = arctic._conn
    assert arctic[library_name]._arctic_lib._curr_conn is c
    arctic.reset()
    assert c is not arctic._conn
    assert len(c.nodes) == 0
    assert arctic[library_name]._arctic_lib._curr_conn is arctic._conn


def test_re_authenticate_on_arctic_reset(mongo_host, library_name):
    from collections import namedtuple
    Cred = namedtuple('Cred', 'user, password')
    with patch('arctic.arctic.authenticate') as auth_mock, \
            patch('arctic.arctic.get_auth') as get_auth_mock:
        auth_mock.return_value = True
        get_auth_mock.return_value = Cred(user='a_username', password='a_passwd')
        arctic = Arctic(mongo_host=mongo_host)
        arctic.initialize_library(library_name, VERSION_STORE)
        vstore = arctic[library_name]
        vstore.list_symbols()
        auth_mock.reset_mock()
        arctic.reset()
        assert auth_mock.call_count > 0
        auth_mock.reset_mock()
        vstore.list_symbols()
        assert auth_mock.call_count == 0


def test_simple(library):
    sym = 'symbol'
    data = get_large_ts(100)

    library.write(sym, data)
    orig = dt.now()
    time.sleep(1)  # Move the timestamp on 1ms
    data2 = get_large_ts(100)
    library.write(sym, data2, prune_previous_version=False)

    # Get the timeseries, it should be the same
    read2 = library.read(sym).data
    assert_frame_equal(read2, data2)

    # Ensure we can get the previous version
    read = library.read(sym, as_of=orig).data
    assert_frame_equal(read, data)


def test_indexes(arctic):
    c = arctic._conn
    arctic.initialize_library("library", VERSION_STORE, segment='month')
    chunk = c.arctic.library.index_information()
    index_version = chunk['_id_']['v']  # Mongo 3.2 has index v1, 3.4 and 3.5 have v2 (3.4 can run in compabitility mode with v1)
    assert chunk == {u'_id_': {u'key': [(u'_id', 1)], u'ns': u'arctic.library', u'v': index_version},
                     u'symbol_1_parent_1_segment_1': {u'background': True,
                                                      u'key': [(u'symbol', 1),
                                                               (u'parent', 1),
                                                               (u'segment', 1)],
                                                      u'ns': u'arctic.library',
                                                      u'unique': True,
                                                      u'v': index_version},
                     u'symbol_1_sha_1': {u'background': True,
                                         u'key': [(u'symbol', 1), (u'sha', 1)],
                                         u'ns': u'arctic.library',
                                         u'unique': True,
                                         u'v': index_version},
                     u'symbol_hashed': {u'background': True,
                                        u'key': [(u'symbol', u'hashed')],
                                        u'ns': u'arctic.library',
                                        u'v': index_version},
                     u'symbol_1_sha_1_segment_1': {u'background': True,
                                                   u'key': [(u'symbol', 1), (u'sha', 1), (u'segment', 1)],
                                                   u'ns': u'arctic.library',
                                                   u'unique': True,
                                                   u'v': index_version}}
    snapshots = c.arctic.library.snapshots.index_information()
    assert snapshots == {u'_id_': {u'key': [(u'_id', 1)],
                                               u'ns': u'arctic.library.snapshots',
                                               u'v': index_version},
                                     u'name_1': {u'background': True,
                                                 u'key': [(u'name', 1)],
                                                 u'ns': u'arctic.library.snapshots',
                                                 u'unique': True,
                                                 u'v': index_version}}
    versions = c.arctic.library.versions.index_information()
    assert versions == {u'_id_': {u'key': [(u'_id', 1)],
                                           u'ns': u'arctic.library.versions',
                                           u'v': index_version},
                                 u'symbol_1__id_-1': {u'background': True,
                                                      u'key': [(u'symbol', 1), (u'_id', -1)],
                                                      u'ns': u'arctic.library.versions',
                                                      u'v': index_version},
                                 u'symbol_1_version_-1': {u'background': True,
                                                          u'key': [(u'symbol', 1), (u'version', -1)],
                                                          u'ns': u'arctic.library.versions',
                                                          u'unique': True,
                                                          u'v': index_version}}
    version_nums = c.arctic.library.version_nums.index_information()
    assert version_nums == {u'_id_': {u'key': [(u'_id', 1)],
                                               u'ns': u'arctic.library.version_nums',
                                               u'v': index_version},
                                     u'symbol_1': {u'background': True,
                                                   u'key': [(u'symbol', 1)],
                                                   u'ns': u'arctic.library.version_nums',
                                                   u'unique': True,
                                                   u'v': index_version}}


def test_delete_library(arctic, library, library_name):
    mongo = arctic._conn
    # create a library2 library too - ensure that this isn't deleted
    arctic.initialize_library('user.library2', VERSION_STORE, segment='month')
    library.write('asdf', get_large_ts(1))
    assert 'TEST' in mongo.arctic_test.list_collection_names()
    assert 'TEST.versions' in mongo.arctic_test.list_collection_names()
    assert 'library2' in mongo.arctic_user.list_collection_names()
    assert 'library2.versions' in mongo.arctic_user.list_collection_names()

    arctic.delete_library(library_name)
    assert 'TEST' not in mongo.arctic_user.list_collection_names()
    assert 'TEST.versions' not in mongo.arctic_user.list_collection_names()
    with pytest.raises(LibraryNotFoundException):
        arctic[library_name]
    with pytest.raises(LibraryNotFoundException):
        arctic['arctic_{}'.format(library_name)]
    assert 'library2' in mongo.arctic_user.list_collection_names()
    assert 'library2.versions' in mongo.arctic_user.list_collection_names()


def test_quota(arctic, library, library_name):
    thing = list(range(100))
    library._arctic_lib.set_quota(10)
    assert arctic.get_quota(library_name) == 10
    assert library._arctic_lib.get_quota() == 10
    library.write('thing', thing)
    with pytest.raises(QuotaExceededException):
        library.write('ts', thing)
        library.write('ts', thing)
        library.write('ts', thing)
        library.write('ts', thing)
    with pytest.raises(QuotaExceededException):
        arctic.check_quota(library_name)


def test_check_quota(arctic, library, library_name):
    with patch('arctic.arctic.logger.info') as info:
        arctic.check_quota(library_name)
    assert info.call_count == 1


def test_default_mongo_retry_timout():
    now = time.time()
    with pytest.raises(LibraryNotFoundException):
        Arctic('unresolved-host', serverSelectionTimeoutMS=0)['some.lib']
    assert time.time() - now < 1.


def test_lib_rename(arctic):
    arctic.initialize_library('test')
    l = arctic['test']
    l.write('test_data', 'abc')
    arctic.rename_library('test', 'new_name')
    l = arctic['new_name']
    assert(l.read('test_data').data == 'abc')
    with pytest.raises(LibraryNotFoundException) as e:
        l = arctic['test']
    assert('Library test' in str(e.value))
    assert('test' not in arctic.list_libraries())


def test_lib_rename_namespace(arctic):
    arctic.initialize_library('namespace.test')
    l = arctic['namespace.test']
    l.write('test_data', 'abc')

    with pytest.raises(ValueError) as e:
        arctic.rename_library('namespace.test', 'new_namespace.test')
    assert('Collection can only be renamed in the same database' in str(e.value))

    arctic.rename_library('namespace.test', 'namespace.newlib')
    l = arctic['namespace.newlib']
    assert(l.read('test_data').data == 'abc')

    with pytest.raises(LibraryNotFoundException) as e:
        l = arctic['namespace.test']
    assert('Library namespace.test' in str(e.value))
    assert('namespace.test' not in arctic.list_libraries())


def test_lib_type(arctic):
    arctic.initialize_library('test')
    assert(arctic.get_library_type('test') == VERSION_STORE)


def test_library_exists(arctic):
    arctic.initialize_library('test')
    assert arctic.library_exists('test')
    assert not arctic.library_exists('nonexistentlib')


def test_library_exists_no_auth(arctic):
    arctic.initialize_library('test')
    with patch('arctic.arctic.ArcticLibraryBinding') as AB:
        AB.return_value = MagicMock(
            get_library_type=MagicMock(side_effect=OperationFailure("not authorized on arctic to execute command")))
        assert arctic.library_exists('test')
        assert AB.return_value.get_library_type.called
        assert not arctic.library_exists('nonexistentlib')


def test_list_libraries_cached(arctic):
    # default in arctic is to cache list_libraries.
    libs = ['test1', 'test2']
    for lib in libs:
        arctic.initialize_library(lib)

    # Cached data should have been appended to cache.
    assert sorted(libs) == sorted(arctic.list_libraries()) == sorted(arctic._list_libraries())

    # Should default to uncached list_libraries if cache is empty.
    with patch('arctic.arctic.Arctic._list_libraries', return_value=libs) as uncached_list_libraries:
        # Empty cache manually.
        arctic._conn.meta_db.cache.remove({})
        assert arctic._list_libraries_cached() == libs
        uncached_list_libraries.assert_called()

    # Reload cache and check that it has data
    arctic.reload_cache()
    assert sorted(arctic._cache.get('list_libraries')) == sorted(libs)

    # Should fetch it from cache the second time.
    with patch('arctic.arctic.Arctic._list_libraries', return_value=libs) as uncached_list_libraries:
        assert arctic._list_libraries_cached() == libs
        uncached_list_libraries.assert_not_called()


def test_initialize_library_adds_to_cache(arctic):
    libs = ['test1', 'test2']

    for lib in libs:
        arctic.initialize_library(lib)

    arctic.reload_cache()
    assert arctic._list_libraries_cached() == arctic._list_libraries()

    # Add another lib
    arctic.initialize_library('test3')

    assert sorted(arctic._cache.get('list_libraries')) == ['test1', 'test2', 'test3']


def test_cache_does_not_return_stale_data(arctic):
    libs = ['test1', 'test2']

    for lib in libs:
        arctic.initialize_library(lib)

    arctic.reload_cache()
    assert arctic._list_libraries_cached() == arctic._list_libraries()

    time.sleep(0.2)

    # Should call uncached list_libraries if the data is stale according to caller.
    with patch('arctic.arctic.Arctic._list_libraries', return_value=libs) as uncached_list_libraries:
        assert arctic._list_libraries_cached(newer_than_secs=0.1) == libs
        uncached_list_libraries.assert_called()


def test_renaming_returns_new_name_in_cache(arctic):
    libs = ['test1', 'test2']

    for lib in libs:
        arctic.initialize_library(lib)

    assert arctic._list_libraries_cached() == arctic._list_libraries()

    arctic.rename_library('test1', 'test3')

    assert sorted(arctic._list_libraries_cached()) == sorted(['test2', 'test3'])


def test_deleting_library_removes_it_from_cache(arctic):
    libs = ['test1', 'test2']

    for lib in libs:
        arctic.initialize_library(lib)

    arctic.delete_library('test1')

    assert arctic._list_libraries_cached() == arctic._list_libraries() == arctic.list_libraries() == ['test2']


def test_disable_cache_by_settings(arctic):
    lib = 'test1'
    arctic.initialize_library(lib)

    # Should be enabled by default
    assert arctic._list_libraries_cached() == arctic._list_libraries()

    arctic._cache.set_caching_state(enabled=False)

    # Should not return cached results now.
    with patch('arctic.arctic.Arctic._list_libraries', return_value=[lib]) as uncached_list_libraries:
        with patch('arctic.arctic.Arctic._list_libraries_cached', return_value=[lib]) as cached_list_libraries:
            arctic.list_libraries()
            uncached_list_libraries.assert_called()
            cached_list_libraries.assert_not_called()

    arctic._cache.set_caching_state(enabled=True)

    # Should used cached data again.
    with patch('arctic.arctic.Arctic._list_libraries', return_value=[lib]) as uncached_list_libraries_e:
        with patch('arctic.arctic.Arctic._list_libraries_cached', return_value=[lib]) as cached_list_libraries_e:
            arctic.list_libraries()
            uncached_list_libraries_e.assert_not_called()
            cached_list_libraries_e.assert_called()