loopback-swagger/test/specgen/tag-builder.test.js

Integration between LoopBack and Swagger API specs

// Copyright IBM Corp. 2015,2019. All Rights Reserved.
// Node module: loopback-swagger
// This file is licensed under the MIT License.
// License text available at https://opensource.org/licenses/MIT

'use strict';

var tagBuilder = require('../../lib/specgen/tag-builder');
var expect = require('chai').expect;
var _defaults = require('lodash').defaults;

describe('tag-builder', function() {
  it('joins array descriptions from ctor.settings', function() {
    var tag = tagBuilder.buildTagFromClass({
      ctor: {settings: {description: ['line1', 'line2']}},
    });

    expect(tag.description).to.equal('line1\nline2');
  });

  it('joins array descriptions from ctor.sharedCtor', function() {
    var tag = tagBuilder.buildTagFromClass({
      ctor: {sharedCtor: {description: ['1', '2', '3']}},
    });

    expect(tag.description).to.eql('1\n2\n3');
  });

  it('should use custom swagger name if provided', function() {
    var tag = tagBuilder.buildTagFromClass({
      ctor: {settings: {swagger: {tag: {name: 'Something Else'}}}},
    });

    expect(tag.name).to.eql('Something Else');
  });

  it('sets external spec properties from model options', function() {
    var tag = tagBuilder.buildTagFromClass({
      ctor: {settings: {swagger: {tag: {externalDocs: {url: 'http://google.com'}}}}},
    });

    expect(tag.externalDocs).to.eql({url: 'http://google.com'});
  });
});