[ADD] dynamic_ribbons: add test cases for the better console in future

Author: pbch-odoo

dynamic_ribbons/__manifest__.py

@@ -4,13 +4,13 @@
     'summary': '',
     'author': 'PBCH',
     'category': 'Website',
-    'depends': [ 'website_sale', 'stock' ],
+    'depends': ['website_sale', 'stock'],
     'data': [
         'views/product_ribbon_view.xml',
         'views/snippet.xml',
     ],
     'assets': {
-        'website.assets_wysiwyg':[
+        'website.assets_wysiwyg': [
             'dynamic_ribbons/static/src/js/website_sale_editor.js',
         ],
         'website.backend_assets_all_wysiwyg': [

dynamic_ribbons/controllers/shop_product.py

@@ -1,6 +1,7 @@
 from odoo.addons.website_sale.controllers.main import WebsiteSale
 from odoo import http
 
+
 class WebsiteSaleExtended(WebsiteSale):
 
     @http.route([
@@ -18,4 +19,3 @@ def shop(self, page=0, category=None, search='', min_price=0.0, max_price=0.0, p
                 product._get_ribbon(products_prices)
 
         return response
-        

dynamic_ribbons/models/product_ribbon.py

@@ -1,6 +1,7 @@
 from odoo import fields, models, api
 from odoo.exceptions import ValidationError
 
+
 class ProductRibbon(models.Model):
     _inherit = "product.ribbon"
 
@@ -38,12 +39,11 @@ def create(self, vals_list):
                 if existing_ribbon:
                     raise ValidationError(f"A ribbon with assign type '{assign_type}' already exists. You cannot create another one.")
         return super().create(vals_list)
-        
+
     def write(self, vals):
         assign_type = vals.get('assign')
         if assign_type != 'manual':
             existing_ribbon = self.search([('assign', '=', assign_type), ('id', '!=', self.id)])
             if existing_ribbon:
                 raise ValidationError(f"A ribbon with assign type '{assign_type}' already exists. You cannot assign another one.")
         return super().write(vals)
-        

dynamic_ribbons/models/product_template.py

@@ -1,5 +1,6 @@
 from odoo import models, fields
 
+
 class ProductTemplate(models.Model):
     _inherit = 'product.template'
 
@@ -21,12 +22,12 @@ def _get_ribbon(self, products_prices):
         if out_of_stock_ribbon and self.qty_available <= 0.0 and not self.allow_out_of_stock_order:
             self.website_ribbon_id = out_of_stock_ribbon.id
             self.website_ribbon_auto = True
-            return 
+            return
 
         # Sale Ribbon
         pricelist_price = products_prices[self.id].get('price_reduce')
         sale_ribbon = product_ribbon_sudo.search([('assign', '=', 'sale')])
-        if sale_ribbon and (pricelist_price < self.list_price or self.list_price < self.compare_list_price):            
+        if sale_ribbon and (pricelist_price < self.list_price or self.list_price < self.compare_list_price):        
             self.website_ribbon_id = sale_ribbon.id
             self.website_ribbon_auto = True
             return
@@ -38,12 +39,11 @@ def _get_ribbon(self, products_prices):
             if days_since_publish <= new_ribbon.show_period:
                 self.website_ribbon_id = new_ribbon.id
                 self.website_ribbon_auto = True
-                return  
+                return
 
         # If no ribbon was assigned automatically then clearing any existing automatic ribbon
         self.website_ribbon_id = None
 
-
     def write(self, vals):
         if 'website_ribbon_id' in vals and vals['website_ribbon_id'] != self.website_ribbon_id.id:
             vals['website_ribbon_auto'] = False

dynamic_ribbons/tests/__init__.py

@@ -0,0 +1 @@
+from . import product_ribbons_test_case

dynamic_ribbons/tests/product_ribbons_test_case.py

@@ -0,0 +1,87 @@
+from odoo.tests.common import TransactionCase, tagged
+from odoo.exceptions import ValidationError
+
+
+@tagged("post_install", "-at_install")
+class TestProductribbon(TransactionCase):
+
+    def setUp(self):
+        super().setUp()
+        self.website = self.env["website"].search([], limit=1)
+        self.product = self.env["product.template"].search([], limit=1)
+        self.christmas_pricelist = self.env["product.pricelist"].search(
+            [("name", "=", "Christmas")], limit=1
+        )
+        self.christmas_pricelist.write({"selectable": True})
+        self.prices = self.product._get_sales_prices(self.website)
+
+    def _create_ribbon(self, name, assign):
+        return self.env["product.ribbon"].create({
+            "name": name,
+            "assign": assign,
+        })
+
+    def test_sale_ribbon_is_assigned_when_discount_applies(self):
+        ribbon = self._create_ribbon("Sale", "sale")
+        self.product._get_ribbon(self.prices)
+
+        self.assertEqual(
+            self.product.website_ribbon_id.id,
+            ribbon.id,
+            "Expected Sale ribbon to be assigned when pricelist discount is active."
+        )
+
+    def test_out_of_stock_ribbon_priority_over_sale(self):
+        self.product.write({
+            "qty_available": 0,
+            "allow_out_of_stock_order": False
+        })
+
+        out_ribbon = self._create_ribbon("Out of Stock", "out_of_stock")
+        self._create_ribbon("Sale", "sale")
+        self.product._get_ribbon(self.prices)
+
+        self.assertEqual(
+            self.product.website_ribbon_id.id,
+            out_ribbon.id,
+            "Out of Stock ribbon should take priority over Sale ribbon."
+        )
+
+    def test_validation_error_on_duplicate_ribbon_assign(self):
+        self._create_ribbon("Sale Discount", "sale")
+        with self.assertRaises(ValidationError, msg="Duplicate 'sale' ribbon should raise ValidationError"):
+            self._create_ribbon("Sale Offer", "sale")
+
+    def test_manual_ribbon_should_override_automatic(self):
+        manual = self._create_ribbon("Sold Out", "manual")
+        self.product.write({"website_ribbon_id": manual.id})
+        self._create_ribbon("New", "new")
+
+        self.product._get_ribbon(self.prices)
+
+        self.assertEqual(
+            self.product.website_ribbon_id.id,
+            manual.id,
+            "Manual ribbon must not be replaced by any automatic ribbon."
+        )
+
+    def test_out_of_stock_respects_allow_out_of_stock_flag(self):
+        ribbon = self._create_ribbon("Out of Stock", "out_of_stock")
+
+        # Case 1: Should apply
+        self.product.write({"qty_available": 0, "allow_out_of_stock_order": False})
+        self.product._get_ribbon(self.prices)
+        self.assertEqual(
+            self.product.website_ribbon_id.id,
+            ribbon.id,
+            "Expected Out of Stock ribbon when allow_out_of_stock_order is False."
+        )
+
+        # Case 2: Should NOT apply
+        self.product.write({"allow_out_of_stock_order": True})
+        self.product._get_ribbon(self.prices)
+        self.assertNotEqual(
+            self.product.website_ribbon_id.id,
+            ribbon.id,
+            "Out of Stock ribbon should not be shown when allow_out_of_stock_order is True."
+        )