feat: #70 continue when break

Author: shaunthegeek

app/Commands/WikiImportCommand.php

@@ -8,6 +8,7 @@
 use DOMDocument;
 use Exception;
 use Illuminate\Contracts\Filesystem\FileNotFoundException;
+use Illuminate\Support\Facades\File;
 use Illuminate\Support\Str;
 use LaravelFans\Confluence\Facades\Confluence;
 use LaravelZero\Framework\Commands\Command;
@@ -20,6 +21,7 @@ class WikiImportCommand extends Command
     protected Disk $codingDisk;
     protected Wiki $codingWiki;
     protected array $errors = [];
+    protected array $importedPages = [];
 
     /**
      * The signature of the command.
@@ -37,6 +39,7 @@ class WikiImportCommand extends Command
         {--coding_team_domain= : CODING 团队域名，如 xxx.coding.net 即填写 xxx}
         {--coding_project_uri= : CODING 项目标识，如 xxx.coding.net/p/yyy 即填写 yyy}
         {--save-markdown : 本地保留生成的 Markdown 文件}
+        {--continue : 断点续传}
     ';
 
     /**
@@ -194,6 +197,9 @@ private function handleConfluenceHtml(): int
 
     private function uploadConfluencePages(string $htmlDir, array $tree, array $titles, int $parentId = 0): void
     {
+        if ($this->option('continue') && file_exists($htmlDir . DIRECTORY_SEPARATOR . 'success.log')) {
+            $this->importedPages = parse_ini_file($htmlDir . DIRECTORY_SEPARATOR . 'success.log');
+        }
         foreach ($tree as $page => $subPages) {
             $title = $titles[$page];
             $wikiId = $this->uploadConfluencePage($htmlDir . DIRECTORY_SEPARATOR . $page, $title, $parentId);
@@ -207,6 +213,11 @@ private function uploadConfluencePages(string $htmlDir, array $tree, array $titl
 
     private function uploadConfluencePage(string $filePath, string $title = '', int $parentId = 0): int
     {
+        $page = basename($filePath);
+        if ($this->option('continue') && isset($this->importedPages[$page])) {
+            $this->warn('断点续传，跳过页面：' . $page);
+            return $this->importedPages[$page];
+        }
         try {
             $markdown = $this->confluence->htmlFile2Markdown($filePath);
         } catch (FileNotFoundException $e) {
@@ -223,7 +234,6 @@ private function uploadConfluencePage(string $filePath, string $title = '', int
         $this->info('标题：' . $title);
 
         $htmlDir = dirname($filePath);
-        $page = basename($filePath);
         $markdown = $this->dealAttachments($filePath, $markdown);
         $mdFilename = substr($page, 0, -5) . '.md';
         if ($this->option('save-markdown')) {
@@ -244,22 +254,20 @@ private function uploadConfluencePage(string $filePath, string $title = '', int
                 $this->codingProjectUri,
                 $result['JobId']
             );
-        } catch (Exception $e) {
-            $message = '错误：导入失败，跳过 ' . $title . ' ' . $page;
-            $this->error($message);
-            $this->errors[] = $message;
-            return false;
-        }
-        if ($jobStatus['Status'] == 'success') {
+            if ($jobStatus['Status'] != 'success') {
+                throw new Exception('job status ' . $jobStatus['Status']);
+            }
             $wikiId = intval($jobStatus['Iids'][0]);
-        }
-        if (empty($wikiId)) {
+        } catch (Exception $e) {
             $message = '错误：导入失败，跳过 ' . $title . ' ' . $page;
             $this->error($message);
             $this->errors[] = $message;
             return false;
         }
         $this->codingWiki->updateTitle($this->codingToken, $this->codingProjectUri, $wikiId, $title);
+        if ($this->option('continue')) {
+            file_put_contents($htmlDir . DIRECTORY_SEPARATOR . 'success.log', "$page = $wikiId\n", FILE_APPEND);
+        }
         return $wikiId;
     }
 

tests/Feature/WikiImportCommandTest.php

@@ -5,6 +5,7 @@
 use App\Coding\Disk;
 use App\Coding\Wiki;
 use Confluence\Content;
+use Illuminate\Support\Facades\File;
 use LaravelFans\Confluence\Facades\Confluence;
 use Mockery\MockInterface;
 use Tests\TestCase;
@@ -180,7 +181,8 @@ public function testHandleConfluenceHtmlSuccess()
         $this->instance(Disk::class, $mockDisk);
         $mockDisk->shouldReceive('uploadAttachments')->times(4)->andReturn([]);
 
-        $this->artisan('wiki:import', ['--save-markdown' => true])
+        File::delete($this->dataDir . '/confluence/space1/success.log');
+        $this->artisan('wiki:import', ['--save-markdown' => true, '--continue' => true])
             ->expectsQuestion('数据来源？', 'Confluence')
             ->expectsQuestion('数据类型？', 'HTML')
             ->expectsQuestion('空间导出的 HTML zip 文件路径', $this->dataDir . 'confluence/space1/')
@@ -207,6 +209,11 @@ public function testHandleConfluenceHtmlSuccess()
         unlink($this->dataDir . '/confluence/space1/65591.md');
         unlink($this->dataDir . '/confluence/space1/attachment-demo_65615.md');
         unlink($this->dataDir . '/confluence/space1/text-demo_65601.md');
+        $log = "image-demo_65619.html = 27\n"
+            . "65591.html = 27\n"
+            . "attachment-demo_65615.html = 27\n"
+            . "text-demo_65601.html = 27\n";
+        $this->assertEquals($log, file_get_contents($this->dataDir . '/confluence/space1/success.log'));
     }
 
     public function testAskNothing()
@@ -299,4 +306,58 @@ public function testHandleConfluenceSingleHtmlSuccess()
             ->expectsOutput('上传成功，正在处理，任务 ID：a12353fa-f45b-4af2-83db-666bf9f66615')
             ->assertExitCode(0);
     }
+
+    public function testHandleConfluenceHtmlContinueSuccess()
+    {
+        $this->setConfig();
+
+        // 注意：不能使用 partialMock
+        // https://laracasts.com/discuss/channels/testing/this-partialmock-doesnt-call-the-constructor
+        $mock = \Mockery::mock(Wiki::class, [])->makePartial();
+        $this->instance(Wiki::class, $mock);
+
+        $mock->shouldReceive('createWikiByUploadZip')->times(2)->andReturn(json_decode(
+            file_get_contents($this->dataDir . 'coding/' . 'CreateWikiByZipResponse.json'),
+            true
+        )['Response']);
+        $mock->shouldReceive('getImportJobStatus')->times(2)->andReturn(json_decode(
+            file_get_contents($this->dataDir . 'coding/' . 'DescribeImportJobStatusResponse.json'),
+            true
+        )['Response']['Data']);
+        $mock->shouldReceive('updateTitle')->times(2)->andReturn(true);
+
+
+        $mockDisk = \Mockery::mock(Disk::class, [])->makePartial();
+        $this->instance(Disk::class, $mockDisk);
+        $mockDisk->shouldReceive('uploadAttachments')->times(2)->andReturn([]);
+
+        $log = "image-demo_65619.html = 27\n"
+            . "65591.html = 27\n";
+        file_put_contents($this->dataDir . '/confluence/space1/success.log', $log);
+        $this->artisan('wiki:import', ['--continue' => true])
+            ->expectsQuestion('数据来源？', 'Confluence')
+            ->expectsQuestion('数据类型？', 'HTML')
+            ->expectsQuestion('空间导出的 HTML zip 文件路径', $this->dataDir . 'confluence/space1/')
+            ->expectsOutput('空间名称：空间 1')
+            ->expectsOutput('空间标识：space1')
+            ->expectsOutput('发现 3 个一级页面')
+            ->expectsOutput("开始导入 CODING：")
+            ->expectsOutput('页面不存在：' . $this->dataDir . 'confluence/space1/not-found.html')
+            ->expectsOutput('断点续传，跳过页面：image-demo_65619.html')
+            ->expectsOutput('断点续传，跳过页面：65591.html')
+            ->expectsOutput('发现 2 个子页面')
+            ->expectsOutput('标题：Attachment Demo')
+            ->expectsOutput('上传成功，正在处理，任务 ID：a12353fa-f45b-4af2-83db-666bf9f66615')
+            ->expectsOutput('标题：Text Demo')
+            ->expectsOutput('上传成功，正在处理，任务 ID：a12353fa-f45b-4af2-83db-666bf9f66615')
+            ->expectsOutput('报错信息汇总：')
+            ->expectsOutput('页面不存在：' . $this->dataDir . 'confluence/space1/not-found.html')
+            ->assertExitCode(1);
+        $log = "image-demo_65619.html = 27\n"
+            . "65591.html = 27\n"
+            . "attachment-demo_65615.html = 27\n"
+            . "text-demo_65601.html = 27\n";
+        $this->assertEquals($log, file_get_contents($this->dataDir . '/confluence/space1/success.log'));
+        unlink($this->dataDir . '/confluence/space1/success.log');
+    }
 }