eiffel-community / eiffel

The Eiffel framework vocabulary, descriptions, guides and schemas along with links to relevant implementation repositories.
Apache License 2.0
121 stars 59 forks source link

Add CONFIDENCE_BASIS link for CLM #368

Closed m-linner-ericsson closed 11 months ago

m-linner-ericsson commented 1 year ago

Applicable Issues

Fixes #323

Description of the Change

Added a CONFIDENCE_BASIS link with inspiration from IVs VERIFICATION_BASIS

Alternate Designs

N/A

Benefits

The user of Eiffel can now express in what CONTEXT they send the CLM event but also what basis they used for compiling the confidence.

Possible Drawbacks

None that I can think of

Sign-off

Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or

(b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or

(c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.

(d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.

Signed-off-by: Mattias Linnér mattias.linner@ericsson.com

m-linner-ericsson commented 1 year ago

Diff of YAML and JSON

(venv) emalinn@E-5CG1504MQG:~/github/forks/eiffel$ diff -u definitions/EiffelConfidenceLevelModifiedEvent/3.3.0.yml definitions/EiffelConfidenceLevelModifiedEvent/3.4.0.yml
--- definitions/EiffelConfidenceLevelModifiedEvent/3.3.0.yml    2023-07-20 11:19:01.198861585 +0200
+++ definitions/EiffelConfidenceLevelModifiedEvent/3.4.0.yml    2023-07-20 17:15:49.318468297 +0200
@@ -139,7 +139,20 @@
       any_type: false
       types:
         - EiffelConfidenceLevelModifiedEvent
+  CONFIDENCE_BASIS:
+    description: 'Used to declare the basis for which confidence statement(s) this event have used.
+      The __CAUSE__ link tells what caused the event sending whereas __CONFIDENCE_BASIS__ declares the reason for
+      selecting the provided `data.name` and/or `data.value` '
+    required: false
+    multiple: true
+    targets:
+      any_type: false
+      types:
+        - EiffelTestCaseTriggeredEvent
+        - EiffelTestSuiteStartedEvent
 _history:
+  - version: 3.4.0
+    changes: Add CONFIDENCE_BASIS link (see [Issue 323](https://github.com/eiffel-community/eiffel/issues/323)).
   - version: 3.3.0
     introduced_in: edition-orizaba
     changes: Add EiffelArtifactDeployedEvent as legal target type for
(venv) emalinn@E-5CG1504MQG:~/github/forks/eiffel$ diff -u schemas/EiffelConfidenceLevelModifiedEvent/3.3.0.json schemas/EiffelConfidenceLevelModifiedEvent/3.4.0.json
--- schemas/EiffelConfidenceLevelModifiedEvent/3.3.0.json       2023-07-20 17:16:28.688467573 +0200
+++ schemas/EiffelConfidenceLevelModifiedEvent/3.4.0.json       2023-07-20 17:16:28.748467572 +0200
@@ -18,9 +18,9 @@
         "version": {
           "type": "string",
           "enum": [
-            "3.3.0"
+            "3.4.0"
           ],
-          "default": "3.3.0"
+          "default": "3.4.0"
         },
         "time": {
           "type": "integer"
m-linner-ericsson commented 1 year ago

Setting to draft per https://github.com/eiffel-community/eiffel/issues/323#issuecomment-1397118056

e-backmark-ericsson commented 1 year ago

Outcome from community meeting on Aug 31: