* @package CiviCRM_APIv3
* @subpackage API_Core
*/
-
class api_v3_SyntaxConformanceTest extends CiviUnitTestCase {
protected $_apiversion = 3;
public function setUp() {
parent::setUp();
$this->enableCiviCampaign();
- $this->toBeImplemented['get'] = array('Profile', 'CustomValue', 'Constant', 'CustomSearch', 'Extension', 'ReportTemplate', 'System', 'Setting');
- $this->toBeImplemented['create'] = array('SurveyRespondant', 'OptionGroup', 'MailingRecipients', 'UFMatch', 'LocationType', 'CustomSearch', 'Extension', 'ReportTemplate', 'System');
- $this->toBeImplemented['delete'] = array('MembershipPayment', 'OptionGroup', 'SurveyRespondant', 'UFJoin', 'UFMatch', 'Extension', 'LocationType', 'System');
+ $this->toBeImplemented['get'] = array(
+ 'Profile',
+ 'CustomValue',
+ 'Constant',
+ 'CustomSearch',
+ 'Extension',
+ 'ReportTemplate',
+ 'System',
+ 'Setting'
+ );
+ $this->toBeImplemented['create'] = array(
+ 'SurveyRespondant',
+ 'OptionGroup',
+ 'MailingRecipients',
+ 'UFMatch',
+ 'LocationType',
+ 'CustomSearch',
+ 'Extension',
+ 'ReportTemplate',
+ 'System'
+ );
+ $this->toBeImplemented['delete'] = array(
+ 'MembershipPayment',
+ 'OptionGroup',
+ 'SurveyRespondant',
+ 'UFJoin',
+ 'UFMatch',
+ 'Extension',
+ 'LocationType',
+ 'System'
+ );
$this->onlyIDNonZeroCount['get'] = array('ActivityType', 'Entity', 'Domain', 'Setting');
$this->deprecatedAPI = array('Location', 'ActivityType', 'SurveyRespondant');
$this->deletableTestObjects = array();
public static function entities_getSqlOperators() {
return static::entities(static::toBeSkipped_getSqlOperators());
}
+
/**
* @return array
*/
public static function entities_getfields() {
return static::entities(static::toBeSkipped_getfields(TRUE));
}
+
/**
* @return array
*/
$entitiesToFix = array('Case', 'Relationship');
foreach ($entities as $entityName => $entity) {
if (!in_array($entityName, $invalidEntities)
- && !in_array($entityName, $entitiesToFix)) {
+ && !in_array($entityName, $entitiesToFix)
+ ) {
if (!empty(self::$componentMap[$entityName]) && empty($enabledComponents[self::$componentMap[$entityName]])) {
CRM_Core_BAO_ConfigSetting::enableComponent(self::$componentMap[$entityName]);
}
* @return array
*/
public static function toBeSkipped_get($sequential = FALSE) {
- $entitiesWithoutGet = array('MailingEventSubscribe', 'MailingEventConfirm', 'MailingEventResubscribe', 'MailingEventUnsubscribe', 'Location');
+ $entitiesWithoutGet = array(
+ 'MailingEventSubscribe',
+ 'MailingEventConfirm',
+ 'MailingEventResubscribe',
+ 'MailingEventUnsubscribe',
+ 'Location'
+ );
if ($sequential === TRUE) {
return $entitiesWithoutGet;
}
* @return array
*/
public static function toBeSkipped_delete($sequential = FALSE) {
- $entitiesWithout = array('MailingContact', 'MailingEventConfirm', 'MailingEventResubscribe', 'MailingEventSubscribe', 'MailingEventUnsubscribe', 'MailingRecipients', 'Constant', 'Entity', 'Location', 'Domain', 'Profile', 'CustomValue', 'Setting');
+ $entitiesWithout = array(
+ 'MailingContact',
+ 'MailingEventConfirm',
+ 'MailingEventResubscribe',
+ 'MailingEventSubscribe',
+ 'MailingEventUnsubscribe',
+ 'MailingRecipients',
+ 'Constant',
+ 'Entity',
+ 'Location',
+ 'Domain',
+ 'Profile',
+ 'CustomValue',
+ 'Setting'
+ );
if ($sequential === TRUE) {
return $entitiesWithout;
}
}
return $entities;
}
+
/**
* Generate list of entities to test for get by id functions
* @param bool $sequential
* Entities to be skipped
*/
public static function toBeSkipped_automock($sequential = FALSE) {
- $entitiesWithoutGet = array('MailingContact', 'EntityTag', 'Participant', 'ParticipantPayment', 'Setting', 'SurveyRespondant', 'MailingRecipients', 'CustomSearch', 'Extension', 'ReportTemplate', 'System');
+ $entitiesWithoutGet = array(
+ 'MailingContact',
+ 'EntityTag',
+ 'Participant',
+ 'ParticipantPayment',
+ 'Setting',
+ 'SurveyRespondant',
+ 'MailingRecipients',
+ 'CustomSearch',
+ 'Extension',
+ 'ReportTemplate',
+ 'System'
+ );
if ($sequential === TRUE) {
return $entitiesWithoutGet;
}
*/
public static function toBeSkipped_updatesingle($sequential = FALSE) {
$entitiesWithout = array(
- 'Attachment', // pseudo-entity; testUpdateSingleValueAlter doesn't introspect properly on it. Multiple magic fields
+ 'Attachment',
+ // pseudo-entity; testUpdateSingleValueAlter doesn't introspect properly on it. Multiple magic fields
'Mailing',
'MailingGroup',
'MailingJob',
'PaymentProcessor',
'Setting',
'MailingContact',
- 'SystemLog' //skip this because it doesn't make sense to update logs,
+ 'SystemLog'
+ //skip this because it doesn't make sense to update logs,
);
if ($sequential === TRUE) {
return $entitiesWithout;
*/
public static function toBeSkipped_getlimit() {
$entitiesWithout = array(
- 'Case', //case api has non-std mandatory fields one of (case_id, contact_id, activity_id, contact_id)
- 'EntityTag', // non-standard api - has inappropriate mandatory fields & doesn't implement limit
- 'Event', // failed 'check that a 5 limit returns 5' - probably is_template field is wrong or something, or could be limit doesn't work right
- 'Extension', // can't handle creating 25
- 'Note', // fails on 5 limit - probably a set up problem
- 'Setting', //a bit of a pseudoapi - keys by domain
+ 'Case',
+ //case api has non-std mandatory fields one of (case_id, contact_id, activity_id, contact_id)
+ 'EntityTag',
+ // non-standard api - has inappropriate mandatory fields & doesn't implement limit
+ 'Event',
+ // failed 'check that a 5 limit returns 5' - probably is_template field is wrong or something, or could be limit doesn't work right
+ 'Extension',
+ // can't handle creating 25
+ 'Note',
+ // fails on 5 limit - probably a set up problem
+ 'Setting',
+ //a bit of a pseudoapi - keys by domain
);
return $entitiesWithout;
}
),
'ActivityContact' => array(
'cant_update' => array(
- 'activity_id', //we have an FK on activity_id + contact_id + record id so if we don't leave this one distinct we get an FK constraint error
+ 'activity_id',
+ //we have an FK on activity_id + contact_id + record id so if we don't leave this one distinct we get an FK constraint error
),
),
'Address' => array(
$this->assertEquals(1, $result['is_error'], 'In line ' . __LINE__);
$this->assertContains("Mandatory key(s) missing from params array", $result['error_message']);
}
+
/**
* @dataProvider entities_get
*/
$this->assertEquals(2000, $result['error_code']);
$this->assertEquals('Input variable `params` is not an array', $result['error_message']);
}
+
/**
* @dataProvider entities_get
* @Xdepends testEmptyParam_get // no need to test the simple if the empty doesn't work/is skipped. doesn't seem to work
// big random number. fun fact: if you multiply it by pi^e, the result is another random number, but bigger ;)
$nonExistantID = 30867307034;
if (in_array($Entity, $this->toBeImplemented['get'])
- || in_array($Entity, $this->toBeSkipped_getByID())
+ || in_array($Entity, $this->toBeSkipped_getByID())
) {
return;
}
$this->assertEquals($limit, count($result['values']), $message);
}
}
+
/**
* Create two entities and make sure we can fetch them individually by ID (e.g. using "contact_id=>2"
* or "group_id=>4")
$valuesNotToReturn = $this->getKnownUnworkablesUpdateSingle($entityName, 'break_return');
// these can't be requested as return values
$entityValuesThatDoNotWork = array_merge(
- $this->getKnownUnworkablesUpdateSingle($entityName, 'cant_update'),
- $this->getKnownUnworkablesUpdateSingle($entityName, 'cant_return'),
- $valuesNotToReturn
- );
+ $this->getKnownUnworkablesUpdateSingle($entityName, 'cant_update'),
+ $this->getKnownUnworkablesUpdateSingle($entityName, 'cant_return'),
+ $valuesNotToReturn
+ );
$return = array_diff($return, $valuesNotToReturn);
$baoObj = new CRM_Core_DAO();
$fieldName = $specs['uniquename'];
}
if ($field == 'currency' || $field == 'id' || $field == strtolower($entityName) . '_id'
- || in_array($field, $entityValuesThatDoNotWork)) {
+ || in_array($field, $entityValuesThatDoNotWork)
+ ) {
//@todo id & entity_id are correct but we should fix currency & frequency_day
continue;
}
if (empty($options['values'])) {
//eg. pdf_format id doesn't ship with any
if (isset($specs['pseudoconstant']['optionGroupName'])) {
- $optionGroupID = $this->callAPISuccess('option_group', 'getvalue', array('name' => 'pdf_format', 'return' => 'id'));
- $optionValue = $this->callAPISuccess('option_value', 'create', array('option_group_id' => $optionGroupID, 'label' => 'new option value'));
+ $optionGroupID = $this->callAPISuccess('option_group', 'getvalue', array(
+ 'name' => 'pdf_format',
+ 'return' => 'id'
+ ));
+ $optionValue = $this->callAPISuccess('option_value', 'create', array(
+ 'option_group_id' => $optionGroupID,
+ 'label' => 'new option value'
+ ));
$options['values'][] = $optionValue['id'];
}
}
);
$checkEntity = $this->callAPISuccess($entityName, 'getsingle', $checkParams);
- $this->assertAPIArrayComparison($entity, $checkEntity, array(), "checking if $fieldName was correctly updated\n" . print_r(array('update-params' => $updateParams, 'update-result' => $update, 'getsingle-params' => $checkParams, 'getsingle-result' => $checkEntity, 'expected entity' => $entity), TRUE));
+ $this->assertAPIArrayComparison($entity, $checkEntity, array(), "checking if $fieldName was correctly updated\n" . print_r(array(
+ 'update-params' => $updateParams,
+ 'update-result' => $update,
+ 'getsingle-params' => $checkParams,
+ 'getsingle-result' => $checkEntity,
+ 'expected entity' => $entity
+ ), TRUE));
if ($resetFKTo) {
//reset the foreign key fields because otherwise our cleanup routine fails & some other unexpected stuff can kick in
$entity = array_merge($entity, $resetFKTo);
$this->assertEquals(1, $result['is_error'], 'In line ' . __LINE__);
$this->assertContains("Mandatory key(s) missing from params array", $result['error_message']);
}
+
/**
* @dataProvider entities_delete
*/
}
$result = $this->callAPIFailure($Entity, 'Delete', array('id' => 999));
}
+
/**
* @dataProvider entities
*/
}
$actions = $this->callAPISuccess($entity, 'getactions', array());
foreach ($actions['values'] as $action) {
- if (substr($action, -7) == '_create' || substr($action, -4) == '_get' || substr($action, -7) == '_delete') {
+ if (substr($action, -7) == '_create' || substr($action, -4) == '_get' || substr($action, -7) == '_delete') {
//getactions can't distinguish between contribution_page.create & contribution_page.create
continue;
}
}
return $returnEntities;
}
+
/**
* @param string $entityName
* @param int $count
projects / civicrm-core.git / blobdiff