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

Configuration via YAML #164

Open
mauricioaniche opened this issue May 17, 2023 · 7 comments
Open

Configuration via YAML #164

mauricioaniche opened this issue May 17, 2023 · 7 comments
Labels
enhancement New feature or request Medium priority

Comments

@mauricioaniche
Copy link
Contributor

Configurations are provided to Andy via a Java file that we, as teachers, have to write. The idea of making it into a Java class is that we'd get the support of the compiler to know if something is wrong. In practice, we never write these files in an IDE. It's always in WebLab. And because of that, the verbosity of Java is cumbersome.

We should support configuration via YAML files.

Suggestion:

  • If there's a YAML file provided, we use it instead of the RunConfiguration.
  • We parse the YAML file (feel free to bring a library for that) and put it in a class that extends RunConfiguration
  • If something is missing, throw early exception and stop the execution, so that the teacher gets notified quicky.
  • Everything else should work after that, as Andy just expects an instance of RunConfiguration.
@Idkwhoami42
Copy link
Contributor

Hi! I'd like to try implementing this feature. Can I be assigned to this issue?

@mauricioaniche
Copy link
Contributor Author

Hey, @Idkwhoami42, go for it!

@Idkwhoami42
Copy link
Contributor

Idkwhoami42 commented May 30, 2023

Hi, I had a question regarding type safety of the YAML file. Should I implement proper type safety and checks (with specific errors messages).

@mauricioaniche
Copy link
Contributor Author

Great question, @Idkwhoami42! I don't think we need a full-blown super detailed type checker, but if anything is wrong, we should stop Andy and let the teacher know. Any extra hint to identify the problem in the exception message is welcome!

@mauricioaniche
Copy link
Contributor Author

Hi, @Idkwhoami42, are you still working on this one?

@Idkwhoami42
Copy link
Contributor

Hi, Sorry for the bad communication, I was quite busy with exams and travelling.. but now I can start working on it again. I had implemented most of it before so shouldn't take that long hopefully. Sorry for the delay!

@mauricioaniche
Copy link
Contributor Author

Awesome!!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request Medium priority
Projects
None yet
Development

No branches or pull requests

2 participants