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

WP3 Validation of process metadata: test_process_metadata_functional() should ignore non-functional metadata in parameter schema #54

Open
Jay-Gohil opened this issue Aug 7, 2024 · 4 comments

Comments

@Jay-Gohil
Copy link

Jay-Gohil commented Aug 7, 2024

test_process_metadata_functions() from src/openeo_test_suite/tests/processes/metadata/test_process_metadata.py, check values within functional and non-functional parameters. For example, this function also tests for description, which is present in the schema parameter. Like"id": "array_append", "parameters": [ { "description": "Value to append to the array.", "name": "value", "schema": { "description": "Any data type is allowed." } }

This should not happen if -m "not optional" is added to the command.

@soxofaan
Copy link
Member

non-functional parameters are skipped with -m "not optional". The longrunning marker has nothing to do with process metadata.

See the docs in readme about "WP3 Validation of process metadata":

Non-functional tests concern descriptions and other metadata of processes that have no impact on the actual behavior of the process, failures in these tests should be taken as warnings, but don't necessarily need to be fixed. These can be skipped by adding -m "not optional" to the pytest command.

@Jay-Gohil
Copy link
Author

There's was a mistake in last sentence. I have made the edit.

@soxofaan soxofaan reopened this Aug 19, 2024
@soxofaan soxofaan changed the title WP3 Validation of process metadata: test_process_metadata_functions() should not test non-functional parameters within the schema parameter when -m "not longrunning" is added WP3 Validation of process metadata: test_process_metadata_functional() should ignore non-functional parameters within the schema parameter Aug 19, 2024
@soxofaan soxofaan changed the title WP3 Validation of process metadata: test_process_metadata_functional() should ignore non-functional parameters within the schema parameter WP3 Validation of process metadata: test_process_metadata_functional() should ignore non-functional metadata in parameter schema Aug 19, 2024
@soxofaan
Copy link
Member

ok, I understand now, you are talking about non-functional fields in the schema of process parameters. The parameter's schema is indeed being compared as a whole currently:

# Tests if the type of parameters is equivalent
assert expected_parameter["schema"] == actual_parameter["schema"]

Do you have some concrete examples of differing parameter schema's?

@m-mohr
Copy link
Member

m-mohr commented Dec 9, 2024

A couple of examples where even schemas are meant to be updated by implementations:

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

3 participants