分片上传的版本号使用枚举判断，并添加单元测试覆盖错误版本号

lihsai0 · lihsai0 · commit ddbdff5f013b · 2022-01-24T18:18:53.000+08:00
- 新增 `myclabs/php-enum` 包
- 新增枚举类 `SplitUploadVersion`
- 新增错误版本号 `v`, `1`, `2` 的单元测试
diff --git a/autoload.php b/autoload.php
@@ -1,5 +1,9 @@
 <?php
 
+if ( file_exists(dirname(__FILE__).'/vendor/autoload.php') ) {
+    require_once dirname(__FILE__).'/vendor/autoload.php';
+}
+
 function classLoader($class)
 {
     $path = str_replace('\\', DIRECTORY_SEPARATOR, $class);
diff --git a/composer.json b/composer.json
@@ -18,7 +18,8 @@
         }
     ],
     "require": {
-        "php": ">=5.3.3"
+        "php": ">=5.3.3",
+        "myclabs/php-enum": "1.6.6"
     },
     "require-dev": {
         "paragonie/random_compat": ">=2",
diff --git a/src/Qiniu/Enum/QiniuEnum.php b/src/Qiniu/Enum/QiniuEnum.php
@@ -0,0 +1,41 @@
+<?php
+
+namespace Qiniu\Enum;
+
+use MyCLabs\Enum\Enum;
+
+/**
+ * 扩展 MyCLabs\Enum\Enum 以使用其新版本的 from 方法
+ *
+ * @link https://github.com/myclabs/php-enum
+ */
+abstract class QiniuEnum extends Enum
+{
+    /**
+     * @param mixed $value
+     * @return static
+     */
+    public static function from($value)
+    {
+        $key = self::assertValidValueReturningKey($value);
+
+        return self::__callStatic($key, array());
+    }
+
+    /**
+     * Asserts valid enum value
+     *
+     * @psalm-pure
+     * @psalm-assert T $value
+     * @param mixed $value
+     * @return string
+     */
+    private static function assertValidValueReturningKey($value)
+    {
+        if (false === ($key = self::search($value))) {
+            throw new \UnexpectedValueException("Value '$value' is not part of the enum " . __CLASS__);
+        }
+
+        return $key;
+    }
+}
diff --git a/src/Qiniu/Enum/SplitUploadVersion.php b/src/Qiniu/Enum/SplitUploadVersion.php
@@ -0,0 +1,9 @@
+<?php
+
+namespace Qiniu\Enum;
+
+final class SplitUploadVersion extends QiniuEnum
+{
+    const V1 = 'v1';
+    const V2 = 'v2';
+}
diff --git a/src/Qiniu/Storage/ResumeUploader.php b/src/Qiniu/Storage/ResumeUploader.php
@@ -5,6 +5,7 @@
 use Qiniu\Config;
 use Qiniu\Http\Client;
 use Qiniu\Http\Error;
+use Qiniu\Enum\SplitUploadVersion;
 
 /**
  * 断点续上传类, 该类主要实现了断点续上传中的分块上传,
@@ -70,9 +71,14 @@ public function __construct(
         $this->finishedEtags = array("etags"=>array(), "uploadId"=>"", "expiredAt"=>0, "uploaded"=>0);
         $this->config = $config;
         $this->resumeRecordFile = $resumeRecordFile ? $resumeRecordFile : null;
-        $this->version = $version ? $version : 'v1';
         $this->partSize = $partSize ? $partSize : config::BLOCK_SIZE;
 
+        try {
+            $this->version = SplitUploadVersion::from($version ? $version : 'v1');
+        } catch (\Exception $e) {
+            throw new \Exception("only support v1/v2 now!", 0, $e);
+        }
+
         list($accessKey, $bucket, $err) = \Qiniu\explodeUpToken($upToken);
         $this->bucket = $bucket;
         if ($err != null) {
@@ -92,7 +98,7 @@ public function __construct(
     public function upload($fname)
     {
         $uploaded = 0;
-        if ($this->version == 'v2') {
+        if ($this->version == SplitUploadVersion::V2) {
             $partNumber = 1;
             $encodedObjectName = $this->key? \Qiniu\base64_urlSafeEncode($this->key) : '~';
         };
@@ -125,13 +131,13 @@ public function upload($fname)
             }
 
             if ($blkputRets) {
-                if ($this->version == 'v1') {
+                if ($this->version == SplitUploadVersion::V1) {
                     if (isset($blkputRets['contexts']) && isset($blkputRets['uploaded']) &&
                         is_array($blkputRets['contexts']) && is_int($blkputRets['uploaded'])) {
                         $this->contexts = $blkputRets['contexts'];
                         $uploaded = $blkputRets['uploaded'];
                     }
-                } elseif ($this->version == 'v2') {
+                } elseif ($this->version == SplitUploadVersion::V2) {
                     if (isset($blkputRets["etags"]) && isset($blkputRets["uploadId"]) &&
                         isset($blkputRets["expiredAt"]) && $blkputRets["expiredAt"] > time()
                         && $blkputRets["uploaded"] > 0 && is_array($blkputRets["etags"]) &&
@@ -149,13 +155,13 @@ public function upload($fname)
                     throw new \Exception("only support v1/v2 now!");
                 }
             } else {
-                if ($this->version == 'v2') {
+                if ($this->version == SplitUploadVersion::V2) {
                     $this->makeInitReq($encodedObjectName);
                 }
             }
         } else {
             // init a Multipart Upload task if choose v2
-            if ($this->version == 'v2') {
+            if ($this->version == SplitUploadVersion::V2) {
                 $this->makeInitReq($encodedObjectName);
             }
         }
@@ -166,10 +172,10 @@ public function upload($fname)
             if ($data === false) {
                 throw new \Exception("file read failed", 1);
             }
-            if ($this->version == 'v1') {
+            if ($this->version == SplitUploadVersion::V1) {
                 $crc = \Qiniu\crc32_data($data);
                 $response = $this->makeBlock($data, $blockSize);
-            } else {
+            } elseif ($this->version == SplitUploadVersion::V2) {
                 $md5 = md5($data);
                 $response = $this->uploadPart(
                     $data,
@@ -178,6 +184,8 @@ public function upload($fname)
                     $encodedObjectName,
                     $md5
                 );
+            } else {
+                throw new \Exception("only support v1/v2 now!");
             }
 
             $ret = null;
@@ -193,7 +201,7 @@ public function upload($fname)
                 $this->host = $upHostBackup;
             }
 
-            if ($this->version == 'v1') {
+            if ($this->version == SplitUploadVersion::V1) {
                 if ($response->needRetry() || !isset($ret['crc32']) || $crc != $ret['crc32']) {
                     $response = $this->makeBlock($data, $blockSize);
                     $ret = $response->json();
@@ -203,7 +211,7 @@ public function upload($fname)
                     return array(null, new Error($this->currentUrl, $response));
                 }
                 array_push($this->contexts, $ret['ctx']);
-            } else {
+            } elseif ($this->version == SplitUploadVersion::V2) {
                 if ($response->needRetry() || !isset($ret['md5']) || $md5 != $ret['md5']) {
                     $response = $this->uploadPart(
                         $data,
@@ -221,22 +229,26 @@ public function upload($fname)
                 $blockStatus = array('etag' => $ret['etag'], 'partNumber' => $partNumber);
                 array_push($this->finishedEtags['etags'], $blockStatus);
                 $partNumber += 1;
+            } else {
+                throw new \Exception("only support v1/v2 now!");
             }
 
             $uploaded += $blockSize;
-            if ($this->version == 'v2') {
+            if ($this->version == SplitUploadVersion::V2) {
                 $this->finishedEtags['uploaded'] = $uploaded;
             }
 
             if ($this->resumeRecordFile !== null) {
-                if ($this->version == 'v1') {
+                if ($this->version == SplitUploadVersion::V1) {
                     $recordData = array(
                         'contexts' => $this->contexts,
                         'uploaded' => $uploaded
                     );
                     $recordData = json_encode($recordData);
-                } else {
+                } elseif ($this->version == SplitUploadVersion::V2) {
                     $recordData = json_encode($this->finishedEtags);
+                } else {
+                    throw new \Exception("only support v1/v2 now!");
                 }
                 if ($recordData) {
                     $isWritten = file_put_contents($this->resumeRecordFile, $recordData);
@@ -248,10 +260,12 @@ public function upload($fname)
                 }
             }
         }
-        if ($this->version == 'v1') {
+        if ($this->version == SplitUploadVersion::V1) {
             return $this->makeFile($fname);
-        } else {
+        } elseif ($this->version == SplitUploadVersion::V2) {
             return $this->completeParts($fname, $this->finishedEtags['uploadId'], $encodedObjectName);
+        } else {
+            throw new \Exception("only support v1/v2 now!");
         }
     }
 
diff --git a/tests/Qiniu/Tests/ResumeUpTest.php b/tests/Qiniu/Tests/ResumeUpTest.php
@@ -203,4 +203,59 @@ public function testResumeUploadV2WithParams()
         $this->assertEquals("val_2", $response->headers()["X-Qn-Meta-M2"]);
         unlink($tempFile);
     }
+
+    // valid versions are tested above
+    // Use PHPUnit's Data Provider to test multiple Exception is better,
+    // but not match the test style of this project
+    public function testResumeUploadWithInvalidVersion()
+    {
+        $zone = new Zone(array('up.qiniup.com'));
+        $cfg = new Config($zone);
+        $upManager = new UploadManager($cfg);
+        $testFileSize = config::BLOCK_SIZE * 2;
+        $partSize = 5 * 1024 * 1024;
+        $testInvalidVersions = array(
+            // High probability invalid versions
+            'v',
+            '1',
+            '2'
+        );
+
+        $expectExceptionCount = 0;
+        foreach ($testInvalidVersions as $invalidVersion) {
+            $key = 'resumePutFile4ML_'.rand()."_";
+            $token = $this->auth->uploadToken($this->bucketName, $key);
+            $tempFile = qiniuTempFile($testFileSize);
+            $resumeFile = tempnam(sys_get_temp_dir(), 'resume_file');
+            $this->assertNotFalse($resumeFile);
+            try {
+                $upManager->putFile(
+                    $token,
+                    $key,
+                    $tempFile,
+                    null,
+                    'application/octet-stream',
+                    false,
+                    $resumeFile,
+                    $invalidVersion,
+                    $partSize
+                );
+            } catch (\Exception $e) {
+                $isRightException = false;
+                $expectExceptionCount++;
+                while ($e) {
+                    $isRightException = $e instanceof \UnexpectedValueException;
+                    if ($isRightException) {
+                        break;
+                    }
+                    $e = $e->getPrevious();
+                }
+                $this->assertTrue($isRightException);
+            }
+
+            unlink($resumeFile);
+            unlink($tempFile);
+        }
+        $this->assertEquals(count($testInvalidVersions), $expectExceptionCount);
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,9 @@`
`1`	`1`	`<?php`
`2`	`2`
	`3`	`+if ( file_exists(dirname(__FILE__).'/vendor/autoload.php') ) {`
	`4`	`+ require_once dirname(__FILE__).'/vendor/autoload.php';`
	`5`	`+}`
	`6`	`+`
`3`	`7`	`function classLoader($class)`
`4`	`8`	`{`
`5`	`9`	`$path = str_replace('\\', DIRECTORY_SEPARATOR, $class);`