Draft: Regression test example #123
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 3 commits
June 4, 2024 15:21
Factor out functions that do walk-tree and that answer questions about the model (e.g. is_optional()? for a particular field). Those functions are reusable for several tasks and should not be tied to document generation only. The implementations of helper functions are now also cleaner, and using consistent naming of parameters. The ifex_ast_doc.py was modified accordingly to make use of the new module ifex_model_walk for walk-function and other helpers. Other than that, very little change to the actual documentation generation logic. Signed-off-by: Gunnar Andersson <gunnar_dev@[email protected]>
This simplifies the implementation of TemplateDir so that it can easily get the node names to match them against template names. (the walk function was clearly overkill for this task). Signed-off-by: Gunnar Andersson <gunnar_dev@[email protected]>
This runs through most outputs we can find (various generators and documentation generation) and reports any differences compared to previous versions. This is useful for spotting regressions and being confident about refactorings. At this time, comparison of the result must be done manually - the workflow does not determine "failure" on a regression (but that is of course done by the normal unit tests, etc.). NOTE: This removes other workflows from regression test branch because they are superfluous in the current usage (they will be run when a PR is sent, etc.) Later, if the regression test is introduced in the PR flow, some conditions could be set up to make this better. Signed-off-by: Gunnar Andersson <gunnar_dev@[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
(WIP) Regression test CI workflow, to check for problems when doing bigger refactoring etc.