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

Models return useful exceptions #180

Closed
1 of 4 tasks
Tracked by #171
jawache opened this issue Oct 1, 2023 · 4 comments · Fixed by Green-Software-Foundation/if-unofficial-plugins#6
Closed
1 of 4 tasks
Tracked by #171

Models return useful exceptions #180

jawache opened this issue Oct 1, 2023 · 4 comments · Fixed by Green-Software-Foundation/if-unofficial-plugins#6
Assignees

Comments

@jawache
Copy link
Contributor

jawache commented Oct 1, 2023

What: Models return a useful set of exceptions
Why: So the user can figure out what they are doing wrong wiring the IMPL and fix it.
SoW:

  • First go through the spec documentation and the current set of models and propose a set of exceptions.
  • Review the exceptions with the core team and broader IEF project team.
  • Implement the new exceptions in the models.
  • Catch the exceptions in the CLI and log appropriately
@jawache jawache mentioned this issue Oct 1, 2023
22 tasks
@jawache jawache added the model label Oct 1, 2023
@jawache jawache added this to the v.0.1 - Alpha milestone Oct 1, 2023
@jawache jawache moved this to Ready in IF Oct 1, 2023
@jawache
Copy link
Contributor Author

jawache commented Oct 1, 2023

NOTE: @gnanakeethan very important, read the checkboxes above. This task is asking you to first document the exceptions, and then review with the team before you implement them.

@gnanakeethan
Copy link
Contributor

  • Invalid observations
  • Missing Observation Parameter
  • Invalid Observation Parameter - type error / value error
  • Invalid Observatioin Parameter - range error
  • Missing Configuration Parameter
  • Invalid Configuration parameter
  • Incomplete configuration
  • Unsupported Resource Type
  • Unsupported Resolution Mechanism (interpolation -> spline / linear only)
  • External API Error

@jawache
Copy link
Contributor Author

jawache commented Oct 12, 2023

Feedback From Call

  • To help users figure out what's wrongs and where to look in the IMPL file it's related to.
  • Error message can contain the hint.
  • YAML path should point to a part of the YAML where the user can look.

@jawache jawache moved this from Ready to Backlog in IF Oct 17, 2023
@jmcook1186 jmcook1186 moved this from Backlog to In Progress in IF Nov 8, 2023
@jmcook1186 jmcook1186 moved this from In Progress to Ready in IF Nov 14, 2023
@jmcook1186 jmcook1186 moved this from Ready to In Progress in IF Nov 14, 2023
@jmcook1186 jmcook1186 moved this from In Progress to Ready in IF Nov 14, 2023
@jmcook1186 jmcook1186 moved this from Ready to In Progress in IF Nov 16, 2023
@jmcook1186
Copy link
Contributor

jmcook1186 commented Nov 20, 2023

Sprint planning updates 20/11/23

  • Apply to both if and if-unofficial models
  • 0.5 day estimate to each assigned dev
  • expect PR 21/11/23

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

4 participants