embark/packages/stack/communication/test/communication.spec.js
Michael Bradley, Jr 3693ebd90d fix: ensure that packages properly specify their dependencies
Many packages in the monorepo did not specify all of their dependencies; they
were effectively relying on resolution in the monorepo's root
`node_modules`. In a production release of `embark` and `embark[js]-*` packages
this can lead to broken packages.

To fix the problem currently and to help prevent it from happening again, make
use of the `eslint-plugin-import` package's `import/no-extraneous-dependencies`
and `import/no-unresolved` rules. In the root `tslint.json` set
`"no-implicit-dependencies": true`, wich is the tslint equivalent of
`import/no-extraneous-dependencies`; there is no tslint equivalent for
`import/no-unresolved`, but we will eventually replace tslint with an eslint
configuration that checks both `.js` and `.ts` files.

For `import/no-unresolved` to work in our monorepo setup, in most packages add
an `index.js` that has:

```js
module.exports = require('./dist'); // or './dist/lib' in some cases
```

And point `"main"` in `package.json` to `"./index.js"`. Despite what's
indicated in npm's documentation for `package.json`, it's also necessary to add
`"index.js"` to the `"files"` array.

Make sure that all `.js` files that can and should be linted are in fact
linted. For example, files in `packages/embark/src/cmd/` weren't being linted
and many test suites weren't being linted.

Bump all relevant packages to `eslint@6.8.0`.

Fix all linter errors that arose after these changes.

Implement a `check-yarn-lock` script that's run as part of `"ci:full"` and
`"qa:full"`, and can manually be invoked via `yarn cylock` in the root of the
monorepo. The script exits with error if any specifiers are found in
`yarn.lock` for `embark[js][-*]` and/or `@embarklabs/*` (with a few exceptions,
cf. `scripts/check-yarn-lock.js`).
2020-02-25 14:52:10 -06:00

72 lines
2.0 KiB
JavaScript

import sinon from 'sinon';
import assert from 'assert';
import { fakeEmbark } from 'embark-testing';
import Communication from '../src/';
describe('stack/communication', () => {
// eslint-disable-next-line no-unused-vars
let communication, communicationNodeLaunchFn, doneCb;
const { embark } = fakeEmbark();
beforeEach(() => {
embark.setConfig({
communicationConfig: {
connection: {
host: 'localhost'
}
},
embarkConfig: {}
});
communication = new Communication(embark);
communicationNodeLaunchFn = sinon.spy(done => {
embark.events.request('processes:register', 'communication', {
launchFn: cb => cb(),
stopFn: cb => cb()
});
embark.events.request('processes:launch', 'communication', _err => {
done();
});
});
doneCb = sinon.fake();
});
afterEach(() => {
embark.teardown();
sinon.restore();
});
test('it should register and start communication node', () => {
const communicationConfig = {
provider: 'whisper',
enabled: true
};
const processRegisterHandler = sinon.spy((_name, _fns) => {});
const processLaunchHandler = sinon.spy((_name, fn) => fn());
embark.events.setCommandHandler('processes:register', processRegisterHandler);
embark.events.setCommandHandler('processes:launch', processLaunchHandler);
embark.events.request('communication:node:register', 'whisper', communicationNodeLaunchFn);
embark.events.request('communication:node:start', communicationConfig, doneCb);
assert(communicationNodeLaunchFn.calledOnce);
assert(doneCb.calledOnce);
});
test('it should register artifact file from configuration', () => {
const pipelineRegisterHandler = sinon.spy((params, fn) => fn());
embark.events.setCommandHandler('pipeline:register', pipelineRegisterHandler);
embark.plugins.emitAndRunActionsForEvent('pipeline:generateAll:before', {}, doneCb);
assert(pipelineRegisterHandler.calledOnce);
assert(doneCb.calledOnce);
});
});