fix: improved separator display in respect workflows (#2334)

Author: DmitryAnansky

.changeset/ready-actors-fly.md

@@ -0,0 +1,7 @@
+---
+"@redocly/respect-core": patch
+"@redocly/openapi-core": patch
+"@redocly/cli": patch
+---
+
+Fixed an issue where the Respect workflow separator did not render correctly in GitHub CI environments.

__tests__/respect/case-insensitive-headers/__snapshots__/case-insensitive-headers.test.ts.snap

@@ -1,33 +1,33 @@
 // Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
 
 exports[`should send in request and proceed case-insensitive headers in runtime expressions 1`] = `
-"────────────────────────────────────────────────────────────────────────────────
-
-  Running workflow case-insensitive-headers.arazzo.yaml / get-museum-hours
-
-  ✓ GET /museum-hours - step get-museum-hours
+"──────────────────────────────────────────────────────────────────────────────── 
+ 
+  Running workflow case-insensitive-headers.arazzo.yaml / get-museum-hours 
+ 
+  ✓ GET /museum-hours - step get-museum-hours 
     ✓ success criteria check - $request.header.content-type == 'third'
     ✓ success criteria check - $request.header.CammelCasedHeader == 'custom-heade...
     ✓ success criteria check - $response.header.X-Content-Type-Options == 'nosnif...
     ✓ status code check - $statusCode in [200, 400, 404]
     ✓ content-type check
     ✓ schema check
-
-
+ 
+ 
   Summary for case-insensitive-headers.arazzo.yaml
   
   Workflows: 1 passed, 1 total
   Steps: 1 passed, 1 total
   Checks: 6 passed, 6 total
-  Time: <test>ms
-
-
+  Time: <test>ms 
+ 
+ 
 ┌──────────────────────────────────────────────────────────────────────────────┬────────────┬─────────┬─────────┬──────────┐
 │ Filename                                                                     │ Workflows  │ Passed  │ Failed  │ Warnings │
 ├──────────────────────────────────────────────────────────────────────────────┼────────────┼─────────┼─────────┼──────────┤
 │ ✓ case-insensitive-headers.arazzo.yaml                                       │ 1          │ 1       │ -       │ -        │
 └──────────────────────────────────────────────────────────────────────────────┴────────────┴─────────┴─────────┴──────────┘
-
+ 
 
 "
 `;

__tests__/respect/cat-fact-api/__snapshots__/cat-fact-api.test.ts.snap

@@ -1,40 +1,40 @@
 // Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
 
 exports[`cats api test case 1`] = `
-"────────────────────────────────────────────────────────────────────────────────
-
-  Running workflow auto-cat.arazzo.yaml / get-breeds-workflow
-
-  ✗ GET /breeds - step get-breeds-step
+"──────────────────────────────────────────────────────────────────────────────── 
+ 
+  Running workflow auto-cat.arazzo.yaml / get-breeds-workflow 
+ 
+  ✗ GET /breeds - step get-breeds-step 
     ✓ status code check - $statusCode in [200]
     ✓ content-type check
     ✗ schema check
-
-────────────────────────────────────────────────────────────────────────────────
-
-  Running workflow auto-cat.arazzo.yaml / get-fact-workflow
-
-  ✓ GET /fact - step get-fact-step
+ 
+──────────────────────────────────────────────────────────────────────────────── 
+ 
+  Running workflow auto-cat.arazzo.yaml / get-fact-workflow 
+ 
+  ✓ GET /fact - step get-fact-step 
     ✓ status code check - $statusCode in [200, 404]
     ✓ content-type check
     ✓ schema check
-
-────────────────────────────────────────────────────────────────────────────────
-
-  Running workflow auto-cat.arazzo.yaml / get-facts-workflow
-
-  ✗ GET /facts - step get-facts-step
+ 
+──────────────────────────────────────────────────────────────────────────────── 
+ 
+  Running workflow auto-cat.arazzo.yaml / get-facts-workflow 
+ 
+  ✗ GET /facts - step get-facts-step 
     ✓ status code check - $statusCode in [200]
     ✓ content-type check
     ✗ schema check
-
+ 
 
   Failed tests info:
 
   Workflow name: get-breeds-workflow
-
-    stepId - get-breeds-step
-    ✗ schema check
+ 
+    stepId - get-breeds-step 
+    ✗ schema check 
       
       TYPE must be array
       

__tests__/respect/consider-severity-in-next-step-execution/__snapshots__/consider-severity-in-next-step-execution.test.ts.snap

@@ -1,17 +1,17 @@
 // Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
 
 exports[`should not follow the default behavior to break and return if onFailure omitted with warn severity and continue execution of the next step 1`] = `
-"────────────────────────────────────────────────────────────────────────────────
-
-  Running workflow consider-severity-in-next-step-execution.arazzo.yaml / first-workflow
-
-  ✓ GET /museum-hours - step first-step
+"──────────────────────────────────────────────────────────────────────────────── 
+ 
+  Running workflow consider-severity-in-next-step-execution.arazzo.yaml / first-workflow 
+ 
+  ✓ GET /museum-hours - step first-step 
 
     Request URL: https://redocly.com/_mock/demo/openapi/museum-api/museum-hours
     Request Headers:
       accept: application/json, application/problem+json
-      authorization: Basic Og==
-
+      authorization: Basic Og== 
+ 
 
     Response status code: 200
     Response time: <test> ms
@@ -68,24 +68,24 @@ exports[`should not follow the default behavior to break and return if onFailure
           "timeOpen": "10:00",
           "timeClose": "16:00"
         }
-      ]
-
+      ] 
+ 
     ✓ success criteria check - $statusCode == 200
     ✓ status code check - $statusCode in [200, 400, 404]
     ✓ content-type check
     ✓ schema check
-
-────────────────────────────────────────────────────────────────────────────────
-
-  Running workflow consider-severity-in-next-step-execution.arazzo.yaml / second-workflow
-
-  ✗ GET /special-events - step list-events
+ 
+──────────────────────────────────────────────────────────────────────────────── 
+ 
+  Running workflow consider-severity-in-next-step-execution.arazzo.yaml / second-workflow 
+ 
+  ✗ GET /special-events - step list-events 
 
     Request URL: https://redocly.com/_mock/demo/openapi/museum-api/special-events
     Request Headers:
       accept: application/json, application/problem+json
-      authorization: Basic Og==
-
+      authorization: Basic Og== 
+ 
 
     Response status code: 200
     Response time: <test> ms
@@ -207,23 +207,23 @@ exports[`should not follow the default behavior to break and return if onFailure
           ],
           "price": 5
         }
-      ]
-
+      ] 
+ 
     ⚠ success criteria check - $statusCode == 201
     ✓ status code check - $statusCode in [200, 400, 404]
     ✓ content-type check
     ✓ schema check
-
-  Running child workflow for the step call-first-workflow
-  Running workflow consider-severity-in-next-step-execution.arazzo.yaml / first-workflow
-
-  ✓ GET /museum-hours - step first-step
+ 
+  Running child workflow for the step call-first-workflow 
+  Running workflow consider-severity-in-next-step-execution.arazzo.yaml / first-workflow 
+ 
+  ✓ GET /museum-hours - step first-step 
 
     Request URL: https://redocly.com/_mock/demo/openapi/museum-api/museum-hours
     Request Headers:
       accept: application/json, application/problem+json
-      authorization: Basic Og==
-
+      authorization: Basic Og== 
+ 
 
     Response status code: 200
     Response time: <test> ms
@@ -280,37 +280,37 @@ exports[`should not follow the default behavior to break and return if onFailure
           "timeOpen": "10:00",
           "timeClose": "16:00"
         }
-      ]
-
+      ] 
+ 
     ✓ success criteria check - $statusCode == 200
     ✓ status code check - $statusCode in [200, 400, 404]
     ✓ content-type check
     ✓ schema check
-
-
+ 
+ 
 
   Failed tests info:
 
   Workflow name: second-workflow
-
-    stepId - list-events
-    ⚠ success criteria check
+ 
+    stepId - list-events 
+    ⚠ success criteria check 
       Checking simple criteria: {"condition":"$statusCode == 201"}
-      
+       
   Summary for consider-severity-in-next-step-execution.arazzo.yaml
   
   Workflows: 2 passed, 2 total
   Steps: 3 passed, 1 warnings, 3 total
   Checks: 12 passed, 1 warnings, 12 total
-  Time: <test>ms
-
-
+  Time: <test>ms 
+ 
+ 
 ┌──────────────────────────────────────────────────────────────────────────────────────────────┬────────────┬─────────┬─────────┬──────────┐
 │ Filename                                                                                     │ Workflows  │ Passed  │ Failed  │ Warnings │
 ├──────────────────────────────────────────────────────────────────────────────────────────────┼────────────┼─────────┼─────────┼──────────┤
 │ ✓ consider-severity-in-next-step-execution.arazzo.yaml                                       │ 2          │ 2       │ -       │ 1        │
 └──────────────────────────────────────────────────────────────────────────────────────────────┴────────────┴─────────┴─────────┴──────────┘
-
+ 
 
 "
 `;

__tests__/respect/implicit/__snapshots__/implicit.test.ts.snap

@@ -1,11 +1,11 @@
 // Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
 
 exports[`should implicitly add content type header based on requestBody.content field (the first one) if such does not specified 1`] = `
-"────────────────────────────────────────────────────────────────────────────────
-
-  Running workflow implicit.arazzo.yaml / implicit-content-type
-
-  ✓ POST /activities - step post-activities
+"──────────────────────────────────────────────────────────────────────────────── 
+ 
+  Running workflow implicit.arazzo.yaml / implicit-content-type 
+ 
+  ✓ POST /activities - step post-activities 
 
     Request URL: https://api.impossiblemissionsforce.com/activities
     Request Headers:
@@ -26,18 +26,18 @@ exports[`should implicitly add content type header based on requestBody.content
           "path": "/security/network-security/",
           "timestamp": "2023-02-19T09:31:27Z"
         }
-      }
-
+      } 
+ 
 
     Response status code: 204
     Response time: <test> ms
     Response Headers: <response headers test>
     Response Body:
-      {}
-
+      {} 
+ 
     ✓ status code check - $statusCode in [204, 400]
-
-  ✓ POST /quizzes - step post-quizzes
+ 
+  ✓ POST /quizzes - step post-quizzes 
 
     Request URL: https://api.impossiblemissionsforce.com/quizzes
     Request Headers:
@@ -61,8 +61,8 @@ exports[`should implicitly add content type header based on requestBody.content
             "correctAnswer": "b"
           }
         ]
-      }
-
+      } 
+ 
 
     Response status code: 400
     Response time: <test> ms
@@ -74,28 +74,28 @@ exports[`should implicitly add content type header based on requestBody.content
         "status": 400,
         "detail": "string",
         "instance": "string"
-      }
-
+      } 
+ 
     ✓ success criteria check - $request.header.content-type == 'application/origi...
     ✓ status code check - $statusCode in [201, 400]
     ✓ content-type check
     ✓ schema check
-
-
+ 
+ 
   Summary for implicit.arazzo.yaml
   
   Workflows: 1 passed, 1 total
   Steps: 2 passed, 2 total
   Checks: 5 passed, 5 total
-  Time: <test>ms
-
-
+  Time: <test>ms 
+ 
+ 
 ┌──────────────────────────────────────────────────────────────┬────────────┬─────────┬─────────┬──────────┐
 │ Filename                                                     │ Workflows  │ Passed  │ Failed  │ Warnings │
 ├──────────────────────────────────────────────────────────────┼────────────┼─────────┼─────────┼──────────┤
 │ ✓ implicit.arazzo.yaml                                       │ 1          │ 1       │ -       │ -        │
 └──────────────────────────────────────────────────────────────┴────────────┴─────────┴─────────┴──────────┘
-
+ 
 
 "
 `;