public static function setUpBeforeClass()
{
parent::setUpBeforeClass();
SecurityTestHelper::createSuperAdmin();
SecurityTestHelper::createUsers();
$super = User::getByUsername('super');
$super->primaryEmail->emailAddress = '*****@*****.**';
$saved = $super->save();
if (!$saved) {
throw new FailedToSaveModelException();
}
MarketingListTestHelper::createMarketingListByName('testMarketingList');
$campaign = CampaignTestHelper::createCampaign('testCampaign', 'testSubject', 'testContent', 'testHtmlContent');
$contact = ContactTestHelper::createContactByNameForOwner('test', $super);
$emailMessage = EmailMessageTestHelper::createArchivedUnmatchedSentMessage($super);
$campaignItem = new CampaignItem();
$campaignItem->contact = $contact;
$campaignItem->processed = true;
$campaignItem->campaign = $campaign;
$campaignItem->emailMessage = $emailMessage;
$campaignItem->unrestrictedSave();
if (!$saved) {
throw new FailedToSaveModelException();
}
AllPermissionsOptimizationUtil::rebuild();
}
public static function createNewActivity($type, $modelId, $personId, $url = null, $sourceIP = null)
{
$relatedModel = CampaignItem::getById(intval($modelId));
if (!$relatedModel) {
throw new NotFoundException();
}
$relationName = 'campaignItem';
return parent::createNewChildActivity($type, $personId, $url, $relationName, $relatedModel, $sourceIP);
}
/**
* Method for testing creating a simple notification for the current user.
*/
public function actionGenerateManageSubscriptionHash()
{
if (Yii::app()->user->userModel->username != 'super') {
throw new NotSupportedException();
}
$contact = RandomDataUtil::getRandomValueFromArray(Contact::getAll());
$personId = $contact->getClassId('Person');
$marketingList = RandomDataUtil::getRandomValueFromArray(MarketingList::getAll());
$marketingListId = $marketingList->id;
$model = RandomDataUtil::getRandomValueFromArray(CampaignItem::getAll());
$modelId = $model->id;
$modelType = get_class($model);
$hash = EmailMessageActivityUtil::resolveHashForUnsubscribeAndManageSubscriptionsUrls($personId, $marketingListId, $modelId, $modelType, false);
echo 'index.php/marketingLists/external/manageSubscriptions?hash=' . $hash;
}
/**
* Method for testing creating a simple notification for the current user.
*/
public function actionGenerateManageSubscriptionHash()
{
if (!Group::isUserASuperAdministrator(Yii::app()->user->userModel)) {
throw new NotSupportedException();
}
$contact = RandomDataUtil::getRandomValueFromArray(Contact::getAll());
$personId = $contact->getClassId('Person');
$marketingList = RandomDataUtil::getRandomValueFromArray(MarketingList::getAll());
$marketingListId = $marketingList->id;
$model = RandomDataUtil::getRandomValueFromArray(CampaignItem::getAll());
$modelId = $model->id;
$modelType = get_class($model);
$hash = GlobalMarketingFooterUtil::resolveHash($personId, $marketingListId, $modelId, $modelType, false);
echo 'index.php/marketingLists/external/manageSubscriptions?hash=' . $hash;
}
/**
* @param int $type
* @return string
*/
protected static function resolveCampaignTypeSubQuery($type)
{
assert('is_int($type)');
$quote = DatabaseCompatibilityUtil::getQuote();
$where = null;
$campaignItemTableName = CampaignItem::getTableName();
$campaignItemActivityTableName = CampaignItemActivity::getTableName();
$emailMessageActivityTableName = EmailMessageActivity::getTableName();
$selectQueryAdapter = new RedBeanModelSelectQueryAdapter();
$joinTablesAdapter = new RedBeanModelJoinTablesQueryAdapter('CampaignItemActivity');
$selectQueryAdapter->addClauseByQueryString("1");
$joinTablesAdapter->addFromTableAndGetAliasName($emailMessageActivityTableName, 'emailmessageactivity_id', $campaignItemActivityTableName);
$where = "type = " . $type . " and {$quote}{$campaignItemActivityTableName}{$quote}" . ".campaignitem_id = {$quote}{$campaignItemTableName}{$quote}.id";
$sql = SQLQueryUtil::makeQuery($campaignItemActivityTableName, $selectQueryAdapter, $joinTablesAdapter, null, 1, $where);
return $sql;
}
/**
* @see BaseJob::run()
*/
public function run()
{
$batchSize = $this->resolveBatchSize();
$campaignItemsToProcess = CampaignItem::getByProcessedAndStatusAndSendOnDateTime(0, Campaign::STATUS_PROCESSING, time(), $batchSize);
foreach ($campaignItemsToProcess as $campaignItem) {
try {
$this->processCampaignItemInQueue($campaignItem);
} catch (NotFoundException $e) {
return $campaignItem->delete();
} catch (NotSupportedException $e) {
$this->errorMessage = $e->getMessage();
return false;
}
}
return true;
}
protected function processRun()
{
parent::processRun();
$batchSize = $this->resolveBatchSize();
if ($batchSize != null) {
$resolvedBatchSize = $batchSize + 1;
} else {
$resolvedBatchSize = null;
}
$campaignItemsToProcess = CampaignItem::getByProcessedAndStatusAndSendOnDateTime(0, Campaign::STATUS_PROCESSING, time(), $resolvedBatchSize);
$startingMemoryUsage = memory_get_usage();
$modelsProcessedCount = 0;
$signalMarkCompletedJob = true;
foreach ($campaignItemsToProcess as $campaignItem) {
try {
$this->processCampaignItemInQueue($campaignItem);
} catch (NotFoundException $e) {
//todo: handle if delete returns false.
$campaignItem->delete();
} catch (NotSupportedException $e) {
$this->errorMessage = $e->getMessage();
//todo: returning false if using job queueing will cause job to not run again. maybe do something different?
return false;
}
$this->runGarbageCollection($campaignItem);
$modelsProcessedCount++;
if ($this->hasReachedMaximumProcessingCount($modelsProcessedCount, $batchSize)) {
Yii::app()->jobQueue->add('CampaignQueueMessagesInOutbox', 5);
$signalMarkCompletedJob = false;
break;
}
if (!Yii::app()->performance->isMemoryUsageSafe()) {
$this->addMaximumMemoryUsageReached();
Yii::app()->jobQueue->add('CampaignQueueMessagesInOutbox', 5);
$signalMarkCompletedJob = false;
break;
}
}
$this->addMaxmimumProcessingCountMessage($modelsProcessedCount, $startingMemoryUsage);
if ($signalMarkCompletedJob) {
Yii::app()->jobQueue->add('CampaignMarkCompleted', 5);
}
return true;
}
protected function processRun()
{
$batchSize = $this->resolveBatchSize();
$campaignItemsToProcess = CampaignItem::getByProcessedAndStatusAndSendOnDateTime(0, Campaign::STATUS_PROCESSING, time(), $batchSize);
$startingMemoryUsage = memory_get_usage();
$modelsProcessedCount = 0;
foreach ($campaignItemsToProcess as $campaignItem) {
try {
$this->processCampaignItemInQueue($campaignItem);
} catch (NotFoundException $e) {
return $campaignItem->delete();
} catch (NotSupportedException $e) {
$this->errorMessage = $e->getMessage();
return false;
}
$this->runGarbageCollection($campaignItem);
$modelsProcessedCount++;
}
$this->addMaxmimumProcessingCountMessage($modelsProcessedCount, $startingMemoryUsage);
return true;
}
protected static function generateCampaignItems($campaign, $pageSize)
{
if ($pageSize == null) {
$pageSize = self::DEFAULT_CAMPAIGNITEMS_TO_CREATE_PAGE_SIZE;
}
$contacts = array();
$quote = DatabaseCompatibilityUtil::getQuote();
$sql = "select {$quote}marketinglistmember{$quote}.{$quote}contact_id{$quote} from {$quote}marketinglistmember{$quote}\n left join {$quote}campaignitem{$quote} on {$quote}campaignitem{$quote}.{$quote}contact_id{$quote} " . "= {$quote}marketinglistmember{$quote}.{$quote}contact_id{$quote} " . "AND {$quote}campaignitem{$quote}.{$quote}campaign_id{$quote} = " . $campaign->id . " where {$quote}marketinglistmember{$quote}.{$quote}marketinglist_id{$quote} = " . $campaign->marketingList->id . " and {$quote}campaignitem{$quote}.{$quote}id{$quote} IS NULL limit " . $pageSize;
$ids = R::getCol($sql);
foreach ($ids as $contactId) {
$contacts[] = Contact::getById((int) $contactId);
}
if (!empty($contacts)) {
//todo: if the return value is false, then we might need to catch that since it didn't go well.
CampaignItem::registerCampaignItemsByCampaign($campaign, $contacts);
if (count($ids) < $pageSize) {
return true;
}
} else {
return true;
}
}
/**
* @depends testRunWithCustomBatchSize
*/
public function testRunWithContactContainingPrimaryEmailOptedOut()
{
$unprocessedItems = CampaignItem::getByProcessed(0);
$this->assertCount(1, $unprocessedItems);
$job = new CampaignQueueMessagesInOutboxJob();
$email = new Email();
$email->emailAddress = '*****@*****.**';
$email->optOut = true;
$contact = ContactTestHelper::createContactByNameForOwner('contact 07', $this->user);
$contact->primaryEmail = $email;
$this->assertTrue($contact->save());
$marketingList = MarketingListTestHelper::createMarketingListByName('marketingList 08', 'description goes here', 'fromName', '*****@*****.**');
$campaign = CampaignTestHelper::createCampaign('campaign 08', 'subject', '[[FIRST^NAME]]', '[[LAST^NAME]]', null, null, null, Campaign::STATUS_PROCESSING, null, null, $marketingList);
$processed = 0;
$campaignItem = CampaignItemTestHelper::createCampaignItem($processed, $campaign, $contact);
$unprocessedItems = CampaignItem::getByProcessedAndCampaignId($processed, $campaign->id);
$this->assertCount(1, $unprocessedItems);
$this->assertTrue($job->run());
$unprocessedItems = CampaignItem::getByProcessedAndCampaignId($processed, $campaign->id);
$this->assertCount(0, $unprocessedItems);
$personId = $contact->getClassId('Person');
$activities = CampaignItemActivity::getByTypeAndModelIdAndPersonIdAndUrl(CampaignItemActivity::TYPE_SKIP, $campaignItem->id, $personId);
$this->assertNotEmpty($activities);
$this->assertCount(1, $activities);
}
public function generateCampaignItemsForDueCampaigns($count)
{
$marketingList = MarketingListTestHelper::createMarketingListByName('marketingList Test', 'description goes here', 'fromName', '*****@*****.**');
$marketingListId = $marketingList->id;
$contacts = array();
$emails = array();
for ($i = 0; $i < $count; $i++) {
$emails[$i] = new Email();
$emails[$i]->emailAddress = "demo{$i}@zurmo.com";
$account = AccountTestHelper::createAccountByNameForOwner('account ' . $i, $this->user);
$contact = ContactTestHelper::createContactWithAccountByNameForOwner('contact ' . $i, $this->user, $account);
$contact->primaryEmail = $emails[$i];
$this->assertTrue($contact->save());
$contacts[$i] = $contact;
MarketingListMemberTestHelper::createMarketingListMember(0, $marketingList, $contact);
}
$marketingList->forgetAll();
$marketingList = MarketingList::getById($marketingListId);
$content = <<<MTG
[[COMPANY^NAME]]
[[CREATED^DATE^TIME]]
[[DEPARTMENT]]
[[DESCRIPTION]]
[[FIRST^NAME]]
[[GOOGLE^WEB^TRACKING^ID]]
[[INDUSTRY]]
[[JOB^TITLE]]
[[LAST^NAME]]
[[LATEST^ACTIVITY^DATE^TIME]]
[[MOBILE^PHONE]]
[[MODIFIED^DATE^TIME]]
[[OFFICE^FAX]]
[[OFFICE^PHONE]]
[[TITLE]]
[[SOURCE]]
[[STATE]]
[[WEBSITE]]
[[MODEL^URL]]
[[BASE^URL]]
[[APPLICATION^NAME]]
[[CURRENT^YEAR]]
[[LAST^YEAR]]
[[OWNERS^AVATAR^SMALL]]
[[OWNERS^AVATAR^MEDIUM]]
[[OWNERS^AVATAR^LARGE]]
[[OWNERS^EMAIL^SIGNATURE]]
[[UNSUBSCRIBE^URL]]
[[MANAGE^SUBSCRIPTIONS^URL]]
[[PRIMARY^EMAIL__EMAIL^ADDRESS]]
[[PRIMARY^EMAIL__EMAIL^ADDRESS]]
[[SECONDARY^ADDRESS__CITY]]
[[SECONDARY^ADDRESS__COUNTRY]]
[[SECONDARY^ADDRESS__INVALID]]
[[SECONDARY^ADDRESS__LATITUDE]]
[[SECONDARY^ADDRESS__LONGITUDE]]
[[SECONDARY^ADDRESS__POSTAL^CODE]]
[[SECONDARY^ADDRESS__STATE]]
[[SECONDARY^ADDRESS__STREET1]]
[[SECONDARY^ADDRESS__STREET2]]
[[OWNER__DEPARTMENT]]
[[OWNER__FIRST^NAME]]
[[OWNER__IS^ACTIVE]]
[[OWNER__MOBILE^PHONE]]
[[OWNER__LAST^LOGIN^DATE^TIME]]
[[OWNER__LAST^NAME]]
[[CREATED^BY^USER__FIRST^NAME]]
[[CREATED^BY^USER__LAST^NAME]]
[[CREATED^BY^USER__MOBILE^PHONE]]
[[CREATED^BY^USER__TITLE]]
[[CREATED^BY^USER__USERNAME]]
[[ACCOUNT__ANNUAL^REVENUE]]
[[ACCOUNT__INDUSTRY]]
[[ACCOUNT__NAME]]
[[ACCOUNT__WEBSITE]]
[[ACCOUNT__BILLING^ADDRESS__COUNTRY]]
[[ACCOUNT__BILLING^ADDRESS__CITY]]
[[ACCOUNT__OWNER__FIRST^NAME]]
' " ` " '
MTG;
$sendOnDateTime = DateTimeUtil::convertTimestampToDbFormatDateTime(time() - 600);
$campaign = CampaignTestHelper::createCampaign('campaign Test', 'subject', $content, $content, null, null, null, Campaign::STATUS_ACTIVE, $sendOnDateTime, null, $marketingList, false);
$fileNames = array('testImage.png', 'testZip.zip', 'testPDF.pdf');
$files = array();
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;
$campaign->files->add($file);
}
$this->assertTrue($campaign->save(false));
$campaignId = $campaign->id;
$campaign->forgetAll();
$campaignItems = CampaignItem::getByProcessedAndCampaignId(0, $campaignId);
$this->assertEmpty($campaignItems);
//Process open campaigns.
Yii::app()->jobQueue->deleteAll();
AutoresponderOrCampaignBatchSizeConfigUtil::setBatchSize($count);
Yii::app()->jobQueue->deleteAll();
$this->assertCount(0, Yii::app()->jobQueue->getAll());
ForgetAllCacheUtil::forgetAllCaches();
$job = new CampaignGenerateDueCampaignItemsJob();
$startedAt = microtime(true);
$this->assertTrue($job->run());
$timeTaken = microtime(true) - $startedAt;
ForgetAllCacheUtil::forgetAllCaches();
$campaign->forgetAll();
unset($campaign);
$campaign = Campaign::getById($campaignId);
$this->assertNotNull($campaign);
$this->assertEquals(Campaign::STATUS_PROCESSING, $campaign->status);
$campaignItems = CampaignItem::getByProcessedAndCampaignId(0, $campaignId);
$this->assertNotEmpty($campaignItems);
$this->assertCount($count, $campaignItems);
return $timeTaken;
}
protected static function generateCampaignItems($campaign, $pageSize)
{
if ($pageSize == null) {
$pageSize = self::DEFAULT_CAMPAIGNITEMS_TO_CREATE_PAGE_SIZE;
}
$contacts = array();
$quote = DatabaseCompatibilityUtil::getQuote();
$marketingListMemberTableName = RedBeanModel::getTableName('MarketingListMember');
$campaignItemTableName = RedBeanModel::getTableName('CampaignItem');
$sql = "select {$quote}{$marketingListMemberTableName}{$quote}.{$quote}contact_id{$quote} from {$quote}{$marketingListMemberTableName}{$quote}";
// Not Coding Standard
$sql .= "left join {$quote}{$campaignItemTableName}{$quote} on ";
$sql .= "{$quote}{$campaignItemTableName}{$quote}.{$quote}contact_id{$quote} ";
$sql .= "= {$quote}{$marketingListMemberTableName}{$quote}.{$quote}contact_id{$quote}";
$sql .= "AND {$quote}{$campaignItemTableName}{$quote}.{$quote}campaign_id{$quote} = " . $campaign->id . " ";
$sql .= "where {$quote}{$marketingListMemberTableName}{$quote}.{$quote}marketinglist_id{$quote} = " . $campaign->marketingList->id;
$sql .= " and {$quote}{$campaignItemTableName}{$quote}.{$quote}id{$quote} is null limit " . $pageSize;
$ids = R::getCol($sql);
foreach ($ids as $contactId) {
$contacts[] = Contact::getById((int) $contactId);
}
if (!empty($contacts)) {
//todo: if the return value is false, then we might need to catch that since it didn't go well.
CampaignItem::registerCampaignItemsByCampaign($campaign, $contacts);
if (count($ids) < $pageSize) {
return true;
}
} else {
return true;
}
return false;
}
/**
* @depends testRunWithDueActiveCampaignsWithMembers
*/
public function testRunWithJustDueActiveCampaignsWithMembers()
{
$marketingList = MarketingListTestHelper::createMarketingListByName('marketingList 05');
$marketingListId = $marketingList->id;
$processed = 0;
for ($i = 6; $i <= 10; $i++) {
$contact = ContactTestHelper::createContactByNameForOwner('campaignContact 0' . $i, $this->user);
MarketingListMemberTestHelper::createMarketingListMember($processed, $marketingList, $contact);
}
$marketingList->forgetAll();
$marketingList = MarketingList::getById($marketingListId);
$nowDateTime = DateTimeUtil::convertTimestampToDbFormatDateTime(time());
$campaign = CampaignTestHelper::createCampaign('Active, Just Due With Members', 'subject', 'text Content', 'Html Content', null, null, null, Campaign::STATUS_ACTIVE, $nowDateTime, null, $marketingList);
// we have to do this to ensure when we retrieve the data status is updated from db.
$campaign->forgetAll();
$this->assertEmpty(CampaignItem::getAll());
// sleep 1 second to ensure we are giving ample time difference between creating the campaign and calling the job
sleep(1);
$job = new CampaignGenerateDueCampaignItemsJob();
$this->assertTrue($job->run());
$campaign = Campaign::getByName('Active, just Due With Members');
$this->assertEquals(Campaign::STATUS_PROCESSING, $campaign[0]->status);
$allCampaignItems = CampaignItem::getAll();
$this->assertNotEmpty($allCampaignItems);
$this->assertCount(5, $allCampaignItems);
$campaignItems = CampaignItem::getByProcessedAndCampaignId(0, $campaign[0]->id);
$this->assertNotEmpty($campaignItems);
$this->assertCount(5, $campaignItems);
}
/**
* @param CampaignItem $campaignItem
* @return string
*/
protected static function renderMetricsContent(CampaignItem $campaignItem)
{
if (!ActionSecurityUtil::canCurrentUserPerformAction('Details', $campaignItem->emailMessage)) {
return static::renderRestrictedEmailMessageAccessLink($campaignItem->emailMessage);
}
$isQueued = $campaignItem->isQueued();
$isSkipped = $campaignItem->isSkipped();
if ($isQueued) {
$content = static::getQueuedContent();
} elseif ($isSkipped) {
$content = static::getSkippedContent();
} elseif ($campaignItem->hasFailedToSend()) {
$content = static::getSendFailedContent();
} elseif ($campaignItem->isSent()) {
$content = static::getSentContent();
if ($campaignItem->hasAtLeastOneOpenActivity()) {
$content .= static::getOpenedContent();
}
if ($campaignItem->hasAtLeastOneClickActivity()) {
$content .= static::getClickedContent();
}
if ($campaignItem->hasAtLeastOneUnsubscribeActivity()) {
$content .= static::getUnsubscribedContent();
}
if ($campaignItem->hasAtLeastOneBounceActivity()) {
$content .= static::getBouncedContent();
}
} else {
$content = static::getAwaitingQueueingContent();
}
return ZurmoHtml::wrapAndRenderContinuumButtonContent($content);
}
protected function deleteAllCampaignItems()
{
$campaignItems = CampaignItem::getAll();
foreach ($campaignItems as $campaignItem) {
$campaignItem->delete();
}
}
public function actionDrillDownDetails($campaignItemId)
{
$id = (int) $campaignItemId;
$campaignItem = CampaignItem::getById($id);
ControllerSecurityUtil::resolveAccessCanCurrentUserReadModel($campaignItem->campaign);
ControllerSecurityUtil::resolveAccessCanCurrentUserReadModel($campaignItem->contact);
ControllerSecurityUtil::resolveAccessCanCurrentUserReadModel($campaignItem->emailMessage);
echo CampaignItemSummaryListViewColumnAdapter::resolveDrillDownMetricsSummaryContent($campaignItem);
}
/**
* @depends testGenerateCampaignItemsForDueCampaigns
*/
public function testGenerateCampaignItemsForDueCampaignsWithCustomBatchSize()
{
$contactIds = array();
$marketingListIds = array();
$campaignIds = array();
for ($index = 6; $index < 9; $index++) {
$contact = ContactTestHelper::createContactByNameForOwner('campaignContact 0' . $index, $this->user);
$contactIds[] = $contact->id;
$contact->forgetAll();
}
for ($index = 8; $index < 12; $index++) {
$suffix = $index;
if ($index < 10) {
$suffix = "0{$suffix}";
}
$marketingList = MarketingListTestHelper::createMarketingListByName('marketingList ' . $suffix);
$marketingListId = $marketingList->id;
$marketingListIds[] = $marketingListId;
foreach ($contactIds as $contactId) {
$contact = Contact::getById($contactId);
$unsubscribed = rand(10, 20) % 2;
MarketingListMemberTestHelper::createMarketingListMember($unsubscribed, $marketingList, $contact);
}
$marketingList->forgetAll();
$marketingList = MarketingList::getById($marketingListId);
$campaignSuffix = substr($marketingList->name, -2);
$campaign = CampaignTestHelper::createCampaign('campaign ' . $campaignSuffix, 'subject ' . $campaignSuffix, 'text ' . $campaignSuffix, 'html ' . $campaignSuffix, null, null, null, null, null, null, $marketingList);
$this->assertNotNull($campaign);
$campaignIds[] = $campaign->id;
$campaign->forgetAll();
}
foreach ($campaignIds as $campaignId) {
$campaignItems = CampaignItem::getByProcessedAndCampaignId(0, $campaignId);
$this->assertEmpty($campaignItems);
}
$this->assertTrue(CampaignItemsUtil::generateCampaignItemsForDueCampaigns(5));
foreach ($campaignIds as $index => $campaignId) {
$campaign = Campaign::getById($campaignId);
$campaignItems = CampaignItem::getByProcessedAndCampaignId(0, $campaignId);
if ($index === 0) {
$expectedCount = AutoresponderOrCampaignBatchSizeConfigUtil::getBatchSize();
$memberCount = count($campaign->marketingList->marketingListMembers);
if ($memberCount < $expectedCount) {
$expectedCount = $memberCount;
}
$this->assertNotEmpty($campaignItems);
$this->assertCount($expectedCount, $campaignItems);
$this->assertEquals(Campaign::STATUS_PROCESSING, $campaign->status);
} else {
$this->assertEmpty($campaignItems);
$this->assertEquals(Campaign::STATUS_ACTIVE, $campaign->status);
}
}
$this->assertTrue(CampaignItemsUtil::generateCampaignItemsForDueCampaigns());
foreach ($campaignIds as $index => $campaignId) {
$campaign = Campaign::getById($campaignId);
$campaignItems = CampaignItem::getByProcessedAndCampaignId(0, $campaignId);
if ($index < 2) {
$expectedCount = AutoresponderOrCampaignBatchSizeConfigUtil::getBatchSize();
$memberCount = count($campaign->marketingList->marketingListMembers);
if ($memberCount < $expectedCount) {
$expectedCount = $memberCount;
}
$this->assertNotEmpty($campaignItems);
$this->assertCount($expectedCount, $campaignItems);
$this->assertEquals(Campaign::STATUS_PROCESSING, $campaign->status);
} else {
$this->assertEmpty($campaignItems);
$this->assertEquals(Campaign::STATUS_ACTIVE, $campaign->status);
}
}
// TODO: @Shoaibi: Medium: Add tests for the other campaign type.
}
protected static function areAllCampaignItemsProcessed($campaignId)
{
$unprocessedCampaignItems = CampaignItem::getByProcessedAndCampaignId(0, $campaignId);
return count($unprocessedCampaignItems) == 0;
}
/**
* @depends testCreateAndGetCampaignItemById
*/
public function testDeleteCampaignItem()
{
$campaignItems = CampaignItem::getAll();
$this->assertNotEmpty($campaignItems);
$this->assertCount(10, $campaignItems);
$campaignItems[0]->delete();
$campaignItems = CampaignItem::getAll();
$this->assertNotEmpty($campaignItems);
$this->assertCount(9, $campaignItems);
}
public function testResolveMailerWithItemsData()
{
$contact = ContactTestHelper::createContactByNameForOwner('mailercontact', $this->user);
$campaignItem = new CampaignItem();
$campaignItem->processed = 0;
$campaignItem->contact = $contact;
$this->assertTrue($campaignItem->unrestrictedSave());
ZurmoConfigurationUtil::setByModuleName('MarketingModule', 'UseAutoresponderOrCampaignOwnerMailSettings', true);
ZurmoConfigurationUtil::setByModuleName('SendGridModule', 'enableSendgrid', true);
$emailMessage = EmailMessageHelper::processAndCreateTestEmailMessage(array('name' => 'Test User', 'address' => '*****@*****.**'), '*****@*****.**');
$emailMessage->owner = static::$bothSGandCstmUser;
$this->assertTrue($emailMessage->save());
$campaignItem->emailMessage = $emailMessage;
$this->assertTrue($campaignItem->unrestrictedSave());
//user sendgrid, should return personal sg instance
$mailerFactory = new ZurmoMailerFactory($emailMessage);
$mailer = $mailerFactory->resolveMailer();
$this->assertTrue($mailer instanceof ZurmoSendGridMailer);
$this->assertNotNull($mailer->getEmailAccount());
//Uncheck autoresponder/camapign settings for owner, should return global sg instance
ZurmoConfigurationUtil::setByModuleName('MarketingModule', 'UseAutoresponderOrCampaignOwnerMailSettings', false);
$mailerFactory = new ZurmoMailerFactory($emailMessage);
$mailer = $mailerFactory->resolveMailer();
$this->assertTrue($mailer instanceof ZurmoSendGridMailer);
$this->assertNull($mailer->getEmailAccount());
ZurmoConfigurationUtil::setByModuleName('MarketingModule', 'UseAutoresponderOrCampaignOwnerMailSettings', true);
$emailMessage->owner = static::$usercstmsmtp;
assert($emailMessage->save());
// Not Coding Standard
$mailerFactory = new ZurmoMailerFactory($emailMessage);
$mailer = $mailerFactory->resolveMailer();
$this->assertTrue($mailer instanceof ZurmoSwiftMailer);
$this->assertNotNull($mailer->getEmailAccount());
$this->assertEquals('smtp', $mailer->getEmailMessage()->mailerType);
$this->assertEquals('personal', $mailer->getEmailMessage()->mailerSettings);
}
/**
* @depends testCreateNewActivity
*/
public function testGetByTypeAndModelIdAndPersonIdAndUrl()
{
$type = CampaignItemActivity::TYPE_OPEN;
$url = null;
$persons = Person::getAll();
$this->assertNotEmpty($persons);
$person = $persons[0];
$campaignItems = CampaignItem::getAll();
$this->assertNotEmpty($campaignItems);
$campaignItem = $campaignItems[0];
$activities = CampaignItemActivity::getByTypeAndModelIdAndPersonIdAndUrl($type, $campaignItem->id, $person->id, $url);
$this->assertNotEmpty($activities);
$this->assertCount(1, $activities);
$activity = $activities[0];
$this->assertEquals($type, $activity->type);
$this->assertEquals(1, $activity->quantity);
$this->assertEquals($person, $activity->person);
$this->assertEquals($campaignItem, $activity->campaignItem);
// now try same thing but with a url this time.
$contact = Contact::getByName('contact 02 contact 02son');
$personId = $contact[0]->getClassId('Person');
$person = Person::getById($personId);
$type = CampaignItemActivity::TYPE_CLICK;
$url = 'http://www.zurmo.com';
$activities = CampaignItemActivity::getByTypeAndModelIdAndPersonIdAndUrl($type, $campaignItem->id, $personId, $url);
$this->assertNotEmpty($activities);
$this->assertCount(1, $activities);
$activity = $activities[0];
$this->assertEquals($type, $activity->type);
$this->assertEquals(1, $activity->quantity);
$this->assertEquals($person, $activity->person);
$this->assertEquals($campaignItem, $activity->campaignItem);
}
/**
* @param array $searchAttributeData
* @param string $groupBy
* @return string
*/
protected static function makeCampaignsSqlQuery($searchAttributeData, $groupBy)
{
$quote = DatabaseCompatibilityUtil::getQuote();
$where = null;
$selectDistinct = false;
$campaignTableName = Campaign::getTableName();
$campaignItemTableName = CampaignItem::getTableName();
$emailMessageTableName = EmailMessage::getTableName();
$sentDateTimeColumnName = EmailMessage::getColumnNameByAttribute('sentDateTime');
$joinTablesAdapter = new RedBeanModelJoinTablesQueryAdapter('Campaign');
$where = RedBeanModelDataProvider::makeWhere('Campaign', $searchAttributeData, $joinTablesAdapter);
Campaign::resolveReadPermissionsOptimizationToSqlQuery(Yii::app()->user->userModel, $joinTablesAdapter, $where, $selectDistinct);
$selectQueryAdapter = new RedBeanModelSelectQueryAdapter($selectDistinct);
$uniqueOpensSelectPart = static::resolveCampaignTypeSubQuery(EmailMessageActivity::TYPE_OPEN);
$uniqueClicksSelectPart = static::resolveCampaignTypeSubQuery(EmailMessageActivity::TYPE_CLICK);
static::addEmailMessageDayDateClause($selectQueryAdapter, $sentDateTimeColumnName);
static::addEmailMessageFirstDayOfWeekDateClause($selectQueryAdapter, $sentDateTimeColumnName);
static::addEmailMessageFirstDayOfMonthDateClause($selectQueryAdapter, $sentDateTimeColumnName);
$selectQueryAdapter->addNonSpecificCountClause();
$selectQueryAdapter->addClauseByQueryString("count((" . $uniqueOpensSelectPart . "))", static::UNIQUE_OPENS);
$selectQueryAdapter->addClauseByQueryString("count((" . $uniqueClicksSelectPart . "))", static::UNIQUE_CLICKS);
$joinTablesAdapter->addLeftTableAndGetAliasName($campaignItemTableName, 'id', $campaignTableName, 'campaign_id');
$joinTablesAdapter->addLeftTableAndGetAliasName($emailMessageTableName, 'emailmessage_id', $campaignItemTableName, 'id');
$sql = SQLQueryUtil::makeQuery($campaignTableName, $selectQueryAdapter, $joinTablesAdapter, null, null, $where, null, $groupBy);
return $sql;
}
/**
* @depends testSendQueued
*/
public function testSendQueuedSkipsPausedCampaignMessages()
{
EmailMessage::deleteAll();
$job = new CampaignQueueMessagesInOutboxJob();
$email = new Email();
$email->emailAddress = '*****@*****.**';
$contact = ContactTestHelper::createContactByNameForOwner('contact', $this->user);
$contact->primaryEmail = $email;
$this->assertTrue($contact->save());
$marketingList = MarketingListTestHelper::createMarketingListByName('marketingList');
MarketingListMemberTestHelper::createMarketingListMember(0, $marketingList, $contact);
$campaign = CampaignTestHelper::createCampaign('campaign', 'subject', 'text Content', 'Html Content', null, null, null, Campaign::STATUS_PROCESSING, null, 0, $marketingList);
$processed = 0;
CampaignItemTestHelper::createCampaignItem($processed, $campaign, $contact);
$this->assertTrue($job->run());
$campaignItems = CampaignItem::getAll();
$this->assertCount(1, $campaignItems);
$campaignItemsProcessed = CampaignItem::getByProcessedAndCampaignId(1, $campaign->id);
$this->assertCount(1, $campaignItemsProcessed);
$campaign->status = Campaign::STATUS_PAUSED;
$this->assertTrue($campaign->save());
$this->assertEquals(1, Yii::app()->emailHelper->getQueuedCount());
$this->assertEquals(0, Yii::app()->emailHelper->getSentCount());
Yii::app()->emailHelper->sendQueued();
$this->assertEquals(1, Yii::app()->emailHelper->getQueuedCount());
$this->assertEquals(0, Yii::app()->emailHelper->getSentCount());
}
/**
* @depends testRunWithMultipleRecipientsWithAttachments
*/
public function testRunWithSubscribedAndUnsubscribedMembers()
{
$campaignItemsCountBefore = CampaignItem::getCount();
$job = new CampaignQueueMessagesInOutboxJob();
$marketingList = MarketingListTestHelper::createMarketingListByName('marketingList 10');
$marketingListId = $marketingList->id;
$contacts = array();
for ($i = 0; $i < 5; $i++) {
$email = new Email();
$email->emailAddress = "demo{$i}@zurmo.com";
$contact = ContactTestHelper::createContactByNameForOwner('contact 0' . ($i + 14), $this->user);
$contact->primaryEmail = $email;
$this->assertTrue($contact->save());
$contacts[] = $contact;
MarketingListMemberTestHelper::createMarketingListMember($i % 2, $marketingList, $contact);
}
$marketingList->forgetAll();
$marketingList = MarketingList::getById($marketingListId);
$campaign = CampaignTestHelper::createCampaign('campaign 10', 'subject 10', '[[FIRST^NAME]]', '[[LAST^NAME]]', null, null, null, Campaign::STATUS_PROCESSING, null, 0, $marketingList);
$this->assertNotNull($campaign);
$campaignId = $campaign->id;
foreach ($contacts as $contact) {
CampaignItemTestHelper::createCampaignItem(0, $campaign, $contact);
}
$this->assertTrue($job->run());
$campaign = Campaign::getById($campaignId);
$campaignItemsCountExpected = $campaignItemsCountBefore + 5;
$campaignItemsCountAfter = CampaignItem::getCount();
$this->assertEquals($campaignItemsCountExpected, $campaignItemsCountAfter);
$campaignItemsProcessed = CampaignItem::getByProcessedAndCampaignId(1, $campaign->id);
$this->assertCount(5, $campaignItemsProcessed);
$skippedCount = 0;
foreach ($campaignItemsProcessed as $campaignItem) {
$contact = $campaignItem->contact;
$member = MarketingListMember::getByMarketingListIdContactIdAndUnsubscribed($campaign->marketingList->id, $contact->id, true);
if ($member) {
$personId = $campaignItem->contact->getClassId('Person');
$type = CampaignItemActivity::TYPE_SKIP;
$activity = CampaignItemActivity::getByTypeAndModelIdAndPersonIdAndUrl($type, $campaignItem->id, $personId);
$this->assertNotNull($activity);
$this->assertNotEmpty($activity);
$this->assertCount(1, $activity);
$skippedCount++;
} else {
$this->assertNotEmpty($campaignItem->emailMessage);
$this->assertContains($contact->firstName, $campaignItem->emailMessage->content->textContent);
$this->assertContains($contact->lastName, $campaignItem->emailMessage->content->htmlContent);
}
}
$this->assertEquals(2, $skippedCount);
}
/**
* @param array $searchAttributeData
* @param string $groupBy
* @return string
*/
protected static function makeCampaignsSqlQuery($searchAttributeData, $groupBy)
{
$quote = DatabaseCompatibilityUtil::getQuote();
$where = null;
$selectDistinct = false;
$campaignTableName = Campaign::getTableName('Campaign');
$campaignItemTableName = CampaignItem::getTableName('CampaignItem');
$itemTableName = Item::getTableName('Item');
$emailMessageTableName = EmailMessage::getTableName('EmailMessage');
$sentDateTimeColumnName = EmailMessage::getColumnNameByAttribute('sentDateTime');
$createdDateTimeColumnName = Item::getColumnNameByAttribute('createdDateTime');
$joinTablesAdapter = new RedBeanModelJoinTablesQueryAdapter('Campaign');
$where = RedBeanModelDataProvider::makeWhere('Campaign', $searchAttributeData, $joinTablesAdapter);
Campaign::resolveReadPermissionsOptimizationToSqlQuery(Yii::app()->user->userModel, $joinTablesAdapter, $where, $selectDistinct);
$selectQueryAdapter = new RedBeanModelSelectQueryAdapter($selectDistinct);
$queuedEmailsSelectPart = "sum(CASE WHEN {$quote}{$emailMessageTableName}{$quote}.{$quote}{$sentDateTimeColumnName}" . $quote . " = '0000-00-00 00:00:00' OR {$quote}{$emailMessageTableName}{$quote}" . ".{$quote}{$sentDateTimeColumnName}{$quote} IS NULL THEN 1 ELSE 0 END)";
// Not Coding Standard
$sentEmailsSelectPart = "sum(CASE WHEN {$quote}{$emailMessageTableName}{$quote}.{$quote}{$sentDateTimeColumnName}" . $quote . " > '0000-00-00 00:00:00' THEN 1 ELSE 0 END)";
$uniqueOpensSelectPart = static::resolveCampaignTypeSubQuery(EmailMessageActivity::TYPE_OPEN);
$uniqueClicksSelectPart = static::resolveCampaignTypeSubQuery(EmailMessageActivity::TYPE_CLICK);
$bouncedSelectPart = static::resolveCampaignTypeSubQuery(EmailMessageActivity::TYPE_BOUNCE);
$optedOutSelectPart = static::resolveCampaignTypeSubQuery(EmailMessageActivity::TYPE_UNSUBSCRIBE);
//
$selectQueryAdapter->addDayDateClause($itemTableName, $createdDateTimeColumnName, static::DAY_DATE);
$selectQueryAdapter->addFirstDayOfWeekDateClause($itemTableName, $createdDateTimeColumnName, static::FIRST_DAY_OF_WEEK_DATE);
$selectQueryAdapter->addFirstDayOfMonthDateClause($itemTableName, $createdDateTimeColumnName, static::FIRST_DAY_OF_MONTH_DATE);
$selectQueryAdapter->addNonSpecificCountClause();
$selectQueryAdapter->addClauseByQueryString($queuedEmailsSelectPart, static::QUEUED);
$selectQueryAdapter->addClauseByQueryString($sentEmailsSelectPart, static::SENT);
$selectQueryAdapter->addClauseByQueryString("count((" . $uniqueOpensSelectPart . "))", static::UNIQUE_OPENS);
$selectQueryAdapter->addClauseByQueryString("count((" . $uniqueClicksSelectPart . "))", static::UNIQUE_CLICKS);
$selectQueryAdapter->addClauseByQueryString("count((" . $bouncedSelectPart . "))", static::BOUNCED);
$selectQueryAdapter->addClauseByQueryString("count((" . $optedOutSelectPart . "))", static::UNSUBSCRIBED);
$joinTablesAdapter->addLeftTableAndGetAliasName($campaignItemTableName, 'id', $campaignTableName, 'campaign_id');
$joinTablesAdapter->addLeftTableAndGetAliasName($emailMessageTableName, 'emailmessage_id', $campaignItemTableName, 'id');
$sql = SQLQueryUtil::makeQuery($campaignTableName, $selectQueryAdapter, $joinTablesAdapter, null, null, $where, null, $groupBy);
return $sql;
}
/**
* @depends testCreateAndGetCampaignItemById
*/
public function testDeleteCampaignItem()
{
$campaignItems = CampaignItem::getAll();
$this->assertNotEmpty($campaignItems);
$this->assertCount(10, $campaignItems);
$campaignItemActivity = new CampaignItemActivity();
$campaignItemActivity->type = CampaignItemActivity::TYPE_CLICK;
$campaignItemActivity->quantity = 1;
$campaignItemActivity->campaignItem = $campaignItems[0];
$campaignItemActivity->latestSourceIP = '121.212.122.112';
$this->assertTrue($campaignItemActivity->save());
$campaignItems[0]->emailMessage = $this->resolveEmailMessage();
$this->assertTrue($campaignItems[0]->unrestrictedSave());
$this->assertEquals(1, EmailMessage::getCount());
$this->assertEquals(1, EmailMessageContent::getCount());
$this->assertEquals(1, EmailMessageSender::getCount());
$this->assertEquals(1, EmailMessageRecipient::getCount());
$campaignItemActivities = CampaignItemActivity::getAll();
$this->assertCount(1, $campaignItemActivities);
$campaignItems[0]->delete();
$campaignItems = CampaignItem::getAll();
$this->assertNotEmpty($campaignItems);
$this->assertCount(9, $campaignItems);
$campaignItemActivities = CampaignItemActivity::getAll();
$this->assertCount(0, $campaignItemActivities);
$this->assertEquals(0, EmailMessage::getCount());
$this->assertEquals(0, EmailMessageContent::getCount());
$this->assertEquals(0, EmailMessageSender::getCount());
$this->assertEquals(0, EmailMessageRecipient::getCount());
}
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 generateAndProcessCampaignItems($count)
{
$contacts = array();
$emails = array();
for ($i = 0; $i < $count; $i++) {
$emails[$i] = new Email();
$emails[$i]->emailAddress = "demo{$i}@zurmo.com";
$account = AccountTestHelper::createAccountByNameForOwner('account ' . $i, $this->user);
$contact = ContactTestHelper::createContactWithAccountByNameForOwner('contact ' . $i, $this->user, $account);
$contact->primaryEmail = $emails[$i];
$this->assertTrue($contact->save());
$contacts[$i] = $contact;
}
$content = <<<MTG
[[COMPANY^NAME]]
[[CREATED^DATE^TIME]]
[[DEPARTMENT]]
[[DESCRIPTION]]
[[FIRST^NAME]]
[[GOOGLE^WEB^TRACKING^ID]]
[[INDUSTRY]]
[[JOB^TITLE]]
[[LAST^NAME]]
[[LATEST^ACTIVITY^DATE^TIME]]
[[MOBILE^PHONE]]
[[MODIFIED^DATE^TIME]]
[[OFFICE^FAX]]
[[OFFICE^PHONE]]
[[TITLE]]
[[SOURCE]]
[[STATE]]
[[WEBSITE]]
[[MODEL^URL]]
[[BASE^URL]]
[[APPLICATION^NAME]]
[[CURRENT^YEAR]]
[[LAST^YEAR]]
[[OWNERS^AVATAR^SMALL]]
[[OWNERS^AVATAR^MEDIUM]]
[[OWNERS^AVATAR^LARGE]]
[[OWNERS^EMAIL^SIGNATURE]]
[[UNSUBSCRIBE^URL]]
[[MANAGE^SUBSCRIPTIONS^URL]]
[[PRIMARY^EMAIL__EMAIL^ADDRESS]]
[[PRIMARY^EMAIL__EMAIL^ADDRESS]]
[[SECONDARY^ADDRESS__CITY]]
[[SECONDARY^ADDRESS__COUNTRY]]
[[SECONDARY^ADDRESS__INVALID]]
[[SECONDARY^ADDRESS__LATITUDE]]
[[SECONDARY^ADDRESS__LONGITUDE]]
[[SECONDARY^ADDRESS__POSTAL^CODE]]
[[SECONDARY^ADDRESS__STATE]]
[[SECONDARY^ADDRESS__STREET1]]
[[SECONDARY^ADDRESS__STREET2]]
[[OWNER__DEPARTMENT]]
[[OWNER__FIRST^NAME]]
[[OWNER__IS^ACTIVE]]
[[OWNER__MOBILE^PHONE]]
[[OWNER__LAST^LOGIN^DATE^TIME]]
[[OWNER__LAST^NAME]]
[[CREATED^BY^USER__FIRST^NAME]]
[[CREATED^BY^USER__LAST^NAME]]
[[CREATED^BY^USER__MOBILE^PHONE]]
[[CREATED^BY^USER__TITLE]]
[[CREATED^BY^USER__USERNAME]]
[[ACCOUNT__ANNUAL^REVENUE]]
[[ACCOUNT__INDUSTRY]]
[[ACCOUNT__NAME]]
[[ACCOUNT__WEBSITE]]
[[ACCOUNT__BILLING^ADDRESS__COUNTRY]]
[[ACCOUNT__BILLING^ADDRESS__CITY]]
[[ACCOUNT__OWNER__FIRST^NAME]]
' " ` " '
MTG;
$marketingList = MarketingListTestHelper::createMarketingListByName('marketingList Test', 'description goes here', 'fromName', '*****@*****.**');
$campaign = CampaignTestHelper::createCampaign('campaign Test', 'subject', $content, $content, null, null, null, Campaign::STATUS_PROCESSING, null, null, $marketingList, false);
$fileNames = array('testImage.png', 'testZip.zip', 'testPDF.pdf');
$files = array();
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;
$campaign->files->add($file);
}
$this->assertTrue($campaign->save(false));
$processed = 0;
foreach ($contacts as $contact) {
MarketingListMemberTestHelper::createMarketingListMember(0, $marketingList, $contact);
CampaignItemTestHelper::createCampaignItem($processed, $campaign, $contact);
}
AutoresponderOrCampaignBatchSizeConfigUtil::setBatchSize($count);
Yii::app()->jobQueue->deleteAll();
ForgetAllCacheUtil::forgetAllCaches();
$job = new CampaignQueueMessagesInOutboxJob();
$this->assertCount(0, Yii::app()->jobQueue->getAll());
$startedAt = microtime(true);
$this->assertTrue($job->run());
$timeTaken = microtime(true) - $startedAt;
ForgetAllCacheUtil::forgetAllCaches();
$campaignItemsCountExpected = $count;
$campaignItemsCountAfter = CampaignItem::getCount();
$this->assertEquals($campaignItemsCountExpected, $campaignItemsCountAfter);
$campaignItemsProcessed = CampaignItem::getByProcessedAndCampaignId(1, $campaign->id);
$this->assertCount($count, $campaignItemsProcessed);
foreach ($campaignItemsProcessed as $i => $campaignItem) {
$contact = $contacts[$i];
$email = $emails[$i];
$emailMessage = $campaignItem->emailMessage;
$this->assertEquals($marketingList->owner->id, $emailMessage->owner->id);
$marketingListPermissions = ExplicitReadWriteModelPermissionsUtil::makeBySecurableItem($marketingList);
$emailMessagePermissions = ExplicitReadWriteModelPermissionsUtil::makeBySecurableItem($emailMessage);
$this->assertEquals($marketingListPermissions, $emailMessagePermissions);
$this->assertEquals($campaign->subject, $emailMessage->subject);
$this->assertNotEquals($campaign->textContent, $emailMessage->content->textContent);
$this->assertNotEquals($campaign->htmlContent, $emailMessage->content->htmlContent);
$this->assertEquals(2, substr_count($emailMessage->content->textContent, '/marketingLists/external/'));
$this->assertContains('/marketingLists/external/', $emailMessage->content->htmlContent);
$this->assertEquals(2, substr_count($emailMessage->content->htmlContent, '/marketingLists/external/'));
$this->assertEquals('*****@*****.**', $emailMessage->sender->fromAddress);
$this->assertEquals('Support Team', $emailMessage->sender->fromName);
$this->assertEquals(1, $emailMessage->recipients->count());
$recipients = $emailMessage->recipients;
$this->assertEquals(strval($contact), $recipients[0]->toName);
$this->assertEquals($email->emailAddress, $recipients[0]->toAddress);
$this->assertEquals(EmailMessageRecipient::TYPE_TO, $recipients[0]->type);
$this->assertNotEmpty($emailMessage->files);
$this->assertCount(count($files), $emailMessage->files);
foreach ($campaign->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);
//CampaingItem should share the Attachments content from Campaign
$this->assertEquals($file->fileContent->content, $emailMessage->files[$index]->fileContent->content);
$this->assertEquals($file->fileContent->id, $emailMessage->files[$index]->fileContent->id);
}
$headersArray = array('zurmoItemId' => $campaignItem->id, 'zurmoItemClass' => get_class($campaignItem), 'zurmoPersonId' => $contact->getClassId('Person'));
$expectedHeaders = serialize($headersArray);
$this->assertEquals($expectedHeaders, $emailMessage->headers);
}
return $timeTaken;
}
/**
* @depends testRequiredAttributes
*/
public function testDeleteCampaign()
{
$campaigns = Campaign::getAll();
$this->assertEquals(4, count($campaigns));
CampaignItemTestHelper::createCampaignItem(0, $campaigns[0]);
$campaignItems = CampaignItem::getAll();
$this->assertCount(1, $campaignItems);
$campaignItemActivity = new CampaignItemActivity();
$campaignItemActivity->type = CampaignItemActivity::TYPE_CLICK;
$campaignItemActivity->quantity = 1;
$campaignItemActivity->campaignItem = $campaignItems[0];
$campaignItemActivity->latestSourceIP = '121.212.122.112';
$this->assertTrue($campaignItemActivity->save());
$emailMessage = EmailMessageTestHelper::createOutboxEmail(Yii::app()->user->userModel, 'subject', 'html', 'text', 'from', '*****@*****.**', 'to', '*****@*****.**');
$campaignItems[0]->emailMessage = $emailMessage;
$this->assertTrue($campaignItems[0]->unrestrictedSave());
$this->assertEquals(1, CampaignItemActivity::getCount());
$this->assertEquals(1, EmailMessage::getCount());
$campaigns[0]->delete();
$this->assertEquals(3, Campaign::getCount());
$this->assertEquals(0, CampaignItem::getCount());
$this->assertEquals(0, CampaignItemActivity::getCount());
$this->assertEquals(1, EmailMessage::getCount());
}
protected function deleteUnprocessedCampaignItems()
{
$campaignitems = CampaignItem::getByProcessedAndCampaignId(0, $this->id);
foreach ($campaignitems as $campaignitem) {
$campaignitem->delete();
}
}
