ravel/jest/core/scan.test.js

Ravel Rapid Application Development Framework

const Ravel = require('../../lib/ravel');
const Metadata = require('../../lib/util/meta');

describe('Ravel', () => {
  beforeEach(() => {
    jest.restoreAllMocks();
    jest.resetModules();
    jest.clearAllMocks();
  });

  // Testing how Ravel loads things from a directory
  describe('scan', () => {
    it('should fail with an IllegalValue error if a target directory does not exist', () => {
      const app = new (require('../../lib/ravel'))();
      app.load = jest.fn();
      expect(() => app.scan(`./${Math.random()}`)).toThrow(app.$err.IllegalValue);
    });

    it('should fail with an IllegalValue error if a target directory is not a directory', () => {
      const fs = require('fs');
      jest.spyOn(fs, 'lstatSync').mockImplementation(function () {
        return {
          isDirectory: function () { return false; }
        };
      });
      const app = new (require('../../lib/ravel'))();
      app.load = jest.fn();
      expect(() => app.scan(`./${Math.random()}`)).toThrow(app.$err.IllegalValue);
    });

    it('should attempt to load classes from files within a directory', () => {
      jest.doMock('fs-readdir-recursive', () => {
        return () => ['test1.js', 'test2.js', '.eslintrc', 'package/test3.js'];
      });
      const fs = require('fs');
      jest.spyOn(fs, 'lstatSync').mockImplementation(function () {
        return {
          isDirectory: function () { return true; }
        };
      });
      const app = new (require('../../lib/ravel'))();
      @Ravel.Module
      class M1 {}
      @Ravel.Module('hello')
      class M2 {}
      @Ravel.Module
      class M3 {}
      jest.doMock(upath.toUnix(upath.posix.join(app.cwd, './modules/test1.js')), () => M1, { virtual: true });
      jest.doMock(upath.toUnix(upath.posix.join(app.cwd, './modules/test2.js')), () => M2, { virtual: true });
      jest.doMock(upath.toUnix(upath.posix.join(app.cwd, './modules/package/test3.js')), () => M3, { virtual: true });
      app.load = jest.fn();
      app.scan('./modules');
      expect(app.load).toHaveBeenCalledWith(M1, M2, M3);
      // ensure that names are inferred/used appropriately
      expect(Metadata.getClassMetaValue(M1.prototype, '@role', 'name')).toBe('test1');
      expect(Metadata.getClassMetaValue(M2.prototype, '@role', 'name')).toBe('hello');
      expect(Metadata.getClassMetaValue(M3.prototype, '@role', 'name')).toBe('package.test3');
    });

    it('should attempt to load classes from files within an absolute-pathed directory', () => {
      jest.doMock('fs-readdir-recursive', () => {
        return () => ['test1.js', 'test2.js', '.eslintrc', 'package/test3.js'];
      });
      const fs = require('fs');
      jest.spyOn(fs, 'lstatSync').mockImplementation(function () {
        return {
          isDirectory: function () { return true; }
        };
      });
      const app = new (require('../../lib/ravel'))();
      @Ravel.Module
      class M1 {}
      @Ravel.Module('hello')
      class M2 {}
      @Ravel.Resource('/')
      class R1 {}
      jest.doMock('/modules/test1.js', () => M1, { virtual: true });
      jest.doMock('/modules/test2.js', () => M2, { virtual: true });
      jest.doMock('/modules/package/test3.js', () => R1, { virtual: true });
      app.load = jest.fn();
      app.scan('/modules');
      expect(app.load).toHaveBeenCalledWith(M1, M2, R1);
      // ensure that names are inferred/used appropriately
      expect(Metadata.getClassMetaValue(M1.prototype, '@role', 'name')).toBe('test1');
      expect(Metadata.getClassMetaValue(M2.prototype, '@role', 'name')).toBe('hello');
      expect(Metadata.getClassMetaValue(R1.prototype, '@role', 'name')).toBe('/');
    });

    it('should throw $err.IllegalValue when trying to load a file as a @Module which is not a class', () => {
      jest.doMock('fs-readdir-recursive', () => {
        return () => ['test1.js', 'test2.js', '.eslintrc', 'package/test3.js'];
      });
      const fs = require('fs');
      jest.spyOn(fs, 'lstatSync').mockImplementation(function () {
        return {
          isDirectory: function () { return true; }
        };
      });
      const app = new (require('../../lib/ravel'))();
      @Ravel.Module
      class M1 {}
      @Ravel.Module('hello')
      class M2 {}
      const M3 = {};
      jest.doMock('/modules/test1.js', () => M1, { virtual: true });
      jest.doMock('/modules/test2.js', () => M2, { virtual: true });
      jest.doMock('/modules/package/test3.js', () => M3, { virtual: true });
      app.load = jest.fn();
      expect(() => app.scan('/modules')).toThrow(app.$err.IllegalValue);
    });
  });
});