fs: add benchmark for stat-intensive scenario

Author: XiaochenCui

tools/api-tester/README.md

@@ -45,13 +45,19 @@ All commands below should be run from the root directory of puter.
 
 ### Shorthands
 
-- Run unit tests only:
+- Run all tests (unit tests and benchmarks):
+
+    ```bash
+    node ./tools/api-tester/apitest.js --config=./tools/api-tester/config.yml
+    ```
+
+- Run all unit tests:
 
     ```bash
     node ./tools/api-tester/apitest.js --config=./tools/api-tester/config.yml --unit
     ```
 
-- Run benchmarks only:
+- Run all benchmarks:
 
     ```bash
     node ./tools/api-tester/apitest.js --config=./tools/api-tester/config.yml --bench
@@ -63,6 +69,12 @@ All commands below should be run from the root directory of puter.
     node ./tools/api-tester/apitest.js --config=./tools/api-tester/config.yml --unit --suite=mkdir
     ```
 
+- Filter benchmarks by name:
+
+    ```bash
+    node ./tools/api-tester/apitest.js --config=./tools/api-tester/config.yml --bench --suite=stat_intensive_1
+    ```
+
 - Stop on first failure:
 
     ```bash

tools/api-tester/apitest.js

@@ -100,7 +100,7 @@ const main = async () => {
         for ( const result of benchmark_results ) {
             if ( seen.has(result.name) ) continue;
             seen.add(result.name);
-            console.log(result.name + ' - ' + result.description);
+            console.log(result.name + ': ' + result.description);
         }
     }
 
@@ -146,7 +146,7 @@ async function test({ mountpoint }) {
     if ( unit ) {
         await registry.run_all_tests(suiteName);
     } else if ( bench ) {
-        await registry.run_all_benches();
+        await registry.run_all_benches(suiteName);
     } else {
         await registry.run_all();
     }

tools/api-tester/benches/__entry__.js

@@ -1,3 +1,4 @@
 module.exports = registry => {
-    registry.add_bench('write-intensive-1', require('./write_intensive_1.js'));
+    registry.add_bench('write_intensive_1', require('./write_intensive_1.js'));
+    registry.add_bench('stat_intensive_1', require('./stat_intensive_1.js'));
 };

tools/api-tester/benches/stat_intensive_1.js

@@ -0,0 +1,34 @@
+const chai = require('chai');
+chai.use(require('chai-as-promised'))
+const expect = chai.expect;
+
+module.exports = {
+    name: 'stat intensive 1',
+    description: 'create 10 directories and 100 subdirectories in each, then stat them intensively',
+    do: async t => {
+        console.log('stat intensive 1');
+
+        const dir_count = 10;
+        const subdir_count = 100;
+
+        // key: uuid
+        // value: path
+        const dirs = {};
+
+        for (let i = 0; i < dir_count; i++) {
+            await t.mkdir(`dir_${i}`);
+            for (let j = 0; j < subdir_count; j++) {
+                const subdir = await t.mkdir(`dir_${i}/subdir_${j}`);
+                dirs[subdir.uid] = subdir.path;
+            }
+        }
+
+        for (let i = 0; i < 10; i++) {
+            for (const [uuid, path] of Object.entries(dirs)) {
+                const stat = await t.stat_uuid(uuid);
+                expect(stat.is_dir).equal(true);
+                expect(stat.path).equal(path);
+            }
+        }
+    }
+};

tools/api-tester/lib/TestRegistry.js

@@ -45,9 +45,22 @@ module.exports = class TestRegistry {
     // copilot was able to write everything below this line
     // and I think that's pretty cool
 
-    async run_all_benches () {
+    async run_all_benches (suiteName) {
+        // check if "suiteName" is valid
+        if (suiteName && !Object.keys(this.benches).includes(suiteName)) {
+            throw new Error(`Suite not found: ${suiteName}, valid suites are: ${Object.keys(this.benches).join(', ')}`);
+        }
+
         for ( const [id, bench_definition] of Object.entries(this.benches) ) {
+            if (suiteName && id !== suiteName) {
+                continue;
+            }
+
             console.log(`running bench: ${id}`);
+
+            // reset the working directory
+            await this.t.init_working_directory();
+
             await this.t.runBenchmark(bench_definition);
         }
     }

tools/api-tester/lib/TestSDK.js

@@ -90,6 +90,8 @@ module.exports = class TestSDK {
             this.nameStack.join(` \x1B[36;1m->\x1B[0m `);
         process.stdout.write(strid + ' ... \n');
 
+        this.resetCwd();
+
         this.nameStack.push(benchDefinition.name);
         const start = Date.now();
         try {
@@ -271,6 +273,13 @@ module.exports = class TestSDK {
             const res = await this.post('stat', { ...params, path });
             return res.data;
         }
+        this.stat_uuid = async (uuid, params) => {
+            // for stat(uuid) api:
+            // - use "uid" for "uuid"
+            // - there have to be a "subject" field which is the same as "uid"
+            const res = await this.post('stat', { ...params, uid: uuid, subject: uuid });
+            return res.data;
+        }
         this.statu = async (uid, params) => {
             const res = await this.post('stat', { ...params, uid });
             return res.data;