|
| 1 | +/* Copyright (C) 2024 NooBaa */ |
| 2 | +'use strict'; |
| 3 | + |
| 4 | +const path = require('path'); |
| 5 | +const mocha = require('mocha'); |
| 6 | +const assert = require('assert'); |
| 7 | +const fs_utils = require('../../util/fs_utils'); |
| 8 | +const { TYPES, ACTIONS } = require('../../manage_nsfs/manage_nsfs_constants'); |
| 9 | +const { TMP_PATH, set_path_permissions_and_owner, invalid_nsfs_root_permissions, generate_s3_client, get_coretest_path, |
| 10 | + validate_expiration_header, update_file_mtime, exec_manage_cli } = require('../system_tests/test_utils'); |
| 11 | + |
| 12 | +const coretest_path = get_coretest_path(); |
| 13 | +const coretest = require(coretest_path); |
| 14 | +const { rpc_client, EMAIL, get_admin_mock_account_details } = coretest; |
| 15 | +coretest.setup({}); |
| 16 | + |
| 17 | +let s3_admin; |
| 18 | + |
| 19 | +const tmp_fs_root = path.join(TMP_PATH, 'test_nc_bucket_lifecycle/'); |
| 20 | + |
| 21 | +/** |
| 22 | + * is_nc_coretest returns true when the test runs on NC env |
| 23 | + */ |
| 24 | +const is_nc_coretest = process.env.NC_CORETEST === 'true'; |
| 25 | + |
| 26 | +mocha.describe('nc lifecycle - check expiration header', async function() { |
| 27 | + const bucket_path = path.join(tmp_fs_root, 'test-bucket/'); |
| 28 | + const bucket_name = 'test-bucket'; |
| 29 | + |
| 30 | + mocha.before(async function() { |
| 31 | + this.timeout(0); // eslint-disable-line no-invalid-this |
| 32 | + if (invalid_nsfs_root_permissions()) this.skip(); // eslint-disable-line no-invalid-this |
| 33 | + // create paths |
| 34 | + await fs_utils.create_fresh_path(tmp_fs_root, 0o777); |
| 35 | + await fs_utils.create_fresh_path(bucket_path, 0o770); |
| 36 | + await fs_utils.file_must_exist(bucket_path); |
| 37 | + |
| 38 | + // set permissions |
| 39 | + if (is_nc_coretest) { |
| 40 | + const { uid, gid } = get_admin_mock_account_details(); |
| 41 | + await set_path_permissions_and_owner(bucket_path, { uid, gid }, 0o700); |
| 42 | + } |
| 43 | + |
| 44 | + // create s3_admin client |
| 45 | + const admin = (await rpc_client.account.read_account({ email: EMAIL, })); |
| 46 | + const admin_keys = admin.access_keys; |
| 47 | + s3_admin = generate_s3_client(admin_keys[0].access_key.unwrap(), |
| 48 | + admin_keys[0].secret_key.unwrap(), |
| 49 | + coretest.get_http_address()); |
| 50 | + |
| 51 | + // create test bucket |
| 52 | + const cli_bucket_options = { |
| 53 | + name: bucket_name, |
| 54 | + owner: admin.name, |
| 55 | + path: bucket_path, |
| 56 | + }; |
| 57 | + await exec_manage_cli(TYPES.BUCKET, ACTIONS.ADD, cli_bucket_options); |
| 58 | + }); |
| 59 | + |
| 60 | + mocha.after(async function() { |
| 61 | + this.timeout(0); // eslint-disable-line no-invalid-this |
| 62 | + fs_utils.folder_delete(tmp_fs_root); |
| 63 | + }); |
| 64 | + |
| 65 | + const run_expiration_test = async ({ rules, expected_id, expected_days, key, tagging = undefined, size = 1000}) => { |
| 66 | + const putLifecycleParams = { |
| 67 | + Bucket: bucket_name, |
| 68 | + LifecycleConfiguration: { Rules: rules } |
| 69 | + }; |
| 70 | + await s3_admin.putBucketLifecycleConfiguration(putLifecycleParams); |
| 71 | + |
| 72 | + const putObjectParams = { |
| 73 | + Bucket: bucket_name, |
| 74 | + Key: key, |
| 75 | + Body: 'x'.repeat(size) // default 1KB if size not specified |
| 76 | + }; |
| 77 | + if (tagging) { |
| 78 | + putObjectParams.Tagging = tagging; |
| 79 | + } |
| 80 | + const start_time = new Date(); |
| 81 | + let res = await s3_admin.putObject(putObjectParams); |
| 82 | + assert.ok(res.Expiration, 'expiration header missing in putObject response'); |
| 83 | + |
| 84 | + // update file mtime to simulate a 5-days old object |
| 85 | + await update_file_mtime(path.join(bucket_path, key)); |
| 86 | + |
| 87 | + res = await s3_admin.headObject({ Bucket: bucket_name, Key: key }); |
| 88 | + assert.ok(res.Expiration, 'expiration header missing in headObject response'); |
| 89 | + |
| 90 | + const valid = validate_expiration_header(res.Expiration, start_time, expected_id, expected_days - 5); |
| 91 | + assert.ok(valid, `expected rule ${expected_id} to match`); |
| 92 | + }; |
| 93 | + |
| 94 | + function generate_rule(expiration_days, id, prefix, tags, size_gt, size_lt) { |
| 95 | + const filters = {}; |
| 96 | + if (prefix) filters.Prefix = prefix; |
| 97 | + if (Array.isArray(tags) && tags.length) filters.Tags = tags; |
| 98 | + if (size_gt !== undefined) filters.ObjectSizeGreaterThan = size_gt; |
| 99 | + if (size_lt !== undefined) filters.ObjectSizeLessThan = size_lt; |
| 100 | + |
| 101 | + const filter = Object.keys(filters).length > 1 ? { And: filters } : filters; |
| 102 | + |
| 103 | + return { |
| 104 | + ID: id, |
| 105 | + Status: 'Enabled', |
| 106 | + Filter: filter, |
| 107 | + Expiration: { Days: expiration_days }, |
| 108 | + }; |
| 109 | + } |
| 110 | + |
| 111 | + mocha.it('should select rule with longest prefix', async () => { |
| 112 | + const rules = [ |
| 113 | + generate_rule(10, 'short-prefix', 'lifecycle-test1/', [], undefined, undefined), |
| 114 | + generate_rule(17, 'long-prefix', 'lifecycle-test1/logs/', [], undefined, undefined), |
| 115 | + ]; |
| 116 | + await run_expiration_test({ |
| 117 | + rules, |
| 118 | + key: 'lifecycle-test1/logs//file.txt', |
| 119 | + expected_id: 'long-prefix', |
| 120 | + expected_days: 17 |
| 121 | + }); |
| 122 | + }); |
| 123 | + |
| 124 | + mocha.it('should select rule with more tags when prefix is same', async () => { |
| 125 | + const rules = [ |
| 126 | + generate_rule(5, 'one-tag', 'lifecycle-test2/', [{ Key: 'env', Value: 'prod' }], undefined, undefined), |
| 127 | + generate_rule(9, 'two-tags', 'lifecycle-test2/', [ |
| 128 | + { Key: 'env', Value: 'prod' }, |
| 129 | + { Key: 'team', Value: 'backend' } |
| 130 | + ], undefined, undefined), |
| 131 | + ]; |
| 132 | + await run_expiration_test({ |
| 133 | + rules, |
| 134 | + key: 'lifecycle-test2/file2.txt', |
| 135 | + tagging: 'env=prod&team=backend', |
| 136 | + expected_id: 'two-tags', |
| 137 | + expected_days: 9 |
| 138 | + }); |
| 139 | + }); |
| 140 | + |
| 141 | + mocha.it('should select rule with narrower size span when prefix and tags are matching', async () => { |
| 142 | + const rules = [ |
| 143 | + generate_rule(4, 'wide-range', 'lifecycle-test3/', [], 100, 10000), |
| 144 | + generate_rule(6, 'narrow-range', 'lifecycle-test3/', [], 1000, 5000), |
| 145 | + ]; |
| 146 | + await run_expiration_test({ |
| 147 | + rules, |
| 148 | + key: 'lifecycle-test3/file3.txt', |
| 149 | + size: 1500, |
| 150 | + expected_id: 'narrow-range', |
| 151 | + expected_days: 6 |
| 152 | + }); |
| 153 | + }); |
| 154 | + |
| 155 | + mocha.it('should fallback to first matching rule if all filters are equal', async () => { |
| 156 | + const rules = [ |
| 157 | + generate_rule(7, 'rule-a', 'lifecycle/test4/', [], 0, 10000), |
| 158 | + generate_rule(11, 'rule-b', 'lifecycle/test4/', [], 0, 10000), |
| 159 | + ]; |
| 160 | + await run_expiration_test({ |
| 161 | + rules, |
| 162 | + key: 'lifecycle/test4/file4.txt', |
| 163 | + expected_id: 'rule-a', |
| 164 | + expected_days: 7 |
| 165 | + }); |
| 166 | + }); |
| 167 | +}); |
0 commit comments