iframe-proxy | Sunbelt Computer Software

152 lines (134 loc) · 4.67 KB
/* eslint-disable no-unused-expressions */
const { expect } = require('chai');
const { operation, tag, security, idPathParameters } = require('../lib/utils');
describe('util tests', () => {
  describe('operation', () => {
    const defaults = {
      parameters: ['default', 'parameter'],
      responses: { default: 'responses' },
      description: 'default description',
      summary: 'default summary',
      tags: ['default', 'tags'],
      consumes: ['default', 'consumes'],
      produces: ['default', 'produces'],
      security: ['default', 'security']
    it('should provide spec defaults for empty service.docs.operations[method] and defaults', () => {
      expect(operation('find', { docs: {}, find () {} }, {})).to.deep.equal({
        parameters: [],
        responses: {},
        description: '',
        summary: '',
        tags: [],
        consumes: [],
        produces: [],
        security: []
    it('should consume defaults', () => {
      expect(operation('find', { docs: {}, find () {} }, defaults)).to.deep.equal(defaults);
    it('should prefer prefer method.docs over service.docs.operations[method] overservice.docs.operations.all ', () => {
      const service = {
        docs: {
          operations: {
            all: {
              tags: ['onlyAll'],
              summary: 'global summary'
            find: {
              description: 'description of docs.find',
              summary: 'only from docs.operations.find'
        find () {}
      service.find.docs = {
        description: 'description of find.docs'
      expect(operation('find', service, defaults)).to.deep.equal({
        parameters: defaults.parameters,
        responses: defaults.responses,
        description: 'description of find.docs',
        summary: 'only from docs.operations.find',
        tags: ['onlyAll'],
        consumes: defaults.consumes,
        produces: defaults.produces,
        security: defaults.security
    it('should support setting of nested path keys', () => {
      const service = {
        docs: {
          operations: {
            find: {
              description: 'description of docs.find',
              'nested.added': 'key'
        find () {}
      expect(operation('find', service, {}, { nested: { object: 'value' } })).to.deep.equal({
        description: 'description of docs.find',
        nested: {
          object: 'value',
          added: 'key'
  describe('tag', () => {
    it('should provide a default description', () => {
      expect(tag('message')).to.deep.equal({
        name: 'message',
        description: 'A message service'
    it('should consume known options', () => {
      const options = {
        description: 'my description',
        externalDocs: {
          url: 'https://example.com',
          description: 'The external documentation'
        additionalOption: 'should not be consumed'
      expect(tag('message', options)).to.deep.equal({
        name: 'message',
        description: options.description,
        externalDocs: options.externalDocs
  describe('security', () => {
    const securityDefinitions = [
      { BasicAuth: [] }
    const securities = ['create'];
    it('should return empty array when method should not be secured', () => {
      expect(security('find', securities, securityDefinitions)).to.deep.equals([]);
    it('should return security definitions array when method should be secured', () => {
      expect(security('create', securities, securityDefinitions)).to.equals(securityDefinitions);
    it('should return security definitions array when all methods should be secured', () => {
      expect(security('create', ['all'], securityDefinitions)).to.equals(securityDefinitions);
  describe('idPathParameters', () => {
    it('should return id path parameters when idName is string', () => {
      expect(idPathParameters('id', ',')).to.deep.equals('{id}');
    it('should return id path parameters when idName is array', () => {
      expect(idPathParameters(['id'], ',')).to.deep.equals('{id}');
    it('should return id path parameters when idName is array with multiple items', () => {
      expect(idPathParameters(['firstId', 'secondId'], ',')).to.deep.equals('{firstId},{secondId}');
    it('should return id path parameters when idName is array with multiple items and custom idSeparator', () => {
      expect(idPathParameters(['firstId', 'secondId'], '|')).to.deep.equals('{firstId}|{secondId}');
Sunbelt Computer Software

PL/B Language Development and Support

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Sunbelt Computer Software

PL/B Language Development and Support

Uh oh!

FilesExpand file tree

utils.test.js

Latest commit

History

utils.test.js

File metadata and controls
