Skip to content

Commit 90f7bf6

Browse files
DmitryAnanskyDmitryAnansky
committed
chore: add changelog and e2e test
1 parent 510e4fe commit 90f7bf6

File tree

6 files changed

+435
-0
lines changed

6 files changed

+435
-0
lines changed

‎.changeset/thick-eyes-create.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
"@redocly/respect-core": minor
3+
"@redocly/cli": minor
4+
---
5+
6+
Added the `secrets-reveal` option to the respect command, allowing raw (unmasked) output to be generated.

‎__tests__/respect/reveal-masked-input-secrets/__snapshots__/reveal-masked-input-secrets.test.ts.snap‎

Lines changed: 284 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,284 @@
1+
// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
2+
3+
exports[`should reveal masked input values 1`] = `
4+
"────────────────────────────────────────────────────────────────────────────────
5+
6+
Running workflow reveal-masked-input-secrets.arazzo.yaml / get-museum-hours
7+
8+
✓ GET /museum-hours - step get-museum-hours
9+
10+
    Request URL: https://redocly.com/_mock/demo/openapi/museum-api/museum-hours
11+
    Request Headers:
12+
      accept: application/json, application/problem+json
13+
      authorization: Basic Og==
14+
      password: password
15+
      username: John
16+
      masked-combined-value: John and password and maybe Basic Og==
17+
      multi-word-secret: Bearer password
18+
19+
20+
    Response status code: 200
21+
    Response time: <test> ms
22+
    Response Headers: <response headers test>
23+
    Response Body:
24+
      [
25+
       {
26+
       "date": "2023-09-11",
27+
       "timeOpen": "09:00",
28+
       "timeClose": "18:00"
29+
       },
30+
       {
31+
       "date": "2023-09-12",
32+
       "timeOpen": "09:00",
33+
       "timeClose": "18:00"
34+
       },
35+
       {
36+
       "date": "2023-09-13",
37+
       "timeOpen": "09:00",
38+
       "timeClose": "18:00"
39+
       },
40+
       {
41+
       "date": "2023-09-14",
42+
       "timeOpen": "09:00",
43+
       "timeClose": "18:00"
44+
       },
45+
       {
46+
       "date": "2023-09-15",
47+
       "timeOpen": "10:00",
48+
       "timeClose": "16:00"
49+
       },
50+
       {
51+
       "date": "2023-09-18",
52+
       "timeOpen": "09:00",
53+
       "timeClose": "18:00"
54+
       },
55+
       {
56+
       "date": "2023-09-19",
57+
       "timeOpen": "09:00",
58+
       "timeClose": "18:00"
59+
       },
60+
       {
61+
       "date": "2023-09-20",
62+
       "timeOpen": "09:00",
63+
       "timeClose": "18:00"
64+
       },
65+
       {
66+
       "date": "2023-09-21",
67+
       "timeOpen": "09:00",
68+
       "timeClose": "18:00"
69+
       },
70+
       {
71+
       "date": "2023-09-22",
72+
       "timeOpen": "10:00",
73+
       "timeClose": "16:00"
74+
       }
75+
      ]
76+
77+
    ✓ success criteria check - $statusCode == 200
78+
    ✓ status code check - $statusCode in [200, 400, 404]
79+
    ✓ content-type check
80+
    ✓ schema check
81+
82+
────────────────────────────────────────────────────────────────────────────────
83+
84+
Running workflow reveal-masked-input-secrets.arazzo.yaml / events-crud
85+
86+
✓ GET /special-events - step list-events
87+
88+
    Request URL: https://redocly.com/_mock/demo/openapi/museum-api/special-events
89+
    Request Headers:
90+
      accept: application/json, application/problem+json
91+
      authorization: Basic Og==
92+
      multi-word-secret: composed Basic Og==
93+
94+
95+
    Response status code: 200
96+
    Response time: <test> ms
97+
    Response Headers: <response headers test>
98+
    Response Body:
99+
      [
100+
       {
101+
       "eventId": "f3e0e76e-e4a8-466e-ab9c-ae36c15b8e97",
102+
       "name": "Sasquatch Ballet",
103+
       "location": "Seattle... probably",
104+
       "eventDescription": "They're big, they're hairy, but they're also graceful. Come learn how the biggest feet can have the lightest touch.",
105+
       "dates": [
106+
       "2023-12-15",
107+
       "2023-12-22"
108+
       ],
109+
       "price": 40
110+
       },
111+
       {
112+
       "eventId": "2f14374a-9c65-4ee5-94b7-fba66d893483",
113+
       "name": "Solar Telescope Demonstration",
114+
       "location": "Far from the sun.",
115+
       "eventDescription": "Look at the sun without going blind!",
116+
       "dates": [
117+
       "2023-09-07",
118+
       "2023-09-14"
119+
       ],
120+
       "price": 50
121+
       },
122+
       {
123+
       "eventId": "6aaa61ba-b2aa-4868-b803-603dbbf7bfdb",
124+
       "name": "Cook like a Caveman",
125+
       "location": "Fire Pit on East side",
126+
       "eventDescription": "Learn to cook on an open flame.",
127+
       "dates": [
128+
       "2023-11-10",
129+
       "2023-11-17",
130+
       "2023-11-24"
131+
       ],
132+
       "price": 5
133+
       },
134+
       {
135+
       "eventId": "602b75e1-5696-4ab8-8c7a-f9e13580f910",
136+
       "name": "Underwater Basket Weaving",
137+
       "location": "Rec Center Pool next door.",
138+
       "eventDescription": "Learn to weave baskets underwater.",
139+
       "dates": [
140+
       "2023-09-12",
141+
       "2023-09-15"
142+
       ],
143+
       "price": 15
144+
       },
145+
       {
146+
       "eventId": "dad4bce8-f5cb-4078-a211-995864315e39",
147+
       "name": "Mermaid Treasure Identification and Analysis",
148+
       "location": "Room Sea-12",
149+
       "eventDescription": "Join us as we review and classify a rare collection of 20 thingamabobs, gadgets, gizmos, whoosits, and whatsits — kindly donated by Ariel.",
150+
       "dates": [
151+
       "2023-09-05",
152+
       "2023-09-08"
153+
       ],
154+
       "price": 30
155+
       },
156+
       {
157+
       "eventId": "6744a0da-4121-49cd-8479-f8cc20526495",
158+
       "name": "Time Traveler Tea Party",
159+
       "location": "Temporal Tearoom",
160+
       "eventDescription": "Sip tea with important historical figures.",
161+
       "dates": [
162+
       "2023-11-18",
163+
       "2023-11-25",
164+
       "2023-12-02"
165+
       ],
166+
       "price": 60
167+
       },
168+
       {
169+
       "eventId": "3be6453c-03eb-4357-ae5a-984a0e574a54",
170+
       "name": "Pirate Coding Workshop",
171+
       "location": "Computer Room",
172+
       "eventDescription": "Captain Blackbeard shares his love of the C...language. And possibly Arrrrr (R lang).",
173+
       "dates": [
174+
       "2023-10-29",
175+
       "2023-10-30",
176+
       "2023-10-31"
177+
       ],
178+
       "price": 45
179+
       },
180+
       {
181+
       "eventId": "9d90d29a-2af5-4206-97d9-9ea9ceadcb78",
182+
       "name": "Llama Street Art Through the Ages",
183+
       "location": "Auditorium",
184+
       "eventDescription": "Llama street art?! Alpaca my bags -- let's go!",
185+
       "dates": [
186+
       "2023-10-29",
187+
       "2023-10-30",
188+
       "2023-10-31"
189+
       ],
190+
       "price": 45
191+
       },
192+
       {
193+
       "eventId": "a3c7b2c4-b5fb-4ef7-9322-00a919864957",
194+
       "name": "The Great Parrot Debate",
195+
       "location": "Outdoor Amphitheatre",
196+
       "eventDescription": "See leading parrot minds discuss important geopolitical issues.",
197+
       "dates": [
198+
       "2023-11-03",
199+
       "2023-11-10"
200+
       ],
201+
       "price": 35
202+
       },
203+
       {
204+
       "eventId": "b92d46b7-4c5d-422b-87a5-287767e26f29",
205+
       "name": "Eat a Bunch of Corn",
206+
       "location": "Cafeteria",
207+
       "eventDescription": "We accidentally bought too much corn. Please come eat it.",
208+
       "dates": [
209+
       "2023-11-10",
210+
       "2023-11-17",
211+
       "2023-11-24"
212+
       ],
213+
       "price": 5
214+
       }
215+
      ]
216+
217+
    ✓ status code check - $statusCode in [200, 400, 404]
218+
    ✓ content-type check
219+
    ✓ schema check
220+
221+
✓ POST /special-events - step create-event
222+
223+
    Request URL: https://redocly.com/_mock/demo/openapi/museum-api/special-events
224+
    Request Headers:
225+
      content-type: application/json
226+
      accept: application/json, application/problem+json
227+
      authorization: Basic Og==
228+
      multi-word-secret: composed Basic Og==
229+
    Request Body:
230+
      {
231+
       "username": "John",
232+
       "secret": "password",
233+
       "multiwordSecret": "Bearer secretToken",
234+
       "name": "Mermaid Treasure Identification and Analysis",
235+
       "location": "Under the seaaa 🦀 🎶 🌊.",
236+
       "eventDescription": "Join us as we review and classify a rare collection of 20 thingamabobs, gadgets, gizmos, whoosits, and whatsits, kindly donated by Ariel.",
237+
       "dates": [
238+
       "2023-09-05",
239+
       "2023-09-08"
240+
       ],
241+
       "price": 0
242+
      }
243+
244+
245+
    Response status code: 201
246+
    Response time: <test> ms
247+
    Response Headers: <response headers test>
248+
    Response Body:
249+
      {
250+
       "eventId": "dad4bce8-f5cb-4078-a211-995864315e39",
251+
       "name": "Mermaid Treasure Identification and Analysis",
252+
       "location": "Under the seaaa 🦀 🎶 🌊.",
253+
       "eventDescription": "Join us as we review and classify a rare collection of 20 thingamabobs, gadgets, gizmos, whoosits, and whatsits, kindly donated by Ariel.",
254+
       "dates": [
255+
       "2023-09-05",
256+
       "2023-09-08"
257+
       ],
258+
       "price": 0
259+
      }
260+
261+
    ✓ success criteria check - $statusCode == 201
262+
    ✓ success criteria check - $.name == 'Mermaid Treasure Identification and Ana...
263+
    ✓ status code check - $statusCode in [201, 400, 404]
264+
    ✓ content-type check
265+
    ✓ schema check
266+
267+
268+
  Summary for reveal-masked-input-secrets.arazzo.yaml
269+
  
270+
  Workflows: 2 passed, 2 total
271+
  Steps: 3 passed, 3 total
272+
  Checks: 12 passed, 12 total
273+
  Time: <test>ms
274+
275+
276+
┌─────────────────────────────────────────────────────────────────────────────────┬────────────┬─────────┬─────────┬──────────┐
277+
│ Filename │ Workflows │ Passed │ Failed │ Warnings │
278+
├─────────────────────────────────────────────────────────────────────────────────┼────────────┼─────────┼─────────┼──────────┤
279+
│ ✓ reveal-masked-input-secrets.arazzo.yaml │ 2 │ 2 │ - │ - │
280+
└─────────────────────────────────────────────────────────────────────────────────┴────────────┴─────────┴─────────┴──────────┘
281+
282+
283+
"
284+
`;

0 commit comments

Comments
 (0)