From 7d7e3a42f4f669b38865ccd347364ddd8044d60f Mon Sep 17 00:00:00 2001 From: Daniel Stahl Date: Wed, 10 Aug 2016 13:45:30 +0200 Subject: [PATCH 1/7] Added example and documentation of EiffelTestSuiteStartedEvent. --- README.md | 2 +- .../EiffelTestSuiteStartedEvent.md | 37 +++++++++++++++++++ .../EiffelTestSuiteStartedEvent/simple.json | 29 +++++++++++++++ 3 files changed, 67 insertions(+), 1 deletion(-) create mode 100644 eiffel-vocabulary/EiffelTestSuiteStartedEvent.md create mode 100644 examples/events/EiffelTestSuiteStartedEvent/simple.json diff --git a/README.md b/README.md index 74871051..84ad53d0 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,7 @@ __IMPORTANT NOTICE:__ The contents of this repository currectly reflect a __DRAF 1. [EiffelFlowContextDefinedEvent](./eiffel-vocabulary/EiffelFlowContextDefinedEvent.md) 1. EiffelTestCaseStartedEvent 1. EiffelTestCaseFinishedEvent - 1. EiffelTestSuiteStartedEvent + 1. [EiffelTestSuiteStartedEvent](./eiffel-vocabulary/EiffelTestSuiteStartedEvent.md) 1. EiffelTestSuiteFinishedEvent 1. EiffelTestExecutionRecipeCollectionCreated 1. EiffelAnnouncementEvent diff --git a/eiffel-vocabulary/EiffelTestSuiteStartedEvent.md b/eiffel-vocabulary/EiffelTestSuiteStartedEvent.md new file mode 100644 index 00000000..f8a5ddc7 --- /dev/null +++ b/eiffel-vocabulary/EiffelTestSuiteStartedEvent.md @@ -0,0 +1,37 @@ +# EiffelTestSuiteStartedEvent +The EiffelTestSuiteStartedEvent declares that a suite of tests has started. This can either be declared stand-alone or as part of an activity or other test suite, using either a __CAUSE__ or a __CONTEXT__ link type, respectively. + +## Data Members +### data.name +__Type:__ String +__Required:__ Yes +__Description:__ The name of the activity. Uniqueness is not required or checked, but is useful. + +### data.category +__Type:__ String +__Required:__ No +__Description:__ The category of the activity. This can be used to group multiple similar activities for analysis and visualization purposes. Example usage is to label the similar but unique build activities of all the components of system X as "System X Component Build" (whereas the name would be e.g. "System X Component Y Build"). + +### data.types +__Type:__ String[] +__Required:__ No +__Legal values:__ ACCESSIBILITY, BACKUP_RECOVERY, COMPATIBILITY, CONVERSION, DISASTER_RECOVERY, FUNCTIONAL, INSTALLABILITY, INTEROPERABILITY, LOCALIZATION, MAINTAINABILITY, PERFORMANCE, PORTABILITY, PROCEDURE, RELIABILITY, SECURITY, STABILITY, USABILITY +__Description:__ The type or types of testing performed by the test suite, as [defined by ISO 29119](http://www.softwaretestingstandard.org). + +### data.liveLogs +__Type:__ Object[] +__Required:__ No +__Description:__ An array of live log files available during execution. These shall not be presumed to be stored persistently; in other words, once the activity has finished there is no guarantee that these links are valid. Persistently stored logs shall be (re-)declared by [EiffelActivityFinishedEvent](./EiffelActivityFinishedEvent.md). + +#### data.liveLogs.name +__Type:__ String +__Required:__ Yes +__Description:__ The name of the log file. + +#### data.liveLogs.uri +__Type:__ String +__Required:__ Yes +__Description:__ The URI at which the log can be retrieved. + +## Examples +* [Simple example](../examples/events/EiffelTestSuiteStartedEvent/simple.json) \ No newline at end of file diff --git a/examples/events/EiffelTestSuiteStartedEvent/simple.json b/examples/events/EiffelTestSuiteStartedEvent/simple.json new file mode 100644 index 00000000..557f25da --- /dev/null +++ b/examples/events/EiffelTestSuiteStartedEvent/simple.json @@ -0,0 +1,29 @@ +{ + "meta": { + "type": "EiffelTestSuiteStartedEvent", + "version": "1.0", + "time": 1234567890, + "domainId": "example.domain", + "id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeee0" + }, + "data": { + "name": "My test suite", + "category": "Pre-release security tests", + "types": [ + "INSTALLABILITY", + "SECURITY" + ] + "liveLogs": [ + { + "name": "My build log", + "uri": "file:///tmp/logs/data.log" + } + ] + }, + "links": [ + { + "type": "CONTEXT", + "target": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeee1" + } + ] +} From 5a481afb8e30e67b5d0ac2aad8148f91123dde99 Mon Sep 17 00:00:00 2001 From: Daniel Stahl Date: Wed, 10 Aug 2016 13:46:25 +0200 Subject: [PATCH 2/7] Added missing line break. --- eiffel-vocabulary/EiffelTestSuiteStartedEvent.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/eiffel-vocabulary/EiffelTestSuiteStartedEvent.md b/eiffel-vocabulary/EiffelTestSuiteStartedEvent.md index f8a5ddc7..b1707799 100644 --- a/eiffel-vocabulary/EiffelTestSuiteStartedEvent.md +++ b/eiffel-vocabulary/EiffelTestSuiteStartedEvent.md @@ -15,7 +15,7 @@ __Description:__ The category of the activity. This can be used to group multipl ### data.types __Type:__ String[] __Required:__ No -__Legal values:__ ACCESSIBILITY, BACKUP_RECOVERY, COMPATIBILITY, CONVERSION, DISASTER_RECOVERY, FUNCTIONAL, INSTALLABILITY, INTEROPERABILITY, LOCALIZATION, MAINTAINABILITY, PERFORMANCE, PORTABILITY, PROCEDURE, RELIABILITY, SECURITY, STABILITY, USABILITY +__Legal values:__ ACCESSIBILITY, BACKUP_RECOVERY, COMPATIBILITY, CONVERSION, DISASTER_RECOVERY, FUNCTIONAL, INSTALLABILITY, INTEROPERABILITY, LOCALIZATION, MAINTAINABILITY, PERFORMANCE, PORTABILITY, PROCEDURE, RELIABILITY, SECURITY, STABILITY, USABILITY __Description:__ The type or types of testing performed by the test suite, as [defined by ISO 29119](http://www.softwaretestingstandard.org). ### data.liveLogs From bc1fa4e16eebde13444dcd5915109e4e365515b2 Mon Sep 17 00:00:00 2001 From: Daniel Stahl Date: Wed, 10 Aug 2016 13:50:43 +0200 Subject: [PATCH 3/7] Fixed copy-paste errors. Changed data.category to data.categories. --- eiffel-vocabulary/EiffelTestSuiteStartedEvent.md | 8 ++++---- examples/events/EiffelTestSuiteStartedEvent/simple.json | 6 ++++-- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/eiffel-vocabulary/EiffelTestSuiteStartedEvent.md b/eiffel-vocabulary/EiffelTestSuiteStartedEvent.md index b1707799..b6257a6e 100644 --- a/eiffel-vocabulary/EiffelTestSuiteStartedEvent.md +++ b/eiffel-vocabulary/EiffelTestSuiteStartedEvent.md @@ -5,12 +5,12 @@ The EiffelTestSuiteStartedEvent declares that a suite of tests has started. This ### data.name __Type:__ String __Required:__ Yes -__Description:__ The name of the activity. Uniqueness is not required or checked, but is useful. +__Description:__ The name of the test suite. Uniqueness is not required or checked, but is useful. -### data.category -__Type:__ String +### data.categories +__Type:__ String[] __Required:__ No -__Description:__ The category of the activity. This can be used to group multiple similar activities for analysis and visualization purposes. Example usage is to label the similar but unique build activities of all the components of system X as "System X Component Build" (whereas the name would be e.g. "System X Component Y Build"). +__Description:__ The category or categories of the test suite. This can be used to group multiple similar test suites for analysis and visualization purposes. Example usage is to categorize test suites required before release as "Pre-release tests". ### data.types __Type:__ String[] diff --git a/examples/events/EiffelTestSuiteStartedEvent/simple.json b/examples/events/EiffelTestSuiteStartedEvent/simple.json index 557f25da..8df1316e 100644 --- a/examples/events/EiffelTestSuiteStartedEvent/simple.json +++ b/examples/events/EiffelTestSuiteStartedEvent/simple.json @@ -7,8 +7,10 @@ "id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeee0" }, "data": { - "name": "My test suite", - "category": "Pre-release security tests", + "name": "Pre-release installation and security verification", + "categories": [ + "Pre-release tests" + ], "types": [ "INSTALLABILITY", "SECURITY" From 963304eec04a7dca4e927df50e16f1b9ac18505d Mon Sep 17 00:00:00 2001 From: Daniel Stahl Date: Wed, 10 Aug 2016 13:53:45 +0200 Subject: [PATCH 4/7] Added missing comma in example. --- examples/events/EiffelTestSuiteStartedEvent/simple.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/events/EiffelTestSuiteStartedEvent/simple.json b/examples/events/EiffelTestSuiteStartedEvent/simple.json index 8df1316e..54bb3775 100644 --- a/examples/events/EiffelTestSuiteStartedEvent/simple.json +++ b/examples/events/EiffelTestSuiteStartedEvent/simple.json @@ -14,7 +14,7 @@ "types": [ "INSTALLABILITY", "SECURITY" - ] + ], "liveLogs": [ { "name": "My build log", From f118737214680c863781e1ec4875e9010aa55f16 Mon Sep 17 00:00:00 2001 From: Daniel Stahl Date: Tue, 23 Aug 2016 09:51:01 +0200 Subject: [PATCH 5/7] Fixed pull request review comments. --- eiffel-vocabulary/EiffelTestSuiteStartedEvent.md | 2 +- examples/events/EiffelTestSuiteStartedEvent/simple.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/eiffel-vocabulary/EiffelTestSuiteStartedEvent.md b/eiffel-vocabulary/EiffelTestSuiteStartedEvent.md index b6257a6e..e3459def 100644 --- a/eiffel-vocabulary/EiffelTestSuiteStartedEvent.md +++ b/eiffel-vocabulary/EiffelTestSuiteStartedEvent.md @@ -21,7 +21,7 @@ __Description:__ The type or types of testing performed by the test suite, as [d ### data.liveLogs __Type:__ Object[] __Required:__ No -__Description:__ An array of live log files available during execution. These shall not be presumed to be stored persistently; in other words, once the activity has finished there is no guarantee that these links are valid. Persistently stored logs shall be (re-)declared by [EiffelActivityFinishedEvent](./EiffelActivityFinishedEvent.md). +__Description:__ An array of live log files available during execution. These shall not be presumed to be stored persistently; in other words, once the test suite has finished there is no guarantee that these links are valid. Persistently stored logs shall be (re-)declared by [EiffelTestSuiteFinishedEvent](./EiffelTestSuiteFinishedEvent.md). #### data.liveLogs.name __Type:__ String diff --git a/examples/events/EiffelTestSuiteStartedEvent/simple.json b/examples/events/EiffelTestSuiteStartedEvent/simple.json index 54bb3775..26bbef54 100644 --- a/examples/events/EiffelTestSuiteStartedEvent/simple.json +++ b/examples/events/EiffelTestSuiteStartedEvent/simple.json @@ -17,7 +17,7 @@ ], "liveLogs": [ { - "name": "My build log", + "name": "My test log", "uri": "file:///tmp/logs/data.log" } ] From 2a110bdb3796223bb7c215bcb4169d729c725d05 Mon Sep 17 00:00:00 2001 From: Daniel Stahl Date: Tue, 23 Aug 2016 12:18:59 +0200 Subject: [PATCH 6/7] Fixed pull request review comments. --- examples/events/EiffelTestSuiteStartedEvent/simple.json | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/examples/events/EiffelTestSuiteStartedEvent/simple.json b/examples/events/EiffelTestSuiteStartedEvent/simple.json index 26bbef54..516f722e 100644 --- a/examples/events/EiffelTestSuiteStartedEvent/simple.json +++ b/examples/events/EiffelTestSuiteStartedEvent/simple.json @@ -3,7 +3,9 @@ "type": "EiffelTestSuiteStartedEvent", "version": "1.0", "time": 1234567890, - "domainId": "example.domain", + "source": { + "domainId": "example.domain" + }, "id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeee0" }, "data": { From 003391aeeeda4b99e03087c37e2db6c24080c880 Mon Sep 17 00:00:00 2001 From: Daniel Stahl Date: Fri, 26 Aug 2016 10:14:26 +0200 Subject: [PATCH 7/7] Clarified the meaning of test suite. --- eiffel-vocabulary/EiffelTestSuiteStartedEvent.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/eiffel-vocabulary/EiffelTestSuiteStartedEvent.md b/eiffel-vocabulary/EiffelTestSuiteStartedEvent.md index e3459def..cc11d17a 100644 --- a/eiffel-vocabulary/EiffelTestSuiteStartedEvent.md +++ b/eiffel-vocabulary/EiffelTestSuiteStartedEvent.md @@ -1,5 +1,7 @@ # EiffelTestSuiteStartedEvent -The EiffelTestSuiteStartedEvent declares that a suite of tests has started. This can either be declared stand-alone or as part of an activity or other test suite, using either a __CAUSE__ or a __CONTEXT__ link type, respectively. +The EiffelTestSuiteStartedEvent declares that the execution of a test suite has started. This can either be declared stand-alone or as part of an activity or other test suite, using either a __CAUSE__ or a __CONTEXT__ link type, respectively. + +In Eiffel, a test suite is nothing more or less than a collection of test case executions (see [EiffelTestCaseStartedEvent](./EiffelTestCaseStartedEvent.md)) and/or other test suite executions. The executed test suite may be an ad-hoc transient grouping of test cases that were executed at a particular time or place or for a particular purpose or a persistent entity tracked in a test management system - Eiffel makes no distinction or assumptions either way. ## Data Members ### data.name