Skip to content

Commit 09d194a

Browse files
committed
Apply numbering to CSFLE prose tests
1 parent 370b5a2 commit 09d194a

File tree

1 file changed

+22
-11
lines changed

1 file changed

+22
-11
lines changed

tests/SpecTests/ClientSideEncryptionSpecTest.php

Lines changed: 22 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -182,8 +182,9 @@ public function provideTests()
182182
}
183183

184184
/**
185-
* Prose test: Data key and double encryption
185+
* Prose test 2: Data Key and Double Encryption
186186
*
187+
* @see https://github.com/mongodb/specifications/tree/master/source/client-side-encryption/tests#data-key-and-double-encryption
187188
* @dataProvider dataKeyProvider
188189
*/
189190
public function testDataKeyAndDoubleEncryption(string $providerName, $masterKey): void
@@ -320,8 +321,9 @@ public static function dataKeyProvider()
320321
}
321322

322323
/**
323-
* Prose test: External Key Vault
324+
* Prose test 3: External Key Vault
324325
*
326+
* @see https://github.com/mongodb/specifications/tree/master/source/client-side-encryption/tests#external-key-vault-test
325327
* @testWith [false]
326328
* [true]
327329
*/
@@ -471,8 +473,9 @@ static function (self $test, Collection $collection, array $document): void {
471473
}
472474

473475
/**
474-
* Prose test: BSON size limits and batch splitting
476+
* Prose test 4: BSON Size Limits and Batch Splitting
475477
*
478+
* @see https://github.com/mongodb/specifications/tree/master/source/client-side-encryption/tests#bson-size-limits-and-batch-splitting
476479
* @dataProvider provideBSONSizeLimitsAndBatchSplittingTests
477480
*/
478481
public function testBSONSizeLimitsAndBatchSplitting(Closure $test): void
@@ -505,7 +508,9 @@ public function testBSONSizeLimitsAndBatchSplitting(Closure $test): void
505508
}
506509

507510
/**
508-
* Prose test: Views are prohibited
511+
* Prose test 5: Views Are Prohibited
512+
*
513+
* @see https://github.com/mongodb/specifications/tree/master/source/client-side-encryption/tests#views-are-prohibited
509514
*/
510515
public function testViewsAreProhibited(): void
511516
{
@@ -535,8 +540,9 @@ public function testViewsAreProhibited(): void
535540
}
536541

537542
/**
538-
* Prose test: BSON Corpus
543+
* Prose test 6: BSON Corpus
539544
*
545+
* @see https://github.com/mongodb/specifications/tree/master/source/client-side-encryption/tests#corpus-test
540546
* @testWith [true]
541547
* [false]
542548
*/
@@ -647,8 +653,9 @@ public function testCorpus($schemaMap = true): void
647653
}
648654

649655
/**
650-
* Prose test: Custom Endpoint
656+
* Prose test 7: Custom Endpoint
651657
*
658+
* @see https://github.com/mongodb/specifications/tree/master/source/client-side-encryption/tests#custom-endpoint-test
652659
* @dataProvider customEndpointProvider
653660
*/
654661
public function testCustomEndpoint(Closure $test): void
@@ -811,7 +818,9 @@ static function (self $test, ClientEncryption $clientEncryption, ClientEncryptio
811818
}
812819

813820
/**
814-
* Prose test: Bypass spawning mongocryptd (via mongocryptdBypassSpawn)
821+
* Prose test 8: Bypass Spawning mongocryptd (via mongocryptdBypassSpawn)
822+
*
823+
* @see https://github.com/mongodb/specifications/tree/master/source/client-side-encryption/tests#via-mongocryptdbypassspawn
815824
*/
816825
public function testBypassSpawningMongocryptdViaBypassSpawn(): void
817826
{
@@ -844,7 +853,9 @@ public function testBypassSpawningMongocryptdViaBypassSpawn(): void
844853
}
845854

846855
/**
847-
* Bypass spawning mongocryptd (via bypassAutoEncryption)
856+
* Prose test 8: Bypass spawning mongocryptd (via bypassAutoEncryption)
857+
*
858+
* @see https://github.com/mongodb/specifications/tree/master/source/client-side-encryption/tests#via-bypassautoencryption
848859
*/
849860
public function testBypassSpawningMongocryptdViaBypassAutoEncryption(): void
850861
{
@@ -870,7 +881,7 @@ public function testBypassSpawningMongocryptdViaBypassAutoEncryption(): void
870881
}
871882

872883
/**
873-
* Prose test: Invalid KMS Certificate
884+
* Prose test 10: KMS TLS Tests (Invalid KMS Certificate)
874885
*
875886
* @see https://github.com/mongodb/specifications/blob/master/source/client-side-encryption/tests/README.rst#invalid-kms-certificate
876887
*/
@@ -898,7 +909,7 @@ public function testInvalidKmsCertificate(): void
898909
}
899910

900911
/**
901-
* Prose test: Invalid Hostname in KMS Certificate
912+
* Prose test 10: KMS TLS Tests (Invalid Hostname in KMS Certificate)
902913
*
903914
* @see https://github.com/mongodb/specifications/blob/master/source/client-side-encryption/tests/README.rst#invalid-hostname-in-kms-certificate
904915
*/
@@ -926,7 +937,7 @@ public function testInvalidHostnameInKmsCertificate(): void
926937
}
927938

928939
/**
929-
* Prose test: KMS TLS Options
940+
* Prose test 11: KMS TLS Options
930941
*
931942
* @see https://github.com/mongodb/specifications/blob/master/source/client-side-encryption/tests/README.rst#kms-tls-options-tests
932943
* @dataProvider provideKmsTlsOptionsTests

0 commit comments

Comments
 (0)