ExceptionTests.cs

//
// ExceptionTests.cs
//
// Author: Jeffrey Stedfast <jestedfa@microsoft.com>
//
// Copyright (c) 2013-2025 .NET Foundation and Contributors
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
//

#if NET6_0

using System.Runtime.Serialization.Formatters.Binary;

using MailKit;
using MailKit.Net.Imap;
using MailKit.Net.Pop3;

namespace UnitTests {
	[TestFixture]
	public class ExceptionTests
	{
		[Test]
		public void TestFolderNotFoundException ()
		{
			var expected = new FolderNotFoundException ("Inbox");

			using (var stream = new MemoryStream ()) {
				var formatter = new BinaryFormatter ();
				formatter.Serialize (stream, expected);
				stream.Position = 0;

				var ex = (FolderNotFoundException) formatter.Deserialize (stream);
				Assert.That (ex.FolderName, Is.EqualTo (expected.FolderName), "Unexpected FolderName.");
			}

			expected = new FolderNotFoundException ("This is the error message.", "Inbox");

			using (var stream = new MemoryStream ()) {
				var formatter = new BinaryFormatter ();
				formatter.Serialize (stream, expected);
				stream.Position = 0;

				var ex = (FolderNotFoundException) formatter.Deserialize (stream);
				Assert.That (ex.Message, Is.EqualTo (expected.Message), "Unexpected Message.");
				Assert.That (ex.FolderName, Is.EqualTo (expected.FolderName), "Unexpected FolderName.");
			}

			expected = new FolderNotFoundException ("This is the error message.", "Inbox", new IOException ("Inner Exception"));

			using (var stream = new MemoryStream ()) {
				var formatter = new BinaryFormatter ();
				formatter.Serialize (stream, expected);
				stream.Position = 0;

				var ex = (FolderNotFoundException) formatter.Deserialize (stream);
				Assert.That (ex.Message, Is.EqualTo (expected.Message), "Unexpected Message.");
				Assert.That (ex.FolderName, Is.EqualTo (expected.FolderName), "Unexpected FolderName.");
			}

			Assert.Throws<ArgumentNullException> (() => new FolderNotFoundException (null));
			Assert.Throws<ArgumentNullException> (() => new FolderNotFoundException ("message", null));
			Assert.Throws<ArgumentNullException> (() => new FolderNotFoundException ("message", null, new Exception ("message")));
		}

		[Test]
		public void TestFolderNotOpenException ()
		{
			var expected = new FolderNotOpenException ("Inbox", FolderAccess.ReadWrite);

			using (var stream = new MemoryStream ()) {
				var formatter = new BinaryFormatter ();
				formatter.Serialize (stream, expected);
				stream.Position = 0;

				var ex = (FolderNotOpenException) formatter.Deserialize (stream);
				Assert.That (ex.FolderName, Is.EqualTo (expected.FolderName), "Unexpected FolderName.");
				Assert.That (ex.FolderAccess, Is.EqualTo (expected.FolderAccess), "Unexpected FolderAccess.");
			}

			expected = new FolderNotOpenException ("Inbox", FolderAccess.ReadWrite, "This is the error message.");

			using (var stream = new MemoryStream ()) {
				var formatter = new BinaryFormatter ();
				formatter.Serialize (stream, expected);
				stream.Position = 0;

				var ex = (FolderNotOpenException) formatter.Deserialize (stream);
				Assert.That (ex.FolderName, Is.EqualTo (expected.FolderName), "Unexpected FolderName.");
				Assert.That (ex.FolderAccess, Is.EqualTo (expected.FolderAccess), "Unexpected FolderAccess.");
			}

			expected = new FolderNotOpenException ("Inbox", FolderAccess.ReadWrite, "This is the error message.", new IOException ("Inner Exception"));

			using (var stream = new MemoryStream ()) {
				var formatter = new BinaryFormatter ();
				formatter.Serialize (stream, expected);
				stream.Position = 0;

				var ex = (FolderNotOpenException) formatter.Deserialize (stream);
				Assert.That (ex.FolderName, Is.EqualTo (expected.FolderName), "Unexpected FolderName.");
				Assert.That (ex.FolderAccess, Is.EqualTo (expected.FolderAccess), "Unexpected FolderAccess.");
			}

			Assert.Throws<ArgumentNullException> (() => new FolderNotOpenException (null, FolderAccess.ReadOnly));
			Assert.Throws<ArgumentNullException> (() => new FolderNotOpenException (null, FolderAccess.ReadOnly, "message"));
			Assert.Throws<ArgumentNullException> (() => new FolderNotOpenException (null, FolderAccess.ReadOnly, "message", new Exception ("message")));
		}

		[Test]
		public void TestMessageNotFoundException ()
		{
			var expected = new MessageNotFoundException ("This is the message.");

			using (var stream = new MemoryStream ()) {
				var formatter = new BinaryFormatter ();
				formatter.Serialize (stream, expected);
				stream.Position = 0;

				var ex = (MessageNotFoundException) formatter.Deserialize (stream);
				Assert.That (ex.Message, Is.EqualTo (expected.Message), "Unexpected Message.");
			}

			expected = new MessageNotFoundException ("This is the message.", new IOException ("Inner Exception"));

			using (var stream = new MemoryStream ()) {
				var formatter = new BinaryFormatter ();
				formatter.Serialize (stream, expected);
				stream.Position = 0;

				var ex = (MessageNotFoundException)formatter.Deserialize (stream);
				Assert.That (ex.Message, Is.EqualTo (expected.Message), "Unexpected Message.");
			}
		}

		[Test]
		public void TestServiceNotAuthenticatedException ()
		{
			var expected = new ServiceNotAuthenticatedException ();

			using (var stream = new MemoryStream ()) {
				var formatter = new BinaryFormatter ();
				formatter.Serialize (stream, expected);
				stream.Position = 0;

				var ex = (ServiceNotAuthenticatedException) formatter.Deserialize (stream);
				Assert.That (ex.Message, Is.EqualTo (expected.Message), "Unexpected Message.");
			}

			expected = new ServiceNotAuthenticatedException ("This is the message.");

			using (var stream = new MemoryStream ()) {
				var formatter = new BinaryFormatter ();
				formatter.Serialize (stream, expected);
				stream.Position = 0;

				var ex = (ServiceNotAuthenticatedException) formatter.Deserialize (stream);
				Assert.That (ex.Message, Is.EqualTo (expected.Message), "Unexpected Message.");
			}

			expected = new ServiceNotAuthenticatedException ("This is the message.", new IOException ("Inner Exception"));

			using (var stream = new MemoryStream ()) {
				var formatter = new BinaryFormatter ();
				formatter.Serialize (stream, expected);
				stream.Position = 0;

				var ex = (ServiceNotAuthenticatedException) formatter.Deserialize (stream);
				Assert.That (ex.Message, Is.EqualTo (expected.Message), "Unexpected Message.");
			}
		}

		[Test]
		public void TestServiceNotConnectedException ()
		{
			var expected = new ServiceNotConnectedException ();

			using (var stream = new MemoryStream ()) {
				var formatter = new BinaryFormatter ();
				formatter.Serialize (stream, expected);
				stream.Position = 0;

				var ex = (ServiceNotConnectedException) formatter.Deserialize (stream);
				Assert.That (ex.Message, Is.EqualTo (expected.Message), "Unexpected Message.");
			}

			expected = new ServiceNotConnectedException ("This is the message.");

			using (var stream = new MemoryStream ()) {
				var formatter = new BinaryFormatter ();
				formatter.Serialize (stream, expected);
				stream.Position = 0;

				var ex = (ServiceNotConnectedException) formatter.Deserialize (stream);
				Assert.That (ex.Message, Is.EqualTo (expected.Message), "Unexpected Message.");
			}

			expected = new ServiceNotConnectedException ("This is the message.", new IOException ("Inner Exception"));

			using (var stream = new MemoryStream ()) {
				var formatter = new BinaryFormatter ();
				formatter.Serialize (stream, expected);
				stream.Position = 0;

				var ex = (ServiceNotConnectedException) formatter.Deserialize (stream);
				Assert.That (ex.Message, Is.EqualTo (expected.Message), "Unexpected Message.");
			}
		}

		[Test]
		public void TestImapCommandException ()
		{
			var expected = new ImapCommandException (ImapCommandResponse.Bad, "Bad boys, bad boys. Whatcha gonna do?", "Message", new Exception ("InnerException"));

			using (var stream = new MemoryStream ()) {
				var formatter = new BinaryFormatter ();
				formatter.Serialize (stream, expected);
				stream.Position = 0;

				var ex = (ImapCommandException)formatter.Deserialize (stream);
				Assert.That (ex.Response, Is.EqualTo (expected.Response), "Unexpected Response.");
				Assert.That (ex.ResponseText, Is.EqualTo (expected.ResponseText), "Unexpected ResponseText.");
			}

			expected = new ImapCommandException (ImapCommandResponse.Bad, "Bad boys, bad boys. Whatcha gonna do?", "Message");

			using (var stream = new MemoryStream ()) {
				var formatter = new BinaryFormatter ();
				formatter.Serialize (stream, expected);
				stream.Position = 0;

				var ex = (ImapCommandException) formatter.Deserialize (stream);
				Assert.That (ex.Response, Is.EqualTo (expected.Response), "Unexpected Response.");
				Assert.That (ex.ResponseText, Is.EqualTo (expected.ResponseText), "Unexpected ResponseText.");
			}
		}

		[Test]
		public void TestImapProtocolException ()
		{
			var expected = new ImapProtocolException ("Bad boys, bad boys. Whatcha gonna do?", new Exception ("InnerException"));

			using (var stream = new MemoryStream ()) {
				var formatter = new BinaryFormatter ();
				formatter.Serialize (stream, expected);
				stream.Position = 0;

				var ex = (ImapProtocolException) formatter.Deserialize (stream);
				Assert.That (ex.HelpLink, Is.EqualTo (expected.HelpLink), "Unexpected HelpLink.");
			}

			expected = new ImapProtocolException ("Bad boys, bad boys. Whatcha gonna do?");

			using (var stream = new MemoryStream ()) {
				var formatter = new BinaryFormatter ();
				formatter.Serialize (stream, expected);
				stream.Position = 0;

				var ex = (ImapProtocolException) formatter.Deserialize (stream);
				Assert.That (ex.HelpLink, Is.EqualTo (expected.HelpLink), "Unexpected HelpLink.");
			}

			expected = new ImapProtocolException ();

			using (var stream = new MemoryStream ()) {
				var formatter = new BinaryFormatter ();
				formatter.Serialize (stream, expected);
				stream.Position = 0;

				var ex = (ImapProtocolException) formatter.Deserialize (stream);
				Assert.That (ex.HelpLink, Is.EqualTo (expected.HelpLink), "Unexpected HelpLink.");
			}
		}

		[Test]
		public void TestPop3CommandException ()
		{
			var expected = new Pop3CommandException ("Message", "Bad boys, bad boys. Whatcha gonna do?");

			Assert.Throws<ArgumentNullException> (() => new Pop3CommandException ("Message", (string) null));
			Assert.Throws<ArgumentNullException> (() => new Pop3CommandException ("Message", null, new Exception ("inner")));

			using (var stream = new MemoryStream ()) {
				var formatter = new BinaryFormatter ();
				formatter.Serialize (stream, expected);
				stream.Position = 0;

				var ex = (Pop3CommandException) formatter.Deserialize (stream);
				Assert.That (ex.StatusText, Is.EqualTo (expected.StatusText), "Unexpected StatusText.");
			}
		}

		[Test]
		public void TestPop3ProtocolException ()
		{
			var expected = new Pop3ProtocolException ("Bad boys, bad boys. Whatcha gonna do?", new Exception ("InnerException"));

			using (var stream = new MemoryStream ()) {
				var formatter = new BinaryFormatter ();
				formatter.Serialize (stream, expected);
				stream.Position = 0;

				var ex = (Pop3ProtocolException) formatter.Deserialize (stream);
				Assert.That (ex.HelpLink, Is.EqualTo (expected.HelpLink), "Unexpected HelpLink.");
			}

			expected = new Pop3ProtocolException ("Bad boys, bad boys. Whatcha gonna do?");

			using (var stream = new MemoryStream ()) {
				var formatter = new BinaryFormatter ();
				formatter.Serialize (stream, expected);
				stream.Position = 0;

				var ex = (Pop3ProtocolException) formatter.Deserialize (stream);
				Assert.That (ex.HelpLink, Is.EqualTo (expected.HelpLink), "Unexpected HelpLink.");
			}

			expected = new Pop3ProtocolException ();

			using (var stream = new MemoryStream ()) {
				var formatter = new BinaryFormatter ();
				formatter.Serialize (stream, expected);
				stream.Position = 0;

				var ex = (Pop3ProtocolException) formatter.Deserialize (stream);
				Assert.That (ex.HelpLink, Is.EqualTo (expected.HelpLink), "Unexpected HelpLink.");
			}
		}
	}
}

#endif // NET6_0