from __future__ import print_function

import epics.ca

from .mgnt_auto_checkout_test import AutoCheckoutTest


class InServiceTest(AutoCheckoutTest):
    test_id = 'in_service'
    description = 'In service'
    read_only = True
    deferred = False

    def __init__(self):
        super(InServiceTest, self).__init__(
            pre_checkout_routines=[]
        )

    def execute(self, magnet):
        """Ensures that a magnet is in service.

        1. Attempt to `caget <magnet>:OUTOFSERVICE`.
        2. FAIL if `caget` times out or `OUTOFSERVICE` is `Out-of-Service`, otherwise PASS.

        Args:
            magnet (dict): Information about a magnet from Oracle (Elements, Polynomial, Additional Data)

        Returns:
            None

        """
        # Check if in service
        out_of_service_pv = '{}:OUTOFSERVICE'.format(magnet['device'])
        out_of_service = epics.caget(out_of_service_pv, as_string=True)
        if out_of_service is None:
            self.data = '{} not found'.format(out_of_service_pv)
            self.status = False
            print('FAIL')
            return

        if out_of_service == 'Out-of-Service':
            self.data = out_of_service
            self.status = False
            print('FAIL')

        else:
            self.data = out_of_service
            self.status = True
            print('PASS')
