Schema/clarify retry history

CHANGELOG.md

@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
+- Clarified `retryAttempts` as the ordered history preceding the final attempt, aligned `retries` counting semantics, and updated the schema and examples accordingly ([#62](https://github.com/ctrf-io/ctrf/pull/62)).
 - Added an optional identity model for CTRF documents, logical runs, test cases, executions, attempts, attachments, and shards ([#57](https://github.com/ctrf-io/ctrf/pull/57)).
 - Clarified namespace guidance for `extra` extension keys and examples ([#56](https://github.com/ctrf-io/ctrf/pull/56)).
 - Clarified immutability guidance for emitted CTRF report artifacts ([#55](https://github.com/ctrf-io/ctrf/pull/55)).

examples/comprehensive.json

@@ -79,8 +79,8 @@
         "name": "user can checkout",
         "status": "passed",
         "duration": 5200,
-        "start": 1609459203500,
-        "stop": 1609459208700,
+        "start": 1609459208700,
+        "stop": 1609459213900,
         "suite": ["Checkout"],
         "type": "e2e",
         "tags": ["smoke"],
@@ -113,14 +113,6 @@
                 "path": "/artifacts/retry-1.png"
               }
             ]
-          },
-          {
-            "attempt": 2,
-            "attemptId": "48c3f90b-95a9-4c13-a42f-0888bb0b1002",
-            "status": "passed",
-            "duration": 5200,
-            "start": 1609459208700,
-            "stop": 1609459213900
           }
         ],
         "insights": {

examples/with-retries.json

@@ -26,7 +26,7 @@
       {
         "name": "flaky test",
         "status": "passed",
-        "duration": 300,
+        "duration": 140,
         "flaky": true,
         "retries": 2,
         "retryAttempts": [
@@ -41,11 +41,6 @@
             "status": "failed",
             "duration": 130,
             "message": "Connection timeout"
-          },
-          {
-            "attempt": 3,
-            "status": "passed",
-            "duration": 140
           }
         ]
       }

schema/ctrf.schema.json

@@ -256,24 +256,26 @@
                 "type": "string"
               },
               "retries": {
-                "description": "Number of retry attempts performed",
-                "type": "integer"
+                "description": "Number of times the test was re-executed after its initial attempt",
+                "type": "integer",
+                "minimum": 0
               },
               "retryAttempts": {
-                "description": "List of retry attempts for this test",
+                "description": "Ordered history of attempts completed before the final attempt represented by the test object",
                 "type": "array",
+                "minItems": 1,
                 "items": {
-                  "description": "Single retry attempt result",
+                  "description": "Attempt completed before the final attempt",
                   "type": "object",
                   "required": [ "attempt", "status" ],
                   "properties": {
                     "attempt": {
-                      "description": "Attempt number (1 = first execution)",
+                      "description": "Original sequence number for this attempt (1 = initial execution)",
                       "type": "integer",
                       "minimum": 1
                     },
                     "attemptId": {
-                      "description": "Unique identifier for this individual retry attempt. UUID recommended",
+                      "description": "Unique identifier for this individual attempt. UUID recommended",
                       "type": "string",
                       "minLength": 1
                     },
@@ -289,7 +291,8 @@
                     },
                     "duration": {
                       "description": "Attempt execution time (milliseconds)",
-                      "type": "integer"
+                      "type": "integer",
+                      "minimum": 0
                     },
                     "message": {
                       "description": "Error or failure message for this attempt",