OpenSimulationInterface / osi-validation

Tools around the OSI used to verify the content of messages and more.
Other
10 stars 8 forks source link

Syntax in YML-File #27

Open rruisong opened 4 years ago

rruisong commented 4 years ago

Describe the bug

A clear and concise description of what the bug is. If we specify the highest field in yml-file without any attributes, this highest filed will not be found by the OSI-Validator. It seems that we need to have at least one attribute (no matter which one it is) in yml-file.

Describe how to reproduce the bug

Steps to reproduce the behavior:

  1. Go to folder 'requirements-osi-3'
  2. Open the yml file 'osi_version.yml'
  3. Delete all text under 'InterfaceVersion:'
  4. Save the yml file 'osi_version.yml'
  5. Run 'osivalidator -r -requirements-osi-3 .\data\small_test.osi'
  6. See error in screenshot.
  7. Open the yml file 'osi_version.yml'
  8. Add one attribute (like ' version_major:')
  9. Save the yml file 'osi_version.yml'
  10. Run 'osivalidator -r -requirements-osi-3 .\data\small_test.osi'
  11. See it works again

Describe the expected behavior

Since the OSI-Validator produces always an explicit output on what is not set and just outputs only the highest field, I think I only need to define the highest field in yml file (like InterfaceVersion in osi_version.yml), if I am not interested in this field.

Show some screenshots

image

Describe the OS you are using

Additional context

vkresch commented 4 years ago

Yes that's true. From the user perspective it would be more intuitive to check all the fields if they are set without defining a full skeleton in the yml files. This should be a feature to implement in the next validator release. As for now I would stick to defining the full skeleton.