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

Design Guideline violation in EiffelTestExecutionRecipeCollectionCreatedEvent example #149

Closed
egbomol opened this issue Jul 25, 2017 · 1 comment
Labels
protocol All protocol changes protocol-incompat Protocol changes that aren't backwards compatible

Comments

@egbomol
Copy link

egbomol commented Jul 25, 2017

Hi,

The data.batches.recipes.constraints has the following description:

Type: Object
Required: No
Description: Any constraints of the execution. The syntax of this object is not controlled, as the nature of such constraints are highly dependent on technology domain and test execution framework. That being said, there are three questions that typically need to be answered: what is the item under test, in what kind of environment is it to be tested, and what are the test parameters?

In the batches.json we have the following:

"constraints": {
"load": 10000,
"environment": {
"os": "ubuntu-15.04",
"MY_PATH": "/home/lt-worf"
}
}

Which looks to violate the Event design Guidelines ( https://github.com/Ericsson/eiffel/blob/master/eiffel-syntax-and-usage/event-design-guidelines.md ) paragraph:

"Do not use variable key names: For purposes of automated validation, analysis and search, custom key names shall be avoided. Consequently, for custom key-value pairs { "key": "customKeyName", "value": "customValue" } shall be used instead of { "customKeyName": "customValue" } ."

The correct example should be:
"constraints": [
{"key": "load", "value": 10000},
{"key": "environment", "value": {
"os": "ubuntu-15.04",
"MY_PATH": "/home/lt-worf"}
}
]

Br,
Gabor

@d-stahl-ericsson
Copy link
Contributor

Quite right. I suggest we create a version 2.0.0 of the event and change the type of data.batches.recipes.constraints to an array, as dictated by the guidelines.

d-stahl-ericsson added a commit to d-stahl-ericsson/eiffel that referenced this issue Aug 3, 2017
As per issue eiffel-community#149.

In 2.0.0 of the event, the syntax of data.batches.recipes.constraints changed
to comply with protocol design guidelines. It is no longer an uncontrolled
object, but a list of key-value pair, identical to data.customData.
d-stahl-ericsson added a commit to d-stahl-ericsson/eiffel that referenced this issue Nov 9, 2017
As per issue eiffel-community#149.

In 2.0.0 of the event, the syntax of data.batches.recipes.constraints changed
to comply with protocol design guidelines. It is no longer an uncontrolled
object, but a list of key-value pair, identical to data.customData.
d-stahl-ericsson added a commit that referenced this issue Nov 15, 2017
Stepped EiffelTestExecutionRecipeCollectionCreatedEvent to 2.0.0, as per issue #149.

In version 2.0.0 of the event, the syntax of data.batches.recipes.constraints changed to comply with protocol design guidelines. It is no longer an uncontrolled object, but a list of key-value pair, identical to data.customData.

Updated schema for EiffelTestExecutionRecipeCollectionCreatedEvent 2.0.0 and fixed incorrect UUID in EiffelTestExecutionRecipeCollectionCreatedEvent examples.
@magnusbaeck magnusbaeck added protocol All protocol changes protocol-incompat Protocol changes that aren't backwards compatible labels Nov 18, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
protocol All protocol changes protocol-incompat Protocol changes that aren't backwards compatible
Projects
None yet
Development

No branches or pull requests

3 participants