sharkdp/hyperfine

${HYPERFINE_ITERATION} is not visible in prepare or conclude commands

Open

#781 opened on Dec 3, 2024

View on GitHub
 (4 comments) (0 reactions) (0 assignees)Rust (28,110 stars) (479 forks)batch import
feature-requestgood first issue

Description

I thought I could use the ${HYPERFINE_ITERATION} env variable that is exposed (mentioned as a solution in https://github.com/sharkdp/hyperfine/issues/778) ; however this is only accessible in the main command of the iteration, not the prepare or conclude steps for each iteration.

So for example if I want to prepare , test and cleanup a series of files, I would do something like this (with echo for illustrative purposes) :

 ~/hyperfine --runs 5 --prepare 'echo touch file${HYPERFINE_ITERATION}.dat' \
                  'echo testing file${HYPERFINE_ITERATION}.dat' \
                  --conclude 'echo rm file${HYPERFINE_ITERATION}.dat' --show-output

However this does not work because the env var is not exposed in all the steps:

Benchmark 1: echo testing file${HYPERFINE_ITERATION}.dat
touch file.dat
testing file0.dat
rm file.dat
touch file.dat
testing file1.dat
rm file.dat
touch file.dat
testing file2.dat
rm file.dat
touch file.dat
testing file3.dat
rm file.dat
touch file.dat
testing file4.dat
rm file.dat
  Time (mean ± σ):      90.7 µs ± 202.8 µs    [User: 116.6 µs, System: 252.7 µs]
  Range (min … max):     0.0 µs … 453.5 µs    5 runs

so it's not possible to prepare and clean up each file.

Contributor guide

Tech stack
rust
Domain
cli
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Rust basicsFamiliarity with hyperfine's codebaseUnderstanding of environment variables
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
To add HYPERFINE ITERATION to prepare and conclude commands, locate where the environment variables are set for the main command (likely in src/benchmark.rs). The prepare and conclude commands are likely spawned in the same loop. Ensure the iteration number is exported to those subprocesses. Check linked issue #778 for existing discussion on the env var. After making changes, test with the provided example.
${HYPERFINE_ITERATION} is not visible in prepare or conclude commands · sharkdp/hyperfine#781 | Good First Issue