CRM-20420 - Add docblocks
[civicrm-core.git] / tools / scripts / phpunit
1 #!/usr/bin/env php
2 <?php
3
4 /**
5 * In the past, Civi bundled a hacked copy of PHPUnit used like:
6 *
7 * cd tools
8 * ./scripts/phpunit Some_Class_NameTest
9 *
10 * This script is an adapter for backwards compatibility.
11 */
12
13 if (PHP_SAPI !== 'cli') {
14 die("phpunit can only be run from command line.");
15 }
16
17 $phpunit = findCommand('phpunit4');
18 if (!$phpunit) {
19 $phpunit = findCommand('phpunit');
20 }
21 if (!$phpunit) {
22 echo "Plesae ensure that:\n";
23 echo " * PHPUnit is installed.\n";
24 echo " * The extensions for dbunit and selenium are installed.\n" ;
25 echo " * The command \"phpunit\" is in the PATH.\n";
26 echo "See also: https://github.com/civicrm/civicrm-buildkit/\n";
27 exit(127);
28 }
29
30 chdir(dirname(dirname(__DIR__))); // civicrm-core root dir
31
32 array_shift($argv);
33
34 // Convert class names to file names
35 $CIVICRM_UF = 'UnitTests';
36 foreach ($argv as $k => $v) {
37 if (preg_match('/^(CRM_|api_v3_|EnvTest|WebTest_|E2E_)/', $v)) {
38 $argv[$k] = 'tests/phpunit/' . strtr($v, '_', '/') . '.php';
39 }
40 elseif (preg_match('/^Civi\\\\/', $v)) {
41 $argv[$k] = 'tests/phpunit/' . strtr($v, '\\', '/') . '.php';
42 }
43
44 if (preg_match('/^(WebTest|E2E)/', $v)) {
45 $CIVICRM_UF='';
46 }
47 }
48 putenv("CIVICRM_UF=$CIVICRM_UF");
49
50 // Transition: Make sure we use phpunit code from PATH, not
51 // civicrm-packages. This will be unnecessary once civicrm-packages is
52 // updated.
53 if (is_dir('packages/PHPUnit/')) {
54 if (!rename('packages/PHPUnit', 'packages/PHPUnit.bak')) {
55 echo "Failed to move aside stale copy of PHPUnit.\n";
56 exit(1);
57 }
58 }
59
60 $cmd =
61 findPhp() // In case this system has multiple copies of PHP, use the active/preferred one.
62 // . ' -ddisplay_errors=1'
63 . ' '
64 . escapeshellarg($phpunit)
65 . ' '
66 . implode(' ', array_map('escapeshellarg', $argv));
67 passthru($cmd);
68
69 function findPhp() {
70 if (defined('PHP_BINARY')) {
71 return PHP_BINARY; // php 5.4+
72 } elseif (defined('PHP_BINDIR') && file_exists(PHP_BINDIR . '/php')) {
73 return PHP_BINDIR . '/php'; // php 5.3
74 } else {
75 die("Failed to determine active PHP version.");
76 }
77 }
78
79 function findCommand($name) {
80 $paths = explode(PATH_SEPARATOR, getenv('PATH'));
81 foreach ($paths as $path) {
82 if (file_exists("$path/$name")) {
83 return "$path/$name";
84 }
85 }
86 return NULL;
87 }