Merge pull request #17294 from agh1/sr-rel-perms

[civicrm-core.git] / tests / phpunit / api / v3 / ActivityCaseTest.php

<?php

/**
 *  Test Activity.get API with the case_id field
 *
 * @package CiviCRM_APIv3
 * @group headless
 */
class api_v3_ActivityCaseTest extends CiviCaseTestCase {
  protected $_params;
  protected $_entity;
  protected $_cid;

  /**
   * @var array
   *  APIv3 Result (Case.create)
   */
  protected $_case;

  /**
   * @var array
   *  APIv3 Result (Activity.create)
   */
  protected $_otherActivity;

  /**
   * Test setup for every test.
   *
   * Connect to the database, truncate the tables that will be used
   * and redirect stdin to a temporary file.
   */
  public function setUp() {
    $this->_entity = 'case';

    parent::setUp();

    $this->_cid = $this->individualCreate();

    $this->_case = $this->callAPISuccess('case', 'create', [
      'case_type_id' => $this->caseTypeId,
      'subject' => __CLASS__,
      'contact_id' => $this->_cid,
    ]);

    $this->_otherActivity = $this->callAPISuccess('Activity', 'create', [
      'source_contact_id' => $this->_cid,
      'activity_type_id' => 'Phone Call',
      'subject' => 'Ask not what your API can do for you, but what you can do for your API.',
    ]);
  }

  /**
   * Test activity creation on case based
   * on id or hash present in case subject.
   */
  public function testActivityCreateOnCase() {
    $hash = substr(sha1(CIVICRM_SITE_KEY . $this->_case['id']), 0, 7);
    $subjectArr = [
      "[case #{$this->_case['id']}] test activity recording under case with id",
      "[case #{$hash}] test activity recording under case with id",
    ];
    foreach ($subjectArr as $subject) {
      $activity = $this->callAPISuccess('Activity', 'create', [
        'source_contact_id' => $this->_cid,
        'activity_type_id' => 'Phone Call',
        'subject' => $subject,
      ]);
      $case = $this->callAPISuccessGetSingle('Activity', ['return' => ["case_id"], 'id' => $activity['id']]);
      //Check if case id is present for the activity.
      $this->assertEquals($this->_case['id'], $case['case_id'][0]);
    }
  }

  public function testGet() {
    $this->assertTrue(is_numeric($this->_case['id']));
    $this->assertTrue(is_numeric($this->_otherActivity['id']));

    $getByCaseId = $this->callAPIAndDocument('Activity', 'get', [
      'case_id' => $this->_case['id'],
    ], __FUNCTION__, __FILE__);
    $this->assertNotEmpty($getByCaseId['values']);
    $getByCaseId_ids = array_keys($getByCaseId['values']);

    $getByCaseNotNull = $this->callAPIAndDocument('Activity', 'get', [
      'case_id' => ['IS NOT NULL' => 1],
    ], __FUNCTION__, __FILE__);
    $this->assertNotEmpty($getByCaseNotNull['values']);
    $getByCaseNotNull_ids = array_keys($getByCaseNotNull['values']);

    $getByCaseNull = $this->callAPIAndDocument('Activity', 'get', [
      'case_id' => ['IS NULL' => 1],
    ], __FUNCTION__, __FILE__);
    $this->assertNotEmpty($getByCaseNull['values']);
    $getByCaseNull_ids = array_keys($getByCaseNull['values']);

    $this->assertTrue(in_array($this->_otherActivity['id'], $getByCaseNull_ids));
    $this->assertNotTrue(in_array($this->_otherActivity['id'], $getByCaseId_ids));
    $this->assertEquals($getByCaseId_ids, $getByCaseNotNull_ids);
    $this->assertEquals([], array_intersect($getByCaseId_ids, $getByCaseNull_ids));
  }

  public function testActivityGetWithCaseInfo() {
    $activities = $this->callAPISuccess('Activity', 'get', [
      'sequential' => 1,
      'case_id' => $this->_case['id'],
      'return' => ['case_id', 'case_id.subject'],
    ]);
    $this->assertEquals(__CLASS__, $activities['values'][0]['case_id.subject']);
    // Note - case_id is always an array
    $this->assertEquals($this->_case['id'], $activities['values'][0]['case_id'][0]);
  }

}