* <http://www.gnu.org/licenses/>.
*/
+use Civi\Payment\System;
+
/**
* Include configuration
*/
/**
* Base class for CiviCRM unit tests
*
+ * This class supports two (mutually-exclusive) techniques for cleaning up test data. Subclasses
+ * may opt for one or neither:
+ *
+ * 1. quickCleanup() is a helper which truncates a series of tables. Call quickCleanup()
+ * as part of setUp() and/or tearDown(). quickCleanup() is thorough - but it can
+ * be cumbersome to use (b/c you must identify the tables to cleanup) and slow to execute.
+ * 2. useTransaction() executes the test inside a transaction. It's easier to use
+ * (because you don't need to identify specific tables), but it doesn't work for tests
+ * which manipulate schema or truncate data -- and could behave inconsistently
+ * for tests which specifically examine DB transactions.
+ *
* Common functions for unit tests
* @package CiviCRM
*/
class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase {
/**
- * api version - easier to override than just a define
+ * Api version - easier to override than just a define
*/
protected $_apiversion = API_LATEST_VERSION;
/**
- * Database has been initialized
+ * Database has been initialized.
*
* @var boolean
*/
private static $dbInit = FALSE;
/**
- * Database connection
+ * Database connection.
*
* @var PHPUnit_Extensions_Database_DB_IDatabaseConnection
*/
protected $_dbconn;
/**
- * The database name
+ * The database name.
*
* @var string
*/
static protected $_dbName;
/**
- * Track tables we have modified during a test
+ * Track tables we have modified during a test.
*/
protected $_tablesToTruncate = array();
public $DBResetRequired = TRUE;
/**
- * Constructor
+ * @var CRM_Core_Transaction|NULL
+ */
+ private $tx = NULL;
+
+ /**
+ * @var CRM_Utils_Hook_UnitTests hookClass
+ * example of setting a method for a hook
+ * $this->hookClass->setHook('civicrm_aclWhereClause', array($this, 'aclWhereHookAllResults'));
+ */
+ public $hookClass = NULL;
+
+ /**
+ * @var array common values to be re-used multiple times within a class - usually to create the relevant entity
+ */
+ protected $_params = array();
+
+ /**
+ * @var CRM_Extension_System
+ */
+ protected $origExtensionSystem;
+
+ /**
+ * Constructor.
*
* Because we are overriding the parent class constructor, we
* need to show the same arguments as exist in the constructor of
* ReflectionClass of the Test class and checks the constructor
* of that class to decide how to set up the test.
*
- * @param string $name
- * @param array $data
- * @param string $dataName
+ * @param string $name
+ * @param array $data
+ * @param string $dataName
*/
- function __construct($name = NULL, array$data = array(), $dataName = '') {
+ public function __construct($name = NULL, array$data = array(), $dataName = '') {
parent::__construct($name, $data, $dataName);
// we need full error reporting
// also load the class loader
require_once 'CRM/Core/ClassLoader.php';
CRM_Core_ClassLoader::singleton()->register();
- if (function_exists('_civix_phpunit_setUp')) { // FIXME: loosen coupling
+ if (function_exists('_civix_phpunit_setUp')) {
+ // FIXME: loosen coupling
_civix_phpunit_setUp();
}
}
+ /**
+ * Override to run the test and assert its state.
+ * @return mixed
+ * @throws \Exception
+ * @throws \PHPUnit_Framework_IncompleteTest
+ * @throws \PHPUnit_Framework_SkippedTest
+ */
+ protected function runTest() {
+ try {
+ return parent::runTest();
+ }
+ catch (PEAR_Exception $e) {
+ // PEAR_Exception has metadata in funny places, and PHPUnit won't log it nicely
+ throw new Exception(\CRM_Core_Error::formatTextException($e), $e->getCode());
+ }
+ }
+
/**
* @return bool
*/
- function requireDBReset() {
+ public function requireDBReset() {
return $this->DBResetRequired;
}
/**
* @return string
*/
- static function getDBName() {
+ public static function getDBName() {
$dbName = !empty($GLOBALS['mysql_db']) ? $GLOBALS['mysql_db'] : 'civicrm_tests_dev';
return $dbName;
}
/**
- * Create database connection for this instance
+ * Create database connection for this instance.
*
* Initialize the test database if it hasn't been initialized
*
}
/**
- * Required implementation of abstract method
+ * Required implementation of abstract method.
*/
protected function getDataSet() {
}
/**
* @param bool $perClass
* @param null $object
- * @return bool TRUE if the populate logic runs; FALSE if it is skipped
+ * @return bool
+ * TRUE if the populate logic runs; FALSE if it is skipped
*/
protected static function _populateDB($perClass = FALSE, &$object = NULL) {
civicrm_api('system', 'flush', array('version' => 3, 'triggers' => 1));
CRM_Core_BAO_ConfigSetting::setEnabledComponents(array(
- 'CiviEvent', 'CiviContribute', 'CiviMember', 'CiviMail', 'CiviReport', 'CiviPledge'
+ 'CiviEvent',
+ 'CiviContribute',
+ 'CiviMember',
+ 'CiviMail',
+ 'CiviReport',
+ 'CiviPledge',
));
return TRUE;
}
/**
- * Common setup functions for all unit tests
+ * Common setup functions for all unit tests.
*/
protected function setUp() {
$session = CRM_Core_Session::singleton();
$session->set('userID', NULL);
- CRM_Utils_Hook::singleton(TRUE);
$this->errorScope = CRM_Core_TemporaryErrorScope::useException(); // REVERT
// Use a temporary file for STDIN
$GLOBALS['stdin'] = tmpfile();
// when running unit tests, use mockup user framework
$config->setUserFramework('UnitTests');
-
+ $this->hookClass = CRM_Utils_Hook::singleton(TRUE);
// also fix the fatal error handler to throw exceptions,
// rather than exit
$config->fatalErrorHandler = 'CiviUnitTestCase_fatalErrorHandler';
}
/**
- * Read everything from the datasets directory and insert into the db
+ * Read everything from the datasets directory and insert into the db.
*/
public function loadAllFixtures() {
$fixturesDir = __DIR__ . '/../../fixtures';
}
/**
- * emulate a logged in user since certain functions use that
+ * Emulate a logged in user since certain functions use that.
* value to store a record in the DB (like activity)
* CRM-8180
+ *
+ * @return int
+ * Contact ID of the created user.
*/
public function createLoggedInUser() {
$params = array(
'contact_type' => 'Individual',
);
$contactID = $this->individualCreate($params);
+ $this->callAPISuccess('UFMatch', 'create', array(
+ 'contact_id' => $contactID,
+ 'uf_name' => 'superman',
+ 'uf_id' => 6,
+ ));
$session = CRM_Core_Session::singleton();
$session->set('userID', $contactID);
+ return $contactID;
}
public function cleanDB() {
}
/**
- * Common teardown functions for all unit tests
+ * Create default domain contacts for the two domains added during test class.
+ * database population.
+ */
+ public function createDomainContacts() {
+ $default_domain_contact = $this->organizationCreate();
+ $second_domain_contact = $this->organizationCreate();
+ }
+
+ /**
+ * Common teardown functions for all unit tests.
*/
protected function tearDown() {
error_reporting(E_ALL & ~E_NOTICE);
+ CRM_Utils_Hook::singleton()->reset();
+ $this->hookClass->reset();
$session = CRM_Core_Session::singleton();
$session->set('userID', NULL);
- $tablesToTruncate = array('civicrm_contact');
- $this->quickCleanup($tablesToTruncate);
+
+ if ($this->tx) {
+ $this->tx->rollback()->commit();
+ $this->tx = NULL;
+
+ CRM_Core_Transaction::forceRollbackIfEnabled();
+ \Civi\Core\Transaction\Manager::singleton(TRUE);
+ }
+ else {
+ CRM_Core_Transaction::forceRollbackIfEnabled();
+ \Civi\Core\Transaction\Manager::singleton(TRUE);
+
+ $tablesToTruncate = array('civicrm_contact', 'civicrm_uf_match');
+ $this->quickCleanup($tablesToTruncate);
+ $this->createDomainContacts();
+ }
+
$this->cleanTempDirs();
$this->unsetExtensionSystem();
+ $this->clearOutputBuffer();
}
/**
* FIXME: Maybe a better way to do it
*/
- function foreignKeyChecksOff() {
+ public function foreignKeyChecksOff() {
self::$utils = new Utils($GLOBALS['mysql_host'],
$GLOBALS['mysql_port'],
$GLOBALS['mysql_user'],
return TRUE;
}
- function foreignKeyChecksOn() {
+ public function foreignKeyChecksOn() {
// FIXME: might not be needed if previous fixme implemented
}
/**
- * Generic function to compare expected values after an api call to retrieved
+ * Generic function to compare expected values after an api call to retrieved.
* DB values.
*
* @daoName string DAO Name of object we're evaluating.
* @match array Associative array of field name => expected value. Empty if asserting
* that a DELETE occurred
* @delete boolean True if we're checking that a DELETE action occurred.
+ * @param $daoName
+ * @param $id
+ * @param $match
+ * @param bool $delete
+ * @throws \PHPUnit_Framework_AssertionFailedError
*/
- function assertDBState($daoName, $id, $match, $delete = FALSE) {
+ public function assertDBState($daoName, $id, $match, $delete = FALSE) {
if (empty($id)) {
// adding this here since developers forget to check for an id
// and hence we get the first value in the db
// Otherwise check matches of DAO field values against expected values in $match.
if ($object->find(TRUE)) {
- $fields = & $object->fields();
+ $fields = &$object->fields();
foreach ($fields as $name => $value) {
$dbName = $value['name'];
if (isset($match[$name])) {
}
}
- // Request a record from the DB by seachColumn+searchValue. Success if a record is found.
/**
- * @param $daoName
+ * Request a record from the DB by seachColumn+searchValue. Success if a record is found.
+ * @param string $daoName
* @param $searchValue
* @param $returnColumn
* @param $searchColumn
* @return null|string
* @throws PHPUnit_Framework_AssertionFailedError
*/
- function assertDBNotNull($daoName, $searchValue, $returnColumn, $searchColumn, $message) {
+ public function assertDBNotNull($daoName, $searchValue, $returnColumn, $searchColumn, $message) {
if (empty($searchValue)) {
$this->fail("empty value passed to assertDBNotNull");
}
return $value;
}
- // Request a record from the DB by seachColumn+searchValue. Success if returnColumn value is NULL.
/**
- * @param $daoName
+ * Request a record from the DB by seachColumn+searchValue. Success if returnColumn value is NULL.
+ * @param string $daoName
* @param $searchValue
* @param $returnColumn
* @param $searchColumn
* @param $message
*/
- function assertDBNull($daoName, $searchValue, $returnColumn, $searchColumn, $message) {
+ public function assertDBNull($daoName, $searchValue, $returnColumn, $searchColumn, $message) {
$value = CRM_Core_DAO::getFieldValue($daoName, $searchValue, $returnColumn, $searchColumn, TRUE);
$this->assertNull($value, $message);
}
- // Request a record from the DB by id. Success if row not found.
/**
- * @param $daoName
- * @param $id
+ * Request a record from the DB by id. Success if row not found.
+ * @param string $daoName
+ * @param int $id
* @param null $message
*/
- function assertDBRowNotExist($daoName, $id, $message = NULL) {
+ public function assertDBRowNotExist($daoName, $id, $message = NULL) {
$message = $message ? $message : "$daoName (#$id) should not exist";
$value = CRM_Core_DAO::getFieldValue($daoName, $id, 'id', 'id', TRUE);
$this->assertNull($value, $message);
}
- // Request a record from the DB by id. Success if row not found.
/**
- * @param $daoName
- * @param $id
+ * Request a record from the DB by id. Success if row not found.
+ * @param string $daoName
+ * @param int $id
* @param null $message
*/
- function assertDBRowExist($daoName, $id, $message = NULL) {
+ public function assertDBRowExist($daoName, $id, $message = NULL) {
$message = $message ? $message : "$daoName (#$id) should exist";
$value = CRM_Core_DAO::getFieldValue($daoName, $id, 'id', 'id', TRUE);
$this->assertEquals($id, $value, $message);
}
- // Compare a single column value in a retrieved DB record to an expected value
/**
- * @param $daoName
+ * Compare a single column value in a retrieved DB record to an expected value.
+ * @param string $daoName
* @param $searchValue
* @param $returnColumn
* @param $searchColumn
* @param $expectedValue
* @param $message
*/
- function assertDBCompareValue($daoName, $searchValue, $returnColumn, $searchColumn,
- $expectedValue, $message
+ public function assertDBCompareValue(
+ $daoName, $searchValue, $returnColumn, $searchColumn,
+ $expectedValue, $message
) {
$value = CRM_Core_DAO::getFieldValue($daoName, $searchValue, $returnColumn, $searchColumn, TRUE);
$this->assertEquals($value, $expectedValue, $message);
}
- // Compare all values in a single retrieved DB record to an array of expected values
/**
- * @param $daoName
- * @param $searchParams
+ * Compare all values in a single retrieved DB record to an array of expected values.
+ * @param string $daoName
+ * @param array $searchParams
* @param $expectedValues
*/
- function assertDBCompareValues($daoName, $searchParams, $expectedValues) {
+ public function assertDBCompareValues($daoName, $searchParams, $expectedValues) {
//get the values from db
$dbValues = array();
CRM_Core_DAO::commonRetrieve($daoName, $searchParams, $dbValues);
}
/**
- * Assert that a SQL query returns a given value
+ * Assert that a SQL query returns a given value.
*
* The first argument is an expected value. The remaining arguments are passed
* to CRM_Core_DAO::singleValueQuery
*
* Example: $this->assertSql(2, 'select count(*) from foo where foo.bar like "%1"',
* array(1 => array("Whiz", "String")));
+ * @param $expected
+ * @param $query
+ * @param array $params
+ * @param string $message
*/
- function assertDBQuery($expected, $query, $params = array()) {
+ public function assertDBQuery($expected, $query, $params = array(), $message = '') {
+ if ($message) {
+ $message .= ': ';
+ }
$actual = CRM_Core_DAO::singleValueQuery($query, $params);
$this->assertEquals($expected, $actual,
- sprintf('expected=[%s] actual=[%s] query=[%s]',
- $expected, $actual, CRM_Core_DAO::composeQuery($query, $params, FALSE)
+ sprintf('%sexpected=[%s] actual=[%s] query=[%s]',
+ $message, $expected, $actual, CRM_Core_DAO::composeQuery($query, $params, FALSE)
)
);
}
* @param array $expected
* @param array $actual
*/
- function assertTreeEquals($expected, $actual) {
+ public function assertTreeEquals($expected, $actual) {
$e = array();
$a = array();
CRM_Utils_Array::flatten($expected, $e, '', ':::');
}
/**
- * Assert that two numbers are approximately equal
+ * Assert that two numbers are approximately equal.
*
* @param int|float $expected
* @param int|float $actual
* @param int|float $tolerance
* @param string $message
*/
- function assertApproxEquals($expected, $actual, $tolerance, $message = NULL) {
+ public function assertApproxEquals($expected, $actual, $tolerance, $message = NULL) {
if ($message === NULL) {
$message = sprintf("approx-equals: expected=[%.3f] actual=[%.3f] tolerance=[%.3f]", $expected, $actual, $tolerance);
}
}
/**
+ * Assert attributes are equal.
+ *
* @param $expectedValues
* @param $actualValues
- * @param null $message
+ * @param string $message
*
* @throws PHPUnit_Framework_AssertionFailedError
*/
- function assertAttributesEquals($expectedValues, $actualValues, $message = NULL) {
+ public function assertAttributesEquals($expectedValues, $actualValues, $message = NULL) {
foreach ($expectedValues as $paramName => $paramValue) {
if (isset($actualValues[$paramName])) {
- $this->assertEquals($paramValue, $actualValues[$paramName], "Value Mismatch On $paramName - value 1 is " . print_r($paramValue, TRUE) . " value 2 is " . print_r($actualValues[$paramName], TRUE) );
+ $this->assertEquals($paramValue, $actualValues[$paramName], "Value Mismatch On $paramName - value 1 is " . print_r($paramValue, TRUE) . " value 2 is " . print_r($actualValues[$paramName], TRUE));
}
else {
$this->fail("Attribute '$paramName' not present in actual array.");
* @param $key
* @param $list
*/
- function assertArrayKeyExists($key, &$list) {
+ public function assertArrayKeyExists($key, &$list) {
$result = isset($list[$key]) ? TRUE : FALSE;
$this->assertTrue($result, ts("%1 element exists?",
array(1 => $key)
* @param $key
* @param $list
*/
- function assertArrayValueNotNull($key, &$list) {
+ public function assertArrayValueNotNull($key, &$list) {
$this->assertArrayKeyExists($key, $list);
$value = isset($list[$key]) ? $list[$key] : NULL;
}
/**
- * check that api returned 'is_error' => 0
- * else provide full message
- * @param array $apiResult api result
- * @param string $prefix extra test to add to message
+ * Check that api returned 'is_error' => 0.
+ *
+ * @param array $apiResult
+ * Api result.
+ * @param string $prefix
+ * Extra test to add to message.
*/
- function assertAPISuccess($apiResult, $prefix = '') {
+ public function assertAPISuccess($apiResult, $prefix = '') {
if (!empty($prefix)) {
$prefix .= ': ';
}
$errorMessage = empty($apiResult['error_message']) ? '' : " " . $apiResult['error_message'];
- if(!empty($apiResult['debug_information'])) {
+ if (!empty($apiResult['debug_information'])) {
$errorMessage .= "\n " . print_r($apiResult['debug_information'], TRUE);
}
- if(!empty($apiResult['trace'])){
+ if (!empty($apiResult['trace'])) {
$errorMessage .= "\n" . print_r($apiResult['trace'], TRUE);
}
$this->assertEquals(0, $apiResult['is_error'], $prefix . $errorMessage);
}
/**
- * check that api returned 'is_error' => 1
- * else provide full message
+ * Check that api returned 'is_error' => 1.
*
- * @param array $apiResult api result
- * @param string $prefix extra test to add to message
+ * @param array $apiResult
+ * Api result.
+ * @param string $prefix
+ * Extra test to add to message.
* @param null $expectedError
*/
- function assertAPIFailure($apiResult, $prefix = '', $expectedError = NULL) {
+ public function assertAPIFailure($apiResult, $prefix = '', $expectedError = NULL) {
if (!empty($prefix)) {
$prefix .= ': ';
}
- if($expectedError && !empty($apiResult['is_error'])){
- $this->assertEquals($expectedError, $apiResult['error_message'], 'api error message not as expected' . $prefix );
+ if ($expectedError && !empty($apiResult['is_error'])) {
+ $this->assertEquals($expectedError, $apiResult['error_message'], 'api error message not as expected' . $prefix);
}
$this->assertEquals(1, $apiResult['is_error'], "api call should have failed but it succeeded " . $prefix . (print_r($apiResult, TRUE)));
$this->assertNotEmpty($apiResult['error_message']);
* @param $actual
* @param string $message
*/
- function assertType($expected, $actual, $message = '') {
+ public function assertType($expected, $actual, $message = '') {
return $this->assertInternalType($expected, $actual, $message);
}
/**
- * check that a deleted item has been deleted
+ * Check that a deleted item has been deleted.
+ *
+ * @param $entity
+ * @param $id
*/
- function assertAPIDeleted($entity, $id) {
+ public function assertAPIDeleted($entity, $id) {
$this->callAPISuccess($entity, 'getcount', array('id' => $id), 0);
}
/**
- * check that api returned 'is_error' => 1
+ * Check that api returned 'is_error' => 1
* else provide full message
- * @param $result
+ * @param array $result
* @param $expected
* @param array $valuesToExclude
- * @param string $prefix extra test to add to message
- * @internal param array $apiResult api result
+ * @param string $prefix
+ * Extra test to add to message.
*/
- function assertAPIArrayComparison($result, $expected, $valuesToExclude = array(), $prefix = '') {
+ public function assertAPIArrayComparison($result, $expected, $valuesToExclude = array(), $prefix = '') {
$valuesToExclude = array_merge($valuesToExclude, array('debug', 'xdebug', 'sequential'));
foreach ($valuesToExclude as $value) {
- if(isset($result[$value])) {
+ if (isset($result[$value])) {
unset($result[$value]);
}
- if(isset($expected[$value])) {
+ if (isset($expected[$value])) {
unset($expected[$value]);
}
}
*
* @param $entity
* @param $action
- * @param $params
+ * @param array $params
* @return array|int
*/
- function civicrm_api($entity, $action, $params) {
+ public function civicrm_api($entity, $action, $params) {
return civicrm_api($entity, $action, $params);
}
/**
- * This function exists to wrap api functions
+ * Create a batch of external API calls which can
+ * be executed concurrently.
+ *
+ * @code
+ * $calls = $this->createExternalAPI()
+ * ->addCall('Contact', 'get', ...)
+ * ->addCall('Contact', 'get', ...)
+ * ...
+ * ->run()
+ * ->getResults();
+ * @endcode
+ *
+ * @return \Civi\API\ExternalBatch
+ * @throws PHPUnit_Framework_SkippedTestError
+ */
+ public function createExternalAPI() {
+ global $civicrm_root;
+ $defaultParams = array(
+ 'version' => $this->_apiversion,
+ 'debug' => 1,
+ );
+
+ $calls = new \Civi\API\ExternalBatch($defaultParams);
+ $calls->setSettingsPath("$civicrm_root/tests/phpunit/CiviTest/civicrm.settings.cli.php");
+
+ if (!$calls->isSupported()) {
+ $this->markTestSkipped('The test relies on Civi\API\ExternalBatch. This is unsupported in the local environment.');
+ }
+
+ return $calls;
+ }
+
+ /**
+ * wrap api functions.
* so we can ensure they succeed & throw exceptions without litterering the test with checks
*
* @param string $entity
* @param string $action
* @param array $params
- * @param mixed $checkAgainst optional value to check result against, implemented for getvalue,
+ * @param mixed $checkAgainst
+ * Optional value to check result against, implemented for getvalue,.
* getcount, getsingle. Note that for getvalue the type is checked rather than the value
* for getsingle the array is compared against an array passed in - the id is not compared (for
* better or worse )
*
* @return array|int
*/
- function callAPISuccess($entity, $action, $params, $checkAgainst = NULL) {
+ public function callAPISuccess($entity, $action, $params, $checkAgainst = NULL) {
$params = array_merge(array(
'version' => $this->_apiversion,
'debug' => 1,
$params
);
switch (strtolower($action)) {
- case 'getvalue' :
+ case 'getvalue':
return $this->callAPISuccessGetValue($entity, $params, $checkAgainst);
- case 'getsingle' :
+
+ case 'getsingle':
return $this->callAPISuccessGetSingle($entity, $params, $checkAgainst);
- case 'getcount' :
- return $this->callAPISuccessGetCount($entity, $params, $checkAgainst);
+
+ case 'getcount':
+ return $this->callAPISuccessGetCount($entity, $params, $checkAgainst);
}
$result = $this->civicrm_api($entity, $action, $params);
$this->assertAPISuccess($result, "Failure in api call for $entity $action");
*
* @param string $entity
* @param array $params
- * @param string $type - per http://php.net/manual/en/function.gettype.php possible types
- * - boolean
- * - integer
- * - double
- * - string
- * - array
- * - object
+ * @param string $type
+ * Per http://php.net/manual/en/function.gettype.php possible types.
+ * - boolean
+ * - integer
+ * - double
+ * - string
+ * - array
+ * - object
*
* @return array|int
*/
- function callAPISuccessGetValue($entity, $params, $type = NULL) {
+ public function callAPISuccessGetValue($entity, $params, $type = NULL) {
$params += array(
'version' => $this->_apiversion,
'debug' => 1,
);
$result = $this->civicrm_api($entity, 'getvalue', $params);
- if($type){
- if($type == 'integer'){
+ if ($type) {
+ if ($type == 'integer') {
// api seems to return integers as strings
$this->assertTrue(is_numeric($result), "expected a numeric value but got " . print_r($result, 1));
}
- else{
- $this->assertType($type, $result, "returned result should have been of type $type but was " );
+ else {
+ $this->assertType($type, $result, "returned result should have been of type $type but was ");
}
}
return $result;
*
* @param string $entity
* @param array $params
- * @param array $checkAgainst - array to compare result against
- * - boolean
- * - integer
- * - double
- * - string
- * - array
- * - object
+ * @param array $checkAgainst
+ * Array to compare result against.
+ * - boolean
+ * - integer
+ * - double
+ * - string
+ * - array
+ * - object
*
* @throws Exception
* @return array|int
*/
- function callAPISuccessGetSingle($entity, $params, $checkAgainst = NULL) {
+ public function callAPISuccessGetSingle($entity, $params, $checkAgainst = NULL) {
$params += array(
'version' => $this->_apiversion,
'debug' => 1,
);
$result = $this->civicrm_api($entity, 'getsingle', $params);
- if(!is_array($result) || !empty($result['is_error']) || isset($result['values'])) {
+ if (!is_array($result) || !empty($result['is_error']) || isset($result['values'])) {
throw new Exception('Invalid getsingle result' . print_r($result, TRUE));
}
- if($checkAgainst){
+ if ($checkAgainst) {
// @todo - have gone with the fn that unsets id? should we check id?
$this->checkArrayEquals($result, $checkAgainst);
}
* @param null $count
* @throws Exception
* @return array|int
- * @internal param string $type - per http://php.net/manual/en/function.gettype.php possible types
- * - boolean
- * - integer
- * - double
- * - string
- * - array
- * - object
- */
- function callAPISuccessGetCount($entity, $params, $count = NULL) {
+ */
+ public function callAPISuccessGetCount($entity, $params, $count = NULL) {
$params += array(
'version' => $this->_apiversion,
'debug' => 1,
);
$result = $this->civicrm_api($entity, 'getcount', $params);
- if(!is_integer($result) || !empty($result['is_error']) || isset($result['values'])) {
+ if (!is_int($result) || !empty($result['is_error']) || isset($result['values'])) {
throw new Exception('Invalid getcount result : ' . print_r($result, TRUE) . " type :" . gettype($result));
}
- if(is_int($count)){
- $this->assertEquals($count, $result, "incorect count returned from $entity getcount");
+ if (is_int($count)) {
+ $this->assertEquals($count, $result, "incorrect count returned from $entity getcount");
}
return $result;
}
/**
- * This function exists to wrap api functions
+ * This function exists to wrap api functions.
* so we can ensure they succeed, generate and example & throw exceptions without litterering the test with checks
*
* @param string $entity
* @param string $action
* @param array $params
- * @param string $function - pass this in to create a generated example
- * @param string $file - pass this in to create a generated example
+ * @param string $function
+ * Pass this in to create a generated example.
+ * @param string $file
+ * Pass this in to create a generated example.
* @param string $description
- * @param string|null $subfile
- * @param string|null $actionName
+ * @param string|null $exampleName
+ *
* @return array|int
*/
- function callAPIAndDocument($entity, $action, $params, $function, $file, $description = "", $subfile = NULL, $actionName = NULL){
+ public function callAPIAndDocument($entity, $action, $params, $function, $file, $description = "", $exampleName = NULL) {
$params['version'] = $this->_apiversion;
$result = $this->callAPISuccess($entity, $action, $params);
- $this->documentMe($params, $result, $function, $file, $description, $subfile, $actionName);
+ $this->documentMe($entity, $action, $params, $result, $function, $file, $description, $exampleName);
return $result;
}
/**
- * This function exists to wrap api functions
+ * This function exists to wrap api functions.
* so we can ensure they fail where expected & throw exceptions without litterering the test with checks
* @param string $entity
* @param string $action
* @param array $params
- * @param string $expectedErrorMessage error
+ * @param string $expectedErrorMessage
+ * Error.
* @param null $extraOutput
* @return array|int
*/
- function callAPIFailure($entity, $action, $params, $expectedErrorMessage = NULL, $extraOutput = NULL) {
+ public function callAPIFailure($entity, $action, $params, $expectedErrorMessage = NULL, $extraOutput = NULL) {
if (is_array($params)) {
$params += array(
'version' => $this->_apiversion,
* so the distinction between set
* up & tested functions is clearer
*
- * @return array api Result
+ * @return array
+ * api Result
*/
- public function createTestEntity(){
+ public function createTestEntity() {
return $entity = $this->callAPISuccess($this->entity, 'create', $this->params);
}
/**
* Generic function to create Organisation, to be used in test cases
*
- * @param array parameters for civicrm_contact_add api function call
- * @param int sequence number if creating multiple organizations
+ * @param array $params
+ * parameters for civicrm_contact_add api function call
+ * @param int $seq
+ * sequence number if creating multiple organizations
*
- * @return int id of Organisation created
+ * @return int
+ * id of Organisation created
*/
- function organizationCreate($params = array(), $seq = 0) {
+ public function organizationCreate($params = array(), $seq = 0) {
if (!$params) {
$params = array();
}
/**
* Generic function to create Individual, to be used in test cases
*
- * @param array parameters for civicrm_contact_add api function call
- * @param int sequence number if creating multiple individuals
+ * @param array $params
+ * parameters for civicrm_contact_add api function call
+ * @param int $seq
+ * sequence number if creating multiple individuals
*
- * @return int id of Individual created
+ * @return int
+ * id of Individual created
*/
- function individualCreate($params = array(), $seq = 0) {
+ public function individualCreate($params = array(), $seq = 0) {
$params = array_merge($this->sampleContact('Individual', $seq), $params);
return $this->_contactCreate($params);
}
/**
* Generic function to create Household, to be used in test cases
*
- * @param array parameters for civicrm_contact_add api function call
- * @param int sequence number if creating multiple households
+ * @param array $params
+ * parameters for civicrm_contact_add api function call
+ * @param int $seq
+ * sequence number if creating multiple households
*
- * @return int id of Household created
+ * @return int
+ * id of Household created
*/
- function householdCreate($params = array(), $seq = 0) {
+ public function householdCreate($params = array(), $seq = 0) {
$params = array_merge($this->sampleContact('Household', $seq), $params);
return $this->_contactCreate($params);
}
/**
- * Helper function for getting sample contact properties
+ * Helper function for getting sample contact properties.
*
- * @param enum contact type: Individual, Organization
- * @param int sequence number for the values of this type
+ * @param string $contact_type
+ * enum contact type: Individual, Organization
+ * @param int $seq
+ * sequence number for the values of this type
*
- * @return array properties of sample contact (ie. $params for API call)
+ * @return array
+ * properties of sample contact (ie. $params for API call)
*/
- function sampleContact($contact_type, $seq = 0) {
+ public function sampleContact($contact_type, $seq = 0) {
$samples = array(
'Individual' => array(
// The number of values in each list need to be coprime numbers to not have duplicates
'last_name' => array('Anderson', 'Miller', 'Smith', 'Collins', 'Peterson'),
),
'Organization' => array(
- 'organization_name' => array('Unit Test Organization', 'Acme', 'Roberts and Sons', 'Cryo Space Labs', 'Sharper Pens'),
+ 'organization_name' => array(
+ 'Unit Test Organization',
+ 'Acme',
+ 'Roberts and Sons',
+ 'Cryo Space Labs',
+ 'Sharper Pens',
+ ),
),
'Household' => array(
'household_name' => array('Unit Test household'),
);
$params = array('contact_type' => $contact_type);
foreach ($samples[$contact_type] as $key => $values) {
- $params[$key] = $values[$seq % sizeof($values)];
+ $params[$key] = $values[$seq % count($values)];
}
- if ($contact_type == 'Individual' ) {
- $params['email'] = strtolower(
- $params['first_name'] . '_' . $params['last_name'] . '@civicrm.org'
- );
- $params['prefix_id'] = 3;
- $params['suffix_id'] = 3;
+ if ($contact_type == 'Individual') {
+ $params['email'] = strtolower(
+ $params['first_name'] . '_' . $params['last_name'] . '@civicrm.org'
+ );
+ $params['prefix_id'] = 3;
+ $params['suffix_id'] = 3;
}
return $params;
}
/**
- * Private helper function for calling civicrm_contact_add
+ * Private helper function for calling civicrm_contact_add.
*
- * @param $params
+ * @param array $params
+ * For civicrm_contact_add api function call.
*
* @throws Exception
- * @internal param \parameters $array for civicrm_contact_add api function call
*
- * @return int id of Household created
+ * @return int
+ * id of Household created
*/
private function _contactCreate($params) {
$result = $this->callAPISuccess('contact', 'create', $params);
}
/**
- * @param $contactID
+ * Delete contact, ensuring it is not the domain contact
*
- * @return array|int
+ * @param int $contactID
+ * Contact ID to delete
*/
- function contactDelete($contactID) {
- $params = array(
- 'id' => $contactID,
- 'skip_undelete' => 1,
- 'debug' => 1,
- );
- $domain = new CRM_Core_BAO_Domain;
+ public function contactDelete($contactID) {
+ $domain = new CRM_Core_BAO_Domain();
$domain->contact_id = $contactID;
- if ($domain->find(TRUE)) {
- // we are finding tests trying to delete the domain contact in cleanup
- //since this is mainly for cleanup lets put a safeguard here
- return;
+ if (!$domain->find(TRUE)) {
+ $this->callAPISuccess('contact', 'delete', array(
+ 'id' => $contactID,
+ 'skip_undelete' => 1,
+ ));
}
- $result = $this->callAPISuccess('contact', 'delete', $params);
- return $result;
}
/**
- * @param $contactTypeId
+ * @param int $contactTypeId
*
* @throws Exception
*/
- function contactTypeDelete($contactTypeId) {
- require_once 'CRM/Contact/BAO/ContactType.php';
+ public function contactTypeDelete($contactTypeId) {
$result = CRM_Contact_BAO_ContactType::del($contactTypeId);
if (!$result) {
throw new Exception('Could not delete contact type');
*
* @return mixed
*/
- function membershipTypeCreate($params = array()) {
+ public function membershipTypeCreate($params = array()) {
CRM_Member_PseudoConstant::flush('membershipType');
CRM_Core_Config::clearDBCache();
$memberOfOrganization = $this->organizationCreate();
}
/**
- * @param $params
+ * @param array $params
*
* @return mixed
*/
- function contactMembershipCreate($params) {
+ public function contactMembershipCreate($params) {
$pre = array(
'join_date' => '2007-01-21',
'start_date' => '2007-01-21',
}
/**
- * Function to delete Membership Type
+ * Delete Membership Type.
*
- * @param $params
- * @internal param int $membershipTypeID
+ * @param array $params
*/
- function membershipTypeDelete($params) {
+ public function membershipTypeDelete($params) {
$this->callAPISuccess('MembershipType', 'Delete', $params);
}
/**
- * @param $membershipID
+ * @param int $membershipID
*/
- function membershipDelete($membershipID) {
+ public function membershipDelete($membershipID) {
$deleteParams = array('id' => $membershipID);
$result = $this->callAPISuccess('Membership', 'Delete', $deleteParams);
- return;
}
/**
*
* @return mixed
*/
- function membershipStatusCreate($name = 'test member status') {
+ public function membershipStatusCreate($name = 'test member status') {
$params['name'] = $name;
$params['start_event'] = 'start_date';
$params['end_event'] = 'end_date';
}
/**
- * @param $membershipStatusID
+ * @param int $membershipStatusID
*/
- function membershipStatusDelete($membershipStatusID) {
+ public function membershipStatusDelete($membershipStatusID) {
if (!$membershipStatusID) {
return;
}
$result = $this->callAPISuccess('MembershipStatus', 'Delete', array('id' => $membershipStatusID));
- return;
}
/**
*
* @return mixed
*/
- function relationshipTypeCreate($params = array()) {
+ public function relationshipTypeCreate($params = array()) {
$params = array_merge(array(
'name_a_b' => 'Relation 1 for relationship type create',
'name_b_a' => 'Relation 2 for relationship type create',
'is_reserved' => 1,
'is_active' => 1,
),
- $params
+ $params
);
$result = $this->callAPISuccess('relationship_type', 'create', $params);
}
/**
- * Function to delete Relatinship Type
+ * Delete Relatinship Type.
*
* @param int $relationshipTypeID
*/
- function relationshipTypeDelete($relationshipTypeID) {
+ public function relationshipTypeDelete($relationshipTypeID) {
$params['id'] = $relationshipTypeID;
$this->callAPISuccess('relationship_type', 'delete', $params);
}
/**
- * @param null $params
+ * @param array $params
*
* @return mixed
*/
- function paymentProcessorTypeCreate($params = NULL) {
+ public function paymentProcessorTypeCreate($params = NULL) {
if (is_null($params)) {
$params = array(
'name' => 'API_Test_PP',
}
/**
- * Function to create Participant
+ * Create Participant.
*
- * @param array $params array of contact id and event id values
+ * @param array $params
+ * Array of contact id and event id values.
*
- * @return int $id of participant created
+ * @return int
+ * $id of participant created
*/
- function participantCreate($params) {
- if(empty($params['contact_id'])){
+ public function participantCreate($params) {
+ if (empty($params['contact_id'])) {
$params['contact_id'] = $this->individualCreate();
}
- if(empty($params['event_id'])){
+ if (empty($params['event_id'])) {
$event = $this->eventCreate();
$params['event_id'] = $event['id'];
}
}
/**
- * Function to create Payment Processor
+ * Create Payment Processor.
*
- * @return object of Payment Processsor
+ * @return CRM_Financial_DAO_PaymentProcessor
+ * instance of Payment Processsor
*/
- function processorCreate() {
+ public function processorCreate() {
$processorParams = array(
'domain_id' => 1,
'name' => 'Dummy',
}
/**
- * Function to create contribution page
+ * Create contribution page.
*
- * @param $params
- * @return object of contribution page
+ * @param array $params
+ * @return array
+ * Array of contribution page
*/
- function contributionPageCreate($params) {
+ public function contributionPageCreate($params) {
$this->_pageParams = array(
'title' => 'Test Contribution Page',
'financial_type_id' => 1,
}
/**
- * Function to create Tag
+ * Create Tag.
*
* @param array $params
- * @return array result of created tag
+ * @return array
+ * result of created tag
*/
- function tagCreate($params = array()) {
+ public function tagCreate($params = array()) {
$defaults = array(
'name' => 'New Tag3',
'description' => 'This is description for Our New Tag ',
'domain_id' => '1',
);
$params = array_merge($defaults, $params);
- $result = $this->callAPISuccess('Tag', 'create', $params);
+ $result = $this->callAPISuccess('Tag', 'create', $params);
return $result['values'][$result['id']];
}
/**
- * Function to delete Tag
+ * Delete Tag.
*
- * @param int $tagId id of the tag to be deleted
+ * @param int $tagId
+ * Id of the tag to be deleted.
+ *
+ * @return int
*/
- function tagDelete($tagId) {
+ public function tagDelete($tagId) {
require_once 'api/api.php';
$params = array(
'tag_id' => $tagId,
/**
* Add entity(s) to the tag
*
- * @param array $params
+ * @param array $params
*
* @return bool
*/
- function entityTagAdd($params) {
+ public function entityTagAdd($params) {
$result = $this->callAPISuccess('entity_tag', 'create', $params);
return TRUE;
}
/**
- * Function to create contribution
- *
- * @param int $cID contact_id
+ * Create contribution.
*
- * @internal param int $cTypeID id of financial type
+ * @param int $cID
+ * Contact_id.
*
- * @return int id of created contribution
+ * @return int
+ * id of created contribution
*/
- function pledgeCreate($cID) {
+ public function pledgeCreate($cID) {
$params = array(
'contact_id' => $cID,
'pledge_create_date' => date('Ymd'),
}
/**
- * Function to delete contribution
+ * Delete contribution.
*
- * @param $pledgeId
- * @internal param int $contributionId
+ * @param int $pledgeId
*/
- function pledgeDelete($pledgeId) {
+ public function pledgeDelete($pledgeId) {
$params = array(
'pledge_id' => $pledgeId,
);
}
/**
- * Function to create contribution
- *
- * @param int $cID contact_id
- * @param int $cTypeID id of financial type
+ * Create contribution.
*
+ * @param int $cID
+ * Contact_id.
+ * @param int $cTypeID
+ * Id of financial type.
* @param int $invoiceID
* @param int $trxnID
* @param int $paymentInstrumentID
* @param bool $isFee
- * @return int id of created contribution
+ *
+ * @return int
+ * id of created contribution
*/
- function contributionCreate($cID, $cTypeID = 1, $invoiceID = 67890, $trxnID = 12345, $paymentInstrumentID = 1, $isFee = TRUE) {
+ public function contributionCreate($cID, $cTypeID = 1, $invoiceID = 67890, $trxnID = 12345, $paymentInstrumentID = 1, $isFee = TRUE) {
$params = array(
'domain_id' => 1,
'contact_id' => $cID,
}
/**
- * Function to create online contribution
- *
- * @param $params
- * @param int $financialType id of financial type
+ * Create online contribution.
*
+ * @param array $params
+ * @param int $financialType
+ * Id of financial type.
* @param int $invoiceID
* @param int $trxnID
- * @return int id of created contribution
+ *
+ * @return int
+ * id of created contribution
*/
- function onlineContributionCreate($params, $financialType, $invoiceID = 67890, $trxnID = 12345) {
+ public function onlineContributionCreate($params, $financialType, $invoiceID = 67890, $trxnID = 12345) {
$contribParams = array(
'contact_id' => $params['contact_id'],
'receive_date' => date('Ymd'),
}
/**
- * Function to delete contribution
+ * Delete contribution.
*
* @param int $contributionId
*
* @return array|int
*/
- function contributionDelete($contributionId) {
+ public function contributionDelete($contributionId) {
$params = array(
'contribution_id' => $contributionId,
);
}
/**
- * Function to create an Event
+ * Create an Event.
*
- * @param array $params name-value pair for an event
+ * @param array $params
+ * Name-value pair for an event.
*
- * @return array $event
+ * @return array
*/
- function eventCreate($params = array()) {
+ public function eventCreate($params = array()) {
// if no contact was passed, make up a dummy event creator
if (!isset($params['contact_id'])) {
$params['contact_id'] = $this->_contactCreate(array(
}
/**
- * Function to delete event
+ * Delete event.
*
- * @param int $id ID of the event
+ * @param int $id
+ * ID of the event.
*
* @return array|int
*/
- function eventDelete($id) {
+ public function eventDelete($id) {
$params = array(
'event_id' => $id,
);
}
/**
- * Function to delete participant
+ * Delete participant.
*
* @param int $participantID
*
* @return array|int
*/
- function participantDelete($participantID) {
+ public function participantDelete($participantID) {
$params = array(
'id' => $participantID,
);
}
/**
- * Function to create participant payment
+ * Create participant payment.
*
- * @param $participantID
- * @param null $contributionID
- * @return int $id of created payment
+ * @param int $participantID
+ * @param int $contributionID
+ * @return int
+ * $id of created payment
*/
- function participantPaymentCreate($participantID, $contributionID = NULL) {
+ public function participantPaymentCreate($participantID, $contributionID = NULL) {
//Create Participant Payment record With Values
$params = array(
'participant_id' => $participantID,
}
/**
- * Function to delete participant payment
+ * Delete participant payment.
*
* @param int $paymentID
*/
- function participantPaymentDelete($paymentID) {
+ public function participantPaymentDelete($paymentID) {
$params = array(
'id' => $paymentID,
);
}
/**
- * Function to add a Location
+ * Add a Location.
*
- * @param $contactID
- * @return int location id of created location
+ * @param int $contactID
+ * @return int
+ * location id of created location
*/
- function locationAdd($contactID) {
+ public function locationAdd($contactID) {
$address = array(
1 => array(
'location_type' => 'New Location Type',
'state_province' => 'Michigan',
'supplemental_address_1' => 'Hallmark Ct',
'supplemental_address_2' => 'Jersey Village',
- )
+ ),
);
$params = array(
}
/**
- * Function to delete Locations of contact
+ * Delete Locations of contact.
*
- * @params array $pamars parameters
+ * @param array $params
+ * Parameters.
*/
- function locationDelete($params) {
- $result = $this->callAPISuccess('Location', 'delete', $params);
+ public function locationDelete($params) {
+ $this->callAPISuccess('Location', 'delete', $params);
}
/**
- * Function to add a Location Type
+ * Add a Location Type.
*
- * @param null $params
- * @return int location id of created location
+ * @param array $params
+ * @return CRM_Core_DAO_LocationType
+ * location id of created location
*/
- function locationTypeCreate($params = NULL) {
+ public function locationTypeCreate($params = NULL) {
if ($params === NULL) {
$params = array(
'name' => 'New Location Type',
}
/**
- * Function to delete a Location Type
+ * Delete a Location Type.
*
- * @param int location type id
+ * @param int $locationTypeId
*/
- function locationTypeDelete($locationTypeId) {
+ public function locationTypeDelete($locationTypeId) {
$locationType = new CRM_Core_DAO_LocationType();
$locationType->id = $locationTypeId;
$locationType->delete();
}
/**
- * Function to add a Group
- *
- * @params array to add group
+ * Add a Group.
*
* @param array $params
- * @return int groupId of created group
+ * @return int
+ * groupId of created group
*/
- function groupCreate($params = array()) {
+ public function groupCreate($params = array()) {
$params = array_merge(array(
- 'name' => 'Test Group 1',
- 'domain_id' => 1,
- 'title' => 'New Test Group Created',
- 'description' => 'New Test Group Created',
- 'is_active' => 1,
- 'visibility' => 'Public Pages',
- 'group_type' => array(
- '1' => 1,
- '2' => 1,
- ),
- ), $params);
+ 'name' => 'Test Group 1',
+ 'domain_id' => 1,
+ 'title' => 'New Test Group Created',
+ 'description' => 'New Test Group Created',
+ 'is_active' => 1,
+ 'visibility' => 'Public Pages',
+ 'group_type' => array(
+ '1' => 1,
+ '2' => 1,
+ ),
+ ), $params);
$result = $this->callAPISuccess('Group', 'create', $params);
return $result['id'];
}
+
/**
- * Function to delete a Group
+ * Function to add a Group.
*
- * @param $gid
- * @internal param int $id
+ * @params array to add group
+ *
+ * @param int $groupID
+ * @param int $totalCount
+ * @return int
+ * groupId of created group
+ */
+ public function groupContactCreate($groupID, $totalCount = 10) {
+ $params = array('group_id' => $groupID);
+ for ($i = 1; $i <= $totalCount; $i++) {
+ $contactID = $this->individualCreate();
+ if ($i == 1) {
+ $params += array('contact_id' => $contactID);
+ }
+ else {
+ $params += array("contact_id.$i" => $contactID);
+ }
+ }
+ $result = $this->callAPISuccess('GroupContact', 'create', $params);
+
+ return $result;
+ }
+
+ /**
+ * Delete a Group.
+ *
+ * @param int $gid
*/
- function groupDelete($gid) {
+ public function groupDelete($gid) {
$params = array(
'id' => $gid,
}
/**
- * Create a UFField
+ * Create a UFField.
* @param array $params
*/
- function uFFieldCreate($params = array()) {
+ public function uFFieldCreate($params = array()) {
$params = array_merge(array(
'uf_group_id' => 1,
'field_name' => 'first_name',
}
/**
- * Function to add a UF Join Entry
+ * Add a UF Join Entry.
*
- * @param null $params
- * @return int $id of created UF Join
+ * @param array $params
+ * @return int
+ * $id of created UF Join
*/
- function ufjoinCreate($params = NULL) {
+ public function ufjoinCreate($params = NULL) {
if ($params === NULL) {
$params = array(
'is_active' => 1,
}
/**
- * Function to delete a UF Join Entry
+ * Delete a UF Join Entry.
*
- * @param array with missing uf_group_id
+ * @param array $params
+ * with missing uf_group_id
*/
- function ufjoinDelete($params = NULL) {
+ public function ufjoinDelete($params = NULL) {
if ($params === NULL) {
$params = array(
'is_active' => 1,
}
/**
- * Function to create Group for a contact
+ * @param array $params
+ * Optional parameters.
+ *
+ * @return int
+ * Campaign ID.
+ */
+ public function campaignCreate($params = array()) {
+ $this->enableCiviCampaign();
+ $campaign = $this->callAPISuccess('campaign', 'create', array_merge(array(
+ 'name' => 'big_campaign',
+ 'title' => 'Campaign',
+ ), $params));
+ return $campaign['id'];
+ }
+
+ /**
+ * Create Group for a contact.
*
* @param int $contactId
*/
- function contactGroupCreate($contactId) {
+ public function contactGroupCreate($contactId) {
$params = array(
'contact_id.1' => $contactId,
'group_id' => 1,
}
/**
- * Function to delete Group for a contact
+ * Delete Group for a contact.
*
- * @param $contactId
- * @internal param array $params
+ * @param int $contactId
*/
- function contactGroupDelete($contactId) {
+ public function contactGroupDelete($contactId) {
$params = array(
'contact_id.1' => $contactId,
'group_id' => 1,
}
/**
- * Function to create Activity
+ * Create Activity.
*
- * @param null $params
+ * @param array $params
* @return array|int
- * @internal param int $contactId
*/
- function activityCreate($params = NULL) {
+ public function activityCreate($params = NULL) {
if ($params === NULL) {
$individualSourceID = $this->individualCreate();
}
/**
- * Function to create an activity type
+ * Create an activity type.
*
- * @params array $params parameters
+ * @param array $params
+ * Parameters.
+ * @return array
*/
- function activityTypeCreate($params) {
- $result = $this->callAPISuccess('ActivityType', 'create', $params);
- return $result;
+ public function activityTypeCreate($params) {
+ return $this->callAPISuccess('ActivityType', 'create', $params);
}
/**
- * Function to delete activity type
+ * Delete activity type.
*
- * @params Integer $activityTypeId id of the activity type
+ * @param int $activityTypeId
+ * Id of the activity type.
+ * @return array
*/
- function activityTypeDelete($activityTypeId) {
+ public function activityTypeDelete($activityTypeId) {
$params['activity_type_id'] = $activityTypeId;
- $result = $this->callAPISuccess('ActivityType', 'delete', $params);
- return $result;
+ return $this->callAPISuccess('ActivityType', 'delete', $params);
}
/**
- * Function to create custom group
+ * Create custom group.
*
* @param array $params
* @return array|int
- * @internal param string $className
- * @internal param string $title name of custom group
*/
- function customGroupCreate($params = array()) {
+ public function customGroupCreate($params = array()) {
$defaults = array(
'title' => 'new custom group',
'extends' => 'Contact',
$params = array_merge($defaults, $params);
if (strlen($params['title']) > 13) {
- $params['title'] = substr($params['title'], 0, 13);
+ $params['title'] = substr($params['title'], 0, 13);
}
//have a crack @ deleting it first in the hope this will prevent derailing our tests
- $check = $this->callAPISuccess('custom_group', 'get', array('title' => $params['title'], array('api.custom_group.delete' => 1)));
+ $this->callAPISuccess('custom_group', 'get', array(
+ 'title' => $params['title'],
+ array('api.custom_group.delete' => 1),
+ ));
return $this->callAPISuccess('custom_group', 'create', $params);
}
/**
- * existing function doesn't allow params to be over-ridden so need a new one
+ * Existing function doesn't allow params to be over-ridden so need a new one
* this one allows you to only pass in the params you want to change
+ * @param array $params
+ * @return array|int
*/
- function CustomGroupCreateByParams($params = array()) {
+ public function CustomGroupCreateByParams($params = array()) {
$defaults = array(
'title' => "API Custom Group",
'extends' => 'Contact',
}
/**
- * Create custom group with multi fields
+ * Create custom group with multi fields.
+ * @param array $params
+ * @return array|int
*/
- function CustomGroupMultipleCreateByParams($params = array()) {
+ public function CustomGroupMultipleCreateByParams($params = array()) {
$defaults = array(
'style' => 'Tab',
'is_multiple' => 1,
}
/**
- * Create custom group with multi fields
+ * Create custom group with multi fields.
+ * @param array $params
+ * @return array
*/
- function CustomGroupMultipleCreateWithFields($params = array()) {
+ public function CustomGroupMultipleCreateWithFields($params = array()) {
// also need to pass on $params['custom_field'] if not set but not in place yet
$ids = array();
$customGroup = $this->CustomGroupMultipleCreateByParams($params);
$ids['custom_group_id'] = $customGroup['id'];
- $customField = $this->customFieldCreate(array('custom_group_id' => $ids['custom_group_id'], 'label' => 'field_1' . $ids['custom_group_id']));
+ $customField = $this->customFieldCreate(array(
+ 'custom_group_id' => $ids['custom_group_id'],
+ 'label' => 'field_1' . $ids['custom_group_id'],
+ ));
$ids['custom_field_id'][] = $customField['id'];
- $customField = $this->customFieldCreate(array('custom_group_id' => $ids['custom_group_id'], 'default_value' => '', 'label' => 'field_2' . $ids['custom_group_id']));
+ $customField = $this->customFieldCreate(array(
+ 'custom_group_id' => $ids['custom_group_id'],
+ 'default_value' => '',
+ 'label' => 'field_2' . $ids['custom_group_id'],
+ ));
$ids['custom_field_id'][] = $customField['id'];
- $customField = $this->customFieldCreate(array('custom_group_id' => $ids['custom_group_id'], 'default_value' => '', 'label' => 'field_3' . $ids['custom_group_id']));
+ $customField = $this->customFieldCreate(array(
+ 'custom_group_id' => $ids['custom_group_id'],
+ 'default_value' => '',
+ 'label' => 'field_3' . $ids['custom_group_id'],
+ ));
$ids['custom_field_id'][] = $customField['id'];
return $ids;
* Create a custom group with a single text custom field. See
* participant:testCreateWithCustom for how to use this
*
- * @param string $function __FUNCTION__
- * @param $filename
- * @internal param string $file __FILE__
+ * @param string $function
+ * __FUNCTION__.
+ * @param string $filename
+ * $file __FILE__.
*
- * @return array $ids ids of created objects
+ * @return array
+ * ids of created objects
*/
- function entityCustomGroupWithSingleFieldCreate($function, $filename) {
+ public function entityCustomGroupWithSingleFieldCreate($function, $filename) {
$params = array('title' => $function);
$entity = substr(basename($filename), 0, strlen(basename($filename)) - 8);
- $params['extends'] = $entity ? $entity : 'Contact';
+ $params['extends'] = $entity ? $entity : 'Contact';
$customGroup = $this->CustomGroupCreate($params);
$customField = $this->customFieldCreate(array('custom_group_id' => $customGroup['id'], 'label' => $function));
CRM_Core_PseudoConstant::flush();
}
/**
- * Function to delete custom group
+ * Delete custom group.
*
* @param int $customGroupID
*
* @return array|int
*/
- function customGroupDelete($customGroupID) {
+ public function customGroupDelete($customGroupID) {
$params['id'] = $customGroupID;
return $this->callAPISuccess('custom_group', 'delete', $params);
}
/**
- * Function to create custom field
+ * Create custom field.
*
- * @param array $params (custom_group_id) is required
- * @return array|int
- * @internal param string $name name of custom field
- * @internal param int $apiversion API version to use
+ * @param array $params
+ * (custom_group_id) is required.
+ * @return array
*/
- function customFieldCreate($params) {
+ public function customFieldCreate($params) {
$params = array_merge(array(
'label' => 'Custom Field',
'data_type' => 'String',
), $params);
$result = $this->callAPISuccess('custom_field', 'create', $params);
-
- if ($result['is_error'] == 0 && isset($result['id'])) {
- CRM_Core_BAO_CustomField::getTableColumnGroup($result['id'], 1);
- // force reset of enabled components to help grab custom fields
- CRM_Core_Component::getEnabledComponents(1);
- return $result;
- }
+ // these 2 functions are called with force to flush static caches
+ CRM_Core_BAO_CustomField::getTableColumnGroup($result['id'], 1);
+ CRM_Core_Component::getEnabledComponents(1);
+ return $result;
}
/**
- * Function to delete custom field
+ * Delete custom field.
*
* @param int $customFieldID
*
* @return array|int
*/
- function customFieldDelete($customFieldID) {
+ public function customFieldDelete($customFieldID) {
$params['id'] = $customFieldID;
return $this->callAPISuccess('custom_field', 'delete', $params);
}
/**
- * Function to create note
- *
- * @params array $params name-value pair for an event
+ * Create note.
*
- * @param $cId
- * @return array $note
+ * @param int $cId
+ * @return array
*/
- function noteCreate($cId) {
+ public function noteCreate($cId) {
$params = array(
'entity_table' => 'civicrm_contact',
'entity_id' => $cId,
}
/**
- * Enable CiviCampaign Component
+ * Enable CiviCampaign Component.
*/
- function enableCiviCampaign() {
+ public function enableCiviCampaign() {
CRM_Core_BAO_ConfigSetting::enableComponent('CiviCampaign');
// force reload of config object
$config = CRM_Core_Config::singleton(TRUE, TRUE);
/**
* Create test generated example in api/v3/examples.
+ *
* To turn this off (e.g. on the server) set
* define(DONT_DOCUMENT_TEST_CONFIG ,1);
* in your settings file
- * @param array $params array as passed to civicrm_api function
- * @param array $result array as received from the civicrm_api function
- * @param string $function calling function - generally __FUNCTION__
- * @param string $filename called from file - generally __FILE__
- * @param string $description descriptive text for the example file
- * @param string $subfile name for subfile - if this is completed the example will be put in a subfolder (named by the entity)
- * @param string $action - optional action - otherwise taken from function name
- */
- function documentMe($params, $result, $function, $filename, $description = "", $subfile = NULL, $action = NULL) {
+ *
+ * @param string $entity
+ * @param string $action
+ * @param array $params
+ * Array as passed to civicrm_api function.
+ * @param array $result
+ * Array as received from the civicrm_api function.
+ * @param string $testFunction
+ * Calling function - generally __FUNCTION__.
+ * @param string $testFile
+ * Called from file - generally __FILE__.
+ * @param string $description
+ * Descriptive text for the example file.
+ * @param string $exampleName
+ * Name for this example file (CamelCase) - if ommitted the action name will be substituted.
+ */
+ private function documentMe($entity, $action, $params, $result, $testFunction, $testFile, $description = "", $exampleName = NULL) {
if (defined('DONT_DOCUMENT_TEST_CONFIG') && DONT_DOCUMENT_TEST_CONFIG) {
return;
}
- $entity = substr(basename($filename), 0, strlen(basename($filename)) - 8);
- //todo - this is a bit cludgey
- if (empty($action)) {
- if (strstr($function, 'Create')) {
- $action = empty($action) ? 'create' : $action;
- $entityAction = 'Create';
- }
- elseif (strstr($function, 'GetSingle')) {
- $action = empty($action) ? 'getsingle' : $action;
- $entityAction = 'GetSingle';
- }
- elseif (strstr($function, 'GetValue')) {
- $action = empty($action) ? 'getvalue' : $action;
- $entityAction = 'GetValue';
- }
- elseif (strstr($function, 'GetCount')) {
- $action = empty($action) ? 'getcount' : $action;
- $entityAction = 'GetCount';
- }
- elseif (strstr($function, 'GetFields')) {
- $action = empty($action) ? 'getfields' : $action;
- $entityAction = 'GetFields';
- }
- elseif (strstr($function, 'GetList')) {
- $action = empty($action) ? 'getlist' : $action;
- $entityAction = 'GetList';
- }
- elseif (strstr($function, 'GetActions')) {
- $action = empty($action) ? 'getactions' : $action;
- $entityAction = 'GetActions';
- }
- elseif (strstr($function, 'Get')) {
- $action = empty($action) ? 'get' : $action;
- $entityAction = 'Get';
- }
- elseif (strstr($function, 'Delete')) {
- $action = empty($action) ? 'delete' : $action;
- $entityAction = 'Delete';
- }
- elseif (strstr($function, 'Update')) {
- $action = empty($action) ? 'update' : $action;
- $entityAction = 'Update';
- }
- elseif (strstr($function, 'Subscribe')) {
- $action = empty($action) ? 'subscribe' : $action;
- $entityAction = 'Subscribe';
- }
- elseif (strstr($function, 'Submit')) {
- $action = empty($action) ? 'submit' : $action;
- $entityAction = 'Submit';
- }
- elseif (strstr($function, 'Apply')) {
- $action = empty($action) ? 'apply' : $action;
- $entityAction = 'Apply';
- }
- elseif (strstr($function, 'Replace')) {
- $action = empty($action) ? 'replace' : $action;
- $entityAction = 'Replace';
+ $entity = _civicrm_api_get_camel_name($entity);
+ $action = strtolower($action);
+
+ if (empty($exampleName)) {
+ // Attempt to convert lowercase action name to CamelCase.
+ // This is clunky/imperfect due to the convention of all lowercase actions.
+ $exampleName = CRM_Utils_String::convertStringToCamel($action);
+ $knownPrefixes = array(
+ 'Get',
+ 'Set',
+ 'Create',
+ 'Update',
+ 'Send',
+ );
+ foreach ($knownPrefixes as $prefix) {
+ if (strpos($exampleName, $prefix) === 0 && $prefix != $exampleName) {
+ $exampleName[strlen($prefix)] = strtoupper($exampleName[strlen($prefix)]);
+ }
}
}
- else {
- $entityAction = ucwords($action);
- }
$this->tidyExampleResult($result);
- if(isset($params['version'])) {
+ if (isset($params['version'])) {
unset($params['version']);
}
- // a cleverer person than me would do it in a single regex
- if (strstr($entity, 'UF')) {
- $fnPrefix = strtolower(preg_replace('/(?<! )(?<!^)(?<=UF)[A-Z]/', '_$0', $entity));
- }
- else {
- $fnPrefix = strtolower(preg_replace('/(?<! )(?<!^)[A-Z]/', '_$0', $entity));
+ // Format multiline description as array
+ $desc = array();
+ if (is_string($description) && strlen($description)) {
+ foreach (explode("\n", $description) as $line) {
+ $desc[] = trim($line);
+ }
}
$smarty = CRM_Core_Smarty::singleton();
- $smarty->assign('testfunction', $function);
- $function = $fnPrefix . "_" . strtolower($action);
- $smarty->assign('function', $function);
- $smarty->assign('fnPrefix', $fnPrefix);
+ $smarty->assign('testFunction', $testFunction);
+ $smarty->assign('function', _civicrm_api_get_entity_name_from_camel($entity) . "_$action");
$smarty->assign('params', $params);
$smarty->assign('entity', $entity);
- $smarty->assign('filename', basename($filename));
- $smarty->assign('description', $description);
+ $smarty->assign('testFile', basename($testFile));
+ $smarty->assign('description', $desc);
$smarty->assign('result', $result);
-
$smarty->assign('action', $action);
- if (empty($subfile)) {
- $subfile = $entityAction;
- }
+
if (file_exists('../tests/templates/documentFunction.tpl')) {
if (!is_dir("../api/v3/examples/$entity")) {
mkdir("../api/v3/examples/$entity");
}
- $f = fopen("../api/v3/examples/$entity/$subfile.php", "w+b");
+ $f = fopen("../api/v3/examples/$entity/$exampleName.php", "w+b");
fwrite($f, $smarty->fetch('../tests/templates/documentFunction.tpl'));
fclose($f);
}
* Tidy up examples array so that fields that change often ..don't
* and debug related fields are unset
*
- * @param $result
- *
- * @internal param array $params
+ * @param array $result
*/
- function tidyExampleResult(&$result){
- if(!is_array($result)) {
+ public function tidyExampleResult(&$result) {
+ if (!is_array($result)) {
return;
}
$fieldsToChange = array(
'decision_date' => '20130805000000',
);
- $keysToUnset = array('xdebug', 'undefined_fields',);
+ $keysToUnset = array('xdebug', 'undefined_fields');
foreach ($keysToUnset as $unwantedKey) {
- if(isset($result[$unwantedKey])) {
+ if (isset($result[$unwantedKey])) {
unset($result[$unwantedKey]);
}
}
if (isset($result['values'])) {
- if(!is_array($result['values'])) {
+ if (!is_array($result['values'])) {
return;
}
$resultArray = &$result['values'];
}
- elseif(is_array($result)) {
+ elseif (is_array($result)) {
$resultArray = &$result;
}
else {
}
foreach ($resultArray as $index => &$values) {
- if(!is_array($values)) {
- continue;
- }
- foreach($values as $key => &$value) {
- if(substr($key, 0, 3) == 'api' && is_array($value)) {
- if(isset($value['is_error'])) {
- // we have a std nested result format
- $this->tidyExampleResult($value);
- }
- else{
- foreach ($value as &$nestedResult) {
- // this is an alternative syntax for nested results a keyed array of results
- $this->tidyExampleResult($nestedResult);
- }
- }
- }
- if(in_array($key, $keysToUnset)) {
- unset($values[$key]);
- break;
- }
- if(array_key_exists($key, $fieldsToChange) && !empty($value)) {
- $value = $fieldsToChange[$key];
+ if (!is_array($values)) {
+ continue;
+ }
+ foreach ($values as $key => &$value) {
+ if (substr($key, 0, 3) == 'api' && is_array($value)) {
+ if (isset($value['is_error'])) {
+ // we have a std nested result format
+ $this->tidyExampleResult($value);
}
- if(is_string($value)) {
- $value = addslashes($value);
+ else {
+ foreach ($value as &$nestedResult) {
+ // this is an alternative syntax for nested results a keyed array of results
+ $this->tidyExampleResult($nestedResult);
+ }
}
}
+ if (in_array($key, $keysToUnset)) {
+ unset($values[$key]);
+ break;
+ }
+ if (array_key_exists($key, $fieldsToChange) && !empty($value)) {
+ $value = $fieldsToChange[$key];
+ }
+ if (is_string($value)) {
+ $value = addslashes($value);
+ }
+ }
}
}
/**
- * Function to delete note
+ * Delete note.
*
- * @params int $noteID
+ * @param array $params
*
+ * @return array|int
*/
- function noteDelete($params) {
+ public function noteDelete($params) {
return $this->callAPISuccess('Note', 'delete', $params);
}
/**
- * Function to create custom field with Option Values
+ * Create custom field with Option Values.
*
* @param array $customGroup
- * @param string $name name of custom field
+ * @param string $name
+ * Name of custom field.
*
* @return array|int
*/
- function customFieldOptionValueCreate($customGroup, $name) {
+ public function customFieldOptionValueCreate($customGroup, $name) {
$fieldParams = array(
'custom_group_id' => $customGroup['id'],
'name' => 'test_custom_group',
*
* @return bool
*/
- function confirmEntitiesDeleted($entities) {
+ public function confirmEntitiesDeleted($entities) {
foreach ($entities as $entity) {
$result = $this->callAPISuccess($entity, 'Get', array());
return TRUE;
}
}
+ return FALSE;
}
/**
* @param $tablesToTruncate
* @param bool $dropCustomValueTables
+ * @throws \Exception
*/
- function quickCleanup($tablesToTruncate, $dropCustomValueTables = FALSE) {
+ public function quickCleanup($tablesToTruncate, $dropCustomValueTables = FALSE) {
+ if ($this->tx) {
+ throw new Exception("CiviUnitTestCase: quickCleanup() is not compatible with useTransaction()");
+ }
if ($dropCustomValueTables) {
$tablesToTruncate[] = 'civicrm_custom_group';
$tablesToTruncate[] = 'civicrm_custom_field';
/**
* Clean up financial entities after financial tests (so we remember to get all the tables :-))
*/
- function quickCleanUpFinancialEntities() {
+ public function quickCleanUpFinancialEntities() {
$tablesToTruncate = array(
'civicrm_contribution',
+ 'civicrm_contribution_soft',
'civicrm_financial_trxn',
+ 'civicrm_financial_item',
'civicrm_contribution_recur',
'civicrm_line_item',
'civicrm_contribution_page',
$this->quickCleanup($tablesToTruncate);
CRM_Core_DAO::executeQuery("DELETE FROM civicrm_membership_status WHERE name NOT IN('New', 'Current', 'Grace', 'Expired', 'Pending', 'Cancelled', 'Deceased')");
$this->restoreDefaultPriceSetConfig();
+ $var = TRUE;
+ CRM_Member_BAO_Membership::createRelatedMemberships($var, $var, TRUE);
+ Civi\Payment\System::singleton()->flushProcessors();
}
- function restoreDefaultPriceSetConfig() {
+ public function restoreDefaultPriceSetConfig() {
CRM_Core_DAO::executeQuery("INSERT INTO `civicrm_price_field` (`id`, `price_set_id`, `name`, `label`, `html_type`, `is_enter_qty`, `help_pre`, `help_post`, `weight`, `is_display_amounts`, `options_per_line`, `is_active`, `is_required`, `active_on`, `expire_on`, `javascript`, `visibility_id`) VALUES (1, 1, 'contribution_amount', 'Contribution Amount', 'Text', 0, NULL, NULL, 1, 1, 1, 1, 1, NULL, NULL, NULL, 1)");
CRM_Core_DAO::executeQuery("INSERT INTO `civicrm_price_field_value` (`id`, `price_field_id`, `name`, `label`, `description`, `amount`, `count`, `max_value`, `weight`, `membership_type_id`, `membership_num_terms`, `is_default`, `is_active`, `financial_type_id`, `deductible_amount`) VALUES (1, 1, 'contribution_amount', 'Contribution Amount', NULL, '1', NULL, NULL, 1, NULL, NULL, 0, 1, 1, 0.00)");
}
/*
* Function does a 'Get' on the entity & compares the fields in the Params with those returned
* Default behaviour is to also delete the entity
- * @param array $params params array to check agains
- * @param int $id id of the entity concerned
- * @param string $entity name of entity concerned (e.g. membership)
- * @param bool $delete should the entity be deleted as part of this check
- * @param string $errorText text to print on error
- *
+ * @param array $params
+ * Params array to check agains.
+ * @param int $id
+ * Id of the entity concerned.
+ * @param string $entity
+ * Name of entity concerned (e.g. membership).
+ * @param bool $delete
+ * Should the entity be deleted as part of this check.
+ * @param string $errorText
+ * Text to print on error.
*/
/**
- * @param $params
- * @param $id
+ * @param array $params
+ * @param int $id
* @param $entity
* @param int $delete
* @param string $errorText
*
* @throws Exception
*/
- function getAndCheck($params, $id, $entity, $delete = 1, $errorText = '') {
+ public function getAndCheck($params, $id, $entity, $delete = 1, $errorText = '') {
$result = $this->callAPISuccessGetSingle($entity, array(
'id' => $id,
if ($type == CRM_Utils_Type::T_DATE) {
$dateFields[] = $settings['name'];
// we should identify both real names & unique names as dates
- if($field != $settings['name']) {
+ if ($field != $settings['name']) {
$dateFields[] = $field;
}
}
- if($type == CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME) {
+ if ($type == CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME) {
$dateTimeFields[] = $settings['name'];
// we should identify both real names & unique names as dates
- if($field != $settings['name']) {
+ if ($field != $settings['name']) {
$dateTimeFields[] = $field;
}
}
}
/**
- * Function to get formatted values in the actual and expected result
- * @param array $actual actual calculated values
- * @param array $expected expected values
- *
+ * Get formatted values in the actual and expected result.
+ * @param array $actual
+ * Actual calculated values.
+ * @param array $expected
+ * Expected values.
*/
- function checkArrayEquals(&$actual, &$expected) {
+ public function checkArrayEquals(&$actual, &$expected) {
self::unsetId($actual);
self::unsetId($expected);
$this->assertEquals($actual, $expected);
}
/**
- * Function to unset the key 'id' from the array
- * @param array $unformattedArray The array from which the 'id' has to be unset
- *
+ * Unset the key 'id' from the array
+ * @param array $unformattedArray
+ * The array from which the 'id' has to be unset.
*/
- static function unsetId(&$unformattedArray) {
+ public static function unsetId(&$unformattedArray) {
$formattedArray = array();
if (array_key_exists('id', $unformattedArray)) {
unset($unformattedArray['id']);
}
if (!empty($unformattedArray['values']) && is_array($unformattedArray['values'])) {
foreach ($unformattedArray['values'] as $key => $value) {
- if (is_Array($value)) {
+ if (is_array($value)) {
foreach ($value as $k => $v) {
if ($k == 'id') {
unset($value[$k]);
/**
* Helper to enable/disable custom directory support
*
- * @param array $customDirs with members:
+ * @param array $customDirs
+ * With members:.
* 'php_path' Set to TRUE to use the default, FALSE or "" to disable support, or a string path to use another path
* 'template_path' Set to TRUE to use the default, FALSE or "" to disable support, or a string path to use another path
*/
- function customDirectories($customDirs) {
+ public function customDirectories($customDirs) {
require_once 'CRM/Core/Config.php';
$config = CRM_Core_Config::singleton();
}
/**
- * Generate a temporary folder
+ * Generate a temporary folder.
*
* @param string $prefix
- * @return string $string
+ * @return string
*/
- function createTempDir($prefix = 'test-') {
+ public function createTempDir($prefix = 'test-') {
$tempDir = CRM_Utils_File::tempdir($prefix);
$this->tempDirs[] = $tempDir;
return $tempDir;
}
- function cleanTempDirs() {
+ public function cleanTempDirs() {
if (!is_array($this->tempDirs)) {
// fix test errors where this is not set
return;
}
/**
- * Temporarily replace the singleton extension with a different one
+ * Temporarily replace the singleton extension with a different one.
+ * @param \CRM_Extension_System $system
*/
- function setExtensionSystem(CRM_Extension_System $system) {
+ public function setExtensionSystem(CRM_Extension_System $system) {
if ($this->origExtensionSystem == NULL) {
$this->origExtensionSystem = CRM_Extension_System::singleton();
}
CRM_Extension_System::setSingleton($this->origExtensionSystem);
}
- function unsetExtensionSystem() {
+ public function unsetExtensionSystem() {
if ($this->origExtensionSystem !== NULL) {
CRM_Extension_System::setSingleton($this->origExtensionSystem);
$this->origExtensionSystem = NULL;
* @param $extras
* @return void
*/
- function setMockSettingsMetaData($extras) {
+ public function setMockSettingsMetaData($extras) {
CRM_Core_BAO_Setting::$_cache = array();
- $this->callAPISuccess('system','flush', array());
+ $this->callAPISuccess('system', 'flush', array());
CRM_Core_BAO_Setting::$_cache = array();
- CRM_Utils_Hook::singleton()->setHook('civicrm_alterSettingsMetaData', function (&$metadata, $domainId, $profile) use ($extras) {
- $metadata = array_merge($metadata, $extras);
- });
+ CRM_Utils_Hook::singleton()
+ ->setHook('civicrm_alterSettingsMetaData', function (&$metadata, $domainId, $profile) use ($extras) {
+ $metadata = array_merge($metadata, $extras);
+ });
$fields = $this->callAPISuccess('setting', 'getfields', array());
foreach ($extras as $key => $spec) {
}
/**
- * @param $name
+ * @param string $name
*/
- function financialAccountDelete($name) {
+ public function financialAccountDelete($name) {
$financialAccount = new CRM_Financial_DAO_FinancialAccount();
$financialAccount->name = $name;
- if($financialAccount->find(TRUE)) {
+ if ($financialAccount->find(TRUE)) {
$entityFinancialType = new CRM_Financial_DAO_EntityFinancialAccount();
$entityFinancialType->financial_account_id = $financialAccount->id;
$entityFinancialType->delete();
}
}
- /**
- * Use $ids as an instruction to do test cleanup
- */
- function deleteFromIDSArray() {
- foreach ($this->ids as $entity => $ids) {
- foreach ($ids as $id) {
- $this->callAPISuccess($entity, 'delete', array('id' => $id));
- }
- }
- }
-
/**
* FIXME: something NULLs $GLOBALS['_HTML_QuickForm_registered_rules'] when the tests are ran all together
* (NB unclear if this is still required)
*/
- function _sethtmlGlobals() {
+ public function _sethtmlGlobals() {
$GLOBALS['_HTML_QuickForm_registered_rules'] = array(
'required' => array(
'html_quickform_rule_required',
- 'HTML/QuickForm/Rule/Required.php'
+ 'HTML/QuickForm/Rule/Required.php',
),
'maxlength' => array(
'html_quickform_rule_range',
- 'HTML/QuickForm/Rule/Range.php'
+ 'HTML/QuickForm/Rule/Range.php',
),
'minlength' => array(
'html_quickform_rule_range',
- 'HTML/QuickForm/Rule/Range.php'
+ 'HTML/QuickForm/Rule/Range.php',
),
'rangelength' => array(
'html_quickform_rule_range',
- 'HTML/QuickForm/Rule/Range.php'
+ 'HTML/QuickForm/Rule/Range.php',
),
'email' => array(
'html_quickform_rule_email',
- 'HTML/QuickForm/Rule/Email.php'
+ 'HTML/QuickForm/Rule/Email.php',
),
'regex' => array(
'html_quickform_rule_regex',
- 'HTML/QuickForm/Rule/Regex.php'
+ 'HTML/QuickForm/Rule/Regex.php',
),
'lettersonly' => array(
'html_quickform_rule_regex',
- 'HTML/QuickForm/Rule/Regex.php'
+ 'HTML/QuickForm/Rule/Regex.php',
),
'alphanumeric' => array(
'html_quickform_rule_regex',
- 'HTML/QuickForm/Rule/Regex.php'
+ 'HTML/QuickForm/Rule/Regex.php',
),
'numeric' => array(
'html_quickform_rule_regex',
- 'HTML/QuickForm/Rule/Regex.php'
+ 'HTML/QuickForm/Rule/Regex.php',
),
'nopunctuation' => array(
'html_quickform_rule_regex',
- 'HTML/QuickForm/Rule/Regex.php'
+ 'HTML/QuickForm/Rule/Regex.php',
),
'nonzero' => array(
'html_quickform_rule_regex',
- 'HTML/QuickForm/Rule/Regex.php'
+ 'HTML/QuickForm/Rule/Regex.php',
),
'callback' => array(
'html_quickform_rule_callback',
- 'HTML/QuickForm/Rule/Callback.php'
+ 'HTML/QuickForm/Rule/Callback.php',
),
'compare' => array(
'html_quickform_rule_compare',
- 'HTML/QuickForm/Rule/Compare.php'
- )
+ 'HTML/QuickForm/Rule/Compare.php',
+ ),
);
// FIXME: …ditto for $GLOBALS['HTML_QUICKFORM_ELEMENT_TYPES']
$GLOBALS['HTML_QUICKFORM_ELEMENT_TYPES'] = array(
'group' => array(
'HTML/QuickForm/group.php',
- 'HTML_QuickForm_group'
+ 'HTML_QuickForm_group',
),
'hidden' => array(
'HTML/QuickForm/hidden.php',
- 'HTML_QuickForm_hidden'
+ 'HTML_QuickForm_hidden',
),
'reset' => array(
'HTML/QuickForm/reset.php',
- 'HTML_QuickForm_reset'
+ 'HTML_QuickForm_reset',
),
'checkbox' => array(
'HTML/QuickForm/checkbox.php',
- 'HTML_QuickForm_checkbox'
+ 'HTML_QuickForm_checkbox',
),
'file' => array(
'HTML/QuickForm/file.php',
- 'HTML_QuickForm_file'
+ 'HTML_QuickForm_file',
),
'image' => array(
'HTML/QuickForm/image.php',
- 'HTML_QuickForm_image'
+ 'HTML_QuickForm_image',
),
'password' => array(
'HTML/QuickForm/password.php',
- 'HTML_QuickForm_password'
+ 'HTML_QuickForm_password',
),
'radio' => array(
'HTML/QuickForm/radio.php',
- 'HTML_QuickForm_radio'
+ 'HTML_QuickForm_radio',
),
'button' => array(
'HTML/QuickForm/button.php',
- 'HTML_QuickForm_button'
+ 'HTML_QuickForm_button',
),
'submit' => array(
'HTML/QuickForm/submit.php',
- 'HTML_QuickForm_submit'
+ 'HTML_QuickForm_submit',
),
'select' => array(
'HTML/QuickForm/select.php',
- 'HTML_QuickForm_select'
+ 'HTML_QuickForm_select',
),
'hiddenselect' => array(
'HTML/QuickForm/hiddenselect.php',
- 'HTML_QuickForm_hiddenselect'
+ 'HTML_QuickForm_hiddenselect',
),
'text' => array(
'HTML/QuickForm/text.php',
- 'HTML_QuickForm_text'
+ 'HTML_QuickForm_text',
),
'textarea' => array(
'HTML/QuickForm/textarea.php',
- 'HTML_QuickForm_textarea'
+ 'HTML_QuickForm_textarea',
),
'fckeditor' => array(
'HTML/QuickForm/fckeditor.php',
- 'HTML_QuickForm_FCKEditor'
+ 'HTML_QuickForm_FCKEditor',
),
'tinymce' => array(
'HTML/QuickForm/tinymce.php',
- 'HTML_QuickForm_TinyMCE'
+ 'HTML_QuickForm_TinyMCE',
),
'dojoeditor' => array(
'HTML/QuickForm/dojoeditor.php',
- 'HTML_QuickForm_dojoeditor'
+ 'HTML_QuickForm_dojoeditor',
),
'link' => array(
'HTML/QuickForm/link.php',
- 'HTML_QuickForm_link'
+ 'HTML_QuickForm_link',
),
'advcheckbox' => array(
'HTML/QuickForm/advcheckbox.php',
- 'HTML_QuickForm_advcheckbox'
+ 'HTML_QuickForm_advcheckbox',
),
'date' => array(
'HTML/QuickForm/date.php',
- 'HTML_QuickForm_date'
+ 'HTML_QuickForm_date',
),
'static' => array(
'HTML/QuickForm/static.php',
- 'HTML_QuickForm_static'
+ 'HTML_QuickForm_static',
),
'header' => array(
'HTML/QuickForm/header.php',
- 'HTML_QuickForm_header'
+ 'HTML_QuickForm_header',
),
'html' => array(
'HTML/QuickForm/html.php',
- 'HTML_QuickForm_html'
+ 'HTML_QuickForm_html',
),
'hierselect' => array(
'HTML/QuickForm/hierselect.php',
- 'HTML_QuickForm_hierselect'
+ 'HTML_QuickForm_hierselect',
),
'autocomplete' => array(
'HTML/QuickForm/autocomplete.php',
- 'HTML_QuickForm_autocomplete'
+ 'HTML_QuickForm_autocomplete',
),
'xbutton' => array(
'HTML/QuickForm/xbutton.php',
- 'HTML_QuickForm_xbutton'
+ 'HTML_QuickForm_xbutton',
),
'advmultiselect' => array(
'HTML/QuickForm/advmultiselect.php',
- 'HTML_QuickForm_advmultiselect'
- )
+ 'HTML_QuickForm_advmultiselect',
+ ),
);
}
* $this->createLoggedInUser();
* $this->_permissionedDisabledGroup = $this->groupCreate(array('title' => 'pick-me-disabled', 'is_active' => 0, 'name' => 'pick-me-disabled'));
* $this->_permissionedGroup = $this->groupCreate(array('title' => 'pick-me-active', 'is_active' => 1, 'name' => 'pick-me-active'));
- *
*/
- function setupACL() {
+ public function setupACL($isProfile = FALSE) {
global $_REQUEST;
$_REQUEST = $this->_params;
CRM_Core_Config::singleton()->userPermissionClass->permissions = array('access CiviCRM');
$optionGroupID = $this->callAPISuccessGetValue('option_group', array('return' => 'id', 'name' => 'acl_role'));
- $optionValue = $this->callAPISuccess('option_value', 'create', array('option_group_id' => $optionGroupID,
+ $optionValue = $this->callAPISuccess('option_value', 'create', array(
+ 'option_group_id' => $optionGroupID,
'label' => 'pick me',
'value' => 55,
));
-
CRM_Core_DAO::executeQuery("
TRUNCATE civicrm_acl_cache
");
TRUNCATE civicrm_acl_contact_cache
");
-
CRM_Core_DAO::executeQuery("
INSERT INTO civicrm_acl_entity_role (
- `acl_role_id`, `entity_table`, `entity_id`
- ) VALUES (55, 'civicrm_group', {$this->_permissionedGroup});
+ `acl_role_id`, `entity_table`, `entity_id`, `is_active`
+ ) VALUES (55, 'civicrm_group', {$this->_permissionedGroup}, 1);
");
- CRM_Core_DAO::executeQuery("
- INSERT INTO civicrm_acl (
- `name`, `entity_table`, `entity_id`, `operation`, `object_table`, `object_id`, `is_active`
- )
- VALUES (
- 'view picked', 'civicrm_group', $this->_permissionedGroup , 'Edit', 'civicrm_saved_search', {$this->_permissionedGroup}, 1
- );
- ");
+ if ($isProfile) {
+ CRM_Core_DAO::executeQuery("
+ INSERT INTO civicrm_acl (
+ `name`, `entity_table`, `entity_id`, `operation`, `object_table`, `object_id`, `is_active`
+ )
+ VALUES (
+ 'view picked', 'civicrm_acl_role', 55, 'Edit', 'civicrm_uf_group', 0, 1
+ );
+ ");
+ }
+ else {
+ CRM_Core_DAO::executeQuery("
+ INSERT INTO civicrm_acl (
+ `name`, `entity_table`, `entity_id`, `operation`, `object_table`, `object_id`, `is_active`
+ )
+ VALUES (
+ 'view picked', 'civicrm_group', $this->_permissionedGroup , 'Edit', 'civicrm_saved_search', {$this->_permissionedGroup}, 1
+ );
+ ");
+
+ CRM_Core_DAO::executeQuery("
+ INSERT INTO civicrm_acl (
+ `name`, `entity_table`, `entity_id`, `operation`, `object_table`, `object_id`, `is_active`
+ )
+ VALUES (
+ 'view picked', 'civicrm_group', $this->_permissionedGroup, 'Edit', 'civicrm_saved_search', {$this->_permissionedDisabledGroup}, 1
+ );
+ ");
+ }
- CRM_Core_DAO::executeQuery("
- INSERT INTO civicrm_acl (
- `name`, `entity_table`, `entity_id`, `operation`, `object_table`, `object_id`, `is_active`
- )
- VALUES (
- 'view picked', 'civicrm_group', $this->_permissionedGroup, 'Edit', 'civicrm_saved_search', {$this->_permissionedDisabledGroup}, 1
- );
- ");
$this->_loggedInUser = CRM_Core_Session::singleton()->get('userID');
$this->callAPISuccess('group_contact', 'create', array(
'group_id' => $this->_permissionedGroup,
'contact_id' => $this->_loggedInUser,
));
- //flush cache
- CRM_ACL_BAO_Cache::resetCache();
- CRM_Contact_BAO_Group::getPermissionClause(TRUE);
- CRM_ACL_API::groupPermission('whatever', 9999, NULL, 'civicrm_saved_search', NULL, NULL, TRUE);
+
+ if (!$isProfile) {
+ //flush cache
+ CRM_ACL_BAO_Cache::resetCache();
+ CRM_Contact_BAO_Group::getPermissionClause(TRUE);
+ CRM_ACL_API::groupPermission('whatever', 9999, NULL, 'civicrm_saved_search', NULL, NULL, TRUE);
+ }
}
/**
- * alter default price set so that the field numbers are not all 1 (hiding errors)
+ * Alter default price set so that the field numbers are not all 1 (hiding errors)
*/
- function offsetDefaultPriceSet() {
+ public function offsetDefaultPriceSet() {
$contributionPriceSet = $this->callAPISuccess('price_set', 'getsingle', array('name' => 'default_contribution_amount'));
$firstID = $contributionPriceSet['id'];
- $this->callAPISuccess('price_set', 'create', array('id' => $contributionPriceSet['id'], 'is_active' => 0, 'name' => 'old'));
+ $this->callAPISuccess('price_set', 'create', array(
+ 'id' => $contributionPriceSet['id'],
+ 'is_active' => 0,
+ 'name' => 'old',
+ ));
unset($contributionPriceSet['id']);
$newPriceSet = $this->callAPISuccess('price_set', 'create', $contributionPriceSet);
- $priceField = $this->callAPISuccess('price_field', 'getsingle', array('price_set_id' => $firstID, 'options' => array('limit' => 1)));
+ $priceField = $this->callAPISuccess('price_field', 'getsingle', array(
+ 'price_set_id' => $firstID,
+ 'options' => array('limit' => 1),
+ ));
unset($priceField['id']);
$priceField['price_set_id'] = $newPriceSet['id'];
$newPriceField = $this->callAPISuccess('price_field', 'create', $priceField);
- $priceFieldValue = $this->callAPISuccess('price_field_value', 'getsingle', array('price_set_id' => $firstID, 'sequential' => 1, 'options' => array('limit' => 1)));
+ $priceFieldValue = $this->callAPISuccess('price_field_value', 'getsingle', array(
+ 'price_set_id' => $firstID,
+ 'sequential' => 1,
+ 'options' => array('limit' => 1),
+ ));
unset($priceFieldValue['id']);
//create some padding to use up ids
$this->callAPISuccess('price_field_value', 'create', array_merge($priceFieldValue, array('price_field_id' => $newPriceField['id'])));
}
-/**
- * Create an instance of the paypal processor
- * @todo this isn't a great place to put it - but really it belongs on a class that extends
- * this parent class & we don't have a structure for that yet
- * There is another function to this effect on the PaypalPro test but it appears to be silently failing
- * & the best protection agains that is the functions this class affords
- */
- function paymentProcessorCreate($params = array()) {
- $params = array_merge(array(
- 'name' => 'demo',
- 'domain_id' => CRM_Core_Config::domainID(),
- 'payment_processor_type_id' => 'PayPal',
- 'is_active' => 1,
- 'is_default' => 0,
- 'is_test' => 1,
- 'user_name' => 'sunil._1183377782_biz_api1.webaccess.co.in',
- 'password' => '1183377788',
- 'signature' => 'APixCoQ-Zsaj-u3IH7mD5Do-7HUqA9loGnLSzsZga9Zr-aNmaJa3WGPH',
- 'url_site' => 'https://www.sandbox.paypal.com/',
- 'url_api' => 'https://api-3t.sandbox.paypal.com/',
- 'url_button' => 'https://www.paypal.com/en_US/i/btn/btn_xpressCheckout.gif',
- 'class_name' => 'Payment_PayPalImpl',
- 'billing_mode' => 3,
- 'financial_type_id' => 1,
- ),
- $params);
- if(!is_numeric($params['payment_processor_type_id'])) {
- // really the api should handle this through getoptions but it's not exactly api call so lets just sort it
- //here
- $params['payment_processor_type_id'] = $this->callAPISuccess('payment_processor_type', 'getvalue', array(
- 'name' => $params['payment_processor_type_id'],
- 'return' => 'id',
- ), 'integer');
- }
- $result = $this->callAPISuccess('payment_processor', 'create', $params);
- return $result['id'];
- }
+ /**
+ * Create an instance of the paypal processor.
+ * @todo this isn't a great place to put it - but really it belongs on a class that extends
+ * this parent class & we don't have a structure for that yet
+ * There is another function to this effect on the PaypalPro test but it appears to be silently failing
+ * & the best protection agains that is the functions this class affords
+ * @param array $params
+ * @return int $result['id'] payment processor id
+ */
+ public function paymentProcessorCreate($params = array()) {
+ $params = array_merge(array(
+ 'name' => 'demo',
+ 'domain_id' => CRM_Core_Config::domainID(),
+ 'payment_processor_type_id' => 'PayPal',
+ 'is_active' => 1,
+ 'is_default' => 0,
+ 'is_test' => 1,
+ 'user_name' => 'sunil._1183377782_biz_api1.webaccess.co.in',
+ 'password' => '1183377788',
+ 'signature' => 'APixCoQ-Zsaj-u3IH7mD5Do-7HUqA9loGnLSzsZga9Zr-aNmaJa3WGPH',
+ 'url_site' => 'https://www.sandbox.paypal.com/',
+ 'url_api' => 'https://api-3t.sandbox.paypal.com/',
+ 'url_button' => 'https://www.paypal.com/en_US/i/btn/btn_xpressCheckout.gif',
+ 'class_name' => 'Payment_PayPalImpl',
+ 'billing_mode' => 3,
+ 'financial_type_id' => 1,
+ ),
+ $params);
+ if (!is_numeric($params['payment_processor_type_id'])) {
+ // really the api should handle this through getoptions but it's not exactly api call so lets just sort it
+ //here
+ $params['payment_processor_type_id'] = $this->callAPISuccess('payment_processor_type', 'getvalue', array(
+ 'name' => $params['payment_processor_type_id'],
+ 'return' => 'id',
+ ), 'integer');
+ }
+ $result = $this->callAPISuccess('payment_processor', 'create', $params);
+ return $result['id'];
+ }
+
+ /**
+ * Set up initial recurring payment allowing subsequent IPN payments.
+ */
+ public function setupRecurringPaymentProcessorTransaction() {
+ $contributionRecur = $this->callAPISuccess('contribution_recur', 'create', array(
+ 'contact_id' => $this->_contactID,
+ 'amount' => 1000,
+ 'sequential' => 1,
+ 'installments' => 5,
+ 'frequency_unit' => 'Month',
+ 'frequency_interval' => 1,
+ 'invoice_id' => $this->_invoiceID,
+ 'contribution_status_id' => 2,
+ 'processor_id' => $this->_paymentProcessorID,
+ 'api.contribution.create' => array(
+ 'total_amount' => '200',
+ 'invoice_id' => $this->_invoiceID,
+ 'financial_type_id' => 1,
+ 'contribution_status_id' => 'Pending',
+ 'contact_id' => $this->_contactID,
+ 'contribution_page_id' => $this->_contributionPageID,
+ 'payment_processor_id' => $this->_paymentProcessorID,
+ ),
+ ));
+ $this->_contributionRecurID = $contributionRecur['id'];
+ $this->_contributionID = $contributionRecur['values']['0']['api.contribution.create']['id'];
+ }
+
+ /**
+ * We don't have a good way to set up a recurring contribution with a membership so let's just do one then alter it
+ */
+ public function setupMembershipRecurringPaymentProcessorTransaction() {
+ $this->ids['membership_type'] = $this->membershipTypeCreate();
+ //create a contribution so our membership & contribution don't both have id = 1
+ $this->contributionCreate($this->_contactID, 1, 'abcd', '345j');
+ $this->setupRecurringPaymentProcessorTransaction();
+ $this->ids['membership'] = $this->callAPISuccess('membership', 'create', array(
+ 'contact_id' => $this->_contactID,
+ 'membership_type_id' => $this->ids['membership_type'],
+ 'contribution_recur_id' => $this->_contributionRecurID,
+ 'format.only_id' => TRUE,
+ ));
+ //CRM-15055 creates line items we don't want so get rid of them so we can set up our own line items
+ CRM_Core_DAO::executeQuery("TRUNCATE civicrm_line_item");
+
+ $this->callAPISuccess('line_item', 'create', array(
+ 'entity_table' => 'civicrm_membership',
+ 'entity_id' => $this->ids['membership'],
+ 'contribution_id' => $this->_contributionID,
+ 'label' => 'General',
+ 'qty' => 1,
+ 'unit_price' => 200,
+ 'line_total' => 200,
+ 'financial_type_id' => 1,
+ 'price_field_id' => $this->callAPISuccess('price_field', 'getvalue', array(
+ 'return' => 'id',
+ 'label' => 'Membership Amount',
+ )),
+ 'price_field_value_id' => $this->callAPISuccess('price_field_value', 'getvalue', array(
+ 'return' => 'id',
+ 'label' => 'General',
+ )),
+ ));
+ $this->callAPISuccess('membership_payment', 'create', array(
+ 'contribution_id' => $this->_contributionID,
+ 'membership_id' => $this->ids['membership'],
+ ));
+ }
/**
* @param $message
*
* @throws Exception
- */function CiviUnitTestCase_fatalErrorHandler($message) {
- throw new Exception("{$message['message']}: {$message['code']}");
-}
+ */
+ public function CiviUnitTestCase_fatalErrorHandler($message) {
+ throw new Exception("{$message['message']}: {$message['code']}");
+ }
+
+ /**
+ * Helper function to create new mailing.
+ * @return mixed
+ */
+ public function createMailing() {
+ $params = array(
+ 'subject' => 'maild' . rand(),
+ 'body_text' => 'bdkfhdskfhduew{domain.address}{action.optOutUrl}',
+ 'name' => 'mailing name' . rand(),
+ 'created_id' => 1,
+ );
+
+ $result = $this->callAPISuccess('Mailing', 'create', $params);
+ return $result['id'];
+ }
+
+ /**
+ * Helper function to delete mailing.
+ * @param $id
+ */
+ public function deleteMailing($id) {
+ $params = array(
+ 'id' => $id,
+ );
+
+ $this->callAPISuccess('Mailing', 'delete', $params);
+ }
+
+ /**
+ * Wrap the entire test case in a transaction.
+ *
+ * Only subsequent DB statements will be wrapped in TX -- this cannot
+ * retroactively wrap old DB statements. Therefore, it makes sense to
+ * call this at the beginning of setUp().
+ *
+ * Note: Recall that TRUNCATE and ALTER will force-commit transactions, so
+ * this option does not work with, e.g., custom-data.
+ *
+ * WISHLIST: Monitor SQL queries in unit-tests and generate an exception
+ * if TRUNCATE or ALTER is called while using a transaction.
+ *
+ * @param bool $nest
+ * Whether to use nesting or reference-counting.
+ */
+ public function useTransaction($nest = TRUE) {
+ if (!$this->tx) {
+ $this->tx = new CRM_Core_Transaction($nest);
+ $this->tx->rollback();
+ }
+ }
+
+ public function clearOutputBuffer() {
+ while (ob_get_level() > 0) {
+ ob_end_clean();
+ }
+ }
+
+ /**
+ * @param $exists
+ * @param array $apiResult
+ */
+ protected function assertAttachmentExistence($exists, $apiResult) {
+ $fileId = $apiResult['id'];
+ $this->assertTrue(is_numeric($fileId));
+ $this->assertEquals($exists, file_exists($apiResult['values'][$fileId]['path']));
+ $this->assertDBQuery($exists ? 1 : 0, 'SELECT count(*) FROM civicrm_file WHERE id = %1', array(
+ 1 => array($fileId, 'Int'),
+ ));
+ $this->assertDBQuery($exists ? 1 : 0, 'SELECT count(*) FROM civicrm_entity_file WHERE id = %1', array(
+ 1 => array($fileId, 'Int'),
+ ));
+ }
+
}
projects / civicrm-core.git / blobdiff