tests/phpunit/api/v3/APIStandardsTest.php

   1 <?php
   2 // vim: set si ai expandtab tabstop=4 shiftwidth=4 softtabstop=4:
   3
   4 /**
   5  *  File to v3 APIs for Standards compliance
   6  *
   7  *  (PHP 5)
   8  *
   9  *   @copyright Copyright CiviCRM LLC (C) 2009
  10  *   @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html
  11  *              GNU Affero General Public License version 3
  12  *   @version   $Id:
  13  *   @package   CiviCRM
  14  *
  15  *   This file is part of CiviCRM
  16  *
  17  *   CiviCRM is free software; you can redistribute it and/or
  18  *   modify it under the terms of the GNU Affero General Public License
  19  *   as published by the Free Software Foundation; either version 3 of
  20  *   the License, or (at your option) any later version.
  21  *
  22  *   CiviCRM is distributed in the hope that it will be useful,
  23  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  24  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  25  *   GNU Affero General Public License for more details.
  26  *
  27  *   You should have received a copy of the GNU Affero General Public
  28  *   License along with this program.  If not, see
  29  *   <http://www.gnu.org/licenses/>.
  30  */
  31
  32 /**
  33  *  Include class definitions
  34  */
  35 require_once 'CiviTest/CiviUnitTestCase.php';
  36
  37 /**
  38  *  Test APIv3 civicrm_activity_* functions
  39  *
  40  *  @package CiviCRM_APIv3
  41  *  @todo determine where help functions should sit (here or 'up the tree'), & best way to define API dir
  42  */
  43 class api_v3_APIStandardsTest extends CiviUnitTestCase {
  44
  45   protected $_apiversion;
  46   protected $_apiDir;
  47   protected $_functionFiles;
  48   protected $_regexForGettingAPIStdFunctions;
  49   /* This test case doesn't require DB reset */
  50
  51
  52
  53   public $DBResetRequired = FALSE;
  54
  55   /**
  56    *  Test setup for every test
  57    *
  58    *  Connect to the database, truncate the tables that will be used
  59    *  and redirect stdin to a temporary file
  60    */
  61   public function setUp() {
  62     //  Connect to the database
  63     parent::setUp();
  64     $this->useTransaction(TRUE);
  65     $this->_apiversion = 3;
  66     $this->_apiDir = "../api/v3/";
  67     $this->_functionFiles = array('Entity.php', 'utils.php');
  68
  69     //should possibly insert variable rather than '3' in below
  70     $this->_regexForGettingAPIStdFunctions = '/^civicrm_api3_  #starts with civicrm_api_3 (ignore internal functions)
  71                                                   .*_              #any number of characters up to the last _
  72     # negative look ahead on string getfields
  73                                                   (?:(?!getfields))/x';
  74     // functions to skip from utils.php mainly since they get sucked in via
  75     // a require chain in the include files
  76     $this->_skipFunctionList = array(
  77       // location api is deprecated
  78       'civicrm_api3_location_create',
  79       'civicrm_api3_location_get',
  80       'civicrm_api3_location_delete',
  81       // most of these seem to be internal functions
  82       'civicrm_api3_entity_create',
  83       'civicrm_api3_entity_delete',
  84       'civicrm_api3_survey_respondant_count',
  85       // functions from utils.php
  86       'civicrm_api3_verify_one_mandatory',
  87       'civicrm_api3_verify_mandatory',
  88       'civicrm_api3_get_dao',
  89       'civicrm_api3_create_success',
  90       'civicrm_api3_create_error',
  91       'civicrm_api3_error',
  92       'civicrm_api3_check_contact_dedupe',
  93       'civicrm_api3_api_check_permission',
  94     );
  95   }
  96
  97   /**
  98    * Test checks that all v3 API return a standardised error message when
  99    * the $params passed in is not an array.
 100    */
 101   function testParamsNotArray() {
 102     /*I have commented this out as the check for is_array has been moved to civicrm_api. But keeping in place as
 103     * this test, in contrast to the standards test, tests all existing API rather than just CRUD ones
 104     * so want to keep code for re-use
 105         $files = $this->getAllFilesinAPIDir();
 106         $this->assertGreaterThan(1, count($files),"something has gone wrong listing the files in line " . __LINE__);
 107         $this->requireOnceFilesArray($files);
 108         $apiStdFunctions = $this->getAllAPIStdFunctions();
 109         $this->assertGreaterThan(1, count($apiStdFunctions),"something has gone wrong getting the std functions in line " . __LINE__);
 110         $params = 'string';
 111         foreach($apiStdFunctions as $key => $function){
 112             if ( in_array( $function, $this->_skipFunctionList ) ) {
 113                 continue;
 114             }
 115             try {
 116                 $result = $function($params);
 117             } catch ( Exception $e ) {
 118               continue;
 119             }
 120
 121         }*/
 122   }
 123
 124   /**
 125    * Get all the files in the API directory for the relevant version which contain API functions
 126    * @return array $files array of php files in the directory excluding helper files
 127    */
 128   function getAllFilesinAPIDir() {
 129     $files = array();
 130     $handle = opendir($this->_apiDir);
 131
 132     while (($file = readdir($handle)) !== FALSE) {
 133       if (strstr($file, ".php") &&
 134         $file != 'Entity.php' &&
 135         $file != 'Generic.php' &&
 136         $file != 'utils.php'
 137       ) {
 138         $files[] = $file;
 139       }
 140     }
 141
 142     closedir($handle);
 143     return $files;
 144   }
 145
 146   /**
 147    * Require once  Files
 148    * @param $files array list of files to load
 149    */
 150   function requireOnceFilesArray($files) {
 151     foreach ($files as $key => $file) {
 152       require_once $this->_apiDir . $file;
 153     }
 154   }
 155
 156   /**
 157    * Get all api exposed functions that are expected to conform to standards
 158    * @return array $functionlist
 159    */
 160   function getAllAPIStdFunctions() {
 161     $functionlist = get_defined_functions();
 162     $functions = preg_grep($this->_regexForGettingAPIStdFunctions, $functionlist['user']);
 163     foreach ($functions as $key => $function) {
 164       if (stristr($function, 'getfields')) {
 165         unset($functions[$key]);
 166       }
 167       if (stristr($function, '_generic_')) {
 168         unset($functions[$key]);
 169       }
 170     }
 171     return $functions;
 172   }
 173 }
 174