|
| 1 | +<!--- |
| 2 | + Copyright 2017 Ericsson AB. |
| 3 | + For a full list of individual contributors, please see the commit history. |
| 4 | +
|
| 5 | + Licensed under the Apache License, Version 2.0 (the "License"); |
| 6 | + you may not use this file except in compliance with the License. |
| 7 | + You may obtain a copy of the License at |
| 8 | +
|
| 9 | + http://www.apache.org/licenses/LICENSE-2.0 |
| 10 | +
|
| 11 | + Unless required by applicable law or agreed to in writing, software |
| 12 | + distributed under the License is distributed on an "AS IS" BASIS, |
| 13 | + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 14 | + See the License for the specific language governing permissions and |
| 15 | + limitations under the License. |
| 16 | +---> |
| 17 | + |
| 18 | +# EiffelTestCaseTriggeredEvent (TCT) |
| 19 | +The EiffelTestCaseTriggeredEvent declares that the execution of a test case has been triggered, but not yet started. This can either be declared stand-alone or as part of an activity or test suite, using either a __CAUSE__ or a __CONTEXT__ link type, respectively. |
| 20 | + |
| 21 | +This event is used to communicate intent, and thereby serves a similar purpose to that of [EiffelActivityTriggeredEvent](./EiffelActivityTriggeredEvent.md). A triggered test case execution is expected to either be started (represented by [EiffelTestCaseStartedEvent](./EiffelTestCaseStartedEvent.md)) or canceled (represented by [EiffelTestCaseCanceledEvent](./EiffelTestCaseCanceledEvent.md)). Consequently, any delay between triggering and execution can be assumed to imply queuing time (e.g. waiting for available test resources) and monitored as such. |
| 22 | + |
| 23 | +## Data Members |
| 24 | +### data.testCase |
| 25 | +__Type:__ Object |
| 26 | +__Required:__ Yes |
| 27 | +__Description:__ Identification of the test case to be executed. |
| 28 | + |
| 29 | +#### data.testCase.tracker |
| 30 | +__Type:__ String |
| 31 | +__Required:__ No |
| 32 | +__Description:__ The name of the test case tracker - typically a test management system. |
| 33 | + |
| 34 | +#### data.testCase.id |
| 35 | +__Type:__ String |
| 36 | +__Required:__ Yes |
| 37 | +__Description:__ The unique identity of the test case to be executed. |
| 38 | + |
| 39 | +#### data.testCase.version |
| 40 | +__Type:__ String |
| 41 | +__Required:__ No |
| 42 | +__Description:__ The unique version of the identified test case to be executed. Where this property is not used it is assumed that test cases are not version controlled. |
| 43 | + |
| 44 | +#### data.testCase.uri |
| 45 | +__Type:__ String |
| 46 | +__Required:__ No |
| 47 | +__Description:__ A location where a description of the test case can be retrieved. To the extent that multiple versions of the same test case co-exist, this property SHALL identify the exact version to be executed. |
| 48 | + |
| 49 | +### data.recipeId |
| 50 | +__Type:__ String |
| 51 | +__Required:__ No |
| 52 | +__Description:__ If triggering this test case execution was the result of an Execution Recipe, as defined by an [EiffelTestExecutionRecipeCollectionCreatedEvent](./EiffelTestExecutionRecipeCollectionCreatedEvent.md), this UUID SHALL match the relevant __data.batches.recipes.id__ in that event. |
| 53 | + |
| 54 | +### data.triggers |
| 55 | +__Type:__ Object[] |
| 56 | +__Required:__ No |
| 57 | +__Description:__ The circumstances triggering the test case execution. |
| 58 | + |
| 59 | +#### data.triggers.type |
| 60 | +__Type:__ String |
| 61 | +__Required:__ Yes |
| 62 | +__Legal values:__ MANUAL, EIFFEL_EVENT, SOURCE_CHANGE, TIMER, OTHER |
| 63 | +__Description:__ The type of trigger. |
| 64 | +MANUAL signifies that the test case execution was manually triggered. |
| 65 | +EIFFEL_EVENT signifies that the test case execution was triggered by one or more Eiffel events. These events should be represented via __CAUSE__ links. |
| 66 | +SOURCE_CHANGE signifies that the test case execution was triggered as a consequence of a detected source change __not__ represented by Eiffel events. |
| 67 | +TIMER signifies that the test case execution was triggered by a timer. |
| 68 | +OTHER signifies any other triggering cause. |
| 69 | + |
| 70 | +#### data.triggers.description |
| 71 | +__Type:__ String |
| 72 | +__Required:__ No |
| 73 | +__Description:__ A description of the trigger. |
| 74 | + |
| 75 | +### data.executionType |
| 76 | +__Type:__ String |
| 77 | +__Required:__ No |
| 78 | +__Legal values:__ MANUAL, SEMI_AUTOMATED, AUTOMATED, OTHER |
| 79 | +__Description:__ The type of execution (often related to, but ultimately separate from, __data.triggers.type__). |
| 80 | + |
| 81 | +### data.parameters |
| 82 | +__Type:__ Object[] |
| 83 | +__Required:__ No |
| 84 | +__Description:__ A list of parameters to be passed to the test case execution. |
| 85 | + |
| 86 | +#### data.parameters.name |
| 87 | +__Type:__ String |
| 88 | +__Required:__ Yes |
| 89 | +__Description:__ The name of the parameter. |
| 90 | + |
| 91 | +#### data.parameters.value |
| 92 | +__Type:__ String |
| 93 | +__Required:__ Yes |
| 94 | +__Description:__ The value of the parameter. |
| 95 | + |
| 96 | +## Version History |
| 97 | +| Version | Introducing Commit | |
| 98 | +| --------- | ------------------ | |
| 99 | +| 1.0.0 | _Current version_ | |
| 100 | + |
| 101 | +## Examples |
| 102 | +* [Simple example](../examples/events/EiffelTestCaseTriggeredEvent/simple.json) |
0 commit comments