Skip to content

PHPLIB-662: Unified test runner should error for unexpected operation arguments #898

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 24, 2022
Merged

PHPLIB-662: Unified test runner should error for unexpected operation arguments #898

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f60d1f2
PHPLIB-662: Unified test runner should error for unexpected operation…
aleksandr-rudo Mar 11, 2022
9776f7c
Arguments schema update.
aleksandr-rudo Mar 15, 2022
d92f61f
Apply suggestions from code review
aleksandr-rudo Mar 23, 2022
7e720b1
Fixes in order to coding standards, suggested removal of "typeMap".
aleksandr-rudo Mar 23, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions tests/UnifiedSpecTests/Operation.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,7 @@ private function execute()
private function executeForChangeStream(ChangeStream $changeStream)
{
$args = $this->prepareArguments();
Util::assertArgumentsBySchema(ChangeStream::class, $this->name, $args);

switch ($this->name) {
case 'iterateUntilDocumentOrError':
Expand Down Expand Up @@ -243,6 +244,7 @@ private function executeForChangeStream(ChangeStream $changeStream)
private function executeForClient(Client $client)
{
$args = $this->prepareArguments();
Util::assertArgumentsBySchema(Client::class, $this->name, $args);

switch ($this->name) {
case 'createChangeStream':
Expand All @@ -268,6 +270,7 @@ private function executeForClient(Client $client)
private function executeForCollection(Collection $collection)
{
$args = $this->prepareArguments();
Util::assertArgumentsBySchema(Collection::class, $this->name, $args);

switch ($this->name) {
case 'aggregate':
Expand Down Expand Up @@ -479,6 +482,7 @@ private function executeForCollection(Collection $collection)
private function executeForCursor(Cursor $cursor)
{
$args = $this->prepareArguments();
Util::assertArgumentsBySchema(Cursor::class, $this->name, $args);

switch ($this->name) {
case 'close':
Expand Down Expand Up @@ -526,6 +530,7 @@ private function executeForCursor(Cursor $cursor)
private function executeForDatabase(Database $database)
{
$args = $this->prepareArguments();
Util::assertArgumentsBySchema(Database::class, $this->name, $args);

switch ($this->name) {
case 'aggregate':
Expand Down Expand Up @@ -587,6 +592,7 @@ private function executeForDatabase(Database $database)
private function executeForSession(Session $session)
{
$args = $this->prepareArguments();
Util::assertArgumentsBySchema(Session::class, $this->name, $args);

switch ($this->name) {
case 'abortTransaction':
Expand Down Expand Up @@ -627,6 +633,7 @@ private function executeForSession(Session $session)
private function executeForBucket(Bucket $bucket)
{
$args = $this->prepareArguments();
Util::assertArgumentsBySchema(Bucket::class, $this->name, $args);

switch ($this->name) {
case 'delete':
Expand Down Expand Up @@ -672,6 +679,7 @@ private function executeForBucket(Bucket $bucket)
private function executeForTestRunner()
{
$args = $this->prepareArguments();
Util::assertArgumentsBySchema(self::OBJECT_TEST_RUNNER, $this->name, $args);

switch ($this->name) {
case 'assertCollectionExists':
Expand Down
98 changes: 98 additions & 0 deletions tests/UnifiedSpecTests/Util.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,16 @@

namespace MongoDB\Tests\UnifiedSpecTests;

use MongoDB\ChangeStream;
use MongoDB\Client;
use MongoDB\Collection;
use MongoDB\Database;
use MongoDB\Driver\Cursor;
use MongoDB\Driver\ReadConcern;
use MongoDB\Driver\ReadPreference;
use MongoDB\Driver\Session;
use MongoDB\Driver\WriteConcern;
use MongoDB\GridFS\Bucket;
use stdClass;

use function array_diff_key;
Expand All @@ -26,13 +33,104 @@

final class Util
{
/**
* Array to fill, which contains the schema of allowed attributes for operations.
*/
private static $args = [
Operation::OBJECT_TEST_RUNNER => [
'assertCollectionExists' => ['databaseName', 'collectionName'],
'assertCollectionNotExists' => ['databaseName', 'collectionName'],
'assertIndexExists' => ['databaseName', 'collectionName', 'indexName'],
'assertIndexNotExists' => ['databaseName', 'collectionName', 'indexName'],
'assertSameLsidOnLastTwoCommands' => ['client'],
'assertDifferentLsidOnLastTwoCommands' => ['client'],
'assertNumberConnectionsCheckedOut' => ['connections'],
'assertSessionDirty' => ['session'],
'assertSessionNotDirty' => ['session'],
'assertSessionPinned' => ['session'],
'assertSessionTransactionState' => ['session', 'state'],
'assertSessionUnpinned' => ['session'],
'failPoint' => ['client', 'failPoint'],
'targetedFailPoint' => ['session', 'failPoint'],
'loop' => ['operations', 'storeErrorsAsEntity', 'storeFailuresAsEntity', 'storeSuccessesAsEntity', 'storeIterationsAsEntity'],
],
Client::class => [
'createChangeStream' => ['pipeline', 'session', 'fullDocument', 'resumeAfter', 'startAfter', 'startAtOperationTime', 'batchSize', 'collation', 'maxAwaitTimeMS'],
'listDatabaseNames' => ['authorizedDatabases', 'filter', 'maxTimeMS', 'session'],
'listDatabases' => ['authorizedDatabases', 'filter', 'maxTimeMS', 'session'],
],
Database::class => [
'aggregate' => ['pipeline', 'session', 'useCursor', 'allowDiskUse', 'batchSize', 'bypassDocumentValidation', 'collation', 'comment', 'explain', 'hint', 'let', 'maxAwaitTimeMS', 'maxTimeMS'],
'createChangeStream' => ['pipeline', 'session', 'fullDocument', 'resumeAfter', 'startAfter', 'startAtOperationTime', 'batchSize', 'collation', 'maxAwaitTimeMS'],
'createCollection' => ['collection', 'session', 'autoIndexId', 'capped', 'collation', 'expireAfterSeconds', 'flags', 'indexOptionDefaults', 'max', 'maxTimeMS', 'size', 'storageEngine', 'timeseries', 'validationAction', 'validationLevel', 'validator'],
'dropCollection' => ['collection', 'session'],
'listCollectionNames' => ['authorizedCollections', 'filter', 'maxTimeMS', 'session'],
'listCollections' => ['authorizedCollections', 'filter', 'maxTimeMS', 'session'],
// Note: commandName is not used by PHP
'runCommand' => ['command', 'session', 'commandName'],
],
Collection::class => [
'aggregate' => ['pipeline', 'session', 'useCursor', 'allowDiskUse', 'batchSize', 'bypassDocumentValidation', 'collation', 'comment', 'explain', 'hint', 'let', 'maxAwaitTimeMS', 'maxTimeMS'],
'bulkWrite' => ['requests', 'session', 'ordered', 'bypassDocumentValidation'],
'createChangeStream' => ['pipeline', 'session', 'fullDocument', 'resumeAfter', 'startAfter', 'startAtOperationTime', 'batchSize', 'collation', 'maxAwaitTimeMS'],
'createFindCursor' => ['filter', 'session', 'allowDiskUse', 'allowPartialResults', 'batchSize', 'collation', 'comment', 'cursorType', 'hint', 'limit', 'max', 'maxAwaitTimeMS', 'maxScan', 'maxTimeMS', 'min', 'modifiers', 'noCursorTimeout', 'oplogReplay', 'projection', 'returnKey', 'showRecordId', 'skip', 'snapshot', 'sort'],
'createIndex' => ['keys', 'commitQuorum', 'maxTimeMS', 'name', 'session'],
'dropIndex' => ['name', 'session', 'maxTimeMS'],
'count' => ['filter', 'session', 'collation', 'hint', 'limit', 'maxTimeMS', 'skip'],
'countDocuments' => ['filter', 'session', 'limit', 'skip', 'collation', 'hint', 'maxTimeMS'],
'estimatedDocumentCount' => ['session', 'maxTimeMS'],
'deleteMany' => ['filter', 'session', 'collation', 'hint'],
'deleteOne' => ['filter', 'session', 'collation', 'hint'],
'findOneAndDelete' => ['filter', 'session', 'projection', 'arrayFilters', 'bypassDocumentValidation', 'collation', 'hint', 'maxTimeMS', 'new', 'sort', 'update', 'upsert'],
'distinct' => ['fieldName', 'filter', 'session', 'collation', 'maxTimeMS'],
'drop' => ['session'],
'find' => ['filter', 'session', 'allowDiskUse', 'allowPartialResults', 'batchSize', 'collation', 'comment', 'cursorType', 'hint', 'limit', 'max', 'maxAwaitTimeMS', 'maxScan', 'maxTimeMS', 'min', 'modifiers', 'noCursorTimeout', 'oplogReplay', 'projection', 'returnKey', 'showRecordId', 'skip', 'snapshot', 'sort'],
'findOne' => ['filter', 'session', 'allowDiskUse', 'allowPartialResults', 'batchSize', 'collation', 'comment', 'cursorType', 'hint', 'max', 'maxAwaitTimeMS', 'maxScan', 'maxTimeMS', 'min', 'modifiers', 'noCursorTimeout', 'oplogReplay', 'projection', 'returnKey', 'showRecordId', 'skip', 'snapshot', 'sort'],
'findOneAndReplace' => ['returnDocument', 'filter', 'replacement', 'session', 'projection', 'returnDocument', 'upsert', 'arrayFilters', 'bypassDocumentValidation', 'collation', 'hint', 'maxTimeMS', 'new', 'remove', 'sort'],
'replaceOne' => ['filter', 'replacement', 'session', 'upsert', 'arrayFilters', 'bypassDocumentValidation', 'collation', 'hint'],
'findOneAndUpdate' => ['returnDocument', 'filter', 'update', 'session', 'upsert', 'projection', 'remove', 'arrayFilters', 'bypassDocumentValidation', 'collation', 'hint', 'maxTimeMS', 'sort'],
'updateMany' => ['filter', 'update', 'session', 'upsert', 'arrayFilters', 'bypassDocumentValidation', 'collation', 'hint'],
'updateOne' => ['filter', 'update', 'session', 'upsert', 'arrayFilters', 'bypassDocumentValidation', 'collation', 'hint'],
'insertMany' => ['options', 'documents', 'session', 'ordered', 'bypassDocumentValidation'],
'insertOne' => ['document', 'session', 'bypassDocumentValidation'],
'listIndexes' => ['session', 'maxTimeMS'],
'mapReduce' => ['map', 'reduce', 'out', 'session', 'bypassDocumentValidation', 'collation', 'finalize', 'jsMode', 'limit', 'maxTimeMS', 'query', 'scope', 'sort', 'verbose'],
],
ChangeStream::class => [
'iterateUntilDocumentOrError' => [],
],
Cursor::class => [
'close' => [],
'iterateUntilDocumentOrError' => [],
],
Session::class => [
'abortTransaction' => [],
'commitTransaction' => [],
'endSession' => [],
'startTransaction' => ['maxCommitTimeMS', 'readConcern', 'readPreference', 'writeConcern'],
'withTransaction' => ['callback', 'maxCommitTimeMS', 'readConcern', 'readPreference', 'writeConcern'],
],
Bucket::class => [
'delete' => ['id'],
'downloadByName' => ['filename', 'revision'],
'download' => ['id'],
'uploadWithId' => ['id', 'filename', 'source', 'chunkSizeBytes', 'disableMD5', 'contentType', 'metadata'],
'upload' => ['filename', 'source', 'chunkSizeBytes', 'disableMD5', 'contentType', 'metadata'],
],
];

public static function assertHasOnlyKeys($arrayOrObject, array $keys): void
{
assertThat($arrayOrObject, logicalOr(isType('array'), isInstanceOf(stdClass::class)));
$diff = array_diff_key((array) $arrayOrObject, array_fill_keys($keys, 1));
assertEmpty($diff, 'Unsupported keys: ' . implode(',', array_keys($diff)));
}

public static function assertArgumentsBySchema(string $executingObjectName, string $operation, array $args): void
{
self::assertHasOnlyKeys($args, self::$args[$executingObjectName][$operation]);
}

public static function createReadConcern(stdClass $o): ReadConcern
{
self::assertHasOnlyKeys($o, ['level']);
Expand Down