NC | Adding support of user bucket path

Signed-off-by: jackyalbo <jacky.albo@gmail.com>

Author: jackyalbo

config.js

@@ -1016,6 +1016,8 @@ config.NSFS_LIST_IGNORE_ENTRY_ON_EACCES = true;
 // we will for now handle the same way also EINVAL error - for gpfs stat issues on list (.snapshots)
 config.NSFS_LIST_IGNORE_ENTRY_ON_EINVAL = true;
 
+config.NSFS_USER_BUCKET_PATH_HTTP_HEADER = 'x-nsfs-bucket-path';
+
 ////////////////////////////
 // NSFS NON CONTAINERIZED //
 ////////////////////////////

src/api/bucket_api.js

@@ -33,6 +33,7 @@ module.exports = {
                     },
                     bucket_claim: { $ref: '#/definitions/bucket_claim' },
                     force_md5_etag: { type: 'boolean' },
+                    user_bucket_path: { type: 'string' }
                 }
             },
             reply: {

src/endpoint/s3/ops/s3_put_bucket.js

@@ -9,7 +9,8 @@ const config = require('../../../../config');
 async function put_bucket(req, res) {
     const lock_enabled = config.WORM_ENABLED ? req.headers['x-amz-bucket-object-lock-enabled'] &&
         req.headers['x-amz-bucket-object-lock-enabled'].toUpperCase() === 'TRUE' : undefined;
-    await req.object_sdk.create_bucket({ name: req.params.bucket, lock_enabled: lock_enabled });
+    const user_bucket_path = req.headers[config.NSFS_USER_BUCKET_PATH_HTTP_HEADER];
+    await req.object_sdk.create_bucket({ name: req.params.bucket, lock_enabled: lock_enabled, user_bucket_path: user_bucket_path });
     if (config.allow_anonymous_access_in_test && req.headers['x-amz-acl'] === 'public-read') { // For now we will enable only for tests
         const policy = {
             Version: '2012-10-17',

src/sdk/bucketspace_fs.js

@@ -305,7 +305,8 @@ class BucketSpaceFS extends BucketSpaceSimpleFS {
 
             const { name } = params;
             const bucket_config_path = this.config_fs.get_bucket_path_by_name(name);
-            const bucket_storage_path = path.join(sdk.requesting_account.nsfs_account_config.new_buckets_path, name);
+            const bucket_storage_path = params.user_bucket_path ||
+                path.join(sdk.requesting_account.nsfs_account_config.new_buckets_path, name);
 
             dbg.log0(`BucketSpaceFS.create_bucket
                 requesting_account=${util.inspect(sdk.requesting_account)},

src/test/integration_tests/nsfs/test_nsfs_integration.js

@@ -380,6 +380,53 @@ mocha.describe('bucket operations - namespace_fs', function() {
         console.log(inspect(res));
         await fs_utils.file_must_exist(path.join(s3_new_buckets_path, bucket_name + '-s3'));
     });
+    mocha.it('create s3 bucket with x-nsfs-bucket-path', async function() {
+        // only NC supports creating buckets on custom paths
+        if (!is_nc_coretest) this.skip(); // eslint-disable-line no-invalid-this
+        const new_buckets_path = get_new_buckets_path_by_test_env(tmp_fs_root, s3_new_buckets_dir);
+        const x_nsfs_bucket_path = `${new_buckets_path}${bucket_name}-custom-path`;
+        s3_correct_uid_default_nsr.middlewareStack.add(
+            (next, context) => args => {
+                args.request.headers[config.NSFS_USER_BUCKET_PATH_HTTP_HEADER] = x_nsfs_bucket_path;
+                return next(args);
+            },
+            {
+                step: "finalizeRequest",
+                name: "addCustomHeader",
+            }
+        );
+        const res = await s3_correct_uid_default_nsr.createBucket({ Bucket: bucket_name + '-s3-custom', });
+        console.log(inspect(res));
+        await fs_utils.file_must_exist(x_nsfs_bucket_path);
+        s3_correct_uid_default_nsr.middlewareStack.remove("addCustomHeader");
+    });
+
+    mocha.it('create s3 bucket with x-nsfs-bucket-path fail as directory exists', async function() {
+        // only NC supports creating buckets on custom paths
+        if (!is_nc_coretest) this.skip(); // eslint-disable-line no-invalid-this
+        const new_buckets_path = get_new_buckets_path_by_test_env(tmp_fs_root, s3_new_buckets_dir);
+        const x_nsfs_bucket_path = `${new_buckets_path}${bucket_name}-custom-path`; // already created in previous test
+        // this is the path that was created if x_nsfs_bucket_path header wasn't used
+        const no_x_nsfs_bucket_path = `${new_buckets_path}${bucket_name}-s3-custom-fail`;
+        s3_correct_uid_default_nsr.middlewareStack.add(
+            (next, context) => args => {
+                args.request.headers[config.NSFS_USER_BUCKET_PATH_HTTP_HEADER] = x_nsfs_bucket_path;
+                return next(args);
+            },
+            {
+                step: "finalizeRequest",
+                name: "addCustomHeader",
+            }
+        );
+        try {
+        const res = await s3_correct_uid_default_nsr.createBucket({ Bucket: bucket_name + '-s3-custom-fail', });
+            assert.fail(inspect(res));
+        } catch (err) {
+            assert.strictEqual(err.Code, 'BucketAlreadyExists');
+        }
+        await fs_utils.file_must_not_exist(no_x_nsfs_bucket_path);
+        s3_correct_uid_default_nsr.middlewareStack.remove("addCustomHeader");
+    });
 
     mocha.it('get bucket acl - rpc bucket', async function() {
         const res = await s3_correct_uid_default_nsr.getBucketAcl({ Bucket: first_bucket });