@ibm-cloud/openapi-ruleset/test/rules/schema-casing-convention.test.js

Spectral ruleset for validating IBM Cloud services

/**
 * Copyright 2023 - 2024 IBM Corporation.
 * SPDX-License-Identifier: Apache2.0
 */

const { schemaCasingConvention } = require('../../src/rules');
const {
  makeCopy,
  rootDocument,
  testRule,
  severityCodes,
} = require('../test-utils');

const rule = schemaCasingConvention;
const ruleId = 'ibm-schema-casing-convention';
const expectedMsg = 'Schema names must be upper camel case';
const expectedSeverity = severityCodes.warning;

describe(`Spectral rule: ${ruleId}`, () => {
  describe('Should not yield errors', () => {
    it('Clean spec', async () => {
      const results = await testRule(ruleId, rule, rootDocument);
      expect(results).toHaveLength(0);
    });

    it('No components', async () => {
      const testDocument = {
        openapi: '3.0',
        paths: {
          '/v1/things': {
            post: {},
          },
        },
      };
      const results = await testRule(ruleId, rule, testDocument);
      expect(results).toHaveLength(0);
    });

    it('No schemas', async () => {
      const testDocument = {
        openapi: '3.0',
        paths: {
          '/v1/things': {
            post: {
              requestBody: {
                $ref: '#/components/requestBodies/CreateThingRequest',
              },
            },
          },
        },
        components: {
          requestBodies: {
            CreateThingRequest: {},
          },
        },
      };
      const results = await testRule(ruleId, rule, testDocument);
      expect(results).toHaveLength(0);
    });

    it('Upper camel case schema name with capitalized acronym', async () => {
      const testDocument = makeCopy(rootDocument);
      testDocument.components.schemas.IAMCredentialsSecret = {};

      const results = await testRule(ruleId, rule, testDocument);
      expect(results).toHaveLength(0);
    });
  });

  describe('Should yield errors', () => {
    it('Lower camel case schema name', async () => {
      const testDocument = makeCopy(rootDocument);
      testDocument.components.schemas.movieCollection = {};

      const results = await testRule(ruleId, rule, testDocument);
      expect(results).toHaveLength(1);

      const expectedPaths = ['components.schemas.movieCollection'];
      for (const i in results) {
        expect(results[i].code).toBe(ruleId);
        expect(results[i].message).toBe(expectedMsg);
        expect(results[i].severity).toBe(expectedSeverity);
        expect(results[i].path.join('.')).toBe(expectedPaths[i]);
      }
    });

    it('Multiple schema names with incorrect casing', async () => {
      const testDocument = makeCopy(rootDocument);
      testDocument.components.schemas.movieCollection = {};
      testDocument.components.schemas['Drink-Collection'] = {};

      const results = await testRule(ruleId, rule, testDocument);
      expect(results).toHaveLength(2);

      const expectedPaths = [
        'components.schemas.movieCollection',
        'components.schemas.Drink-Collection',
      ];

      for (const i in results) {
        expect(results[i].code).toBe(ruleId);
        expect(results[i].message).toBe(expectedMsg);
        expect(results[i].severity).toBe(expectedSeverity);
        expect(results[i].path.join('.')).toBe(expectedPaths[i]);
      }
    });
  });
});