CRM-16514 - CRM_Activity_ActionMappingTest - Add some tests

Notably, this includes a test with `recipientIsBob`.

There other tests mostly a sanity check to ensure that I was writing the
test well.

diff --git a/tests/phpunit/CRM/Activity/ActionMappingTest.php b/tests/phpunit/CRM/Activity/ActionMappingTest.php
new file mode 100644 (file)
index 0000000..0cd894a
--- /dev/null
+++ b/tests/phpunit/CRM/Activity/ActionMappingTest.php
@@ -0,0 +1,237 @@
+<?php
+/*
+ +--------------------------------------------------------------------+
+ | CiviCRM version 4.7                                                |
+ +--------------------------------------------------------------------+
+ | Copyright CiviCRM LLC (c) 2004-2015                                |
+ +--------------------------------------------------------------------+
+ | This file is a part of CiviCRM.                                    |
+ |                                                                    |
+ | CiviCRM is free software; you can copy, modify, and distribute it  |
+ | under the terms of the GNU Affero General Public License           |
+ | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
+ |                                                                    |
+ | CiviCRM is distributed in the hope that it will be useful, but     |
+ | WITHOUT ANY WARRANTY; without even the implied warranty of         |
+ | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
+ | See the GNU Affero General Public License for more details.        |
+ |                                                                    |
+ | You should have received a copy of the GNU Affero General Public   |
+ | License and the CiviCRM Licensing Exception along                  |
+ | with this program; if not, contact CiviCRM LLC                     |
+ | at info[AT]civicrm[DOT]org. If you have questions about the        |
+ | GNU Affero General Public License or the licensing of CiviCRM,     |
+ | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
+ +--------------------------------------------------------------------+
+ */
+
+require_once 'CiviTest/CiviUnitTestCase.php';
+
+/**
+ * Class CRM_Activity_ActionMappingTest
+ * @group ActionSchedule
+ *
+ * This class tests various configurations of scheduled-reminders, with a focus on
+ * reminders for *activity types*. It follows a design/pattern described in
+ * AbstractMappingTest.
+ *
+ * NOTE: There are also pretty deep tests of activity-based reminders in
+ * CRM_Core_BAO_ActionScheduleTest.
+ *
+ * @see \Civi\ActionSchedule\AbstractMappingTest
+ * @see CRM_Core_BAO_ActionScheduleTest
+ */
+class CRM_Activity_ActionMappingTest extends \Civi\ActionSchedule\AbstractMappingTest {
+
+  /**
+   * Generate a list of test cases, where each is a distinct combination of
+   * data, schedule-rules, and schedule results.
+   *
+   * @return array
+   *   - targetDate: string; eg "2015-02-01 00:00:01"
+   *   - setupFuncs: string, space-separated list of setup functions
+   *   - messages: array; each item is a message that's expected to be sent
+   *     each message may include keys:
+   *        - time: approximate time (give or take a few seconds)
+   *        - recipients: array of emails
+   *        - subject: regex
+   */
+  public function createTestCases() {
+    $cs = array();
+
+    $cs[] = array(
+      '2015-02-01 00:00:00',
+      'addAliceMeeting scheduleForAny startOnTime useHelloFirstName recipientIsActivitySource',
+      array(
+        array(
+          'time' => '2015-02-01 00:00:00',
+          'to' => array('alice@example.org'),
+          'subject' => '/Hello, Alice.*via subject/',
+        ),
+      ),
+    );
+
+    $cs[] = array(
+      '2015-02-01 00:00:00',
+      'addAliceMeeting scheduleForAny startOnTime useHelloFirstName recipientIsBob',
+      array(
+        array(
+          'time' => '2015-02-01 00:00:00',
+          'to' => array('bob@example.org'),
+          'subject' => '/Hello, Bob.*via subject/',
+          // It might make more sense to get Alice's details... but path of least resistance...
+        ),
+      ),
+    );
+
+    $cs[] = array(
+      '2015-02-01 00:00:00',
+      'addAliceMeeting addBobPhoneCall scheduleForMeeting startOnTime useHelloFirstName recipientIsActivitySource',
+      array(
+        array(
+          'time' => '2015-02-01 00:00:00',
+          'to' => array('alice@example.org'),
+          'subject' => '/Hello, Alice.*via subject/',
+        ),
+      ),
+    );
+
+    $cs[] = array(
+      '2015-02-01 00:00:00',
+      'addAliceMeeting addBobPhoneCall scheduleForAny startOnTime useHelloFirstName recipientIsActivitySource',
+      array(
+        array(
+          'time' => '2015-02-01 00:00:00',
+          'to' => array('alice@example.org'),
+          'subject' => '/Hello, Alice.*via subject/',
+        ),
+        array(
+          'time' => '2015-02-01 00:00:00',
+          'to' => array('bob@example.org'),
+          'subject' => '/Hello, Bob.*via subject/',
+        ),
+      ),
+    );
+
+    $cs[] = array(
+      '2015-02-02 00:00:00',
+      'addAliceMeeting addBobPhoneCall scheduleForPhoneCall startWeekBefore repeatTwoWeeksAfter useHelloFirstName recipientIsActivitySource',
+      array(
+        array(
+          'time' => '2015-01-26 00:00:00',
+          'to' => array('bob@example.org'),
+          'subject' => '/Hello, Bob.*via subject/',
+        ),
+        array(
+          'time' => '2015-02-02 00:00:00',
+          'to' => array('bob@example.org'),
+          'subject' => '/Hello, Bob.*via subject/',
+        ),
+        array(
+          'time' => '2015-02-09 00:00:00',
+          'to' => array('bob@example.org'),
+          'subject' => '/Hello, Bob.*via subject/',
+        ),
+        array(
+          'time' => '2015-02-16 00:00:00',
+          'to' => array('bob@example.org'),
+          'subject' => '/Hello, Bob.*via subject/',
+        ),
+      ),
+    );
+
+    return $cs;
+  }
+
+  /**
+   * Create an activity record for Alice with type "Meeting".
+   */
+  public function addAliceMeeting() {
+    $this->callAPISuccess('Activity', 'create', array(
+      'source_contact_id' => $this->contacts['alice']['id'],
+      'activity_type_id' => 'Meeting',
+      'subject' => 'Subject for Alice',
+      'activity_date_time' => date('Y-m-d H:i:s', strtotime($this->targetDate)),
+      'status_id' => 2,
+      'assignee_contact_id' => array($this->contacts['carol']['id']),
+    ));
+  }
+
+  /**
+   * Create a contribution record for Bob with type "Donation".
+   */
+  public function addBobPhoneCall() {
+    $this->callAPISuccess('Activity', 'create', array(
+      'source_contact_id' => $this->contacts['bob']['id'],
+      'activity_type_id' => 'Phone Call',
+      'subject' => 'Subject for Bob',
+      'activity_date_time' => date('Y-m-d H:i:s', strtotime($this->targetDate)),
+      'status_id' => 2,
+      'assignee_contact_id' => array($this->contacts['carol']['id']),
+    ));
+  }
+
+  /**
+   * Schedule message delivery for activities of type "Meeting".
+   */
+  public function scheduleForMeeting() {
+    $actTypes = CRM_Activity_BAO_Activity::buildOptions('activity_type_id');
+    $this->schedule->mapping_id = CRM_Activity_ActionMapping::ACTIVITY_MAPPING_ID;
+    $this->schedule->start_action_date = 'receive_date';
+    $this->schedule->entity_value = CRM_Utils_Array::implodePadded(array(array_search('Meeting', $actTypes)));
+    $this->schedule->entity_status = CRM_Utils_Array::implodePadded(array(2));
+  }
+
+  /**
+   * Schedule message delivery for activities of type "Phone Call".
+   */
+  public function scheduleForPhoneCall() {
+    $actTypes = CRM_Activity_BAO_Activity::buildOptions('activity_type_id');
+    $this->schedule->mapping_id = CRM_Activity_ActionMapping::ACTIVITY_MAPPING_ID;
+    $this->schedule->start_action_date = 'receive_date';
+    $this->schedule->entity_value = CRM_Utils_Array::implodePadded(array(array_search('Phone Call', $actTypes)));
+    $this->schedule->entity_status = CRM_Utils_Array::implodePadded(NULL);
+  }
+
+  /**
+   * Schedule message delivery for any contribution, regardless of type.
+   */
+  public function scheduleForAny() {
+    $actTypes = CRM_Activity_BAO_Activity::buildOptions('activity_type_id');
+    $this->schedule->mapping_id = CRM_Activity_ActionMapping::ACTIVITY_MAPPING_ID;
+    $this->schedule->start_action_date = 'receive_date';
+    $this->schedule->entity_value = CRM_Utils_Array::implodePadded(array_keys($actTypes));
+    $this->schedule->entity_status = CRM_Utils_Array::implodePadded(NULL);
+  }
+
+  /**
+   * Set the recipient to "Choose Recipient(s): Bob".
+   */
+  public function recipientIsBob() {
+    $this->schedule->limit_to = 1;
+    $this->schedule->recipient = NULL;
+    $this->schedule->recipient_listing = NULL;
+    $this->schedule->recipient_manual = $this->contacts['bob']['id'];
+  }
+
+  /**
+   * Set the recipient to "Activity Assignee".
+   */
+  public function recipientIsActivityAssignee() {
+    $this->schedule->limit_to = 1;
+    $this->schedule->recipient = 1;
+    $this->schedule->recipient_listing = NULL;
+    $this->schedule->recipient_manual = NULL;
+  }
+
+  /**
+   * Set the recipient to "Activity Source".
+   */
+  public function recipientIsActivitySource() {
+    $this->schedule->limit_to = 1;
+    $this->schedule->recipient = 2;
+    $this->schedule->recipient_listing = NULL;
+    $this->schedule->recipient_manual = NULL;
+  }
+
+}