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.

Sign up for GitHub

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

Jump to bottom

Issue #145, Minor issues fixed #146

Merged
merged 4 commits into from
Jul 4, 2017
Merged

Issue #145, Minor issues fixed #146

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4d07f8c
Issue #145, Minor issues fixed
Umadevi-Kapu Jun 29, 2017
dba7b87
Added "type":"object" in schema file of EiffelTestCaseTriggeredEvent
Umadevi-Kapu Jun 30, 2017
339dad9
Added 1.0.0.json for TCF event in schema
Umadevi-Kapu Jul 3, 2017
82ffa2b
Added version history in EiffelTestCaseFinishedEvent.md file
Umadevi-Kapu Jul 3, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 3 additions & 3 deletions eiffel-vocabulary/EiffelTestCaseFinishedEvent.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,12 +60,12 @@ __Description:__ A list of metrics collected during the test case execution. Not

##### data.outcome.metrics.name
__Type:__ String
__Required:__ No
__Required:__ Yes
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, but the problem is we are now changing the definition of the event, so we need to step the version. This is because the .md file is the canonical source of truth: either we think 1.0.0 is correct and the schema is wrong, or it needs to be changed. Clearly, your change is the right one (data.outcome.metrics is optional, but if used its properties shouldn't be).

In other words, what is needed is stepping the version, e.g.:
| 1.0.1 | Current version | data.outcome.metrics.value and data.outcome.metrics.name made mandatory |

Then a 1.0.1 version of the schema needs to be added, and the current 1.0.0 version "fixed" (i.e. the properties made optional).

__Description:__ The metrics name.

##### data.outcome.metrics.value
__Type:__ Any
__Required:__ No
__Required:__ Yes
__Description:__ The metrics value.

### data.persistentLogs
Expand All @@ -86,7 +86,7 @@ __Description:__ The URI at which the log can be retrieved.
## Version History
| Version | Introduced in | Changes |
| --------- | ------------------------------------------------------ | --------------------------------------- |
| 1.0.0 | [edition-bordeaux](../../../tree/edition-bordeaux) | Initial version. |
| 1.0.1 | [edition-bordeaux](../../../tree/edition-bordeaux) | Current version. |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, I didn't spot this one before. This should be a history of all versions, not just the latest. In other words,
| 1.0.1 | Current version | data.outcome.metrics.value and data.outcome.metrics.name made mandatory. |
| 1.0.0 | [edition-bordeaux](../../../tree/edition-bordeaux) | Initial version. |


## Examples
* [Simple example](../examples/events/EiffelTestCaseFinishedEvent/simple.json)
2 changes: 1 addition & 1 deletion eiffel-vocabulary/EiffelTestExecutionRecipeCollectionCreatedEvent.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ How the test selection service generates the recipe collection is, from the poin

The __data__ object consists of two main parts. __data.selectionStrategy__ identifies the strategy used to select the test cases and generate the recipe collection, while __data.batches__ or __data.batchesUri__ contain or reference, respectively, the recipes. The recipes are grouped in batches, which are used to control the order of execution of test cases. Every batch has a priority to let the test executor order them in sequence, but within each batch no assumptions are made as to the execution order the test cases. This way the recipe collection can either allow the executor a high degree of freedom in scheduling the test executions, and/or prescribe the exact sequential order in which they must be executed. Each event SHALL include one and only one of __data.batches__ and __data.batchesUri__.

Finally, each recipe (__data.batches.recipes__) consists of two parts: the test case to execute, and the constraints of that execution. The EiffelTestExecutionRecipeCollectionCreatedEvent does control the syntax of these constraints, 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? Note the distinction between test case and test execution: it is perfectly legal for a single test case to appear multiple times within the same EiffelTestExecutionRecipeCollectionCreatedEvent, but (presumably) with different constraints.
Finally, each recipe (__data.batches.recipes__) consists of two parts: the test case to execute, and the constraints of that execution. The EiffelTestExecutionRecipeCollectionCreatedEvent does not control the syntax of these constraints, 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? Note the distinction between test case and test execution: it is perfectly legal for a single test case to appear multiple times within the same EiffelTestExecutionRecipeCollectionCreatedEvent, but (presumably) with different constraints.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1


## Data Members
### data.selectionStrategy
Expand Down
0 ...events/EiffelTestCaseCanceled/simple.json → ...s/EiffelTestCaseCanceledEvent/simple.json
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion examples/events/EiffelTestCaseFinishedEvent/simple.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"meta": {
"type": "EiffelTestCaseFinishedEvent",
"version": "1.0.0",
"version": "1.0.1",
"time": 1234567890,
"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeee0"
},
Expand Down
9 changes: 8 additions & 1 deletion schemas/EiffelActivityTriggeredEvent/1.0.0.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,14 @@
"type": "object",
"properties": {
"type": {
"type": "string"
"type": "string",
"enum": [
"MANUAL",
"EIFFEL_EVENT",
"SOURCE_CHANGE",
"TIMER",
"OTHER"
]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

},
"description": {
"type": "string"
Expand Down
2 changes: 1 addition & 1 deletion ...as/EiffelTestCaseFinishedEvent/1.0.0.json → ...as/EiffelTestCaseFinishedEvent/1.0.1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
},
"version": {
"type": "string",
"enum": [ "1.0.0" ],
"enum": [ "1.0.0", "1.0.1" ],
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@d-stahl-ericsson Could you please check this changes also

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You don't want to rename 1.0.0.json to 1.0.1.json. Instead, you want to copy it. 1.0.0.json should only check 1.0.0 of the event (i.e. "enum": [ "1.0.0" ]) and 1.0.1.json should only check 1.0.1 of the event (i.e. "enum": [ "1.0.1" ]). The former will not require data.outcome.metrics properties, but the latter will.

"default": "1.0.0"
},
"time": {
Expand Down
9 changes: 8 additions & 1 deletion schemas/EiffelTestCaseTriggeredEvent/1.0.0.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,14 @@
"type": "object",
"properties": {
"type": {
"type": "string"
"type": "string",
"enum": [
"MANUAL",
"EIFFEL_EVENT",
"SOURCE_CHANGE",
"TIMER",
"OTHER"
]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

},
"description": {
"type": "string"
Expand Down
3 changes: 1 addition & 2 deletions schemas/EiffelTestExecutionRecipeCollectionCreatedEvent/1.0.0.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,8 +163,7 @@
},
"required": [
"id",
"testCase",
"constraints"
"testCase"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

],
"additionalProperties": false
}
Expand Down