diff --git a/examples/testcaserun_cancelled.json b/examples/testcaserun_canceled.json similarity index 87% rename from examples/testcaserun_cancelled.json rename to examples/testcaserun_canceled.json index 3688e7c2..b8ecdec4 100644 --- a/examples/testcaserun_cancelled.json +++ b/examples/testcaserun_canceled.json @@ -3,7 +3,7 @@ "version": "0.4.0-draft", "id": "271069a8-fc18-44f1-b38f-9d70a1695819", "source": "/event/source/123", - "type": "dev.cdevents.testcaserun.cancelled.0.1.0", + "type": "dev.cdevents.testcaserun.canceled.0.1.0-draft", "timestamp": "2023-03-20T14:27:05.315384Z" }, "subject": { @@ -12,7 +12,7 @@ "type": "testCaseRun", "content": { "severity": "low", - "reason": "Cancelled by user 123", + "reason": "Canceled by user 123", "environment": { "id": "dev", "source": "testkube-dev-123" diff --git a/examples/testcaserun_finished.json b/examples/testcaserun_finished.json index 2a8c4355..3e9b3121 100644 --- a/examples/testcaserun_finished.json +++ b/examples/testcaserun_finished.json @@ -3,7 +3,7 @@ "version": "0.4.0-draft", "id": "271069a8-fc18-44f1-b38f-9d70a1695819", "source": "/event/source/123", - "type": "dev.cdevents.testcaserun.finished.0.2.0", + "type": "dev.cdevents.testcaserun.finished.0.2.0-draft", "timestamp": "2023-03-20T14:27:05.315384Z" }, "subject": { diff --git a/examples/testcaserun_skipped.json b/examples/testcaserun_skipped.json index 84f5f027..ea678efb 100644 --- a/examples/testcaserun_skipped.json +++ b/examples/testcaserun_skipped.json @@ -3,7 +3,7 @@ "version": "0.4.0-draft", "id": "271069a8-fc18-44f1-b38f-9d70a1695819", "source": "/event/source/123", - "type": "dev.cdevents.testcaserun.skipped.0.1.0", + "type": "dev.cdevents.testcaserun.skipped.0.1.0-draft", "timestamp": "2023-03-20T14:27:05.315384Z" }, "subject": { diff --git a/examples/testsuiterun_finished.json b/examples/testsuiterun_finished.json index c4383909..bf59001e 100644 --- a/examples/testsuiterun_finished.json +++ b/examples/testsuiterun_finished.json @@ -3,7 +3,7 @@ "version": "0.4.0-draft", "id": "271069a8-fc18-44f1-b38f-9d70a1695819", "source": "/event/source/123", - "type": "dev.cdevents.testsuiterun.finished.0.2.0", + "type": "dev.cdevents.testsuiterun.finished.0.2.0-draft", "timestamp": "2023-03-20T14:27:05.315384Z" }, "subject": { diff --git a/schemas/testcaseruncancelled.json b/schemas/testcaseruncanceled.json similarity index 96% rename from schemas/testcaseruncancelled.json rename to schemas/testcaseruncanceled.json index cab13884..644be535 100644 --- a/schemas/testcaseruncancelled.json +++ b/schemas/testcaseruncanceled.json @@ -1,6 +1,6 @@ { "$schema": "https://json-schema.org/draft/2020-12/schema", - "$id": "https://cdevents.dev/0.4.0-draft/schema/test-case-run-cancelled-event", + "$id": "https://cdevents.dev/0.4.0-draft/schema/test-case-run-canceled-event", "properties": { "context": { "properties": { @@ -19,9 +19,9 @@ "type": { "type": "string", "enum": [ - "dev.cdevents.testcaserun.cancelled.0.1.0" + "dev.cdevents.testcaserun.canceled.0.1.0-draft" ], - "default": "dev.cdevents.testcaserun.cancelled.0.1.0" + "default": "dev.cdevents.testcaserun.canceled.0.1.0-draft" }, "timestamp": { "type": "string", diff --git a/schemas/testcaserunfinished.json b/schemas/testcaserunfinished.json index 0ab0104c..c30dbe50 100644 --- a/schemas/testcaserunfinished.json +++ b/schemas/testcaserunfinished.json @@ -19,9 +19,9 @@ "type": { "type": "string", "enum": [ - "dev.cdevents.testcaserun.finished.0.2.0" + "dev.cdevents.testcaserun.finished.0.2.0-draft" ], - "default": "dev.cdevents.testcaserun.finished.0.2.0" + "default": "dev.cdevents.testcaserun.finished.0.2.0-draft" }, "timestamp": { "type": "string", diff --git a/schemas/testcaserunskipped.json b/schemas/testcaserunskipped.json index 0389b2b2..94ad80dd 100644 --- a/schemas/testcaserunskipped.json +++ b/schemas/testcaserunskipped.json @@ -19,9 +19,9 @@ "type": { "type": "string", "enum": [ - "dev.cdevents.testcaserun.skipped.0.1.0" + "dev.cdevents.testcaserun.skipped.0.1.0-draft" ], - "default": "dev.cdevents.testcaserun.skipped.0.1.0" + "default": "dev.cdevents.testcaserun.skipped.0.1.0-draft" }, "timestamp": { "type": "string", diff --git a/schemas/testsuiterunfinished.json b/schemas/testsuiterunfinished.json index 325e321c..edc0d040 100644 --- a/schemas/testsuiterunfinished.json +++ b/schemas/testsuiterunfinished.json @@ -19,9 +19,9 @@ "type": { "type": "string", "enum": [ - "dev.cdevents.testsuiterun.finished.0.2.0" + "dev.cdevents.testsuiterun.finished.0.2.0-draft" ], - "default": "dev.cdevents.testsuiterun.finished.0.2.0" + "default": "dev.cdevents.testsuiterun.finished.0.2.0-draft" }, "timestamp": { "type": "string", diff --git a/testing-events.md b/testing-events.md index 7fc048b0..e3e01e1b 100644 --- a/testing-events.md +++ b/testing-events.md @@ -21,14 +21,14 @@ This specification defines three subjects in this stage: `testCaseRun`, `testSui The predicates for `testCaseRun` must follow the following expectations: - The following events are valid initial events: `queued`, `started`, or `skipped`. -- The following events must be preceded by some other event: `finished` and `cancelled`. -- A `queued` event must be followed by one of the following: `started`, `finished`, or `cancelled`. +- The following events must be preceded by some other event: `finished` and `canceled`. +- A `queued` event must be followed by one of the following: `started`, `finished`, or `canceled`. - A `started` event must be followed by a `finished` event. -- The following events are terminal events, and will *not* be followed by other events: `finished`, `cancelled` and `skipped`. +- The following events are terminal events, and will *not* be followed by other events: `finished`, `canceled` and `skipped`. | Subject | Description | Predicates | |---------------------------------|----------------------------------------------|------------------------------------------------------------------------------------------------------------| -| [`testCaseRun`](#testcaserun) | The execution of a software testCase | [`queued`](#testcaserun-queued), [`started`](#testcaserun-started), [`finished`](#testcaserun-finished), [`cancelled`](#testcaserun-cancelled), [`skipped`](#testcaserun-skipped) | +| [`testCaseRun`](#testcaserun) | The execution of a software testCase | [`queued`](#testcaserun-queued), [`started`](#testcaserun-started), [`finished`](#testcaserun-finished), [`canceled`](#testcaserun-canceled), [`skipped`](#testcaserun-skipped) | | [`testSuiteRun`](#testsuiterun) | The execution of a software testSuite | [`queued`](#testsuiterun-queued), [`started`](#testsuiterun-started), [`finished`](#testsuiterun-finished) | | [`testOutput`](#testoutput) | An output artifact produced by a testCaseRun | [`published`](#testoutput-published) | @@ -110,7 +110,7 @@ This event represents a started testCase execution. This event represents a finished testCase execution. The event will contain the outcome and additional metadata as applicable. -- Event Type: __`dev.cdevents.testcaserun.finished.0.2.0`__ +- Event Type: __`dev.cdevents.testcaserun.finished.0.2.0-draft`__ - Predicate: finished - Subject: [`testCaseRun`](#testcaserun) @@ -123,14 +123,14 @@ This event represents a finished testCase execution. The event will contain the | testSuiteRun | `Object` [`testSuiteRun`](#testsuiterun) | A testSuiteRun to associate this testCaseRun with a containing testSuiteRun | `{"id":"Auth-TestSuite-execution-12334", "source": "staging/testkube"}` | | | outcome | `String (enum)` | The outcome of the testSuite execution, one of `pass`, `fail`, `cancel`, `error`, `skip` | `pass` | ✅ | | severity | `String (enum)` | Severity if the test failed, one of `low`, `medium`, `high`, `critical` | `critical` | -| reason | `String` | A reason related to the outcome of the execution | `Cancelled by user`, `Failed assertion`, `Timed out` | | +| reason | `String` | A reason related to the outcome of the execution | `Canceled by user`, `Failed assertion`, `Timed out` | | -### [`testCaseRun cancelled`](examples/testcaserun_cancelled.json) +### [`testCaseRun canceled`](examples/testcaserun_canceled.json) -This event represents a cancelled testCaseRun execution. This event should be emitted if a "queued" testCaseRun is stopped prior to the "testCaseRun.started" event. +This event represents a canceled testCaseRun execution. This event should be emitted if a "queued" testCaseRun is stopped prior to the "testCaseRun.started" event. -- Event Type: __`dev.cdevents.testcaserun.cancelled.0.1.0`__ -- Predicate: cancelled +- Event Type: __`dev.cdevents.testcaserun.canceled.0.1.0-draft`__ +- Predicate: canceled - Subject: [`testCaseRun`](#testcaserun) | Field | Type | Description | Examples | Required | @@ -141,13 +141,13 @@ This event represents a cancelled testCaseRun execution. This event should be em | testCase | `Object` [`testCase`](#testcase) | Definition of the testCase being executed | `{"id": "92834723894", "name": "Login Test", "type": "integration"}` | | | testSuiteRun | `Object` [`testSuiteRun`](#testsuiterun) | A testSuiteRun to associate this testCaseRun with a containing testSuiteRun | `{"id":"Auth-TestSuite-execution-12334", "source": "staging/testkube"}` | | | severity | `String` | Severity if the test failed, one of `low`, `medium`, `high`, `critical` | `critical` | -| reason | `String` | A reason related to the outcome of the execution | `Cancelled by user`, `Test run exceeded time limit` | | +| reason | `String` | A reason related to the outcome of the execution | `Canceled by user`, `Test run exceeded time limit` | | ### [`testCaseRun skipped`](examples/testcaserun_skipped.json) This event represents a skipped testCaseRun execution. The event should only be emitted if there has been no prior "queued" or "started" event. -- Event Type: __`dev.cdevents.testcaserun.skipped.0.1.0`__ +- Event Type: __`dev.cdevents.testcaserun.skipped.0.1.0-draft`__ - Predicate: skipped - Subject: [`testCaseRun`](#testcaserun) @@ -197,7 +197,7 @@ This event represents a started testSuite execution. This event represents a finished testSuite execution. The event will contain the outcome and additional metadata as applicable. -- Event Type: __`dev.cdevents.testsuiterun.finished.0.2.0`__ +- Event Type: __`dev.cdevents.testsuiterun.finished.0.2.0-draft`__ - Predicate: finished - Subject: [`testSuiteRun`](#testsuiterun) @@ -208,7 +208,7 @@ This event represents a finished testSuite execution. The event will contain the | environment | `Object` [`environment`](continuous-deployment.md/#environment) | The environment in which this testSuiteRun was running | `{"id": "1234"}`, `{"id": "dev", "source": "testkube-dev-123"}` | ✅ | | outcome | `String (enum)` | The outcome of the testSuite execution, one of `pass`, `fail`, `cancel`, `error`, `skip` | `fail` | ✅ | | severity | `String (enum)` | Severity if the test failed, one of `low`, `medium`, `high`, `critical` | `critical`, `low`, `medium`, `high` | -| reason | `String` | A reason related to the outcome of the execution | `Cancelled by user`, `Failed testCase` | | +| reason | `String` | A reason related to the outcome of the execution | `Canceled by user`, `Failed testCase` | | | testSuite | `Object` [`testSuite`](#testsuite) | Definition of the testSuite being executed | `{"id": "92834723894", "name": "Auth TestSuite"}` | | ### [`testOutput published`](examples/testoutput_published.json)