Add spec tests

mongodb · Oct 31, 2024 · a5ee44c · a5ee44c
1 parent cc47ff7
commit a5ee44c
Show file tree

Hide file tree

Showing 7 changed files with 30 additions and 15 deletions.
diff --git a/psalm-baseline.xml b/psalm-baseline.xml
@@ -286,11 +286,13 @@
   <file src="src/GridFS/CollectionWrapper.php">
     <InvalidNullableReturnType>
       <code><![CDATA[int]]></code>
+      <code><![CDATA[int]]></code>
     </InvalidNullableReturnType>
     <MixedAssignment>
       <code><![CDATA[$ids[]]]></code>
     </MixedAssignment>
     <NullableReturnStatement>
+      <code><![CDATA[$count]]></code>
       <code><![CDATA[$this->filesCollection->updateMany(
             ['filename' => $filename],
             ['$set' => ['filename' => $newFilename]],

diff --git a/src/GridFS/Bucket.php b/src/GridFS/Bucket.php
@@ -252,7 +252,11 @@ public function delete(mixed $id)
      */
     public function deleteByName(string $filename): void
     {
-        $this->collectionWrapper->deleteFileAndChunksByFilename($filename);
+        $count = $this->collectionWrapper->deleteFileAndChunksByFilename($filename);
+
+        if ($count === 0) {
+            throw FileNotFoundException::byFilename($filename);
+        }
     }
 
     /**
@@ -672,9 +676,9 @@ public function rename(mixed $id, string $newFilename)
      */
     public function renameByName(string $filename, string $newFilename): void
     {
-        $matchedCount = $this->collectionWrapper->updateFilenameForFilename($filename, $newFilename);
+        $count = $this->collectionWrapper->updateFilenameForFilename($filename, $newFilename);
 
-        if (! $matchedCount) {
+        if ($count === 0) {
             throw FileNotFoundException::byFilename($filename);
         }
     }

diff --git a/src/GridFS/CollectionWrapper.php b/src/GridFS/CollectionWrapper.php
@@ -74,7 +74,7 @@ public function deleteChunksByFilesId(mixed $id): void
     /**
      * Delete all GridFS files and chunks for a given filename.
      */
-    public function deleteFileAndChunksByFilename(string $filename): ?int
+    public function deleteFileAndChunksByFilename(string $filename): int
     {
         /** @var iterable<array{_id: mixed}> $files */
         $files = $this->findFiles(['filename' => $filename], [

diff --git a/tests/GridFS/BucketFunctionalTest.php b/tests/GridFS/BucketFunctionalTest.php
@@ -182,17 +182,10 @@ public function testDeleteByName(): void
         $this->assertCollectionCount($this->chunksCollection, 0);
     }
 
-    public function testDeleteByNameShouldIgnoreNonexistentFiles(): void
+    public function testDeleteByNameShouldRequireFileToExist(): void
     {
-        $this->bucket->uploadFromStream('filename', self::createStream('foobar'));
-
-        $this->assertCollectionCount($this->filesCollection, 1);
-        $this->assertCollectionCount($this->chunksCollection, 1);
-
-        $this->bucket->deleteByName('nonexistent-filename');
-
-        $this->assertCollectionCount($this->filesCollection, 1);
-        $this->assertCollectionCount($this->chunksCollection, 1);
+        $this->expectException(FileNotFoundException::class);
+        $this->bucket->deleteByName('nonexistent-name');
     }
 
     public function testDownloadingFileWithMissingChunk(): void

diff --git a/tests/UnifiedSpecTests/Operation.php b/tests/UnifiedSpecTests/Operation.php
@@ -789,6 +789,12 @@ private function executeForBucket(Bucket $bucket)
 
                 return $bucket->delete($args['id']);
 
+            case 'deleteByName':
+                assertArrayHasKey('filename', $args);
+                assertIsString($args['filename']);
+
+                return $bucket->deleteByName($args['filename']);
+
             case 'downloadByName':
                 assertArrayHasKey('filename', $args);
                 assertIsString($args['filename']);
@@ -812,6 +818,14 @@ private function executeForBucket(Bucket $bucket)
 
                 return null;
 
+            case 'renameByName':
+                assertArrayHasKey('filename', $args);
+                assertArrayHasKey('newFilename', $args);
+                assertIsString($args['filename']);
+                assertIsString($args['newFilename']);
+
+                return $bucket->renameByName($args['filename'], $args['newFilename']);
+
             case 'uploadWithId':
                 assertArrayHasKey('id', $args);
                 $args['_id'] = $args['id'];

diff --git a/tests/UnifiedSpecTests/Util.php b/tests/UnifiedSpecTests/Util.php
@@ -132,9 +132,11 @@ final class Util
         ],
         Bucket::class => [
             'delete' => ['id'],
+            'deleteByName' => ['filename'],
             'downloadByName' => ['filename', 'revision'],
             'download' => ['id'],
             'rename' => ['id', 'newFilename'],
+            'renameByName' => ['filename', 'newFilename'],
             'uploadWithId' => ['id', 'filename', 'source', 'chunkSizeBytes', 'disableMD5', 'contentType', 'metadata'],
             'upload' => ['filename', 'source', 'chunkSizeBytes', 'disableMD5', 'contentType', 'metadata'],
         ],

diff --git a/tests/specifications b/tests/specifications
+61 −11		source/gridfs/gridfs-spec.md
+230 −0		source/gridfs/tests/deleteByName.json
+102 −0		source/gridfs/tests/deleteByName.yml
+313 −0		source/gridfs/tests/renameByName.json
+113 −0		source/gridfs/tests/renameByName.yml