Skip to content

armgit / fli

Public Imported from GitHub
0

Google Flights MCP, CLI and Python Library

19.6 KB
Raw Blame
from datetime import datetime, timedelta
from io import StringIO
from unittest.mock import MagicMock, patch

import pytest
from rich.console import Console
from typer import BadParameter

from fli.cli.enums import DayOfWeek
from fli.cli.utils import (
    build_json_success_response,
    display_date_results,
    display_flight_results,
    filter_dates_by_days,
    filter_flights_by_airlines,
    filter_flights_by_time,
    parse_airlines,
    parse_stops,
    serialize_date_result,
    serialize_flight_result,
    validate_date,
    validate_time_range,
)
from fli.models import Airline, Airport, FlightLeg, FlightResult, MaxStops, TripType
from fli.search.dates import DatePrice


@pytest.fixture
def mock_context():
    """Mock click Context."""
    return MagicMock()


@pytest.fixture
def mock_param():
    """Mock click Parameter."""
    return MagicMock()


def test_validate_date_valid(mock_context, mock_param):
    """Test date validation with valid date."""
    date = "2024-12-25"
    result = validate_date(mock_context, mock_param, date)
    assert result == date


def test_validate_date_single_digit(mock_context, mock_param):
    """Test date validation normalizes single-digit month and day."""
    assert validate_date(mock_context, mock_param, "2027-4-2") == "2027-04-02"
    assert validate_date(mock_context, mock_param, "2027-12-5") == "2027-12-05"
    assert validate_date(mock_context, mock_param, "2027-1-15") == "2027-01-15"


def test_validate_date_invalid(mock_context, mock_param):
    """Test date validation with invalid date."""
    with pytest.raises(BadParameter):
        validate_date(mock_context, mock_param, "2024-13-45")


def test_validate_time_range_valid(mock_context, mock_param):
    """Test time range validation with valid range."""
    time_range = "6-20"
    result = validate_time_range(mock_context, mock_param, time_range)
    assert result == (6, 20)


def test_validate_time_range_invalid(mock_context, mock_param):
    """Test time range validation with invalid range."""
    with pytest.raises(BadParameter):
        validate_time_range(mock_context, mock_param, "25-30")


def test_validate_time_range_none(mock_context, mock_param):
    """Test time range validation with None value."""
    result = validate_time_range(mock_context, mock_param, None)
    assert result is None


def test_parse_stops_numeric():
    """Test parsing stops with numeric values."""
    assert parse_stops("0") == MaxStops.NON_STOP
    assert parse_stops("1") == MaxStops.ONE_STOP_OR_FEWER
    assert parse_stops("2") == MaxStops.TWO_OR_FEWER_STOPS


def test_parse_stops_string():
    """Test parsing stops with string values."""
    assert parse_stops("NON_STOP") == MaxStops.NON_STOP
    assert parse_stops("ANY") == MaxStops.ANY


def test_parse_stops_invalid():
    """Test parsing stops with invalid value."""
    with pytest.raises(BadParameter):
        parse_stops("INVALID")


def test_parse_airlines_valid():
    """Test parsing airlines with valid codes."""
    result = parse_airlines(["DL", "UA"])
    assert len(result) == 2
    assert Airline.DL in result
    assert Airline.UA in result


def test_parse_airlines_none():
    """Test parsing airlines with None value."""
    result = parse_airlines(None)
    assert result is None


def test_parse_airlines_numeric_prefix():
    """Test that airline codes starting with a digit are resolved correctly."""
    result = parse_airlines(["3F"])
    assert result == [Airline._3F]


def test_parse_airlines_invalid():
    """Test parsing airlines with invalid code."""
    with pytest.raises(BadParameter):
        parse_airlines(["INVALID"])


def test_filter_flights_by_time():
    """Test filtering flights by time range."""
    now = datetime.now().replace(hour=10)  # Set to 10 AM
    flights = [
        FlightResult(
            price=100,
            duration=120,
            stops=0,
            legs=[
                FlightLeg(
                    airline=Airline.DL,
                    flight_number="DL123",
                    departure_airport=Airport.JFK,
                    arrival_airport=Airport.LAX,
                    departure_datetime=now,
                    arrival_datetime=now + timedelta(hours=2),
                    duration=120,
                )
            ],
        )
    ]

    # Flight should be included (within range)
    result = filter_flights_by_time(flights, 8, 12)
    assert len(result) == 1

    # Flight should be excluded (outside range)
    result = filter_flights_by_time(flights, 12, 14)
    assert len(result) == 0


def test_filter_flights_by_airlines():
    """Test filtering flights by airlines."""
    now = datetime.now()
    flights = [
        FlightResult(
            price=100,
            duration=120,
            stops=0,
            legs=[
                FlightLeg(
                    airline=Airline.DL,
                    flight_number="DL123",
                    departure_airport=Airport.JFK,
                    arrival_airport=Airport.LAX,
                    departure_datetime=now,
                    arrival_datetime=now + timedelta(hours=2),
                    duration=120,
                )
            ],
        )
    ]

    # Flight should be included (matching airline)
    result = filter_flights_by_airlines(flights, [Airline.DL])
    assert len(result) == 1

    # Flight should be excluded (non-matching airline)
    result = filter_flights_by_airlines(flights, [Airline.UA])
    assert len(result) == 0


def test_filter_dates_by_days():
    """Test filtering dates by days of the week."""
    # Create a date that falls on a Monday
    monday_date = datetime(2024, 1, 1)  # January 1, 2024 was a Monday
    dates = [
        DatePrice(date=(monday_date,), price=100),
        DatePrice(date=(monday_date.replace(day=2),), price=200),  # Tuesday
    ]

    # Filter for Monday only
    result = filter_dates_by_days(dates, [DayOfWeek.MONDAY], TripType.ONE_WAY)
    assert len(result) == 1
    assert result[0].date[0] == monday_date

    # Filter for Tuesday only
    result = filter_dates_by_days(dates, [DayOfWeek.TUESDAY], TripType.ONE_WAY)
    assert len(result) == 1
    assert result[0].date[0] == monday_date.replace(day=2)

    # No day filters should return all dates
    result = filter_dates_by_days(dates, [], TripType.ONE_WAY)
    assert len(result) == 2


# ---------------------------------------------------------------------------
# display_flight_results — round-trip price must not be doubled
# ---------------------------------------------------------------------------


def _make_flight_result(
    price: float, airline=Airline.DL, flight_number="DL123", currency: str | None = "USD"
) -> FlightResult:
    """Create a FlightResult for testing display."""
    now = datetime.now()
    return FlightResult(
        price=price,
        currency=currency,
        duration=300,
        stops=0,
        legs=[
            FlightLeg(
                airline=airline,
                flight_number=flight_number,
                departure_airport=Airport.JFK,
                arrival_airport=Airport.LAX,
                departure_datetime=now,
                arrival_datetime=now + timedelta(hours=5),
                duration=300,
            )
        ],
    )


def _capture_display(flights: list, trip_type: TripType = TripType.ONE_WAY) -> str:
    """Run display_flight_results and capture the rendered text."""
    buf = StringIO()
    test_console = Console(file=buf, width=120, force_terminal=True)
    with patch("fli.cli.utils.console", test_console):
        display_flight_results(flights, trip_type=trip_type)
    return buf.getvalue()


def _capture_date_display(dates: list, trip_type: TripType) -> str:
    """Run display_date_results and capture the rendered text."""
    buf = StringIO()
    test_console = Console(file=buf, width=120, force_terminal=True)
    with patch("fli.cli.utils.console", test_console):
        display_date_results(dates, trip_type)
    return buf.getvalue()


def test_display_one_way_price():
    """One-way flight should display the flight price as-is."""
    output = _capture_display([_make_flight_result(price=159.0)])
    assert "$159.00" in output


def test_display_round_trip_price_not_doubled():
    """Round-trip display must use outbound price only (Google returns full RT price per leg)."""
    outbound = _make_flight_result(price=317.0, flight_number="DL100")
    return_flight = _make_flight_result(price=317.0, airline=Airline.DL, flight_number="DL200")

    output = _capture_display([(outbound, return_flight)])

    assert "$317.00" in output
    assert "$634.00" not in output


def test_display_multi_city_three_legs():
    """Multi-city (3+ legs) should render without errors, showing final-leg price."""
    leg1 = _make_flight_result(price=0.0, flight_number="AA100")
    leg2 = _make_flight_result(price=0.0, flight_number="DL200")
    leg3 = _make_flight_result(price=800.0, flight_number="UA300")

    output = _capture_display([(leg1, leg2, leg3)], trip_type=TripType.MULTI_CITY)

    assert "$800.00" in output
    assert "Multi-city Flight" in output
    assert "Leg 1" in output
    assert "Leg 2" in output
    assert "Leg 3" in output


def test_display_round_trip_price_asymmetric():
    """When leg prices differ, total should be the outbound price, not the sum."""
    outbound = _make_flight_result(price=400.0)
    return_flight = _make_flight_result(price=350.0)

    output = _capture_display([(outbound, return_flight)])

    assert "$400.00" in output
    assert "$750.00" not in output


def test_display_flight_results_shows_booking_url_footer():
    """A booking_url is rendered as a clickable footer below the options."""
    buf = StringIO()
    test_console = Console(file=buf, width=120, force_terminal=True)
    url = "https://www.google.com/travel/flights?q=Flights%20from%20JFK%20to%20LHR"
    with patch("fli.cli.utils.console", test_console):
        display_flight_results(
            [_make_flight_result(price=159.0)],
            trip_type=TripType.ONE_WAY,
            booking_url=url,
        )
    output = buf.getvalue()
    assert "Open on Google Flights" in output
    assert "travel/flights" in output


def test_display_flight_results_no_footer_without_booking_url():
    """No booking footer is shown when booking_url is omitted."""
    output = _capture_display([_make_flight_result(price=159.0)])
    assert "Open on Google Flights" not in output


def test_display_date_results_links_dates_when_route_given():
    """Departure dates become Google Flights hyperlinks when a route is supplied."""
    buf = StringIO()
    test_console = Console(file=buf, width=120, force_terminal=True)
    dates = [DatePrice(date=(datetime(2026, 7, 15),), price=299.0, currency="USD")]
    with patch("fli.cli.utils.console", test_console):
        display_date_results(
            dates,
            TripType.ONE_WAY,
            origin="JFK",
            destination="LHR",
            currency="USD",
        )
    output = buf.getvalue()
    # Rich emits OSC-8 hyperlink escape sequences carrying the URL on a terminal.
    assert "travel/flights" in output


def test_display_one_way_price_uses_returned_currency():
    """One-way flight should use the returned currency code for formatting."""
    output = _capture_display([_make_flight_result(price=159.0, currency="HKD")])
    assert "HK$159.00" in output


def test_display_date_results_uses_returned_currency():
    """Date results should render prices using the returned currency."""
    output = _capture_date_display(
        [DatePrice(date=(datetime(2026, 5, 1),), price=118.0, currency="EUR")],
        TripType.ONE_WAY,
    )
    assert "€118.00" in output


def test_serialize_airline_strips_numeric_prefix():
    """Numeric-prefix airline codes should not include the underscore in output."""
    from fli.cli.utils import serialize_airline

    result = serialize_airline(Airline._3F)
    assert result == {"code": "3F", "name": "FlyOne Armenia"}


def test_serialize_airline_normal_code():
    """Normal airline codes should serialize unchanged."""
    from fli.cli.utils import serialize_airline

    result = serialize_airline(Airline.BA)
    assert result == {"code": "BA", "name": "British Airways"}


def test_serialize_flight_result_one_way():
    """JSON flight serialization should use machine-readable nested fields."""
    flight = _make_flight_result(price=159.0)

    payload = serialize_flight_result(flight)

    assert payload["price"] == 159.0
    assert payload["currency"] == "USD"
    assert payload["legs"][0]["departure_airport"]["code"] == "JFK"
    assert payload["legs"][0]["airline"]["code"] == "DL"


def test_serialize_flight_result_numeric_prefix_airline():
    """Numeric-prefix airline codes in flight legs should not have underscore."""
    flight = _make_flight_result(price=200.0, airline=Airline._3F, flight_number="3F101")

    payload = serialize_flight_result(flight)

    assert payload["legs"][0]["airline"]["code"] == "3F"
    assert payload["legs"][0]["airline"]["name"] == "FlyOne Armenia"


def test_serialize_flight_result_round_trip():
    """Round-trip JSON serialization should expose outbound and return segments."""
    outbound = _make_flight_result(price=317.0, flight_number="DL100")
    return_flight = _make_flight_result(price=317.0, flight_number="DL200")

    payload = serialize_flight_result((outbound, return_flight))

    assert payload["price"] == 317.0
    assert payload["currency"] == "USD"
    assert payload["outbound"]["legs"][0]["flight_number"] == "DL100"
    assert payload["return"]["legs"][0]["flight_number"] == "DL200"


def test_serialize_flight_result_multi_city():
    """Multi-city (3+ legs) JSON serialization should not crash."""
    leg1 = _make_flight_result(price=0.0, flight_number="AA100")
    leg2 = _make_flight_result(price=0.0, flight_number="DL200")
    leg3 = _make_flight_result(price=800.0, flight_number="UA300")

    payload = serialize_flight_result((leg1, leg2, leg3))

    # Price comes from the final leg for multi-city
    assert payload["price"] == 800.0
    assert payload["currency"] == "USD"
    assert payload["duration"] == 900  # 300 * 3
    assert payload["stops"] == 0
    assert len(payload["segments"]) == 3
    assert payload["segments"][0]["legs"][0]["flight_number"] == "AA100"
    assert payload["segments"][1]["legs"][0]["flight_number"] == "DL200"
    assert payload["segments"][2]["legs"][0]["flight_number"] == "UA300"


def test_serialize_date_result_round_trip():
    """Date serialization should include the return date for round-trip searches."""
    result = DatePrice(
        date=(datetime(2026, 5, 1), datetime(2026, 5, 8)),
        price=599.98,
    )

    payload = serialize_date_result(result, TripType.ROUND_TRIP)

    assert payload == {
        "departure_date": "2026-05-01",
        "return_date": "2026-05-08",
        "price": 599.98,
        "currency": "USD",
    }


def test_serialize_date_result_no_booking_url_without_route():
    """Without origin/destination, no booking_url is added (back-compat shape)."""
    result = DatePrice(date=(datetime(2026, 5, 1),), price=199.0)

    payload = serialize_date_result(result, TripType.ONE_WAY)

    assert "booking_url" not in payload


def test_serialize_date_result_includes_booking_url_one_way():
    """A route yields a per-date Google Flights deep link for one-way searches."""
    result = DatePrice(date=(datetime(2026, 5, 1),), price=199.0)

    payload = serialize_date_result(
        result,
        TripType.ONE_WAY,
        origin="JFK",
        destination="LHR",
        currency="USD",
    )

    url = payload["booking_url"]
    assert url.startswith("https://www.google.com/travel/flights?q=")
    assert "JFK" in url
    assert "LHR" in url
    assert "2026-05-01" in url


def test_serialize_date_result_booking_url_round_trip_has_return():
    """Round-trip date links embed the return date too."""
    result = DatePrice(date=(datetime(2026, 5, 1), datetime(2026, 5, 8)), price=599.0)

    payload = serialize_date_result(
        result,
        TripType.ROUND_TRIP,
        origin="JFK",
        destination="LHR",
    )

    assert "2026-05-01" in payload["booking_url"]
    assert "2026-05-08" in payload["booking_url"]


def test_build_json_success_response_includes_booking_url():
    """booking_url is added to the success payload when provided."""
    payload = build_json_success_response(
        search_type="flights",
        trip_type=TripType.ONE_WAY,
        query={},
        results_key="flights",
        results=[],
        booking_url="https://www.google.com/travel/flights?q=x",
    )

    assert payload["booking_url"] == "https://www.google.com/travel/flights?q=x"


def test_build_json_success_response_omits_booking_url_when_none():
    """No booking_url key when not provided."""
    payload = build_json_success_response(
        search_type="flights",
        trip_type=TripType.ONE_WAY,
        query={},
        results_key="flights",
        results=[],
    )

    assert "booking_url" not in payload


def test_serialize_flight_result_uses_returned_currency():
    """JSON flight serialization should preserve the parsed result currency."""
    flight = _make_flight_result(price=159.0, currency="SEK")

    payload = serialize_flight_result(flight)

    assert payload["currency"] == "SEK"


def test_serialize_flight_result_round_trip_uses_returned_currency():
    """Round-trip JSON serialization should preserve the parsed result currency."""
    outbound = _make_flight_result(price=2534.0, currency="SEK", flight_number="SK101")
    return_flight = _make_flight_result(price=2534.0, currency="SEK", flight_number="SK202")

    payload = serialize_flight_result((outbound, return_flight))

    assert payload["currency"] == "SEK"


def test_serialize_date_result_uses_returned_currency():
    """JSON date serialization should preserve the parsed result currency."""
    result = DatePrice(
        date=(datetime(2026, 5, 1),),
        price=118.0,
        currency="SEK",
    )

    payload = serialize_date_result(result, TripType.ONE_WAY)

    assert payload["currency"] == "SEK"


def test_serialize_flight_result_fallback_currency_override():
    """Fallback currency should use the provided default when Google returns None."""
    flight = _make_flight_result(price=117.0, currency=None)

    payload = serialize_flight_result(flight, default_currency="CAD")

    assert payload["currency"] == "CAD"


def test_serialize_flight_result_round_trip_fallback_currency_override():
    """Round-trip fallback currency should use the provided default."""
    outbound = _make_flight_result(price=250.0, currency=None, flight_number="AC100")
    return_flight = _make_flight_result(price=250.0, currency=None, flight_number="AC200")

    payload = serialize_flight_result((outbound, return_flight), default_currency="CAD")

    assert payload["currency"] == "CAD"


def test_serialize_date_result_fallback_currency_override():
    """Date serialization fallback currency should use the provided default."""
    result = DatePrice(
        date=(datetime(2026, 5, 1),),
        price=117.0,
    )

    payload = serialize_date_result(result, TripType.ONE_WAY, default_currency="CAD")

    assert payload["currency"] == "CAD"


def test_serialize_flight_result_extracted_currency_takes_precedence():
    """Extracted currency from Google should take precedence over default_currency."""
    flight = _make_flight_result(price=117.0, currency="GBP")

    payload = serialize_flight_result(flight, default_currency="CAD")

    assert payload["currency"] == "GBP"


def test_format_airport_does_not_repeat_the_disambiguation_code():
    """Disambiguated names (e.g. "Naha Airport (OKA)") must not render the code twice."""
    from fli.cli.utils import format_airport
    from fli.models import Airport

    assert format_airport(Airport.OKA) == "OKA (Naha Airport)"
    assert format_airport(Airport.JFK).startswith("JFK (John F Kennedy")