Source code for allensdk.test_utilities.temp_dir

# Allen Institute Software License - This software license is the 2-clause BSD
# license plus a third clause that prohibits redistribution for commercial
# purposes without further permission.
#
# Copyright 2017. Allen Institute. All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain the above copyright notice,
# this list of conditions and the following disclaimer.
#
# 2. Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions and the following disclaimer in the documentation
# and/or other materials provided with the distribution.
#
# 3. Redistributions for commercial purposes are not permitted without the
# Allen Institute's written permission.
# For purposes of this license, commercial purposes is the incorporation of the
# Allen Institute's software into anything for which you will charge fees or
# other compensation. Contact terms@alleninstitute.org for commercial licensing
# opportunities.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
#
import os
import shutil
import warnings

import numpy as np


# Intended as a fixture. Used in conftest.py.
def temp_dir(request):

    tmpfs = os.path.normpath(os.path.join('/', 'dev', 'shm'))
    # would like to check mount type, but that requires system calls
    if os.path.exists(tmpfs) and os.path.ismount(tmpfs):

        base_path = tmpfs

    else:

        base_path = os.path.dirname(__file__)

    fls = os.listdir(base_path)
    while True:
        dname = ''.join(map(str, np.random.randint(0, 10, 6)))
        if "allensdk_test_{}".format(dname) not in fls:
            break

    specific_path = os.path.join(base_path, 'allensdk_test_' + dname)
    os.makedirs(specific_path)

    def fin():
        shutil.rmtree(specific_path)
        if os.path.exists(specific_path):
            warnings.warn('test dir {0} still exists!', UserWarning)

    request.addfinalizer(fin)

    return specific_path