firmament-yargs/ts/test/remote-catalog.test.ts

Typescript classes for building CLI node applications

import 'reflect-metadata';
import kernel from '../inversify.config';
import {expect} from 'chai';
import * as mocha from 'mocha';
import {RemoteCatalogGetter} from '..';
import * as path from 'path';

const Url = require('url');

describe('Testing RemoteCatalogGetter Creation/Force Error', () => {
  let remoteCatalogGetter: RemoteCatalogGetter;
  beforeEach(() => {
    remoteCatalogGetter = kernel.get<RemoteCatalogGetter>('RemoteCatalogGetter');
    remoteCatalogGetter.forceError = false;
    remoteCatalogGetter.forceException = false;
    remoteCatalogGetter.forceExceptionWaitCount = 0;
  });
  afterEach(() => {
  });
  mocha.it('use mocha instance to avoid linter warning', (done) => {
    done();
  });
  it('should be created by kernel', (done) => {
    expect(remoteCatalogGetter).to.exist;
    done();
  });
});
/*
describe('Testing RemoteCatalogGetter.getParsedUrl', () => {
  let remoteCatalogGetter: RemoteCatalogGetter;
  beforeEach(() => {
    remoteCatalogGetter = kernel.get<RemoteCatalogGetter>('RemoteCatalogGetter');
    remoteCatalogGetter.forceError = false;
    remoteCatalogGetter.forceException = false;
    remoteCatalogGetter.forceExceptionWaitCount = 0;
  });
  afterEach(() => {
  });
  it('should have callback with error', (done) => {
    remoteCatalogGetter.forceError = true;
    remoteCatalogGetter.getParsedUrl(null, (err, parsedUrl) => {
      expect(err).to.exist;
      expect(err.message).to.equal('force error: RemoteCatalogGetterImpl.getParsedUrl');
      expect(parsedUrl).to.not.exist;
      done();
    });
  });
  it('should catch forcedException', (done) => {
    remoteCatalogGetter.forceException = true;
    remoteCatalogGetter.getParsedUrl(null, (err, parsedUrl) => {
      expect(err).to.exist;
      expect(err.message).to.equal('forceException');
      expect(parsedUrl).to.not.exist;
      done();
    });
  });
  it('should have callback with error when url is undefined', (done) => {
    const url = undefined;
    // noinspection JSUnusedAssignment
    remoteCatalogGetter.getParsedUrl(url, (err, parsedUrl) => {
      expect(err).to.exist;
      expect(err.message).to.equal(`Cannot read property 'constructor' of undefined`);
      expect(parsedUrl).to.not.exist;
      done();
    });
  });
  it('should have callback with error when url is null', (done) => {
    const url = null;
    remoteCatalogGetter.getParsedUrl(url, (err, parsedUrl) => {
      expect(err).to.exist;
      expect(err.message).to.equal(`Cannot read property 'constructor' of null`);
      expect(parsedUrl).to.not.exist;
      done();
    });
  });
  it('should have callback with error when url is and empty string', (done) => {
    const url = '';
    remoteCatalogGetter.getParsedUrl(url, (err, parsedUrl) => {
      expect(err).to.exist;
      expect(err.message).to.equal('Empty string is not a url');
      expect(parsedUrl).to.not.exist;
      done();
    });
  });
  it('should return parsed web url', (done) => {
    const url = 'http://www.yahoo.com/grindel.jpg';
    remoteCatalogGetter.getParsedUrl(url, (err, parsedUrl) => {
      expect(err).to.not.exist;
      expect(parsedUrl).to.be.an.instanceof(Url.constructor);
      expect(parsedUrl.protocol).to.equal('http:');
      done();
    });
  });
  it('should return parsed file url', (done) => {
    const url = '/tmp/grindel.jpg';
    remoteCatalogGetter.getParsedUrl(url, (err, parsedUrl) => {
      expect(err).to.not.exist;
      expect(parsedUrl).to.be.an.instanceof(Url.constructor);
      expect(parsedUrl.protocol).to.not.exist;
      done();
    });
  });
});

describe('Testing RemoteCatalogGetter.resolveTextResourceFromUrl', () => {
  let remoteCatalogGetter: RemoteCatalogGetter;
  beforeEach(() => {
    remoteCatalogGetter = kernel.get<RemoteCatalogGetter>('RemoteCatalogGetter');
    remoteCatalogGetter.forceError = false;
    remoteCatalogGetter.forceException = false;
    remoteCatalogGetter.forceExceptionWaitCount = 0;
  });
  afterEach(() => {
  });
  it('should have callback with error', (done) => {
    remoteCatalogGetter.forceError = true;
    remoteCatalogGetter.resolveTextResourceFromUrl(null, (err, text, absoluteUrl) => {
      expect(err).to.exist;
      expect(err.message).to.equal('force error: RemoteCatalogGetterImpl.resolveTextResourceFromUrl');
      expect(text).to.not.exist;
      expect(absoluteUrl).to.not.exist;
      done();
    });
  });
  it('should catch forcedException', (done) => {
    remoteCatalogGetter.forceException = true;
    remoteCatalogGetter.forceExceptionWaitCount = 0;
    remoteCatalogGetter.resolveTextResourceFromUrl(null, (err, text, absoluteUrl) => {
      expect(err).to.exist;
      expect(err.message).to.equal('forceException');
      expect(text).to.not.exist;
      expect(absoluteUrl).to.not.exist;
      done();
    });
  });
  it('should catch inner (2) forcedException', (done) => {
    remoteCatalogGetter.forceException = true;
    remoteCatalogGetter.forceExceptionWaitCount = 2;
    remoteCatalogGetter.resolveTextResourceFromUrl('/tmp', (err, text, absoluteUrl) => {
      expect(err).to.exist;
      expect(err.message).to.equal('forceException');
      expect(text).to.not.exist;
      expect(absoluteUrl).to.not.exist;
      done();
    });
  });
  it('should have callback with error when url is undefined', (done) => {
    const url = undefined;
    // noinspection JSUnusedAssignment
    remoteCatalogGetter.resolveTextResourceFromUrl(url, (err, text, absoluteUrl) => {
      expect(err).to.exist;
      expect(err.message).to.equal(`Cannot read property 'constructor' of undefined`);
      expect(text).to.be.empty;
      expect(absoluteUrl).to.not.exist;
      done();
    });
  });
  it('should have callback with error when url is null', (done) => {
    const url = null;
    remoteCatalogGetter.resolveTextResourceFromUrl(url, (err, text, absoluteUrl) => {
      expect(err).to.exist;
      expect(err.message).to.equal(`Cannot read property 'constructor' of null`);
      expect(text).to.be.empty;
      expect(absoluteUrl).to.not.exist;
      done();
    });
  });
  it('should have callback with error when url is and empty string', (done) => {
    const url = '';
    remoteCatalogGetter.resolveTextResourceFromUrl(url, (err, text, absoluteUrl) => {
      expect(err).to.exist;
      expect(err.message).to.equal('Empty string is not a url');
      expect(text).to.be.empty;
      expect(absoluteUrl).to.not.exist;
      done();
    });
  });
  it(`should return non-null error if file doesn't exist`, (done) => {
    const cwd = process.cwd();
    const url = path.resolve(cwd, 'ts/test/json/valid__.json');
    remoteCatalogGetter.resolveTextResourceFromUrl(url, (err, text, absoluteUrl) => {
      expect(err).to.exist;
      expect(err.message).to.equal(`Url: '/home/jreeme/src/firmament-yargs/ts/test/json/valid__.json' does not exist`);
      expect(absoluteUrl).to.equal(url);
      expect(text).to.be.empty;
      done();
    });
  });
  it(`should return null error if file exists and text should be '12345'`, (done) => {
    const cwd = process.cwd();
    const url = path.resolve(cwd, 'ts/test/json/exists.json');
    remoteCatalogGetter.resolveTextResourceFromUrl(url, (err, text, absoluteUrl) => {
      expect(err).to.not.exist;
      expect(absoluteUrl).to.equal(url);
      expect(text).to.equal('12345\n');
      done();
    });
  });
  it(`should return non-null error if web resource doesn't exist`, (done) => {
    const url = 'http://www.nositeatall.com/gumdrop.jpg';
    remoteCatalogGetter.resolveTextResourceFromUrl(url, (err, text, absoluteUrl) => {
      expect(err).to.exist;
      expect(absoluteUrl).to.equal(url);
      expect(text).to.be.empty;
      done();
    });
  });
  it(`should return null error if web resource exists`, (done) => {
    const url = 'http://www.yahoo.com/';
    remoteCatalogGetter.resolveTextResourceFromUrl(url, (err, text, absoluteUrl) => {
      expect(err).to.not.exist;
      expect(absoluteUrl).to.equal(url);
      expect(text).to.be.not.empty;
      done();
    });
  });
});

describe('Testing RemoteCatalogGetter.resolveJsonObjectFromUrl', () => {
  let remoteCatalogGetter: RemoteCatalogGetter;
  beforeEach(() => {
    remoteCatalogGetter = kernel.get<RemoteCatalogGetter>('RemoteCatalogGetter');
    remoteCatalogGetter.forceError = false;
    remoteCatalogGetter.forceException = false;
    remoteCatalogGetter.forceExceptionWaitCount = 0;
  });
  afterEach(() => {
  });
  it('should have callback with error', (done) => {
    remoteCatalogGetter.forceError = true;
    remoteCatalogGetter.resolveJsonObjectFromUrl(null, (err, jsonObject, absoluteUrl) => {
      expect(err).to.exist;
      expect(err.message).to.equal('force error: RemoteCatalogGetterImpl.resolveJsonObjectFromUrl');
      expect(jsonObject).to.not.exist;
      expect(absoluteUrl).to.not.exist;
      done();
    });
  });
  it('should have callback with error when url is undefined', (done) => {
    const url = undefined;
    remoteCatalogGetter.resolveJsonObjectFromUrl(url, (err, jsonObject, absoluteUrl) => {
      expect(err).to.exist;
      expect(err.message).to.equal(`Cannot read property 'constructor' of undefined`);
      expect(jsonObject).to.not.exist;
      expect(absoluteUrl).to.not.exist;
      done();
    });
  });
  it('should have callback with error when url is null', (done) => {
    const url = null;
    remoteCatalogGetter.resolveJsonObjectFromUrl(url, (err, jsonObject, absoluteUrl) => {
      expect(err).to.exist;
      expect(err.message).to.equal(`Cannot read property 'constructor' of null`);
      expect(absoluteUrl).to.not.exist;
      done();
    });
  });
  it('should return error on bad JSON', (done) => {
    const cwd = process.cwd();
    const url = path.resolve(cwd, 'ts/test/json/bad-json.json');
    remoteCatalogGetter.resolveJsonObjectFromUrl(url, (err, jsonObject, absoluteUrl) => {
      expect(err).to.exist;
      expect(err.message).to.equal('Unexpected token : in JSON at position 1');
      expect(absoluteUrl).to.equal(url);
      done();
    });
  });
  it('should return ', (done) => {
    const cwd = process.cwd();
    const url = path.resolve(cwd, 'ts/test/json/valid.json');
    remoteCatalogGetter.resolveJsonObjectFromUrl(url, (err, jsonObject, absoluteUrl) => {
      expect(err).to.not.exist;
      expect(jsonObject).to.include({description: 'Command Group 0'});
      expect(absoluteUrl).to.equal(url);
      done();
    });
  });
});

describe('Testing RemoteCatalogGetter.getRemoteResource', () => {
  let remoteCatalogGetter: RemoteCatalogGetter;
  beforeEach(() => {
    remoteCatalogGetter = kernel.get<RemoteCatalogGetter>('RemoteCatalogGetter');
    remoteCatalogGetter.forceError = false;
    remoteCatalogGetter.forceException = false;
    remoteCatalogGetter.forceExceptionWaitCount = 0;
  });
  afterEach(() => {
  });
  it('should have callback with error', (done) => {
    remoteCatalogGetter.forceError = true;
    remoteCatalogGetter.getRemoteResource(null, null, (err, remoteCatalogResource) => {
      expect(err).to.exist;
      expect(err.message).to.equal('force error: RemoteCatalogGetterImpl.getRemoteResource');
      expect(remoteCatalogResource).to.not.exist;
      done();
    });
  });
  it('should have callback with error when url is undefined', (done) => {
    let url;
    // noinspection JSUnusedAssignment
    remoteCatalogGetter.getRemoteResource(url, null, (err, remoteCatalogResource) => {
      expect(err).to.exist;
      expect(err.message).to.equal(`Cannot read property 'constructor' of undefined`);
      expect(remoteCatalogResource).to.not.exist;
      done();
    });
  });
  it('should have callback with error when url is null', (done) => {
    const url = null;
    remoteCatalogGetter.getRemoteResource(url, null, (err, remoteCatalogResource) => {
      expect(err).to.exist;
      expect(err.message).to.equal(`Cannot read property 'constructor' of null`);
      expect(remoteCatalogResource).to.not.exist;
      done();
    });
  });
  it('should have callback with error when json resource does not exist', (done) => {
    const cwd = process.cwd();
    const nonExistentJsonFile = 'valid__.json';
    const url = path.resolve(cwd, 'ts/test/json', nonExistentJsonFile);
    const parentCatalogEntryName = 'The parent catalog entry name!';

    remoteCatalogGetter.getRemoteResource(url, parentCatalogEntryName, (err, remoteCatalogResource) => {
      expect(err).to.exist;
      expect(err.message).to.equal(`Url: '/home/jreeme/src/firmament-yargs/ts/test/json/valid__.json' does not exist`);
      expect(remoteCatalogResource).to.not.exist;
      done();
    });
  });
  it('should have callback with error when resource does not contain valid json', (done) => {
    const cwd = process.cwd();
    const nonExistentJsonFile = 'bad-json.json';
    const url = path.resolve(cwd, 'ts/test/json', nonExistentJsonFile);
    const parentCatalogEntryName = 'The parent catalog entry name!';

    remoteCatalogGetter.getRemoteResource(url, parentCatalogEntryName, (err, remoteCatalogResource) => {
      expect(err).to.exist;
      expect(err.message).to.equal('Unexpected token : in JSON at position 1');
      expect(remoteCatalogResource).to.exist;
      done();
    });
  });
  it('should provide reasonable remoteCatalogResource when given link to valid.json', (done) => {
    const cwd = process.cwd();
    const validJson = 'valid.json';
    const url = path.resolve(cwd, 'ts/test/json', validJson);
    const parentCatalogEntryName = 'The parent catalog entry name!';

    remoteCatalogGetter.getRemoteResource(url, parentCatalogEntryName, (err, remoteCatalogResource) => {
      expect(err).to.not.exist;
      //Spot check 'remoteCatalogResource'
      expect(remoteCatalogResource).to.exist;
      expect(remoteCatalogResource).to.include({
        name: validJson
      });
      expect(remoteCatalogResource.parentCatalogEntryName).to.equal(parentCatalogEntryName);
      done();
    });
  });
});

describe('Testing RemoteCatalogGetter.getCatalogFromUrl', () => {
  let remoteCatalogGetter: RemoteCatalogGetter;
  beforeEach(() => {
    remoteCatalogGetter = kernel.get<RemoteCatalogGetter>('RemoteCatalogGetter');
    remoteCatalogGetter.forceError = false;
    remoteCatalogGetter.forceException = false;
    remoteCatalogGetter.forceExceptionWaitCount = 0;
  });
  afterEach(() => {
  });
  it('should have callback with error', (done) => {
    remoteCatalogGetter.forceError = true;
    remoteCatalogGetter.getCatalogFromUrl(null, (err, remoteCatalog) => {
      expect(err).to.exist;
      expect(err.message).to.equal('force error: RemoteCatalogGetterImpl.getCatalogFromUrl');
      expect(remoteCatalog).to.not.exist;
      done();
    });
  });
  it('should have callback with error when url is undefined', (done) => {
    remoteCatalogGetter.getCatalogFromUrl(undefined, (err, remoteCatalog) => {
      expect(err).to.exist;
      expect(err.message).to.equal(`Cannot read property 'constructor' of undefined`);
      expect(remoteCatalog).to.not.exist;
      done();
    });
  });
  it('should have callback with error when url is null', (done) => {
    remoteCatalogGetter.getCatalogFromUrl(null, (err, remoteCatalog) => {
      expect(err).to.exist;
      expect(err.message).to.equal(`Cannot read property 'constructor' of null`);
      expect(remoteCatalog).to.not.exist;
      done();
    });
  });
  it('should have callback with error when json resource does not exist', (done) => {
    const cwd = process.cwd();
    const nonExistentJsonFile = 'valid__.json';
    const url = path.resolve(cwd, 'ts/test/json', nonExistentJsonFile);
    remoteCatalogGetter.getCatalogFromUrl(url, (err, remoteCatalog) => {
      expect(err).to.exist;
      expect(err.message).to.equal(`Url: '[object Object]' does not exist`);
      expect(remoteCatalog).to.not.exist;
      done();
    });
  });
  it('should have callback with error when resource does not contain valid json', (done) => {
    const cwd = process.cwd();
    const nonExistentJsonFile = 'bad-json.json';
    const url = path.resolve(cwd, 'ts/test/json', nonExistentJsonFile);
    remoteCatalogGetter.getCatalogFromUrl(url, (err, remoteCatalog) => {
      expect(err).to.exist;
      expect(err.message).to.equal('Unexpected token : in JSON at position 1');
      expect(remoteCatalog).to.not.exist;
      done();
    });
  });
  it('should return error on catalog containing bad url', (done) => {
    const cwd = process.cwd();
    const nonExistentJsonFile = 'badCommandCatalog.json';
    const url = path.resolve(cwd, 'ts/test/json', nonExistentJsonFile);
    remoteCatalogGetter.getCatalogFromUrl(url, (err, remoteCatalog) => {
      expect(err).to.exist;
      expect(err.message).to.equal(`Url: '/home/jreeme/src/firmament-yargs/ts/test/json/prep-ubuntu-16.04-server---.json' does not exist`);
      expect(remoteCatalog).to.not.exist;
      done();
    });
  });
  it('should return local remoteCatalog', (done) => {
    const cwd = process.cwd();
    const nonExistentJsonFile = 'commandCatalog.json';
    const url = path.resolve(cwd, 'ts/test/json', nonExistentJsonFile);
    remoteCatalogGetter.getCatalogFromUrl(url, (err, remoteCatalog) => {
      expect(err).to.not.exist;
      expect(remoteCatalog).to.exist;
      done();
    });
  });
  it('should return local remoteCatalog', (done) => {
    const url = 'https://raw.githubusercontent.com/jreeme/firmament-bash/master/command-json/commandCatalog.json';
    remoteCatalogGetter.getCatalogFromUrl(url, (err, remoteCatalog) => {
      expect(err).to.not.exist;
      expect(remoteCatalog).to.exist;
      done();
    });
  });
});*/