Merge pull request #13 from cryspen/wysiwys/more-flexible-input

Update accepted format

Author: wysiwys

.github/workflows/build-and-test.yml

@@ -21,22 +21,22 @@ jobs:
           tool: 'cargo'
           os: 'ubuntu-latest'
           output-file-path: ./test/data/extract/cargo_output.txt
-          data-out-path: output.txt
+          data-out-path: output.json
       - uses: ./ # local action in repo
         with:
           tool: 'cargo'
           os: 'ubuntu-latest'
           output-file-path: ./test/data/extract/cargo_output2.txt
-          data-out-path: output.txt
+          data-out-path: output.json
       - uses: ./ # local action in repo
         with:
           tool: 'cargo'
           os: 'ubuntu-latest'
           output-file-path: ./test/data/extract/cargo_output3.txt
-          data-out-path: output.txt
+          data-out-path: output.json
       - uses: ./ # local action in repo
         with:
           tool: 'cargo'
           os: 'ubuntu-latest'
           output-file-path: ./test/data/extract/criterion_output.txt
-          data-out-path: output.txt
+          data-out-path: output.json

.github/workflows/minimal.yml

@@ -18,4 +18,4 @@ jobs:
           tool: 'cargo'
           os: 'ubuntu-latest'
           output-file-path: ./test/data/extract/cargo_output.txt
-          data-out-path: output.txt
+          data-out-path: output.json

README.md

@@ -15,7 +15,9 @@ Currently supported sources:
 
 ## Metadata format
 
-The benchmark name in the `cargo` benchmarks can be provided as a `/`-separated string with the format `category/key size/name/platform/api`. The key size should be an integer. Some fields in this string can be left blank. Any unspecified or invalid fields will be parsed to `undefined`.
+The benchmark name in the `cargo` benchmarks can be provided as a `,`-separated string where each item represents a key-value pair with the format `key=value`, e.g. `category=ML-KEM,keySize=44,name=PK Validation,platform=neon,api=unpacked`.
+
+Alternatively, the benchmark name can be provided as a simple string, which will then be set as the value of the `name` key. This will only happen if there are no `key=value` pairs found in the benchmark name.
 
 ## Output data format
 

src/extract.ts

@@ -9,88 +9,61 @@ export interface BenchmarkResult {
     extra?: string;
     os: string;
 
-    // from NameMetadata
-    category: string | undefined;
-    keySize: number | undefined;
-    name: string;
-    platform: string | undefined;
-    api: string | undefined;
+    // from metadata
+    [key: string]: any;
 }
 
-interface NameMetadata {
-    category: string | undefined;
-    keySize: number | undefined;
-    name: string;
-    platform: string | undefined;
-    api: string | undefined;
-}
-function extractMetadataFromName(name_string: string): NameMetadata {
+function addNameMetadataToResult(result: BenchmarkResult, nameString: string) {
     // split by separator
-    const values = name_string.split('/');
-
-    // if only one arg provided, just return name
-    if (values.length === 1) {
-        const name = name_string;
-        return { name, keySize: undefined, category: undefined, platform: undefined, api: undefined };
-    }
+    const keyValuePairs = nameString.split(',');
 
-    // extract by position
-    const category = values[0] === '' ? undefined : values[0];
+    let foundAtLeastOne = false;
 
-    // If keySize not a number, use `undefined`
-    const keySizeParsed = parseInt(values[1]);
-
-    const keySize = isNaN(keySizeParsed) ? undefined : keySizeParsed;
+    for (const pair of keyValuePairs) {
+        const items = pair.split('=');
+        if (items.length !== 2) {
+            // invalid key-value pair
+            continue;
+        }
+        const [key, value] = items;
+        result[key] = value;
 
-    // if name is not defined, keep entire name_string as name
-    let name = values[2];
-    if (name === undefined || name === '') {
-        name = name_string;
+        // at least one key-value pair was found
+        foundAtLeastOne = true;
     }
 
-    const platform = values[3] === '' ? undefined : values[3];
-    const api = values[4] === '' ? undefined : values[4];
-
-    return {
-        category,
-        keySize,
-        name,
-        platform,
-        api,
-    };
+    if (!foundAtLeastOne) {
+        // no key-value pairs found in string
+        // return the entire string as the name
+        result.name = nameString;
+    }
 }
 
 function extractCargoResult(config: Config, output: string): BenchmarkResult[] {
     const lines = output.split(/\r?\n/g);
     const ret = [];
-    const reExtract = /^test (.+)\s+\.\.\. bench:\s+([0-9,.]+) (\w+\/\w+) \(\+\/- ([0-9,.]+)\)$/;
+
+    const reExtract = /^test (.+)\s+\.\.\. bench:\s+([0-9,.]+) ([0-9A-Za-z_\u03BC]+\/\w+)( \(\+\/- [0-9,.]+\))?$/;
     const reComma = /,/g;
 
     for (const line of lines) {
         const m = line.match(reExtract);
         if (m === null) {
             continue;
         }
-
-        const name_string = m[1].trim();
         const value = parseFloat(m[2].replace(reComma, ''));
         const unit = m[3].trim();
-        const range = m[4].replace(reComma, '');
-
-        // TODO: error handling
-        const { category, keySize, name, platform, api } = extractMetadataFromName(name_string);
-
-        ret.push({
-            value,
-            range: `± ${range}`,
-            unit: unit,
-            os: config.os,
-            category,
-            keySize,
-            name,
-            platform,
-            api,
-        });
+
+        // if the range is provided, replace the prefix, the suffix, and any commas.
+        const range = m[4] ? m[4].replace(reComma, '').replace(' (+/- ', '± ').replace(')', '') : undefined;
+
+        const name_string = m[1].trim();
+
+        const result = { value, range, unit, os: config.os };
+
+        addNameMetadataToResult(result, name_string);
+
+        ret.push(result);
     }
 
     return ret;