X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=tests%2Fphpunit%2Fapi%2Fv3%2FTagTest.php;h=d5de5b5bfad29b3816c66d53c46658d358e57d5f;hb=f299f7db79fed6f3598c84302966bda087e7cac3;hp=e5dd292073f7c513bbcdb11ee0efe3dab4ddecc0;hpb=4bea5552d37a82f57144d027f37af62695fb0e8c;p=civicrm-core.git diff --git a/tests/phpunit/api/v3/TagTest.php b/tests/phpunit/api/v3/TagTest.php index e5dd292073..d5de5b5bfa 100644 --- a/tests/phpunit/api/v3/TagTest.php +++ b/tests/phpunit/api/v3/TagTest.php @@ -3,7 +3,7 @@ +--------------------------------------------------------------------+ | CiviCRM version 5 | +--------------------------------------------------------------------+ - | Copyright CiviCRM LLC (c) 2004-2019 | + | Copyright CiviCRM LLC (c) 2004-2020 | +--------------------------------------------------------------------+ | This file is a part of CiviCRM. | | | @@ -38,13 +38,13 @@ class api_v3_TagTest extends CiviUnitTestCase { * @var array * @ids array of values to be cleaned up in the tear down */ - protected $ids = array(); + protected $ids = []; /** * Tag id. * * @var int */ - protected $tag = array(); + protected $tag = []; protected $tagID; @@ -59,21 +59,27 @@ class api_v3_TagTest extends CiviUnitTestCase { /** * Test civicrm_tag_get with wrong params. + * @param int $version + * @dataProvider versionThreeAndFour */ - public function testGetWrongParams() { - $params = array('name' => 'Wrong Tag Name'); + public function testGetWrongParams($version) { + $this->_apiversion = $version; + $params = ['name' => 'Wrong Tag Name']; $result = $this->callAPISuccess('tag', 'get', $params); $this->assertEquals(0, $result['count']); } /** * Test civicrm_tag_get - success expected. + * @param int $version + * @dataProvider versionThreeAndFour */ - public function testGet() { - $params = array( + public function testGet($version) { + $this->_apiversion = $version; + $params = [ 'id' => $this->tagID, 'name' => $this->tag['name'], - ); + ]; $result = $this->callAPIAndDocument('tag', 'get', $params, __FUNCTION__, __FILE__); $this->assertEquals($this->tag['description'], $result['values'][$this->tagID]['description']); $this->assertEquals($this->tag['name'], $result['values'][$this->tagID]['name']); @@ -81,16 +87,19 @@ class api_v3_TagTest extends CiviUnitTestCase { /** * Test civicrm_tag_get - success expected. + * @param int $version + * @dataProvider versionThreeAndFour */ - public function testGetReturnArray() { + public function testGetReturnArray($version) { + $this->_apiversion = $version; $description = "Demonstrates use of Return as an array."; $subfile = "GetReturnArray"; - $params = array( + $params = [ 'id' => $this->tagID, 'name' => $this->tag['name'], - 'return' => array('name'), - ); + 'return' => ['name'], + ]; $result = $this->callAPIAndDocument('tag', 'get', $params, __FUNCTION__, __FILE__, $description, $subfile); $this->assertTrue(empty($result['values'][$this->tagID]['description'])); $this->assertEquals($this->tag['name'], $result['values'][$this->tagID]['name']); @@ -100,32 +109,39 @@ class api_v3_TagTest extends CiviUnitTestCase { /** * Test civicrm_tag_create with empty params. + * @param int $version + * @dataProvider versionThreeAndFour */ - public function testCreateEmptyParams() { - $result = $this->callAPIFailure('tag', 'create', array(), 'Mandatory key(s) missing from params array: name'); + public function testCreateEmptyParams($version) { + $this->_apiversion = $version; + $result = $this->callAPIFailure('tag', 'create', [], 'name'); } /** * Test civicrm_tag_create. + * @param int $version + * @dataProvider versionThreeAndFour */ - public function testCreatePasstagInParams() { - $params = array( + public function testCreatePasstagInParams($version) { + $this->_apiversion = $version; + $params = [ 'tag' => 10, 'name' => 'New Tag23', 'description' => 'This is description for New Tag 02', - ); + ]; $result = $this->callAPISuccess('tag', 'create', $params); $this->assertEquals(10, $result['id']); } /** * Test civicrm_tag_create - success expected. + * Skipping v4 because used_for is an array */ public function testCreate() { - $params = array( + $params = [ 'name' => 'Super Heros', 'description' => 'Outside undie-wearers', - ); + ]; $result = $this->callAPIAndDocument('tag', 'create', $params, __FUNCTION__, __FILE__); $this->assertNotNull($result['id']); $params['used_for'] = 'civicrm_contact'; @@ -136,15 +152,17 @@ class api_v3_TagTest extends CiviUnitTestCase { * Test civicrm_tag_create activity tag- success expected. * * Test checks that used_for is set and not over-written by default on update. + * + * Skipping v4 because used_for is an array */ public function testCreateEntitySpecificTag() { - $params = array( + $params = [ 'name' => 'New Tag4', 'description' => 'This is description for New Activity tag', 'used_for' => 'civicrm_activity', - ); + ]; $result = $this->callAPISuccess('tag', 'create', $params); - $this->callAPISuccess('tag', 'get', array()); + $this->callAPISuccess('tag', 'get', []); $this->getAndCheck($params, $result['id'], 'tag', 0, __FUNCTION__ . ' tag first created'); unset($params['used_for']); $params['id'] = $result['id']; @@ -157,46 +175,55 @@ class api_v3_TagTest extends CiviUnitTestCase { /** * Test civicrm_tag_delete without tag id. + * @param int $version + * @dataProvider versionThreeAndFour */ - public function testDeleteWithoutTagId() { - $result = $this->callAPIFailure('tag', 'delete', array(), 'Mandatory key(s) missing from params array: id'); + public function testDeleteWithoutTagId($version) { + $this->_apiversion = $version; + $result = $this->callAPIFailure('tag', 'delete', []); } /** * Test civicrm_tag_delete . + * @param int $version + * @dataProvider versionThreeAndFour */ - public function testTagDeleteOldSyntax() { - $params = array( + public function testTagDeleteOldSyntax($version) { + $this->_apiversion = $version; + $params = [ 'tag_id' => $this->tagID, - ); + ]; $result = $this->callAPISuccess('tag', 'delete', $params); unset($this->ids['tag']); } /** * Test civicrm_tag_delete = $params['id'] is correct + * @param int $version + * @dataProvider versionThreeAndFour */ - public function testTagDeleteCorrectSyntax() { - $params = array( + public function testTagDeleteCorrectSyntax($version) { + $this->_apiversion = $version; + $params = [ 'id' => $this->tagID, - ); + ]; $result = $this->callAPIAndDocument('tag', 'delete', $params, __FUNCTION__, __FILE__); unset($this->ids['tag']); } public function testTagGetfields() { $description = "Demonstrate use of getfields to interrogate api."; - $params = array('action' => 'create'); + $params = ['action' => 'create']; $result = $this->callAPIAndDocument('tag', 'getfields', $params, __FUNCTION__, __FILE__, $description, NULL); $this->assertEquals('civicrm_contact', $result['values']['used_for']['api.default']); } public function testTagGetList() { $description = "Demonstrates use of api.getlist for autocomplete and quicksearch applications."; - $params = array( + $params = [ 'input' => $this->tag['name'], - 'extra' => array('used_for'), - ); + 'extra' => ['used_for'], + ]; $result = $this->callAPIAndDocument('tag', 'getlist', $params, __FUNCTION__, __FILE__, $description); $this->assertEquals($this->tag['id'], $result['values'][0]['id']); $this->assertEquals($this->tag['description'], $result['values'][0]['description'][0]);