Skip to content

Commit

Permalink
Update UFJoin test to not use brittle xml set up
Browse files Browse the repository at this point in the history 
This also removes a bunch of tests that are redundant due to
the various other levels of api & entity testing & does other
minor cleanup like fixing expected & actual variables to be in the right order

A cause of test fails for
civicrm#26546
  • Loading branch information
@eileenmcnaughton
eileenmcnaughton committed Jun 24, 2023
1 parent 3e16ef5 commit 53b0ee3
Showing 1 changed file with 35 additions and 170 deletions.
205 changes: 35 additions & 170 deletions tests/phpunit/api/v3/UFJoinTest.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,221 +17,86 @@
* @group headless
*/
class api_v3_UFJoinTest extends CiviUnitTestCase {
/**
* ids from the uf_group_test.xml fixture
* @var int
*/
protected $_ufGroupId = 11;
protected $_ufFieldId;
protected $_contactId = 69;

protected function setUp(): void {
parent::setUp();
// Truncate the tables
$this->quickCleanup(
[
'civicrm_group',
'civicrm_contact',
'civicrm_uf_group',
'civicrm_uf_join',
'civicrm_uf_match',
]
);
$this->loadXMLDataSet(dirname(__FILE__) . '/dataset/uf_group_test.xml');
}

public function tearDown(): void {
// Truncate the tables
$this->quickCleanup(
[
'civicrm_group',
'civicrm_contact',
'civicrm_uf_group',
'civicrm_uf_join',
'civicrm_uf_match',
]
);
}

/**
* Find uf join group id.
* @param int $version
* @dataProvider versionThreeAndFour
*/
public function testFindUFGroupId($version) {
$this->_apiversion = $version;
$params = [
'module' => 'CiviContribute',
'entity_table' => 'civicrm_contribution_page',
'entity_id' => 1,
'weight' => 1,
'uf_group_id' => $this->_ufGroupId,
'is_active' => 1,
];
$ufJoin = $this->callAPISuccess('uf_join', 'create', $params);

$searchParams = [
'entity_table' => 'civicrm_contribution_page',
'entity_id' => 1,
];
$result = $this->callAPISuccess('uf_join', 'get', $searchParams);

foreach ($result['values'] as $key => $value) {
$this->assertEquals($value['uf_group_id'], $this->_ufGroupId);
}
}

/**
* @param int $version
* @dataProvider versionThreeAndFour
*/
public function testUFJoinEditWithoutUFGroupId($version) {
$this->_apiversion = $version;
$params = [
'module' => 'CiviContribute',
'entity_table' => 'civicrm_contribution_page',
'entity_id' => 1,
'weight' => 1,
'is_active' => 1,
];
$result = $this->callAPIFailure('uf_join', 'create', $params);
$this->assertStringContainsString('Mandatory', $result['error_message']);
$this->assertStringContainsString('missing', $result['error_message']);
$this->assertStringContainsString('uf_group_id', $result['error_message']);
$this->quickCleanup([
'civicrm_group',
'civicrm_uf_group',
'civicrm_uf_join',
'civicrm_uf_match',
]);
parent::tearDown();
}

/**
* Create/update uf join
*
* @param int $version
*
* @dataProvider versionThreeAndFour
*/
public function testCreateUFJoin($version) {
public function testCreateUFJoin(int $version): void {
$this->_apiversion = $version;
$ufGroupID = $this->createTestEntity('UFGroup', [
'group_type' => 'Contact',
'title' => 'Test Profile',
])['id'];
$params = [
'module' => 'CiviContribute',
'entity_table' => 'civicrm_contribution_page',
'entity_id' => 1,
'weight' => 1,
'uf_group_id' => $this->_ufGroupId,
'uf_group_id' => $ufGroupID,
'is_active' => 1,
'sequential' => 1,
];
$ufJoin = $this->callAPIAndDocument('uf_join', 'create', $params, __FUNCTION__, __FILE__);
$this->assertEquals($ufJoin['values'][0]['module'], $params['module']);
$this->assertEquals($ufJoin['values'][0]['uf_group_id'], $params['uf_group_id']);
$this->assertEquals($ufJoin['values'][0]['is_active'], $params['is_active']);
$ufJoin = $this->callAPISuccess('UFJoin', 'create', $params)['values'][0];
$this->assertEquals('CiviContribute', $ufJoin['module']);
$this->assertEquals($ufGroupID, $ufJoin['uf_group_id']);
$this->assertEquals(1, $ufJoin['is_active']);

$params = [
'id' => $ufJoin['id'],
'module' => 'CiviContribute',
'entity_table' => 'civicrm_contribution_page',
'entity_id' => 1,
'weight' => 1,
'uf_group_id' => $this->_ufGroupId,
'uf_group_id' => $ufGroupID,
'is_active' => 0,
'sequential' => 1,
];
$ufJoinUpdated = $this->callAPISuccess('uf_join', 'create', $params);
$this->assertEquals($ufJoinUpdated['values'][0]['module'], $params['module']);
$this->assertEquals($ufJoinUpdated['values'][0]['uf_group_id'], $params['uf_group_id']);
$this->assertEquals($ufJoinUpdated['values'][0]['is_active'], $params['is_active']);
$ufJoinUpdated = $this->callAPISuccess('uf_join', 'create', $params)['values'][0];
$this->assertEquals('CiviContribute', $ufJoinUpdated['module']);
$this->assertEquals($ufGroupID, $ufJoinUpdated['uf_group_id']);
$this->assertEquals(0, $ufJoinUpdated['is_active']);
}

/**
* Ensure we can create a survey join which is less common than event or contribution
* joins.
*
* @param int $version
*
* @dataProvider versionThreeAndFour
*/
public function testCreateSurveyUFJoin($version) {
public function testCreateSurveyUFJoin(int $version): void {
$this->_apiversion = $version;
$params = [
'module' => 'CiviCampaign',
'entity_table' => 'civicrm_survey',
'entity_id' => 1,
'weight' => 1,
'uf_group_id' => $this->_ufGroupId,
'uf_group_id' => $this->createTestEntity('UFGroup', [
'group_type' => 'Contact',
'title' => 'Test Profile',
])['id'],
'is_active' => 1,
'sequential' => 1,
];
$ufJoin = $this->callAPIAndDocument('uf_join', 'create', $params, __FUNCTION__, __FILE__);
$this->assertEquals($ufJoin['values'][0]['module'], $params['module']);
$this->assertEquals($ufJoin['values'][0]['uf_group_id'], $params['uf_group_id']);
$this->assertEquals($ufJoin['values'][0]['is_active'], $params['is_active']);
}

/**
* @param int $version
* @dataProvider versionThreeAndFour
*/
public function testFindUFJoinEmptyParams($version) {
$this->_apiversion = $version;
$result = $this->callAPIFailure('uf_join', 'create', []);
$this->assertStringContainsString('Mandatory', $result['error_message']);
$this->assertStringContainsString('missing', $result['error_message']);
$this->assertStringContainsString('module', $result['error_message']);
$this->assertStringContainsString('uf_group_id', $result['error_message']);
}

/**
* @param int $version
* @dataProvider versionThreeAndFour
*/
public function testCreateUFJoinWithoutUFGroupId($version) {
$this->_apiversion = $version;
$params = [
'module' => 'CiviContribute',
'entity_table' => 'civicrm_contribution_page',
'entity_id' => 1,
'weight' => 1,
'is_active' => 1,
];
$result = $this->callAPIFailure('uf_join', 'create', $params);
$this->assertStringContainsString('Mandatory', $result['error_message']);
$this->assertStringContainsString('missing', $result['error_message']);
$this->assertStringContainsString('uf_group_id', $result['error_message']);
}

/**
* Find uf join id.
* @param int $version
* @dataProvider versionThreeAndFour
*/
public function testGetUFJoinId($version) {
$this->_apiversion = $version;
$params = [
'module' => 'CiviContribute',
'entity_table' => 'civicrm_contribution_page',
'entity_id' => 1,
'weight' => 1,
'uf_group_id' => $this->_ufGroupId,
'is_active' => 1,
];

$ufJoin = $this->callAPISuccess('uf_join', 'create', $params);
$searchParams = [
'entity_table' => 'civicrm_contribution_page',
'entity_id' => 1,
'sequential' => 1,
];

$result = $this->callAPIAndDocument('uf_join', 'get', $searchParams, __FUNCTION__, __FILE__);
$this->assertEquals($result['values'][0]['module'], $params['module']);
$this->assertEquals($result['values'][0]['uf_group_id'], $params['uf_group_id']);
$this->assertEquals($result['values'][0]['entity_id'], $params['entity_id']);
}

/**
* Test civicrm_activity_create() using example code.
* @param int $version
* @dataProvider versionThreeAndFour
*/
public function testUFJoinCreateExample($version) {
$this->_apiversion = $version;
require_once 'api/v3/examples/UFJoin/Create.ex.php';
$result = UF_join_create_example();
$expectedResult = UF_join_create_expectedresult();
$this->assertEquals($result, $expectedResult);
$ufJoin = $this->callAPISuccess('UFJoin', 'create', $params)['values'][0];
$this->assertEquals('CiviCampaign', $ufJoin['module']);
$this->assertEquals($params['uf_group_id'], $ufJoin['uf_group_id']);
$this->assertEquals(1, $ufJoin['is_active']);
}

}

0 comments on commit 53b0ee3

Please sign in to comment.