lib/tests/events.py

#!/usr/bin/env python3

#    Kosmorrolib - The Library To Compute Your Ephemerides
#    Copyright (C) 2021  Jérôme Deuchnord <jerome@deuchnord.fr>
#
#    This program is free software: you can redistribute it and/or modify
#    it under the terms of the GNU Affero General Public License as
#    published by the Free Software Foundation, either version 3 of the
#    License, or (at your option) any later version.
#
#    This program is distributed in the hope that it will be useful,
#    but WITHOUT ANY WARRANTY; without even the implied warranty of
#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#    GNU Affero General Public License for more details.
#
#    You should have received a copy of the GNU Affero General Public License
#    along with this program.  If not, see <https://www.gnu.org/licenses/>.

import unittest

from datetime import date, datetime
from parameterized import parameterized

from kosmorrolib import events
from kosmorrolib.model import Event, ASTERS
from kosmorrolib.enum import EventType
from kosmorrolib.exceptions import OutOfRangeDateError

EXPECTED_EVENTS = [
    (date(2020, 2, 7), []),
    (
        date(2020, 10, 13),
        [Event(EventType.OPPOSITION, [ASTERS[4]], datetime(2020, 10, 13, 23, 25))],
    ),
    (
        date(2022, 12, 8),
        [
            Event(
                EventType.CONJUNCTION,
                [ASTERS[1], ASTERS[4]],
                datetime(2022, 12, 8, 4, 18),
            ),
            Event(EventType.OPPOSITION, [ASTERS[4]], datetime(2022, 12, 8, 5, 41)),
        ],
    ),
    (
        date(2025, 1, 16),
        [Event(EventType.OPPOSITION, [ASTERS[4]], datetime(2025, 1, 16, 2, 38))],
    ),
    (
        date(2027, 2, 19),
        [
            Event(EventType.MOON_PERIGEE, [ASTERS[1]], datetime(2027, 2, 19, 7, 38)),
            Event(EventType.OPPOSITION, [ASTERS[4]], datetime(2027, 2, 19, 15, 50)),
        ],
    ),
    (
        date(2020, 1, 2),
        [
            Event(EventType.MOON_APOGEE, [ASTERS[1]], datetime(2020, 1, 2, 1, 32)),
            Event(
                EventType.CONJUNCTION,
                [ASTERS[2], ASTERS[5]],
                datetime(2020, 1, 2, 16, 41),
            ),
        ],
    ),
    (
        date(2020, 1, 12),
        [
            Event(
                EventType.CONJUNCTION,
                [ASTERS[2], ASTERS[6]],
                datetime(2020, 1, 12, 9, 51),
            ),
            Event(
                EventType.CONJUNCTION,
                [ASTERS[2], ASTERS[9]],
                datetime(2020, 1, 12, 10, 13),
            ),
            Event(
                EventType.CONJUNCTION,
                [ASTERS[6], ASTERS[9]],
                datetime(2020, 1, 12, 16, 57),
            ),
        ],
    ),
    (
        date(2020, 2, 10),
        [
            Event(
                EventType.MAXIMAL_ELONGATION,
                [ASTERS[2]],
                datetime(2020, 2, 10, 13, 46),
                details={"deg": 18.2},
            ),
            Event(EventType.MOON_PERIGEE, [ASTERS[1]], datetime(2020, 2, 10, 20, 34)),
        ],
    ),
    (
        date(2020, 3, 24),
        [
            Event(
                EventType.MAXIMAL_ELONGATION,
                [ASTERS[2]],
                datetime(2020, 3, 24, 1, 56),
                details={"deg": 27.8},
            ),
            Event(EventType.MOON_APOGEE, [ASTERS[1]], datetime(2020, 3, 24, 15, 39)),
            Event(
                EventType.MAXIMAL_ELONGATION,
                [ASTERS[3]],
                datetime(2020, 3, 24, 21, 58),
                details={"deg": 46.1},
            ),
        ],
    ),
    (
        date(2005, 6, 16),
        [
            Event(
                EventType.OCCULTATION,
                [ASTERS[1], ASTERS[5]],
                datetime(2005, 6, 16, 6, 31),
            )
        ],
    ),
    (
        date(2020, 4, 7),
        [Event(EventType.MOON_PERIGEE, [ASTERS[1]], datetime(2020, 4, 7, 18, 14))],
    ),
    (
        date(2020, 1, 29),
        [Event(EventType.MOON_APOGEE, [ASTERS[1]], datetime(2020, 1, 29, 21, 32))],
    ),
]


class EventTestCase(unittest.TestCase):
    def setUp(self) -> None:
        self.maxDiff = None

    @parameterized.expand(EXPECTED_EVENTS)
    def test_search_events(self, d: date, expected_events: [Event]):
        actual_events = events.get_events(d)
        self.assertEqual(
            len(expected_events),
            len(actual_events),
            "Expected %d elements, got %d for date %s.\n%s"
            % (len(expected_events), len(actual_events), d.isoformat(), actual_events),
        )

        for i, expected_event in enumerate(expected_events):
            actual_event = actual_events[i]
            # Remove unnecessary precision (seconds and microseconds)
            actual_event.start_time = datetime(
                actual_event.start_time.year,
                actual_event.start_time.month,
                actual_event.start_time.day,
                actual_event.start_time.hour,
                actual_event.start_time.minute,
            )

            self.assertEqual(expected_event.__dict__, actual_event.__dict__)

    def test_get_events_raises_exception_on_out_of_date_range(self):
        with self.assertRaises(OutOfRangeDateError):
            events.get_events(date(1789, 5, 5))


if __name__ == "__main__":
    unittest.main()