spec icon indicating copy to clipboard operation
spec copied to clipboard

The protocol is not consistent on events that notify executions

Open e-backmark-ericsson opened this issue 2 years ago • 1 comments

This issue was raised as a result of a discussion during the CDEvents WG on Jan 30th, 2023

These event subjects all represent executions of some kind, as they can all be started and finished:

The protocol is not consistent regarding those subjects or their predicates though:

  • All of them have the predicates started and finished, but just some of them have the predicate queued
  • The names of the subjects sometimes contain the suffix "Run" and sometimes not. It makes somewhat sense to not add "Run" to a "build" subject, since a build can be interpreted as a verb, but the testCase and testSuite subjects should probably include the "Run" suffix to be consistent with taskRun and pipelineRun. A clear naming convention for events that represent executions should be written as well, to not end up in such inconsistencies ahead.

Furthermore, none of the subjects above have a predicate that would signal that the subject has left the queue. A subject that has been queued would eventually get started, but there seems to be a need to also be able to signal that the subject has been dequeued and thus is not anymore expected to be started. The predicate to use here should proposedly be either dequeued or canceled.

Note: Some of this issue is already considered in #105

e-backmark-ericsson avatar Jan 30 '23 13:01 e-backmark-ericsson

Some of this was fixed in https://github.com/cdevents/spec/pull/126

We should try to fix the rest of it for 0.4

e-backmark-ericsson avatar Jun 05 '23 15:06 e-backmark-ericsson

After discussion (meeting 2025-08-19):

  • use the suffix Run, testCase & testSuite are already renamed testCaseRun and testSuiteRun in 0.4 (see https://github.com/cdevents/spec/blob/spec-v0.4/testing-events.md)
  • build will be removed for 0.5, it's a duplicate of pipelineRun or taskRun (for migration, it is recommended to convert build into a taskRun and to provide complementary information via links or via customData (to be defined).

I'll do the PR to remove build asap before the release of 0.5 (after merge of pending PR that modify build to avoid conflict)

davidB avatar Aug 26 '25 12:08 davidB

@xibz , @afrittoli ,

This issue could be closed (I can't); another issue #263 was started to discuss the removal of the build.

davidB avatar Aug 27 '25 09:08 davidB