1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418
|
"""Define tests for the client."""
import logging
from datetime import date
from typing import Any
from unittest.mock import Mock
import aiohttp
import pytest
from aresponses import ResponsesMockServer
from freezegun import freeze_time
from aioridwell import async_get_client
from aioridwell.errors import RidwellError
from aioridwell.model import EventState, PickupCategory
@pytest.mark.asyncio
async def test_get_accounts(
aresponses: ResponsesMockServer,
authenticated_ridwell_api_server: ResponsesMockServer,
user_response: dict[str, Any],
) -> None:
"""Test getting all accounts associated with a client.
Args:
aresponses: An aresponses server.
authenticated_ridwell_api_server: A mocked authenticated Ridwell API server.
user_response: An API response payload.
"""
async with authenticated_ridwell_api_server:
authenticated_ridwell_api_server.add(
"api.ridwell.com",
"/",
"post",
response=aiohttp.web_response.json_response(user_response, status=200),
)
async with aiohttp.ClientSession() as session:
client = await async_get_client("user", "password", session=session)
assert client.user_id == "userId1"
accounts = await client.async_get_accounts()
assert len(accounts) == 1
account = accounts["accountId1"]
assert account.account_id == "accountId1"
assert account.address == {
"street1": "123 Main Street",
"city": "Seattle",
"subdivision": "WA",
"postalCode": "98101",
}
assert account.email == "user@email.com"
assert account.full_name == "Jane Doe"
assert account.phone == "1234567890"
assert account.subscription_id == "subscriptionId1"
assert account.subscription_active is True
aresponses.assert_plan_strictly_followed()
@freeze_time("2021-10-01")
@pytest.mark.asyncio
async def test_get_next_pickup_event(
aresponses: ResponsesMockServer,
authenticated_ridwell_api_server: ResponsesMockServer,
caplog: Mock,
upcoming_subscription_pickups_response: dict[str, Any],
user_response: dict[str, Any],
) -> None:
"""Test getting the next upcoming pickup event associated with an account.
Args:
aresponses: An aresponses server.
authenticated_ridwell_api_server: A mocked authenticated Ridwell API server.
caplog: A mocked logging utility.
upcoming_subscription_pickups_response: An API response payload.
user_response: An API response payload.
"""
caplog.set_level(logging.DEBUG)
async with authenticated_ridwell_api_server:
authenticated_ridwell_api_server.add(
"api.ridwell.com",
"/",
"post",
response=aiohttp.web_response.json_response(user_response, status=200),
)
authenticated_ridwell_api_server.add(
"api.ridwell.com",
"/",
"post",
response=aiohttp.web_response.json_response(
upcoming_subscription_pickups_response, status=200
),
)
async with aiohttp.ClientSession() as session:
client = await async_get_client("user", "password", session=session)
assert client.user_id == "userId1"
accounts = await client.async_get_accounts()
assert len(accounts) == 1
account = accounts["accountId1"]
assert account.account_id == "accountId1"
pickup_event = await account.async_get_next_pickup_event()
assert pickup_event.pickup_date == date(2021, 10, 13)
assert pickup_event.state == EventState.SCHEDULED
assert len(pickup_event.pickups) == 3
assert pickup_event.pickups[0].name == "Threads"
assert pickup_event.pickups[0].offer_id == "pickupOffer1"
assert pickup_event.pickups[0].priority == 1
assert pickup_event.pickups[0].product_id == "pickupProduct1"
assert pickup_event.pickups[0].quantity == 1
assert pickup_event.pickups[0].category == PickupCategory.STANDARD
assert pickup_event.pickups[1].name == "Beyond the Bin"
assert pickup_event.pickups[1].offer_id == "pickupOffer2"
assert pickup_event.pickups[1].priority == 1
assert pickup_event.pickups[1].product_id == "pickupProduct2"
assert pickup_event.pickups[1].quantity == 2
assert pickup_event.pickups[1].category == PickupCategory.ADD_ON
assert pickup_event.pickups[2].name == "Chocolate"
assert pickup_event.pickups[2].offer_id == "pickupOffer3"
assert pickup_event.pickups[2].priority == 2
assert pickup_event.pickups[2].product_id == "pickupProduct3"
assert pickup_event.pickups[2].quantity == 1
assert pickup_event.pickups[2].category == PickupCategory.ROTATING
assert any(
"Detected assumed rotating pickup: Chocolate" in e.message
for e in caplog.records
)
aresponses.assert_plan_strictly_followed()
@freeze_time("2021-10-31")
@pytest.mark.asyncio
async def test_get_next_pickup_event_none_left(
aresponses: ResponsesMockServer,
authenticated_ridwell_api_server: ResponsesMockServer,
upcoming_subscription_pickups_response: dict[str, Any],
user_response: dict[str, Any],
) -> None:
"""Test getting the next pickup event with no supporting data.
Args:
aresponses: An aresponses server.
authenticated_ridwell_api_server: A mocked authenticated Ridwell API server.
upcoming_subscription_pickups_response: An API response payload.
user_response: An API response payload.
"""
async with authenticated_ridwell_api_server:
authenticated_ridwell_api_server.add(
"api.ridwell.com",
"/",
"post",
response=aiohttp.web_response.json_response(user_response, status=200),
)
authenticated_ridwell_api_server.add(
"api.ridwell.com",
"/",
"post",
response=aiohttp.web_response.json_response(
upcoming_subscription_pickups_response, status=200
),
)
async with aiohttp.ClientSession() as session:
client = await async_get_client("user", "password", session=session)
assert client.user_id == "userId1"
accounts = await client.async_get_accounts()
assert len(accounts) == 1
account = accounts["accountId1"]
assert account.account_id == "accountId1"
with pytest.raises(RidwellError):
await account.async_get_next_pickup_event()
aresponses.assert_plan_strictly_followed()
@pytest.mark.asyncio
async def test_get_pickup_events(
aresponses: ResponsesMockServer,
authenticated_ridwell_api_server: ResponsesMockServer,
upcoming_subscription_pickups_response: dict[str, Any],
user_response: dict[str, Any],
) -> None:
"""Test getting all upcoming pickup events associated with an account.
Args:
aresponses: An aresponses server.
authenticated_ridwell_api_server: A mocked authenticated Ridwell API server.
upcoming_subscription_pickups_response: An API response payload.
user_response: An API response payload.
"""
async with authenticated_ridwell_api_server:
authenticated_ridwell_api_server.add(
"api.ridwell.com",
"/",
"post",
response=aiohttp.web_response.json_response(user_response, status=200),
)
authenticated_ridwell_api_server.add(
"api.ridwell.com",
"/",
"post",
response=aiohttp.web_response.json_response(
upcoming_subscription_pickups_response, status=200
),
)
async with aiohttp.ClientSession() as session:
client = await async_get_client("user", "password", session=session)
assert client.user_id == "userId1"
accounts = await client.async_get_accounts()
assert len(accounts) == 1
account = accounts["accountId1"]
assert account.account_id == "accountId1"
pickup_events = await account.async_get_pickup_events()
assert len(pickup_events) == 2
assert pickup_events[0].pickup_date == date(2021, 10, 13)
assert pickup_events[0].state == EventState.SCHEDULED
assert pickup_events[1].pickup_date == date(2021, 10, 27)
assert pickup_events[1].state == EventState.INITIALIZED
assert len(pickup_events[0].pickups) == 3
assert pickup_events[0].pickups[0].name == "Threads"
assert pickup_events[0].pickups[0].offer_id == "pickupOffer1"
assert pickup_events[0].pickups[0].priority == 1
assert pickup_events[0].pickups[0].product_id == "pickupProduct1"
assert pickup_events[0].pickups[0].quantity == 1
assert pickup_events[0].pickups[0].category == PickupCategory.STANDARD
assert pickup_events[0].pickups[1].name == "Beyond the Bin"
assert pickup_events[0].pickups[1].offer_id == "pickupOffer2"
assert pickup_events[0].pickups[1].priority == 1
assert pickup_events[0].pickups[1].product_id == "pickupProduct2"
assert pickup_events[0].pickups[1].quantity == 2
assert pickup_events[0].pickups[1].category == PickupCategory.ADD_ON
assert pickup_events[0].pickups[2].name == "Chocolate"
assert pickup_events[0].pickups[2].offer_id == "pickupOffer3"
assert pickup_events[0].pickups[2].priority == 2
assert pickup_events[0].pickups[2].product_id == "pickupProduct3"
assert pickup_events[0].pickups[2].quantity == 1
assert pickup_events[0].pickups[2].category == PickupCategory.ROTATING
aresponses.assert_plan_strictly_followed()
@pytest.mark.asyncio
async def test_get_pickup_events_cost(
aresponses: ResponsesMockServer,
authenticated_ridwell_api_server: ResponsesMockServer,
subscription_pickup_quote_response: dict[str, Any],
upcoming_subscription_pickups_response: dict[str, Any],
user_response: dict[str, Any],
) -> None:
"""Test getting the cost of upcoming pickup events.
Args:
aresponses: An aresponses server.
authenticated_ridwell_api_server: A mocked authenticated Ridwell API server.
subscription_pickup_quote_response: An API response payload.
upcoming_subscription_pickups_response: An API response payload.
user_response: An API response payload.
"""
async with authenticated_ridwell_api_server:
authenticated_ridwell_api_server.add(
"api.ridwell.com",
"/",
"post",
response=aiohttp.web_response.json_response(user_response, status=200),
)
authenticated_ridwell_api_server.add(
"api.ridwell.com",
"/",
"post",
response=aiohttp.web_response.json_response(
upcoming_subscription_pickups_response, status=200
),
)
authenticated_ridwell_api_server.add(
"api.ridwell.com",
"/",
"post",
response=aiohttp.web_response.json_response(
subscription_pickup_quote_response, status=200
),
)
async with aiohttp.ClientSession() as session:
client = await async_get_client("user", "password", session=session)
assert client.user_id == "userId1"
accounts = await client.async_get_accounts()
assert len(accounts) == 1
account = accounts["accountId1"]
assert account.account_id == "accountId1"
pickup_events = await account.async_get_pickup_events()
assert len(pickup_events) == 2
event_1_addon_cost = await pickup_events[0].async_get_estimated_addon_cost()
assert event_1_addon_cost == 1.00
event_2_addon_cost = await pickup_events[1].async_get_estimated_addon_cost()
assert event_2_addon_cost == 0.00
aresponses.assert_plan_strictly_followed()
@pytest.mark.asyncio
async def test_opt_in( # pylint: disable=too-many-arguments
aresponses: ResponsesMockServer,
authenticated_ridwell_api_server: ResponsesMockServer,
caplog: Mock,
upcoming_subscription_pickups_response: dict[str, Any],
update_subscription_pickup_response: dict[str, Any],
user_response: dict[str, Any],
) -> None:
"""Test opting in/out of a pickup.
Args:
aresponses: An aresponses server.
authenticated_ridwell_api_server: A mocked authenticated Ridwell API server.
caplog: A mocked logging utility.
upcoming_subscription_pickups_response: An API response payload.
update_subscription_pickup_response: An API response payload.
user_response: An API response payload.
"""
async with authenticated_ridwell_api_server:
authenticated_ridwell_api_server.add(
"api.ridwell.com",
"/",
"post",
response=aiohttp.web_response.json_response(user_response, status=200),
)
authenticated_ridwell_api_server.add(
"api.ridwell.com",
"/",
"post",
response=aiohttp.web_response.json_response(
upcoming_subscription_pickups_response, status=200
),
)
authenticated_ridwell_api_server.add(
"api.ridwell.com",
"/",
"post",
response=aiohttp.web_response.json_response(
update_subscription_pickup_response, status=200
),
)
update_subscription_pickup_response["data"]["updateSubscriptionPickup"][
"subscriptionPickup"
]["state"] = "skipped"
authenticated_ridwell_api_server.add(
"api.ridwell.com",
"/",
"post",
response=aiohttp.web_response.json_response(
update_subscription_pickup_response, status=200
),
)
update_subscription_pickup_response["data"]["updateSubscriptionPickup"][
"subscriptionPickup"
]["state"] = "fake_state"
authenticated_ridwell_api_server.add(
"api.ridwell.com",
"/",
"post",
response=aiohttp.web_response.json_response(
update_subscription_pickup_response, status=200
),
)
async with aiohttp.ClientSession() as session:
client = await async_get_client("user", "password", session=session)
assert client.user_id == "userId1"
accounts = await client.async_get_accounts()
assert len(accounts) == 1
account = accounts["accountId1"]
assert account.account_id == "accountId1"
pickup_events = await account.async_get_pickup_events()
assert len(pickup_events) == 2
await pickup_events[0].async_opt_in()
state = pickup_events[0].state
assert state == EventState.SCHEDULED
await pickup_events[0].async_opt_out()
state = pickup_events[0].state
assert state == EventState.SKIPPED
await pickup_events[0].async_opt_in()
assert any(
"Unknown pickup event state: fake_state" in e.message
for e in caplog.records
)
assert pickup_events[0].state == EventState.UNKNOWN
aresponses.assert_plan_strictly_followed()
|