3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.3 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
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 +--------------------------------------------------------------------+
28 require_once 'PHPUnit/Extensions/SeleniumTestCase.php';
31 * Include configuration
33 define('CIVICRM_SETTINGS_PATH', __DIR__
. '/civicrm.settings.dist.php');
34 define('CIVICRM_SETTINGS_LOCAL_PATH', __DIR__
. '/civicrm.settings.local.php');
36 if (file_exists(CIVICRM_SETTINGS_LOCAL_PATH
)) {
37 require_once CIVICRM_SETTINGS_LOCAL_PATH
;
39 require_once CIVICRM_SETTINGS_PATH
;
42 * Base class for CiviCRM Selenium tests
44 * Common functions for unit tests
47 class CiviSeleniumTestCase
extends PHPUnit_Extensions_SeleniumTestCase
{
49 // Current logged-in user
50 protected $loggedInAs = NULL;
55 * Because we are overriding the parent class constructor, we
56 * need to show the same arguments as exist in the constructor of
57 * PHPUnit_Framework_TestCase, since
58 * PHPUnit_Framework_TestSuite::createTest() creates a
59 * ReflectionClass of the Test class and checks the constructor
60 * of that class to decide how to set up the test.
64 * @param string $dataName
66 function __construct($name = NULL, array$data = array(), $dataName = '', array$browser = array()) {
67 parent
::__construct($name, $data, $dataName, $browser);
68 $this->loggedInAs
= NULL;
70 require_once 'CiviSeleniumSettings.php';
71 $this->settings
= new CiviSeleniumSettings();
72 if (property_exists($this->settings
, 'serverStartupTimeOut') && $this->settings
->serverStartupTimeOut
) {
73 global $CiviSeleniumTestCase_polled;
74 if (!$CiviSeleniumTestCase_polled) {
75 $CiviSeleniumTestCase_polled = TRUE;
76 CRM_Utils_Network
::waitForServiceStartup(
77 $this->drivers
[0]->getHost(),
78 $this->drivers
[0]->getPort(),
79 $this->settings
->serverStartupTimeOut
85 require_once 'CRM/Core/ClassLoader.php';
86 CRM_Core_ClassLoader
::singleton()->register();
88 // also initialize a connection to the db
89 // FIXME: not necessary for most tests, consider moving into functions that need this
90 $config = CRM_Core_Config
::singleton();
93 protected function setUp() {
94 $this->setBrowser($this->settings
->browser
);
95 // Make sure that below strings have path separator at the end
96 $this->setBrowserUrl($this->settings
->sandboxURL
);
97 $this->sboxPath
= $this->settings
->sandboxPATH
;
98 if (property_exists($this->settings
, 'rcHost') && $this->settings
->rcHost
) {
99 $this->setHost($this->settings
->rcHost
);
101 if (property_exists($this->settings
, 'rcPort') && $this->settings
->rcPort
) {
102 $this->setPort($this->settings
->rcPort
);
106 protected function tearDown() {
110 * Authenticate as drupal user
111 * @param $user: (str) the key 'user' or 'admin', or a literal username
112 * @param $pass: (str) if $user is a literal username and not 'user' or 'admin', supply the password
114 function webtestLogin($user = 'user', $pass = NULL) {
115 // If already logged in as correct user, do nothing
116 if ($this->loggedInAs
=== $user) {
119 // If we are logged in as a different user, log out first
120 if ($this->loggedInAs
) {
121 $this->webtestLogout();
123 $this->open("{$this->sboxPath}user");
124 // Lookup username & password if not supplied
126 if ($pass === NULL) {
127 $pass = $user == 'admin' ?
$this->settings
->adminPassword
: $this->settings
->password
;
128 $username = $user == 'admin' ?
$this->settings
->adminUsername
: $this->settings
->username
;
130 // Make sure login form is available
131 $this->waitForElementPresent('edit-submit');
132 $this->type('edit-name', $username);
133 $this->type('edit-pass', $pass);
134 $this->click('edit-submit');
135 $this->waitForPageToLoad($this->getTimeoutMsec());
136 $this->loggedInAs
= $user;
139 function webtestLogout() {
140 if ($this->loggedInAs
) {
141 $this->open($this->sboxPath
. "user/logout");
142 $this->waitForPageToLoad($this->getTimeoutMsec());
144 $this->loggedInAs
= NULL;
148 * Open an internal path beginning with 'civicrm/'
150 * @param $url (str) omit the 'civicrm/' it will be added for you
151 * @param $args (str|array) optional url arguments
152 * @param $waitFor - page element to wait for - using this is recommended to ensure the document is fully loaded
154 * Although it doesn't seem to do much now, using this function is recommended for
155 * opening all civi pages, and using the $args param is also strongly encouraged
156 * This will make it much easier to run webtests in other CMSs in the future
158 function openCiviPage($url, $args = NULL, $waitFor = 'civicrm-footer') {
159 // Construct full url with args
160 // This could be extended in future to work with other CMS style urls
162 if (is_array($args)) {
164 foreach ($args as $key => $val) {
165 $url .= $sep . $key . '=' . $val;
173 $this->open("{$this->sboxPath}civicrm/$url");
174 $this->waitForPageToLoad($this->getTimeoutMsec());
176 $this->waitForElementPresent($waitFor);
181 * Click on a link or button
182 * Wait for the page to load
183 * Wait for an element to be present
185 function clickLink($element, $waitFor = 'civicrm-footer', $waitForPageLoad = TRUE) {
186 $this->click($element);
187 // conditional wait for page load e.g for ajax form save
188 if ($waitForPageLoad) {
189 $this->waitForPageToLoad($this->getTimeoutMsec());
192 $this->waitForElementPresent($waitFor);
197 * Call the API on the local server
198 * (kind of defeats the point of a webtest - see CRM-11889)
200 function webtest_civicrm_api($entity, $action, $params) {
201 if (!isset($params['version'])) {
202 $params['version'] = 3;
205 $result = civicrm_api($entity, $action, $params);
206 $this->assertTrue(!civicrm_error($result), 'Civicrm api error.');
211 * Call the API on the remote server
212 * Experimental - currently only works if permissions on remote site allow anon user to access ajax api
215 function rest_civicrm_api($entity, $action, $params = array()) {
219 $url = "{$this->settings->sandboxURL}/{$this->sboxPath}civicrm/ajax/rest?entity=$entity&action=$action&json=" . json_encode($params);
223 // Naughty sidestep of civi's security checks
224 'header' => "X-Requested-With: XMLHttpRequest",
227 $ctx = stream_context_create($request);
228 $result = file_get_contents($url, FALSE, $ctx);
229 return json_decode($result, TRUE);
232 function webtestGetFirstValueForOptionGroup($option_group_name) {
233 $result = $this->webtest_civicrm_api("OptionValue", "getvalue", array(
234 'option_group_name' => $option_group_name,
241 function webtestGetValidCountryID() {
243 if (is_null($_country_id)) {
244 $config_backend = $this->webtestGetConfig('countryLimit');
245 $_country_id = current($config_backend);
250 function webtestGetValidEntityID($entity) {
251 // michaelmcandrew: would like to use getvalue but there is a bug
252 // for e.g. group where option.limit not working at the moment CRM-9110
253 $result = $this->webtest_civicrm_api($entity, "get", array('option.limit' => 1, 'return' => 'id'));
254 if (!empty($result['values'])) {
255 return current(array_keys($result['values']));
260 function webtestGetConfig($field) {
261 static $_config_backend;
262 if (is_null($_config_backend)) {
263 $result = $this->webtest_civicrm_api("Domain", "getvalue", array(
264 'current_domain' => 1,
266 'return' => 'config_backend'
268 $_config_backend = unserialize($result);
270 return $_config_backend[$field];
274 * Ensures the required CiviCRM components are enabled
276 function enableComponents($components) {
277 $this->openCiviPage("admin/setting/component", "reset=1", "_qf_Component_next-bottom");
278 $enabledComponents = $this->getSelectOptions("enableComponents-t");
280 foreach ((array) $components as $comp) {
281 if (!in_array($comp, $enabledComponents)) {
282 $this->addSelection("enableComponents-f", "label=$comp");
283 $this->click("//option[@value='$comp']");
289 $this->click("_qf_Component_next-bottom");
290 $this->waitForPageToLoad($this->getTimeoutMsec());
291 $this->waitForText('crm-notification-container', "Saved");
296 * Add a contact with the given first and last names and either a given email
297 * (when specified), a random email (when true) or no email (when unspecified or null).
299 * @param string $fname contact’s first name
300 * @param string $lname contact’s last name
301 * @param mixed $email contact’s email (when string) or random email (when true) or no email (when null)
303 * @return mixed either a string with the (either generated or provided) email or null (if no email)
305 function webtestAddContact($fname = 'Anthony', $lname = 'Anderson', $email = NULL, $contactSubtype = NULL) {
306 $url = $this->sboxPath
. 'civicrm/contact/add?reset=1&ct=Individual';
307 if ($contactSubtype) {
308 $url = $url . "&cst={$contactSubtype}";
311 $this->waitForElementPresent('_qf_Contact_upload_view-bottom');
312 $this->type('first_name', $fname);
313 $this->type('last_name', $lname);
314 if ($email === TRUE) {
315 $email = substr(sha1(rand()), 0, 7) . '@example.org';
318 $this->type('email_1_email', $email);
320 $this->waitForElementPresent('_qf_Contact_upload_view-bottom');
321 $this->click('_qf_Contact_upload_view-bottom');
322 $this->waitForPageToLoad($this->getTimeoutMsec());
326 function webtestAddHousehold($householdName = "Smith's Home", $email = NULL) {
328 $this->openCiviPage("contact/add", "reset=1&ct=Household");
329 $this->click('household_name');
330 $this->type('household_name', $householdName);
332 if ($email === TRUE) {
333 $email = substr(sha1(rand()), 0, 7) . '@example.org';
336 $this->type('email_1_email', $email);
339 $this->click('_qf_Contact_upload_view');
340 $this->waitForPageToLoad($this->getTimeoutMsec());
344 function webtestAddOrganization($organizationName = "Organization XYZ", $email = NULL) {
346 $this->openCiviPage("contact/add", "reset=1&ct=Organization");
347 $this->click('organization_name');
348 $this->type('organization_name', $organizationName);
350 if ($email === TRUE) {
351 $email = substr(sha1(rand()), 0, 7) . '@example.org';
354 $this->type('email_1_email', $email);
356 $this->click('_qf_Contact_upload_view');
357 $this->waitForPageToLoad($this->getTimeoutMsec());
363 function webtestFillAutocomplete($sortName, $fieldName = 'contact_1') {
364 $this->click($fieldName);
365 $this->type($fieldName, $sortName);
366 $this->typeKeys($fieldName, $sortName);
367 $this->waitForElementPresent("css=div.ac_results-inner li");
368 $this->click("css=div.ac_results-inner li");
369 $this->assertContains($sortName, $this->getValue($fieldName), "autocomplete expected $sortName but didn’t find it in " . $this->getValue($fieldName));
374 function webtestOrganisationAutocomplete($sortName) {
375 $this->type('contact_name', $sortName);
376 $this->click('contact_name');
377 $this->waitForElementPresent("css=div.ac_results-inner li");
378 $this->click("css=div.ac_results-inner li");
379 //$this->assertContains($sortName, $this->getValue('contact_1'), "autocomplete expected $sortName but didn’t find it in " . $this->getValue('contact_1'));
383 * 1. By default, when no strtotime arg is specified, sets date to "now + 1 month"
384 * 2. Does not set time. For setting both date and time use webtestFillDateTime() method.
385 * 3. Examples of $strToTime arguments -
386 * webtestFillDate('start_date',"now")
387 * webtestFillDate('start_date',"10 September 2000")
388 * webtestFillDate('start_date',"+1 day")
389 * webtestFillDate('start_date',"+1 week")
390 * webtestFillDate('start_date',"+1 week 2 days 4 hours 2 seconds")
391 * webtestFillDate('start_date',"next Thursday")
392 * webtestFillDate('start_date',"last Monday")
394 function webtestFillDate($dateElement, $strToTimeArgs = NULL) {
395 $timeStamp = strtotime($strToTimeArgs ?
$strToTimeArgs : '+1 month');
397 $year = date('Y', $timeStamp);
398 // -1 ensures month number is inline with calender widget's month
399 $mon = date('n', $timeStamp) - 1;
400 $day = date('j', $timeStamp);
402 $this->click("{$dateElement}_display");
403 $this->waitForElementPresent("css=div#ui-datepicker-div.ui-datepicker div.ui-datepicker-header div.ui-datepicker-title select.ui-datepicker-month");
404 $this->select("css=div#ui-datepicker-div.ui-datepicker div.ui-datepicker-header div.ui-datepicker-title select.ui-datepicker-month", "value=$mon");
405 $this->select("css=div#ui-datepicker-div div.ui-datepicker-header div.ui-datepicker-title select.ui-datepicker-year", "value=$year");
406 $this->click("link=$day");
409 // 1. set both date and time.
410 function webtestFillDateTime($dateElement, $strToTimeArgs = NULL) {
411 $this->webtestFillDate($dateElement, $strToTimeArgs);
413 $timeStamp = strtotime($strToTimeArgs ?
$strToTimeArgs : '+1 month');
414 $hour = date('h', $timeStamp);
415 $min = date('i', $timeStamp);
416 $meri = date('A', $timeStamp);
418 $this->type("{$dateElement}_time", "{$hour}:{$min}{$meri}");
422 * Verify that given label/value pairs are in *sibling* td cells somewhere on the page.
424 * @param array $expected Array of key/value pairs (like Status/Registered) to be checked
425 * @param string $xpathPrefix Pass in an xpath locator to "get to" the desired table or tables. Will be prefixed to xpath
426 * table path. Include leading forward slashes (e.g. "//div[@id='activity-content']").
427 * @param string $tableId Pass in the id attribute of a table to be verified if you want to only check a specific table
430 function webtestVerifyTabularData($expected, $xpathPrefix = NULL, $tableId = NULL) {
433 $tableLocator = "[@id='$tableId']";
435 foreach ($expected as $label => $value) {
437 $this->verifyText("xpath=//table{$tableLocator}/tbody/tr/td{$xpathPrefix}[text()='{$label}']/../following-sibling::td", preg_quote($value), 'In line ' . __LINE__
);
440 $this->verifyText("xpath=//table{$tableLocator}/tbody/tr/td[text()='{$label}']/following-sibling::td", preg_quote($value), 'In line ' . __LINE__
);
446 * Types text into a ckEditor rich text field in a form
448 * @param string $fieldName form field name (as assigned by PHP buildForm class)
449 * @param string $text text to type into the field
450 * @param string $editor which text editor (valid values are 'CKEditor', 'TinyMCE')
454 function fillRichTextField($fieldName, $text = 'Typing this text into editor.', $editor = 'CKEditor') {
455 // make sure cursor focuses on the field
456 $this->fireEvent($fieldName, 'focus');
457 if ($editor == 'CKEditor') {
458 $this->waitForElementPresent("xpath=//div[@id='cke_{$fieldName}']//iframe");
459 $this->runScript("CKEDITOR.instances['{$fieldName}'].setData('<p>{$text}</p>');");
461 elseif ($editor == 'TinyMCE') {
462 $this->waitForElementPresent("xpath=//iframe[@id='{$fieldName}_ifr']");
463 $this->runScript("tinyMCE.activeEditor.setContent('<p>{$text}</p>');");
466 $this->fail("Unknown editor value: $editor, failing (in CiviSeleniumTestCase::fillRichTextField ...");
468 $this->selectFrame('relative=top');
472 * Types option label and name into a table of multiple choice options
473 * (for price set fields of type select, radio, or checkbox)
474 * TODO: extend for custom field multiple choice table input
476 * @param array $options form field name (as assigned by PHP buildForm class)
477 * @param array $validateStrings appends label and name strings to this array so they can be validated later
481 function addMultipleChoiceOptions($options, &$validateStrings) {
482 foreach ($options as $oIndex => $oValue) {
483 $validateStrings[] = $oValue['label'];
484 $validateStrings[] = $oValue['amount'];
485 if (CRM_Utils_Array
::value('membership_type_id', $oValue)) {
486 $this->select("membership_type_id_{$oIndex}", "value={$oValue['membership_type_id']}");
488 if (CRM_Utils_Array
::value('financial_type_id', $oValue)) {
489 $this->select("option_financial_type_id_{$oIndex}", "label={$oValue['financial_type_id']}");
491 $this->type("option_label_{$oIndex}", $oValue['label']);
492 $this->type("option_amount_{$oIndex}", $oValue['amount']);
493 $this->click('link=another choice');
499 function webtestNewDialogContact($fname = 'Anthony', $lname = 'Anderson', $email = 'anthony@anderson.biz',
500 $type = 4, $selectId = 'profiles_1', $row = 1, $prefix = '') {
501 // 4 - Individual profile
502 // 5 - Organization profile
503 // 6 - Household profile
504 $this->select($selectId, "value={$type}");
506 // create new contact using dialog
508 $this->waitForElementPresent("css=div#contact-dialog-{$row}");
511 $this->waitForElementPresent("css=div#contact-dialog-{$prefix}_{$row}");
513 $this->waitForElementPresent('_qf_Edit_next');
517 $this->type('first_name', $fname);
518 $this->type('last_name', $lname);
522 $this->type('organization_name', $fname);
526 $this->type('household_name', $fname);
530 $this->type('email-Primary', $email);
531 $this->click('_qf_Edit_next');
533 // Is new contact created?
535 $this->assertTrue($this->isTextPresent("$fname $lname has been created."), "Status message didn't show up after saving!");
538 $this->assertTrue($this->isTextPresent("$fname has been created."), "Status message didn't show up after saving!");
543 * Generic function to check that strings are present in the page
545 * @strings array array of strings or a single string
549 function assertStringsPresent($strings) {
550 foreach ((array) $strings as $string) {
551 $this->assertTrue($this->isTextPresent($string), "Could not find $string on page");
556 * Generic function to parse a URL string into it's elements.extract a variable value from a string (url)
558 * @url string url to parse or retrieve current url if null
560 * @return array returns an associative array containing any of the various components
561 * of the URL that are present. Querystring elements are returned in sub-array (elements.queryString)
562 * http://php.net/manual/en/function.parse-url.php
565 function parseURL($url = NULL) {
567 $url = $this->getLocation();
570 $elements = parse_url($url);
571 if (!empty($elements['query'])) {
572 $elements['queryString'] = array();
573 parse_str($elements['query'], $elements['queryString']);
579 * Returns a single argument from the url query
581 function urlArg($arg, $url = NULL) {
582 $elements = $this->parseURL($url);
583 return isset($elements['queryString'][$arg]) ?
$elements['queryString'][$arg] : NULL;
587 * Define a payment processor for use by a webtest. Default is to create Dummy processor
588 * which is useful for testing online public forms (online contribution pages and event registration)
590 * @param string $processorName Name assigned to new processor
591 * @param string $processorType Name for processor type (e.g. PayPal, Dummy, etc.)
592 * @param array $processorSettings Array of fieldname => value for required settings for the processor
597 function webtestAddPaymentProcessor($processorName, $processorType = 'Dummy', $processorSettings = NULL, $financialAccount = 'Deposit Bank Account') {
598 if (!$processorName) {
599 $this->fail("webTestAddPaymentProcessor requires $processorName.");
601 if ($processorType == 'Dummy') {
602 $processorSettings = array(
603 'user_name' => 'dummy',
604 'url_site' => 'http://dummy.com',
605 'test_user_name' => 'dummytest',
606 'test_url_site' => 'http://dummytest.com',
609 elseif ($processorType == 'AuthNet') {
610 // FIXME: we 'll need to make a new separate account for testing
611 $processorSettings = array(
612 'test_user_name' => '5ULu56ex',
613 'test_password' => '7ARxW575w736eF5p',
616 elseif ($processorType == 'Google_Checkout') {
617 // FIXME: we 'll need to make a new separate account for testing
618 $processorSettings = array(
619 'test_user_name' => '559999327053114',
620 'test_password' => 'R2zv2g60-A7GXKJYl0nR0g',
623 elseif ($processorType == 'PayPal') {
624 $processorSettings = array(
625 'test_user_name' => '559999327053114',
626 'test_password' => 'R2zv2g60-A7GXKJYl0nR0g',
627 'test_signature' => 'R2zv2g60-A7GXKJYl0nR0g',
630 elseif ($processorType == 'PayPal_Standard') {
631 $processorSettings = array(
632 'test_user_name' => 'V18ki@9r5Bf.org',
635 elseif (empty($processorSettings)) {
636 $this->fail("webTestAddPaymentProcessor requires $processorSettings array if processorType is not Dummy.");
638 $pid = CRM_Core_DAO
::getFieldValue("CRM_Financial_DAO_PaymentProcessorType", $processorType, "id", "name");
640 $this->fail("$processorType processortype not found.");
642 $this->open($this->sboxPath
. 'civicrm/admin/paymentProcessor?action=add&reset=1&pp=' . $pid);
643 $this->waitForPageToLoad($this->getTimeoutMsec());
644 $this->type('name', $processorName);
645 $this->select('financial_account_id', "label={$financialAccount}");
647 foreach ($processorSettings AS $f => $v) {
650 $this->click('_qf_PaymentProcessor_next-bottom');
651 $this->waitForPageToLoad($this->getTimeoutMsec());
652 // Is new processor created?
653 $this->assertTrue($this->isTextPresent($processorName), 'Processor name not found in selector after adding payment processor (webTestAddPaymentProcessor).');
655 $paymentProcessorId = explode('&id=', $this->getAttribute("xpath=//table[@class='selector']//tbody//tr/td[text()='{$processorName}']/../td[7]/span/a[1]@href"));
656 $paymentProcessorId = explode('&', $paymentProcessorId[1]);
657 return $paymentProcessorId[0];
660 function webtestAddCreditCardDetails() {
661 $this->waitForElementPresent('credit_card_type');
662 $this->select('credit_card_type', 'label=Visa');
663 $this->type('credit_card_number', '4807731747657838');
664 $this->type('cvv2', '123');
665 $this->select('credit_card_exp_date[M]', 'label=Feb');
666 $this->select('credit_card_exp_date[Y]', 'label=2019');
669 function webtestAddBillingDetails($firstName = NULL, $middleName = NULL, $lastName = NULL) {
675 $middleName = 'Apple';
679 $lastName = 'Smith_' . substr(sha1(rand()), 0, 7);
682 $this->type('billing_first_name', $firstName);
683 $this->type('billing_middle_name', $middleName);
684 $this->type('billing_last_name', $lastName);
686 $this->type('billing_street_address-5', '234 Lincoln Ave');
687 $this->type('billing_city-5', 'San Bernadino');
688 $this->click('billing_state_province_id-5');
689 $this->select('billing_state_province_id-5', 'label=California');
690 $this->type('billing_postal_code-5', '93245');
692 return array($firstName, $middleName, $lastName);
695 function webtestAttachFile($fieldLocator, $filePath = NULL) {
697 $filePath = '/tmp/testfile_' . substr(sha1(rand()), 0, 7) . '.txt';
698 $fp = @fopen
($filePath, 'w');
699 fputs($fp, 'Test file created by selenium test.');
703 $this->assertTrue(file_exists($filePath), 'Not able to locate file: ' . $filePath);
705 $this->attachFile($fieldLocator, "file://{$filePath}");
710 function webtestCreateCSV($headers, $rows, $filePath = NULL) {
712 $filePath = '/tmp/testcsv_' . substr(sha1(rand()), 0, 7) . '.csv';
715 $data = '"' . implode('", "', $headers) . '"' . "\r\n";
717 foreach ($rows as $row) {
719 foreach ($headers as $field => $header) {
720 $temp[$field] = isset($row[$field]) ?
'"' . $row[$field] . '"' : '""';
722 $data .= implode(', ', $temp) . "\r\n";
725 $fp = @fopen
($filePath, 'w');
729 $this->assertTrue(file_exists($filePath), 'Not able to locate file: ' . $filePath);
735 * Create new relationship type w/ user specified params or default.
737 * @param $params array of required params.
739 * @return an array of saved params values.
741 function webtestAddRelationshipType($params = array()) {
742 $this->openCiviPage("admin/reltype", "reset=1&action=add");
744 //build the params if not passed.
745 if (!is_array($params) ||
empty($params)) {
747 'label_a_b' => 'Test Relationship Type A - B -' . rand(),
748 'label_b_a' => 'Test Relationship Type B - A -' . rand(),
749 'contact_types_a' => 'Individual',
750 'contact_types_b' => 'Individual',
751 'description' => 'Test Relationship Type Description',
754 //make sure we have minimum required params.
755 if (!isset($params['label_a_b']) ||
empty($params['label_a_b'])) {
756 $params['label_a_b'] = 'Test Relationship Type A - B -' . rand();
759 //start the form fill.
760 $this->type('label_a_b', $params['label_a_b']);
761 $this->type('label_b_a', $params['label_b_a']);
762 $this->select('contact_types_a', "value={$params['contact_type_a']}");
763 $this->select('contact_types_b', "value={$params['contact_type_b']}");
764 $this->type('description', $params['description']);
767 $this->click('_qf_RelationshipType_next-bottom');
768 $this->waitForPageToLoad($this->getTimeoutMsec());
771 $this->assertTrue($this->isTextPresent('The Relationship Type has been saved.'),
772 "Status message didn't show up after saving!"
775 $this->openCiviPage("admin/reltype", "reset=1");
777 //validate data on selector.
779 if (isset($data['description'])) {
780 unset($data['description']);
782 $this->assertStringsPresent($data);
788 * Create new online contribution page w/ user specified params or defaults.
789 * FIXME: this function take an absurd number of params - very unwieldy :(
791 * @param User can define pageTitle, hash and rand values for later data verification
793 * @return $pageId of newly created online contribution page.
795 function webtestAddContributionPage($hash = NULL,
798 $processor = array('Dummy Processor' => 'Dummy'),
799 $amountSection = TRUE,
804 $membershipTypes = TRUE,
805 $memPriceSetId = NULL,
812 $isAddPaymentProcessor = TRUE,
813 $isPcpApprovalNeeded = FALSE,
814 $isSeparatePayment = FALSE,
815 $honoreeSection = TRUE,
816 $allowOtherAmmount = TRUE,
817 $isConfirmEnabled = TRUE,
818 $financialType = 'Donation',
820 $membershipsRequired = TRUE
823 $hash = substr(sha1(rand()), 0, 7);
826 $pageTitle = 'Donate Online ' . $hash;
830 $rand = 2 * rand(2, 50);
833 // Create a new payment processor if requested
834 if ($isAddPaymentProcessor) {
835 while (list($processorName, $processorType) = each($processor)) {
836 $this->webtestAddPaymentProcessor($processorName, $processorType);
840 // go to the New Contribution Page page
841 $this->openCiviPage('admin/contribute', 'action=add&reset=1');
843 // fill in step 1 (Title and Settings)
844 $this->type('title', $pageTitle);
846 //to select financial type
847 $this->select('financial_type_id', "label={$financialType}");
850 $this->click('is_organization');
851 $this->select('onbehalf_profile_id', 'label=On Behalf Of Organization');
852 $this->type('for_organization', "On behalf $hash");
854 if ($onBehalf == 'required') {
855 $this->click('CIVICRM_QFID_2_4');
857 elseif ($onBehalf == 'optional') {
858 $this->click('CIVICRM_QFID_1_2');
862 $this->fillRichTextField('intro_text', 'This is introductory message for ' . $pageTitle, 'CKEditor');
863 $this->fillRichTextField('footer_text', 'This is footer message for ' . $pageTitle, 'CKEditor');
865 $this->type('goal_amount', 10 * $rand);
867 // FIXME: handle Start/End Date/Time
868 if ($honoreeSection) {
869 $this->click('honor_block_is_active');
870 $this->type('honor_block_title', "Honoree Section Title $hash");
871 $this->type('honor_block_text', "Honoree Introductory Message $hash");
874 // is confirm enabled? it starts out enabled, so uncheck it if false
875 if (!$isConfirmEnabled) {
876 $this->click("id=is_confirm_enabled");
880 $this->clickLink('_qf_Settings_next', "_qf_Amount_next-bottom");
882 // Get contribution page id
883 $pageId = $this->urlArg('id');
885 // fill in step 2 (Processor, Pay Later, Amounts)
886 if (!empty($processor)) {
888 while (list($processorName) = each($processor)) {
889 // select newly created processor
890 $xpath = "xpath=//label[text() = '{$processorName}']/preceding-sibling::input[1]";
891 $this->assertTrue($this->isTextPresent($processorName));
892 $this->check($xpath);
896 if ($amountSection && !$memPriceSetId) {
898 $this->click('is_pay_later');
899 $this->type('pay_later_text', "Pay later label $hash");
900 $this->fillRichTextField('pay_later_receipt', "Pay later instructions $hash");
904 $this->click('is_pledge_active');
905 $this->click('pledge_frequency_unit[week]');
906 $this->click('is_pledge_interval');
907 $this->type('initial_reminder_day', 3);
908 $this->type('max_reminders', 2);
909 $this->type('additional_reminder_day', 1);
911 elseif ($recurring) {
912 $this->click('is_recur');
913 $this->click("is_recur_interval");
914 $this->click("is_recur_installments");
916 if ($allowOtherAmmount) {
918 $this->click('is_allow_other_amount');
920 // there shouldn't be minimums and maximums on test contribution forms unless you specify it
921 //$this->type('min_amount', $rand / 2);
922 //$this->type('max_amount', $rand * 10);
924 if ($fixedAmount ||
!$allowOtherAmmount) {
925 $this->type('label_1', "Label $hash");
926 $this->type('value_1', "$rand");
928 $this->click('CIVICRM_QFID_1_2');
931 $this->click('amount_block_is_active');
934 $this->click('_qf_Amount_next');
935 $this->waitForElementPresent('_qf_Amount_next-bottom');
936 $this->waitForPageToLoad($this->getTimeoutMsec());
937 $text = "'Amount' information has been saved.";
938 $this->assertTrue($this->isTextPresent($text), 'Missing text: ' . $text);
940 if ($memPriceSetId ||
(($membershipTypes === TRUE) ||
(is_array($membershipTypes) && !empty($membershipTypes)))) {
941 // go to step 3 (memberships)
942 $this->click('link=Memberships');
943 $this->waitForElementPresent('_qf_MembershipBlock_next-bottom');
945 // fill in step 3 (Memberships)
946 $this->click('member_is_active');
947 $this->waitForElementPresent('displayFee');
948 $this->type('new_title', "Title - New Membership $hash");
949 $this->type('renewal_title', "Title - Renewals $hash");
951 if ($memPriceSetId) {
952 $this->click('member_price_set_id');
953 $this->select('member_price_set_id', "value={$memPriceSetId}");
956 if ($membershipTypes === TRUE) {
957 $membershipTypes = array(array('id' => 2));
960 // FIXME: handle Introductory Message - New Memberships/Renewals
961 foreach ($membershipTypes as $mType) {
962 $this->click("membership_type_{$mType['id']}");
963 if (array_key_exists('default', $mType)) {
966 if (array_key_exists('auto_renew', $mType)) {
967 $this->select("auto_renew_{$mType['id']}", "label=Give option");
970 if ($membershipsRequired) {
971 $this->click('is_required');
973 $this->waitForElementPresent('CIVICRM_QFID_2_4');
974 $this->click('CIVICRM_QFID_2_4');
975 if ($isSeparatePayment) {
976 $this->click('is_separate_payment');
979 $this->clickLink('_qf_MembershipBlock_next', '_qf_MembershipBlock_next-bottom');
980 $text = "'MembershipBlock' information has been saved.";
981 $this->assertTrue($this->isTextPresent($text), 'Missing text: ' . $text);
984 // go to step 4 (thank-you and receipting)
985 $this->click('link=Receipt');
986 $this->waitForElementPresent('_qf_ThankYou_next-bottom');
989 $this->type('thankyou_title', "Thank-you Page Title $hash");
990 // FIXME: handle Thank-you Message/Page Footer
991 $this->type('receipt_from_name', "Receipt From Name $hash");
992 $this->type('receipt_from_email', "$hash@example.org");
993 $this->type('receipt_text', "Receipt Message $hash");
994 $this->type('cc_receipt', "$hash@example.net");
995 $this->type('bcc_receipt', "$hash@example.com");
997 $this->click('_qf_ThankYou_next');
998 $this->waitForElementPresent('_qf_ThankYou_next-bottom');
999 $this->waitForPageToLoad($this->getTimeoutMsec());
1000 $text = "'ThankYou' information has been saved.";
1001 $this->assertTrue($this->isTextPresent($text), 'Missing text: ' . $text);
1004 // fill in step 5 (Tell a Friend)
1005 $this->click('link=Tell a Friend');
1006 $this->waitForElementPresent('_qf_Contribute_next-bottom');
1007 $this->click('tf_is_active');
1008 $this->type('tf_title', "TaF Title $hash");
1009 $this->type('intro', "TaF Introduction $hash");
1010 $this->type('suggested_message', "TaF Suggested Message $hash");
1011 $this->type('general_link', "TaF Info Page Link $hash");
1012 $this->type('tf_thankyou_title', "TaF Thank-you Title $hash");
1013 $this->type('tf_thankyou_text', "TaF Thank-you Message $hash");
1015 //$this->click('_qf_Contribute_next');
1016 $this->click('_qf_Contribute_next-bottom');
1017 $this->waitForPageToLoad($this->getTimeoutMsec());
1018 $text = "'Friend' information has been saved.";
1019 $this->assertTrue($this->isTextPresent($text), 'Missing text: ' . $text);
1022 if ($profilePreId ||
$profilePostId) {
1023 // fill in step 6 (Include Profiles)
1024 $this->click('css=li#tab_custom a');
1025 $this->waitForElementPresent('_qf_Custom_next-bottom');
1027 if ($profilePreId) {
1028 $this->select('custom_pre_id', "value={$profilePreId}");
1031 if ($profilePostId) {
1032 $this->select('custom_post_id', "value={$profilePostId}");
1035 $this->click('_qf_Custom_next-bottom');
1036 //$this->waitForElementPresent('_qf_Custom_next-bottom');
1038 $this->waitForPageToLoad($this->getTimeoutMsec());
1039 $text = "'Custom' information has been saved.";
1040 $this->assertTrue($this->isTextPresent($text), 'Missing text: ' . $text);
1044 // fill in step 7 (Premiums)
1045 $this->click('link=Premiums');
1046 $this->waitForElementPresent('_qf_Premium_next-bottom');
1047 $this->click('premiums_active');
1048 $this->type('premiums_intro_title', "Prem Title $hash");
1049 $this->type('premiums_intro_text', "Prem Introductory Message $hash");
1050 $this->type('premiums_contact_email', "$hash@example.info");
1051 $this->type('premiums_contact_phone', rand(100000000, 999999999));
1052 $this->click('premiums_display_min_contribution');
1053 $this->type('premiums_nothankyou_label', 'No thank-you');
1054 $this->click('_qf_Premium_next');
1055 $this->waitForElementPresent('_qf_Premium_next-bottom');
1057 $this->waitForPageToLoad($this->getTimeoutMsec());
1058 $text = "'Premium' information has been saved.";
1059 $this->assertTrue($this->isTextPresent($text), 'Missing text: ' . $text);
1063 // fill in step 8 (Widget Settings)
1064 $this->click('link=Widgets');
1065 $this->waitForElementPresent('_qf_Widget_next-bottom');
1067 $this->click('is_active');
1068 $this->type('url_logo', "URL to Logo Image $hash");
1069 $this->type('button_title', "Button Title $hash");
1070 // Type About text in ckEditor (fieldname, text to type, editor)
1071 $this->fillRichTextField('about', 'This is for ' . $pageTitle, 'CKEditor');
1073 $this->click('_qf_Widget_next');
1074 $this->waitForElementPresent('_qf_Widget_next-bottom');
1076 $this->waitForPageToLoad($this->getTimeoutMsec());
1077 $text = "'Widget' information has been saved.";
1078 $this->assertTrue($this->isTextPresent($text), 'Missing text: ' . $text);
1082 // fill in step 9 (Enable Personal Campaign Pages)
1083 $this->click('link=Personal Campaigns');
1084 $this->waitForElementPresent('_qf_Contribute_next-bottom');
1085 $this->click('pcp_active');
1086 if (!$isPcpApprovalNeeded) {
1087 $this->click('is_approval_needed');
1089 $this->type('notify_email', "$hash@example.name");
1090 $this->select('supporter_profile_id', 'value=2');
1091 $this->type('tellfriend_limit', 7);
1092 $this->type('link_text', "'Create Personal Campaign Page' link text $hash");
1094 $this->click('_qf_Contribute_next-bottom');
1095 //$this->waitForElementPresent('_qf_PCP_next-bottom');
1096 $this->waitForPageToLoad($this->getTimeoutMsec());
1097 $text = "'Pcp' information has been saved.";
1098 $this->assertTrue($this->isTextPresent($text), 'Missing text: ' . $text);
1105 * Function to update default strict rule.
1107 * @params string $contactType Contact type
1108 * @param array $fields Fields to be set for strict rule
1109 * @param Integer $threshold Rule's threshold value
1111 function webtestStrictDedupeRuleDefault($contactType = 'Individual', $fields = array(), $threshold = 10) {
1112 // set default strict rule.
1114 if ($contactType == 'Organization') {
1117 elseif ($contactType == 'Household') {
1121 // Default dedupe fields for each Contact type.
1122 if (empty($fields)) {
1123 $fields = array('civicrm_email.email' => 10);
1124 if ($contactType == 'Organization') {
1126 'civicrm_contact.organization_name' => 10,
1127 'civicrm_email.email' => 10,
1130 elseif ($contactType == 'Household') {
1132 'civicrm_contact.household_name' => 10,
1133 'civicrm_email.email' => 10,
1138 $this->openCiviPage('contact/deduperules', "action=update&id=$strictRuleId", '_qf_DedupeRules_next-bottom');
1141 foreach ($fields as $field => $weight) {
1142 $this->select("where_{$count}", "value={$field}");
1143 $this->type("length_{$count}", '');
1144 $this->type("weight_{$count}", $weight);
1149 $this->type('threshold', $threshold);
1151 $this->click('_qf_DedupeRules_next-bottom');
1152 $this->waitForPageToLoad($this->getTimeoutMsec());
1156 for ($i = $count; $i <= 4; $i++
) {
1157 $this->select("where_{$i}", 'label=- none -');
1158 $this->type("length_{$i}", '');
1159 $this->type("weight_{$i}", '');
1162 $this->type('threshold', $threshold);
1165 $this->click('_qf_DedupeRules_next-bottom');
1166 $this->waitForPageToLoad($this->getTimeoutMsec());
1169 function webtestAddMembershipType($period_type = 'rolling', $duration_interval = 1, $duration_unit = 'year', $auto_renew = 'no') {
1170 $membershipTitle = substr(sha1(rand()), 0, 7);
1171 $membershipOrg = $membershipTitle . ' memorg';
1172 $this->webtestAddOrganization($membershipOrg, TRUE);
1174 $title = 'Membership Type ' . substr(sha1(rand()), 0, 7);
1175 $memTypeParams = array(
1176 'membership_type' => $title,
1177 'member_of_contact' => $membershipOrg,
1178 'financial_type' => 2,
1179 'period_type' => $period_type,
1182 $this->openCiviPage("admin/member/membershipType/add", "action=add&reset=1", '_qf_MembershipType_cancel-bottom');
1184 $this->type('name', $memTypeParams['membership_type']);
1186 // if auto_renew optional or required - a valid payment processor must be created first (e.g Auth.net)
1187 // select the radio first since the element id changes after membership org search results are loaded
1188 switch ($auto_renew) {
1190 $this->click("xpath=//div[@id='membership_type_form']//table/tbody/tr[6]/td/label[contains(text(), 'Auto-renew Option')]/../../td[2]/label[contains(text(), 'Give option, but not required')]");
1194 $this->click("xpath=//div[@id='membership_type_form']//table/tbody/tr[6]/td/label[contains(text(), 'Auto-renew Option')]/../../td[2]/label[contains(text(), 'Auto-renew required')]");
1198 //check if for the element presence (the Auto renew options can be absent when proper payment processor not configured)
1199 if ($this->isElementPresent("xpath=//div[@id='membership_type_form']//table/tbody/tr[6]/td/label[contains(text(), 'Auto-renew Option')]/../../td[2]/label[contains(text(), 'No auto-renew option')]")) {
1200 $this->click("xpath=//div[@id='membership_type_form']//table/tbody/tr[6]/td/label[contains(text(), 'Auto-renew Option')]/../../td[2]/label[contains(text(), 'No auto-renew option')]");
1205 $this->type('member_of_contact', $membershipTitle);
1206 $this->click('member_of_contact');
1207 $this->waitForElementPresent("css=div.ac_results-inner li");
1208 $this->click("css=div.ac_results-inner li");
1210 $this->type('minimum_fee', '100');
1211 $this->select('financial_type_id', "value={$memTypeParams['financial_type']}");
1213 $this->type('duration_interval', $duration_interval);
1214 $this->select('duration_unit', "label={$duration_unit}");
1216 $this->select('period_type', "label={$period_type}");
1218 $this->click('_qf_MembershipType_upload-bottom');
1219 $this->waitForElementPresent('link=Add Membership Type');
1220 $this->assertTrue($this->isTextPresent("The membership type '$title' has been saved."));
1222 return $memTypeParams;
1225 function WebtestAddGroup($groupName = NULL, $parentGroupName = NULL) {
1226 $this->openCiviPage('group/add', 'reset=1', '_qf_Edit_upload-bottom');
1230 $groupName = 'group_' . substr(sha1(rand()), 0, 7);
1232 $this->type('title', $groupName);
1235 $this->type('description', 'Adding new group.');
1237 // check Access Control
1238 $this->click('group_type[1]');
1240 // check Mailing List
1241 $this->click('group_type[2]');
1243 // select Visibility as Public Pages
1244 $this->select('visibility', 'value=Public Pages');
1246 // select parent group
1247 if ($parentGroupName) {
1248 $this->select('parents', "*$parentGroupName");
1252 $this->clickLink('_qf_Edit_upload-bottom');
1254 // Is status message correct?
1255 $this->waitForText('crm-notification-container', "$groupName");
1259 function WebtestAddActivity($activityType = "Meeting") {
1260 // Adding Adding contact with randomized first name for test testContactContextActivityAdd
1261 // We're using Quick Add block on the main page for this.
1262 $firstName1 = substr(sha1(rand()), 0, 7);
1263 $this->webtestAddContact($firstName1, "Summerson", $firstName1 . "@summerson.name");
1264 $firstName2 = substr(sha1(rand()), 0, 7);
1265 $this->webtestAddContact($firstName2, "Anderson", $firstName2 . "@anderson.name");
1267 $this->click("css=li#tab_activity a");
1269 // waiting for the activity dropdown to show up
1270 $this->waitForElementPresent("other_activity");
1272 // Select the activity type from the activity dropdown
1273 $this->select("other_activity", "label=Meeting");
1275 $this->waitForElementPresent("_qf_Activity_upload-bottom");
1277 $this->assertTrue($this->isTextPresent("Anderson, " . $firstName2), "Contact not found in line " . __LINE__
);
1279 // Typing contact's name into the field (using typeKeys(), not type()!)...
1280 $this->click("css=tr.crm-activity-form-block-assignee_contact_id input#token-input-assignee_contact_id");
1281 $this->type("css=tr.crm-activity-form-block-assignee_contact_id input#token-input-assignee_contact_id", $firstName1);
1282 $this->typeKeys("css=tr.crm-activity-form-block-assignee_contact_id input#token-input-assignee_contact_id", $firstName1);
1284 // ...waiting for drop down with results to show up...
1285 $this->waitForElementPresent("css=div.token-input-dropdown-facebook");
1286 $this->waitForElementPresent("css=li.token-input-input-token-facebook");
1288 //.need to use mouseDown on first result (which is a li element), click does not work
1289 // Note that if you are using firebug this appears at the bottom of the html source, before the closing </body> tag, not where the <li> referred to above is, which is a different <li>.
1290 $this->waitForElementPresent("css=div.token-input-dropdown-facebook li");
1291 $this->mouseDown("css=div.token-input-dropdown-facebook li");
1293 // ...again, waiting for the box with contact name to show up...
1294 $this->waitForElementPresent("css=tr.crm-activity-form-block-assignee_contact_id td ul li span.token-input-delete-token-facebook");
1296 // ...and verifying if the page contains properly formatted display name for chosen contact.
1297 $this->assertTrue($this->isTextPresent("Summerson, " . $firstName1), "Contact not found in line " . __LINE__
);
1299 // Putting the contents into subject field - assigning the text to variable, it'll come in handy later
1300 $subject = "This is subject of test activity being added through activity tab of contact summary screen.";
1301 // For simple input fields we can use field id as selector
1302 $this->type("subject", $subject);
1303 $this->type("location", "Some location needs to be put in this field.");
1305 $this->webtestFillDateTime('activity_date_time', '+1 month 11:10PM');
1307 // Setting duration.
1308 $this->type("duration", "30");
1310 // Putting in details.
1311 $this->type("details", "Really brief details information.");
1313 // Making sure that status is set to Scheduled (using value, not label).
1314 $this->select("status_id", "value=1");
1316 // Setting priority.
1317 $this->select("priority_id", "value=1");
1319 // Scheduling follow-up.
1320 $this->click("css=.crm-activity-form-block-schedule_followup div.crm-accordion-header");
1321 $this->select("followup_activity_type_id", "value=1");
1322 $this->webtestFillDateTime('followup_date', '+2 month 11:10PM');
1323 $this->type("followup_activity_subject", "This is subject of schedule follow-up activity");
1326 $this->click("_qf_Activity_upload-bottom");
1327 $this->waitForPageToLoad($this->getTimeoutMsec());
1329 // Is status message correct?
1330 $this->assertTrue($this->isTextPresent("Activity '$subject' has been saved."), "Status message didn't show up after saving!");
1332 $this->waitForElementPresent("xpath=//div[@id='Activities']//table/tbody/tr[2]/td[8]/span/a[text()='View']");
1334 // click through to the Activity view screen
1335 $this->click("xpath=//div[@id='Activities']//table/tbody/tr[2]/td[8]/span/a[text()='View']");
1336 $this->waitForElementPresent('_qf_Activity_cancel-bottom');
1338 // parse URL to grab the activity id
1339 // pass id back to any other tests that call this class
1340 return $this->urlArg('id');
1344 function checkDoLocalDBTest() {
1345 if (defined('CIVICRM_WEBTEST_LOCAL_DB') &&
1346 CIVICRM_WEBTEST_LOCAL_DB
1348 require_once 'tests/phpunit/CiviTest/CiviDBAssert.php';
1355 * Generic function to compare expected values after an api call to retrieved
1358 * @daoName string DAO Name of object we're evaluating.
1359 * @id int Id of object
1360 * @match array Associative array of field name => expected value. Empty if asserting
1361 * that a DELETE occurred
1362 * @delete boolean True if we're checking that a DELETE action occurred.
1364 function assertDBState($daoName, $id, $match, $delete = FALSE) {
1365 if (!self
::checkDoLocalDBTest()) {
1369 return CiviDBAssert
::assertDBState($this, $daoName, $id, $match, $delete);
1372 // Request a record from the DB by seachColumn+searchValue. Success if a record is found.
1373 function assertDBNotNull($daoName, $searchValue, $returnColumn, $searchColumn, $message) {
1374 if (!self
::checkDoLocalDBTest()) {
1378 return CiviDBAssert
::assertDBNotNull($this, $daoName, $searchValue, $returnColumn, $searchColumn, $message);
1381 // Request a record from the DB by seachColumn+searchValue. Success if returnColumn value is NULL.
1382 function assertDBNull($daoName, $searchValue, $returnColumn, $searchColumn, $message) {
1383 if (!self
::checkDoLocalDBTest()) {
1387 return CiviDBAssert
::assertDBNull($this, $daoName, $searchValue, $returnColumn, $searchColumn, $message);
1390 // Request a record from the DB by id. Success if row not found.
1391 function assertDBRowNotExist($daoName, $id, $message) {
1392 if (!self
::checkDoLocalDBTest()) {
1396 return CiviDBAssert
::assertDBRowNotExist($this, $daoName, $id, $message);
1399 // Compare a single column value in a retrieved DB record to an expected value
1400 function assertDBCompareValue($daoName, $searchValue, $returnColumn, $searchColumn,
1401 $expectedValue, $message
1403 if (!self
::checkDoLocalDBTest()) {
1407 return CiviDBAssert
::assertDBCompareValue($daoName, $searchValue, $returnColumn, $searchColumn,
1408 $expectedValue, $message
1412 // Compare all values in a single retrieved DB record to an array of expected values
1413 function assertDBCompareValues($daoName, $searchParams, $expectedValues) {
1414 if (!self
::checkDoLocalDBTest()) {
1418 return CiviDBAssert
::assertDBCompareValues($this, $daoName, $searchParams, $expectedValues);
1421 function assertAttributesEquals(&$expectedValues, &$actualValues) {
1422 if (!self
::checkDoLocalDBTest()) {
1426 return CiviDBAssert
::assertAttributesEquals($expectedValues, $actualValues);
1429 function assertType($expected, $actual, $message = '') {
1430 return $this->assertInternalType($expected, $actual, $message);
1434 * Add new Financial Account
1436 function _testAddFinancialAccount($financialAccountTitle,
1437 $financialAccountDescription = FALSE,
1438 $accountingCode = FALSE,
1440 $financialAccountType = FALSE,
1441 $taxDeductible = FALSE,
1448 $this->openCiviPage("admin/financial/financialAccount", "reset=1");
1450 $this->click("link=Add Financial Account");
1451 $this->waitForElementPresent('_qf_FinancialAccount_cancel-botttom');
1453 // Financial Account Name
1454 $this->type('name', $financialAccountTitle);
1456 // Financial Description
1457 if ($financialAccountDescription) {
1458 $this->type('description', $financialAccountDescription);
1462 if ($accountingCode) {
1463 $this->type('accounting_code', $accountingCode);
1466 // Autofill Organization
1468 $this->webtestOrganisationAutocomplete($firstName);
1471 // Financial Account Type
1472 if ($financialAccountType) {
1473 $this->select('financial_account_type_id', "label={$financialAccountType}");
1476 // Is Tax Deductible
1477 if ($taxDeductible) {
1478 $this->check('is_deductible');
1481 $this->uncheck('is_deductible');
1485 $this->check('is_active');
1488 $this->uncheck('is_active');
1492 $this->check('is_tax');
1495 $this->uncheck('is_tax');
1499 $this->type('tax_rate', $taxRate);
1504 $this->check('is_default');
1507 $this->uncheck('is_default');
1509 $this->click('_qf_FinancialAccount_next-botttom');
1510 $this->waitForPageToLoad($this->getTimeoutMsec());
1514 * Edit Financial Account
1516 function _testEditFinancialAccount($editfinancialAccount,
1517 $financialAccountTitle = FALSE,
1518 $financialAccountDescription = FALSE,
1519 $accountingCode = FALSE,
1521 $financialAccountType = FALSE,
1522 $taxDeductible = FALSE,
1529 $this->openCiviPage("admin/financial/financialAccount", "reset=1");
1532 $this->waitForElementPresent("xpath=//table/tbody//tr/td[1][text()='{$editfinancialAccount}']/../td[9]/span/a[text()='Edit']");
1533 $this->clickLink("xpath=//table/tbody//tr/td[1][text()='{$editfinancialAccount}']/../td[9]/span/a[text()='Edit']", '_qf_FinancialAccount_cancel-botttom');
1535 // Change Financial Account Name
1536 if ($financialAccountTitle) {
1537 $this->type('name', $financialAccountTitle);
1540 // Financial Description
1541 if ($financialAccountDescription) {
1542 $this->type('description', $financialAccountDescription);
1546 if ($accountingCode) {
1547 $this->type('accounting_code', $accountingCode);
1550 // Autofill Edit Organization
1552 $this->webtestOrganisationAutocomplete($firstName);
1555 // Financial Account Type
1556 if ($financialAccountType) {
1557 $this->select('financial_account_type_id', "label={$financialAccountType}");
1560 // Is Tax Deductible
1561 if ($taxDeductible) {
1562 $this->check('is_deductible');
1565 $this->uncheck('is_deductible');
1570 $this->check('is_tax');
1573 $this->uncheck('is_tax');
1578 $this->type('tax_rate', $taxRate);
1583 $this->check('is_default');
1586 $this->uncheck('is_default');
1591 $this->check('is_active');
1594 $this->uncheck('is_active');
1596 $this->click('_qf_FinancialAccount_next-botttom');
1597 $this->waitForPageToLoad($this->getTimeoutMsec());
1601 * Delete Financial Account
1603 function _testDeleteFinancialAccount($financialAccountTitle) {
1604 $this->click("xpath=//table/tbody//tr/td[1][text()='{$financialAccountTitle}']/../td[9]/span/a[text()='Delete']");
1605 $this->waitForElementPresent('_qf_FinancialAccount_next-botttom');
1606 $this->click('_qf_FinancialAccount_next-botttom');
1607 $this->waitForElementPresent('link=Add Financial Account');
1608 $this->assertTrue($this->isTextPresent("Selected Financial Account has been deleted."));
1612 * Verify data after ADD and EDIT
1614 function _assertFinancialAccount($verifyData) {
1615 foreach ($verifyData as $key => $expectedValue) {
1616 $actualValue = $this->getValue($key);
1617 if ($key == 'parent_financial_account') {
1618 $this->assertTrue((bool) preg_match("/^{$expectedValue}/", $actualValue));
1621 $this->assertEquals($expectedValue, $actualValue);
1626 function _assertSelectVerify($verifySelectFieldData) {
1627 foreach ($verifySelectFieldData as $key => $expectedvalue) {
1628 $actualvalue = $this->getSelectedLabel($key);
1629 $this->assertEquals($expectedvalue, $actualvalue);
1633 function addeditFinancialType($financialType, $option = 'new') {
1634 $this->openCiviPage("admin/financial/financialType", "reset=1");
1636 if ($option == 'Delete') {
1637 $this->click("xpath=id('ltype')/div/table/tbody/tr/td[1][text()='$financialType[name]']/../td[7]/span[2]");
1638 $this->waitForElementPresent("css=span.btn-slide-active");
1639 $this->click("xpath=id('ltype')/div/table/tbody/tr/td[1][text()='$financialType[name]']/../td[7]/span[2]/ul/li[2]/a");
1640 $this->waitForElementPresent("_qf_FinancialType_next");
1641 $this->click("_qf_FinancialType_next");
1642 $this->waitForPageToLoad($this->getTimeoutMsec());
1643 $this->assertTrue($this->isTextPresent('Selected financial type has been deleted.'), 'Missing text: ' . 'Selected financial type has been deleted.');
1646 if ($option == 'new') {
1647 $this->click("link=Add Financial Type");
1650 $this->click("xpath=id('ltype')/div/table/tbody/tr/td[1][text()='$financialType[oldname]']/../td[7]/span/a[text()='Edit']");
1652 $this->waitForPageToLoad($this->getTimeoutMsec());
1653 $this->type('name', $financialType['name']);
1654 if ($option == 'new') {
1655 $this->type('description', $financialType['name'] . ' description');
1658 if ($financialType['is_reserved']) {
1659 $this->check('is_reserved');
1662 $this->uncheck('is_reserved');
1665 if ($financialType['is_deductible']) {
1666 $this->check('is_deductible');
1669 $this->uncheck('is_deductible');
1672 $this->click('_qf_FinancialType_next');
1673 $this->waitForPageToLoad($this->getTimeoutMsec());
1674 if ($option == 'new') {
1675 $text = "Your Financial '{$financialType['name']}' Type has been created, along with a corresponding income account '{$financialType['name']}'. That income account, along with standard financial accounts 'Accounts Receivable', 'Banking Fees' and 'Premiums' have been linked to the financial type. You may edit or replace those relationships here.";
1678 $text = "The financial type '{$financialType['name']}' has been saved.";
1680 $this->assertTrue($this->isTextPresent($text), 'Missing text: ' . $text);
1684 * Give the specified permissions
1685 * Note: this function logs in as 'admin' (logging out if necessary)
1687 function changePermissions($permission) {
1688 $this->webtestLogin('admin');
1689 $this->open("{$this->sboxPath}admin/people/permissions");
1690 $this->waitForElementPresent('edit-submit');
1691 foreach ((array) $permission as $perm) {
1692 $this->check($perm);
1694 $this->click('edit-submit');
1695 $this->waitForPageToLoad($this->getTimeoutMsec());
1696 $this->assertTrue($this->isTextPresent('The changes have been saved.'));
1699 function addProfile($profileTitle, $profileFields) {
1700 $this->openCiviPage('admin/uf/group', "reset=1");
1702 $this->click('link=Add Profile');
1704 // Add membership custom data field to profile
1705 $this->waitForElementPresent('_qf_Group_cancel-bottom');
1706 $this->type('title', $profileTitle);
1707 $this->click('_qf_Group_next-bottom');
1709 $this->waitForElementPresent('_qf_Field_cancel-bottom');
1710 //$this->assertTrue($this->isTextPresent("Your CiviCRM Profile '{$profileTitle}' has been added. You can add fields to this profile now."));
1712 foreach ($profileFields as $field) {
1713 $this->waitForElementPresent('field_name_0');
1714 // $this->waitForPageToLoad($this->getTimeoutMsec());
1715 $this->click("id=field_name_0");
1716 $this->select("id=field_name_0", "label=" . $field['type']);
1717 $this->waitForElementPresent('field_name_1');
1718 $this->click("id=field_name_1");
1719 $this->select("id=field_name_1", "label=" . $field['name']);
1720 $this->waitForElementPresent('label');
1721 $this->type("id=label", $field['label']);
1722 $this->click("id=_qf_Field_next_new-top");
1723 $this->waitForPageToLoad($this->getTimeoutMsec());
1724 //$this->assertTrue($this->isTextPresent("Your CiviCRM Profile Field '" . $field['name'] . "' has been saved to '" . $profileTitle . "'. You can add another profile field."));
1728 function addPremium($name, $sku, $amount, $price, $cost, $financialType) {
1729 $this->waitForElementPresent("_qf_ManagePremiums_upload-bottom");
1730 $this->type("name", $name);
1731 $this->type("sku", $sku);
1732 $this->click("CIVICRM_QFID_noImage_16");
1733 $this->type("min_contribution", $amount);
1734 $this->type("price", $price);
1735 $this->type("cost", $cost);
1736 if ($financialType) {
1737 $this->select("financial_type_id", "label={$financialType}");
1739 $this->click("_qf_ManagePremiums_upload-bottom");
1740 $this->waitForPageToLoad($this->getTimeoutMsec());
1743 function addPaymentInstrument($label, $financialAccount) {
1744 $this->openCiviPage('admin/options/payment_instrument', 'group=payment_instrument&action=add&reset=1', "_qf_Options_next-bottom");
1745 $this->type("label", $label);
1746 $this->select("financial_account_id", "value=$financialAccount");
1747 $this->click("_qf_Options_next-bottom");
1748 $this->waitForPageToLoad($this->getTimeoutMsec());
1752 * Ensure we have a default mailbox set up for CiviMail
1754 function setupDefaultMailbox() {
1755 $this->openCiviPage('admin/mailSettings', 'action=update&id=1&reset=1');
1756 // Check if it hasn't already been set up
1757 if (!$this->getSelectedValue('protocol')) {
1758 $this->type('name', 'Test Domain');
1759 $this->select('protocol', "IMAP");
1760 $this->type('server', 'localhost');
1761 $this->type('domain', 'example.com');
1762 $this->click('_qf_MailSettings_next-top');
1763 $this->waitForPageToLoad($this->getTimeoutMsec());
1768 * Determine the default time-out in milliseconds.
1770 * @return string, timeout expressed in milliseconds
1772 function getTimeoutMsec() {
1773 // note: existing local versions of CiviSeleniumSettings may not declare $timeout, so use @
1774 $timeout = ($this->settings
&& @$this->settings
->timeout
) ?
($this->settings
->timeout
* 1000) : 30000;
1775 return (string) $timeout; // don't know why, but all our old code used a string
1780 * checks custom fields rendering / loading properly on the fly WRT entity passed as parameter
1783 * @param array $customSets custom sets i.e entity wise sets want to be created and checked
1784 e.g $customSets = array(array('entity' => 'Contribution', 'subEntity' => 'Donation',
1785 'triggerElement' => $triggerElement))
1786 array $triggerElement: the element which is responsible for custom group to load
1788 which uses the entity info as its selection value
1789 * @param array $pageUrl the url which on which the ajax custom group load takes place
1790 * @param $beforeTriggering code to execute before actual element triggering
1793 function customFieldSetLoadOnTheFlyCheck($customSets, $pageUrl, $beforeTriggering = NULL) {
1794 //add the custom set
1795 $return = $this->addCustomGroupField($customSets);
1797 $this->openCiviPage($pageUrl['url'], $pageUrl['args']);
1799 foreach($return as $values) {
1800 foreach ($values as $entityType => $customData) {
1801 //initiate necessary variables
1802 list($entity, $entityData) = explode('_', $entityType);
1803 $elementType = CRM_Utils_Array
::value('type', $customData['triggerElement'], 'select');
1804 $elementName = CRM_Utils_Array
::value('name', $customData['triggerElement']);
1805 if ($beforeTriggering) {
1806 call_user_func($beforeTriggering);
1808 if ($elementType == 'select') {
1809 //reset the select box, so triggering of ajax only happens
1810 //WRT input of value in this function
1811 $this->select($elementName, "index=0");
1813 if (!empty($entityData)) {
1814 if ($elementType == 'select') {
1815 $this->select($elementName, "label=regexp:{$entityData}");
1817 elseif ($elementType == 'checkbox') {
1818 $val = explode(',', $entityData);
1819 foreach($val as $v) {
1820 $checkId = $this->getAttribute("xpath=//label[text()='{$v}']/@for");
1821 $this->check($checkId);
1826 //sleep method is used as to wait for custom field div to load -
1827 //we cant use wait for the div element as we are asserting for the same,
1828 //so wait for some time till the div loads
1831 //checking for proper custom data which is loading through ajax
1832 $this->assertElementPresent("xpath=//div[@id='{$customData['cgtitle']}'][@class='crm-accordion-body']",
1833 "The on the fly custom group has not been rendered for entity : {$entity} => {$entityData}");
1834 $this->assertElementPresent("xpath=//div[@id='{$customData['cgtitle']}'][@class='crm-accordion-body']/table/tbody/tr/td[2]/input",
1835 "The on the fly custom group field is not present for entity : {$entity} => {$entityData}");
1840 function addCustomGroupField($customSets) {
1841 foreach ($customSets as $customSet) {
1842 $this->openCiviPage("admin/custom/group", "action=add&reset=1");
1844 //fill custom group title
1845 $customGroupTitle = "webtest_for_ajax_cd" . substr(sha1(rand()), 0, 4);
1846 $this->click("title");
1847 $this->type("title", $customGroupTitle);
1849 //custom group extends
1850 $this->click("extends_0");
1851 $this->select("extends_0", "value={$customSet['entity']}");
1852 if (!empty($customSet['subEntity'])) {
1853 $this->addSelection("extends_1", "label={$customSet['subEntity']}");
1857 $this->uncheck('collapse_display');
1860 $this->click('_qf_Group_next-bottom');
1861 $this->waitForElementPresent('_qf_Field_cancel-bottom');
1863 //Is custom group created?
1864 $this->waitForText('crm-notification-container', "Your custom field set '{$customGroupTitle}' has been added.");
1865 $gid = $this->urlArg('gid');
1867 $fieldLabel = "custom_field_for_{$customSet['entity']}_{$customSet['subEntity']}" . substr(sha1(rand()), 0, 4);
1868 $this->type('label', $fieldLabel);
1869 $this->click('_qf_Field_next-bottom');
1870 $this->waitForPageToLoad($this->getTimeoutMsec());
1871 $customGroupTitle = preg_replace('/\s/', '_', trim($customGroupTitle));
1874 "{$customSet['entity']}_{$customSet['subEntity']}" => array('cgtitle' => $customGroupTitle, 'gid' => $gid, 'triggerElement' => $customSet['triggerElement']));