CRM-13072 fixes required to make JobTest pass now 'hidden' failures exposed

diff --git a/api/v3/Job.php b/api/v3/Job.php
index 101099adad64cbbfbe1b79b0b167e076aedfaee0..cdeaa074f567d064e4488390c37580b18482e405 100644 (file)
--- a/api/v3/Job.php
+++ b/api/v3/Job.php
@@ -71,15 +71,7 @@ function _civicrm_api3_job_create_spec(&$params) {
  * {@schema Core/Job.xml}
  */
 function civicrm_api3_job_create($params) {
-  if (isset($params['id']) && !CRM_Utils_Rule::integer($params['id'])) {
-    return civicrm_api3_create_error('Invalid value for job ID');
-  }
-
-  $dao = CRM_Core_BAO_Job::create($params);
-
-  $result = array();
-  _civicrm_api3_object_to_array($dao, $result[$dao->id]);
-  return civicrm_api3_create_success($result, $params, 'job', 'create', $dao);
+  return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
 
 /**

diff --git a/api/v3/utils.php b/api/v3/utils.php
index d3d3571921ab75c23656e8c84d846c8850498357..626f33896287f26d7d5db4b4acf909b0cc34d2ed 100644 (file)
--- a/api/v3/utils.php
+++ b/api/v3/utils.php
@@ -1,6 +1,4 @@
 <?php
-// $Id$
-
 /*
   +--------------------------------------------------------------------+
   | CiviCRM version 4.3                                                |
@@ -1582,7 +1580,7 @@ function _civicrm_api3_validate_string(&$params, &$fieldName, &$fieldInfo, $enti
         throw new Exception("Currency not a valid code: $value");
       }
     }
-    if (!empty($fieldInfo['pseudoconstant']) || !empty($fieldInfo['options'])) {
+    if (!empty($fieldInfo['pseudoconstant']) || !empty($fieldInfo['options']) || !empty($fieldInfo['enumValues'])) {
       _civicrm_api3_api_match_pseudoconstant($params, $entity, $fieldName, $fieldInfo);
     }
     // Check our field length

diff --git a/tests/phpunit/api/v3/JobTest.php b/tests/phpunit/api/v3/JobTest.php
index e240a88e4d4db2736825342f154e21e59f9d4fa5..729781d72be5615a88bcf1ab7a3adaf671cb2054 100644 (file)
--- a/tests/phpunit/api/v3/JobTest.php
+++ b/tests/phpunit/api/v3/JobTest.php
@@ -1,5 +1,4 @@
 <?php
-
 /*
  +--------------------------------------------------------------------+
  | CiviCRM version 4.3                                                |
@@ -38,12 +37,11 @@
  */
 require_once 'CiviTest/CiviUnitTestCase.php';
 class api_v3_JobTest extends CiviUnitTestCase {
-  protected $_apiversion;
+  protected $_apiversion = 3;
 
   public $_eNoticeCompliant = TRUE;
   public $DBResetRequired = FALSE;
   public $_entity = 'Job';
-  public $_apiVersion = 3;
 
   function setUp() {
     parent::setUp();
@@ -59,14 +57,26 @@ class api_v3_JobTest extends CiviUnitTestCase {
    * check with no name
    */
   function testCreateWithoutName() {
+    $params = array('is_active' => 1);
+    $result = $this->callAPIFailure('job', 'create', $params,
+      'Mandatory key(s) missing from params array: run_frequency, name, api_entity, api_action'
+    );
+  }
+  /**
+   * create job with an valid "run_frequency" value
+   */
+  function testCreateWithValidFrequency() {
     $params = array(
+      'sequential' => 1,
+      'name' => 'API_Test_Job',
+      'description' => 'A long description written by hand in cursive',
+      'run_frequency' => 'Hourly',
+      'api_entity' => 'ApiTestEntity',
+      'api_action' => 'apitestaction',
+      'parameters' => 'Semi-formal explanation of runtime job parameters',
       'is_active' => 1,
-      'version' => $this->_apiVersion,
-    );
-    $result = $this->callAPIFailure('job', 'create', $params);
-    $this->assertEquals($result['error_message'],
-      'Mandatory key(s) missing from params array: run_frequency, name, api_entity, api_action'
     );
+    $result = $this->callAPISuccess('job', 'create', $params);
   }
 
   /**
@@ -74,7 +84,6 @@ class api_v3_JobTest extends CiviUnitTestCase {
    */
   function testCreateWithInvalidFrequency() {
     $params = array(
-      'version' => $this->_apiVersion,
       'sequential' => 1,
       'name' => 'API_Test_Job',
       'description' => 'A long description written by hand in cursive',
@@ -92,7 +101,6 @@ class api_v3_JobTest extends CiviUnitTestCase {
    */
   function testCreate() {
     $params = array(
-      'version' => $this->_apiVersion,
       'sequential' => 1,
       'name' => 'API_Test_Job',
       'description' => 'A long description written by hand in cursive',
@@ -102,13 +110,10 @@ class api_v3_JobTest extends CiviUnitTestCase {
       'parameters' => 'Semi-formal explanation of runtime job parameters',
       'is_active' => 1,
     );
-    $result = civicrm_api('job', 'create', $params);
-    $this->assertAPISuccess($result);
-    $this->documentMe($params, $result, __FUNCTION__, __FILE__);
+    $result = $this->callAPIAndDocument('job', 'create', $params, __FUNCTION__, __FILE__);
     $this->assertNotNull($result['values'][0]['id'], 'in line ' . __LINE__);
 
     // mutate $params to match expected return value
-    unset($params['version']);
     unset($params['sequential']);
     //assertDBState compares expected values in $result to actual values in the DB
     $this->assertDBState('CRM_Core_DAO_Job', $result['id'], $params);
@@ -145,15 +150,14 @@ class api_v3_JobTest extends CiviUnitTestCase {
 
   /**
    * check with incorrect required fields
+   * note to copy & pasters - this test is of marginal value
+   * and effort would be better put into making the one in syntax
+   * conformance work for all entities
    */
   function testDeleteWithIncorrectData() {
     $params = array(
-      'id' => 'abcd',
-      'version' => $this->_apiVersion,
-    );
-
+      'id' => 'abcd');
     $result = $this->callAPIFailure('job', 'delete', $params);
-    $this->assertEquals($result['error_message'], 'Invalid value for job ID');
   }
 
   /**
@@ -161,7 +165,6 @@ class api_v3_JobTest extends CiviUnitTestCase {
    */
   function testDelete() {
     $createParams = array(
-      'version' => $this->_apiVersion,
       'sequential' => 1,
       'name' => 'API_Test_Job',
       'description' => 'A long description written by hand in cursive',
@@ -171,41 +174,38 @@ class api_v3_JobTest extends CiviUnitTestCase {
       'parameters' => 'Semi-formal explanation of runtime job parameters',
       'is_active' => 1,
     );
-    $createResult = civicrm_api('job', 'create', $createParams);
+    $createResult = $this->callAPISuccess('job', 'create', $createParams);
     $this->assertAPISuccess($createResult);
 
     $params = array(
       'id' => $createResult['id'],
-      'version' => $this->_apiVersion,
     );
-    $result = civicrm_api('job', 'delete', $params);
-    $this->documentMe($params, $result, __FUNCTION__, __FILE__);
-    $this->assertAPISuccess($result);
+    $result = $this->callAPIAndDocument('job', 'delete', $params, __FUNCTION__, __FILE__);
   }
 
   /**
 
   public function testCallUpdateGreetingMissingParams() {
-    $result = civicrm_api($this->_entity, 'update_greeting', array('gt' => 1, 'version' => $this->_apiVersion));
+    $result = $this->callAPISuccess($this->_entity, 'update_greeting', array('gt' => 1));
     $this->assertEquals('Mandatory key(s) missing from params array: ct', $result['error_message']);
   }
 
   public function testCallUpdateGreetingIncorrectParams() {
-    $result = civicrm_api($this->_entity, 'update_greeting', array('gt' => 1, 'ct' => 'djkfhdskjfhds', 'version' => $this->_apiVersion));
+    $result = $this->callAPISuccess($this->_entity, 'update_greeting', array('gt' => 1, 'ct' => 'djkfhdskjfhds'));
     $this->assertEquals('ct `djkfhdskjfhds` is not valid.', $result['error_message']);
   }
 /*
  * Note that this test is about tesing the metadata / calling of the function & doesn't test the success of the called function
  */
   public function testCallUpdateGreetingSuccess() {
-    $result = civicrm_api($this->_entity, 'update_greeting', array('gt' => 'postal_greeting', 'ct' => 'Individual', 'version' => $this->_apiVersion));
+    $result = $this->callAPISuccess($this->_entity, 'update_greeting', array('gt' => 'postal_greeting', 'ct' => 'Individual'));
     $this->assertAPISuccess($result);
    }
 
   public function testCallUpdateGreetingCommaSeparatedParamsSuccess() {
     $gt = 'postal_greeting,email_greeting,addressee';
     $ct = 'Individual,Household';
-    $result = civicrm_api($this->_entity, 'update_greeting', array('gt' => $gt, 'ct' => $ct, 'version' => $this->_apiVersion));
+    $result = $this->callAPISuccess($this->_entity, 'update_greeting', array('gt' => $gt, 'ct' => $ct));
     $this->assertAPISuccess($result);
   }
 }