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

CKL metadata should be have input validation and consequently disable functionality or throw errors #5634

Open
6 tasks
Amndeep7 opened this issue Mar 14, 2024 · 0 comments

Comments

@Amndeep7
Copy link
Contributor

Amndeep7 commented Mar 14, 2024

Definition of done:

HDF Converters section:

  • The underlying mapper should validate the checklist metadata that it receives and throw an error if it fails there. If you write the validation function well enough there, you might be able to import it and use it in Heimdall as well.

Heimdall section:
There is no validation for the checklist export modal despite us knowing the types and format of the data that should be in each field. We should do user input validation before allowing the user to export a checklist file that might not be valid and therefore fail when someone attempts to consume it.

  • Each field has validation on it to at minimum require that it is of the correct typescript type (ex. number fields should be numbers)
  • Each field has validation on it to ensure that it matches the expected format of that field, ex. Stigviewer should be able to open each file, and it should also make sense that something looks formatted like that.
  • The export button should not be clickable unless all of the validation passes. This will probably require doing some rearchitecting of the modal to make it possible. Maybe check out Vuetify's form validation: https://v2.vuetifyjs.com/en/components/forms/

image

SAF CLI section:

  • The SAF CLI generates CKL metadata - ensure that what the user provides meets the validation
  • The SAF CLI ckl mapper integration takes in CKL metadata - ensure that the error that will propagate up from the mapper is outputted in a way that will make sense to the end user
This was referenced Mar 14, 2024
@Amndeep7 Amndeep7 changed the title CKL export should be disabled if input validation is failing CKL metadata should be have input validation and consequently disable functionality or throw errors May 15, 2024
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

No branches or pull requests

1 participant