test_environ_aacgmv2

Complexity

Total Complexity

17

Size/Duplication

Total Lines	100
Duplicated Lines	0 %

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	TestPyEnviron.test_top_parameters_set_same()	0	17	1
A	TestPyEnviron.teardown()	0	2	1
A	TestPyEnviron.test_good_coeff()	0	15	5
A	TestPyEnviron.reset_evar()	0	9	4
A	TestPyEnviron.test_bad_coeff()	0	5	2
A	TestPyEnviron.setup()	0	5	1
A	TestPyEnviron.test_top_parameters_reset_evar_to_specified()	0	17	2
A	TestPyEnviron.test_top_parameters_default()	0	12	1

# -*- coding: utf-8 -*-
from __future__ import division, absolute_import, unicode_literals

import os
import sys
import pytest


@pytest.mark.xfail
class TestPyEnviron:
    def setup(self):
        self.igrf_path = os.path.join("aacgmv2", "aacgmv2",
                                      "magmodel_1590-2020.txt")
        self.aacgm_path = os.path.join("aacgmv2", "aacgmv2", "aacgm_coeffs",
                                       "aacgm_coeffs-13-")

    def teardown(self):
        del self.igrf_path, self.aacgm_path

    def reset_evar(self, evar):
        """ Reset the environment variables """

        for coeff_key in evar:
            if coeff_key in os.environ.keys():
                del os.environ[coeff_key]

        for coeff_key in evar:
            assert coeff_key not in os.environ.keys()

    def test_good_coeff(self, aacgm_test=None, igrf_test=None):
        """ Test the coefficient path/prefixes """

        # Set the defaults
        if aacgm_test is None:
            aacgm_test = self.aacgm_path
        if igrf_test is None:
            igrf_test = self.igrf_path

        # Perform the test
        if aacgm_test.find(self.aacgm_path) < 0:
            raise AssertionError('BAD AACGMV PATH')

        if igrf_test.find(self.igrf_path) < 0:
            raise AssertionError('BAD IGRF PATH')

    @pytest.mark.parametrize("coeff", [("aacgm_test"), ("igrf_test")])
    def test_bad_coeff(self, coeff):
        """ Test the failure of the class routine 'test_good_coeff'"""
        with pytest.raises(AssertionError, match="BAD"):
            self.test_good_coeff(**{coeff: "bad path"})

    def test_top_parameters_default(self):
        """Test default module coefficients"""

        # Import AACGMV2 after removing any possible preset env variables
        self.reset_evar(evar=['AACGM_v2_DAT_PREFIX', 'IGRF_COEFFS'])
        import aacgmv2

        self.test_good_coeff(aacgmv2.AACGM_v2_DAT_PREFIX, aacgmv2.IGRF_COEFFS)

        assert not aacgmv2.__reset_warn__
        del sys.modules["aacgmv2"]
        del aacgmv2

    @pytest.mark.parametrize("evars", [(["AACGM_v2_DAT_PREFIX"]),
                                       (["AACGM_v2_DAT_PREFIX", "IGRF_COEFFS"]),
                                       (["IGRF_COEFFS"])])
    def test_top_parameters_reset_evar_to_specified(self, evars):
        """Test module reset of AACGM environment variables"""

        self.reset_evar(evar=evars)
        for i, evar in enumerate(evars):
            os.environ[evar] = 'test_prefix{:d}'.format(i)

        import aacgmv2

        self.test_good_coeff(aacgmv2.AACGM_v2_DAT_PREFIX, aacgmv2.IGRF_COEFFS)

        assert aacgmv2.__reset_warn__
        del sys.modules["aacgmv2"]
        del aacgmv2

    def test_top_parameters_set_same(self):
        """Test module non-reset with outside def of both coefficient paths"""

        from aacgmv2 import __file__ as file_path

        coeff_path = os.path.realpath(os.path.dirname(file_path))
        os.environ['AACGM_v2_DAT_PREFIX'] = os.path.join(coeff_path,
                                                         self.aacgm_path)
        os.environ['IGRF_COEFFS'] = os.path.join(coeff_path, self.igrf_path)

        import aacgmv2

        self.test_good_coeff(aacgmv2.AACGM_v2_DAT_PREFIX, aacgmv2.IGRF_COEFFS)

        assert not aacgmv2.__reset_warn__
        del sys.modules["aacgmv2"]
        del aacgmv2