Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

refactor: split cli methods to easy testing #3

Open
wants to merge 20 commits into
base: main
Choose a base branch
from
Open

refactor: split cli methods to easy testing #3

wants to merge 20 commits into from
+1,000 −693

Conversation

fzipi
Copy link
Member

@fzipi fzipi commented Jan 21, 2025 •
edited
Loading

what

  • refactor main to simpler methods
  • apply black formatting
  • include github actions specific library
  • apply grouping in output

why

  • easy testing and readability
  • use additional gha features

@fzipi
refactor: split cli methods to easy testing
59a2b18 
Signed-off-by: Felipe Zipitria <felipe.zipitria@owasp.org>
@fzipi fzipi requested a review from airween January 21, 2025 12:44
theseion
theseion requested changes Jan 22, 2025
View reviewed changes
src/crs_linter/cli.py Outdated Show resolved Hide resolved
src/crs_linter/cli.py Outdated Show resolved Hide resolved
src/crs_linter/cli.py Outdated Show resolved Hide resolved
src/crs_linter/cli.py Outdated Show resolved Hide resolved
src/crs_linter/cli.py Outdated Show resolved Hide resolved
src/crs_linter/cli.py Outdated Show resolved Hide resolved
src/crs_linter/cli.py Outdated Show resolved Hide resolved
src/crs_linter/linter.py Outdated Show resolved Hide resolved
fzipi and others added 8 commits January 22, 2025 09:40
@fzipi @theseion
Apply suggestions from code review
ef41e02 
Co-authored-by: Max Leske <250711+theseion@users.noreply.github.com>
@fzipi
fix: main cli invocation and test
577c887 
Signed-off-by: Felipe Zipitria <felipe.zipitria@owasp.org>
@fzipi
fix: add mocker module
7a237bc 
Signed-off-by: Felipe Zipitria <felipe.zipitria@owasp.org>
@fzipi
fix: add directory flag to test
dcbd4c0 
Signed-off-by: Felipe Zipitria <felipe.zipitria@owasp.org>
@fzipi
fix(ci): run only once
cd0c6d8 
Signed-off-by: Felipe Zipitria <felipe.zipitria@owasp.org>
@fzipi
fix: args parsing
3da6a0c 
Signed-off-by: Felipe Zipitria <felipe.zipitria@owasp.org>
@fzipi
fix: test mocks
87f2aec 
Signed-off-by: Felipe Zipitria <felipe.zipitria@owasp.org>
@fzipi
fix: gha test
13863c3 
Signed-off-by: Felipe Zipitria <felipe.zipitria@owasp.org>
@fzipi fzipi force-pushed the refactor/split-cli-methods branch from 8b1991a to 4477d11 Compare February 3, 2025 16:41
@fzipi
fix: logger
646208c 
Signed-off-by: Felipe Zipitria <felipe.zipitria@owasp.org>
@fzipi fzipi force-pushed the refactor/split-cli-methods branch from 4477d11 to 646208c Compare February 8, 2025 21:52
fzipi added 3 commits February 9, 2025 10:56
@fzipi
fix: sort files
ceeb1c2 
Signed-off-by: Felipe Zipitria <felipe.zipitria@owasp.org>
@fzipi
fix: apply black formatting
0d8363b 
Signed-off-by: Felipe Zipitria <felipe.zipitria@owasp.org>
@fzipi
fix: add debug to gha
3b4b403 
Signed-off-by: Felipe Zipitria <felipe.zipitria@owasp.org>
@fzipi fzipi force-pushed the refactor/split-cli-methods branch from 4db6a91 to 3b4b403 Compare February 9, 2025 14:33
fzipi added 2 commits February 9, 2025 11:42
@fzipi
fix: ids does not carry errors
c6a2c1a 
Signed-off-by: Felipe Zipitria <felipe.zipitria@owasp.org>
@fzipi
fix: do not enable cache for uv.lock
ac6cc5a 
Signed-off-by: Felipe Zipitria <felipe.zipitria@owasp.org>
@fzipi fzipi requested a review from theseion February 9, 2025 14:44
theseion
theseion requested changes Feb 9, 2025
View reviewed changes
.github/workflows/test.yml Outdated Show resolved Hide resolved
src/crs_linter/cli.py Outdated Show resolved Hide resolved
src/crs_linter/cli.py Outdated Show resolved Hide resolved
src/crs_linter/cli.py Outdated Show resolved Hide resolved
src/crs_linter/cli.py Outdated Show resolved Hide resolved
src/crs_linter/linter.py Outdated Show resolved Hide resolved
src/crs_linter/linter.py Outdated Show resolved Hide resolved
src/crs_linter/linter.py Outdated Show resolved Hide resolved
src/crs_linter/linter.py Outdated Show resolved Hide resolved
src/crs_linter/linter.py Outdated Show resolved Hide resolved
fzipi and others added 4 commits February 9, 2025 16:25
@fzipi @theseion
Apply suggestions from code review
afab750 
Co-authored-by: Max Leske <250711+theseion@users.noreply.github.com>
@fzipi
fix: remove script name cleanup
f5ef257 
Signed-off-by: Felipe Zipitria <felipe.zipitria@owasp.org>
@fzipi @theseion
Apply suggestions from code review
c3adefd 
Co-authored-by: Max Leske <250711+theseion@users.noreply.github.com>
@fzipi @theseion
Apply suggestions from code review
04ecb6b 
Co-authored-by: Max Leske <250711+theseion@users.noreply.github.com>
@fzipi
Copy link
Member Author

fzipi commented Feb 9, 2025

Ugh, the code review changes broke it. I'll try to fix.

airween
airween reviewed Feb 10, 2025
View reviewed changes
Copy link

@airween airween left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After a first review I found only one thing (see above), but I'd like to run few tests (after we cleared my review).

src/crs_linter/linter.py

if "operator_argument" in d:
oparg = re.findall(r"%\{(tx.[^%]*)\}", d['operator_argument'], re.I)
oparg = re.findall(r"%\{(tx.[^%]*)}", d["operator_argument"], re.I)
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here you removed the \ from the front of the close bracket. Is that accidentally or on purpose?

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Regardless, the expression are equivalent. In python even the opening brace does not need to be escaped, unless it's umbiguous (e.g., looks like a range expression).

@fzipi fzipi force-pushed the refactor/split-cli-methods branch 2 times, most recently from 2a8ba08 to 0500fea Compare February 10, 2025 21:09
@fzipi fzipi force-pushed the refactor/split-cli-methods branch from 0500fea to 025f053 Compare February 10, 2025 21:17
@fzipi
fix: make code more pythonic
3f10697 
Signed-off-by: Felipe Zipitria <felipe.zipitria@owasp.org>
@fzipi fzipi force-pushed the refactor/split-cli-methods branch from 025f053 to 3f10697 Compare February 10, 2025 21:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@airween airween airween left review comments

@theseion theseion theseion requested changes

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@fzipi @airween @theseion