diff --git a/erpnext/accounts/doctype/bank_statement_import/bank_statement_import.py b/erpnext/accounts/doctype/bank_statement_import/bank_statement_import.py index 2d5422f0d16..28915c8e6d0 100644 --- a/erpnext/accounts/doctype/bank_statement_import/bank_statement_import.py +++ b/erpnext/accounts/doctype/bank_statement_import/bank_statement_import.py @@ -111,20 +111,54 @@ class BankStatementImport(DataImport): return None +def preprocess_mt940_content(content: str) -> str: + """Preprocess MT940 content to fix statement number format issues. + + The MT940 standard expects statement numbers to be maximum 5 digits, + but some banks provide longer statement numbers that cause parsing errors. + This function truncates statement numbers longer than 5 digits to the last 5 digits. + """ + # Fast-path: bail if no :28C: tag exists + if ":28C:" not in content: + return content + + # Match :28C: at start of line, capture digits and optional /seq, preserve whitespace + pattern = re.compile(r"(?m)^(:28C:)(\d{6,})(/\d+)?(\s*)$") + + def replace_statement_number(match): + prefix = match.group(1) # ':28C:' + statement_num = match.group(2) # The statement number + sequence_part = match.group(3) or "" # The sequence part like '/1' + trailing_space = match.group(4) or "" # Preserve trailing whitespace + + # If statement number is longer than 5 digits, truncate to last 5 digits + if len(statement_num) > 5: + statement_num = statement_num[-5:] + + return prefix + statement_num + sequence_part + trailing_space + + # Apply the replacement + processed_content = pattern.sub(replace_statement_number, content) + return processed_content + + @frappe.whitelist() def convert_mt940_to_csv(data_import, mt940_file_path): doc = frappe.get_doc("Bank Statement Import", data_import) - file_doc, content = get_file(mt940_file_path) + _file_doc, content = get_file(mt940_file_path) - if not is_mt940_format(content): + is_mt940 = is_mt940_format(content) + if not is_mt940: frappe.throw(_("The uploaded file does not appear to be in valid MT940 format.")) - if is_mt940_format(content) and not doc.import_mt940_fromat: + if is_mt940 and not doc.import_mt940_fromat: frappe.throw(_("MT940 file detected. Please enable 'Import MT940 Format' to proceed.")) try: - transactions = mt940.parse(content) + # Preprocess MT940 content to fix statement number format issues + processed_content = preprocess_mt940_content(content) + transactions = mt940.parse(processed_content) except Exception as e: frappe.throw(_("Failed to parse MT940 format. Error: {0}").format(str(e))) @@ -249,6 +283,7 @@ def start_import(data_import, bank_account, import_file_path, google_sheets_url, def update_mapping_db(bank, template_options): + """Update bank transaction mapping database with template options.""" bank = frappe.get_doc("Bank", bank) for d in bank.bank_transaction_mapping: d.delete() @@ -260,6 +295,7 @@ def update_mapping_db(bank, template_options): def add_bank_account(data, bank_account): + """Add bank account information to data rows.""" bank_account_loc = None if "Bank Account" not in data[0]: data[0].append("Bank Account") @@ -276,6 +312,7 @@ def add_bank_account(data, bank_account): def write_files(import_file, data): + """Write processed data to CSV or Excel files.""" full_file_path = import_file.file_doc.get_full_path() parts = import_file.file_doc.get_extension() extension = parts[1] @@ -285,11 +322,12 @@ def write_files(import_file, data): with open(full_file_path, "w", newline="") as file: writer = csv.writer(file) writer.writerows(data) - elif extension == "xlsx" or "xls": + elif extension in ("xlsx", "xls"): write_xlsx(data, "trans", file_path=full_file_path) def write_xlsx(data, sheet_name, wb=None, column_widths=None, file_path=None): + """Write data to Excel file with formatting.""" # from xlsx utils with changes column_widths = column_widths or [] if wb is None: diff --git a/erpnext/accounts/doctype/bank_statement_import/test_bank_statement_import.py b/erpnext/accounts/doctype/bank_statement_import/test_bank_statement_import.py index 0dc1093fe1e..3e1cee9115e 100644 --- a/erpnext/accounts/doctype/bank_statement_import/test_bank_statement_import.py +++ b/erpnext/accounts/doctype/bank_statement_import/test_bank_statement_import.py @@ -1,10 +1,209 @@ # Copyright (c) 2020, Frappe Technologies and Contributors # See license.txt -# import frappe + import unittest -from frappe.tests import IntegrationTestCase +from erpnext.accounts.doctype.bank_statement_import.bank_statement_import import ( + is_mt940_format, + preprocess_mt940_content, +) -class TestBankStatementImport(IntegrationTestCase): - pass +class TestBankStatementImport(unittest.TestCase): + """Unit tests for Bank Statement Import functions""" + + def test_preprocess_mt940_content_with_long_statement_number(self): + """Test that statement numbers longer than 5 digits are truncated to last 5 digits""" + # Test case with 6-digit statement number (167619 -> 67619) + mt940_content = ":28C:167619/1" + expected_content = ":28C:67619/1" + result = preprocess_mt940_content(mt940_content) + self.assertEqual(result, expected_content) + + def test_preprocess_mt940_content_with_normal_statement_number(self): + """Test that statement numbers with 5 or fewer digits are unchanged""" + # Test case with 5-digit statement number (should remain unchanged) + mt940_content = ":28C:12345/1" + result = preprocess_mt940_content(mt940_content) + self.assertEqual(result, mt940_content) # Should be unchanged + + # Test case with 4-digit statement number (should remain unchanged) + mt940_content = ":28C:1234/1" + result = preprocess_mt940_content(mt940_content) + self.assertEqual(result, mt940_content) # Should be unchanged + + def test_preprocess_mt940_content_without_sequence_number(self): + """Test statement number truncation without sequence number""" + # Test case with long statement number but no sequence (no /1) + mt940_content = ":28C:987654321" + expected_content = ":28C:54321" + result = preprocess_mt940_content(mt940_content) + self.assertEqual(result, expected_content) + + def test_preprocess_mt940_content_multiple_occurrences(self): + """Test multiple statement numbers in the same content""" + mt940_content = """:28C:167619/1 +:28C:987654/2""" + expected_content = """:28C:67619/1 +:28C:87654/2""" + result = preprocess_mt940_content(mt940_content) + self.assertEqual(result, expected_content) + + def test_preprocess_mt940_content_edge_cases(self): + """Test edge cases like empty content and content without :28C: tags""" + # Test empty content + self.assertEqual(preprocess_mt940_content(""), "") + + # Test content without :28C: tags + content_without_28c = """:20:STARTUMSE +:25:12345678901234567890 +:60F:C031002EUR0,00""" + result = preprocess_mt940_content(content_without_28c) + self.assertEqual(result, content_without_28c) # Should be unchanged + + def test_preprocess_mt940_content_with_full_mt940_document(self): + """Test preprocessing with complete MT940 document""" + mt940_content = """:20:STARTUMSE +:25:12345678901234567890 +:28C:167619/1 +:60F:C031002EUR0,00 +:61:0310021002DR123,45NMSCNONREF//8327000090031789 +:86:806?20EREF+NONREF?21MREF+M180031?22CRED+DE98ZZZ09999999999 +:62F:C031002EUR-123,45 +-""" + expected_content = """:20:STARTUMSE +:25:12345678901234567890 +:28C:67619/1 +:60F:C031002EUR0,00 +:61:0310021002DR123,45NMSCNONREF//8327000090031789 +:86:806?20EREF+NONREF?21MREF+M180031?22CRED+DE98ZZZ09999999999 +:62F:C031002EUR-123,45 +-""" + result = preprocess_mt940_content(mt940_content) + self.assertEqual(result, expected_content) + + def test_is_mt940_format_detection(self): + """Test MT940 format detection function""" + # Valid MT940 content with all required tags + valid_mt940 = """:20:STARTUMSE +:25:12345678901234567890 +:28C:167619/1 +:60F:C031002EUR0,00 +:61:0310021002DR123,45NMSCNONREF//8327000090031789""" + self.assertTrue(is_mt940_format(valid_mt940)) + + # Invalid MT940 content (CSV format) + invalid_mt940 = """Date,Description,Amount +2023-01-01,Test Transaction,100.00 +2023-01-02,Another Transaction,-50.00""" + self.assertFalse(is_mt940_format(invalid_mt940)) + + # Partially valid MT940 (missing some required tags) + partial_mt940 = """:20:STARTUMSE +:25:12345678901234567890 +:60F:C031002EUR0,00""" + self.assertFalse(is_mt940_format(partial_mt940)) + + # Empty content + self.assertFalse(is_mt940_format("")) + + def test_preprocess_mt940_content_boundary_conditions(self): + """Test boundary conditions for statement number length""" + # Test exactly 6 digits (should be truncated) + mt940_content = ":28C:123456/1" + expected_content = ":28C:23456/1" + result = preprocess_mt940_content(mt940_content) + self.assertEqual(result, expected_content) + + # Test exactly 5 digits (should remain unchanged) + mt940_content = ":28C:12345/1" + result = preprocess_mt940_content(mt940_content) + self.assertEqual(result, mt940_content) + + # Test very long statement number + mt940_content = ":28C:123456789012345/1" + expected_content = ":28C:12345/1" # Last 5 digits + result = preprocess_mt940_content(mt940_content) + self.assertEqual(result, expected_content) + + def test_preprocess_mt940_content_real_world_case(self): + """Test with real-world MT940 content that was failing in production""" + # This is based on actual MT940 content that was causing parsing errors (sanitized) + mt940_content = """{1:F0112345678901X0000000000}{2:I94012345678901XN}{4: +:20:STMTREF167619 +:25:1234567890 +:28C:167619/1 +:60F:C250622USD0,00 +:61:2507170717C100000,00NMSCNOREF +:86:BY EXAMPLE INST 123456/03-07-25/TESTBANK/CITY +:61:2507240724C1,00NMSCNEFTINW-1234567890 +:86:NEFT TEST123456789 EXAMPLE MERCHANT SERVICES +:61:2507310731D305,62NMSCTBMS-1234567890 +:86:Chrg: Debit Card Annual Fee 1234 for 2025 +:61:2508030803D1066,00NMSC123456789 +:86:PCD/1234/EXAMPLE DOMAIN/01234567890123/23:27 +:61:2508060806D2000,00NMSCUPI-123456789 +:86:UPI/TEST USER/123456789/PaidViaTestApp +:61:2508140814D5000,00NMSCUPI-123456789 +:86:UPI/TEST USER/123456789/PaidViaTestApp +:61:2509190919D900,00NMSCUPI-123456789 +:86:UPI/EXAMPLE MERCHANT/123456789/Pay +:61:2509190919D2606,00NMSCUPI-123456789 +:86:UPI/JOHN DOE/123456789/PaidViaTestApp +:62F:C250922USD88123,38 +-}""" + + # Expected result with statement number 167619 truncated to 67619 + expected_content = """{1:F0112345678901X0000000000}{2:I94012345678901XN}{4: +:20:STMTREF167619 +:25:1234567890 +:28C:67619/1 +:60F:C250622USD0,00 +:61:2507170717C100000,00NMSCNOREF +:86:BY EXAMPLE INST 123456/03-07-25/TESTBANK/CITY +:61:2507240724C1,00NMSCNEFTINW-1234567890 +:86:NEFT TEST123456789 EXAMPLE MERCHANT SERVICES +:61:2507310731D305,62NMSCTBMS-1234567890 +:86:Chrg: Debit Card Annual Fee 1234 for 2025 +:61:2508030803D1066,00NMSC123456789 +:86:PCD/1234/EXAMPLE DOMAIN/01234567890123/23:27 +:61:2508060806D2000,00NMSCUPI-123456789 +:86:UPI/TEST USER/123456789/PaidViaTestApp +:61:2508140814D5000,00NMSCUPI-123456789 +:86:UPI/TEST USER/123456789/PaidViaTestApp +:61:2509190919D900,00NMSCUPI-123456789 +:86:UPI/EXAMPLE MERCHANT/123456789/Pay +:61:2509190919D2606,00NMSCUPI-123456789 +:86:UPI/JOHN DOE/123456789/PaidViaTestApp +:62F:C250922USD88123,38 +-}""" + + result = preprocess_mt940_content(mt940_content) + self.assertEqual(result, expected_content) + + # Verify that the problematic statement number was actually changed + self.assertIn(":28C:67619/1", result) + self.assertNotIn(":28C:167619/1", result) + + # Verify that other content remains unchanged + self.assertIn(":20:STMTREF167619", result) # Reference should remain unchanged + self.assertIn("UPI/TEST USER/123456789/PaidViaTestApp", result) + + def test_preprocess_mt940_content_whitespace_variants(self): + """Test handling of whitespace and different line endings""" + # Test with trailing spaces + mt940_content = ":28C:167619/1 \n" + expected_content = ":28C:67619/1 \n" + result = preprocess_mt940_content(mt940_content) + self.assertEqual(result, expected_content) + + # Test with Windows line endings (CRLF) + mt940_content = ":28C:167619/1\r\n" + expected_content = ":28C:67619/1\r\n" + result = preprocess_mt940_content(mt940_content) + self.assertEqual(result, expected_content) + + # Test with leading spaces (should not match as it's not line start) + mt940_content = " :28C:167619/1\n" + result = preprocess_mt940_content(mt940_content) + self.assertEqual(result, mt940_content) # Should remain unchanged