begin_test() - Code Metrics - gggeek/phpxmlrpc - Measure and Improve Code Quality continuously with Scrutinizer

begin_test() A
last analyzed 2025-06-13 00:01 UTC

↳ Parent: Project
Complexity

Conditions	2
Paths	2
Size

Total Lines	8
Code Lines	5
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	2
eloc	5
nc	2
nop	2
dl	0
loc	8
rs	10
c	0
b	0
f	0
<?php
/**
 * Benchmarking suite for the PHPXMLRPC lib.
 *
 * @author Gaetano Giunta
 * @copyright (C) 2005-2025 G. Giunta
 * @license code licensed under the BSD License: see file license.txt
 *
 * @todo add a check for response ok in call testing
 * @todo add support for --help option to give users the list of supported parameters
 * @todo make number of test iterations flexible
 **/

use PhpXmlRpc\PhpXmlRpc;
use PhpXmlRpc\Value;
use PhpXmlRpc\Request;
use PhpXmlRpc\Client;
use PhpXmlRpc\Response;
use PhpXmlRpc\Encoder;

/// @todo allow autoloading when the library is installed as dependency
include_once __DIR__ . '/../vendor/autoload.php';

include __DIR__ . '/../tests/parse_args.php';
$args = argParser::getArgs();

function begin_test($test_name, $test_case)
{
    global $test_results;
    if (!isset($test_results[$test_name])) {
        $test_results[$test_name] = array();
    }
    $test_results[$test_name][$test_case] = array();
    $test_results[$test_name][$test_case]['time'] = microtime(true);
}

function end_test($test_name, $test_case, $test_result)
{
    global $test_results;
    $end = microtime(true);
    if (!isset($test_results[$test_name][$test_case])) {
        trigger_error('ending test that was not started');
    }
    $test_results[$test_name][$test_case]['time'] = $end - $test_results[$test_name][$test_case]['time'];
    $test_results[$test_name][$test_case]['result'] = $test_result;
    echo '.';
    flush();
    @ob_flush();
    /** @scrutinizer ignore-unhandled */ @ob_flush();
}

// Set up PHP structures to be used in many tests

$data1 = array(1, 1.0, 'hello world', true, '20051021T23:43:00', -1, 11.0, '~!@#$%^&*()_+|', false, '20051021T23:43:00');
$data2 = array('zero' => $data1, 'one' => $data1, 'two' => $data1, 'three' => $data1, 'four' => $data1, 'five' => $data1, 'six' => $data1, 'seven' => $data1, 'eight' => $data1, 'nine' => $data1);
$data = array($data2, $data2, $data2, $data2, $data2, $data2, $data2, $data2, $data2, $data2);
$keys = array('zero', 'one', 'two', 'three', 'four', 'five', 'six', 'seven', 'eight', 'nine');

// Begin execution

$test_results = array();
$is_web = isset($_SERVER['REQUEST_METHOD']);
$xd = extension_loaded('xdebug') && ini_get('xdebug.profiler_enable');
if ($xd) {
    $num_tests = 1;
} else {
    $num_tests = 10;
}

$title = 'XML-RPC Benchmark Tests';

if ($is_web) {
    echo "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">\n<html xmlns=\"http://www.w3.org/1999/xhtml\" lang=\"en\" xml:lang=\"en\">\n<head>\n<title>$title</title>\n</head>\n<body>\n<h1>$title</h1>\n<pre>\n";
} else {
    echo "$title\n\n";
}

if ($is_web) {
    echo "<h3>Using lib version: " . PhpXmlRpc::$xmlrpcVersion . " on PHP version: " . phpversion() . "</h3>\n";
    if ($xd) {
        echo "<h4>XDEBUG profiling enabled: skipping remote tests. Trace file is: " . htmlspecialchars(xdebug_get_profiler_filename()) . "</h4>\n";
    }
    flush();
    ob_flush();
} else {
    echo "Using lib version: " . PhpXmlRpc::$xmlrpcVersion . " on PHP version: " . phpversion() . "\n";
    if ($xd) {
        echo "XDEBUG profiling enabled: skipping remote tests\nTrace file is: " . xdebug_get_profiler_filename() . "\n";
    }
}

// test 'manual style' data encoding vs. 'automatic style' encoding
begin_test('Data encoding (large array)', 'manual encoding');
for ($i = 0; $i < $num_tests; $i++) {
    $vals = array();
    for ($j = 0; $j < 10; $j++) {
        $valArray = array();
        foreach ($data[$j] as $key => $val) {
            $values = array();
            $values[] = new Value($val[0], 'int');
            $values[] = new Value($val[1], 'double');
            $values[] = new Value($val[2], 'string');
            $values[] = new Value($val[3], 'boolean');
            $values[] = new Value($val[4], 'dateTime.iso8601');
            $values[] = new Value($val[5], 'int');
            $values[] = new Value($val[6], 'double');
            $values[] = new Value($val[7], 'string');
            $values[] = new Value($val[8], 'boolean');
            $values[] = new Value($val[9], 'dateTime.iso8601');
            $valArray[$key] = new Value($values, 'array');
        }
        $vals[] = new Value($valArray, 'struct');
    }
    $value = new Value($vals, 'array');
    $out = $value->serialize();
}
end_test('Data encoding (large array)', 'manual encoding', $out);

begin_test('Data encoding (large array)', 'automatic encoding');
$encoder = new Encoder();
for ($i = 0; $i < $num_tests; $i++) {
    $value = $encoder->encode($data, array('auto_dates'));
    $out = $value->serialize();
}
end_test('Data encoding (large array)', 'automatic encoding', $out);

if (function_exists('xmlrpc_set_type')) {
    begin_test('Data encoding (large array)', 'xmlrpc-epi encoding');
    for ($i = 0; $i < $num_tests; $i++) {
        for ($j = 0; $j < 10; $j++) {
            foreach ($keys as $k) {
                xmlrpc_set_type($data[$j][$k][4], 'datetime');
                xmlrpc_set_type($data[$j][$k][8], 'datetime');
                xmlrpc_set_type(/** @scrutinizer ignore-type */ $data[$j][$k][8], 'datetime');
            }
        }
        $out = xmlrpc_encode($data);
    }
    end_test('Data encoding (large array)', 'xmlrpc-epi encoding', $out);
}

// test 'old style' data decoding vs. 'automatic style' decoding
$dummy = new Request('');
$out = new Response($value);
$in = '<?xml version="1.0" ?>' . "\n" . $out->serialize();

begin_test('Data decoding (large array)', 'manual decoding');
for ($i = 0; $i < $num_tests; $i++) {
    $response = $dummy->ParseResponse($in, true);
    $value = $response->value();
    $result = array();
    foreach($value as $val1) {
        $out = array();
        foreach($val1 as $name => $val) {
            $out[$name] = array();
            foreach($val as $data) {
                $out[$name][] = $data->scalarVal();
            }
        }
        $result[] = $out;
    }
}
end_test('Data decoding (large array)', 'manual decoding', $result);

begin_test('Data decoding (large array)', 'manual decoding deprecated');
for ($i = 0; $i < $num_tests; $i++) {
    $response = $dummy->ParseResponse($in, true);
    $value = $response->value();
    $result = array();
    $l = $value->arraySize();
    $l = /** @scrutinizer ignore-deprecated */ $value->arraySize();
    for ($k = 0; $k < $l; $k++) {
        $val1 = $value->arrayMem($k);
        $val1 = /** @scrutinizer ignore-deprecated */ $value->arrayMem($k);
        $out = array();
        foreach($val1 as $name => $val) {
            $out[$name] = array();
            $m = $val->arraySize();
            for ($j = 0; $j < $m; $j++) {
                $data = $val->arrayMem($j);
                $out[$name][] = $data->scalarVal();
            }
        } // while
        $result[] = $out;
    }
}
end_test('Data decoding (large array)', 'manual decoding deprecated', $result);

begin_test('Data decoding (large array)', 'automatic decoding');
for ($i = 0; $i < $num_tests; $i++) {
    $response = $dummy->parseResponse($in, true, 'phpvals');
    $value = $response->value();
}
end_test('Data decoding (large array)', 'automatic decoding', $value);

if (function_exists('xmlrpc_decode')) {
    begin_test('Data decoding (large array)', 'xmlrpc-epi decoding');
    for ($i = 0; $i < $num_tests; $i++) {
        $response = $dummy->parseResponse($in, true, 'xml');
        $value = xmlrpc_decode($response->value());
        $value = xmlrpc_decode(/** @scrutinizer ignore-type */ $response->value());
    }
    end_test('Data decoding (large array)', 'xmlrpc-epi decoding', $value);
}

if (!$xd) {

    $num_tests = 25;

    /// test multicall vs. many calls vs. keep-alives - HTTP

    $encoder = new Encoder();
    $value = $encoder->encode($data1, array('auto_dates'));
    $req = new Request('interopEchoTests.echoValue', array($value));
    $reqs = array();
    for ($i = 0; $i < $num_tests; $i++) {
        $reqs[] = $req;
    }

    $server = explode(':', $args['HTTPSERVER']);
    if (count($server) > 1) {
        $srv = 'http://' . $server[0] . '://' . $server[1] . $args['HTTPURI'];
        $c = new Client($args['HTTPURI'], $server[0], $server[1]);
        $c = new Client($args['HTTPURI'], $server[0], /** @scrutinizer ignore-type */ $server[1]);
    } else {
        $srv = 'http://' . $args['HTTPSERVER'] . $args['HTTPURI'];
        $c = new Client($args['HTTPURI'], $args['HTTPSERVER']);
    }

    // do not interfere with http compression
    $c->setAcceptedCompression(false);
    $c->setAcceptedCompression(/** @scrutinizer ignore-type */ false);
    //$c->setDebug(1);

    $testName = "Repeated send (small array) to $srv";

    begin_test($testName, 'http 10');
    $response = array();
    for ($i = 0; $i < $num_tests; $i++) {
        $resp = $c->send($req);
        $response[] = $resp->value();
    }
    end_test($testName, 'http 10', $response);

    if (function_exists('curl_init')) {
        $c->setOption(Client::OPT_KEEPALIVE, false);
        begin_test($testName, 'http 11 no keepalive');
        $response = array();
        for ($i = 0; $i < $num_tests; $i++) {
            $resp = $c->send($req, 10, 'http11');
            $response[] = $resp->value();
        }
        end_test($testName, 'http 11 no keepalive', $response);

        begin_test($testName, 'http 11 w. keep-alive');
        $response = array();
        for ($i = 0; $i < $num_tests; $i++) {
            $resp = $c->send($req, 10, 'http11');
            $response[] = $resp->value();
        }
        end_test($testName, 'http 11 w. keep-alive', $response);
        $c->xmlrpc_curl_handle = null;
    }

    // this is a single http call - keepalive on/off does not bother us
    begin_test($testName, 'multicall');
    $response = $c->send($reqs);
    foreach ($response as $key => & $val) {
        $val = $val->value();
    }
    end_test($testName, 'multicall', $response);

    if (function_exists('gzinflate')) {
        $c->setOption(Client::OPT_ACCEPTED_COMPRESSION, array('gzip'));
        $c->setOption(Client::OPT_REQUEST_COMPRESSION, 'gzip');

        begin_test($testName, 'http 10 w. compression');
        $response = array();
        for ($i = 0; $i < $num_tests; $i++) {
            $resp = $c->send($req);
            $response[] = $resp->value();
        }
        end_test($testName, 'http 10 w. compression', $response);

        if (function_exists('curl_init')) {
            $c->setOption(Client::OPT_KEEPALIVE, false);
            begin_test($testName, 'http 11 w. compression and no keepalive');
            $response = array();
            for ($i = 0; $i < $num_tests; $i++) {
                $resp = $c->send($req, 10, 'http11');
                $response[] = $resp->value();
            }
            end_test($testName, 'http 11 w. compression and no keepalive', $response);

            $c->setOption(Client::OPT_KEEPALIVE, true);
            begin_test($testName, 'http 11 w. keep-alive and compression');
            $response = array();
            for ($i = 0; $i < $num_tests; $i++) {
                $resp = $c->send($req, 10, 'http11');
                $response[] = $resp->value();
            }
            end_test($testName, 'http 11 w. keep-alive and compression', $response);
            $c->xmlrpc_curl_handle = null;
        }

        begin_test($testName, 'multicall w. compression');
        $response = $c->send($reqs);
        foreach ($response as $key => & $val) {
            $val = $val->value();
        }
        end_test($testName, 'multicall w. compression', $response);
    }

    if (function_exists('curl_init')) {

        /// test multicall vs. many calls vs. keep-alives - HTTPS

        $server = explode(':', $args['HTTPSSERVER']);
        if (count($server) > 1) {
            $srv = 'https://' . $server[0] . ':' . $server[1] . $args['HTTPSURI'];
            $c = new Client($args['HTTPSURI'], $server[0], $server[1], 'https');
        } else {
            $srv = 'https://' . $args['HTTPSSERVER'] . $args['HTTPSURI'];
            $c = new Client($args['HTTPSURI'], $args['HTTPSSERVER'], 443, 'https');
        }
        $c->setOption(Client::OPT_VERIFY_PEER, !$args['HTTPSIGNOREPEER']);
        $c->setOption(Client::OPT_VERIFY_HOST, $args['HTTPSVERIFYHOST']);
        // do not interfere with http compression
        $c->setOption(Client::OPT_ACCEPTED_COMPRESSION, false);
        //$c->debug = 1;

        $testName = "Repeated send (small array) to $srv";

        $c->setOption(Client::OPT_KEEPALIVE, false);
        begin_test($testName, 'https no keep-alive');
        $response = array();
        for ($i = 0; $i < $num_tests; $i++) {
            $resp = $c->send($req);
            $response[] = $resp->value();
        }
        end_test($testName, 'https no keep-alive', $response);

        $c->setOption(Client::OPT_KEEPALIVE, true);
        begin_test($testName, 'https w. keep-alive');
        $response = array();
        for ($i = 0; $i < $num_tests; $i++) {
            $resp = $c->send($req, 10);
            $response[] = $resp->value();
        }
        end_test($testName, 'https w. keep-alive', $response);
        $c->xmlrpc_curl_handle = null;

        begin_test($testName, 'https multicall');
        $response = $c->send($reqs);
        foreach ($response as $key => & $val) {
            $val = $val->value();
        }
        end_test($testName, 'https multicall', $response);

        if (function_exists('gzinflate')) {
            $c->setOption(Client::OPT_ACCEPTED_COMPRESSION, array('gzip'));
            $c->setOption(Client::OPT_REQUEST_COMPRESSION, 'gzip');

            $c->setOption(Client::OPT_KEEPALIVE, false);
            begin_test($testName, 'https w. compression and no keepalive');
            $response = array();
            for ($i = 0; $i < $num_tests; $i++) {
                $resp = $c->send($req);
                $response[] = $resp->value();
            }
            end_test($testName, 'https w. compression and no keepalive', $response);

            $c->setOption(Client::OPT_KEEPALIVE, true);
            begin_test($testName, 'https w. keep-alive and compression');
            $response = array();
            for ($i = 0; $i < $num_tests; $i++) {
                $resp = $c->send($req, 10);
                $response[] = $resp->value();
            }
            end_test($testName, 'https w. keep-alive and compression', $response);
            $c->xmlrpc_curl_handle = null;

            begin_test($testName, 'multicall w. https and compression');
            $response = $c->send($reqs);
            foreach ($response as $key => & $val) {
                $val = $val->value();
            }
            end_test($testName, 'multicall w. https and compression', $response);
        }
    }

    if (function_exists('curl_init') && defined('CURL_HTTP_VERSION_2_0')) {

        /// test multicall vs. many calls vs. keep-alives - HTTP/2

        $server = explode(':', $args['HTTPSSERVER']);
        if (count($server) > 1) {
            $srv = 'https://' . $server[0] . ':' . $server[1] . $args['HTTPSURI'];
            $c = new Client($args['HTTPSURI'], $server[0], $server[1], 'https');
        } else {
            $srv = 'https://' . $args['HTTPSSERVER'] . $args['HTTPSURI'];
            $c = new Client($args['HTTPSURI'], $args['HTTPSSERVER'], 443, 'h2');
        }
        $c->setOption(Client::OPT_VERIFY_PEER, !$args['HTTPSIGNOREPEER']);
        $c->setOption(Client::OPT_VERIFY_HOST, $args['HTTPSVERIFYHOST']);
        // do not interfere with http compression
        $c->setOption(Client::OPT_ACCEPTED_COMPRESSION, false);
        //$c->setDebug(1);

        $testName = "Repeated send (small array) to $srv - HTTP/2";

        $c->setOption(Client::OPT_KEEPALIVE, false);
        begin_test($testName, 'http2 no keep-alive');
        $response = array();
        for ($i = 0; $i < $num_tests; $i++) {
            $resp = $c->send($req);
            $response[] = $resp->value();
        }
        end_test($testName, 'http2 no keep-alive', $response);

        $c->setOption(Client::OPT_KEEPALIVE, true);
        begin_test($testName, 'http2 w. keep-alive');
        $response = array();
        for ($i = 0; $i < $num_tests; $i++) {
            $resp = $c->send($req, 10);
            $response[] = $resp->value();
        }
        end_test($testName, 'http2 w. keep-alive', $response);
        $c->xmlrpc_curl_handle = null;

        begin_test($testName, 'http2 multicall');
        $response = $c->send($reqs);
        foreach ($response as $key => & $val) {
            $val = $val->value();
        }
        end_test($testName, 'http2 multicall', $response);

        if (function_exists('gzinflate')) {
            $c->setOption(Client::OPT_ACCEPTED_COMPRESSION, array('gzip'));
            $c->setOption(Client::OPT_REQUEST_COMPRESSION, 'gzip');

            $c->setOption(Client::OPT_KEEPALIVE, false);
            begin_test($testName, 'http2 w. compression and no keepalive');
            $response = array();
            for ($i = 0; $i < $num_tests; $i++) {
                $resp = $c->send($req);
                $response[] = $resp->value();
            }
            end_test($testName, 'http2 w. compression and no keepalive', $response);

            $c->setOption(Client::OPT_KEEPALIVE, true);
            begin_test($testName, 'http2 w. keep-alive and compression');
            $response = array();
            for ($i = 0; $i < $num_tests; $i++) {
                $resp = $c->send($req, 10);
                $response[] = $resp->value();
            }
            end_test($testName, 'http2 w. keep-alive and compression', $response);
            $c->xmlrpc_curl_handle = null;

            begin_test($testName, 'multicall w. http2 and compression');
            $response = $c->send($reqs);
            foreach ($response as $key => & $val) {
                $val = $val->value();
            }
            end_test($testName, 'multicall w. http2 and compression', $response);
        }
    }
} // end of 'if no xdebug profiling'


echo "\n";
foreach ($test_results as $test => $results) {
    echo "\nTEST: $test\n";
    foreach ($results as $case => $data) {
        echo "  $case: {$data['time']} secs - Output data CRC: " . crc32(serialize($data['result'])) . "\n";
    }
}

if ($is_web) {
    echo "\n</pre>\n</body>\n</html>\n";
}

gggeek / phpxmlrpc

begin_test() A last analyzed 2025-06-13 00:01 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

begin_test() A
last analyzed 2025-06-13 00:01 UTC
