feat: lint arazzo test descriptions

.changeset/green-worms-vanish.md

@@ -0,0 +1,6 @@
+---
+"@redocly/openapi-core": minor
+"@redocly/cli": minor
+---
+
+Added support for Arazzo description linting.

__tests__/bundle/bundle-arazzo-valid-test-description/museum.yaml

@@ -0,0 +1,32 @@
+arazzo: 1.0.0
+info:
+  title: Redocly Museum API Tickets
+  description: >-
+    A part of imaginary, but delightful Museum API for interacting with museum services
+    and information. Built with love by Redocly.
+  version: 1.0.0
+
+sourceDescriptions:
+  - name: museum-api
+    type: openapi
+    url: museum-api.yaml
+
+workflows:
+  - workflowId: get-museum-tickets
+    description: >-
+      This workflow demonstrates how to buy tickets for the museum.
+    parameters:
+      - $ref: './parameter.yaml'
+    steps:
+      - stepId: buy-tickets
+        description: >-
+          Buy museum tickets resolving request details with buyMuseumTickets operationId from museum-api.yaml description.
+        operationId: buyMuseumTickets
+        requestBody:
+          $ref: './request-body.yaml#/requestBody'
+        successCriteria:
+          - condition: $statusCode == 201
+        outputs:
+          ticketId: $response.body.ticketId
+    outputs:
+      ticketId: $steps.buy-tickets.outputs.ticketId

__tests__/bundle/bundle-arazzo-valid-test-description/parameter.yaml

@@ -0,0 +1,3 @@
+in: header
+name: Authorization
+value: Basic Og==

__tests__/bundle/bundle-arazzo-valid-test-description/request-body.yaml

@@ -0,0 +1,5 @@
+requestBody:
+  payload:
+    ticketType: general
+    ticketDate: 2023-09-07
+    email: [email protected]

__tests__/bundle/bundle-arazzo-valid-test-description/snapshot.js

@@ -0,0 +1,43 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`E2E bundle bundle-arazzo-valid-test-description 1`] = `
+info:
+  title: Redocly Museum API Tickets
+  description: A part of imaginary, but delightful Museum API for interacting with museum services and information. Built with love by Redocly.
+  version: 1.0.0
+components:
+  parameters:
+    parameter:
+      in: header
+      name: Authorization
+      value: Basic Og==
+arazzo: 1.0.0
+sourceDescriptions:
+  - name: museum-api
+    type: openapi
+    url: museum-api.yaml
+workflows:
+  - workflowId: get-museum-tickets
+    description: This workflow demonstrates how to buy tickets for the museum.
+    parameters:
+      - $ref: '#/parameters/parameter'
+    steps:
+      - stepId: buy-tickets
+        description: Buy museum tickets resolving request details with buyMuseumTickets operationId from museum-api.yaml description.
+        operationId: buyMuseumTickets
+        requestBody:
+          payload:
+            ticketType: general
+            ticketDate: '2023-09-07'
+            email: [email protected]
+        successCriteria:
+          - condition: $statusCode == 201
+        outputs:
+          ticketId: $response.body.ticketId
+    outputs:
+      ticketId: $steps.buy-tickets.outputs.ticketId
+
+bundling museum.yaml...
+📦 Created a bundle for museum.yaml at stdout <test>ms.
+
+`;

__tests__/commands.test.ts

@@ -31,11 +31,35 @@ describe('E2E', () => {
 
       const args = getParams('../../../packages/cli/src/index.ts', 'lint');
 
-      it(file, () => {
+      test(file, () => {
         const result = getCommandOutput(args, testPath);
         (<any>expect(cleanupOutput(result))).toMatchSpecificSnapshot(join(testPath, 'snapshot.js'));
       });
     }
+
+    test('lint valid Arazzo description', () => {
+      const dirName = 'arazzo-valid-test-description';
+      const folderPath = join(__dirname, `lint/${dirName}`);
+
+      const args = getParams('../../../packages/cli/src/index.ts', 'lint', ['museum.yaml']);
+
+      const result = getCommandOutput(args, folderPath);
+      (expect(cleanupOutput(result)) as any).toMatchSpecificSnapshot(
+        join(folderPath, 'snapshot.js')
+      );
+    });
+
+    test('lint not valid Arazzo description', () => {
+      const dirName = 'arazzo-not-valid-test-description';
+      const folderPath = join(__dirname, `lint/${dirName}`);
+
+      const args = getParams('../../../packages/cli/src/index.ts', 'lint', ['museum.yaml']);
+
+      const result = getCommandOutput(args, folderPath);
+      (expect(cleanupOutput(result)) as any).toMatchSpecificSnapshot(
+        join(folderPath, 'snapshot.js')
+      );
+    });
   });
 
   describe('zero-config', () => {
@@ -389,6 +413,7 @@ describe('E2E', () => {
     const excludeFolders = [
       'bundle-remove-unused-components',
       'bundle-remove-unused-components-from-config',
+      'bundle-arazzo-valid-test-description',
     ];
     const folderPath = join(__dirname, 'bundle');
     const contents = readdirSync(folderPath).filter((folder) => !excludeFolders.includes(folder));
@@ -403,11 +428,19 @@ describe('E2E', () => {
 
       const args = getParams('../../../packages/cli/src/index.ts', 'bundle', [...entryPoints]);
 
-      it(file, () => {
+      test(file, () => {
         const result = getCommandOutput(args, testPath);
         (<any>expect(cleanupOutput(result))).toMatchSpecificSnapshot(join(testPath, 'snapshot.js'));
       });
     }
+
+    test('bundle-arazzo-valid-test-description', () => {
+      const testPath = join(folderPath, 'bundle-arazzo-valid-test-description');
+      const args = getParams('../../../packages/cli/src/index.ts', 'bundle', ['museum.yaml']);
+
+      const result = getCommandOutput(args, testPath);
+      (<any>expect(cleanupOutput(result))).toMatchSpecificSnapshot(join(testPath, 'snapshot.js'));
+    });
   });
 
   describe('bundle with option: remove-unused-components', () => {

__tests__/lint-config/invalid-config--lint-config-off/snapshot.js

@@ -5,7 +5,7 @@ exports[`E2E lint-config test with option: { dirName: 'invalid-config--lint-conf
 validating ../__fixtures__/valid-openapi.yaml...
 ../__fixtures__/valid-openapi.yaml: validated in <test>ms
 
-Woohoo! Your API description is valid. 🎉
+Woohoo! Your description document is valid. 🎉
 
 [WARNING] Unused rules found in .redocly.yaml: context.
 Check the spelling and verify the added plugin prefix.

__tests__/lint-config/invalid-config--lint-config-warn/snapshot.js

@@ -19,7 +19,7 @@ Warning was generated by the configuration spec rule.
 validating ../__fixtures__/valid-openapi.yaml...
 ../__fixtures__/valid-openapi.yaml: validated in <test>ms
 
-Woohoo! Your API description is valid. 🎉
+Woohoo! Your description document is valid. 🎉
 
 [WARNING] Unused rules found in .redocly.yaml: context.
 Check the spelling and verify the added plugin prefix.

__tests__/lint-config/invalid-config--no-option/snapshot.js

@@ -19,7 +19,7 @@ Warning was generated by the configuration spec rule.
 validating ../__fixtures__/valid-openapi.yaml...
 ../__fixtures__/valid-openapi.yaml: validated in <test>ms
 
-Woohoo! Your API description is valid. 🎉
+Woohoo! Your description document is valid. 🎉
 
 [WARNING] Unused rules found in .redocly.yaml: context.
 Check the spelling and verify the added plugin prefix.