Files
enterprise-addons/delivery_starshipit/tests/test_delivery_starshipit.py
T

370 lines
16 KiB
Python

# Part of Odoo. See LICENSE file for full copyright and licensing details.
import json
from contextlib import contextmanager
from unittest.mock import patch
import requests
from odoo import Command
from odoo.tests import TransactionCase, tagged
from odoo.exceptions import UserError
@contextmanager
def _mock_starshipit_call(
simulate_unavailable_price=False,
simulate_error=False,
simulate_error_for=None,
):
def _should_simulate_error(url):
if simulate_error_for:
if isinstance(simulate_error_for, str):
return simulate_error_for in url
else:
return any(endpoint in url for endpoint in simulate_error_for)
else:
return simulate_error
def _mock_request(*args, **kwargs):
method = kwargs.get('method') or args[0]
url = kwargs.get('url') or args[1]
data = kwargs.get('json') or {}
responses = {
'GET': {
'/shipment/clone': {
'success': True,
'order': {'order_id': 'CP0123457', 'order_number': data.get('orders', [{}])[0].get('order_number')},
},
'orders': {
'success': True,
'order': {'order_id': 'CP0123456', 'manifested': False, 'total_shipping_price': 4.20}
}
},
'POST': {
'deliveryservices': {
'success': True,
'services': [
{'carrier': 'CourierPostA', 'carrier_name': 'Courier Post A', 'service_name': 'Courier Post Island A', 'service_code': 'CP01ILA', 'total_price': 4.20},
{'carrier': 'CourierPostB', 'carrier_name': 'Courier Post B', 'service_name': 'Courier Post Island B', 'service_code': 'CP01ILB', 'total_price': 6.20},
]
},
'rates': {
'success': True,
'rates': [
{'service_name': 'Courier Post Island', 'service_code': 'CP01IL', 'total_price': 4.20},
{'service_name': 'Courier Post Inland', 'service_code': 'CP02IL', 'total_price': 6.90},
]
},
# For simplicity, we only set the two id's used by the backend.
'orders/import': {
'success': True,
'orders': [{'order_id': 'CP0123456', 'order_number': data.get('orders', [{}])[0].get('order_number')}],
},
'orders/shipment': {
'success': True,
'tracking_numbers': ['123tracking'],
'labels': ['WW91J3JlIGEgY3VyaW91cyBvbmUgYXJlbid0IHlvdQ=='],
},
'archive': {
'success': True,
},
}
}
if simulate_unavailable_price and method == 'GET' and 'orders' in url:
# Simulate a Starshipit call that doesn't return the shipping price yet
responses['GET']['orders']['order'].pop('total_shipping_price')
for endpoint, content in responses[method].items():
if endpoint in url:
response = requests.Response()
if _should_simulate_error(url):
# Simulate error on Starshpit call
response._content = json.dumps({
'success': False,
'errors': [{
"message": "General Exception",
"details": "Simulated error for testing purposes."
}]
}).encode()
response.status_code = 500
return response
else:
response._content = json.dumps(content).encode()
response.status_code = 200
return response
raise Exception('unhandled request url %s' % url)
with patch.object(requests.Session, 'request', _mock_request):
yield
@tagged('post_install', '-at_install')
class TestDeliveryStarShipIt(TransactionCase):
@classmethod
def setUpClass(cls):
super().setUpClass()
cls.your_company = cls.env.ref("base.main_partner")
cls.your_company.write({
'name': 'Odoo SAU',
'country_id': cls.env.ref('base.au').id,
'street': '25 Walters Street',
'street2': False,
'state_id': cls.env.ref('base.state_au_7').id,
'city': 'Taminick',
'zip': 3675,
'phone': '0353483783',
})
cls.au_partner = cls.env['res.partner'].create({
'name': 'Acme Corporation',
'is_company': True,
'street': '26 Acheron Road',
'street2': False,
'city': 'Hazelwood North',
'country_id': cls.env.ref('base.au').id,
'zip': 3840,
'state_id': cls.env.ref('base.state_au_7').id,
'email': 'acme.corp82@example.com',
'phone': '0353229781',
})
cls.product_to_ship1 = cls.env["product.product"].create({
'name': 'Door with Legs',
'type': 'consu',
'weight': 10.0
})
cls.product_to_ship2 = cls.env["product.product"].create({
'name': 'Door with Arms',
'type': 'consu',
'weight': 15.0
})
shipping_product = cls.env['product.product'].create({
'name': 'StarShipIt Delivery',
'type': 'service'
})
cls.starshipit = cls.env['delivery.carrier'].create({
'delivery_type': 'starshipit',
'product_id': shipping_product.id,
'starshipit_api_key': 'mock_key',
'starshipit_subscription_key': 'mock_key',
'name': 'StarShipIt',
'starshipit_service_code': 'CP01IL',
'starshipit_carrier_code': 'CourierPost',
'invoice_policy': 'real',
})
cls.starshipit_second = cls.env['delivery.carrier'].create({
'delivery_type': 'starshipit',
'product_id': shipping_product.id,
'starshipit_api_key': 'mock_key',
'starshipit_subscription_key': 'mock_key',
'name': 'StarShipIt Second',
'starshipit_service_code': 'CP02IL',
'starshipit_carrier_code': 'CourierPost',
})
def test_rate_order(self):
""" Set up a sale order for an AU client and ensure that the rate is computed properly. """
sale_order = self.env['sale.order'].create({
'partner_id': self.au_partner.id,
'order_line': [
Command.create({
'product_id': self.product_to_ship1.id
}),
Command.create({
'product_id': self.product_to_ship2.id
})
]
})
wiz_action = sale_order.action_open_delivery_wizard()
choose_delivery_carrier = self.env[wiz_action['res_model']].with_context(wiz_action['context']).create({
'carrier_id': self.starshipit.id,
'order_id': sale_order.id
})
with _mock_starshipit_call():
choose_delivery_carrier.update_price()
self.assertEqual(choose_delivery_carrier.delivery_price, 4.20)
def test_shipping_order(self):
""" Ensure that the shipping of an order works properly. """
sale_order = self.env['sale.order'].create({
'partner_id': self.au_partner.id,
'order_line': [
Command.create({
'product_id': self.product_to_ship1.id
}),
Command.create({
'product_id': self.product_to_ship2.id
})
]
})
wiz_action = sale_order.action_open_delivery_wizard()
choose_delivery_carrier = self.env[wiz_action['res_model']].with_context(wiz_action['context']).create({
'carrier_id': self.starshipit.id,
'order_id': sale_order.id
})
with _mock_starshipit_call():
choose_delivery_carrier.update_price()
choose_delivery_carrier.button_confirm()
sale_order.action_confirm()
self.assertGreater(len(sale_order.picking_ids), 0, "The Sales Order did not generate pickings for shipment.")
picking = sale_order.picking_ids[0]
self.assertEqual(picking.carrier_id.id, sale_order.carrier_id.id, "The carrier is not the same on Picking and on SO.")
picking.action_assign()
picking.move_ids.picked = True
self.assertGreater(picking.weight, 0.0, "The picking weight should be positive.")
picking._action_done()
self.assertIsNot(picking.starshipit_parcel_reference, False, "The StarShipIt Parcel Reference is not set")
# Check that we the PDF is there and contains the "label"
pdf = picking.message_ids.attachment_ids.filtered(lambda m: m.datas == b'WW91J3JlIGEgY3VyaW91cyBvbmUgYXJlbid0IHlvdQ==')
self.assertNotEqual(pdf, self.env['ir.attachment'], "The label should be present as a pdf attachment.")
def test_generate_return(self):
sale_order = self.env['sale.order'].create({
'partner_id': self.au_partner.id,
'order_line': [
Command.create({
'product_id': self.product_to_ship1.id
}),
Command.create({
'product_id': self.product_to_ship2.id
})
]
})
wiz_action = sale_order.action_open_delivery_wizard()
choose_delivery_carrier = self.env[wiz_action['res_model']].with_context(wiz_action['context']).create({
'carrier_id': self.starshipit.id,
'order_id': sale_order.id
})
with _mock_starshipit_call():
choose_delivery_carrier.update_price()
choose_delivery_carrier.button_confirm()
sale_order.action_confirm()
self.assertGreater(len(sale_order.picking_ids), 0, "The Sales Order did not generate pickings for shipment.")
picking = sale_order.picking_ids[0]
self.assertEqual(picking.carrier_id.id, sale_order.carrier_id.id, "The carrier is not the same on Picking and on SO.")
picking.action_assign()
picking.move_ids.picked = True
self.assertGreater(picking.weight, 0.0, "The picking weight should be positive.")
picking._action_done()
self.assertIsNot(picking.starshipit_parcel_reference, False, "The StarShipIt Parcel Reference is not set")
# The parcel has been processed, but we wish to return it
picking.carrier_id.starshipit_get_return_label(picking)
self.assertIsNot(picking.starshipit_return_parcel_reference, False, "The StarShipIt Return Parcel Reference is not set")
pdf = picking.message_ids.attachment_ids.filtered(lambda m: m.datas == b'WW91J3JlIGEgY3VyaW91cyBvbmUgYXJlbid0IHlvdQ==')
self.assertEqual(len(pdf), 2, "There should be two label, one for the shipping and one for the return.")
def test_shipping_order_async_price(self):
""" Test the full flow with a delayed price from Starshipit. """
sale_order = self.env['sale.order'].create({
'partner_id': self.au_partner.id,
'order_line': [
Command.create({'product_id': self.product_to_ship1.id})
]
})
with _mock_starshipit_call(simulate_unavailable_price=True):
sale_order.set_delivery_line(self.starshipit, 0)
sale_order.action_confirm()
picking = sale_order.picking_ids[0]
picking.action_assign()
picking.move_ids.picked = True
picking._action_done()
self.assertEqual(picking.carrier_price, 0.0, "Initial carrier_price should be 0.0 as price was pending.")
initial_delivery_line = sale_order.order_line.filtered('is_delivery')
self.assertEqual(initial_delivery_line.price_unit, 0.0, "Initial SO delivery line cost should be 0.0.")
with _mock_starshipit_call(simulate_unavailable_price=False):
self.env['stock.picking']._cron_starshipit_fetch_and_update_prices(auto_commit=False)
self.assertEqual(picking.carrier_price, 4.20, "Final carrier_price on picking should be updated by the cron.")
final_delivery_line = sale_order.order_line.filtered('is_delivery')
self.assertEqual(final_delivery_line.price_unit, 4.20, "Final SO delivery line cost should be updated by the cron.")
def test_partner_address_street2(self):
""" Ensure street2 is taken into account if not False """
au_partner_2 = self.env['res.partner'].create({
'name': 'Acme Corporation',
'street': 'Unit 12 Floor 15',
'street2': '26 Acheron Road',
'city': 'Hazelwood North',
'country_id': self.env.ref('base.au').id,
'zip': 3840,
'state_id': self.env.ref('base.state_au_7').id,
})
starshipit_service = self.starshipit._get_starshipit()
# Without street2
partner_details = starshipit_service._populate_partner_details(self.au_partner)
self.assertEqual(partner_details['street'], '26 Acheron Road')
# With street2
partner_details = starshipit_service._populate_partner_details(au_partner_2)
self.assertEqual(partner_details['street'], 'Unit 12 Floor 15 26 Acheron Road')
def test_retry_shipping_after_label_failure(self):
sale_order = self.env['sale.order'].create({
'partner_id': self.au_partner.id,
'order_line': [
Command.create({'product_id': self.product_to_ship1.id})
]
})
# Simulate error in label creation step
with _mock_starshipit_call(simulate_error_for="shipment"):
sale_order.set_delivery_line(self.starshipit, 0)
sale_order.action_confirm()
picking = sale_order.picking_ids[0]
picking.action_assign()
picking.move_ids.picked = True
with self.assertRaises(UserError):
picking._action_done()
# Simulate successful retry
with _mock_starshipit_call(simulate_error=False):
picking._action_done()
pdf = picking.message_ids.attachment_ids.filtered(lambda m: m.datas == b'WW91J3JlIGEgY3VyaW91cyBvbmUgYXJlbid0IHlvdQ==')
self.assertNotEqual(pdf, self.env['ir.attachment'], "Label should be created successfully on retry.")
def test_create_delivery_method_from_so(self):
""" Test the creation of a delivery method from a sale order. """
sale_order = self.env['sale.order'].create({
'partner_id': self.au_partner.id,
'order_line': [Command.create({'product_id': self.product_to_ship1.id})]
})
# Open "Add Shipping" Wizard in sale order
wiz_action = sale_order.action_open_delivery_wizard()
add_shipping_wizard = self.env[wiz_action['res_model']].with_context(wiz_action['context']).create({
'carrier_id': self.starshipit.id,
'order_id': sale_order.id
})
with _mock_starshipit_call():
# Open "Get more delivery methods" Wizard from "Add Shipping" Wizard
new_delivery_method_wiz_action = add_shipping_wizard.create_new_starshipit_delivery_method()
new_delivery_method_wiz = self.env[new_delivery_method_wiz_action['res_model']].with_context(new_delivery_method_wiz_action['context']).create({})
# Select a service and validate
new_delivery_method_wiz['selected_service_code'] = 'CP01ILB'
result_action = new_delivery_method_wiz.action_validate()
self.assertNotEqual(result_action['context']['default_carrier_id'], self.starshipit.id, "A new carrier id should have been created.")
# Redirected to the "Add Shipping" Wizard with the new carrier
new_add_shipping_wizard = self.env[result_action['res_model']].with_context(result_action['context']).create({})
self.assertEqual(new_add_shipping_wizard.carrier_id.starshipit_service_code, 'CP01ILB', "A new carrier id should have been created with the selected service code.")