public function testRun()
{
$super = User::getByUsername('super');
Yii::app()->user->userModel = $super;
$box = EmailBox::resolveAndGetByName(EmailBox::NOTIFICATIONS_NAME);
$outboxFolder = EmailFolder::getByBoxAndType($box, EmailFolder::TYPE_OUTBOX);
$sentFolder = EmailFolder::getByBoxAndType($box, EmailFolder::TYPE_SENT);
$emailMessage = EmailMessageTestHelper::createDraftSystemEmail('My Email Message', $super);
$emailMessage->folder = $outboxFolder;
$saved = $emailMessage->save();
$this->assertTrue($saved);
$emailMessageId = $emailMessage->id;
$emailMessage->forget();
unset($emailMessage);
$emailMessage2 = EmailMessageTestHelper::createDraftSystemEmail('My Email Message', $super);
$emailMessage2->folder = $outboxFolder;
$saved = $emailMessage2->save();
$this->assertTrue($saved);
$emailMessage2Id = $emailMessage2->id;
$emailMessage2->forget();
unset($emailMessage2);
$this->assertEquals(2, EmailMessage::getCount());
$job = new ProcessOutboundEmailJob();
$this->assertTrue($job->run());
$emailMessages = EmailMessage::getAll();
$this->assertEquals(2, count($emailMessages));
$emailMessage = EmailMessage::getById($emailMessageId);
$this->assertEquals($sentFolder, $emailMessage->folder);
$emailMessage2 = EmailMessage::getById($emailMessage2Id);
$this->assertEquals($sentFolder, $emailMessage2->folder);
}
protected static function getQueuedContentForDrillDown(CampaignItem $campaignItem)
{
$monitorJobData = JobsToJobsCollectionViewUtil::getNonMonitorJobsData();
if ($campaignItem->emailMessage->folder->type == EmailFolder::TYPE_OUTBOX_ERROR) {
$content = Zurmo::t('MarketingModule', 'Attempted to send the message {count} times but an error occurred: {error}.', array('{count}' => $campaignItem->emailMessage->sendAttempts, '{error}' => strval($campaignItem->emailMessage->error)));
} else {
$content = Zurmo::t('MarketingModule', 'The last completed run date of the {jobName} job was on {dateTime}. The email message has not yet been sent.', array('{jobName}' => ProcessOutboundEmailJob::getDisplayName(), '{dateTime}' => $monitorJobData[ProcessOutboundEmailJob::getType()]['lastCompletedRunEncodedContent']));
}
return ZurmoHtml::tag('h4', array(), $content);
}
public function testRunWithCampaignPausedAfterAllItemsGeneratedAndThenUnpaused()
{
// Cleanup
Campaign::deleteAll();
$this->assertEquals(0, Campaign::getCount());
$this->assertEquals(0, CampaignItem::getCount());
$this->assertEquals(0, CampaignItemActivity::getCount());
MarketingList::deleteAll();
$this->assertEquals(0, MarketingList::getCount());
$this->assertEquals(0, MarketingListMember::getCount());
EmailMessage::deleteAll();
$this->assertEquals(0, EmailMessage::getCount());
$this->assertEquals(0, EmailMessageContent::getCount());
$this->assertEquals(0, EmailMessageSender::getCount());
$this->assertEquals(0, EmailMessageRecipient::getCount());
Contact::deleteAll();
$this->assertEquals(0, Contact::getCount());
// setup an email address for contacts
$email = new Email();
$email->emailAddress = '*****@*****.**';
// create a marketing list with 5 members
$marketingList = MarketingListTestHelper::createMarketingListByName('marketingList 05');
$marketingListId = $marketingList->id;
for ($i = 1; $i <= 5; $i++) {
$contact = ContactTestHelper::createContactByNameForOwner('campaignContact 0' . $i, $this->user);
$contact->primaryEmail = $email;
$this->assertTrue($contact->save());
MarketingListMemberTestHelper::createMarketingListMember(0, $marketingList, $contact);
}
$marketingList->forgetAll();
// create a due campaign with that marketing list
$campaign = CampaignTestHelper::createCampaign('campaign 04', 'subject', 'text Content', 'Html Content', null, null, null, null, null, null, MarketingList::getById($marketingListId));
$campaignId = $campaign->id;
/*
* Run 1:
* CampaignGenerateDueCampaignItemsJob
* status == processing
* items generated but unprocessed
*
* CampaignQueueMessagesInOutboxJob
* status == processing
* items processed with email messages generated and queued
*
* ProcessOutboundEmailJob
* status == processing
* email items attempted to be sent
*
* Run 2:
* Pause the campaign
* items are processed and still present
*
* Unpause the campaign
* status == active
* items are processed and still present
*
* CampaignGenerateDueCampaignItemsJob
* status == processing
* ensure all items are present and processed
*
* CampaignQueueMessagesInOutboxJob
* status == processing
* ensure all items are present and processed
* ensure all email messages are present with correct folder type
*
* ProcessOutboundEmailJob
* ensure all email messages are present with correct folder type
* status == processing
*
*
* Run 3:
* Mark Campaign as Completed
* status == completed
*/
// we have to do this to ensure when we retrieve the data status is updated from db.
$campaign->forgetAll();
$this->assertEmpty(CampaignItem::getAll());
// Run 1 starts here
// Run CampaignGenerateDueCampaignItemsJob
$job = new CampaignGenerateDueCampaignItemsJob();
$this->assertTrue($job->run());
$campaign = Campaign::getById($campaignId);
// ensure status is processing
$this->assertEquals(Campaign::STATUS_PROCESSING, $campaign->status);
// ensure 5 campaign items have been generated
$this->assertEquals(5, CampaignItem::getCount());
// ensure all 5 campaign items are unprocessed
$campaignItems = CampaignItem::getByProcessedAndCampaignId(0, $campaignId);
$this->assertNotEmpty($campaignItems);
$this->assertCount(5, $campaignItems);
// Run CampaignQueueMessagesInOutboxJob
$job = new CampaignQueueMessagesInOutboxJob();
$this->assertTrue($job->run());
// Ensure campaign status
$campaign = Campaign::getById($campaignId);
$this->assertEquals(Campaign::STATUS_PROCESSING, $campaign->status);
// ensure all 5 campaign items are processed
$campaignItems = CampaignItem::getByProcessedAndCampaignId(1, $campaignId);
$this->assertNotEmpty($campaignItems);
$this->assertCount(5, $campaignItems);
// Ensure 5 new email messages
$this->assertEquals(5, EmailMessage::getCount());
$this->assertEquals(5, EmailHelper::getQueuedCount());
// Run ProcessOutboundEmail
$job = new ProcessOutboundEmailJob();
$this->assertTrue($job->run());
// Ensure all email were sent
$this->assertEquals(5, EmailMessage::getCount());
$this->assertEquals(0, EmailHelper::getQueuedCount());
foreach (EmailMessage::getAll() as $emailMessage) {
$this->assertEquals($emailMessage->folder->type, EmailFolder::TYPE_SENT);
}
// Ensure campaign status
$campaign = Campaign::getById($campaignId);
$this->assertEquals(Campaign::STATUS_PROCESSING, $campaign->status);
// end of Run 1
// Run 2 starts here
// Pause the campaign
$campaign->status = Campaign::STATUS_PAUSED;
$this->assertTrue($campaign->save());
// ensure campaign items are still there
$campaignItems = CampaignItem::getByProcessedAndCampaignId(1, $campaignId);
$this->assertCount(5, $campaignItems);
$this->assertNotEmpty($campaignItems);
// Unpause campaign
$campaign = Campaign::getById($campaignId);
$this->assertEquals(Campaign::STATUS_PAUSED, $campaign->status);
$campaign->status = Campaign::STATUS_ACTIVE;
$this->assertTrue($campaign->save());
// ensure campaign items are still there
$campaignItems = CampaignItem::getByProcessedAndCampaignId(1, $campaignId);
$this->assertCount(5, $campaignItems);
$this->assertNotEmpty($campaignItems);
// Ensure status change
$campaign = Campaign::getById($campaignId);
$this->assertEquals(Campaign::STATUS_ACTIVE, $campaign->status);
// Run CampaignGenerateDueCampaignItemsJob
$job = new CampaignGenerateDueCampaignItemsJob();
$this->assertTrue($job->run());
// Ensure campaign status change
$campaign = Campaign::getById($campaignId);
$this->assertEquals(Campaign::STATUS_PROCESSING, $campaign->status);
// ensure all 5 (previously created in run1) campaign items are still processed
$campaignItems = CampaignItem::getByProcessedAndCampaignId(1, $campaignId);
$this->assertNotEmpty($campaignItems);
$this->assertCount(5, $campaignItems);
// Run CampaignQueueMessagesInOutboxJob
$job = new CampaignQueueMessagesInOutboxJob();
$this->assertTrue($job->run());
// Ensure campaign status
$campaign = Campaign::getById($campaignId);
$this->assertEquals(Campaign::STATUS_PROCESSING, $campaign->status);
// ensure all 5 (previously created in run1) campaign items are still processed
$campaignItems = CampaignItem::getByProcessedAndCampaignId(1, $campaignId);
$this->assertNotEmpty($campaignItems);
$this->assertCount(5, $campaignItems);
// Ensure all 5 (previously created and sent in run1) emails are sent.
$this->assertEquals(5, EmailMessage::getCount());
foreach (EmailMessage::getAll() as $emailMessage) {
$this->assertEquals($emailMessage->folder->type, EmailFolder::TYPE_SENT);
}
// Run ProcessOutboundEmail
$job = new ProcessOutboundEmailJob();
$this->assertTrue($job->run());
// Ensure all 5 (previously created and sent in run1) emails are sent.
$this->assertEquals(5, EmailMessage::getCount());
foreach (EmailMessage::getAll() as $emailMessage) {
$this->assertEquals($emailMessage->folder->type, EmailFolder::TYPE_SENT);
}
// Ensure campaign status
$campaign = Campaign::getById($campaignId);
$this->assertEquals(Campaign::STATUS_PROCESSING, $campaign->status);
// end of Run 2
// Run 3 starts here
// Run CampaignMarkCompleted
$job = new CampaignMarkCompletedJob();
$this->assertTrue($job->run());
// Ensure campaign status change
$campaign = Campaign::getById($campaignId);
$this->assertEquals(Campaign::STATUS_COMPLETED, $campaign->status);
// end of Run 3
}
public function testSendMessagePopulatesEmailAccountSettings()
{
$jane = User::getByUsername('jane');
Yii::app()->user->userModel = $jane;
$emailHelper = new EmailHelper();
EmailMessageTestHelper::createEmailAccount($jane);
$emailAccount = EmailAccount::getByUserAndName($jane);
$emailAccount->useCustomOutboundSettings = EmailMessageUtil::OUTBOUND_PERSONAL_SMTP_SETTINGS;
$emailAccount->outboundType = 'abc';
$emailAccount->outboundPort = 11;
$emailAccount->outboundHost = 'dumb.domain';
$emailAccount->outboundUsername = '******';
$emailAccount->outboundPassword = '******';
$emailAccount->outboundSecurity = 'ssl';
$emailAccount->save();
$emailMessage = EmailMessageTestHelper::createOutboxEmail($jane, 'Test email', 'Raw content', 'Html content', 'Zurmo', Yii::app()->emailHelper->outboundUsername, 'John Doe', Yii::app()->params['emailTestAccounts']['userImapSettings']['imapUsername']);
$emailMessage->account = $emailAccount;
$emailMessage->save();
$this->assertEquals(1, Yii::app()->emailHelper->getQueuedCount());
$this->assertEquals(0, Yii::app()->emailHelper->getSentCount());
Yii::app()->emailHelper->sendQueued();
$job = new ProcessOutboundEmailJob();
$this->assertTrue($job->run());
//Since user email account has invalid settings message is not sent
$this->assertContains('Connection could not be established with host dumb.domain', strval($emailMessage->error));
$this->assertEquals(1, Yii::app()->emailHelper->getQueuedCount());
$this->assertEquals(0, Yii::app()->emailHelper->getSentCount());
}
/**
* @depends testSend
*/
public function testSendRealEmail()
{
$super = User::getByUsername('super');
Yii::app()->user->userModel = $super;
Yii::app()->emailHelper->sendEmailThroughTransport = true;
Yii::app()->imap->imapHost = Yii::app()->params['emailTestAccounts']['userImapSettings']['imapHost'];
Yii::app()->imap->imapUsername = Yii::app()->params['emailTestAccounts']['userImapSettings']['imapUsername'];
Yii::app()->imap->imapPassword = Yii::app()->params['emailTestAccounts']['userImapSettings']['imapPassword'];
Yii::app()->imap->imapPort = Yii::app()->params['emailTestAccounts']['userImapSettings']['imapPort'];
Yii::app()->imap->imapSSL = Yii::app()->params['emailTestAccounts']['userImapSettings']['imapSSL'];
Yii::app()->imap->imapFolder = Yii::app()->params['emailTestAccounts']['userImapSettings']['imapFolder'];
Yii::app()->imap->setInboundSettings();
Yii::app()->imap->init();
Yii::app()->emailHelper->outboundHost = Yii::app()->params['emailTestAccounts']['smtpSettings']['outboundHost'];
Yii::app()->emailHelper->outboundPort = Yii::app()->params['emailTestAccounts']['smtpSettings']['outboundPort'];
Yii::app()->emailHelper->outboundUsername = Yii::app()->params['emailTestAccounts']['smtpSettings']['outboundUsername'];
Yii::app()->emailHelper->outboundPassword = Yii::app()->params['emailTestAccounts']['smtpSettings']['outboundPassword'];
Yii::app()->emailHelper->outboundSecurity = Yii::app()->params['emailTestAccounts']['smtpSettings']['outboundSecurity'];
Yii::app()->emailHelper->sendEmailThroughTransport = true;
Yii::app()->emailHelper->setOutboundSettings();
Yii::app()->emailHelper->init();
$steve = UserTestHelper::createBasicUser('steve');
EmailMessageTestHelper::createEmailAccount($steve);
if (EmailMessageTestHelper::isSetEmailAccountsTestConfiguration()) {
$user = User::getByUsername('steve');
$user->primaryEmail->emailAddress = Yii::app()->params['emailTestAccounts']['userImapSettings']['imapUsername'];
$this->assertTrue($user->save());
Yii::app()->imap->connect();
Yii::app()->imap->deleteMessages(true);
$imapStats = Yii::app()->imap->getMessageBoxStatsDetailed();
$this->assertEquals(0, $imapStats->Nmsgs);
$emailMessage = EmailMessageTestHelper::createOutboxEmail($super, 'Test email', 'Raw content', ',b>html content</b>end.', 'Zurmo', Yii::app()->emailHelper->outboundUsername, 'Ivica', Yii::app()->params['emailTestAccounts']['userImapSettings']['imapUsername']);
Yii::app()->imap->connect();
$imapStats = Yii::app()->imap->getMessageBoxStatsDetailed();
$this->assertEquals(0, $imapStats->Nmsgs);
$this->assertEquals(1, Yii::app()->emailHelper->getQueuedCount());
$this->assertEquals(3, Yii::app()->emailHelper->getSentCount());
Yii::app()->emailHelper->sendQueued($emailMessage);
$job = new ProcessOutboundEmailJob();
$this->assertTrue($job->run());
$this->assertEquals(0, Yii::app()->emailHelper->getQueuedCount());
$this->assertEquals(4, Yii::app()->emailHelper->getSentCount());
sleep(30);
Yii::app()->imap->connect();
$imapStats = Yii::app()->imap->getMessageBoxStatsDetailed();
$this->assertEquals(1, $imapStats->Nmsgs);
}
Yii::app()->emailHelper->sendEmailThroughTransport = false;
}
public function generateAndProcessEmailMessages($count)
{
$box = EmailBox::resolveAndGetByName(EmailBox::NOTIFICATIONS_NAME);
$outboxFolder = EmailFolder::getByBoxAndType($box, EmailFolder::TYPE_OUTBOX);
$sentFolder = EmailFolder::getByBoxAndType($box, EmailFolder::TYPE_SENT);
$fileNames = array('testImage.png', 'testZip.zip', 'testPDF.pdf');
$emailMessageIds = array();
$files = array();
for ($i = 0; $i < $count; $i++) {
$emailMessage = EmailMessageTestHelper::createDraftSystemEmail('My Email Message ' . $i, $this->user);
foreach ($fileNames as $index => $fileName) {
$file = ZurmoTestHelper::createFileModel($fileName);
$files[$index]['name'] = $fileName;
$files[$index]['type'] = $file->type;
$files[$index]['size'] = $file->size;
$files[$index]['contents'] = $file->fileContent->content;
$emailMessage->files->add($file);
}
$emailMessage->folder = $outboxFolder;
$saved = $emailMessage->save(false);
$this->assertTrue($saved);
$emailMessageIds[] = $emailMessage->id;
$emailMessage->forget();
unset($emailMessage);
}
OutboundEmailBatchSizeConfigUtil::setBatchSize($count + 1);
Yii::app()->jobQueue->deleteAll();
ForgetAllCacheUtil::forgetAllCaches();
$job = new ProcessOutboundEmailJob();
$startedAt = microtime(true);
$this->assertTrue($job->run());
$timeTaken = microtime(true) - $startedAt;
ForgetAllCacheUtil::forgetAllCaches();
$emailMessages = EmailMessage::getAll();
$this->assertEquals($count, count($emailMessages));
foreach ($emailMessageIds as $i => $emailMessageId) {
$emailMessage = EmailMessage::getById($emailMessageId);
$this->assertEquals('My Email Message ' . $i, $emailMessage->subject);
$this->assertEquals(1, $emailMessage->sendAttempts);
$this->assertEquals($sentFolder->id, $emailMessage->folder->id);
$this->assertNotEmpty($emailMessage->files);
$this->assertCount(count($files), $emailMessage->files);
foreach ($emailMessage->files as $index => $file) {
$this->assertEquals($file->name, $emailMessage->files[$index]->name);
$this->assertEquals($file->type, $emailMessage->files[$index]->type);
$this->assertEquals($file->size, $emailMessage->files[$index]->size);
$this->assertEquals($file->fileContent->content, $emailMessage->files[$index]->fileContent->content);
$this->assertEquals($file->fileContent->id, $emailMessage->files[$index]->fileContent->id);
}
}
return $timeTaken;
}
