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

feature: Base CSV Checking and RVM Addition #8

Merged
merged 22 commits into from
Jan 22, 2025

Conversation

sfrinaldi
Copy link
Collaborator

@sfrinaldi sfrinaldi commented Sep 13, 2024

Tested on develop branch to verify the added attribute ties done in this branch for the RVM don't break on ones that do not have this information / csv headers yet. Appears to work still without breaking.

Feature includes doorstop base check during the doorstop import command for csv files. Workflow will still continue but a warning_log.txt file will generate (as well as console warning messages during the run) with just the duplicate UID errors it found when parsing through each csv file.

Also skips over / ignores comment lines now for the invalid UID warnings that would generate before.

Adding RVM attributes for being able to pull those values easier from doorstop (in the correct manner) for implementing with the modified rtv_doorstop fork. Removed testing files so repo doesn't need to be removed after cloning (or to be implemented as a submodule or something else). (Testing files of requirements cause there to be multiple 'roots' detected as there is a built tree already)

Example warning_log.txt:

image

More features will be added to this whether in a separate repo (requirements-tools) or using available tools (like csv-lint). Pros for merging this initial feature earlier is current requirements being developed / reviewed in Gitlab will be able to get this warning_log.txt (locally / gitlab workflow will need to be adjusted for adding this file as an artifact) and duplicate uid messages in the workflow logs.

@sfrinaldi sfrinaldi self-assigned this Sep 13, 2024
@sfrinaldi sfrinaldi added the enhancement New feature or request label Sep 13, 2024
@sfrinaldi
Copy link
Collaborator Author

@patrickingraham Let me know if you think this is worth pulling to main in its initial state so that the current branches (especially when compiling locally) can see this information for when requirements are being adjusted. Otherwise I can just wait on this PR / continue to work on it.

@douglase
Copy link
Collaborator

@sfrinaldi have you tested against https://github.com/douglase/doorstop_requirements_template/ or do we need to update that too?

@sfrinaldi
Copy link
Collaborator Author

sfrinaldi commented Nov 1, 2024

Will double check! Might need to be updated.

@sfrinaldi
Copy link
Collaborator Author

sfrinaldi commented Nov 1, 2024

@douglase Alright, so I checked it out and for that repo it looks like its what is used in requirements_tools but also a lot of the functionality for the newer doorstop (as it can publish to latex / markdown / excel actually now and not just html) doesn't require pandocs. I see there is a UASAL fork uasal/doorstop_requirements_template for that repo you linked (douglase/doorstop-requirements-template) which looks like it is out of date in comparison.

The graphviz is still being generated and added (in pretty much the same fashion but we have it stop at a certain level (4) as then it becomes a bit unreadable). Did we want to have it integrated / use travisci? Let me know if there was something else you were referring too that I didn't cover.

sfrinaldi added a commit that referenced this pull request Jan 6, 2025
Changed not False to is True.
Testing out having RVM built into doorstop / seeing how it would be for automation. Not completed yet / first commits. This is non-functional at the moment.
Commenting out RVM
Adjusting new RTM values.
Will allow repo to be in pearl_requirements / shorten time (could be a submodule).
Trying to just have logging write to a file for ones that are warnings.
Edits to latex.py to allow for latex template to not have include_graphics without erroring out.
For latex.py, fixing wrapper statement and check for if 'include_graphics' key is present in template_data.
Having doctitle be able to be set in the template for latex publishing.
Will check template_data for if the traceability
Prevents the need of doorstop needing to be re-cloned and remove for each run.
Spelling correction.
Adding the option to the default template for including the traceability_matrix to the published latex documentation.
Changed not False to is True.
@sfrinaldi sfrinaldi force-pushed the u/sfrinaldi/verification-matrix-testing branch from a6b922d to eac485a Compare January 7, 2025 17:02
@sfrinaldi sfrinaldi linked an issue Jan 9, 2025 that may be closed by this pull request
This reverts commit eac485a.
* Edits to RVM items in item.py

Correcting comments in loading/setting methods as well.

* Add default sep value to document.py

* Change reorder to false in tree.py

* Revert "Add default sep value to document.py"

This reverts commit 1cb26f1.

* Revert "Change reorder to false in tree.py"

This reverts commit f251b93.

* Add template_data[rvm] to latex.py

* Add rvm to doorstop.yml template

* Add rvm to wrapper in latex.py

* Add booktabs package to latex template

* Add \landscape for RVM section to latex.py

* Add lscape package to latex templates

* Add rotating/adjustbox packages to latex templates

* Edit wrapper for RVM in latex.py

* Testing sidewaystable in latex.py wrapper

* Test to markdown for latex

* Edit RVM wrapper in latex.py

* Update latex templates

* Edits to packages in latex templates

* Remove test markdown setup in doorstop.cls

* Fix to rvm wrapper in latex.py

* Add \sloppy to doorstop.yml

* Package update to doorstop.cls

* Fix to rvm wrapper in latex.py
@sfrinaldi sfrinaldi changed the title Pulling Base CSV Checking Feature feature: Base CSV Checking and RVM Addition Jan 21, 2025
@sfrinaldi
Copy link
Collaborator Author

Renamed to better reflect what this PR is now.

@sfrinaldi
Copy link
Collaborator Author

sfrinaldi commented Jan 22, 2025

Doing a quick check / test on pearl_requirements with the updated branches for doorstop-ewan and the related rtm_doorstop branch after a PR has gone through. (Last check for any issues before final merging for this PR).

Update: Passes checks / outputs same.

@sfrinaldi sfrinaldi merged commit 884b709 into main Jan 22, 2025
@sfrinaldi sfrinaldi deleted the u/sfrinaldi/verification-matrix-testing branch January 22, 2025 19:18
@sfrinaldi sfrinaldi linked an issue Jan 23, 2025 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

fix: Latex Warnings in Publishing edit: RVM header / generating output
3 participants