-
+
-
-
+
-
+
+
+
+
+
-
-
+
+
-
-
-
+
-
- WAYBILL
- -
- ![]()
-
- |
+ WAYBILL
+
+
+ |
+
+ |
+
-
+
+
-
-
-
- | Date: | -- - | -
|---|---|
| Incident: | -- - | -
| Request: | -- - | -
| Donation: | -- - | -
-
-
-
- | Transport: | -- - | -
|---|---|
| Vehicle: | -- - | -
| Driver: | -
-
- |
-
+
|
+
+
|
+
-
+
-
-
-
-
- FROM (Origin)
-
-
-
-
- -
- - -
-
-
-
-
- TO (Destination)
-
-
-
-
- -
- - -
+
|
+
+
|
+
| Distribution | +|||
|---|---|---|---|
| Distribution Area: | ++ + | +Est. Beneficiaries: | ++ + | +
| Distribution Type: | ++ + | +||
Items
-| # | -Product | -Quantity | -Unit | -Lot/Batch | +# | +Product | +Demand | +Shipped | +Unit | +Lot/Batch |
|---|---|---|---|---|---|---|---|---|---|---|
| + |
|
- + | - | + | - | + + | + + | +- | + |
|
| Total Items | -
- |
- - | ||||||||
-
-
-
-
- Dispatched By
-
- Name / Signature / Date -
- - Name / Signature / Date -
-
+
+
-
-
|
- Transported By
- - Name / Signature / Date - - -
-
-
-
-
-
- Received By
-
- - Name / Signature / Date -
-
+
- Notes:
-
-
-
+
+
+ Name / Signature / Date
+ |
+
-
diff --git a/spp_drims/static/description/index.html b/spp_drims/static/description/index.html
index 26845b56f..b742de145 100644
--- a/spp_drims/static/description/index.html
+++ b/spp_drims/static/description/index.html
@@ -565,6 +565,26 @@
- ![]()
-
- -
+
+ - -
+ ![]()
+
Changelog
+
+19.0.3.0.4
+-
+
- feat(drims): rework the dispatch page and correct the waybill. +Dispatch & Delivery leads the form instead of sitting behind +Additional Info, a dispatch shows its destination location rather than +an empty Delivery Address, and everything the request already decided +— operation type, source document, source location and the DRIMS +fields — is locked, with Quantity left editable so a partial dispatch +and its backorder can still be produced. The waybill prints on one +page with the signature block intact and the TO box filled in (#1150, +#1151) +
- Deployment note: the waybill’s barcode needs the rlPyCairo +renderer, added to docker/requirements.txt in this change. +Upgrading the module is not enough — the container image has to be +rebuilt, or every report containing a barcode or QR code answers +HTTP 500. The waybill itself still prints without it, minus the +barcode (#1151) +
19.0.3.0.1
- fix(drims): a dispatch validated short no longer leaves the request
@@ -576,7 +596,7 @@
19.0.3.0.1
API (#1087)
+
-
19.0.3.0.0
- feat(drims): allocate stock per source warehouse. The Allocate Stock
@@ -596,7 +616,7 @@
19.0.3.0.0
destination-type selector (#1075)
+
19.0.2.0.0
- Initial migration to OpenSPP2 diff --git a/spp_drims/tests/__init__.py b/spp_drims/tests/__init__.py index 0cd72487f..d3ae52a3e 100644 --- a/spp_drims/tests/__init__.py +++ b/spp_drims/tests/__init__.py @@ -5,6 +5,7 @@ from . import test_allocation_preview_wizard from . import test_approval from . import test_coordination +from . import test_dispatch_page from . import test_dispatch_backorder from . import test_donation from . import test_incident @@ -14,5 +15,6 @@ from . import test_return from . import test_return_wizard from . import test_stock +from . import test_waybill_report from . import test_template from . import test_wizard diff --git a/spp_drims/tests/test_dispatch_page.py b/spp_drims/tests/test_dispatch_page.py new file mode 100644 index 000000000..6ead5bce3 --- /dev/null +++ b/spp_drims/tests/test_dispatch_page.py @@ -0,0 +1,279 @@ +# Part of OpenSPP. See LICENSE file for full copyright and licensing details. +"""OP#1150: the dispatch form should put the DRIMS work where you look first. + +The tab moves to second place and is renamed, "Delivery Address" gives way to +the destination location, and the destination has to actually be populated. +""" + +from datetime import date, timedelta + +from lxml import etree + +from odoo.tests import tagged +from odoo.tools.safe_eval import safe_eval + +from .common import DrimsTestCommon + + +@tagged("post_install", "-at_install") +class TestDrimsDispatchPage(DrimsTestCommon): + """Structure of the inherited stock.picking form.""" + + def setUp(self): + super().setUp() + self.future_date = date.today() + timedelta(days=30) + + # ------------------------------------------------------------------ + # helpers + # ------------------------------------------------------------------ + + def _form_arch(self): + view = self.env["stock.picking"].get_view(self.env.ref("stock.view_picking_form").id, "form") + return etree.fromstring(view["arch"]) + + def _hidden_for(self, node, **record): + """Evaluate a node's ``invisible`` expression against field values.""" + return bool(safe_eval(node.get("invisible", "False"), dict(record))) + + def _dispatch_with_destination(self, with_destination_warehouse=True): + destination = self.env["stock.warehouse"].create( + {"name": "DP Destination WH", "code": "DPD", "is_drims_warehouse": True} + ) + self.env["stock.quant"].create( + { + "product_id": self.product.id, + "location_id": self.warehouse.lot_stock_id.id, + "quantity": 50, + } + ) + vals = { + "incident_id": self.incident.id, + "destination_area_id": self.area.id, + "date_needed": self.future_date, + "line_ids": [ + ( + 0, + 0, + { + "product_id": self.product.id, + "quantity_requested": 50, + "uom_id": self.product.uom_id.id, + }, + ) + ], + } + if with_destination_warehouse: + vals["destination_warehouse_id"] = destination.id + request = self.env["spp.drims.request"].create(vals) + request.action_submit() + request.action_approve() + request.action_allocate() + request.action_create_dispatch() + return request, request.picking_ids, destination + + # ------------------------------------------------------------------ + # the tab + # ------------------------------------------------------------------ + + def test_drims_tab_is_second_and_renamed(self): + pages = self._form_arch().xpath("//notebook/page") + labels = [(p.get("name"), p.get("string")) for p in pages] + + self.assertGreaterEqual(len(labels), 2, f"unexpected notebook layout: {labels}") + self.assertEqual( + labels[0][0], + "operations", + f"Operations should still lead the notebook, got {labels}", + ) + self.assertEqual( + labels[1], + ("drims", "Dispatch & Delivery"), + f"the DRIMS tab should sit second and be renamed, got {labels}", + ) + + def test_drims_tab_still_hidden_on_non_drims_pickings(self): + """Renaming and moving it must not make it show up on plain transfers.""" + page = self._form_arch().xpath("//notebook/page[@name='drims']")[0] + + self.assertTrue(self._hidden_for(page, drims_type_id=False)) + self.assertFalse(self._hidden_for(page, drims_type_id=1)) + + # ------------------------------------------------------------------ + # Delivery Address out, Destination Location in + # ------------------------------------------------------------------ + + def test_delivery_address_hidden_only_for_dispatches(self): + arch = self._form_arch() + field = arch.xpath("//field[@name='partner_id'][@nolabel='1']")[0] + # contains(@class, ...) rather than Odoo's hasclass(), which is an Odoo + # XPath extension and is not available to plain lxml here. + label_block = arch.xpath("//div[contains(@class, 'o_td_label')][label[@for='partner_id']]")[0] + + for node, what in ((field, "field"), (label_block, "label")): + self.assertTrue( + self._hidden_for(node, drims_type="request_dispatch"), + f"Delivery Address {what} should be hidden on a dispatch", + ) + # Receipts, transfers, returns and plain stock pickings keep it. + self.assertFalse( + self._hidden_for(node, drims_type="donation_receipt"), + f"Delivery Address {what} should remain on a donation receipt", + ) + self.assertFalse( + self._hidden_for(node, drims_type=False), + f"Delivery Address {what} should remain on a non-DRIMS picking", + ) + + def test_destination_location_shown_only_for_dispatches(self): + candidates = self._form_arch().xpath("//field[@name='location_dest_id'][@string='Destination Location']") + self.assertEqual(len(candidates), 1, "expected exactly one DRIMS destination field") + field = candidates[0] + + self.assertFalse(self._hidden_for(field, drims_type="request_dispatch")) + self.assertTrue(self._hidden_for(field, drims_type="donation_receipt")) + self.assertTrue(self._hidden_for(field, drims_type=False)) + self.assertEqual(field.get("readonly"), "1", "the destination is set by the request") + + # ------------------------------------------------------------------ + # "ensure that field is properly populated" + # ------------------------------------------------------------------ + + def test_destination_is_the_request_destination_warehouse(self): + _request, picking, destination = self._dispatch_with_destination() + + self.assertEqual(picking.location_dest_id, destination.lot_stock_id) + self.assertTrue(picking.location_dest_id.complete_name) + + def test_destination_falls_back_when_no_destination_warehouse(self): + """Without a destination warehouse the dispatch still names a location.""" + _request, picking, _destination = self._dispatch_with_destination(with_destination_warehouse=False) + + self.assertTrue( + picking.location_dest_id, + "a dispatch must always have a destination location to print and display", + ) + + # ------------------------------------------------------------------ + # round 2: what a dispatch must not let you change + # ------------------------------------------------------------------ + + def _readonly_for(self, node, **record): + """Evaluate a node's ``readonly`` expression against field values.""" + return bool(safe_eval(node.get("readonly", "False"), dict(record))) + + def _outside_list(self, arch, name): + """Header copies of a field, ignoring the moves-list copies. + + Core declares picking_type_id and location_id in the list as well, so a + bare //field[@name=...] is ambiguous. + """ + return [ + n for n in arch.xpath(f"//field[@name='{name}']") if not any(a.tag == "list" for a in n.iterancestors()) + ] + + def _shown_for(self, arch, name, **record): + """The one copy of ``name`` rendered for a picking with these values. + + Some fields are declared twice with mutually exclusive ``invisible`` — + core's copy plus a dispatch-only replacement — so "the field" is only + meaningful once you say which kind of picking you are looking at. + """ + record.setdefault("picking_type_code", "outgoing") + record.setdefault("state", "assigned") + shown = [n for n in self._outside_list(arch, name) if not self._hidden_for(n, **record)] + self.assertEqual(len(shown), 1, f"expected exactly one {name} visible for {record}, found {len(shown)}") + return shown[0] + + def _shown_on_dispatch(self, arch, name): + return self._shown_for(arch, name, drims_type="request_dispatch") + + def test_header_fields_are_locked_on_a_dispatch(self): + """Operation Type, Source Location and Source Document are set by the + request, so a dispatch must not offer them for editing (OP#1150).""" + # Source Location only renders for multi-location users; core keeps a + # complementary invisible copy for everyone else, so exactly one of the + # two survives into the arch and this decides which. + self.env.user.group_ids = [(4, self.env.ref("stock.group_stock_multi_locations").id)] + arch = self._form_arch() + + for name in ("picking_type_id", "location_id", "origin"): + with self.subTest(field=name): + node = self._shown_on_dispatch(arch, name) + self.assertTrue( + self._readonly_for(node, state="assigned", drims_type="request_dispatch"), + f"{name} is still editable on a dispatch", + ) + # An ordinary transfer keeps core's copy, which stays editable. + core = self._shown_for(arch, name, drims_type=False) + self.assertFalse( + self._readonly_for(core, state="assigned", drims_type=False), + f"{name} must stay editable on an ordinary transfer", + ) + + def test_source_location_is_inert_on_a_dispatch_not_merely_read_only(self): + """Read-only is not enough — it still renders as a link to the location. + + QA asked whether Source Location had become clickable. It had: making a + many2one read-only turns it into an internal link, and ``no_open`` + cannot be conditional because ``options`` is a static dict. Core sets + no_open on picking_type_id already, which is why that one is inert; it + does not on location_id, so a dispatch gets its own copy. + """ + self.env.user.group_ids = [(4, self.env.ref("stock.group_stock_multi_locations").id)] + node = self._shown_on_dispatch(self._form_arch(), "location_id") + + self.assertNotEqual(node.get("invisible"), "1", "the lock landed on the hidden copy") + self.assertEqual(node.get("readonly"), "1") + self.assertIn("'no_open': True", node.get("options") or "", "Source Location still links out") + + def test_operation_type_is_inert_too(self): + """picking_type_id is read-only and already carries core's no_open.""" + self.env.user.group_ids = [(4, self.env.ref("stock.group_stock_multi_locations").id)] + node = self._shown_on_dispatch(self._form_arch(), "picking_type_id") + + self.assertIn("'no_open': True", node.get("options") or "") + + def test_dispatch_product_is_locked_but_quantity_is_not(self): + """The line-up is the request's; the quantity shipped is not. + + Entering less than Demand is how a partial dispatch and its backorder + are produced (OP#1087), so quantity has to stay editable. + """ + arch = self._form_arch() + moves = arch.xpath("//page[@name='operations']/field[@name='move_ids']/list") + self.assertEqual(len(moves), 1) + + product = moves[0].xpath("./field[@name='product_id']") + self.assertEqual(len(product), 1) + self.assertIn( + "parent.drims_type == 'request_dispatch'", + product[0].get("readonly") or "", + "the product can still be swapped on a dispatch", + ) + + for qty_field in ("quantity", "product_uom_qty"): + for node in moves[0].xpath(f"./field[@name='{qty_field}']"): + self.assertNotIn( + "drims_type", + node.get("readonly") or "", + f"{qty_field} must stay editable — short shipment drives the backorder", + ) + + def test_drims_information_is_read_only_on_a_dispatch(self): + """Every field in that group is written by the system, not the user.""" + arch = self._form_arch() + group = arch.xpath("//group[@name='drims_info']") + self.assertEqual(len(group), 1) + + for name in ("drims_type_id", "waybill_number", "drims_request_id", "incident_id"): + with self.subTest(field=name): + nodes = group[0].xpath(f"./field[@name='{name}']") + self.assertEqual(len(nodes), 1, f"{name} missing from DRIMS Information") + self.assertTrue( + self._readonly_for(nodes[0], drims_type="request_dispatch"), + f"{name} is still editable on a dispatch", + ) + self.assertFalse( + self._readonly_for(nodes[0], drims_type="donation_receipt"), + f"{name} must stay editable on a donation receipt", + ) diff --git a/spp_drims/tests/test_waybill_report.py b/spp_drims/tests/test_waybill_report.py new file mode 100644 index 000000000..e92dd9994 --- /dev/null +++ b/spp_drims/tests/test_waybill_report.py @@ -0,0 +1,256 @@ +# Part of OpenSPP. See LICENSE file for full copyright and licensing details. +"""OP#1151: the waybill has to survive wkhtmltopdf and say the right things. + +Content is asserted against the rendered QWeb HTML, which is fast and stable. +The PDF layout itself — columns sitting side by side, the document fitting on one +page, the barcode appearing as an embedded image — was verified by rendering the +real PDF and inspecting it with pdfimages/pdftotext; that is not repeated here +because driving wkhtmltopdf in a test is slow and brittle. +""" + +from datetime import date, timedelta + +from odoo.tests import tagged + +from .common import DrimsTestCommon + + +@tagged("post_install", "-at_install") +class TestDrimsWaybillReport(DrimsTestCommon): + """Rendered content of the waybill, plus the embedded barcode helper.""" + + def setUp(self): + super().setUp() + self.future_date = date.today() + timedelta(days=30) + self.dest_warehouse = self.env["stock.warehouse"].create( + { + "name": "Waybill Destination WH", + "code": "WBD", + "is_drims_warehouse": True, + } + ) + + # ------------------------------------------------------------------ + # helpers + # ------------------------------------------------------------------ + + def _vocab(self, namespace, code): + return self.vocab_code.search( + [ + ("vocabulary_id.namespace_uri", "=", f"urn:openspp:vocab:drims:{namespace}"), + ("code", "=", code), + ], + limit=1, + ) + + def _dispatch(self, requested=200, shipped=180): + self.env["stock.quant"].create( + { + "product_id": self.product.id, + "location_id": self.warehouse.lot_stock_id.id, + "quantity": requested, + } + ) + request = self.env["spp.drims.request"].create( + { + "incident_id": self.incident.id, + "destination_area_id": self.area.id, + "date_needed": self.future_date, + "destination_warehouse_id": self.dest_warehouse.id, + "line_ids": [ + ( + 0, + 0, + { + "product_id": self.product.id, + "quantity_requested": requested, + "uom_id": self.product.uom_id.id, + }, + ) + ], + } + ) + request.action_submit() + request.action_approve() + # OP#1079: quantity_allocated is a stored compute over per-warehouse + # allocation rows, so allocating means recording a row. + self.env["spp.drims.request.allocation"].create( + { + "request_line_id": request.line_ids[0].id, + "warehouse_id": self.warehouse.id, + "quantity_allocated": requested, + } + ) + request.state_id = self._vocab("request-states", "allocated") + request.action_create_dispatch() + picking = request.picking_ids + picking.write( + { + "beneficiary_count": 320, + "beneficiary_area_id": self.area.id, + "distribution_type_id": self.env["spp.vocabulary.code"] + .search( + [ + ( + "vocabulary_id.namespace_uri", + "=", + "urn:openspp:vocab:drims:distribution-types", + ) + ], + limit=1, + ) + .id, + "transport_mode_id": self._vocab("transport-modes", "road").id, + "vehicle_registration": "ABC-1234", + "driver_name": "Juan Dela Cruz", + "note": "
NOTE_MUST_NOT_APPEAR
", + } + ) + move = picking.move_ids[0] + move.quantity = shipped + move.picked = True + return request, picking + + def _render(self, picking): + html = self.env["ir.actions.report"]._render_qweb_html("spp_drims.report_waybill", picking.ids)[0] + return html.decode() if isinstance(html, bytes) else html + + # ------------------------------------------------------------------ + # layout: no flexbox, because wkhtmltopdf cannot render it + # ------------------------------------------------------------------ + + def test_layout_uses_no_bootstrap_grid_or_card(self): + """Guards the reason this template is table-based. + + wkhtmltopdf 0.12 is a WebKit build with no flexbox, so Bootstrap's `row`, + `col-*` and `card` all collapse and every column stacks — which used to + push the signature row onto a second page. Anyone reintroducing them will + not see the damage in the browser preview, only in the PDF, so fail here + instead. + """ + _request, picking = self._dispatch() + html = self._render(picking) + + body = html.split('', 1)[-1]
+ for banned in ('class="row', 'class="col-', 'class="card'):
+ self.assertNotIn(
+ banned,
+ body,
+ f'{banned}" reintroduced into the waybill; it will stack in the PDF',
+ )
+
+ # ------------------------------------------------------------------
+ # content that had to go
+ # ------------------------------------------------------------------
+
+ def test_total_items_footer_is_gone(self):
+ """It counted move lines, not quantity — 1 for a 200-unit consignment."""
+ _request, picking = self._dispatch()
+ self.assertNotIn("Total Items", self._render(picking))
+
+ def test_picking_note_is_not_printed(self):
+ _request, picking = self._dispatch()
+ self.assertNotIn("NOTE_MUST_NOT_APPEAR", self._render(picking))
+
+ # ------------------------------------------------------------------
+ # content that had to change
+ # ------------------------------------------------------------------
+
+ def test_shipped_quantity_is_shown_alongside_demand(self):
+ """The waybill accompanies the goods, so it must state what is on board."""
+ _request, picking = self._dispatch(requested=200, shipped=180)
+ html = self._render(picking)
+
+ self.assertIn("Shipped", html)
+ self.assertIn("Demand", html)
+ self.assertIn("180.00", html, "picked quantity missing from the waybill")
+ self.assertIn("200.00", html, "demand should remain for reconciliation")
+
+ def test_destination_falls_back_to_the_location(self):
+ """partner_id is normally blank on a dispatch, which left TO empty."""
+ _request, picking = self._dispatch()
+ self.assertFalse(picking.partner_id, "precondition: no delivery address is set")
+
+ html = self._render(picking)
+
+ self.assertIn("TO (Destination)", html)
+ self.assertIn("Waybill Destination WH", html)
+ self.assertIn(picking.location_dest_id.complete_name, html)
+
+ def test_distribution_details_are_printed(self):
+ _request, picking = self._dispatch()
+ html = self._render(picking)
+
+ self.assertIn("Distribution Area", html)
+ self.assertIn(self.area.name, html)
+ self.assertIn("320", html, "estimated beneficiaries missing")
+ self.assertIn("Distribution Type", html)
+
+ def test_transaction_type_is_printed(self):
+ """One template serves dispatches and donation receipts; say which."""
+ _request, picking = self._dispatch()
+ self.assertIn(picking.drims_type_id.display, self._render(picking))
+
+ def test_vehicle_and_driver_rows_survive_being_empty(self):
+ """They are labels to write on, so the row must print regardless."""
+ _request, picking = self._dispatch()
+ picking.write({"vehicle_registration": False, "driver_name": False})
+
+ html = self._render(picking)
+
+ self.assertIn("Vehicle:", html)
+ self.assertIn("Driver:", html)
+
+ def test_request_row_shown_and_donation_row_hidden_for_a_dispatch(self):
+ """Only the one that applies to this transaction type."""
+ _request, picking = self._dispatch()
+ html = self._render(picking)
+
+ self.assertIn("Request:", html)
+ self.assertNotIn("Donation:", html)
+
+ # ------------------------------------------------------------------
+ # barcode
+ # ------------------------------------------------------------------
+
+ def test_barcode_is_embedded_not_fetched(self):
+ """Embedded so it does not depend on web.base.url being reachable.
+
+ A relative /report/barcode/ URL requires wkhtmltopdf to fetch over HTTP
+ from inside the rendering process, where web.base.url usually points at an
+ external host and port that cannot be reached — the barcode then vanishes
+ with no error.
+ """
+ _request, picking = self._dispatch()
+ html = self._render(picking)
+
+ self.assertNotIn("/report/barcode/", html, "barcode is being fetched over HTTP again")
+ self.assertIn("data:image/png;base64,", html)
+
+ def test_barcode_helper_returns_a_png_data_uri(self):
+ _request, picking = self._dispatch()
+
+ uri = picking._get_waybill_barcode_data_uri()
+
+ self.assertTrue(uri.startswith("data:image/png;base64,"))
+ self.assertGreater(len(uri), 200, "barcode payload looks empty")
+
+ def test_barcode_helper_is_falsy_without_a_waybill_number(self):
+ _request, picking = self._dispatch()
+ picking.waybill_number = False
+
+ self.assertFalse(picking._get_waybill_barcode_data_uri())
+
+ def test_waybill_still_renders_when_the_barcode_cannot_be_built(self):
+ """A missing renderPM backend must not stop a waybill printing."""
+ _request, picking = self._dispatch()
+
+ def boom(*args, **kwargs):
+ raise OSError("cannot import desired renderPM backend rlPyCairo")
+
+ self.patch(type(self.env["ir.actions.report"]), "barcode", boom)
+
+ self.assertFalse(picking._get_waybill_barcode_data_uri())
+ html = self._render(picking)
+ self.assertIn("WAYBILL", html)
+ self.assertIn(picking.waybill_number, html)
diff --git a/spp_drims/views/stock_move_views.xml b/spp_drims/views/stock_move_views.xml
new file mode 100644
index 000000000..fbe934335
--- /dev/null
+++ b/spp_drims/views/stock_move_views.xml
@@ -0,0 +1,81 @@
+
+
+
+
+
+
+ stock.move.form.drims
+ stock.move
+
+
+
+
+
+
+
+
+ stock.move.operations.form.drims
+ stock.move
+
+
+
+
+
+
+
+
+
+
+ stock.move.list.drims
+ stock.move
+
+
+
+
+
+
diff --git a/spp_drims/views/stock_picking_views.xml b/spp_drims/views/stock_picking_views.xml
index 5d1540ec5..13d539c91 100644
--- a/spp_drims/views/stock_picking_views.xml
+++ b/spp_drims/views/stock_picking_views.xml
@@ -117,6 +117,99 @@
state != 'done' or drims_type_id
+
+
+ state in ('done', 'cancel') or drims_type == 'request_dispatch'
+
+
+
+ picking_type_code == 'incoming' or drims_type == 'request_dispatch'
+
+
+
+
+ state in ['cancel', 'done'] or drims_type == 'request_dispatch'
+
+
+
+
+ (state != 'draft' and not additional) or move_lines_count > 0 or parent.drims_type == 'request_dispatch'
+
+
-
-
-
+
+
+ drims_type == 'request_dispatch'
+
+
+ drims_type == 'request_dispatch'
+
+
+
+
+
+
+
+
-