add is_secret option for custom args to be shown in the web UI masked #2284
Conversation
locust/templates/index.html
Outdated
| <label for="{{key}}">{{key}}</label> | ||
| <input type="text" name="{{key}}" id="{{key}}" class="val" value="{{value}}" /><br> | ||
| <input type="{{'password' if value[1] else 'text'}}" name="{{key}}" id="{{key}}" class="val" value="{{value[0]}}" /><br> |
There was a problem hiding this comment.
This is a little too weird/un-obvious. Maybe use a dict instead of a tuple?
There was a problem hiding this comment.
|
Sounds useful. I’m thinking maybe the option should just be |
…d show help text in UI if provided
My thought was "secret" is a lot more general than "password" - e.g. what if the user wanted to have an API Key as a masked input? It's not really a password, but it is a secret - so feels a little more intuitive for use with parser.add_argument() but of course I defer to you. |
|
Also, is it just me or does the CSS for the footer need to be updated to make it sticky (without overlapping with actual content)? |
because i’m used to html is_password made more sense to me :) but it doesnt really matter. |
|
@heyman what do you think? |
Idk :) |
Yes definitely, please refer to latest commit 52fe074 to fix this - also I noticed the "About" popup (from the link in the footer) was getting covered up by the header so adjusted the z-index to prevent that as well |
|
Sounds reasonable! I'd prefer We should also add something about this under the Custom arguments section in the documentation for extending Locust (which I also think we should rename to "Extending Locust" instead of "Event hooks" btw, see my comment at: 9469486#r95553244) |
|
I can merge this now if there is nothing more to add. |
Yep this was already done, please refer to this part of the first commit: e71eb8f#diff-0a5d25e3b717d98c55f177095b87d64583ccfb2e076c91c03e4afcbf155864dd Which the docs file docs/extending-locust.rst references. |
Ah, yes, I forgot that the example file is inlined into the documentation 👍 |
Thought it would be nice, especially for live demo purposes, to be able to quickly indicate when adding custom arguments that are to be exposed in the web UI which should be password masked text inputs, e.g. when you want to use the Web UI to run the load tests under different user logins, so the user password text input field should be a password input.