Stepped EiffelTestExecutionRecipeCollectionCreatedEvent to 2.0.0

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 · Nov 9, 2017 · b328196 · b328196
1 parent 03a3340
commit b328196
Show file tree

Hide file tree

Showing 5 changed files with 368 additions and 16 deletions.
diff --git a/eiffel-vocabulary/EiffelTestExecutionRecipeCollectionCreatedEvent.md b/eiffel-vocabulary/EiffelTestExecutionRecipeCollectionCreatedEvent.md
@@ -98,9 +98,19 @@ __Required:__ No
 __Description:__ A location where a description of the test case can be retrieved.
 
 ##### data.batches.recipes.constraints
-__Type:__ Object  
+__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?
+__Description:__ Any constraints of the execution. The nature of such constraints is highly dependent on technology domain and test execution framework. Consequently, there are no pre-defined or required constraints. Instead, this property is a list of key-value pairs on the same format as [data.customData](../customization/custom-data.md). 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?
+
+###### data.batches.recipes.constraints.key
+__Type:__ String  
+__Required:__ Yes  
+__Description:__ The key name of constraint.
+
+###### data.batches.recipes.constraints.value
+__Type:__ Any  
+__Required:__ Yes  
+__Description:__ The value of the constraint.
 
 #### data.batches.dependencies
 __Type:__ Object[]  
@@ -120,8 +130,10 @@ __Description:__ The UUID of the dependent execution (__data.batches.recipes.id_
 ## Version History
 | Version   | Introduced in                                          | Changes                                 |
 | --------- | ------------------------------------------------------ | --------------------------------------- |
+| 2.0.0     | Current version.                                       | Changed syntax of data.batches.recipes.constraints from an uncontrolled object to a list of key-value pairs to comply with design guidelines. |
 | 1.0.0     | [edition-bordeaux](../../../tree/edition-bordeaux)     | Initial version.                        |
 
 ## Examples
 * [Example using data.batches](../examples/events/EiffelTestExecutionRecipeCollectionCreatedEvent/batches.json)
+* [Example using data.batches (1.0.0 syntax)](../examples/events/EiffelTestExecutionRecipeCollectionCreatedEvent/batches-1.0.0.json)
 * [Example using data.batchesUri](../examples/events/EiffelTestExecutionRecipeCollectionCreatedEvent/batchesUri.json)
diff --git a/examples/events/EiffelTestExecutionRecipeCollectionCreatedEvent/batches-1.0.0.json b/examples/events/EiffelTestExecutionRecipeCollectionCreatedEvent/batches-1.0.0.json
@@ -0,0 +1,65 @@
+{
+  "meta": {
+    "type": "EiffelTestExecutionRecipeCollectionCreatedEvent",
+    "version": "1.0.0",
+    "time": 1234567890,
+    "id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeee0"
+  },
+  "data": {
+    "selectionStrategy": {
+      "tracker": "My Test Selector",
+      "id": "TCSS-1234/5",
+      "uri": "http://tm.company.com/browse/TCSS-1234?version=5"
+    },
+    "batches": [
+      {
+        "name": "First batch",
+        "priority": 1,
+        "recipes": [
+          {
+            "id": "aaaaaaaa-bbbb-5ccc-addd-eeeeeeeeeee0",
+            "testCase": {
+              "tracker": "My Test Management System",
+              "id": "TC-1234",
+              "uri": "http://tm.company.com/browse/TC-1234"
+            },
+            "constraints": {
+              "load": 10000,
+              "environment": {
+                "os": "ubuntu-15.04",
+                "MY_PATH": "/home/lt-worf"
+              }
+            }
+          },
+          {
+            "id": "aaaaaaaa-bbbb-5ccc-addd-eeeeeeeeeee1",
+            "testCase": {
+              "tracker": "My Test Management System",
+              "id": "TC-1234",
+              "uri": "http://tm.company.com/browse/TC-1234"
+            },
+            "constraints": {
+              "load": 500,
+              "environment": {
+                "os": "ubuntu-16.04.1",
+                "MY_PATH": "/home/cpt-picard"
+              }
+            }
+          }      
+        ],
+        "dependencies": [
+          {
+            "dependent": "aaaaaaaa-bbbb-5ccc-addd-eeeeeeeeeee0",
+            "dependency": "aaaaaaaa-bbbb-5ccc-addd-eeeeeeeeeee1"
+          }
+        ]
+      }
+    ]
+  },
+  "links": [
+    {
+      "type": "CONTEXT",
+      "target": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeee1"
+    }
+  ]
+}
diff --git a/examples/events/EiffelTestExecutionRecipeCollectionCreatedEvent/batches.json b/examples/events/EiffelTestExecutionRecipeCollectionCreatedEvent/batches.json
@@ -1,7 +1,7 @@
 {
   "meta": {
     "type": "EiffelTestExecutionRecipeCollectionCreatedEvent",
-    "version": "1.0.0",
+    "version": "2.0.0",
     "time": 1234567890,
     "id": "aaaaaaaa-bbbb-5ccc-8ddd-eeeeeeeeeee0"
   },
@@ -23,13 +23,19 @@
               "id": "TC-1234",
               "uri": "http://tm.company.com/browse/TC-1234"
             },
-            "constraints": {
-              "load": 10000,
-              "environment": {
-                "os": "ubuntu-15.04",
-                "MY_PATH": "/home/lt-worf"
+            "constraints": [
+              {
+                "key": "load",
+                "value": 10000
+              },
+              {
+                "key": "environment",
+                "value": {
+                  "os": "ubuntu-15.04",
+                  "MY_PATH": "/home/lt-worf"
+                }
               }
-            }
+            ]
           },
           {
             "id": "aaaaaaaa-bbbb-5ccc-addd-eeeeeeeeeee1",
@@ -38,13 +44,19 @@
               "id": "TC-1234",
               "uri": "http://tm.company.com/browse/TC-1234"
             },
-            "constraints": {
-              "load": 500,
-              "environment": {
-                "os": "ubuntu-16.04.1",
-                "MY_PATH": "/home/cpt-picard"
+            "constraints": [
+              {
+                "key": "load",
+                "value": 500
+              },
+              {
+                "key": "environment",
+                "value": {
+                  "os": "ubuntu-16.04.1",
+                  "MY_PATH": "/home/cpt-picard"
+                }
               }
-            }
+            ]
           }      
         ],
         "dependencies": [

diff --git a/examples/events/EiffelTestExecutionRecipeCollectionCreatedEvent/batchesUri.json b/examples/events/EiffelTestExecutionRecipeCollectionCreatedEvent/batchesUri.json
@@ -1,7 +1,7 @@
 {
   "meta": {
     "type": "EiffelTestExecutionRecipeCollectionCreatedEvent",
-    "version": "1.0.0",
+    "version": "2.0.0",
     "time": 1234567890,
     "source": {
       "domainId": "example.domain"