from __future__ import print_function

from helpers.mgnt_utilities import almost_equal, is_string
from tests.mgnt_get_poly_from_epics import GetPolyFromEPICS
from tests.mgnt_get_poly_from_oracle import GetPolyFromOracle
from .mgnt_auto_checkout_test import AutoCheckoutTest


class TrimEnabledTest(AutoCheckoutTest):
    test_id = 'trim_enabled'
    description = 'Trim enabled'
    read_only = True
    deferred = False

    def __init__(self):
        super(TrimEnabledTest, self).__init__(
            pre_checkout_routines=[GetPolyFromOracle, GetPolyFromEPICS]
        )

    def execute(self, magnet):
        """Ensures that trim is correctly disabled or enabled for a magnet.

        1. Attempt to `caget <magnet>:TRIMDISABLE`.
        2. FAIL if `caget` times out.
        3. FAIL if ramp rate is `0` when `TRIMDISABLE` is `0` or ramp rate is nonzero when `TRIMDISABLE` is `1`.
        4. If trim is enabled:
            a. Attempt to `caget <magnet>:TRIMRAMPRATE` and `TRIMSETL`.
            b. Make sure that the Oracle and EPICS values match to 6 decimal places (mantissa only).
            c. PASS if values match, otherwise FAIL and print the first mismatch.
        5. Report "Disabled" and PASS.

        Args:
            magnet (dict): Information about a magnet from Oracle (Elements, Polynomial, Additional Data)

        Returns:
            None

        """
        # Check if trim is enabled
        oracle_data = GetPolyFromOracle().data[magnet['element']]
        epics_data = GetPolyFromEPICS().data[magnet['element']]
        trim_disable_pv = magnet['device'] + ':TRIMDISABLE'
        trim_disable_epics = epics_data['TRIMDISABLE']
        trim_ramp_rate_oracle = oracle_data['trimramprate']
        if trim_disable_epics is None:
            self.data = '{} not found'.format(trim_disable_pv)
            self.status = False
            print('FAIL')

        elif (not is_string(magnet) and magnet['psc_type'] != 'SERIAL') and (
                trim_disable_epics and trim_ramp_rate_oracle > 0):
            self.data = 'Ramp rate is {} > 0 but {} is {}'.format(trim_ramp_rate_oracle, trim_disable_pv,
                                                                  trim_disable_epics)
            self.status = False
            print('FAIL')

        elif not trim_disable_epics:
            if not trim_ramp_rate_oracle:
                self.data = 'Ramp rate {} but {} is {}'.format(trim_ramp_rate_oracle, trim_disable_pv,
                                                               trim_disable_epics)
                self.status = False
                print('FAIL')

            else:
                # Check ramp rate and settle time
                fields = ['TRIMRAMPRATE', 'TRIMSETL']
                detail_lines = ['Enabled']
                for field in fields:
                    pv = '{}:{}'.format(magnet['device'], field)
                    oracle_value = oracle_data[field.lower()]
                    epics_value = epics_data[field]
                    if not almost_equal(oracle_value, epics_value):
                        self.data = '{} = {} in EPICS but should be {} according to polynomial database'.format(pv,
                                                                                                                epics_value,
                                                                                                                oracle_value)
                        self.status = False
                        print('FAIL')
                        return

                    else:
                        detail_lines.append('{} = {}'.format(field, epics_value))
                        self.data = '\n'.join(detail_lines)
                        self.status = True
                        print('PASS')

        else:
            self.data = 'Disabled'
            self.status = True
            print('PASS')
