tests/phpunit/Civi/CCase/SequenceListenerTest.php

   1 <?php
   2 namespace Civi\CCase;
   3
   4 /**
   5  * Class SequenceListenerTest
   6  *
   7  * @package Civi\CCase
   8  * @group headless
   9  */
  10 class SequenceListenerTest extends \CiviCaseTestCase {
  11
  12   public function setUp() {
  13     parent::setUp();
  14     $this->_params = [
  15       'case_type' => $this->caseType,
  16       'subject' => 'Test case',
  17       'contact_id' => 17,
  18     ];
  19     //Add an activity status with Type = Completed
  20     $this->callAPISuccess('OptionValue', 'create', [
  21       'option_group_id' => "activity_status",
  22       'filter' => \CRM_Activity_BAO_Activity::COMPLETED,
  23       'label' => "Skip Activity",
  24     ]);
  25   }
  26
  27   public function testSequence() {
  28     $actStatuses = array_flip(\CRM_Core_PseudoConstant::activityStatus('name'));
  29     $caseStatuses = array_flip(\CRM_Case_PseudoConstant::caseStatus('name'));
  30     $actTypes = array_flip(\CRM_Activity_BAO_Activity::buildOptions('activity_type_id', 'create'));
  31
  32     // Create case; schedule first activity
  33     \CRM_Utils_Time::setTime('2013-11-30 01:00:00');
  34     $case = $this->callAPISuccess('case', 'create', $this->_params);
  35     $analyzer = new \Civi\CCase\Analyzer($case['id']);
  36     $this->assertEquals($caseStatuses['Open'], self::ag($analyzer->getCase(), 'status_id'));
  37     $this->assertApproxTime('2013-11-30 01:00:00', self::ag($analyzer->getSingleActivity('Medical evaluation'), 'activity_date_time'));
  38     $this->assertEquals($actStatuses['Scheduled'], self::ag($analyzer->getSingleActivity('Medical evaluation'), 'status_id'));
  39     $this->assertFalse($analyzer->hasActivity('Mental health evaluation'));
  40     $this->assertFalse($analyzer->hasActivity('Secure temporary housing'));
  41
  42     // Edit details of first activity -- but don't finish it yet!
  43     \CRM_Utils_Time::setTime('2013-11-30 01:30:00');
  44     $this->callApiSuccess('Activity', 'create', [
  45       'id' => self::ag($analyzer->getSingleActivity('Medical evaluation'), 'id'),
  46       'subject' => 'This is the new subject',
  47     ]);
  48     $analyzer = new \Civi\CCase\Analyzer($case['id']);
  49     $this->assertEquals($caseStatuses['Open'], self::ag($analyzer->getCase(), 'status_id'));
  50     $this->assertApproxTime('2013-11-30 01:00:00', self::ag($analyzer->getSingleActivity('Medical evaluation'), 'activity_date_time'));
  51     $this->assertEquals($actStatuses['Scheduled'], self::ag($analyzer->getSingleActivity('Medical evaluation'), 'status_id'));
  52     $this->assertFalse($analyzer->hasActivity('Mental health evaluation'));
  53     $this->assertFalse($analyzer->hasActivity('Secure temporary housing'));
  54
  55     // Complete first activity; schedule second
  56     \CRM_Utils_Time::setTime('2013-11-30 02:00:00');
  57     $this->callApiSuccess('Activity', 'create', [
  58       'id' => self::ag($analyzer->getSingleActivity('Medical evaluation'), 'id'),
  59       'status_id' => $actStatuses['Completed'],
  60     ]);
  61     $analyzer->flush();
  62     $this->assertEquals($caseStatuses['Open'], self::ag($analyzer->getCase(), 'status_id'));
  63     $this->assertApproxTime('2013-11-30 01:00:00', self::ag($analyzer->getSingleActivity('Medical evaluation'), 'activity_date_time'));
  64     $this->assertEquals($actStatuses['Completed'], self::ag($analyzer->getSingleActivity('Medical evaluation'), 'status_id'));
  65     $this->assertApproxTime('2013-11-30 02:00:00', self::ag($analyzer->getSingleActivity('Mental health evaluation'), 'activity_date_time'));
  66     $this->assertEquals($actStatuses['Scheduled'], self::ag($analyzer->getSingleActivity('Mental health evaluation'), 'status_id'));
  67     $this->assertFalse($analyzer->hasActivity('Secure temporary housing'));
  68
  69     //Complete second activity using "Skip Activity"(Completed); schedule third
  70     \CRM_Utils_Time::setTime('2013-11-30 03:00:00');
  71     $this->callApiSuccess('Activity', 'create', [
  72       'id' => self::ag($analyzer->getSingleActivity('Mental health evaluation'), 'id'),
  73       'status_id' => $actStatuses['Skip_Activity'],
  74     ]);
  75     $analyzer->flush();
  76     $this->assertEquals($caseStatuses['Open'], self::ag($analyzer->getCase(), 'status_id'));
  77     $this->assertApproxTime('2013-11-30 01:00:00', self::ag($analyzer->getSingleActivity('Medical evaluation'), 'activity_date_time'));
  78     $this->assertEquals($actStatuses['Completed'], self::ag($analyzer->getSingleActivity('Medical evaluation'), 'status_id'));
  79     $this->assertApproxTime('2013-11-30 02:00:00', self::ag($analyzer->getSingleActivity('Mental health evaluation'), 'activity_date_time'));
  80     $this->assertEquals($actStatuses['Skip_Activity'], self::ag($analyzer->getSingleActivity('Mental health evaluation'), 'status_id'));
  81     $this->assertApproxTime('2013-11-30 03:00:00', self::ag($analyzer->getSingleActivity('Secure temporary housing'), 'activity_date_time'));
  82     $this->assertEquals($actStatuses['Scheduled'], self::ag($analyzer->getSingleActivity('Secure temporary housing'), 'status_id'));
  83
  84     //Add an Activity before the case is closed
  85     \CRM_Utils_Time::setTime('2013-11-30 04:00:00');
  86     $this->callApiSuccess('Activity', 'create', [
  87       'activity_name' => 'Follow up',
  88       'activity_type_id' => $actTypes['Follow up'],
  89       'status_id' => $actStatuses['Scheduled'],
  90       'case_id' => $case['id'],
  91       'activity_date_time' => \CRM_Utils_Time::getTime(),
  92     ]);
  93     $analyzer->flush();
  94     $this->assertApproxTime('2013-11-30 01:00:00', self::ag($analyzer->getSingleActivity('Medical evaluation'), 'activity_date_time'));
  95     $this->assertEquals($actStatuses['Completed'], self::ag($analyzer->getSingleActivity('Medical evaluation'), 'status_id'));
  96     $this->assertApproxTime('2013-11-30 02:00:00', self::ag($analyzer->getSingleActivity('Mental health evaluation'), 'activity_date_time'));
  97     $this->assertEquals($actStatuses['Skip_Activity'], self::ag($analyzer->getSingleActivity('Mental health evaluation'), 'status_id'));
  98     $this->assertApproxTime('2013-11-30 03:00:00', self::ag($analyzer->getSingleActivity('Secure temporary housing'), 'activity_date_time'));
  99     $this->assertEquals($actStatuses['Scheduled'], self::ag($analyzer->getSingleActivity('Secure temporary housing'), 'status_id'));
 100     $this->assertApproxTime('2013-11-30 04:00:00', self::ag($analyzer->getSingleActivity('Follow up'), 'activity_date_time'));
 101     $this->assertEquals($actStatuses['Scheduled'], self::ag($analyzer->getSingleActivity('Follow up'), 'status_id'));
 102
 103     // Complete third activity; Case should remain open because of the Follow up activity
 104     \CRM_Utils_Time::setTime('2013-11-30 04:00:00');
 105     $this->callApiSuccess('Activity', 'create', [
 106       'id' => self::ag($analyzer->getSingleActivity('Secure temporary housing'), 'id'),
 107       'status_id' => $actStatuses['Completed'],
 108     ]);
 109     $analyzer->flush();
 110     $this->assertApproxTime('2013-11-30 01:00:00', self::ag($analyzer->getSingleActivity('Medical evaluation'), 'activity_date_time'));
 111     $this->assertEquals($actStatuses['Completed'], self::ag($analyzer->getSingleActivity('Medical evaluation'), 'status_id'));
 112     $this->assertApproxTime('2013-11-30 02:00:00', self::ag($analyzer->getSingleActivity('Mental health evaluation'), 'activity_date_time'));
 113     $this->assertEquals($actStatuses['Skip_Activity'], self::ag($analyzer->getSingleActivity('Mental health evaluation'), 'status_id'));
 114     $this->assertApproxTime('2013-11-30 03:00:00', self::ag($analyzer->getSingleActivity('Secure temporary housing'), 'activity_date_time'));
 115     $this->assertEquals($actStatuses['Completed'], self::ag($analyzer->getSingleActivity('Secure temporary housing'), 'status_id'));
 116     $this->assertApproxTime('2013-11-30 04:00:00', self::ag($analyzer->getSingleActivity('Follow up'), 'activity_date_time'));
 117     $this->assertEquals($actStatuses['Scheduled'], self::ag($analyzer->getSingleActivity('Follow up'), 'status_id'));
 118     $this->assertEquals($caseStatuses['Open'], self::ag($analyzer->getCase(), 'status_id'));
 119
 120     // Complete the additional Activity; Case closed
 121     \CRM_Utils_Time::setTime('2013-11-30 04:00:00');
 122     $this->callApiSuccess('Activity', 'create', [
 123       'id' => self::ag($analyzer->getSingleActivity('Follow up'), 'id'),
 124       'status_id' => $actStatuses['Completed'],
 125     ]);
 126     $analyzer->flush();
 127     $this->assertApproxTime('2013-11-30 01:00:00', self::ag($analyzer->getSingleActivity('Medical evaluation'), 'activity_date_time'));
 128     $this->assertEquals($actStatuses['Completed'], self::ag($analyzer->getSingleActivity('Medical evaluation'), 'status_id'));
 129     $this->assertApproxTime('2013-11-30 02:00:00', self::ag($analyzer->getSingleActivity('Mental health evaluation'), 'activity_date_time'));
 130     $this->assertEquals($actStatuses['Skip_Activity'], self::ag($analyzer->getSingleActivity('Mental health evaluation'), 'status_id'));
 131     $this->assertApproxTime('2013-11-30 03:00:00', self::ag($analyzer->getSingleActivity('Secure temporary housing'), 'activity_date_time'));
 132     $this->assertEquals($actStatuses['Completed'], self::ag($analyzer->getSingleActivity('Secure temporary housing'), 'status_id'));
 133     $this->assertApproxTime('2013-11-30 04:00:00', self::ag($analyzer->getSingleActivity('Follow up'), 'activity_date_time'));
 134     $this->assertEquals($actStatuses['Completed'], self::ag($analyzer->getSingleActivity('Follow up'), 'status_id'));
 135     $this->assertEquals($caseStatuses['Closed'], self::ag($analyzer->getCase(), 'status_id'));
 136   }
 137
 138   /**
 139    * @param $caseTypes
 140    * @see \CRM_Utils_Hook::caseTypes
 141    */
 142   public function hook_caseTypes(&$caseTypes) {
 143     $caseTypes[$this->caseType] = [
 144       'module' => 'org.civicrm.hrcase',
 145       'name' => $this->caseType,
 146       'file' => __DIR__ . '/HousingSupportWithSequence.xml',
 147     ];
 148   }
 149
 150   /**
 151    * @param $expected
 152    * @param $actual
 153    * @param int $tolerance
 154    */
 155   public function assertApproxTime($expected, $actual, $tolerance = 1) {
 156     $diff = abs(strtotime($expected) - strtotime($actual));
 157     $this->assertTrue($diff <= $tolerance, sprintf("Check approx time equality. expected=[%s] actual=[%s] tolerance=[%s]",
 158       $expected, $actual, $tolerance
 159     ));
 160   }
 161
 162   /**
 163    * Get a value from an array. This is syntactic-sugar to work-around PHP 5.3's limited syntax.
 164    *
 165    * @param $array
 166    * @param $key
 167    * @return mixed
 168    */
 169   public static function ag($array, $key) {
 170     return $array[$key];
 171   }
 172
 173 }