Merge pull request #37310 from deepeshgarg007/lead_details_qb

chore: rewrite query using query builder

erpnext/crm/report/lead_details/lead_details.py

@@ -4,6 +4,7 @@
 
 import frappe
 from frappe import _
+from frappe.query_builder.functions import Concat_ws, Date
 
 
 def execute(filters=None):
@@ -69,53 +70,41 @@ def get_columns():
 
 
 def get_data(filters):
-	return frappe.db.sql(
+	lead = frappe.qb.DocType("Lead")
-		"""
+	address = frappe.qb.DocType("Address")
-		SELECT
+	dynamic_link = frappe.qb.DocType("Dynamic Link")
-			`tabLead`.name,
+
-			`tabLead`.lead_name,
+	query = (
-			`tabLead`.status,
+		frappe.qb.from_(lead)
-			`tabLead`.lead_owner,
+		.left_join(dynamic_link)
-			`tabLead`.territory,
+		.on((lead.name == dynamic_link.link_name) & (dynamic_link.parenttype == "Address"))
-			`tabLead`.source,
+		.left_join(address)
-			`tabLead`.email_id,
+		.on(address.name == dynamic_link.parent)
-			`tabLead`.mobile_no,
+		.select(
-			`tabLead`.phone,
+			lead.name,
-			`tabLead`.owner,
+			lead.lead_name,
-			`tabLead`.company,
+			lead.status,
-			concat_ws(', ',
+			lead.lead_owner,
-				trim(',' from `tabAddress`.address_line1),
+			lead.territory,
-				trim(',' from tabAddress.address_line2)
+			lead.source,
-			) AS address,
+			lead.email_id,
-			`tabAddress`.state,
+			lead.mobile_no,
-			`tabAddress`.pincode,
+			lead.phone,
-			`tabAddress`.country
+			lead.owner,
-		FROM
+			lead.company,
-			`tabLead` left join `tabDynamic Link` on (
+			(Concat_ws(", ", address.address_line1, address.address_line2)).as_("address"),
-			`tabLead`.name = `tabDynamic Link`.link_name and
+			address.state,
-			`tabDynamic Link`.parenttype = 'Address')
+			address.pincode,
-			left join `tabAddress` on (
+			address.country,
-			`tabAddress`.name=`tabDynamic Link`.parent)
+		)
-		WHERE
+		.where(lead.company == filters.company)
-			company = %(company)s
+		.where(Date(lead.creation).between(filters.from_date, filters.to_date))
-			AND DATE(`tabLead`.creation) BETWEEN %(from_date)s AND %(to_date)s
-			{conditions}
-		ORDER BY
-			`tabLead`.creation asc """.format(
-			conditions=get_conditions(filters)
-		),
-		filters,
-		as_dict=1,
 	)
 
-
-def get_conditions(filters):
-	conditions = []
-
 	if filters.get("territory"):
-		conditions.append(" and `tabLead`.territory=%(territory)s")
+		query = query.where(lead.territory == filters.get("territory"))
 
 	if filters.get("status"):
-		conditions.append(" and `tabLead`.status=%(status)s")
+		query = query.where(lead.status == filters.get("status"))
 
-	return " ".join(conditions) if conditions else ""
+	return query.run(as_dict=1)

erpnext/e_commerce/shopping_cart/test_shopping_cart.py

@@ -17,7 +17,6 @@ from erpnext.e_commerce.shopping_cart.cart import (
 	request_for_quotation,
 	update_cart,
 )
-from erpnext.tests.utils import create_test_contact_and_address
 
 
 class TestShoppingCart(unittest.TestCase):
@@ -28,7 +27,6 @@ class TestShoppingCart(unittest.TestCase):
 
 	def setUp(self):
 		frappe.set_user("Administrator")
-		create_test_contact_and_address()
 		self.enable_shopping_cart()
 		if not frappe.db.exists("Website Item", {"item_code": "_Test Item"}):
 			make_website_item(frappe.get_cached_doc("Item", "_Test Item"))
@@ -46,48 +44,57 @@ class TestShoppingCart(unittest.TestCase):
 		frappe.db.sql("delete from `tabTax Rule`")
 
 	def test_get_cart_new_user(self):
-		self.login_as_new_user()
-
-		# test if lead is created and quotation with new lead is fetched
-		quotation = _get_cart_quotation()
-		self.assertEqual(quotation.quotation_to, "Customer")
-		self.assertEqual(
-			quotation.contact_person,
-			frappe.db.get_value("Contact", dict(email_id="test_cart_user@example.com")),
-		)
-		self.assertEqual(quotation.contact_email, frappe.session.user)
-
-		return quotation
-
-	def test_get_cart_customer(self):
-		def validate_quotation():
-			# test if quotation with customer is fetched
-			quotation = _get_cart_quotation()
-			self.assertEqual(quotation.quotation_to, "Customer")
-			self.assertEqual(quotation.party_name, "_Test Customer")
-			self.assertEqual(quotation.contact_email, frappe.session.user)
-			return quotation
-
 		self.login_as_customer(
 			"test_contact_two_customer@example.com", "_Test Contact 2 For _Test Customer"
 		)
-		validate_quotation()
+		create_address_and_contact(
-
+			address_title="_Test Address for Customer 2",
-		self.login_as_customer()
+			first_name="_Test Contact for Customer 2",
-		quotation = validate_quotation()
+			email="test_contact_two_customer@example.com",
+			customer="_Test Customer 2",
+		)
+		# test if lead is created and quotation with new lead is fetched
+		customer = frappe.get_doc("Customer", "_Test Customer 2")
+		quotation = _get_cart_quotation(party=customer)
+		self.assertEqual(quotation.quotation_to, "Customer")
+		self.assertEqual(
+			quotation.contact_person,
+			frappe.db.get_value("Contact", dict(email_id="test_contact_two_customer@example.com")),
+		)
+		self.assertEqual(quotation.contact_email, frappe.session.user)
 
 		return quotation
 
-	def test_add_to_cart(self):
+	def test_get_cart_customer(self, customer="_Test Customer 2"):
-		self.login_as_customer()
+		def validate_quotation(customer_name):
+			# test if quotation with customer is fetched
+			party = frappe.get_doc("Customer", customer_name)
+			quotation = _get_cart_quotation(party=party)
+			self.assertEqual(quotation.quotation_to, "Customer")
+			self.assertEqual(quotation.party_name, customer_name)
+			self.assertEqual(quotation.contact_email, frappe.session.user)
+			return quotation
 
+		quotation = validate_quotation(customer)
+		return quotation
+
+	def test_add_to_cart(self):
+		self.login_as_customer(
+			"test_contact_two_customer@example.com", "_Test Contact 2 For _Test Customer"
+		)
+		create_address_and_contact(
+			address_title="_Test Address for Customer 2",
+			first_name="_Test Contact for Customer 2",
+			email="test_contact_two_customer@example.com",
+			customer="_Test Customer 2",
+		)
 		# clear existing quotations
 		self.clear_existing_quotations()
 
 		# add first item
 		update_cart("_Test Item", 1)
 
-		quotation = self.test_get_cart_customer()
+		quotation = self.test_get_cart_customer("_Test Customer 2")
 
 		self.assertEqual(quotation.get("items")[0].item_code, "_Test Item")
 		self.assertEqual(quotation.get("items")[0].qty, 1)
@@ -95,7 +102,7 @@ class TestShoppingCart(unittest.TestCase):
 
 		# add second item
 		update_cart("_Test Item 2", 1)
-		quotation = self.test_get_cart_customer()
+		quotation = self.test_get_cart_customer("_Test Customer 2")
 		self.assertEqual(quotation.get("items")[1].item_code, "_Test Item 2")
 		self.assertEqual(quotation.get("items")[1].qty, 1)
 		self.assertEqual(quotation.get("items")[1].amount, 20)
@@ -108,7 +115,7 @@ class TestShoppingCart(unittest.TestCase):
 
 		# update first item
 		update_cart("_Test Item", 5)
-		quotation = self.test_get_cart_customer()
+		quotation = self.test_get_cart_customer("_Test Customer 2")
 		self.assertEqual(quotation.get("items")[0].item_code, "_Test Item")
 		self.assertEqual(quotation.get("items")[0].qty, 5)
 		self.assertEqual(quotation.get("items")[0].amount, 50)
@@ -121,7 +128,7 @@ class TestShoppingCart(unittest.TestCase):
 
 		# remove first item
 		update_cart("_Test Item", 0)
-		quotation = self.test_get_cart_customer()
+		quotation = self.test_get_cart_customer("_Test Customer 2")
 
 		self.assertEqual(quotation.get("items")[0].item_code, "_Test Item 2")
 		self.assertEqual(quotation.get("items")[0].qty, 1)
@@ -132,7 +139,17 @@ class TestShoppingCart(unittest.TestCase):
 	@unittest.skip("Flaky in CI")
 	def test_tax_rule(self):
 		self.create_tax_rule()
-		self.login_as_customer()
+
+		self.login_as_customer(
+			"test_contact_two_customer@example.com", "_Test Contact 2 For _Test Customer"
+		)
+		create_address_and_contact(
+			address_title="_Test Address for Customer 2",
+			first_name="_Test Contact for Customer 2",
+			email="test_contact_two_customer@example.com",
+			customer="_Test Customer 2",
+		)
+
 		quotation = self.create_quotation()
 
 		from erpnext.accounts.party import set_taxes
@@ -320,7 +337,7 @@ class TestShoppingCart(unittest.TestCase):
 		if frappe.db.exists("User", email):
 			return
 
-		frappe.get_doc(
+		user = frappe.get_doc(
 			{
 				"doctype": "User",
 				"user_type": "Website User",
@@ -330,6 +347,40 @@ class TestShoppingCart(unittest.TestCase):
 			}
 		).insert(ignore_permissions=True)
 
+		user.add_roles("Customer")
+
+
+def create_address_and_contact(**kwargs):
+	if not frappe.db.get_value("Address", {"address_title": kwargs.get("address_title")}):
+		frappe.get_doc(
+			{
+				"doctype": "Address",
+				"address_title": kwargs.get("address_title"),
+				"address_type": kwargs.get("address_type") or "Office",
+				"address_line1": kwargs.get("address_line1") or "Station Road",
+				"city": kwargs.get("city") or "_Test City",
+				"state": kwargs.get("state") or "Test State",
+				"country": kwargs.get("country") or "India",
+				"links": [
+					{"link_doctype": "Customer", "link_name": kwargs.get("customer") or "_Test Customer"}
+				],
+			}
+		).insert()
+
+	if not frappe.db.get_value("Contact", {"first_name": kwargs.get("first_name")}):
+		contact = frappe.get_doc(
+			{
+				"doctype": "Contact",
+				"first_name": kwargs.get("first_name"),
+				"links": [
+					{"link_doctype": "Customer", "link_name": kwargs.get("customer") or "_Test Customer"}
+				],
+			}
+		)
+		contact.add_email(kwargs.get("email") or "test_contact_customer@example.com", is_primary=True)
+		contact.add_phone(kwargs.get("phone") or "+91 0000000000", is_primary_phone=True)
+		contact.insert()
+
 
 test_dependencies = [
 	"Sales Taxes and Charges Template",