PyCQA / PyCQA/bandit

Do performance benchmark testing as part of build

Open
#1,140 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
8.3k
Forks
836
Avg merge
5d 3h
Merged PRs (30d)
1

Description

Is your feature request related to a problem? Please describe.
Bandit could use some more focus on being performant. Currently there really isn't any testing of performance other than user feedback.

Describe the solution you'd like
I'd like to see a job in tox and the CI to run benchmark tests. This can establish a baseline such that we can focus on improving the results.

Describe alternatives you've considered
n/a

Additional context
It's unclear which tool would be best to run benchmarking on Bandit. There is pytest-benchmark but believe it makes use of pytest. Bandit currently uses stestr.

Love this idea? Give it a 👍. We prioritize fulfilling features with the most 👍.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading Bandit's existing tox and CI configuration to understand how jobs and tests are run. Compare the suitability of pytest-benchmark with the current stestr setup. Done means a repeatable benchmark job runs in tox and CI and establishes a baseline for future performance changes.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
ci-cd, devtools, performance, testing-qa
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.