DomainTest.php

<?php
/*
 +--------------------------------------------------------------------+
 | Copyright CiviCRM LLC. All rights reserved.                        |
 |                                                                    |
 | This work is published under the GNU AGPLv3 license with some      |
 | permitted exceptions and without any warranty. For full license    |
 | and copyright information, see https://civicrm.org/licensing       |
 +--------------------------------------------------------------------+
 */

/**
 * Test class for Domain API - civicrm_domain_*
 *
 * @package CiviCRM_APIv3
 * @subpackage API_Domain
 * @group headless
 */
class api_v3_DomainTest extends CiviUnitTestCase {

  protected $params;

  /**
   * Sets up the fixture, for example, opens a network connection.
   *
   * This method is called before a test is executed.
   */
  protected function setUp(): void {
    parent::setUp();
    $this->useTransaction(TRUE);

    // taken from form code - couldn't find good method to use
    $params['entity_id'] = 1;
    $params['entity_table'] = CRM_Core_BAO_Domain::getTableName();
    $defaultLocationType = CRM_Core_BAO_LocationType::getDefault();
    $domContact = $this->callAPISuccess('contact', 'create', [
      'contact_type' => 'Organization',
      'organization_name' => 'new org',
      'api.phone.create' => [
        'location_type_id' => $defaultLocationType->id,
        'phone_type_id' => 1,
        'phone' => '456-456',
      ],
      'api.address.create' => [
        'location_type_id' => $defaultLocationType->id,
        'street_address' => '45 Penny Lane',
      ],
      'api.email.create' => [
        'location_type_id' => $defaultLocationType->id,
        'email' => 'my@email.com',
      ],
    ]);

    $this->callAPISuccess('domain', 'create', [
      'id' => 1,
      'contact_id' => $domContact['id'],
    ]);
    $this->params = [
      'name' => 'A-team domain',
      'description' => 'domain of chaos',
      'domain_version' => '4.2',
      'contact_id' => $domContact['id'],
    ];
  }

  /**
   * Test civicrm_domain_get.
   *
   * Takes no params.
   * Testing mainly for format.
   */
  public function testGet(): void {

    $params = ['sequential' => 1];
    $result = $this->callAPISuccess('domain', 'get', $params);

    $this->assertIsArray($result);

    $domain = $result['values'][0];
    $this->assertEquals("info@EXAMPLE.ORG", $domain['from_email']);
    $this->assertEquals("FIXME", $domain['from_name']);
    // checking other important parts of domain information
    // test will fail if backward incompatible changes happen
    $this->assertArrayHasKey('id', $domain);
    $this->assertArrayHasKey('name', $domain);
    $this->assertArrayHasKey('domain_email', $domain);
    $this->assertEquals([
      'phone_type' => 'Phone',
      'phone' => '456-456',
    ], $domain['domain_phone']);
    $this->assertArrayHasKey('domain_address', $domain);
  }

  /**
   * Test get function with current domain.
   *
   * @throws \CRM_Core_Exception
   */
  public function testGetCurrentDomain(): void {
    $params = ['current_domain' => 1];
    $result = $this->callAPISuccess('domain', 'get', $params);

    $this->assertIsArray($result);

    foreach ($result['values'] as $key => $domain) {
      if ($key == 'version') {
        continue;
      }

      $this->assertEquals("info@EXAMPLE.ORG", $domain['from_email']);
      $this->assertEquals("FIXME", $domain['from_name']);

      // checking other important parts of domain information
      // test will fail if backward incompatible changes happen
      $this->assertArrayHasKey('id', $domain);
      $this->assertArrayHasKey('name', $domain);
      $this->assertArrayHasKey('domain_email', $domain);
      $this->assertArrayHasKey('domain_phone', $domain);
      $this->assertArrayHasKey('domain_address', $domain);
      $this->assertEquals("my@email.com", $domain['domain_email']);
      $this->assertEquals("456-456", $domain['domain_phone']['phone']);
      $this->assertEquals("45 Penny Lane", $domain['domain_address']['street_address']);
    }
  }

  /**
   * This test checks for a memory leak.
   *
   * The leak was observed when doing 2 gets on current domain.
   * @param int $version
   * @dataProvider versionThreeAndFour
   */
  public function testGetCurrentDomainTwice($version) {
    $this->_apiversion = $version;
    $domain = $this->callAPISuccess('domain', 'getvalue', [
      'current_domain' => 1,
      'return' => 'name',
    ]);
    $this->assertEquals('Default Domain Name', $domain, print_r($domain, TRUE));
    $domain = $this->callAPISuccess('domain', 'getvalue', [
      'current_domain' => 1,
      'return' => 'name',
    ]);
    $this->assertEquals('Default Domain Name', $domain, print_r($domain, TRUE));
  }

  /**
   * Test civicrm_domain_create.
   */
  public function testCreate(): void {
    $result = $this->callAPISuccess('domain', 'create', $this->params);
    $this->assertEquals($result['count'], 1);
    $this->assertNotNull($result['id']);
    $this->assertEquals($result['values'][$result['id']]['name'], $this->params['name']);
    $this->assertEquals($result['values'][$result['id']]['domain_version'], $this->params['domain_version']);
  }

  /**
   * Test if Domain.create does not touch the version of the domain.
   *
   * See CRM-17430.
   * @param int $version
   * @dataProvider versionThreeAndFour
   */
  public function testUpdateDomainName($version) {
    $this->_apiversion = $version;
    // First create a domain.
    $domain_result = $this->callAPISuccess('domain', 'create', $this->params);
    $domain_before = $this->callAPISuccess('Domain', 'getsingle', ['id' => $domain_result['id']]);

    // Change domain name.
    $this->callAPISuccess('Domain', 'create', [
      'id' => $domain_result['id'],
      'name' => 'B-Team domain',
    ]);

    // Get domain again.
    $domain_after = $this->callAPISuccess('Domain', 'getsingle', ['id' => $domain_result['id']]);

    // Version should still be the same.
    $this->assertEquals($domain_before['version'], $domain_after['version']);
  }

  /**
   * Test whether Domain.create returns a correct value for domain_version.
   *
   * See CRM-17430.
   */
  public function testCreateDomainResult(): void {
    // First create a domain.
    $domain_result = $this->callAPISuccess('Domain', 'create', $this->params);
    $result_value = CRM_Utils_Array::first($domain_result['values']);

    // Check for domain_version in create result.
    $this->assertEquals($this->params['domain_version'], $result_value['domain_version']);
  }

  /**
   * Test civicrm_domain_create with empty params.
   *
   * Error expected.
   * @param int $version
   * @dataProvider versionThreeAndFour
   */
  public function testCreateWithEmptyParams($version) {
    $this->_apiversion = $version;
    $this->callAPIFailure('domain', 'create', []);
  }

}