MAGETWO-38151: Data Rollback

- Changed rollback file validation logic.

Author: safwkhan

lib/internal/Magento/Framework/Setup/BackupRollback.php

@@ -127,6 +127,9 @@ public function codeBackup($time, $type = Factory::TYPE_FILESYSTEM)
      */
     public function codeRollback($rollbackFile, $type = Factory::TYPE_FILESYSTEM)
     {
+        if (preg_match('/[0-9]_(filesystem)_(code|media)\.(tgz)$/', $rollbackFile) !== 1) {
+            throw new LocalizedException(new Phrase('Invalid rollback file.'));
+        }
         $backupsDir = $this->directoryList->getPath(DirectoryList::VAR_DIR) . '/' . self::DEFAULT_BACKUP_DIRECTORY;
         if (!$this->file->isExists($backupsDir . '/' . $rollbackFile)) {
             throw new LocalizedException(new Phrase('The rollback file does not exist.'));
@@ -159,7 +162,6 @@ public function codeRollback($rollbackFile, $type = Factory::TYPE_FILESYSTEM)
         $fsRollback->setBackupsDir($backupsDir);
         $fsRollback->setBackupExtension('tgz');
         $time = explode('_', $rollbackFile);
-        $this->checkRollbackFileValidity($time, 'tgz');
         $fsRollback->setTime($time[0]);
         $this->log->log($granularType . ' rollback is starting ...');
         $fsRollback->rollback();
@@ -206,6 +208,9 @@ public function dbBackup($time)
      */
     public function dbRollback($rollbackFile)
     {
+        if (preg_match('/[0-9]_(db).(gz)$/', $rollbackFile) !== 1) {
+            throw new LocalizedException(new Phrase('Invalid rollback file.'));
+        }
         $backupsDir = $this->directoryList->getPath(DirectoryList::VAR_DIR) . '/' . self::DEFAULT_BACKUP_DIRECTORY;
         if (!$this->file->isExists($backupsDir . '/' . $rollbackFile)) {
             throw new LocalizedException(new Phrase('The rollback file does not exist.'));
@@ -217,7 +222,6 @@ public function dbRollback($rollbackFile)
         $dbRollback->setBackupsDir($backupsDir);
         $dbRollback->setBackupExtension('gz');
         $time = explode('_', $rollbackFile);
-        $this->checkRollbackFileValidity($time, 'gz');
         if (count($time) === 3) {
             $thirdPart = explode('.', $time[2]);
             $dbRollback->setName($thirdPart[0]);
@@ -284,24 +288,4 @@ private function getMediaBackupIgnorePaths()
         }
         return $ignorePaths;
     }
-
-    /**
-     * Check if the provided backup file for rollback is valid
-     *
-     * @param array $time
-     * @param string $type
-     * @return void
-     * @throws LocalizedException
-     */
-    private function checkRollbackFileValidity($time, $type)
-    {
-        $invalidFileNameMsg = 'Invalid rollback file.';
-        if (!in_array(count($time), [2, 3])) {
-            throw new LocalizedException(new Phrase($invalidFileNameMsg));
-        }
-        $extension = explode('.', $time[count($time) - 1]);
-        if ($extension[count($extension) - 1] !== $type) {
-            throw new LocalizedException(new Phrase($invalidFileNameMsg));
-        }
-    }
 }

lib/internal/Magento/Framework/Setup/Test/Unit/BackupRollbackTest.php

@@ -120,9 +120,9 @@ public function testCodeRollback()
         $this->setupCodeBackupRollback();
         $this->file->expects($this->once())
             ->method('isExists')
-            ->with($this->path . '/backups/RollbackFile_A.tgz')
+            ->with($this->path . '/backups/12345_filesystem_code.tgz')
             ->willReturn(true);
-        $this->model->codeRollback('RollbackFile_A.tgz');
+        $this->model->codeRollback('12345_filesystem_code.tgz');
     }
 
     /**
@@ -134,7 +134,7 @@ public function testCodeRollbackWithInvalidFilePath()
         $this->file->expects($this->once())
             ->method('isExists')
             ->willReturn(false);
-        $this->model->codeRollback('RollbackFile_A.tgz');
+        $this->model->codeRollback('12345_filesystem_code.tgz');
     }
 
     /**
@@ -143,24 +143,9 @@ public function testCodeRollbackWithInvalidFilePath()
      */
     public function testCodeRollbackWithInvalidFileType()
     {
-        $this->file->expects($this->once())
-            ->method('isExists')
-            ->willReturn(true);
         $this->model->codeRollback('RollbackFile_A.txt');
     }
 
-    /**
-     * @expectedException \Magento\Framework\Exception\LocalizedException
-     * @expectedExceptionMessage Invalid rollback file.
-     */
-    public function testCodeRollbackWithInvalidFileFormat()
-    {
-        $this->file->expects($this->once())
-            ->method('isExists')
-            ->willReturn(true);
-        $this->model->codeRollback('RollbackFile.gz');
-    }
-
     public function testMediaBackup()
     {
         $this->setupCodeBackupRollback();
@@ -177,9 +162,9 @@ public function testMediaRollback()
         $this->setupCodeBackupRollback();
         $this->file->expects($this->once())
             ->method('isExists')
-            ->with($this->path . '/backups/RollbackFile_A.tgz')
+            ->with($this->path . '/backups/12345_filesystem_media.tgz')
             ->willReturn(true);
-        $this->model->codeRollback('RollbackFile_A.tgz', Factory::TYPE_MEDIA);
+        $this->model->codeRollback('12345_filesystem_media.tgz', Factory::TYPE_MEDIA);
     }
 
     public function testDbBackup()
@@ -197,9 +182,9 @@ public function testDbRollback()
         $this->database->expects($this->once())->method('rollback');
         $this->file->expects($this->once())
             ->method('isExists')
-            ->with($this->path . '/backups/RollbackFile_A.gz')
+            ->with($this->path . '/backups/12345_db.gz')
             ->willReturn(true);
-        $this->model->dbRollback('RollbackFile_A.gz');
+        $this->model->dbRollback('12345_db.gz');
     }
 
     private function setupCodeBackupRollback()
@@ -217,7 +202,7 @@ private function setupCodeBackupRollback()
             ->willReturn('RollbackFile_A.tgz');
         $this->filesystem->expects($this->once())
             ->method('getBackupPath')
-            ->willReturn('pathToFile/RollbackFile_A.tgz');
+            ->willReturn('pathToFile/12345_filesystem_code.tgz');
         $this->log->expects($this->once())
             ->method('logSuccess');
     }
@@ -235,7 +220,7 @@ private function setupDbBackupRollback()
             ->willReturn('RollbackFile_A.gz');
         $this->database->expects($this->once())
             ->method('getBackupPath')
-            ->willReturn('pathToFile/RollbackFile_A.gz');
+            ->willReturn('pathToFile/12345_db.tgz');
         $this->log->expects($this->once())
             ->method('logSuccess');
     }