EXERCISE-SUT-REPORT(1)

💖 EXERCISE-SUT 💖

okay so bestie, this is exercise-sut — the whole tool — and right now we're zooming in on exactly one of its subcommands: report. it's giving "let me turn your pile of raw test data into something pretty" and honestly? iconic. 🌸

✨ COMMAND exercise-sut report ✨

the vibe check, first:

usage: exercise-sut report [-h] [-q] [-d] [--diffs DIFFS] [--include
       INCLUDE] [--exclude EXCLUDE] [--jobs JOBS] [--toolpath TOOLPATH]
       [--toolopts TOOLOPTS] [--outdir OUTDIR] [--stop-on-failure] [--dry-run]
       [--list-monikers] [respaths ...]

Generate reports from collected data. that's it, that's the whole job. take the data you already gathered, make reports out of it. slay. 💅

• respaths — one or multiple paths to be searched for test results. give it one, give it many, she'll go looking. 🦋

🎀 OPTIONS exercise-sut report 🎀

• -h — show this help message and exit. the classic. the safe word. 😌
• -q — be quiet. shhh. no chatter. 🤫
• -d — print debugging information. when you need to know everything that's happening, no cap. 🐛
• --diffs DIFFS — okay so this one is a little extra, so let me set the scene: collected data is stored in directories, and each directory name is constructed from multiple monikers separated by dashes, like 'hrt-c6-uf_max-autoc1e_off'. this option lets you create diff reports by including multiple results in one report. it takes a comma-separated list of monikers to select the results you want to include in the diff report. you can use this option multiple times, fr fr. and if you don't provide it at all? you just get reports with a single result. lowkey simple. ✨
• --include INCLUDE — comma-separated list of monikers that must be found from the result path name. if it's not there, it's not invited to the party. 💖
• --exclude EXCLUDE — comma-separated list of monikers that must not be found from the result path name. not you. goodbye. 🚫
• --jobs JOBS, -j JOBS — number of threads to use for generating reports with. multitasking queen behavior. 👑
• --toolpath TOOLPATH — by default, the name of the report tool is resolved from the results. this option overrides the tool. main character energy: you pick who shows up. 🛠️
• --toolopts TOOLOPTS — additional options to use for running the tool. and here's the cute part: the string "{REPORTID}" inside TOOLOPTS gets replaced with the report ID. literally a little placeholder that gets swapped in. 🎁
• --outdir OUTDIR, -o OUTDIR — path to the directory where the results get stored. default is <toolname-date-time>. 📁
• --stop-on-failure — stop if any of the steps fail, instead of continuing. and yes bestie, that's the default — so this is already what she does unless you tell her otherwise. 🙈
• --dry-run — do not run any commands, only print them. it's the "manifesting" option. look at all the things you would do. ✨
• --list-monikers — a moniker is an abbreviation for a setting. exercise-sut uses monikers to create directory names and report IDs for collected results. use this option to list the monikers associated with each setting, if any, and exit. so it's the cheat sheet, the legend, the iykyk glossary. 🌈

quick reminder bestie: those commas in --diffs, --include and --exclude are doing the heavy lifting — comma-separated lists, okay? don't come at me with spaces. 💀

that's the whole page, bestie — every flag, every default, every literal string, all of it, untouched and unbothered. 💜

EXERCISE-SUT 🩷 page date 2024-03-08 — mwah, go generate some gorgeous reports. 💖✨