File with fixture to run tests.

"""

A module defining a list of fixture functions.

"""

from __future__ import absolute_import

import mock

import pytest

import importlib

import tango

from tango import DeviceProxy

from tango.test_context import DeviceTestContext

@pytest.fixture(scope="session", autouse=True)

def tango_context(request):

    """Creates and returns a TANGO DeviceTestContext object.

    Parameters

    ----------

    request: _pytest.fixtures.SubRequest

        A request object gives access to the requesting test context.

    """

    # TODO: package_name and class_name can be used in future

    # fq_test_class_name = request.cls.__module__

    # fq_test_class_name_details = fq_test_class_name.split(".")

    # package_name = fq_test_class_name_details[1]

    # class_name = module_name = fq_test_class_name_details[1]

    module = importlib.import_module("{}.{}".format("csp_lmc_common", "CspMaster"))

    klass = getattr(module, "CspMaster")

    properties = {'SkaLevel': '2', 

                  'CspCbf': 'mid_csp_cbf/sub_elt/master',

                  'CspPss': 'mid_csp_pss/sub_elt/master',

                  'CspPst': 'mid_csp_pst/sub_elt/master',

                  }

    tango_context = DeviceTestContext(klass, properties=properties, process=False)

    tango_context.start()

    klass.get_name = mock.Mock(side_effect=tango_context.get_device_access)

    yield tango_context

    tango_context.stop()

@pytest.fixture(scope="function")

def initialize_device(tango_context):

    """Re-initializes the device.

    Parameters

    ----------

    tango_context: tango.test_context.DeviceTestContext

        Context to run a device without a database.

    """

    yield tango_context.device.Init()

@pytest.fixture(scope="class")

def cbf_master():

    """Create DeviceProxy for the CspMaster device

       to test the device with the TANGO DB

    """

    database = tango.Database()

    instance_list = database.get_device_exported_for_class('CbfMaster')

    for instance in instance_list.value_string:

        try:

            return tango.DeviceProxy(instance)

        except tango.DevFailed:

            continue