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

file domain - confusing errors/behavior when using composition #807

Open
mildwonkey opened this issue Nov 19, 2024 · 0 comments
Open

file domain - confusing errors/behavior when using composition #807

mildwonkey opened this issue Nov 19, 2024 · 0 comments
Labels
enhancement New feature or request triage Awaiting triage from the team

Comments

@mildwonkey
Copy link
Contributor

We ran into some confusing behavior - explained by the lack of compose support for relative file paths - when working through Andy's OSCAL parity PRs. I see opportunities for better error messages (and documentation); I don't think there's a bug here (per se) but we do need to clean up the behavior:

The first issue we saw was user error, and a documentation issue: we had file:/some/path instead of file://some/path in the link to the validation, and that syntax isn't referenced in the file domain page at all.

This is the actual thing that isn't working currently (this is known and documented) - that final relative path is the problem:
component-def.yaml -> links to validation (abs path) -> validation links to a file (relative path)

these aren't instructions, but some thoughts on outcomes from this issue:
-[ ] filepath syntax in file domain doc (relative paths, absolute paths, file://, other supported getters)
-[ ] consider checking for file paths that start with something like file: but not file:// (and only if there is an error return a "this looked weird" message)?
-[ ] can we return a clearer error about the file domain when composition is required and it finds relative file paths? Is there a way lula can abort a given validation if it sees a relative file path? (until we implement compose)
-[ ] or just hurry up and fix compose + file domain, @mildwonkey, geez.

@mildwonkey mildwonkey added the enhancement New feature or request label Nov 19, 2024
@github-actions github-actions bot added the triage Awaiting triage from the team label Nov 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request triage Awaiting triage from the team
Projects
Status: 🆕 New
Development

No branches or pull requests

1 participant