Files
mongo-php-driver/tests/utils/tools.php
Jeremy Mikola 6eb0944565 PHPC-319: Convert top-level documents to stdClass by default
Update tests to expect stdClass for documents. Debug handlers and the Server getter methods will still decode documents as native arrays.
2015-07-11 00:38:05 -04:00

401 lines
12 KiB
PHP

<?php
/**
* Prints a traditional hex dump of byte values and printable characters.
*
* @see http://stackoverflow.com/a/4225813/162228
* @param string $data Binary data
* @param integer $width Bytes displayed per line
*/
function hex_dump($data, $width = 16)
{
static $pad = '.'; // Placeholder for non-printable characters
static $from = '';
static $to = '';
if ($from === '') {
for ($i = 0; $i <= 0xFF; $i++) {
$from .= chr($i);
$to .= ($i >= 0x20 && $i <= 0x7E) ? chr($i) : $pad;
}
}
$hex = str_split(bin2hex($data), $width * 2);
$chars = str_split(strtr($data, $from, $to), $width);
$offset = 0;
$length = $width * 3;
foreach ($hex as $i => $line) {
printf("%6X : %-{$length}s [%s]\n", $offset, implode(' ', str_split($line, 2)), $chars[$i]);
$offset += $width;
}
}
/**
* Return a collection name to use for the test file.
*
* The filename will be stripped of the base path to the test suite (prefix) as
* well as the PHP file extension (suffix). Special characters (including hyphen
* for shell compatibility) will be replaced with underscores.
*
* @param string $filename
* @return string
*/
function makeCollectionNameFromFilename($filename)
{
$filename = realpath($filename);
$prefix = realpath(dirname(__FILE__) . '/..') . DIRECTORY_SEPARATOR;
$replacements = array(
// Strip test path prefix
sprintf('/^%s/', preg_quote($prefix, '/')) => '',
// Strip file extension suffix
'/\.php$/' => '',
// SKIPIFs add ".skip" between base name and extension
'/\.skip$/' => '',
// Replace special characters with underscores
sprintf('/[%s]/', preg_quote('-$/\\', '/')) => '_',
);
return preg_replace(array_keys($replacements), array_values($replacements), $filename);
}
function TESTCOMMANDS($uri) {
$cmd = array(
"configureFailPoint" => 1,
);
$command = new MongoDB\Driver\Command($cmd);
$manager = new MongoDB\Driver\Manager($uri);
try {
$result = $manager->executeCommand("test", $command);
} catch(Exception $e) {
/* command not found */
if ($e->getCode() == 59) {
die("skip this test requires mongod with enableTestCommands");
}
}
}
function NEEDS($uri) {
if (!constant($uri)) {
exit("skip -- need '$uri' defined");
}
}
function PREDICTABLE() {
global $servers;
foreach($servers as $k => $v) {
if (!defined($k) || !constant($k)) {
exit("skip - needs predictable environment (e.g. vagrant)\n");
}
}
}
function SLOW() {
if (getenv("SKIP_SLOW_TESTS")) {
exit("skip SKIP_SLOW_TESTS");
}
}
function LOAD($uri, $dbname = DATABASE_NAME, $collname = COLLECTION_NAME, $filename = null) {
if (!$filename) {
$filename = "compress.zlib://" . __DIR__ . "/" . "PHONGO-FIXTURES.json.gz";
}
$manager = new MongoDB\Driver\Manager($uri);
$bulk = new MongoDB\Driver\BulkWrite(false);
$server = $manager->selectServer(new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::RP_PRIMARY));
$data = file_get_contents($filename);
$array = json_decode($data);
foreach($array as $document) {
$bulk->insert($document);
}
$retval = $server->executeBulkWrite("$dbname.$collname", $bulk);
if ($retval->getInsertedCount() !== count($array)) {
exit(sprintf('skip Fixtures were not loaded (expected: %d, actual: %d)', $total, $retval->getInsertedCount()));
}
}
function CLEANUP($uri, $dbname = DATABASE_NAME, $collname = COLLECTION_NAME) {
try {
$manager = new MongoDB\Driver\Manager($uri);
$cmd = new MongoDB\Driver\Command(array("drop" => $collname));
$rp = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::RP_PRIMARY);
try {
$manager->executeCommand($dbname, $cmd, $rp);
} catch(Exception $e) {
do {
/* ns not found */
if ($e->getCode() == 59) {
continue;
}
throw $e;
} while (0);
}
} catch(Exception $e) {
echo "skip (cleanup); $uri" . $e->getCode(), ": ", $e->getMessage();
exit(1);
}
}
function START($id, array $options = array()) {
if (getenv("TRAVIS")) {
exit("skip Cannot start/stop server ondemand on travis");
}
$options += array("name" => "mongod", "id" => $id);
$opts = [
"http" => [
"timeout" => 30,
"method" => "PUT",
"header" => "Accept: application/json\r\n" .
"Content-type: application/x-www-form-urlencoded",
"content" => json_encode($options),
"ignore_errors" => true,
],
];
$ctx = stream_context_create($opts);
$json = file_get_contents(getMOUri() . "/servers/$id", false, $ctx);
$result = json_decode($json, true);
/* Failed -- or was already started */
if (!isset($result["mongodb_uri"])) {
DELETE($id);
define($id, false);
} else {
define($id, $result["mongodb_uri"]);
$FILENAME = sys_get_temp_dir() . "/PHONGO-SERVERS.json";
$json = file_get_contents($FILENAME);
$config = json_decode($json, true);
$config[$id] = constant($id);
file_put_contents($FILENAME, json_encode($config, JSON_PRETTY_PRINT));
}
}
function DELETE($id) {
$opts = [
"http" => [
"timeout" => 30,
"method" => "DELETE",
"header" => "Accept: application/json\r\n",
"ignore_errors" => true,
],
];
$ctx = stream_context_create($opts);
$json = file_get_contents(getMOUri() . "/servers/$id", false, $ctx);
$FILENAME = sys_get_temp_dir() . "/PHONGO-SERVERS.json";
$json = file_get_contents($FILENAME);
$config = json_decode($json, true);
unset($config[$id]);
file_put_contents($FILENAME, json_encode($config, JSON_PRETTY_PRINT));
}
function severityToString($type) {
switch($type) {
case E_WARNING:
return "E_WARNING";
default:
return "Some other #_$type";
}
}
function raises($function, $type, $infunction = null) {
$errhandler = function($severity, $message, $file, $line, $errcontext) {
throw new ErrorException($message, 0, $severity, $file, $line);
};
set_error_handler($errhandler, $type);
try {
$function();
} catch(Exception $e) {
if ($e instanceof ErrorException && $e->getSeverity() & $type) {
if ($infunction) {
$trace = $e->getTrace();
$function = $trace[0]["function"];
if (strcasecmp($function, $infunction) == 0) {
printf("OK: Got %s thrown from %s\n", $exceptionname, $infunction);
} else {
printf("ALMOST: Got %s - but was thrown in %s, not %s\n", $exceptionname, $function, $infunction);
}
restore_error_handler();
return $e->getMessage();
}
printf("OK: Got %s\n", severityToString($type));
} else {
printf("ALMOST: Got %s - expected %s\n", get_class($e), $exceptionname);
}
restore_error_handler();
return $e->getMessage();
}
echo "FAILED: Expected $exceptionname thrown!\n";
restore_error_handler();
}
function throws($function, $exceptionname, $infunction = null) {
try {
$function();
} catch(Exception $e) {
if ($e instanceof $exceptionname) {
if ($infunction) {
$trace = $e->getTrace();
$function = $trace[0]["function"];
if (strcasecmp($function, $infunction) == 0) {
printf("OK: Got %s thrown from %s\n", $exceptionname, $infunction);
} else {
printf("ALMOST: Got %s - but was thrown in %s, not %s\n", $exceptionname, $function, $infunction);
}
return $e->getMessage();
}
printf("OK: Got %s\n", $exceptionname);
} else {
printf("ALMOST: Got %s - expected %s\n", get_class($e), $exceptionname);
}
return $e->getMessage();
}
echo "FAILED: Expected $exceptionname thrown!\n";
}
function printServer(MongoDB\Driver\Server $server)
{
printf("server: %s:%d\n", $server->getHost(), $server->getPort());
}
function printWriteResult(MongoDB\Driver\WriteResult $result, $details = true)
{
printServer($result->getServer());
printf("insertedCount: %d\n", $result->getInsertedCount());
printf("matchedCount: %d\n", $result->getMatchedCount());
printf("modifiedCount: %d\n", $result->getModifiedCount());
printf("upsertedCount: %d\n", $result->getUpsertedCount());
printf("deletedCount: %d\n", $result->getDeletedCount());
foreach ($result->getUpsertedIds() as $index => $id) {
printf("upsertedId[%d]: ", $index);
var_dump($id);
}
$writeConcernError = $result->getWriteConcernError();
printWriteConcernError($writeConcernError ? $writeConcernError : null, $details);
foreach ($result->getWriteErrors() as $writeError) {
printWriteError($writeError);
}
}
function printWriteConcernError(MongoDB\Driver\WriteConcernError $error = null, $details)
{
if ($error) {
/* This stuff is generated by the server, no need for us to test it */
if (!$details) {
printf("writeConcernError: %s (%d)\n", $error->getMessage(), $error->getCode());
return;
}
var_dump($error);
printf("writeConcernError.message: %s\n", $error->getMessage());
printf("writeConcernError.code: %d\n", $error->getCode());
printf("writeConcernError.info: ");
var_dump($error->getInfo());
}
}
function printWriteError(MongoDB\Driver\WriteError $error)
{
var_dump($error);
printf("writeError[%d].message: %s\n", $error->getIndex(), $error->getMessage());
printf("writeError[%d].code: %d\n", $error->getIndex(), $error->getCode());
}
function getInsertCount($retval) {
return $retval->getInsertedCount();
}
function getModifiedCount($retval) {
return $retval->getModifiedCount();
}
function getDeletedCount($retval) {
return $retval->getDeletedCount();
}
function getUpsertedCount($retval) {
return $retval->getUpsertedCount();
}
function getWriteErrors($retval) {
return (array)$retval->getWriteErrors();
}
function def($arr) {
foreach($arr as $const => $value) {
define($const, getenv("PHONGO_TEST_$const") ?: $value);
}
}
function configureFailPoint(MongoDB\Driver\Manager $manager, $failPoint, $mode, $data = array()) {
$doc = array(
"configureFailPoint" => $failPoint,
"mode" => $mode,
);
if ($data) {
$doc["data"] = $data;
}
$cmd = new MongoDB\Driver\Command($doc);
$result = $manager->executeCommand("admin", $cmd);
$arr = current($result->toArray());
if (empty($arr->ok)) {
var_dump($result);
throw new RuntimeException("Failpoint failed");
}
return true;
}
function failMaxTimeMS(MongoDB\Driver\Manager $manager) {
return configureFailPoint($manager, "maxTimeAlwaysTimeOut", array("times" => 1));
}
function getMOUri() {
if (!($HOST = getenv("MONGODB_ORCHESTRATION_HOST"))) {
$HOST = "192.168.112.10";
}
if (!($PORT = getenv("MONGODB_ORCHESTRATION_PORT"))) {
$PORT = "8889";
}
$MO = "http://$HOST:$PORT";
return $MO;
}
function getMOPresetBase() {
if (!($BASE = getenv("mongodb_orchestration_base"))) {
$BASE = "/phongo/";
}
return $BASE;
}
function toArray($var, $typemap = array()) {
$func = BSON_NAMESPACE . "\\" . __FUNCTION__;
return $func($var, $typemap);
}
function fromArray($var) {
$func = BSON_NAMESPACE . "\\" . __FUNCTION__;
return $func($var);
}
function toJSON($var) {
$func = BSON_NAMESPACE . "\\" . __FUNCTION__;
return $func($var);
}
function fromJSON($var) {
$func = BSON_NAMESPACE . "\\" . __FUNCTION__;
return $func($var);
}
/* NOTE: Using this function will take down mongod ! */
function failGetMore(MongoDB\Driver\Manager $manager) {
return configureFailPoint($manager, "failReceivedGetmore", "alwaysOn");
}