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.

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

feat: add schema for test overrides #2

Merged
merged 4 commits into from
Feb 5, 2024

Conversation

theseion
Copy link
Collaborator

@theseion theseion commented Nov 9, 2023

No description provided.

@theseion theseion force-pushed the add-overrides-schema branch from e789812 to 08b9bab Compare November 9, 2023 15:44
- write and improve tests
- deprecate `log_contains` and `no_log_contains` in favour of new `log`
  struct
- add `expect_id` and `no_expect_id` to simplify standard log output
  matches
@theseion theseion force-pushed the add-overrides-schema branch from 08b9bab to 18e88f1 Compare November 13, 2023 09:19
- deprecate some fields in favor of new ones
- add `retry_once` option
@theseion theseion force-pushed the add-overrides-schema branch from 18e88f1 to 2434b86 Compare November 13, 2023 09:30
@fzipi
Copy link
Member

fzipi commented Nov 20, 2023

@theseion You are committing the generated files. I don't think we want that.

@fzipi fzipi self-requested a review November 20, 2023 23:13
@theseion
Copy link
Collaborator Author

Yeah, wasn't sure about that. I did it mainly because main.go requires the generated code. But the whole thing is a big hack anyway because dstdocgen can't deal with neither more than one schema nor reusing examples. So there's currently a manual step involved after generating the doc files.
I was going to talk to you about all this before completing this PR.

@theseion
Copy link
Collaborator Author

@fzipi I figured out a way to reuse code. I'd appreciate some feedback. The markdown output is still not perfect (references to external code are documented a bit weirdly), but in general it works well.

@fzipi
Copy link
Member

fzipi commented Jan 26, 2024

Awesome fix! Now I need to look at the weird stuff and compare. It took me some time the first iteration to get it in good shape...

@theseion
Copy link
Collaborator Author

theseion commented Feb 3, 2024

Can we merge this PR for now? I can't work on finishing the implementation in go-ftw to support the nginx tests.

Copy link
Member

@fzipi fzipi left a comment

Choose a reason for hiding this comment

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

Yes, let's move forward with this.

@fzipi fzipi merged commit c334dae into coreruleset:main Feb 5, 2024
1 check passed
@theseion theseion deleted the add-overrides-schema branch February 5, 2024 16:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants