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

Syntax in YML-File #27

Open
rruisong opened this issue Aug 26, 2020 · 1 comment
Open

Syntax in YML-File #27

rruisong opened this issue Aug 26, 2020 · 1 comment
Labels
bug Problems in the build system, build scripts, etc or faults in the interface. feature request Proposals which enhance the interface or add additional features.

Comments

@rruisong
Copy link

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

  • OS: Windows 10
  • Language: Python
  • Version 3.7

Additional context

@rruisong rruisong added the bug Problems in the build system, build scripts, etc or faults in the interface. label Aug 26, 2020
@rruisong rruisong changed the title YML-File Syntax in YML-File Aug 26, 2020
@vkresch
Copy link
Contributor

vkresch commented Aug 27, 2020

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.

@vkresch vkresch added the feature request Proposals which enhance the interface or add additional features. label Aug 27, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Problems in the build system, build scripts, etc or faults in the interface. feature request Proposals which enhance the interface or add additional features.
Projects
None yet
Development

No branches or pull requests

2 participants