test/PopApi.spec.js

// Import the necessary modules.
// @flow
/* eslint-disable no-unused-expressions */
import cluster from 'cluster'
import sinon from 'sinon'
import winston from 'winston'
import { expect } from 'chai'

import {
  Logger,
  PopApi,
  Routes
} from '../src'
import {
  name,
  version
} from '../package'

/** @test {PopApi} */
describe('PopApi', () => {
  /** @test {PopApi.app} */
  it('should have a static express instance', () => {
    expect(PopApi.app).to.exist
  })

  /** @test {PopApi.debug} */
  it('should have a debug function for extra output', () => {
    expect(PopApi.debug).to.exist
    expect(PopApi.debug).to.be.a('function')
  })

  /** @test {PopApi._installedPlugins} */
  it('should have a static map for the installed plugins', () => {
    expect(PopApi._installedPlugins).to.exist
    expect(PopApi._installedPlugins).to.be.a('Map')
  })

  /**
   * Helper function to test the `use` method.
   * @param {!string} msg - The message to print for the test.
   * @returns {undefined}
   */
  function testUse(msg: string): void {
    /** @test {PopApi.use} */
    it(msg, () => {
      PopApi.use(Routes, {
        app: PopApi.app
      })

      expect(PopApi._installedPlugins).to.be.a('Map')
      expect(PopApi._installedPlugins.size).to.equal(1)
    })
  }

  // Execute the tests.
  [
    'should register a middleware plugin',
    'should not register the same plugin twice'
  ].map(testUse)

  /** @test {PopApi.use} */
  it('should not register the plugin if it is not a class', () => {
    PopApi.use({})

    expect(PopApi._installedPlugins).to.be.a('Map')
    expect(PopApi._installedPlugins.size).to.equal(1)
  })

  /** @test {PopApi.init} */
  it('should initiate the PopApi instance', done => {
    process.argv = ['', '', '-m', 'pretty']
    PopApi.init({
      name,
      version,
      workers: 0
    }).then(res => done())
      .catch(done)
  })

  /** @test {PopApi.init} */
  it('should initiate the PopApi instance and not create the temporary directory', done => {
    const masterStub = sinon.stub(cluster, 'isMaster')
    const forkStub = sinon.stub(cluster, 'fork')
    masterStub.value(false)

    process.argv = ['', '', '-m', 'pretty']
    PopApi.init({
      name,
      version
    }).then(() => {
      masterStub.restore()
      forkStub.restore()

      done()
    }).catch(done)
  })

  /**
   * Hook for tearing down the PopApi tests.
   * @type {Function}
   */
  after(done => {
    winston.loggers.close()
    process.env.NODE_ENV = 'test'
    PopApi.server.closeApi(PopApi.database, done)
    Logger.fileTransport = null
  })
})