436847 - Implement an SMTP fake server testing scheme for /mailnews

Status: RESOLVED FIXED

(MailNews Core :: Networking: SMTP, defect)

Description

[Mark Banner (:standard8)]

Attachment: The fix

This bug is for extension of the mailnews fake servers for SMTP. This is based on the work originally done in bug 413077.

The attached patch implements a fake SMTP server and provides a test for nsISmtpService::sendMessageFile. This was the latest, most sane, place I could find before we actually start hooking into the message protocol.

I have added some documentation to nsISmtpServer and nsISmtpServer which were all things I had to find out whilst implementing the test.

In nsISmtpServer I changed the prototype from "SendMessageFile" to "sendMessageFile" to reflect how we normally do idl functions. I also changed requestDSN to aRequestDSN, and fixed some tabs.

The test checks that the messages received at the SMTP server are correct and in the right order. It currently doesn't check the content of the message is correct - I plan to do that later.

We will probably also want to provide more helper functions for various test actions, again I'll look at adding those later as I add more tests. The purpose of this patch is to get a baseline server in place.

Comment 1

[David :Bienvenu]

Comment on attachment 323349 [details] [diff] [review]
The fix

very cool!

Is this copy+pasted from the fake news server? I don't think it applies to smtp servers.

+  this.group = null;
+  this.article = null;

super bonus points for adding a test to make sure the url listener really gets called - that's very important for extensions, and in general.

Comment 2

[Mark Banner (:standard8)]

Attachment: Part 2

It turns out the first version wasn't actually working 100% correct. This was because the message1.eml file wasn't in CRLF format as per the spec. This was causing the fake server not to work right, so I've fixed the file format (hopefully!).

Also included is a bunch more documentation for nsISmtpServer.

I've extended the nsISmtpService::sendMessageFile documentation with a note about the file format.

I've moved some of the functions from the test file to the head (so that they can be shared) and implemented some slight more generic functions to make the test file cleaner and easier to set up overall.

There's a bunch of dumps removed as we don't really need them.

The fake server now doesn't return an code after each line (it shouldn't do).

On top of all that I've added a second test for the basic plain auth case. Doesn't really test much extra, but proves everything is working right now ;-)

Comment 3

[Joshua Cranmer [:jcranmer]]

(In reply to comment #2)
> It turns out the first version wasn't actually working 100% correct. This was
> because the message1.eml file wasn't in CRLF format as per the spec. This was
> causing the fake server not to work right, so I've fixed the file format
> (hopefully!).

In the maild test suites, the responses are sanitized to use CRLF using the following JS line:
response = response.replace(/([^\r])\n/,"$1\r\n");

However, looking at the SMTP APIs, it doesn't seem that this simple transformation is possible without creating a temporary file.

Comment 4

[Mark Banner (:standard8)]

Both patches are checked in now. I'm declaring this fixed, I'll look at doing the listeners in another bug.