From af63a9b6e39385f099ad3b9e94e5b730201ca293 Mon Sep 17 00:00:00 2001 From: Brandon Joyce Date: Wed, 29 Nov 2023 12:08:51 -0500 Subject: [PATCH] Add message_id parameter (#63) * Add message_id parameter * Validate length of message id when user provided * Formatting --- AUTHORS.md | 9 +++++---- pyas2lib/as2.py | 25 +++++++++++++++++++++---- pyas2lib/tests/test_basic.py | 24 ++++++++++++++++++++++++ 3 files changed, 50 insertions(+), 8 deletions(-) diff --git a/AUTHORS.md b/AUTHORS.md index 3c75246..f8b47d9 100644 --- a/AUTHORS.md +++ b/AUTHORS.md @@ -1,4 +1,5 @@ -* Abhishek Ram @abhishek-ram -* Chad Gates @chadgates -* Bruno Ribeiro da Silva @loop0 -* Robin C Samuel @robincsamuel \ No newline at end of file +- Abhishek Ram @abhishek-ram +- Chad Gates @chadgates +- Bruno Ribeiro da Silva @loop0 +- Robin C Samuel @robincsamuel +- Brandon Joyce @brandonjoyce diff --git a/pyas2lib/as2.py b/pyas2lib/as2.py index cb058ad..12ebac7 100644 --- a/pyas2lib/as2.py +++ b/pyas2lib/as2.py @@ -330,6 +330,7 @@ def build( content_type="application/edi-consent", additional_headers=None, disposition_notification_to="no-reply@pyas2.com", + message_id=None, ): """Function builds the AS2 message. Compresses, signs and encrypts @@ -354,6 +355,10 @@ def build( :param disposition_notification_to: Email address for disposition-notification-to header entry. (default "no-reply@pyas2.com") + + :param message_id: + A value to be used for the left side of the message id. If not provided a + unique id is generated. (default None) """ # Validations @@ -372,10 +377,22 @@ def build( "Encryption of messages is enabled but encrypt key is not set for the receiver." ) - # Generate message id using UUID 1 as it uses both hostname and time - self.message_id = ( - email_utils.make_msgid(domain=self.sender.domain).lstrip("<").rstrip(">") - ) + if message_id: + self.message_id = f"{message_id}@{self.sender.domain}" + else: + self.message_id = ( + email_utils.make_msgid(domain=self.sender.domain) + .lstrip("<") + .rstrip(">") + ) + + # ensure the total length of the message id is no more than 255 characters + if len(self.message_id) > 255: + raise ValueError( + "Message ID must be no more than 255 characters for " + "compatibility with some AS2 servers. " + f"Current message ID length is {len(self.message_id)}." + ) # Set up the message headers as2_headers = { diff --git a/pyas2lib/tests/test_basic.py b/pyas2lib/tests/test_basic.py index 3eadbb8..fed94b9 100644 --- a/pyas2lib/tests/test_basic.py +++ b/pyas2lib/tests/test_basic.py @@ -1,4 +1,5 @@ """Module for testing the basic features of pyas2.""" +import pytest import socket from pyas2lib import as2 from . import Pyas2TestCase @@ -200,6 +201,29 @@ def test_plain_message_without_domain(self): out_message.build(self.test_data) self.assertEqual(out_message.message_id.split("@")[1], socket.getfqdn()) + def test_plain_message_with_custom_message_id(self): + """Test Message building with a custom message id""" + + # Build an As2 message to be transmitted to partner + self.org.domain = "example.com" + out_message = as2.Message(self.org, self.partner) + out_message.build(self.test_data, message_id="some_custom_id") + self.assertEqual(out_message.message_id, "some_custom_id@example.com") + + def test_invalid_message_id_length_raises_error(self): + """Test Message building with a custom message id that's invalid""" + + # Build an As2 message to be transmitted to partner + self.org.domain = "example.com" + out_message = as2.Message(self.org, self.partner) + very_long_message_id = "a" * 1000 + with pytest.raises(ValueError) as excinfo: + out_message.build(self.test_data, message_id=very_long_message_id) + assert ( + "Message ID must be no more than 255 characters for compatibility" + in str(excinfo.value) + ) + def find_org(self, as2_id): return self.org