diff --git a/src/backups.js b/src/backups.js index bce72244e..dac4d0a1d 100644 --- a/src/backups.js +++ b/src/backups.js @@ -199,7 +199,7 @@ function backupBoxWithAppBackupIds(appBackupIds, prefix, callback) { backupdb.add({ id: backupId, version: config.version(), type: backupdb.BACKUP_TYPE_BOX, dependsOn: appBackupIds, restoreConfig: null }, function (error) { if (error) return callback(new BackupsError(BackupsError.INTERNAL_ERROR, error)); - api(backupConfig.provider).backup(backupConfig, backupId, paths.BOX_DATA_DIR, function (backupTaskError) { + api(backupConfig.provider).upload(backupConfig, backupId, paths.BOX_DATA_DIR, function (backupTaskError) { const state = backupTaskError ? backupdb.BACKUP_STATE_ERROR : backupdb.BACKUP_STATE_NORMAL; debug('backupBoxWithAppBackupIds: %s time: %s secs', state, (new Date() - startTime)/1000); @@ -252,7 +252,7 @@ function createNewAppBackup(app, manifest, prefix, backupConfig, callback) { if (error) return callback(new BackupsError(BackupsError.INTERNAL_ERROR, error)); var appDataDir = safe.fs.realpathSync(path.join(paths.APPS_DATA_DIR, app.id)); - api(backupConfig.provider).backup(backupConfig, backupId, appDataDir, function (backupTaskError) { + api(backupConfig.provider).upload(backupConfig, backupId, appDataDir, function (backupTaskError) { const state = backupTaskError ? backupdb.BACKUP_STATE_ERROR : backupdb.BACKUP_STATE_NORMAL; debugApp(app, 'createNewAppBackup: %s done with state %s', backupId, state); @@ -437,7 +437,7 @@ function restoreApp(app, addonsToRestore, backupId, callback) { var startTime = new Date(); async.series([ - api(backupConfig.provider).restore.bind(null, backupConfig, backupId, appDataDir), + api(backupConfig.provider).download.bind(null, backupConfig, backupId, appDataDir), addons.restoreAddons.bind(null, app, addonsToRestore) ], function (error) { debug('restoreApp: time: %s', (new Date() - startTime)/1000); @@ -464,7 +464,7 @@ function cleanupAppBackups(backupConfig, referencedAppBackups, callback) { debug('cleanup: removing %s', backup.id); - api(backupConfig.provider).removeBackups(backupConfig, [ backup.id ], function (error) { + api(backupConfig.provider).removeMany(backupConfig, [ backup.id ], function (error) { if (error) { debug('cleanup: error removing backup %j : %s', backup, error.message); iteratorDone(); @@ -523,7 +523,7 @@ function cleanupBoxBackups(backupConfig, callback) { var backupIds = [].concat(backup.id, backup.dependsOn); - api(backupConfig.provider).removeBackups(backupConfig, backupIds, function (error) { + api(backupConfig.provider).removeMany(backupConfig, backupIds, function (error) { if (error) { debug('cleanup: error removing backup %j : %s', backup, error.message); iteratorDone(); diff --git a/src/storage/caas.js b/src/storage/caas.js index 89d15a63f..41ac8d980 100644 --- a/src/storage/caas.js +++ b/src/storage/caas.js @@ -1,10 +1,10 @@ 'use strict'; exports = module.exports = { - backup: backup, - restore: restore, - copyBackup: copyBackup, - removeBackups: removeBackups, + upload: upload, + download: download, + copy: copy, + removeMany: removeMany, backupDone: backupDone, @@ -61,7 +61,7 @@ function getBackupFilePath(apiConfig, backupId) { } // storage api -function backup(apiConfig, backupId, sourceDir, callback) { +function upload(apiConfig, backupId, sourceDir, callback) { assert.strictEqual(typeof apiConfig, 'object'); assert.strictEqual(typeof backupId, 'string'); assert.strictEqual(typeof sourceDir, 'string'); @@ -99,7 +99,7 @@ function backup(apiConfig, backupId, sourceDir, callback) { }); } -function restore(apiConfig, backupId, destination, callback) { +function download(apiConfig, backupId, destination, callback) { assert.strictEqual(typeof apiConfig, 'object'); assert.strictEqual(typeof backupId, 'string'); assert.strictEqual(typeof destination, 'string'); @@ -134,7 +134,7 @@ function restore(apiConfig, backupId, destination, callback) { }); } -function copyBackup(apiConfig, oldBackupId, newBackupId, callback) { +function copy(apiConfig, oldBackupId, newBackupId, callback) { assert.strictEqual(typeof apiConfig, 'object'); assert.strictEqual(typeof oldBackupId, 'string'); assert.strictEqual(typeof newBackupId, 'string'); @@ -162,7 +162,7 @@ function copyBackup(apiConfig, oldBackupId, newBackupId, callback) { }); } -function removeBackups(apiConfig, backupIds, callback) { +function removeMany(apiConfig, backupIds, callback) { assert.strictEqual(typeof apiConfig, 'object'); assert(Array.isArray(backupIds)); assert.strictEqual(typeof callback, 'function'); @@ -184,7 +184,7 @@ function removeBackups(apiConfig, backupIds, callback) { var s3 = new AWS.S3(credentials); s3.deleteObjects(params, function (error, data) { if (error) debug('Unable to remove %s. Not fatal.', params.Key, error); - else debug('removeBackups: Deleted: %j Errors: %j', data.Deleted, data.Errors); + else debug('removeMany: Deleted: %j Errors: %j', data.Deleted, data.Errors); callback(null); }); diff --git a/src/storage/filesystem.js b/src/storage/filesystem.js index 683385ec2..e5b4e93b7 100644 --- a/src/storage/filesystem.js +++ b/src/storage/filesystem.js @@ -1,10 +1,11 @@ 'use strict'; exports = module.exports = { - backup: backup, - restore: restore, - copyBackup: copyBackup, - removeBackups: removeBackups, + upload: upload, + download: download, + copy: copy, + + removeMany: removeMany, backupDone: backupDone, @@ -37,7 +38,7 @@ function getBackupFilePath(apiConfig, backupId) { } // storage api -function backup(apiConfig, backupId, sourceDir, callback) { +function upload(apiConfig, backupId, sourceDir, callback) { assert.strictEqual(typeof apiConfig, 'object'); assert.strictEqual(typeof backupId, 'string'); assert.strictEqual(typeof sourceDir, 'string'); @@ -73,7 +74,7 @@ function backup(apiConfig, backupId, sourceDir, callback) { }); } -function restore(apiConfig, backupId, destination, callback) { +function download(apiConfig, backupId, destination, callback) { assert.strictEqual(typeof apiConfig, 'object'); assert.strictEqual(typeof backupId, 'string'); assert.strictEqual(typeof destination, 'string'); @@ -97,7 +98,7 @@ function restore(apiConfig, backupId, destination, callback) { targz.extract(fileStream, destination, apiConfig.key || null, callback); } -function copyBackup(apiConfig, oldBackupId, newBackupId, callback) { +function copy(apiConfig, oldBackupId, newBackupId, callback) { assert.strictEqual(typeof apiConfig, 'object'); assert.strictEqual(typeof oldBackupId, 'string'); assert.strictEqual(typeof newBackupId, 'string'); @@ -136,7 +137,7 @@ function copyBackup(apiConfig, oldBackupId, newBackupId, callback) { }); } -function removeBackups(apiConfig, backupIds, callback) { +function removeMany(apiConfig, backupIds, callback) { assert.strictEqual(typeof apiConfig, 'object'); assert(Array.isArray(backupIds)); assert.strictEqual(typeof callback, 'function'); @@ -145,7 +146,7 @@ function removeBackups(apiConfig, backupIds, callback) { var filePath = getBackupFilePath(apiConfig, id); if (!safe.fs.unlinkSync(filePath)) { - debug('removeBackups: Unable to remove %s : %s', filePath, safe.error.message); + debug('removeMany: Unable to remove %s : %s', filePath, safe.error.message); } safe.fs.rmdirSync(path.dirname(filePath)); // try to cleanup empty directories diff --git a/src/storage/interface.js b/src/storage/interface.js index 32a23f1a0..c7a18bd97 100644 --- a/src/storage/interface.js +++ b/src/storage/interface.js @@ -7,10 +7,11 @@ // ------------------------------------------- exports = module.exports = { - backup: backup, - restore: restore, - copyBackup: copyBackup, - removeBackups: removeBackups, + upload: upload, + download: download, + copy: copy, + + removeMany: removeMany, backupDone: backupDone, @@ -19,7 +20,7 @@ exports = module.exports = { var assert = require('assert'); -function backup(apiConfig, backupId, sourceDir, callback) { +function upload(apiConfig, backupId, sourceDir, callback) { assert.strictEqual(typeof apiConfig, 'object'); assert.strictEqual(typeof backupId, 'string'); assert.strictEqual(typeof sourceDir, 'string'); @@ -30,7 +31,7 @@ function backup(apiConfig, backupId, sourceDir, callback) { callback(new Error('not implemented')); } -function restore(apiConfig, backupId, destination, callback) { +function download(apiConfig, backupId, destination, callback) { assert.strictEqual(typeof apiConfig, 'object'); assert.strictEqual(typeof backupId, 'string'); assert.strictEqual(typeof destination, 'string'); @@ -41,7 +42,7 @@ function restore(apiConfig, backupId, destination, callback) { callback(new Error('not implemented')); } -function copyBackup(apiConfig, oldBackupId, newBackupId, callback) { +function copy(apiConfig, oldBackupId, newBackupId, callback) { assert.strictEqual(typeof apiConfig, 'object'); assert.strictEqual(typeof oldBackupId, 'string'); assert.strictEqual(typeof newBackupId, 'string'); @@ -52,7 +53,7 @@ function copyBackup(apiConfig, oldBackupId, newBackupId, callback) { callback(new Error('not implemented')); } -function removeBackups(apiConfig, backupIds, callback) { +function removeMany(apiConfig, backupIds, callback) { assert.strictEqual(typeof apiConfig, 'object'); assert(Array.isArray(backupIds)); assert.strictEqual(typeof callback, 'function'); diff --git a/src/storage/noop.js b/src/storage/noop.js index baf9683d1..0b1d52698 100644 --- a/src/storage/noop.js +++ b/src/storage/noop.js @@ -1,10 +1,11 @@ 'use strict'; exports = module.exports = { - backup: backup, - restore: restore, - copyBackup: copyBackup, - removeBackups: removeBackups, + upload: upload, + download: download, + copy: copy, + + removeMany: removeMany, backupDone: backupDone, @@ -14,7 +15,7 @@ exports = module.exports = { var assert = require('assert'), debug = require('debug')('box:storage/noop'); -function backup(apiConfig, backupId, sourceDir, callback) { +function upload(apiConfig, backupId, sourceDir, callback) { assert.strictEqual(typeof apiConfig, 'object'); assert.strictEqual(typeof backupId, 'string'); assert.strictEqual(typeof sourceDir, 'string'); @@ -25,7 +26,7 @@ function backup(apiConfig, backupId, sourceDir, callback) { callback(); } -function restore(apiConfig, backupId, destination, callback) { +function download(apiConfig, backupId, destination, callback) { assert.strictEqual(typeof apiConfig, 'object'); assert.strictEqual(typeof backupId, 'string'); assert.strictEqual(typeof destination, 'string'); @@ -36,7 +37,7 @@ function restore(apiConfig, backupId, destination, callback) { callback(new Error('Cannot restore from noop backend')); } -function copyBackup(apiConfig, oldBackupId, newBackupId, callback) { +function copy(apiConfig, oldBackupId, newBackupId, callback) { assert.strictEqual(typeof apiConfig, 'object'); assert.strictEqual(typeof oldBackupId, 'string'); assert.strictEqual(typeof newBackupId, 'string'); @@ -47,12 +48,12 @@ function copyBackup(apiConfig, oldBackupId, newBackupId, callback) { callback(); } -function removeBackups(apiConfig, backupIds, callback) { +function removeMany(apiConfig, backupIds, callback) { assert.strictEqual(typeof apiConfig, 'object'); assert(Array.isArray(backupIds)); assert.strictEqual(typeof callback, 'function'); - debug('removeBackups: %j', backupIds); + debug('removeMany: %j', backupIds); callback(); } diff --git a/src/storage/s3.js b/src/storage/s3.js index 52a3184d7..58c512302 100644 --- a/src/storage/s3.js +++ b/src/storage/s3.js @@ -1,10 +1,11 @@ 'use strict'; exports = module.exports = { - backup: backup, - restore: restore, - copyBackup: copyBackup, - removeBackups: removeBackups, + upload: upload, + download: download, + copy: copy, + + removeMany: removeMany, backupDone: backupDone, @@ -66,7 +67,7 @@ function getBackupFilePath(apiConfig, backupId) { } // storage api -function backup(apiConfig, backupId, sourceDir, callback) { +function upload(apiConfig, backupId, sourceDir, callback) { assert.strictEqual(typeof apiConfig, 'object'); assert.strictEqual(typeof backupId, 'string'); assert.strictEqual(typeof sourceDir, 'string'); @@ -104,7 +105,7 @@ function backup(apiConfig, backupId, sourceDir, callback) { }); } -function restore(apiConfig, backupId, destination, callback) { +function download(apiConfig, backupId, destination, callback) { assert.strictEqual(typeof apiConfig, 'object'); assert.strictEqual(typeof backupId, 'string'); assert.strictEqual(typeof destination, 'string'); @@ -140,7 +141,7 @@ function restore(apiConfig, backupId, destination, callback) { }); } -function copyBackup(apiConfig, oldBackupId, newBackupId, callback) { +function copy(apiConfig, oldBackupId, newBackupId, callback) { assert.strictEqual(typeof apiConfig, 'object'); assert.strictEqual(typeof oldBackupId, 'string'); assert.strictEqual(typeof newBackupId, 'string'); @@ -168,7 +169,7 @@ function copyBackup(apiConfig, oldBackupId, newBackupId, callback) { }); } -function removeBackups(apiConfig, backupIds, callback) { +function removeMany(apiConfig, backupIds, callback) { assert.strictEqual(typeof apiConfig, 'object'); assert(Array.isArray(backupIds)); assert.strictEqual(typeof callback, 'function'); @@ -189,8 +190,8 @@ function removeBackups(apiConfig, backupIds, callback) { var s3 = new AWS.S3(credentials); s3.deleteObjects(params, function (error, data) { - if (error) debug('removeBackups: Unable to remove %s. Not fatal.', params.Key, error); - else debug('removeBackups: Deleted: %j Errors: %j', data.Deleted, data.Errors); + if (error) debug('removeMany: Unable to remove %s. Not fatal.', params.Key, error); + else debug('removeMany: Deleted: %j Errors: %j', data.Deleted, data.Errors); callback(null); }); diff --git a/src/test/storage-test.js b/src/test/storage-test.js index 6f4395df2..cb70a828b 100644 --- a/src/test/storage-test.js +++ b/src/test/storage-test.js @@ -145,15 +145,15 @@ describe('Storage', function () { }); it('can backup', function (done) { - filesystem.backup(gBackupConfig, gBackupId_1, gSourceFolder, function (error) { + filesystem.upload(gBackupConfig, gBackupId_1, gSourceFolder, function (error) { expect(error).to.be(null); done(); }); }); - it('can restore', function (done) { - filesystem.restore(gBackupConfig, gBackupId_1, gDestinationFolder, function (error) { + it('can download', function (done) { + filesystem.download(gBackupConfig, gBackupId_1, gDestinationFolder, function (error) { expect(error).to.be(null); compareDirectories(path.join(gSourceFolder, 'data'), path.join(gDestinationFolder, 'data'), function (error) { @@ -170,16 +170,16 @@ describe('Storage', function () { it('can copy backup', function (done) { // will be verified after removing the first and restoring from the copy - filesystem.copyBackup(gBackupConfig, gBackupId_1, gBackupId_2, done); + filesystem.copy(gBackupConfig, gBackupId_1, gBackupId_2, done); }); it('can remove backup', function (done) { - // will be verified with next test trying to restore the removed one - filesystem.removeBackups(gBackupConfig, [ gBackupId_1 ], done); + // will be verified with next test trying to download the removed one + filesystem.removeMany(gBackupConfig, [ gBackupId_1 ], done); }); - it('cannot restore deleted backup', function (done) { - filesystem.restore(gBackupConfig, gBackupId_1, gDestinationFolder, function (error) { + it('cannot download deleted backup', function (done) { + filesystem.download(gBackupConfig, gBackupId_1, gDestinationFolder, function (error) { expect(error).to.be.an('object'); expect(error.reason).to.equal(BackupsError.NOT_FOUND); @@ -187,8 +187,8 @@ describe('Storage', function () { }); }); - it('can restore backup copy', function (done) { - filesystem.restore(gBackupConfig, gBackupId_2, gDestinationFolder, function (error) { + it('can download backup copy', function (done) { + filesystem.download(gBackupConfig, gBackupId_2, gDestinationFolder, function (error) { expect(error).to.be(null); compareDirectories(path.join(gSourceFolder, 'data'), path.join(gDestinationFolder, 'data'), function (error) { @@ -204,7 +204,7 @@ describe('Storage', function () { }); it('can remove backup copy', function (done) { - filesystem.removeBackups(gBackupConfig, [ gBackupId_2 ], done); + filesystem.removeMany(gBackupConfig, [ gBackupId_2 ], done); }); }); @@ -257,15 +257,15 @@ describe('Storage', function () { }); it('can backup', function (done) { - s3.backup(gBackupConfig, gBackupId_1, gSourceFolder, function (error) { + s3.upload(gBackupConfig, gBackupId_1, gSourceFolder, function (error) { expect(error).to.be(null); done(); }); }); - it('can restore', function (done) { - s3.restore(gBackupConfig, gBackupId_1, gDestinationFolder, function (error) { + it('can download', function (done) { + s3.download(gBackupConfig, gBackupId_1, gDestinationFolder, function (error) { expect(error).to.be(null); compareDirectories(path.join(gSourceFolder, 'data'), path.join(gDestinationFolder, 'data'), function (error) { @@ -282,16 +282,16 @@ describe('Storage', function () { it('can copy backup', function (done) { // will be verified after removing the first and restoring from the copy - s3.copyBackup(gBackupConfig, gBackupId_1, gBackupId_2, done); + s3.copy(gBackupConfig, gBackupId_1, gBackupId_2, done); }); it('can remove backup', function (done) { - // will be verified with next test trying to restore the removed one - s3.removeBackups(gBackupConfig, [ gBackupId_1 ], done); + // will be verified with next test trying to download the removed one + s3.removeMany(gBackupConfig, [ gBackupId_1 ], done); }); - it('cannot restore deleted backup', function (done) { - s3.restore(gBackupConfig, gBackupId_1, gDestinationFolder, function (error) { + it('cannot download deleted backup', function (done) { + s3.download(gBackupConfig, gBackupId_1, gDestinationFolder, function (error) { expect(error).to.be.an('object'); expect(error.reason).to.equal(BackupsError.NOT_FOUND); @@ -299,8 +299,8 @@ describe('Storage', function () { }); }); - it('can restore backup copy', function (done) { - s3.restore(gBackupConfig, gBackupId_2, gDestinationFolder, function (error) { + it('can download backup copy', function (done) { + s3.download(gBackupConfig, gBackupId_2, gDestinationFolder, function (error) { expect(error).to.be(null); compareDirectories(path.join(gSourceFolder, 'data'), path.join(gDestinationFolder, 'data'), function (error) { @@ -316,7 +316,7 @@ describe('Storage', function () { }); it('can remove backup copy', function (done) { - s3.removeBackups(gBackupConfig, [ gBackupId_2 ], done); + s3.removeMany(gBackupConfig, [ gBackupId_2 ], done); }); }); });