The EiffelActivityFinishedEvent declares that a previously started activity (declared by EiffelActivityTriggeredEvent followed by EiffelActivityStartedEvent) has finished.
Type: Object
Required: Yes
Description: The outcome of the activity.
Type: String
Required: Yes
Legal values: SUCCESSFUL, UNSUCCESSFUL, FAILED, ABORTED, TIMED_OUT, INCONCLUSIVE
Description: A terse standardized conclusion of the activity, designed to be machine readable.
SUCCESSFUL signifies that the activity was concluded and the outcome matched expectations.
UNSUCCESSFUL signifies that the activity was concluded, but the outcome did not match expectations. To exemplify, a compilation job was successfully invoked, but compilation failed.
FAILED signifies that the activity could not be successfully executed. To exemplify, a compilation could not be invoked, e.g. due to misconfiguration or environment issues.
ABORTED signifies that the activity was aborted before it could be concluded.
TIMED_OUT signifies that the activity did not conclude within the allowed time frame.
INCONCLUSIVE signifies that the outcome of the activity could not be determined.
Type: String
Required: No
Description: A verbose description of the activity outcome, designed to provide human readers with further information.
Type: Object[]
Required: No
Description: An array of persistent log files generated during execution.
Type: String
Required: Yes
Description: The name of the log file.
Type: String
Required: Yes
Description: The URI at which the log can be retrieved.
Required: Yes
Legal targets: EiffelActivityTriggeredEvent
Multiple allowed: No
Description: Declares the activity execution that was finished. In other words, EiffelActivityTriggeredEvent acts as a handle for the activity execution. This differs from CONTEXT. In ACTIVITY_EXECUTION the source carries information pertaining to the target (i.e. the activity started, finished or was canceled). In CONTEXT, on the other hand, the source constitutes a subset of the target (e.g. this test case was executed as part of that activity or test suite).
Required: No
Legal targets: Any
Multiple allowed: Yes
Description: Identifies a cause of the event occurring. SHOULD not be used in conjunction with CONTEXT: individual events providing CAUSE within a larger context gives rise to ambiguity. It is instead recommended to let the root event of the context declare CAUSE.
Required: No
Legal targets: EiffelActivityTriggeredEvent,
EiffelTestSuiteStartedEvent
Multiple allowed: No
Description: Identifies the activity or test suite of which this event constitutes a part.
Required: No
Legal targets: EiffelFlowContextDefinedEvent
Multiple allowed: Yes
Description: Identifies the flow context of the event: which is the continuous integration and delivery flow in which this occurred – e.g. which product, project, track or version this is applicable to.
Type: String
Format: UUID
Required: Yes
Description: The unique identity of the event, generated at event creation.
Type: String
Format: An event type name
Required: Yes
Description: The type of event. This field is required by the recipient of the event, as each event type has a specific meaning and a specific set of members in the data and links objects.
Type: String
Format: Semantic Versioning 2.0.0
Required: Yes
Description: The version of the event type. This field is required by the recipient of the event to interpret the contents. Please see Versioning for more information.
Type: Integer
Format: UNIX Epoch time, in milliseconds.
Required: Yes
Description: The event creation timestamp.
Type: String[]
Format: Free text
Required: No
Description: Any tags or keywords associated with the events, for searchability purposes.
Type: Object
Format:
Required: No
Description: A description of the source of the event. This object is primarily for traceability purposes, and while optional, some form of identification of the source is HIGHLY RECOMMENDED. It offers multiple methods of identifying the source of the event, techniques which may be select from based on the technology domain and needs in any particular use case.
Type: String
Format: Free text
Required: No
Description: Identifies the domain that produced an event. A domain is an infrastructure topological concept, which may or may not corresponds to an organization or product structures. A good example would be Java packages notation, ex. com.mycompany.product.component or mycompany.site.division. Also, keep in mind that all names are more or less prone to change. Particularly, it is recommended to avoid organizational names or site names, as organizations tend to be volatile and development is easily relocated. Relatively speaking, product and component names tend to be more stable and are therefore encouraged, while code names may be an option. You need to decide what is the most sensible option in your case.
Type: String
Format: Hostname
Required: No
Description: The hostname of the event sender.
Type: String
Format: Free text
Required: No
Description: The name of the event sender.
Type: String
Format: purl specification
Required: No
Description: The identity of the serializer software used to construct the event, in purl format.
Type: String
Format: URI
Required: No
Description: The URI of, related to or describing the event sender.
Type: Object
Format:
Required: No
Description: An optional object for enclosing security related information, particularly supporting data integrity. See Security for further information.
Type: Object
Format:
Required: No
Description: An optional object for properties supporting the Strong Distribution Model. Note that this only addressed the integrity of the Eiffel event, not its confidentiality or availability.
Type: String
Format:
Required: Yes
Description: The identity of the author of the event. This property is intended to enable the recipient to look up the appropriate public key for decrypting the digest and thereby verifying author identity and data integrity. The format of the author identity varies depending on the key infrastructure solution used. Note that this requires the presence of a Trusted Authority (TA) which the recipient can query for the correct public key. The identity and location of the TA must never be included in the event itself, as this would compromise the security of the solution.
Type: String
Format:
Required: Yes
Description: The encrypted digest. The cryptographic hash function and the decryption algorithm to use, similarly to the Trusted Authority (TA), must be known to the recipient. Note that the digest of the entire event is affected by the value of this property. For this reason the input to the hash function SHALL be the entire event unaltered in all parts except for this property, which SHALL be replaced by an empty string.
| Version | Introduced in | Changes |
|---|---|---|
| 2.0.0 | Current version | Introduced purl identifiers instead of GAVs (see Issue 182) |
| 1.1.0 | edition-toulouse | Multiple links of type FLOW_CONTEXT allowed. |
| 1.0.0 | edition-bordeaux | Initial version. |