def test_courier_available_event(self):
"""Test to verify the mechanics of how the dispatcher sets a courier to available"""
# Constants
initial_time = hour_to_sec(14)
on_time = time(14, 0, 0)
off_time = time(15, 0, 0)
service_time = min_to_sec(6)
# Services
env = Environment(initial_time=initial_time)
dispatcher = Dispatcher(env=env, matching_policy=DummyMatchingPolicy())
# Creates a courier and sets it to the picking state
courier = Courier(dispatcher=dispatcher, env=env, courier_id=32, on_time=on_time, off_time=off_time)
dispatcher.idle_couriers = {courier.courier_id: courier}
env.process(courier._picking_up_state(
orders={
21: Order(drop_off_service_time=service_time, ready_time=time(14, 20, 0))
}
))
env.run(until=initial_time + min_to_sec(10))
# Verify courier properties are modified and it is allocated correctly
self.assertEqual(courier.condition, 'picking_up')
self.assertIn(courier.courier_id, dispatcher.picking_up_couriers.keys())
self.assertEqual(dispatcher.idle_couriers, {})
def test_get_prospects(self):
"""Test to verify how prospects are obtained"""
# Constants
on_time = time(14, 0, 0)
off_time = time(16, 0, 0)
# Services
policy = GreedyMatchingPolicy()
# Case 1: verify an order is prospect to a courier
order = Order(pick_up_at=Location(4.678622, -74.055694),
drop_off_at=Location(4.690207, -74.044235))
courier = Courier(location=Location(4.709022, -74.035102),
on_time=on_time,
off_time=off_time)
prospects = policy._get_prospects(orders=[order], couriers=[courier])
self.assertEqual(prospects.tolist(), [[0, 0]])
# Case 2: verify an order is not prospect to a courier
order = Order(pick_up_at=Location(4.678622, -74.055694),
drop_off_at=Location(4.690207, -74.044235))
courier = Courier(location=Location(4.8090, -74.9351),
on_time=on_time,
off_time=off_time,
active_route=Route(stops=[],
orders={
2: Order(),
3: Order(),
4: Order()
}))
prospects = policy._get_prospects(orders=[order], couriers=[courier])
self.assertEqual(prospects.tolist(), [])
# Case 3: assert some orders being prospect and some not to some couriers
order_1 = Order(pick_up_at=Location(4.678622, -74.055694),
drop_off_at=Location(4.690207, -74.044235),
order_id=1)
order_2 = Order(pick_up_at=Location(1.178, -72.25),
drop_off_at=Location(1.690207, -75.044235),
order_id=2)
courier_1 = Courier(location=Location(4.709022, -74.035102),
on_time=on_time,
off_time=off_time,
courier_id=1)
courier_2 = Courier(location=Location(4.709022, -74.035102),
on_time=on_time,
off_time=off_time,
courier_id=2)
prospects = policy._get_prospects(orders=[order_1, order_2],
couriers=[courier_1, courier_2])
self.assertEqual(len(prospects), 2)
def test_calculate_earnings(self):
"""Test to verify the mechanics of calculating the shift's earnings"""
# Constants
random.seed(523)
on_time = time(0, 0, 0)
off_time = time(2, 0, 0)
# Services
env = Environment()
# Creates a two hour - shift courier
courier = Courier(env=env, on_time=on_time, off_time=off_time)
# Verifies for two scenarios how the earnings are calculated.
# In the first test, raw earnings from orders are chosen.
# In the second test, the hourly earnings rate is chosen.
# Test 1. Creates courier earnings to select the raw earnings from orders.
# Asserts that these earnings are selected over the hourly earnings rate
courier.fulfilled_orders = [Order()] * 7
courier.earnings = courier._calculate_earnings()
self.assertEqual(
courier.earnings,
len(courier.fulfilled_orders) *
settings.COURIER_EARNINGS_PER_ORDER)
# Test 2. Creates courier earnings to select the hourly earnings rate.
# Asserts that these earnings are selected over the order earnings
courier.fulfilled_orders = [Order()] * 2
courier.earnings = courier._calculate_earnings()
self.assertEqual(
courier.earnings,
sec_to_hour(time_diff(courier.off_time, courier.on_time)) *
settings.COURIER_EARNINGS_PER_HOUR)
def test_notify_prepositioning_event_accept_idle(self, osrm):
"""Test to evaluate how a courier handles a prepositioning notification while being idle and accepts it"""
# Constants
random.seed(348)
initial_time = hour_to_sec(17)
time_delta = min_to_sec(10)
on_time = time(17, 0, 0)
off_time = time(17, 30, 0)
# Services
env = Environment(initial_time=initial_time)
dispatcher = Dispatcher(env=env, matching_policy=DummyMatchingPolicy())
# Creates a courier with high acceptance rate and immediately send a prepositioning notification
courier = Courier(
acceptance_policy=self.acceptance_policy,
dispatcher=dispatcher,
env=env,
movement_evaluation_policy=self.movement_evaluation_policy,
movement_policy=self.movement_policy,
courier_id=self.courier_id,
vehicle=self.vehicle,
location=self.start_location,
acceptance_rate=0.99,
on_time=on_time,
off_time=off_time)
instruction = Route(orders=None,
stops=[
Stop(location=self.pick_up_at,
position=0,
orders=None,
type=StopType.PREPOSITION,
visited=False)
])
notification = Notification(courier=courier,
instruction=instruction,
type=NotificationType.PREPOSITIONING)
env.process(courier.notification_event(notification))
env.run(until=initial_time + time_delta)
# Asserts that the courier fulfilled the route and is at a different start location
self.assertIsNone(courier.active_route)
self.assertIsNone(courier.active_stop)
self.assertEqual(dispatcher.fulfilled_orders, {})
self.assertNotEqual(courier.location, self.start_location)
self.assertEqual(courier.condition, 'idle')
self.assertIn(courier.courier_id, dispatcher.idle_couriers.keys())
def test_orders_dropped_off_event(self):
"""Test to verify the mechanics of orders being dropped off"""
# Constants
initial_time = hour_to_sec(14)
on_time = time(14, 0, 0)
off_time = time(16, 0, 0)
# Services
env = Environment(initial_time=initial_time)
dispatcher = Dispatcher(env=env, matching_policy=DummyMatchingPolicy())
# Creates an order and sends the picked up event
order = Order(order_id=45, user=User(env=env))
dispatcher.assigned_orders[order.order_id] = order
courier = Courier(on_time=on_time, off_time=off_time)
dispatcher.orders_dropped_off_event(orders={order.order_id: order}, courier=courier)
env.run(until=initial_time + hour_to_sec(1))
# Verify order properties are modified and it is allocated correctly
self.assertEqual(order.state, 'dropped_off')
self.assertEqual(order.drop_off_time, sec_to_time(initial_time))
self.assertIn(order.order_id, dispatcher.fulfilled_orders.keys())
self.assertEqual(dispatcher.assigned_orders, {})
self.assertIn(order.order_id, courier.fulfilled_orders)
def test_prepositioning_notification_rejected_event(self):
"""Test to verify the mechanics of a prepositioning notification being rejected by a courier"""
# Constants
initial_time = hour_to_sec(14)
on_time = time(14, 0, 0)
off_time = time(15, 0, 0)
# Services
env = Environment(initial_time=initial_time)
dispatcher = Dispatcher(env=env, matching_policy=DummyMatchingPolicy())
# Creates a prepositioning notification, a courier and sends the rejected event
instruction = Route(
stops=[
Stop(position=0, type=StopType.PREPOSITION),
Stop(position=1, type=StopType.PREPOSITION)
]
)
courier = Courier(dispatcher=dispatcher, env=env, courier_id=981, on_time=on_time, off_time=off_time)
notification = Notification(courier=courier, instruction=instruction, type=NotificationType.PREPOSITIONING)
dispatcher.notification_rejected_event(notification=notification, courier=courier)
env.run(until=initial_time + min_to_sec(30))
# Verify order and courier properties are modified and it is allocated correctly
self.assertIsNone(courier.active_route)
def test_movement_state(self, osrm):
"""Test to evaluate how a courier moves with dummy movement"""
# Constants
random.seed(365)
on_time = time(0, 0, 0)
off_time = time(5, 0, 0)
env = Environment()
dispatcher = Dispatcher(env=env, matching_policy=DummyMatchingPolicy())
# Creates a courier and runs a simulation
courier = Courier(
acceptance_policy=self.acceptance_policy,
dispatcher=dispatcher,
env=env,
movement_evaluation_policy=self.movement_evaluation_policy,
movement_policy=self.movement_policy,
courier_id=self.courier_id,
vehicle=self.vehicle,
location=self.start_location,
on_time=on_time,
off_time=off_time)
env.run(until=hour_to_sec(4) + min_to_sec(5))
# Asserts that the courier moved and is is in a different location
self.assertEqual(courier.condition, 'moving')
self.assertNotEqual(courier.location, self.start_location)
self.assertIn(courier.courier_id, dispatcher.moving_couriers.keys())
def test_always_idle(self, osrm):
"""Test to evaluate a courier never moving"""
# Constants
random.seed(187)
on_time = time(0, 0, 0)
off_time = time(5, 0, 0)
# Services
env = Environment()
dispatcher = Dispatcher(env=env, matching_policy=DummyMatchingPolicy())
# Creates a courier and runs a simulation
courier = Courier(
acceptance_policy=self.acceptance_policy,
dispatcher=dispatcher,
env=env,
movement_evaluation_policy=self.movement_evaluation_policy,
movement_policy=self.movement_policy,
courier_id=self.courier_id,
vehicle=self.vehicle,
location=self.start_location,
on_time=on_time,
off_time=off_time)
env.run(until=hour_to_sec(4))
# Asserts that the courier is idle and never moved
self.assertEqual(courier.condition, 'idle')
self.assertEqual(courier.location, self.start_location)
self.assertIn(courier.courier_id, dispatcher.idle_couriers.keys())
def test_courier_idle_event(self, *args):
"""Test to verifiy the mechanics of how a courier is set to idle by the dispatcher"""
# Constants
initial_time = hour_to_sec(14)
courier_id = 85
time_delta = min_to_sec(10)
random.seed(26)
on_time = time(14, 0, 0)
off_time = time(15, 0, 0)
# Verifies 3 test cases: when the courier is busy, available or idle.
# For each test case, assert the courier starts in a set and ends up in the idle set
# Test 1: courier is busy
env = Environment(initial_time=initial_time)
dispatcher = Dispatcher(env=env, matching_policy=DummyMatchingPolicy())
courier = Courier(dispatcher=dispatcher, env=env, courier_id=courier_id, on_time=on_time, off_time=off_time)
dispatcher.moving_couriers = {courier.courier_id: courier}
dispatcher.courier_idle_event(courier)
env.run(until=initial_time + time_delta)
self.assertIn(courier.courier_id, dispatcher.idle_couriers.keys())
self.assertEqual(dispatcher.moving_couriers, {})
self.assertEqual(dispatcher.picking_up_couriers, {})
# Test 2: courier is available
env = Environment(initial_time=initial_time)
dispatcher = Dispatcher(env=env, matching_policy=DummyMatchingPolicy())
courier = Courier(dispatcher=dispatcher, env=env, courier_id=courier_id, on_time=on_time, off_time=off_time)
dispatcher.picking_up_couriers = {courier.courier_id: courier}
dispatcher.courier_idle_event(courier)
env.run(until=initial_time + time_delta)
self.assertIn(courier.courier_id, dispatcher.idle_couriers.keys())
self.assertEqual(dispatcher.moving_couriers, {})
self.assertEqual(dispatcher.picking_up_couriers, {})
# Test 3: courier is idle
env = Environment(initial_time=initial_time)
dispatcher = Dispatcher(env=env, matching_policy=DummyMatchingPolicy())
courier = Courier(dispatcher=dispatcher, env=env, courier_id=courier_id, on_time=on_time, off_time=off_time)
dispatcher.idle_couriers = {courier.courier_id: courier}
dispatcher.courier_idle_event(courier)
env.run(until=initial_time + time_delta)
self.assertIn(courier.courier_id, dispatcher.idle_couriers.keys())
self.assertEqual(dispatcher.moving_couriers, {})
self.assertEqual(dispatcher.picking_up_couriers, {})
def test_notification_accepted_event(self):
"""Test to verify the mechanics of a notification being accepted by a courier"""
# Constants
initial_time = hour_to_sec(14)
on_time = time(14, 0, 0)
off_time = time(15, 0, 0)
# Services
env = Environment(initial_time=initial_time)
dispatcher = Dispatcher(env=env, matching_policy=DummyMatchingPolicy())
# Creates an instruction with an order, a courier and sends the accepted event
order = Order(order_id=45)
instruction = Route(
stops=[
Stop(orders={order.order_id: order}, position=0),
Stop(orders={order.order_id: order}, position=1)
],
orders={order.order_id: order}
)
dispatcher.unassigned_orders[order.order_id] = order
courier = Courier(dispatcher=dispatcher, env=env, courier_id=89, on_time=on_time, off_time=off_time)
courier.condition = 'idle'
notification = Notification(
courier=courier,
instruction=instruction
)
dispatcher.notification_accepted_event(notification=notification, courier=courier)
env.run(until=initial_time + min_to_sec(10))
# Verify order and courier properties are modified and it is allocated correctly
self.assertEqual(order.state, 'in_progress')
self.assertEqual(order.acceptance_time, sec_to_time(initial_time))
self.assertEqual(order.courier_id, courier.courier_id)
self.assertIn(order.order_id, dispatcher.assigned_orders.keys())
self.assertIsNotNone(courier.active_route)
self.assertEqual(courier.active_route, instruction)
self.assertEqual(dispatcher.unassigned_orders, {})
def test_log_off(self):
"""Test to evaluate the scheduling of the courier logging off works correctly"""
# Constants
random.seed(888)
on_time = time(8, 0, 0)
off_time = time(14, 0, 0)
initial_time = hour_to_sec(8)
# Verifies for two test cases the scheduling of the courier logging off works correctly.
# In one case, the courier log off event doesn't yet happen. In the other test, it does
# Test 1: the courier achieves the log off after a given time
env = Environment(initial_time=initial_time)
dispatcher = Dispatcher(env=env, matching_policy=DummyMatchingPolicy())
courier = Courier(env=env,
dispatcher=dispatcher,
courier_id=84,
on_time=on_time,
off_time=off_time)
env.run(until=initial_time + hour_to_sec(10))
self.assertEqual(dispatcher.logged_off_couriers,
{courier.courier_id: courier})
self.assertEqual(dispatcher.idle_couriers, {})
self.assertEqual(courier.condition, 'logged_off')
# Test 2: the courier doesn't achieve the log off because the simulation ends before
env = Environment(initial_time=initial_time)
dispatcher = Dispatcher(env=env, matching_policy=DummyMatchingPolicy())
courier = Courier(env=env,
dispatcher=dispatcher,
courier_id=84,
on_time=on_time,
off_time=off_time)
env.run(until=initial_time + hour_to_sec(2))
self.assertEqual(dispatcher.idle_couriers,
{courier.courier_id: courier})
self.assertEqual(dispatcher.logged_off_couriers, {})
self.assertEqual(courier.condition, 'idle')
def test_pick_up_waiting_time(self, osrm):
"""Test to verify the mechanics of the waiting time are correctly designed"""
# Constants
random.seed(290)
on_time = time(6, 0, 0)
off_time = time(8, 0, 0)
# Services
env = Environment(initial_time=hour_to_sec(6))
dispatcher = Dispatcher(env=env, matching_policy=DummyMatchingPolicy())
# Creates a courier and sets it to pick up stuff
courier = Courier(
acceptance_policy=self.acceptance_policy,
dispatcher=dispatcher,
env=env,
movement_evaluation_policy=self.movement_evaluation_policy,
movement_policy=self.movement_policy,
courier_id=self.courier_id,
vehicle=self.vehicle,
location=self.start_location,
acceptance_rate=0.01,
on_time=on_time,
off_time=off_time)
order = Order(ready_time=time(6, 15, 0), order_id=23)
stop = Stop(orders={order.order_id: order}, type=StopType.PICK_UP)
env.process(courier._execute_stop(stop))
dispatcher.state.interrupt()
# Run until there are no more events and assert the courier experienced waiting time.
env.run(until=hour_to_sec(7))
self.assertTrue(order.pick_up_time >= time(
6, int(order.ready_time.minute + order.pick_up_service_time / 60)))
# For another test, if the order's ready time has expired, the courier doesn't experience waiting time
env = Environment(initial_time=hour_to_sec(6))
dispatcher = Dispatcher(env=env, matching_policy=DummyMatchingPolicy())
courier = Courier(
acceptance_policy=self.acceptance_policy,
dispatcher=dispatcher,
env=env,
movement_evaluation_policy=self.movement_evaluation_policy,
movement_policy=self.movement_policy,
courier_id=self.courier_id,
vehicle=self.vehicle,
location=self.start_location,
acceptance_rate=0.01,
on_time=on_time,
off_time=off_time)
order = Order(ready_time=time(4, 0, 0), order_id=23)
stop = Stop(orders={order.order_id: order}, type=StopType.PICK_UP)
env.process(courier._execute_stop(stop))
dispatcher.state.interrupt()
env.run(until=hour_to_sec(7))
self.assertTrue(
time(order.pick_up_time.hour, order.pick_up_time.minute) <= time(
6, int(order.pick_up_service_time / 60)))
def _new_couriers_procedure(self, couriers_info: List[Dict[str, Any]]):
"""Method to establish how a new courier is created in the World"""
for courier_info in couriers_info:
courier = Courier(
env=self.env,
dispatcher=self.dispatcher,
acceptance_policy=COURIER_ACCEPTANCE_POLICIES_MAP[
settings.COURIER_ACCEPTANCE_POLICY],
movement_evaluation_policy=
COURIER_MOVEMENT_EVALUATION_POLICIES_MAP[
settings.COURIER_MOVEMENT_EVALUATION_POLICY],
movement_policy=COURIER_MOVEMENT_POLICIES_MAP[
settings.COURIER_MOVEMENT_POLICY],
courier_id=courier_info['courier_id'],
vehicle=Vehicle.from_label(label=courier_info['vehicle']),
location=Location(lat=courier_info['on_lat'],
lng=courier_info['on_lng']),
on_time=courier_info['on_time'],
off_time=courier_info['off_time'])
self.couriers.append(courier)
def test_get_estimations(self, osrm):
"""Test to verify that estimations are correctly calculated"""
# Constants
on_time = time(15, 0, 0)
off_time = time(16, 0, 0)
# Services
policy = GreedyMatchingPolicy()
# Create an order and a courier and have them be prospects
order = Order(pick_up_at=Location(4.678622, -74.055694),
drop_off_at=Location(4.690207, -74.044235))
courier = Courier(location=Location(4.709022, -74.035102),
on_time=on_time,
off_time=off_time,
vehicle=Vehicle.CAR)
prospects = np.array([[0, 0]])
# Obtain estimations and assert they are correctly calculated
estimations = policy._get_estimations(orders=[order],
couriers=[courier],
prospects=prospects)
self.assertEqual(
round(estimations['distance'].tolist()[0], 2),
round(
haversine(courier.location.coordinates,
order.pick_up_at.coordinates) +
haversine(order.pick_up_at.coordinates,
order.drop_off_at.coordinates), 2))
average_velocity = courier.vehicle.average_velocity
self.assertEqual(
int(estimations['time'][0]),
int(
haversine(courier.location.coordinates,
order.pick_up_at.coordinates) / average_velocity +
haversine(order.pick_up_at.coordinates,
order.drop_off_at.coordinates) / average_velocity +
order.pick_up_service_time + order.drop_off_service_time))
def test_courier_busy_event(self, *args):
"""Test to verify the mechanics of how the dispatcher sets a courier to busy"""
# Constants
initial_time = hour_to_sec(14)
courier_id = 14
time_delta = min_to_sec(10)
on_time = time(14, 0, 0)
off_time = time(15, 0, 0)
service_time = min_to_sec(7)
# Verifies 2 test cases for how the courier transitions to being busy
# For each test case, assert the courier starts in a set and ends up in the busy set
# Test 1: courier starts dropping off state
env = Environment(initial_time=initial_time)
dispatcher = Dispatcher(env=env, matching_policy=DummyMatchingPolicy())
courier = Courier(dispatcher=dispatcher, env=env, courier_id=courier_id, on_time=on_time, off_time=off_time)
env.process(courier._dropping_off_state(
orders={
21: Order(drop_off_service_time=service_time, ready_time=time(12, 20, 0))
}
))
env.run(until=initial_time + time_delta)
self.assertEqual(courier.condition, 'dropping_off')
self.assertEqual(dispatcher.dropping_off_couriers, {courier.courier_id: courier})
self.assertEqual(dispatcher.idle_couriers, {})
# Test 2: courier start moving state
env = Environment(initial_time=initial_time)
dispatcher = Dispatcher(env=env, matching_policy=DummyMatchingPolicy())
courier = Courier(
dispatcher=dispatcher,
env=env,
courier_id=courier_id,
location=Location(lat=4.690296, lng=-74.043929),
on_time=on_time,
off_time=off_time
)
env.process(courier._moving_state(destination=Location(lat=4.689697, lng=-74.055495)))
env.run(until=initial_time + time_delta)
self.assertEqual(courier.condition, 'moving')
self.assertEqual(dispatcher.moving_couriers, {courier.courier_id: courier})
self.assertEqual(dispatcher.idle_couriers, {})
def test_generate_matching_prospects_picking_up_couriers(self, osrm):
"""Test to verify how prospects are created"""
# Constants
env_time = hour_to_sec(12) + min_to_sec(20)
on_time = time(8, 0, 0)
off_time = time(16, 0, 0)
# Orders
order_1 = Order(order_id=1,
pick_up_at=Location(lat=4.678759, lng=-74.055729),
drop_off_at=Location(lat=4.681694, lng=-74.044811),
ready_time=time(12, 30, 0),
expected_drop_off_time=time(12, 40, 0),
pick_up_service_time=0,
drop_off_service_time=0)
order_2 = Order(order_id=2,
pick_up_at=Location(lat=4.678759, lng=-74.055729),
drop_off_at=Location(lat=4.695001, lng=-74.040737),
ready_time=time(12, 32, 0),
expected_drop_off_time=time(12, 42, 0),
pick_up_service_time=0,
drop_off_service_time=0)
order_3 = Order(order_id=3,
pick_up_at=Location(lat=4.678759, lng=-74.055729),
drop_off_at=Location(lat=4.668742, lng=-74.056684),
ready_time=time(12, 33, 0),
expected_drop_off_time=time(12, 43, 0),
pick_up_service_time=0,
drop_off_service_time=0)
# Couriers
courier_3 = Courier(
courier_id=3,
on_time=on_time,
off_time=off_time,
condition='picking_up',
location=order_3.pick_up_at,
active_route=Route(orders={order_3.order_id: order_3},
stops=[
Stop(location=order_3.pick_up_at,
orders={order_3.order_id: order_3},
position=0,
type=StopType.PICK_UP),
Stop(location=order_3.drop_off_at,
orders={order_3.order_id: order_3},
position=1,
type=StopType.DROP_OFF)
]),
active_stop=Stop(location=order_3.pick_up_at,
orders={order_3.order_id: order_3},
position=0,
type=StopType.PICK_UP))
# Get routes and assert expected behavior
policy = MyopicMatchingPolicy(assignment_updates=True,
prospects=True,
notification_filtering=False,
mip_matcher=False)
routes = policy._generate_routes(orders=[order_1, order_2],
couriers=[courier_3],
env_time=env_time)
# Generate prospects and assert expected behavior
prospects = policy._generate_matching_prospects(routes=routes,
couriers=[courier_3],
env_time=env_time)
self.assertFalse(prospects.tolist())
def test_generate_matching_prospects_all(self, osrm):
"""Test to verify how prospects are created"""
# Constants
env_time = hour_to_sec(12) + min_to_sec(20)
on_time = time(8, 0, 0)
off_time = time(16, 0, 0)
# Orders
order_1 = Order(order_id=1,
pick_up_at=Location(lat=4.678759, lng=-74.055729),
drop_off_at=Location(lat=4.681694, lng=-74.044811),
ready_time=time(12, 30, 0),
expected_drop_off_time=time(12, 40, 0),
pick_up_service_time=0,
drop_off_service_time=0)
order_2 = Order(order_id=2,
pick_up_at=Location(lat=4.678759, lng=-74.055729),
drop_off_at=Location(lat=4.695001, lng=-74.040737),
ready_time=time(12, 32, 0),
expected_drop_off_time=time(12, 42, 0),
pick_up_service_time=0,
drop_off_service_time=0)
order_3 = Order(order_id=3,
pick_up_at=Location(lat=4.678759, lng=-74.055729),
drop_off_at=Location(lat=4.668742, lng=-74.056684),
ready_time=time(12, 33, 0),
expected_drop_off_time=time(12, 43, 0),
pick_up_service_time=0,
drop_off_service_time=0)
order_4 = Order(order_id=4,
pick_up_at=Location(lat=4.678759, lng=-74.055729),
drop_off_at=Location(lat=4.661441, lng=-74.056955),
ready_time=time(12, 34, 0),
expected_drop_off_time=time(12, 44, 0),
pick_up_service_time=0,
drop_off_service_time=0)
# Couriers
courier_1 = Courier(courier_id=1,
on_time=on_time,
off_time=off_time,
condition='idle',
location=Location(lat=4.676854, lng=-74.057498))
courier_2 = Courier(courier_id=2,
on_time=on_time,
off_time=off_time,
condition='idle',
location=Location(lat=4.679408, lng=-74.052524))
# Routes
policy = MyopicMatchingPolicy(assignment_updates=True,
prospects=True,
notification_filtering=False,
mip_matcher=False)
routes = policy._generate_routes(
orders=[order_1, order_2, order_3, order_4],
couriers=[courier_1, courier_2],
env_time=env_time)
# Generate prospects and assert expected behavior
prospects = policy._generate_matching_prospects(
routes=routes, couriers=[courier_1, courier_2], env_time=env_time)
self.assertTrue(prospects.tolist())
self.assertEqual(len(prospects), 8)
def test_notify_event_reject_picking_up(self, osrm):
"""Test to evaluate how a courier handles a notification while picking up and rejects it"""
# Constants
random.seed(4747474)
on_time = time(12, 0, 0)
off_time = time(15, 0, 0)
# Services
env = Environment(initial_time=hour_to_sec(12) + min_to_sec(12))
dispatcher = Dispatcher(env=env, matching_policy=DummyMatchingPolicy())
# Creates a courier with low acceptance rate, an active route and in state of picking up.
# Sends a new instruction, composed of a single new order
active_order = Order(
order_id=self.order_id,
drop_off_at=self.drop_off_at,
pick_up_at=self.pick_up_at,
placement_time=self.placement_time,
expected_drop_off_time=self.expected_drop_off_time,
preparation_time=self.preparation_time,
ready_time=self.ready_time,
courier_id=self.courier_id,
user=User(env=env))
dispatcher.assigned_orders[active_order.order_id] = active_order
new_order = Order(order_id=17,
drop_off_at=Location(lat=4.694627, lng=-74.038886),
pick_up_at=self.pick_up_at,
placement_time=self.placement_time,
expected_drop_off_time=self.expected_drop_off_time,
preparation_time=self.preparation_time,
ready_time=self.ready_time,
user=User(env=env))
dispatcher.unassigned_orders[new_order.order_id] = new_order
courier = Courier(
acceptance_policy=self.acceptance_policy,
dispatcher=dispatcher,
env=env,
movement_evaluation_policy=self.movement_evaluation_policy,
movement_policy=self.movement_policy,
courier_id=self.courier_id,
vehicle=self.vehicle,
location=active_order.pick_up_at,
acceptance_rate=0.01,
active_route=Route(orders={self.order_id: active_order},
stops=[
Stop(location=self.pick_up_at,
position=0,
orders={self.order_id: active_order},
type=StopType.PICK_UP,
visited=False),
Stop(location=self.drop_off_at,
position=1,
orders={self.order_id: active_order},
type=StopType.DROP_OFF,
visited=False)
]),
on_time=on_time,
off_time=off_time)
instruction = Stop(location=new_order.drop_off_at,
position=1,
orders={new_order.order_id: new_order},
type=StopType.DROP_OFF,
visited=False)
notification = Notification(courier=courier, instruction=instruction)
courier.state.interrupt()
courier.active_stop = courier.active_route.stops[0]
courier.state = env.process(
courier._picking_up_state(
orders={active_order.order_id: active_order}))
env.process(courier.notification_event(notification))
env.run(until=hour_to_sec(14))
# Asserts:
# - the courier didn't fulfill the new order,
# - fulfilled the active order and
# - is at a different start location.
self.assertIsNone(new_order.pick_up_time)
self.assertIsNone(new_order.drop_off_time)
self.assertIsNone(new_order.courier_id)
self.assertIn(courier.courier_id, new_order.rejected_by)
self.assertIn(new_order.order_id, courier.rejected_orders)
self.assertEqual(new_order.state, 'unassigned')
self.assertIsNotNone(active_order.pick_up_time)
self.assertIsNotNone(active_order.drop_off_time)
self.assertEqual(active_order.courier_id, courier.courier_id)
self.assertTrue(active_order.pick_up_time < active_order.drop_off_time)
self.assertEqual(active_order.state, 'dropped_off')
self.assertIsNone(courier.active_route)
self.assertIsNone(courier.active_stop)
self.assertNotEqual(courier.location, self.start_location)
self.assertEqual(dispatcher.fulfilled_orders,
{active_order.order_id: active_order})
self.assertEqual(dispatcher.unassigned_orders,
{new_order.order_id: new_order})
self.assertEqual(courier.condition, 'idle')
self.assertIn(courier.courier_id, dispatcher.idle_couriers.keys())
def test_courier_log_off(self):
"""Test to verify how the dispatcher handles a courier logging off"""
# Constants
random.seed(12)
initial_time = hour_to_sec(12)
time_delta = hour_to_sec(2)
service_time = min_to_sec(4)
# Tests 3 cases: when the courier is idle, busy or available.
# For each test, assert that the courier ends up being logged off
# Test 1: the courier is idle
env = Environment(initial_time=initial_time)
dispatcher = Dispatcher(env=env, matching_policy=DummyMatchingPolicy())
courier = Courier(
env=env,
dispatcher=dispatcher,
courier_id=69,
on_time=time(12, 0, 0),
off_time=time(13, 0, 0)
)
env.run(until=initial_time + time_delta)
self.assertEqual(dispatcher.idle_couriers, {})
self.assertEqual(dispatcher.moving_couriers, {})
self.assertEqual(dispatcher.dropping_off_couriers, {})
self.assertEqual(dispatcher.picking_up_couriers, {})
self.assertEqual(dispatcher.logged_off_couriers, {courier.courier_id: courier})
# Test 2: the courier is busy
env = Environment(initial_time=initial_time)
dispatcher = Dispatcher(env=env, matching_policy=DummyMatchingPolicy())
courier = Courier(
env=env,
dispatcher=dispatcher,
courier_id=69,
on_time=time(12, 0, 0),
off_time=time(13, 0, 0)
)
courier.state.interrupt()
env.process(courier._dropping_off_state(
orders={21: Order(drop_off_service_time=service_time)}
))
env.run(until=initial_time + time_delta)
self.assertEqual(dispatcher.idle_couriers, {})
self.assertEqual(dispatcher.moving_couriers, {})
self.assertEqual(dispatcher.dropping_off_couriers, {})
self.assertEqual(dispatcher.picking_up_couriers, {})
self.assertEqual(dispatcher.logged_off_couriers, {courier.courier_id: courier})
# Test 3: the courier is available
env = Environment(initial_time=initial_time)
dispatcher = Dispatcher(env=env, matching_policy=DummyMatchingPolicy())
courier = Courier(
env=env,
dispatcher=dispatcher,
courier_id=69,
on_time=time(12, 0, 0),
off_time=time(13, 0, 0)
)
courier.state.interrupt()
env.process(courier._picking_up_state(
orders={
21: Order(drop_off_service_time=service_time, ready_time=time(12, 20, 0))
}
))
env.run(until=initial_time + time_delta)
self.assertEqual(dispatcher.idle_couriers, {})
self.assertEqual(dispatcher.moving_couriers, {})
self.assertEqual(dispatcher.dropping_off_couriers, {})
self.assertEqual(dispatcher.picking_up_couriers, {})
self.assertEqual(dispatcher.logged_off_couriers, {courier.courier_id: courier})
def test_calculate_target_bundle_size(self):
""""Test to verify the target bundle size is correctly calculated"""
# Constants
on_time = time(15, 0, 0)
off_time = time(16, 0, 0)
ready_time = time(15, 0, 0)
env_time = time_to_sec(time(15, 20, 0))
# Test case 1: create more couriers than orders
courier_1 = Courier(courier_id=1,
on_time=on_time,
off_time=off_time,
condition='idle')
courier_2 = Courier(courier_id=2,
on_time=on_time,
off_time=off_time,
condition='idle')
courier_3 = Courier(courier_id=3,
on_time=on_time,
off_time=off_time,
condition='idle')
order_1 = Order(order_id=1, ready_time=ready_time)
target_size = MyopicMatchingPolicy._calculate_target_bundle_size(
orders=[order_1],
couriers=[courier_1, courier_2, courier_3],
env_time=env_time)
self.assertEqual(target_size, 1)
# Test case 2: create more orders than couriers
courier_1 = Courier(courier_id=1,
on_time=on_time,
off_time=off_time,
condition='idle')
order_1 = Order(order_id=1, ready_time=ready_time)
order_2 = Order(order_id=2, ready_time=ready_time)
order_3 = Order(order_id=3, ready_time=ready_time)
target_size = MyopicMatchingPolicy._calculate_target_bundle_size(
orders=[order_1, order_2, order_3],
couriers=[courier_1],
env_time=env_time)
self.assertEqual(target_size, 3)
# Test case 3: create more orders than couriers but couriers are idle
courier_1 = Courier(courier_id=1,
on_time=on_time,
off_time=off_time,
condition='moving')
order_2 = Order(order_id=2, ready_time=ready_time)
order_3 = Order(order_id=3, ready_time=ready_time)
target_size = MyopicMatchingPolicy._calculate_target_bundle_size(
orders=[order_1, order_2, order_3],
couriers=[courier_1],
env_time=env_time)
self.assertEqual(target_size, 1)
def test_execute(self, osrm):
"""Test the full functionality of the greedy matching policy"""
# Constants
on_time = time(7, 0, 0)
off_time = time(9, 0, 0)
# Services
policy = GreedyMatchingPolicy()
# Test 1: creates an order and two couriers.
# Since the courier_2 is at the same location as the pick up, asserts it should get chosen for notification
order = Order(pick_up_at=Location(4.678622, -74.055694),
drop_off_at=Location(4.690207, -74.044235))
courier_1 = Courier(location=Location(4.709022, -74.035102),
on_time=on_time,
off_time=off_time,
vehicle=Vehicle.CAR,
condition='idle')
courier_2 = Courier(location=Location(4.678622, -74.055694),
on_time=on_time,
off_time=off_time,
vehicle=Vehicle.CAR,
condition='idle')
notifications, _ = policy.execute(orders=[order],
couriers=[courier_1, courier_2],
env_time=3)
self.assertEqual(len(notifications), 1)
self.assertEqual(notifications[0].courier, courier_2)
self.assertIn(order, notifications[0].instruction.orders.values())
# Test 2: creates two orders and two couriers.
# The courier_1 is at the same location as the pick up of order_1.
# The courier_2 is at the same location as the pick up of order_2.
# In this fashion, courier_1 should be selected for order_1 and courier_2 for order_2
order_1 = Order(pick_up_at=Location(4.678622, -74.055694),
drop_off_at=Location(4.690207, -74.044235),
order_id=1)
order_2 = Order(pick_up_at=Location(4.690207, -74.044235),
drop_off_at=Location(4.678622, -74.055694),
order_id=2)
courier_1 = Courier(location=Location(4.678622, -74.055694),
on_time=on_time,
off_time=off_time,
vehicle=Vehicle.CAR,
condition='idle',
courier_id=1)
courier_2 = Courier(location=Location(4.690207, -74.044235),
on_time=on_time,
off_time=off_time,
vehicle=Vehicle.CAR,
condition='idle',
courier_id=2)
notifications, _ = policy.execute(orders=[order_1, order_2],
couriers=[courier_1, courier_2],
env_time=4)
self.assertEqual(len(notifications), 2)
self.assertEqual(notifications[0].courier, courier_1)
self.assertIn(order_1, notifications[0].instruction.orders.values())
self.assertEqual(notifications[1].courier, courier_2)
self.assertIn(order_2, notifications[1].instruction.orders.values())
# Test 3: creates more orders than couriers to check nothing breaks
order_1 = Order(pick_up_at=Location(4.678622, -74.055694),
drop_off_at=Location(4.690207, -74.044235),
order_id=1)
order_2 = Order(pick_up_at=Location(4.690207, -74.044235),
drop_off_at=Location(4.678622, -74.055694),
order_id=2)
courier = Courier(location=Location(4.678622, -74.055694),
on_time=on_time,
off_time=off_time,
vehicle=Vehicle.CAR,
condition='idle',
courier_id=1)
notifications, _ = policy.execute(orders=[order_1, order_2],
couriers=[courier],
env_time=5)
self.assertEqual(len(notifications), 1)
self.assertEqual(notifications[0].courier, courier)
self.assertIn(order_1, notifications[0].instruction.orders.values())
def test_myopic_matching_policy_execute_mip_matcher(self, osrm):
"""Test to verify how the optimization model is solved with a MIP approach"""
# Constants
env_time = hour_to_sec(12) + min_to_sec(20)
on_time = time(8, 0, 0)
off_time = time(16, 0, 0)
random.seed(45)
# Orders
order_1 = Order(order_id=1,
pick_up_at=Location(lat=4.678759, lng=-74.055729),
drop_off_at=Location(lat=4.681694, lng=-74.044811),
ready_time=time(12, 30, 0),
expected_drop_off_time=time(12, 40, 0),
pick_up_service_time=0,
drop_off_service_time=0)
order_2 = Order(order_id=2,
pick_up_at=Location(lat=4.678759, lng=-74.055729),
drop_off_at=Location(lat=4.695001, lng=-74.040737),
ready_time=time(12, 32, 0),
expected_drop_off_time=time(12, 42, 0),
pick_up_service_time=0,
drop_off_service_time=0)
order_3 = Order(order_id=3,
pick_up_at=Location(lat=4.678759, lng=-74.055729),
drop_off_at=Location(lat=4.668742, lng=-74.056684),
ready_time=time(12, 33, 0),
expected_drop_off_time=time(12, 43, 0),
pick_up_service_time=0,
drop_off_service_time=0)
order_4 = Order(order_id=4,
pick_up_at=Location(lat=4.678759, lng=-74.055729),
drop_off_at=Location(lat=4.661441, lng=-74.056955),
ready_time=time(12, 34, 0),
expected_drop_off_time=time(12, 44, 0),
pick_up_service_time=0,
drop_off_service_time=0)
# Couriers
courier_1 = Courier(courier_id=1,
on_time=on_time,
off_time=off_time,
condition='idle',
location=Location(lat=4.676854, lng=-74.057498))
courier_2 = Courier(courier_id=2,
on_time=on_time,
off_time=off_time,
condition='idle',
location=Location(lat=4.679408, lng=-74.052524))
courier_3 = Courier(
courier_id=3,
on_time=on_time,
off_time=off_time,
condition='picking_up',
location=order_3.pick_up_at,
active_route=Route(orders={order_3.order_id: order_3},
stops=[
Stop(location=order_3.pick_up_at,
orders={order_3.order_id: order_3},
position=0,
type=StopType.PICK_UP),
Stop(location=order_3.drop_off_at,
orders={order_3.order_id: order_3},
position=1,
type=StopType.DROP_OFF)
]),
active_stop=Stop(location=order_3.pick_up_at,
orders={order_3.order_id: order_3},
position=0,
type=StopType.PICK_UP))
# Get all the elements from the policy and assert their expected behavior
policy = MyopicMatchingPolicy(assignment_updates=False,
prospects=False,
notification_filtering=False,
mip_matcher=False)
routes = policy._generate_routes(
orders=[order_1, order_2, order_4],
couriers=[courier_1, courier_2, courier_3],
env_time=env_time)
self.assertTrue(routes)
self.assertEqual(len(routes), 2)
self.assertEqual(len(routes[0].orders), 2)
self.assertEqual(len(routes[1].orders), 1)
prospects = policy._generate_matching_prospects(
routes=routes,
couriers=[courier_1, courier_2, courier_3],
env_time=env_time)
self.assertTrue(prospects.tolist())
self.assertEqual(len(prospects), 4),
self.assertEqual(len(prospects),
len(routes) * len([courier_1, courier_2]))
costs = policy._generate_matching_costs(
routes=routes,
couriers=[courier_1, courier_2, courier_3],
prospects=prospects,
env_time=env_time)
self.assertTrue(costs.tolist())
self.assertEqual(len(prospects), len(costs))
self.assertEqual(len(costs), 4)
self.assertNotIn(0., costs)
problem = MatchingProblemBuilder.build(
routes=routes,
couriers=[courier_1, courier_2, courier_3],
prospects=prospects,
costs=costs)
self.assertTrue(problem)
self.assertEqual(len(prospects), len(problem.prospects))
self.assertEqual(len(prospects), len(problem.matching_prospects))
self.assertEqual(len(prospects), len(problem.costs))
self.assertEqual(routes, problem.routes)
self.assertEqual(problem.couriers, [courier_1, courier_2, courier_3])
self.assertNotIn(str(courier_3.courier_id),
problem.matching_prospects['i'])
model_builder = MIPOptimizationModelBuilder(
sense='max',
model_constraints=[
CourierAssignmentConstraint(),
RouteAssignmentConstraint()
],
optimizer='pulp')
model = model_builder.build(problem)
self.assertTrue(model)
self.assertEqual(len(model.constraints),
len(problem.routes) + len([courier_1, courier_2]))
self.assertEqual(len(model.variable_set),
len(problem.matching_prospects) + len(problem.routes))
solution = model.solve()
self.assertTrue(solution.tolist())
self.assertEqual(len(solution),
len(problem.matching_prospects) + len(problem.routes))
self.assertEqual(solution[0:len(problem.prospects)].sum(), 2)
self.assertEqual(solution.sum(), 2)
notifications = policy._process_solution(solution, problem, env_time)
self.assertEqual(len(notifications), len(routes))
self.assertIsInstance(notifications[0].instruction, Route)
self.assertIsInstance(notifications[1].instruction, Route)
self.assertEqual(notifications[0].courier, courier_1)
self.assertEqual(notifications[1].courier, courier_2)
self.assertIn(order_1.order_id,
notifications[1].instruction.orders.keys())
self.assertIn(order_4.order_id,
notifications[1].instruction.orders.keys())
def notification_accepted_event(self, notification: Notification,
courier: Courier):
"""Event detailing how the dispatcher handles the acceptance of a notification by a courier"""
self._log(
f'Dispatcher will handle acceptance of a {notification.type.label} notification '
f'from courier {courier.courier_id} (condition = {courier.condition})'
)
if notification.type == NotificationType.PREPOSITIONING:
courier.active_route = notification.instruction
elif notification.type == NotificationType.PICK_UP_DROP_OFF:
order_ids = (list(notification.instruction.orders.keys())
if isinstance(notification.instruction, Route) else [
order_id for stop in notification.instruction
for order_id in stop.orders.keys()
])
processed_order_ids = [
order_id for order_id in order_ids
if (order_id in self.canceled_orders.keys()
or order_id in self.assigned_orders.keys()
or order_id in self.fulfilled_orders.keys())
]
if bool(processed_order_ids):
self._log(
f'Dispatcher will update the notification to courier {courier.courier_id} '
f'based on these orders being already processed: {processed_order_ids}'
)
notification.update(processed_order_ids)
if ((isinstance(notification.instruction, Route)
and bool(notification.instruction.orders)
and bool(notification.instruction.stops))
or (isinstance(notification.instruction, list)
and bool(notification.instruction)
and bool(notification.instruction[0].orders))):
order_ids = (list(notification.instruction.orders.keys()) if
isinstance(notification.instruction, Route) else [
order_id for stop in notification.instruction
for order_id in stop.orders.keys()
])
self._log(
f'Dispatcher will handle acceptance of orders {order_ids} '
f'from courier {courier.courier_id} (condition = {courier.condition}). '
f'Instruction is a {"Route" if isinstance(notification.instruction, Route) else "List[Stop]"}'
)
instruction_orders = (
notification.instruction.orders.items() if isinstance(
notification.instruction, Route) else [
(order_id, order)
for stop in notification.instruction
for order_id, order in stop.orders.items()
])
for order_id, order in instruction_orders:
del self.unassigned_orders[order_id]
order.acceptance_time = sec_to_time(self.env.now)
order.state = 'in_progress'
order.courier_id = courier.courier_id
self.assigned_orders[order_id] = order
if courier.condition == 'idle' and isinstance(
notification.instruction, Route):
courier.active_route = notification.instruction
elif courier.condition == 'picking_up' and isinstance(
notification.instruction, list):
for stop in notification.instruction:
for order_id, order in stop.orders.items():
courier.active_route.orders[order_id] = order
courier.active_stop.orders[order_id] = order
courier.active_route.stops.append(
Stop(location=stop.location,
position=len(courier.active_route.stops),
orders=stop.orders,
type=stop.type))
courier.accepted_notifications.append(notification)
else:
self._log(
f'Dispatcher will nullify notification to courier {courier.courier_id}. All orders canceled.'
)
def test_notify_event_reject_idle(self, osrm):
"""Test to evaluate how a courier handles a notification while being idle and rejects it"""
# Constants
random.seed(122)
on_time = time(12, 0, 0)
off_time = time(15, 0, 0)
# Services
env = Environment(initial_time=hour_to_sec(12))
dispatcher = Dispatcher(env=env, matching_policy=DummyMatchingPolicy())
# Creates a courier with low acceptance rate and immediately send a new instruction, composed of a single order
courier = Courier(
acceptance_policy=self.acceptance_policy,
dispatcher=dispatcher,
env=env,
movement_evaluation_policy=self.movement_evaluation_policy,
movement_policy=self.movement_policy,
courier_id=self.courier_id,
vehicle=self.vehicle,
location=self.start_location,
acceptance_rate=0.01,
on_time=on_time,
off_time=off_time)
order = Order(order_id=self.order_id,
drop_off_at=self.drop_off_at,
pick_up_at=self.pick_up_at,
placement_time=self.placement_time,
expected_drop_off_time=self.expected_drop_off_time,
preparation_time=self.preparation_time,
ready_time=self.ready_time)
dispatcher.unassigned_orders[order.order_id] = order
instruction = Route(orders={self.order_id: order},
stops=[
Stop(location=self.pick_up_at,
position=0,
orders={self.order_id: order},
type=StopType.PICK_UP,
visited=False),
Stop(location=self.drop_off_at,
position=1,
orders={self.order_id: order},
type=StopType.DROP_OFF,
visited=False)
])
notification = Notification(courier=courier, instruction=instruction)
env.process(courier.notification_event(notification))
env.run(until=hour_to_sec(14))
# Asserts that the courier didn't fulfill the route
self.assertIsNone(order.pick_up_time)
self.assertIsNone(order.drop_off_time)
self.assertIsNone(order.courier_id)
self.assertIsNone(courier.active_route)
self.assertIsNone(courier.active_stop)
self.assertIn(courier.courier_id, order.rejected_by)
self.assertIn(order.order_id, courier.rejected_orders)
self.assertEqual(dispatcher.unassigned_orders, {order.order_id: order})
self.assertEqual(order.state, 'unassigned')
self.assertEqual(courier.location, self.start_location)
self.assertEqual(courier.condition, 'idle')
self.assertIn(courier.courier_id, dispatcher.idle_couriers.keys())