3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
29 * Test APIv3 civicrm_survey_* functions
31 * @package CiviCRM_APIv3
32 * @subpackage API_Campaign
36 * All API should contain at minimum a success test for each
37 * function - in this case - create, get & delete
38 * In addition any extra functionality should be tested & documented
40 * Failure tests should be added for specific api behaviours but note that
41 * many generic patterns are tested in the syntax conformance test
47 class api_v3_SurveyTest
extends CiviUnitTestCase
{
49 protected $entity = 'survey';
50 public $DBResetRequired = FALSE;
53 public function setUp() {
54 $phoneBankActivityTypeID = $this->callAPISuccessGetValue('Option_value', array(
55 'label' => 'PhoneBank',
58 $this->useTransaction();
59 $this->enableCiviCampaign();
60 $this->params
= array(
61 'title' => "survey title",
62 'activity_type_id' => $phoneBankActivityTypeID,
63 'max_number_of_contacts' => 12,
64 'instructions' => "Call people, ask for money",
70 * Test create function succeeds.
72 public function testCreateSurvey() {
73 $result = $this->callAPIAndDocument('survey', 'create', $this->params
, __FUNCTION__
, __FILE__
);
74 $this->getAndCheck($this->params
, $result['id'], $this->entity
);
78 * Test get function succeeds.
80 * This is actually largely tested in the get
81 * action on create. Add extra checks for any 'special' return values or
84 public function testGetSurvey() {
85 $this->createTestEntity();
86 $result = $this->callAPIAndDocument('survey', 'get', $this->params
, __FUNCTION__
, __FILE__
);
87 $this->assertEquals(1, $result['count']);
88 $this->assertNotNull($result['values'][$result['id']]['id']);
92 * Check the delete function succeeds.
94 public function testDeleteSurvey() {
95 $entity = $this->createTestEntity();
96 $result = $this->callAPIAndDocument('survey', 'delete', array('id' => $entity['id']), __FUNCTION__
, __FILE__
);
97 $checkDeleted = $this->callAPISuccess($this->entity
, 'get', array());
98 $this->assertEquals(0, $checkDeleted['count']);
102 * Test & document chained delete pattern.
104 * Note that explanation of the pattern
105 * is best put in the $description variable as it will then be displayed in the
106 * test generated examples. (these are to be found in the api/examples folder).
108 public function testGetSurveyChainDelete() {
109 $description = "Demonstrates get + delete in the same call.";
110 $subfile = 'ChainedGetDelete';
112 'title' => "survey title",
113 'api.survey.delete' => 1,
115 $result = $this->callAPISuccess('survey', 'create', $this->params
);
116 $result = $this->callAPIAndDocument('survey', 'get', $params, __FUNCTION__
, __FILE__
, $description, $subfile);
117 $this->assertEquals(0, $this->callAPISuccess('survey', 'getcount', array()));