From 6f616e5c8767ca8fc0f3e9576856f99316124269 Mon Sep 17 00:00:00 2001 From: eileen Date: Mon, 11 Sep 2017 10:47:30 +1200 Subject: [PATCH] [NFC] comments clean up in test classes. Also remove a few unused variables --- .../CRM/Mailing/BaseMailingSystemTest.php | 29 +++++++++---------- tests/phpunit/api/v3/GroupContactTest.php | 4 --- tests/phpunit/api/v3/MailingGroupTest.php | 12 +------- 3 files changed, 15 insertions(+), 30 deletions(-) diff --git a/tests/phpunit/CRM/Mailing/BaseMailingSystemTest.php b/tests/phpunit/CRM/Mailing/BaseMailingSystemTest.php index 37bf968c14..080d3fd4c4 100644 --- a/tests/phpunit/CRM/Mailing/BaseMailingSystemTest.php +++ b/tests/phpunit/CRM/Mailing/BaseMailingSystemTest.php @@ -32,8 +32,6 @@ * @subpackage API_Job * * @copyright CiviCRM LLC (c) 2004-2017 - * @version $Id: Job.php 30879 2010-11-22 15:45:55Z shot $ - * */ /** @@ -57,7 +55,7 @@ abstract class CRM_Mailing_BaseMailingSystemTest extends CiviUnitTestCase { public function setUp() { $this->useTransaction(); parent::setUp(); - CRM_Mailing_BAO_MailingJob::$mailsProcessed = 0; // DGW + CRM_Mailing_BAO_MailingJob::$mailsProcessed = 0; $this->_groupID = $this->groupCreate(); $this->createContactsInGroup(2, $this->_groupID); @@ -118,7 +116,7 @@ abstract class CRM_Mailing_BaseMailingSystemTest extends CiviUnitTestCase { 'open_tracking' => 1, // Note: open_tracking does nothing with text, but we'll just verify that it does nothing )); - foreach ($allMessages as $k => $message) { + foreach ($allMessages as $message) { /** @var ezcMail $message */ /** @var ezcMailText $textPart */ @@ -146,7 +144,7 @@ abstract class CRM_Mailing_BaseMailingSystemTest extends CiviUnitTestCase { 'open_tracking' => 1, 'url_tracking' => 0, )); - foreach ($allMessages as $k => $message) { + foreach ($allMessages as $message) { /** @var ezcMail $message */ /** @var ezcMailText $htmlPart */ /** @var ezcMailText $textPart */ @@ -196,7 +194,7 @@ abstract class CRM_Mailing_BaseMailingSystemTest extends CiviUnitTestCase { 'open_tracking' => 1, 'url_tracking' => 1, )); - foreach ($allMessages as $k => $message) { + foreach ($allMessages as $message) { /** @var ezcMail $message */ /** @var ezcMailText $htmlPart */ /** @var ezcMailText $textPart */ @@ -239,17 +237,19 @@ abstract class CRM_Mailing_BaseMailingSystemTest extends CiviUnitTestCase { } } + /** + * Each case comes in four parts: + * 1. Mailing HTML (body_html) + * 2. Regex to run against final HTML + * 3. Regex to run against final text + * 4. Additional mailing options + * + * @return array + */ public function urlTrackingExamples() { $cases = array(); - // Each case comes in four parts: - // 1. Mailing HTML (body_html) - // 2. Regex to run against final HTML - // 3. Regex to run against final text - // 4. Additional mailing options - // Tracking disabled - $cases[] = array( '

Foo

', ';

Foo

;', @@ -285,7 +285,6 @@ abstract class CRM_Mailing_BaseMailingSystemTest extends CiviUnitTestCase { ); // Tracking enabled - $cases[] = array( '

Foo

', ';

Foo

;', @@ -338,7 +337,7 @@ abstract class CRM_Mailing_BaseMailingSystemTest extends CiviUnitTestCase { 'subject' => 'Example Subject', 'body_html' => $inputHtml, )); - foreach ($allMessages as $k => $message) { + foreach ($allMessages as $message) { /** @var ezcMail $message */ /** @var ezcMailText $htmlPart */ /** @var ezcMailText $textPart */ diff --git a/tests/phpunit/api/v3/GroupContactTest.php b/tests/phpunit/api/v3/GroupContactTest.php index 39509f095a..33ab456dea 100644 --- a/tests/phpunit/api/v3/GroupContactTest.php +++ b/tests/phpunit/api/v3/GroupContactTest.php @@ -86,8 +86,6 @@ class api_v3_GroupContactTest extends CiviUnitTestCase { ); } - ///////////////// civicrm_group_contact_get methods - /** * Test GroupContact.get by ID. */ @@ -168,8 +166,6 @@ class api_v3_GroupContactTest extends CiviUnitTestCase { $this->assertEquals($result['total_count'], 2); } - ///////////////// civicrm_group_contact_remove methods - /** * Test GroupContact.delete by contact+group ID. */ diff --git a/tests/phpunit/api/v3/MailingGroupTest.php b/tests/phpunit/api/v3/MailingGroupTest.php index 75630204be..814997fefb 100644 --- a/tests/phpunit/api/v3/MailingGroupTest.php +++ b/tests/phpunit/api/v3/MailingGroupTest.php @@ -44,8 +44,6 @@ class api_v3_MailingGroupTest extends CiviUnitTestCase { $this->_email = 'test@test.test'; } - //---------- civicrm_mailing_event_subscribe methods --------- - /** * Test civicrm_mailing_group_event_subscribe with wrong params. */ @@ -85,8 +83,6 @@ class api_v3_MailingGroupTest extends CiviUnitTestCase { $this->contactDelete($contactID); } - //-------- civicrm_mailing_group_event_unsubscribe methods----------- - /** * Test civicrm_mailing_group_event_unsubscribe with wrong params. */ @@ -101,8 +97,6 @@ class api_v3_MailingGroupTest extends CiviUnitTestCase { $this->callAPIFailure('mailing_event_unsubscribe', 'create', $params); } - //--------- civicrm_mailing_group_event_domain_unsubscribe methods ------- - /** * Test civicrm_mailing_group_event_domain_unsubscribe with wrong params. */ @@ -118,8 +112,6 @@ class api_v3_MailingGroupTest extends CiviUnitTestCase { $this->callAPIFailure('mailing_event_unsubscribe', 'create', $params); } - //----------- civicrm_mailing_group_event_resubscribe methods-------- - /** * Test civicrm_mailing_group_event_resubscribe with wrong params type. */ @@ -138,8 +130,6 @@ class api_v3_MailingGroupTest extends CiviUnitTestCase { $this->callAPIFailure('mailing_event_resubscribe', 'create', $params); } - //------------------------ success case --------------------- - /** * Test civicrm_mailing_group_event_subscribe and civicrm_mailing_event_confirm functions - success expected. */ @@ -171,7 +161,7 @@ class api_v3_MailingGroupTest extends CiviUnitTestCase { 'event_subscribe_id' => $result['values'][$result['id']]['subscribe_id'], ); - $result = $this->callAPISuccess('mailing_event_confirm', 'create', $params); + $this->callAPISuccess('mailing_event_confirm', 'create', $params); $this->contactDelete($contactID); } -- 2.25.1