Author Topic: Regression testing of email send (Read 4209 times)

dharmatech · January 09, 2009, 07:39:21 pm

Gurus,

I am hoping for some guidance. I would like to write a unit test of mail sending functions. However, I do not want to actually send a large number of emails or, worse yet, go through them by hand looking for incorrect processing. Therefore emails generated by the test must be grabbed and parsed by the test harness.

I looked through the existing test suite and did not find much that was helpful.

There is a Drupal module reroute_email which grabs outgoing mail with Drupal hook_mail_alter and changes the destination address to something of the tester's choosing. But CiviCRM does not call the Drupal hook.

One approach that strikes me as feasible is to direct mail to the spool, then have the test inspect what appears in the spool. This seems to offer the best hope for test automation. Unfortunately CRM_Mailing_BAO_Spool::send() requires one more argument than the SMTP and sendmail send methods generated by Mail::factory(), therefore using this method causes a fatal PHP error. This could be hacked to make the fourth argument optional, defaulting to null, and allow civicrm_mailing_spool.job_id to be null.

Other feasible approaches might be to have the test harness grab the test mail with a mock /usr/sbin/sendmail program, or somehow return a suitable mock object from Mail::factory().

What does the group suggest?

Thanks in advance -- Walt

Donald Lobo · January 09, 2009, 08:30:52 pm

There is another option (undocumented) which logs all mail to a directory (or optionally to a file)

if u define:

define( 'CIVICRM_MAIL_LOG' , 1 );

in your settings files, all mail gets logged to: files/civicrm/upload/mail/*

if you give it a filename instead, it overwrites that file with the last mail (we typically would use /dev/null in this case)

i suspect the above would help and simplify testing?

lobo

dharmatech · January 10, 2009, 07:00:25 am

Thanks Lobo, I'll try that

-- Walt

fen · July 20, 2009, 09:15:44 am

I'm also trying to test a mailing (reminder notices from UpdateMembershipRecord.php) but don't want actual mails to go out.

If one adds "define( 'CIVICRM_MAILER_SPOOL' , 1 );" to the settings file will it redirect all outgoing mail to the civicrm_mailing_spool table, effectively preventing mails from going out?

Setting CIVICRM_MAIL_LOG as suggested by Lobo looks like it additionally logs mail to a file, but by itself wouldn't prevent mails from going out.

Is this correct?

Dave Greenberg · July 20, 2009, 11:21:20 am

Using the "mail log" setting (below) causes all outbound mail to be written to an MD5 named file in $yourUploadDir/mail directory:

Code: [Select]

define( 'CIVICRM_MAIL_LOG' , 1 );

alphageekboy · June 24, 2010, 06:47:00 pm

Is this still a valid option? I put the setting in the civicrm.settings.php file and it appears to not be sending mail, but I don't see it going into my civicrm upload directory.

alphageekboy · June 24, 2010, 07:53:44 pm

Ah, found the answer here: http://forum.civicrm.org/index.php?topic=10104.0

This is the directory where mail goes.

files/civicrm/templates_c/en_US/ConfigAndLog/mail

I created a SymLink to this directory so may users can test by going to http:///www.example.com/mail and added .htaccess file to allow indexes. Now they can navigate to this directory and click refresh to view emails that are logged.

CiviCRM Community Forums (archive)

News:

Author Topic: Regression testing of email send (Read 4209 times)

dharmatech

Regression testing of email send

Donald Lobo

Re: Regression testing of email send

dharmatech

Re: Regression testing of email send

fen

Re: Regression testing of email send

Dave Greenberg

Re: Regression testing of email send

alphageekboy

Re: Regression testing of email send

alphageekboy

Re: Regression testing of email send