chore: test creation of leave ledger entries depending on leave type while encashing leaves (backport #2633)

hrms/hr/doctype/leave_encashment/test_leave_encashment.py

@@ -8,6 +8,8 @@
 from erpnext.setup.doctype.employee.test_employee import make_employee
 from erpnext.setup.doctype.holiday_list.test_holiday_list import set_holiday_list
 
+from hrms.hr.doctype.leave_allocation.leave_allocation import get_unused_leaves
+from hrms.hr.doctype.leave_ledger_entry.leave_ledger_entry import process_expired_allocation
 from hrms.hr.doctype.leave_period.test_leave_period import create_leave_period
 from hrms.hr.doctype.leave_policy.test_leave_policy import create_leave_policy
 from hrms.hr.doctype.leave_policy_assignment.leave_policy_assignment import (
@@ -31,8 +33,10 @@ def setUp(self):
 		frappe.db.delete("Additional Salary")
 		frappe.db.delete("Leave Encashment")
 
-		if not frappe.db.exists("Leave Type", "_Test Leave Type Encashment"):
-			frappe.get_doc(test_records[2]).insert()
+		self.leave_type = "_Test Leave Type Encashment"
+		if frappe.db.exists("Leave Type", self.leave_type):
+			frappe.delete_doc("Leave Type", self.leave_type, force=True)
+		frappe.get_doc(test_records[2]).insert()
 
 		date = getdate()
 		year_start = getdate(get_year_start(date))
@@ -148,3 +152,102 @@ def test_creation_of_leave_ledger_entry_on_submit(self):
 
 		leave_encashment.cancel()
 		self.assertFalse(frappe.db.exists("Leave Ledger Entry", {"transaction_name": leave_encashment.name}))
+
+	@set_holiday_list("_Test Leave Encashment", "_Test Company")
+	def test_unused_leaves_after_leave_encashment_for_carry_forwarding_leave_type(self):
+		employee = make_employee("[email protected]", company="_Test Company")
+		# allocated 10 leaves, encashable threshold is set 5 in test records, so encashed days are 5
+		leave_encashment = self.get_encashment_created_after_leave_period(employee, is_carry_forward=1)
+		# check if unused leaves are 5 before processing expired allocation runs
+		unused_leaves = get_unused_leaves(
+			employee, self.leave_type, self.leave_period.from_date, self.leave_period.to_date
+		)
+		self.assertEqual(unused_leaves, 5)
+
+		# check if a single leave ledger entry is created
+		self.assertEqual(frappe.get_value("Leave Type", self.leave_type, "is_carry_forward"), 1)
+		leave_ledger_entry = frappe.get_all(
+			"Leave Ledger Entry", fields=["leaves"], filters={"transaction_name": leave_encashment.name}
+		)
+		self.assertEqual(len(leave_ledger_entry), 1)
+		self.assertEqual(leave_ledger_entry[0].leaves, leave_encashment.encashable_days * -1)
+
+		# check if unused leaves are 5 after processing expired allocation runs
+		process_expired_allocation()
+		unused_leaves = get_unused_leaves(
+			employee, self.leave_type, self.leave_period.from_date, self.leave_period.to_date
+		)
+		self.assertEqual(unused_leaves, 5)
+
+	@set_holiday_list("_Test Leave Encashment", "_Test Company")
+	def test_leave_expiry_after_leave_encashment_for_non_carry_forwarding_leave_type(self):
+		employee = make_employee("[email protected]", company="_Test Company")
+		# allocated 10 leaves, encashable days threshold is 5, so encashed days are 5
+
+		leave_encashment = self.get_encashment_created_after_leave_period(employee, is_carry_forward=0)
+		# when leave encashment is created after leave allocation period is over,
+		# it's assumed that process expired allocation has expired the leaves,
+		# hence a reverse ledger entry should be created for the encashment
+		# check if two leave ledger entries are created
+		self.assertEqual(frappe.get_value("Leave Type", self.leave_type, "is_carry_forward"), 0)
+		leave_ledger_entry = frappe.get_all(
+			"Leave Ledger Entry",
+			fields="*",
+			filters={"transaction_name": leave_encashment.name},
+			order_by="leaves",
+		)
+		self.assertEqual(len(leave_ledger_entry), 2)
+		self.assertEqual(leave_ledger_entry[0].leaves, leave_encashment.encashable_days * -1)
+		self.assertEqual(leave_ledger_entry[1].leaves, leave_encashment.encashable_days * 1)
+
+		# check if 10 leaves are expired after processing expired allocation runs
+		process_expired_allocation()
+
+		expired_leaves = frappe.get_value(
+			"Leave Ledger Entry",
+			{"employee": employee, "leave_type": self.leave_type, "is_expired": 1},
+			"leaves",
+		)
+		self.assertEqual(expired_leaves, -10)
+
+	def get_encashment_created_after_leave_period(self, employee, is_carry_forward):
+		frappe.db.delete("Leave Period", {"name": self.leave_period.name})
+		# create new leave period that has end date of yesterday
+		start_date = add_days(getdate(), -30)
+		end_date = add_days(getdate(), -1)
+		self.leave_period = create_leave_period(start_date, end_date, "_Test Company")
+		frappe.db.set_value(
+			"Leave Type",
+			self.leave_type,
+			{
+				"is_carry_forward": is_carry_forward,
+			},
+		)
+
+		leave_policy = frappe.get_value("Leave Policy", {"title": "Test Leave Policy"}, "name")
+		data = {
+			"assignment_based_on": "Leave Period",
+			"leave_policy": leave_policy,
+			"leave_period": self.leave_period.name,
+		}
+		create_assignment_for_multiple_employees([employee], frappe._dict(data))
+
+		make_salary_structure(
+			"Salary Structure for Encashment",
+			"Monthly",
+			employee,
+			other_details={"leave_encashment_amount_per_day": 50},
+		)
+
+		leave_encashment = frappe.get_doc(
+			{
+				"doctype": "Leave Encashment",
+				"employee": employee,
+				"leave_type": self.leave_type,
+				"leave_period": self.leave_period.name,
+				"encashment_date": self.leave_period.to_date,
+				"currency": "INR",
+			}
+		).insert()
+		leave_encashment.submit()
+		return leave_encashment