INFRA-132 - Drupal.Array.Array.CommaLastItem

[civicrm-core.git] / tests / phpunit / api / v3 / APIStandardsTest.php

<?php
// vim: set si ai expandtab tabstop=4 shiftwidth=4 softtabstop=4:

/**
 *  File to v3 APIs for Standards compliance
 *
 *  (PHP 5)
 *
 * @copyright Copyright CiviCRM LLC (C) 2009
 * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html
 *              GNU Affero General Public License version 3
 * @version   $Id:
 * @package   CiviCRM
 *
 *   This file is part of CiviCRM
 *
 *   CiviCRM is free software; you can redistribute it and/or
 *   modify it under the terms of the GNU Affero General Public License
 *   as published by the Free Software Foundation; either version 3 of
 *   the License, or (at your option) any later version.
 *
 *   CiviCRM is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU Affero General Public License for more details.
 *
 *   You should have received a copy of the GNU Affero General Public
 *   License along with this program.  If not, see
 *   <http://www.gnu.org/licenses/>.
 */

/**
 *  Include class definitions
 */
require_once 'CiviTest/CiviUnitTestCase.php';

/**
 *  Test APIv3 civicrm_activity_* functions
 *
 * @package CiviCRM_APIv3
 * @todo determine where help functions should sit (here or 'up the tree'), & best way to define API dir
 */
class api_v3_APIStandardsTest extends CiviUnitTestCase {

  protected $_apiversion;
  protected $_apiDir;
  protected $_functionFiles;
  protected $_regexForGettingAPIStdFunctions;
  /* This test case doesn't require DB reset */


  public $DBResetRequired = FALSE;

  /**
   *  Test setup for every test
   *
   *  Connect to the database, truncate the tables that will be used
   *  and redirect stdin to a temporary file
   */
  public function setUp() {
    //  Connect to the database
    parent::setUp();
    $this->useTransaction(TRUE);
    $this->_apiversion = 3;
    $this->_apiDir = "../api/v3/";
    $this->_functionFiles = array('Entity.php', 'utils.php');

    //should possibly insert variable rather than '3' in below
    $this->_regexForGettingAPIStdFunctions = '/^civicrm_api3_  #starts with civicrm_api_3 (ignore internal functions)
                                                  .*_              #any number of characters up to the last _
    # negative look ahead on string getfields
                                                  (?:(?!getfields))/x';
    // functions to skip from utils.php mainly since they get sucked in via
    // a require chain in the include files
    $this->_skipFunctionList = array(
      // location api is deprecated
      'civicrm_api3_location_create',
      'civicrm_api3_location_get',
      'civicrm_api3_location_delete',
      // most of these seem to be internal functions
      'civicrm_api3_entity_create',
      'civicrm_api3_entity_delete',
      'civicrm_api3_survey_respondant_count',
      // functions from utils.php
      'civicrm_api3_verify_one_mandatory',
      'civicrm_api3_verify_mandatory',
      'civicrm_api3_get_dao',
      'civicrm_api3_create_success',
      'civicrm_api3_create_error',
      'civicrm_api3_error',
      'civicrm_api3_check_contact_dedupe',
      'civicrm_api3_api_check_permission',
    );
  }

  /**
   * Test checks that all v3 API return a standardised error message when
   * the $params passed in is not an array.
   */
  public function testParamsNotArray() {
    /* @codingStandardsIgnoreStart
     * I have commented this out as the check for is_array has been moved to civicrm_api. But keeping in place as
     * this test, in contrast to the standards test, tests all existing API rather than just CRUD ones
     * so want to keep code for re-use
        $files = $this->getAllFilesinAPIDir();
        $this->assertGreaterThan(1, count($files),"something has gone wrong listing the files in line " . __LINE__);
        $this->requireOnceFilesArray($files);
        $apiStdFunctions = $this->getAllAPIStdFunctions();
        $this->assertGreaterThan(1, count($apiStdFunctions),"something has gone wrong getting the std functions in line " . __LINE__);
        $params = 'string';
        foreach ($apiStdFunctions as $key => $function) {
            if ( in_array( $function, $this->_skipFunctionList ) ) {
                continue;
            }
            try {
                $result = $function($params);
            }
            catch ( Exception $e ) {
              continue;
            }

        }
    @codingStandardsIgnoreEnd */
  }

  /**
   * Get all the files in the API directory for the relevant version which contain API functions
   * @return array
   *   array of php files in the directory excluding helper files
   */
  public function getAllFilesinAPIDir() {
    $files = array();
    $handle = opendir($this->_apiDir);

    while (($file = readdir($handle)) !== FALSE) {
      if (strstr($file, ".php") &&
        $file != 'Entity.php' &&
        $file != 'Generic.php' &&
        $file != 'utils.php'
      ) {
        $files[] = $file;
      }
    }

    closedir($handle);
    return $files;
  }

  /**
   * Require once  Files
   * @param array $files
   *   list of files to load.
   */
  public function requireOnceFilesArray($files) {
    foreach ($files as $key => $file) {
      require_once $this->_apiDir . $file;
    }
  }

  /**
   * Get all api exposed functions that are expected to conform to standards
   * @return array
   */
  public function getAllAPIStdFunctions() {
    $functionlist = get_defined_functions();
    $functions = preg_grep($this->_regexForGettingAPIStdFunctions, $functionlist['user']);
    foreach ($functions as $key => $function) {
      if (stristr($function, 'getfields')) {
        unset($functions[$key]);
      }
      if (stristr($function, '_generic_')) {
        unset($functions[$key]);
      }
    }
    return $functions;
  }

}