*/
static protected $_dbName;
+ /**
+ * Track tables we have modified during a test
+ */
+ protected $_tablesToTruncate = array();
+
/**
* @var array of temporary directory names
*/
}
}
+ /**
+ * @return bool
+ */
function requireDBReset() {
return $this->DBResetRequired;
}
+ /**
+ * @return string
+ */
static function getDBName() {
$dbName = !empty($GLOBALS['mysql_db']) ? $GLOBALS['mysql_db'] : 'civicrm_tests_dev';
return $dbName;
$GLOBALS['_PEAR_ERRORSTACK_OVERRIDE_CALLBACK'] = array();
$env = new CRM_Utils_Check_Env();
- CRM_Utils_Check::singleton()->assertValid($env->checkAll());
+ CRM_Utils_Check::singleton()->assertValid($env->checkMysqlTime());
}
/**
else {
error_reporting(E_ALL & ~E_NOTICE);
}
+ $this->_sethtmlGlobals();
+ }
+
+ /**
+ * Read everything from the datasets directory and insert into the db
+ */
+ public function loadAllFixtures() {
+ $fixturesDir = __DIR__ . '/../../fixtures';
+
+ $this->getConnection()->getConnection()->query("SET FOREIGN_KEY_CHECKS = 0;");
+
+ $xmlFiles = glob($fixturesDir . '/*.xml');
+ foreach ($xmlFiles as $xmlFixture) {
+ $op = new PHPUnit_Extensions_Database_Operation_Insert();
+ $dataset = new PHPUnit_Extensions_Database_DataSet_XMLDataSet($xmlFixture);
+ $this->_tablesToTruncate = array_merge($this->_tablesToTruncate, $dataset->getTableNames());
+ $op->execute($this->_dbconn, $dataset);
+ }
+
+ $yamlFiles = glob($fixturesDir . '/*.yaml');
+ foreach ($yamlFiles as $yamlFixture) {
+ $op = new PHPUnit_Extensions_Database_Operation_Insert();
+ $dataset = new PHPUnit_Extensions_Database_DataSet_YamlDataSet($yamlFixture);
+ $this->_tablesToTruncate = array_merge($this->_tablesToTruncate, $dataset->getTableNames());
+ $op->execute($this->_dbconn, $dataset);
+ }
+
+ $this->getConnection()->getConnection()->query("SET FOREIGN_KEY_CHECKS = 1;");
}
/**
}
// Request a record from the DB by seachColumn+searchValue. Success if a record is found.
+ /**
+ * @param $daoName
+ * @param $searchValue
+ * @param $returnColumn
+ * @param $searchColumn
+ * @param $message
+ *
+ * @return null|string
+ * @throws PHPUnit_Framework_AssertionFailedError
+ */
function assertDBNotNull($daoName, $searchValue, $returnColumn, $searchColumn, $message) {
if (empty($searchValue)) {
$this->fail("empty value passed to assertDBNotNull");
}
// Request a record from the DB by seachColumn+searchValue. Success if returnColumn value is NULL.
+ /**
+ * @param $daoName
+ * @param $searchValue
+ * @param $returnColumn
+ * @param $searchColumn
+ * @param $message
+ */
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
+ * @param null $message
+ */
function assertDBRowNotExist($daoName, $id, $message = NULL) {
$message = $message ? $message : "$daoName (#$id) should not exist";
$value = CRM_Core_DAO::getFieldValue($daoName, $id, 'id', 'id', TRUE);
}
// Request a record from the DB by id. Success if row not found.
+ /**
+ * @param $daoName
+ * @param $id
+ * @param null $message
+ */
function assertDBRowExist($daoName, $id, $message = NULL) {
$message = $message ? $message : "$daoName (#$id) should exist";
$value = CRM_Core_DAO::getFieldValue($daoName, $id, 'id', 'id', TRUE);
}
// Compare a single column value in a retrieved DB record to an expected value
+ /**
+ * @param $daoName
+ * @param $searchValue
+ * @param $returnColumn
+ * @param $searchColumn
+ * @param $expectedValue
+ * @param $message
+ */
function assertDBCompareValue($daoName, $searchValue, $returnColumn, $searchColumn,
$expectedValue, $message
) {
}
// Compare all values in a single retrieved DB record to an array of expected values
+ /**
+ * @param $daoName
+ * @param $searchParams
+ * @param $expectedValues
+ */
function assertDBCompareValues($daoName, $searchParams, $expectedValues) {
//get the values from db
$dbValues = array();
$this->assertTrue(abs($actual - $expected) < $tolerance, $message);
}
+ /**
+ * @param $expectedValues
+ * @param $actualValues
+ * @param null $message
+ *
+ * @throws PHPUnit_Framework_AssertionFailedError
+ */
function assertAttributesEquals($expectedValues, $actualValues, $message = NULL) {
foreach ($expectedValues as $paramName => $paramValue) {
if (isset($actualValues[$paramName])) {
}
}
+ /**
+ * @param $key
+ * @param $list
+ */
function assertArrayKeyExists($key, &$list) {
$result = isset($list[$key]) ? TRUE : FALSE;
$this->assertTrue($result, ts("%1 element exists?",
));
}
+ /**
+ * @param $key
+ * @param $list
+ */
function assertArrayValueNotNull($key, &$list) {
$this->assertArrayKeyExists($key, $list);
/**
* check that api returned 'is_error' => 1
* else provide full message
+ *
* @param array $apiResult api result
* @param string $prefix extra test to add to message
+ * @param null $expectedError
*/
function assertAPIFailure($apiResult, $prefix = '', $expectedError = NULL) {
if (!empty($prefix)) {
$this->assertNotEmpty($apiResult['error_message']);
}
+ /**
+ * @param $expected
+ * @param $actual
+ * @param string $message
+ */
function assertType($expected, $actual, $message = '') {
return $this->assertInternalType($expected, $actual, $message);
}
/**
* check that api returned 'is_error' => 1
* else provide full message
- * @param array $apiResult api result
+ * @param $result
+ * @param $expected
+ * @param array $valuesToExclude
* @param string $prefix extra test to add to message
+ * @internal param array $apiResult api result
*/
function assertAPIArrayComparison($result, $expected, $valuesToExclude = array(), $prefix = '') {
$valuesToExclude = array_merge($valuesToExclude, array('debug', 'xdebug', 'sequential'));
$this->assertEquals($result, $expected, "api result array comparison failed " . $prefix . print_r($result, TRUE) . ' was compared to ' . print_r($expected, TRUE));
}
+ /**
+ * A stub for the API interface. This can be overriden by subclasses to change how the API is called.
+ *
+ * @param $entity
+ * @param $action
+ * @param $params
+ * @return array|int
+ */
+ function civicrm_api($entity, $action, $params) {
+ return civicrm_api($entity, $action, $params);
+ }
+
/**
* This function exists to 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
* 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) {
$params = array_merge(array(
case 'getcount' :
return $this->callAPISuccessGetCount($entity, $params, $checkAgainst);
}
- $result = civicrm_api($entity, $action, $params);
+ $result = $this->civicrm_api($entity, $action, $params);
$this->assertAPISuccess($result, "Failure in api call for $entity $action");
return $result;
}
* This function exists to wrap api getValue function & check the result
* so we can ensure they succeed & throw exceptions without litterering the test with checks
* There is a type check in this
+ *
* @param string $entity
* @param array $params
* @param string $type - per http://php.net/manual/en/function.gettype.php possible types
* - string
* - array
* - object
+ *
+ * @return array|int
*/
function callAPISuccessGetValue($entity, $params, $type = NULL) {
$params += array(
'version' => $this->_apiversion,
'debug' => 1,
);
- $result = civicrm_api($entity, 'getvalue', $params);
+ $result = $this->civicrm_api($entity, 'getvalue', $params);
if($type){
if($type == 'integer'){
// api seems to return integers as strings
/**
* This function exists to wrap api getsingle function & check the result
* so we can ensure they succeed & throw exceptions without litterering the test with checks
+ *
* @param string $entity
* @param array $params
* @param array $checkAgainst - array to compare result against
* - string
* - array
* - object
+ *
+ * @throws Exception
+ * @return array|int
*/
function callAPISuccessGetSingle($entity, $params, $checkAgainst = NULL) {
$params += array(
'version' => $this->_apiversion,
'debug' => 1,
);
- $result = civicrm_api($entity, 'getsingle', $params);
+ $result = $this->civicrm_api($entity, 'getsingle', $params);
if(!is_array($result) || !empty($result['is_error']) || isset($result['values'])) {
throw new Exception('Invalid getsingle result' . print_r($result, TRUE));
}
}
return $result;
}
+
/**
* This function exists to wrap api getValue function & check the result
* so we can ensure they succeed & throw exceptions without litterering the test with checks
* There is a type check in this
* @param string $entity
* @param array $params
- * @param string $type - per http://php.net/manual/en/function.gettype.php possible types
+ * @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
'version' => $this->_apiversion,
'debug' => 1,
);
- $result = civicrm_api($entity, 'getcount', $params);
+ $result = $this->civicrm_api($entity, 'getcount', $params);
if(!is_integer($result) || !empty($result['is_error']) || isset($result['values'])) {
throw new Exception('Invalid getcount result : ' . print_r($result, TRUE) . " type :" . gettype($result));
}
}
return $result;
}
+
/**
* 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 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 $description
+ * @param string|null $subfile
+ * @param string|null $actionName
+ * @return array|int
*/
function callAPIAndDocument($entity, $action, $params, $function, $file, $description = "", $subfile = NULL, $actionName = NULL){
$params['version'] = $this->_apiversion;
* @param string $action
* @param array $params
* @param string $expectedErrorMessage error
+ * @param null $extraOutput
+ * @return array|int
*/
function callAPIFailure($entity, $action, $params, $expectedErrorMessage = NULL, $extraOutput = NULL) {
if (is_array($params)) {
'version' => $this->_apiversion,
);
}
- $result = civicrm_api($entity, $action, $params);
+ $result = $this->civicrm_api($entity, $action, $params);
$this->assertAPIFailure($result, "We expected a failure for $entity $action but got a success");
return $result;
}
*/
private function _contactCreate($params) {
$result = $this->callAPISuccess('contact', 'create', $params);
- if (CRM_Utils_Array::value('is_error', $result) ||
- !CRM_Utils_Array::value('id', $result)
- ) {
+ if (!empty($result['is_error']) || empty($result['id'])) {
throw new Exception('Could not create test contact, with message: ' . CRM_Utils_Array::value('error_message', $result) . "\nBacktrace:" . CRM_Utils_Array::value('trace', $result));
}
return $result['id'];
}
+ /**
+ * @param $contactID
+ *
+ * @return array|int
+ */
function contactDelete($contactID) {
$params = array(
'id' => $contactID,
return $result;
}
+ /**
+ * @param $contactTypeId
+ *
+ * @throws Exception
+ */
function contactTypeDelete($contactTypeId) {
require_once 'CRM/Contact/BAO/ContactType.php';
$result = CRM_Contact_BAO_ContactType::del($contactTypeId);
}
}
+ /**
+ * @param array $params
+ *
+ * @return mixed
+ */
function membershipTypeCreate($params = array()) {
CRM_Member_PseudoConstant::flush('membershipType');
CRM_Core_Config::clearDBCache();
+ $memberOfOrganization = $this->organizationCreate();
$params = array_merge(array(
'name' => 'General',
'duration_unit' => 'year',
'duration_interval' => 1,
'period_type' => 'rolling',
- 'member_of_contact_id' => 1,
+ 'member_of_contact_id' => $memberOfOrganization,
'domain_id' => 1,
'financial_type_id' => 1,
'is_active' => 1,
'sequential' => 1,
- 'visibility' => 1,
+ 'visibility' => 'Public',
), $params);
$result = $this->callAPISuccess('MembershipType', 'Create', $params);
return $result['id'];
}
+ /**
+ * @param $params
+ *
+ * @return mixed
+ */
function contactMembershipCreate($params) {
$pre = array(
'join_date' => '2007-01-21',
/**
* Function to delete Membership Type
*
- * @param int $membershipTypeID
+ * @param $params
+ * @internal param int $membershipTypeID
*/
function membershipTypeDelete($params) {
- $result = $this->callAPISuccess('MembershipType', 'Delete', $params);
- return;
+ $this->callAPISuccess('MembershipType', 'Delete', $params);
}
+ /**
+ * @param $membershipID
+ */
function membershipDelete($membershipID) {
$deleteParams = array('id' => $membershipID);
$result = $this->callAPISuccess('Membership', 'Delete', $deleteParams);
return;
}
+ /**
+ * @param string $name
+ *
+ * @return mixed
+ */
function membershipStatusCreate($name = 'test member status') {
$params['name'] = $name;
$params['start_event'] = 'start_date';
return $result['id'];
}
+ /**
+ * @param $membershipStatusID
+ */
function membershipStatusDelete($membershipStatusID) {
if (!$membershipStatusID) {
return;
return;
}
+ /**
+ * @param array $params
+ *
+ * @return mixed
+ */
function relationshipTypeCreate($params = array()) {
$params = array_merge(array(
'name_a_b' => 'Relation 1 for relationship type create',
$this->callAPISuccess('relationship_type', 'delete', $params);
}
+ /**
+ * @param null $params
+ *
+ * @return mixed
+ */
function paymentProcessorTypeCreate($params = NULL) {
if (is_null($params)) {
$params = array(
/**
* Function to create contribution page
*
+ * @param $params
* @return object of contribution page
*/
function contributionPageCreate($params) {
/**
* Function to create Tag
*
+ * @param array $params
* @return array result of created tag
*/
function tagCreate($params = array()) {
/**
* Add entity(s) to the tag
*
- * @param array $params
+ * @param array $params
+ *
+ * @return bool
*/
function entityTagAdd($params) {
$result = $this->callAPISuccess('entity_tag', 'create', $params);
/**
* Function to create contribution
*
- * @param int $cID contact_id
- * @param int $cTypeID id of financial type
+ * @param int $cID contact_id
+ *
+ * @internal param int $cTypeID id of financial type
*
* @return int id of created contribution
*/
/**
* Function to delete contribution
*
- * @param int $contributionId
+ * @param $pledgeId
+ * @internal param int $contributionId
*/
function pledgeDelete($pledgeId) {
$params = array(
/**
* Function to create contribution
*
- * @param int $cID contact_id
- * @param int $cTypeID id of financial type
+ * @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
*/
function contributionCreate($cID, $cTypeID = 1, $invoiceID = 67890, $trxnID = 12345, $paymentInstrumentID = 1, $isFee = TRUE) {
/**
* Function to create online contribution
*
- * @param int $financialType id of financial type
+ * @param $params
+ * @param int $financialType id of financial type
*
+ * @param int $invoiceID
+ * @param int $trxnID
* @return int id of created contribution
*/
function onlineContributionCreate($params, $financialType, $invoiceID = 67890, $trxnID = 12345) {
* Function to delete contribution
*
* @param int $contributionId
+ *
+ * @return array|int
*/
function contributionDelete($contributionId) {
$params = array(
/**
* Function to delete event
*
- * @param int $id ID of the event
+ * @param int $id ID of the event
+ *
+ * @return array|int
*/
function eventDelete($id) {
$params = array(
* Function to delete participant
*
* @param int $participantID
+ *
+ * @return array|int
*/
function participantDelete($participantID) {
$params = array(
/**
* Function to create participant payment
*
+ * @param $participantID
+ * @param null $contributionID
* @return int $id of created payment
*/
function participantPaymentCreate($participantID, $contributionID = NULL) {
/**
* Function to add a Location
*
+ * @param $contactID
* @return int location id of created location
*/
function locationAdd($contactID) {
/**
* Function to add a Location Type
*
+ * @param null $params
* @return int location id of created location
*/
function locationTypeCreate($params = NULL) {
*
* @params array to add group
*
+ * @param array $params
* @return int groupId of created group
- *
*/
function groupCreate($params = array()) {
$params = array_merge(array(
/**
* Function to delete a Group
*
- * @param int $id
+ * @param $gid
+ * @internal param int $id
*/
function groupDelete($gid) {
), $params);
$this->callAPISuccess('uf_field', 'create', $params);
}
+
/**
* Function to add a UF Join Entry
*
+ * @param null $params
* @return int $id of created UF Join
*/
function ufjoinCreate($params = NULL) {
/**
* Function to delete Group for a contact
*
- * @param array $params
+ * @param $contactId
+ * @internal param array $params
*/
function contactGroupDelete($contactId) {
$params = array(
'contact_id.1' => $contactId,
'group_id' => 1,
);
- civicrm_api('GroupContact', 'Delete', $params);
+ $this->civicrm_api('GroupContact', 'Delete', $params);
}
/**
* Function to create Activity
*
- * @param int $contactId
+ * @param null $params
+ * @return array|int
+ * @internal param int $contactId
*/
function activityCreate($params = NULL) {
/**
* Function to create custom group
*
- * @param string $className
- * @param string $title name of custom group
+ * @param array $params
+ * @return array|int
+ * @internal param string $className
+ * @internal param string $title name of custom group
*/
function customGroupCreate($params = array()) {
$defaults = array(
* participant:testCreateWithCustom for how to use this
*
* @param string $function __FUNCTION__
- * @param string $file __FILE__
+ * @param $filename
+ * @internal param string $file __FILE__
*
* @return array $ids ids of created objects
- *
*/
function entityCustomGroupWithSingleFieldCreate($function, $filename) {
$params = array('title' => $function);
/**
* Function to delete custom group
*
- * @param int $customGroupID
+ * @param int $customGroupID
+ *
+ * @return array|int
*/
function customGroupDelete($customGroupID) {
$params['id'] = $customGroupID;
* Function to create custom field
*
* @param array $params (custom_group_id) is required
- * @param string $name name of custom field
- * @param int $apiversion API version to use
+ * @return array|int
+ * @internal param string $name name of custom field
+ * @internal param int $apiversion API version to use
*/
function customFieldCreate($params) {
$params = array_merge(array(
* Function to delete custom field
*
* @param int $customFieldID
+ *
+ * @return array|int
*/
function customFieldDelete($customFieldID) {
*
* @params array $params name-value pair for an event
*
+ * @param $cId
* @return array $note
*/
function noteCreate($cId) {
$action = empty($action) ? 'getfields' : $action;
$entityAction = 'GetFields';
}
+ elseif (strstr($function, 'GetList')) {
+ $action = empty($action) ? 'getlist' : $action;
+ $entityAction = 'GetList';
+ }
elseif (strstr($function, 'Get')) {
$action = empty($action) ? 'get' : $action;
$entityAction = 'Get';
/**
* Tidy up examples array so that fields that change often ..don't
* and debug related fields are unset
- * @param array $params
+ *
+ * @param $result
+ *
+ * @internal param array $params
*/
function tidyExampleResult(&$result){
if(!is_array($result)) {
/**
* Function to create custom field with Option Values
*
- * @param array $customGroup
- * @param string $name name of custom field
+ * @param array $customGroup
+ * @param string $name name of custom field
+ *
+ * @return array|int
*/
function customFieldOptionValueCreate($customGroup, $name) {
$fieldParams = array(
return $this->callAPISuccess('custom_field', 'create', $params);
}
+ /**
+ * @param $entities
+ *
+ * @return bool
+ */
function confirmEntitiesDeleted($entities) {
foreach ($entities as $entity) {
}
}
+ /**
+ * @param $tablesToTruncate
+ * @param bool $dropCustomValueTables
+ */
function quickCleanup($tablesToTruncate, $dropCustomValueTables = FALSE) {
if ($dropCustomValueTables) {
$tablesToTruncate[] = 'civicrm_custom_group';
$tablesToTruncate[] = 'civicrm_custom_field';
}
+ $tablesToTruncate = array_unique(array_merge($this->_tablesToTruncate, $tablesToTruncate));
+
CRM_Core_DAO::executeQuery("SET FOREIGN_KEY_CHECKS = 0;");
foreach ($tablesToTruncate as $table) {
$sql = "TRUNCATE TABLE $table";
}
}
+ /**
+ * Clean up financial entities after financial tests (so we remember to get all the tables :-))
+ */
+ function quickCleanUpFinancialEntities() {
+ $tablesToTruncate = array(
+ 'civicrm_contribution',
+ 'civicrm_financial_trxn',
+ 'civicrm_contribution_recur',
+ 'civicrm_line_item',
+ 'civicrm_contribution_page',
+ 'civicrm_payment_processor',
+ 'civicrm_entity_financial_trxn',
+ 'civicrm_membership',
+ 'civicrm_membership_type',
+ 'civicrm_membership_payment',
+ 'civicrm_membership_log',
+ 'civicrm_membership_block',
+ 'civicrm_event',
+ 'civicrm_participant',
+ 'civicrm_participant_payment',
+ 'civicrm_pledge',
+ 'civicrm_price_set_entity',
+ );
+ $this->quickCleanup($tablesToTruncate);
+ CRM_Core_DAO::executeQuery("DELETE FROM civicrm_membership_status WHERE name NOT IN('New', 'Current', 'Grace', 'Expired', 'Pending', 'Cancelled', 'Deceased')");
+ }
/*
* 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 string $errorText text to print on error
*
*/
+ /**
+ * @param $params
+ * @param $id
+ * @param $entity
+ * @param int $delete
+ * @param string $errorText
+ *
+ * @throws Exception
+ */
function getAndCheck($params, $id, $entity, $delete = 1, $errorText = '') {
$result = $this->callAPISuccessGetSingle($entity, array(
if (array_key_exists('id', $unformattedArray)) {
unset($unformattedArray['id']);
}
- if (CRM_Utils_Array::value('values', $unformattedArray) && is_array($unformattedArray['values'])) {
+ if (!empty($unformattedArray['values']) && is_array($unformattedArray['values'])) {
foreach ($unformattedArray['values'] as $key => $value) {
if (is_Array($value)) {
foreach ($value as $k => $v) {
/**
* Generate a temporary folder
*
- * @return $string
+ * @param string $prefix
+ * @return string $string
*/
function createTempDir($prefix = 'test-') {
$tempDir = CRM_Utils_File::tempdir($prefix);
}
}
+ /**
+ * @param $name
+ */
function financialAccountDelete($name) {
$financialAccount = new CRM_Financial_DAO_FinancialAccount();
$financialAccount->name = $name;
);
}
-/**
- * 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'];
- }
-
-
-function CiviUnitTestCase_fatalErrorHandler($message) {
- throw new Exception("{$message['message']}: {$message['code']}");
-}
+ /**
+ * Set up an acl allowing contact to see 2 specified groups
+ * - $this->_permissionedGroup & $this->_permissionedDisbaledGroup
+ *
+ * You need to have precreated these groups & created the user e.g
+ * $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() {
+ 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,
+ 'label' => 'pick me',
+ 'value' => 55,
+ ));
+
+
+ CRM_Core_DAO::executeQuery("
+ TRUNCATE civicrm_acl_cache
+ ");
+
+ CRM_Core_DAO::executeQuery("
+ 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});
+ ");
+
+ 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
+ );
+ ");
+ $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);
+ }
+
+ /**
+ * alter default price set so that the field numbers are not all 1 (hiding errors)
+ */
+ 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'));
+ 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)));
+ 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)));
+
+ unset($priceFieldValue['id']);
+ //create some padding to use up ids
+ $this->callAPISuccess('price_field_value', 'create', $priceFieldValue);
+ $this->callAPISuccess('price_field_value', 'create', $priceFieldValue);
+ $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'];
+ }
+
+ /**
+ * @param $message
+ *
+ * @throws Exception
+ */
+ function CiviUnitTestCase_fatalErrorHandler($message) {
+ throw new Exception("{$message['message']}: {$message['code']}");
+ }
+
+ /**
+ * Helper function to create new mailing
+ * @return mixed
+ */
+ function createMailing() {
+ $params = array(
+ 'subject' => 'maild' . rand(),
+ 'body_text' => 'bdkfhdskfhduew',
+ 'name' => 'mailing name' . rand(),
+ 'created_id' => 1,
+ );
+
+ $result = $this->callAPISuccess('Mailing', 'create', $params);
+ return $result['id'];
+ }
+
+ /**
+ * Helper function to delete mailing
+ * @param $id
+ */
+ function deleteMailing($id) {
+ $params = array(
+ 'id' => $id,
+ );
+
+ $this->callAPISuccess('Mailing', 'delete', $params);
+ }
}
projects / civicrm-core.git / blobdiff