Skip to content

Fix tests on Schema index helpers #3236

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 2 commits into from
Jan 3, 2025
Merged

Fix tests on Schema index helpers #3236

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
58b94c1
Fix tests on Schema index
GromNaN Jan 2, 2025
34e44b7
Add helpers for index exists/not-exists
GromNaN Jan 2, 2025
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
128 changes: 66 additions & 62 deletions tests/SchemaTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,12 @@
use MongoDB\Collection;
use MongoDB\Database;
use MongoDB\Laravel\Schema\Blueprint;
use MongoDB\Model\IndexInfo;

use function assert;
use function collect;
use function count;
use function sprintf;

class SchemaTest extends TestCase
{
Expand Down Expand Up @@ -81,21 +83,21 @@ public function testIndex(): void
$collection->index('mykey1');
});

$index = $this->getIndex('newcollection', 'mykey1');
$index = $this->assertIndexExists('newcollection', 'mykey1_1');
$this->assertEquals(1, $index['key']['mykey1']);

Schema::table('newcollection', function ($collection) {
$collection->index(['mykey2']);
});

$index = $this->getIndex('newcollection', 'mykey2');
$index = $this->assertIndexExists('newcollection', 'mykey2_1');
$this->assertEquals(1, $index['key']['mykey2']);

Schema::table('newcollection', function ($collection) {
$collection->string('mykey3')->index();
});

$index = $this->getIndex('newcollection', 'mykey3');
$index = $this->assertIndexExists('newcollection', 'mykey3_1');
$this->assertEquals(1, $index['key']['mykey3']);
}

Expand All @@ -105,7 +107,7 @@ public function testPrimary(): void
$collection->string('mykey', 100)->primary();
});

$index = $this->getIndex('newcollection', 'mykey');
$index = $this->assertIndexExists('newcollection', 'mykey_1');
$this->assertEquals(1, $index['unique']);
}

Expand All @@ -115,7 +117,7 @@ public function testUnique(): void
$collection->unique('uniquekey');
});

$index = $this->getIndex('newcollection', 'uniquekey');
$index = $this->assertIndexExists('newcollection', 'uniquekey_1');
$this->assertEquals(1, $index['unique']);
}

Expand All @@ -126,58 +128,52 @@ public function testDropIndex(): void
$collection->dropIndex('uniquekey_1');
});

$index = $this->getIndex('newcollection', 'uniquekey');
$this->assertEquals(null, $index);
$this->assertIndexNotExists('newcollection', 'uniquekey_1');

Schema::table('newcollection', function ($collection) {
$collection->unique('uniquekey');
$collection->dropIndex(['uniquekey']);
});

$index = $this->getIndex('newcollection', 'uniquekey');
$this->assertEquals(null, $index);
$this->assertIndexNotExists('newcollection', 'uniquekey_1');

Schema::table('newcollection', function ($collection) {
$collection->index(['field_a', 'field_b']);
});

$index = $this->getIndex('newcollection', 'field_a_1_field_b_1');
$this->assertNotNull($index);
$this->assertIndexExists('newcollection', 'field_a_1_field_b_1');

Schema::table('newcollection', function ($collection) {
$collection->dropIndex(['field_a', 'field_b']);
});

$index = $this->getIndex('newcollection', 'field_a_1_field_b_1');
$this->assertFalse($index);
$this->assertIndexNotExists('newcollection', 'field_a_1_field_b_1');

$indexName = 'field_a_-1_field_b_1';
Schema::table('newcollection', function ($collection) {
$collection->index(['field_a' => -1, 'field_b' => 1]);
});

$index = $this->getIndex('newcollection', 'field_a_-1_field_b_1');
$this->assertNotNull($index);
$this->assertIndexExists('newcollection', $indexName);

Schema::table('newcollection', function ($collection) {
$collection->dropIndex(['field_a' => -1, 'field_b' => 1]);
});

$index = $this->getIndex('newcollection', 'field_a_-1_field_b_1');
$this->assertFalse($index);
$this->assertIndexNotExists('newcollection', $indexName);

Schema::table('newcollection', function ($collection) {
$collection->index(['field_a', 'field_b'], 'custom_index_name');
$indexName = 'custom_index_name';
Schema::table('newcollection', function ($collection) use ($indexName) {
$collection->index(['field_a', 'field_b'], $indexName);
});

$index = $this->getIndex('newcollection', 'custom_index_name');
$this->assertNotNull($index);
$this->assertIndexExists('newcollection', $indexName);

Schema::table('newcollection', function ($collection) {
$collection->dropIndex('custom_index_name');
Schema::table('newcollection', function ($collection) use ($indexName) {
$collection->dropIndex($indexName);
});

$index = $this->getIndex('newcollection', 'custom_index_name');
$this->assertFalse($index);
$this->assertIndexNotExists('newcollection', $indexName);
}

public function testDropIndexIfExists(): void
Expand All @@ -187,66 +183,58 @@ public function testDropIndexIfExists(): void
$collection->dropIndexIfExists('uniquekey_1');
});

$index = $this->getIndex('newcollection', 'uniquekey');
$this->assertEquals(null, $index);
$this->assertIndexNotExists('newcollection', 'uniquekey');

Schema::table('newcollection', function (Blueprint $collection) {
$collection->unique('uniquekey');
$collection->dropIndexIfExists(['uniquekey']);
});

$index = $this->getIndex('newcollection', 'uniquekey');
$this->assertEquals(null, $index);
$this->assertIndexNotExists('newcollection', 'uniquekey');

Schema::table('newcollection', function (Blueprint $collection) {
$collection->index(['field_a', 'field_b']);
});

$index = $this->getIndex('newcollection', 'field_a_1_field_b_1');
$this->assertNotNull($index);
$this->assertIndexExists('newcollection', 'field_a_1_field_b_1');

Schema::table('newcollection', function (Blueprint $collection) {
$collection->dropIndexIfExists(['field_a', 'field_b']);
});

$index = $this->getIndex('newcollection', 'field_a_1_field_b_1');
$this->assertFalse($index);
$this->assertIndexNotExists('newcollection', 'field_a_1_field_b_1');

Schema::table('newcollection', function (Blueprint $collection) {
$collection->index(['field_a', 'field_b'], 'custom_index_name');
});

$index = $this->getIndex('newcollection', 'custom_index_name');
$this->assertNotNull($index);
$this->assertIndexExists('newcollection', 'custom_index_name');

Schema::table('newcollection', function (Blueprint $collection) {
$collection->dropIndexIfExists('custom_index_name');
});

$index = $this->getIndex('newcollection', 'custom_index_name');
$this->assertFalse($index);
$this->assertIndexNotExists('newcollection', 'custom_index_name');
}

public function testHasIndex(): void
{
$instance = $this;

Schema::table('newcollection', function (Blueprint $collection) use ($instance) {
Schema::table('newcollection', function (Blueprint $collection) {
$collection->index('myhaskey1');
$instance->assertTrue($collection->hasIndex('myhaskey1_1'));
$instance->assertFalse($collection->hasIndex('myhaskey1'));
$this->assertTrue($collection->hasIndex('myhaskey1_1'));
$this->assertFalse($collection->hasIndex('myhaskey1'));
});

Schema::table('newcollection', function (Blueprint $collection) use ($instance) {
Schema::table('newcollection', function (Blueprint $collection) {
$collection->index('myhaskey2');
$instance->assertTrue($collection->hasIndex(['myhaskey2']));
$instance->assertFalse($collection->hasIndex(['myhaskey2_1']));
$this->assertTrue($collection->hasIndex(['myhaskey2']));
$this->assertFalse($collection->hasIndex(['myhaskey2_1']));
});

Schema::table('newcollection', function (Blueprint $collection) use ($instance) {
Schema::table('newcollection', function (Blueprint $collection) {
$collection->index(['field_a', 'field_b']);
$instance->assertTrue($collection->hasIndex(['field_a_1_field_b']));
$instance->assertFalse($collection->hasIndex(['field_a_1_field_b_1']));
$this->assertTrue($collection->hasIndex(['field_a_1_field_b']));
$this->assertFalse($collection->hasIndex(['field_a_1_field_b_1']));
});
}

Expand All @@ -256,7 +244,7 @@ public function testSparse(): void
$collection->sparse('sparsekey');
});

$index = $this->getIndex('newcollection', 'sparsekey');
$index = $this->assertIndexExists('newcollection', 'sparsekey_1');
$this->assertEquals(1, $index['sparse']);
}

Expand All @@ -266,7 +254,7 @@ public function testExpire(): void
$collection->expire('expirekey', 60);
});

$index = $this->getIndex('newcollection', 'expirekey');
$index = $this->assertIndexExists('newcollection', 'expirekey_1');
$this->assertEquals(60, $index['expireAfterSeconds']);
}

Expand All @@ -280,7 +268,7 @@ public function testSoftDeletes(): void
$collection->string('email')->nullable()->index();
});

$index = $this->getIndex('newcollection', 'email');
$index = $this->assertIndexExists('newcollection', 'email_1');
$this->assertEquals(1, $index['key']['email']);
}

Expand All @@ -292,10 +280,10 @@ public function testFluent(): void
$collection->timestamp('created_at');
});

$index = $this->getIndex('newcollection', 'email');
$index = $this->assertIndexExists('newcollection', 'email_1');
$this->assertEquals(1, $index['key']['email']);

$index = $this->getIndex('newcollection', 'token');
$index = $this->assertIndexExists('newcollection', 'token_1');
$this->assertEquals(1, $index['key']['token']);
}

Expand All @@ -307,13 +295,13 @@ public function testGeospatial(): void
$collection->geospatial('continent', '2dsphere');
});

$index = $this->getIndex('newcollection', 'point');
$index = $this->assertIndexExists('newcollection', 'point_2d');
$this->assertEquals('2d', $index['key']['point']);

$index = $this->getIndex('newcollection', 'area');
$index = $this->assertIndexExists('newcollection', 'area_2d');
$this->assertEquals('2d', $index['key']['area']);

$index = $this->getIndex('newcollection', 'continent');
$index = $this->assertIndexExists('newcollection', 'continent_2dsphere');
$this->assertEquals('2dsphere', $index['key']['continent']);
}

Expand All @@ -332,7 +320,7 @@ public function testSparseUnique(): void
$collection->sparse_and_unique('sparseuniquekey');
});

$index = $this->getIndex('newcollection', 'sparseuniquekey');
$index = $this->assertIndexExists('newcollection', 'sparseuniquekey_1');
$this->assertEquals(1, $index['sparse']);
$this->assertEquals(1, $index['unique']);
}
Expand Down Expand Up @@ -573,23 +561,39 @@ public function testVectorSearchIndex()
self::assertSame('vector', $index['latestDefinition']['fields'][0]['type']);
}

protected function getIndex(string $collection, string $name)
protected function assertIndexExists(string $collection, string $name): IndexInfo
{
$index = $this->getIndex($collection, $name);

self::assertNotNull($index, sprintf('Index "%s.%s" does not exist.', $collection, $name));

return $index;
}

protected function assertIndexNotExists(string $collection, string $name): void
{
$collection = DB::getCollection($collection);
$index = $this->getIndex($collection, $name);

self::assertNull($index, sprintf('Index "%s.%s" exists.', $collection, $name));
}

protected function getIndex(string $collection, string $name): ?IndexInfo
{
$collection = $this->getConnection('mongodb')->getCollection($collection);
assert($collection instanceof Collection);

foreach ($collection->listIndexes() as $index) {
if (isset($index['key'][$name])) {
if ($index->getName() === $name) {
return $index;
}
}

return false;
return null;
}

protected function getSearchIndex(string $collection, string $name): ?array
{
$collection = DB::getCollection($collection);
$collection = $this->getConnection('mongodb')->getCollection($collection);
assert($collection instanceof Collection);

foreach ($collection->listSearchIndexes(['name' => $name, 'typeMap' => ['root' => 'array', 'array' => 'array', 'document' => 'array']]) as $index) {
Expand Down
Loading