embark/packages/stack/deployment/test/deployment.spec.js

132 lines
5.2 KiB
JavaScript
Raw Normal View History

import sinon from 'sinon';
import assert from 'assert';
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-20 23:47:01 +00:00
import { fakeEmbark } from 'embark-testing';
import Deployment from '../src/';
describe('stack/deployment', () => {
const { embark, plugins } = fakeEmbark();
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-20 23:47:01 +00:00
// eslint-disable-next-line no-unused-vars
let deployment;
let deployedContracts = [];
let beforeAllAction, beforeDeployAction, shouldDeployAction, deployedAction, afterAllAction;
let deployFn;
let doneCb;
beforeEach(() => {
embark.config.blockchainConfig = { enabled: true };
deployment = new Deployment(embark, { plugins });
beforeAllAction = sinon.spy((params, cb) => { cb(null, params); });
beforeDeployAction = sinon.spy((params, cb) => { cb(null, params); });
shouldDeployAction = sinon.spy((params, cb) => { cb(null, params); });
deployedAction = sinon.spy((params, cb) => { cb(null, params); });
afterAllAction = sinon.spy((params, cb) => { cb(null, params); });
deployFn = sinon.spy((contract, done) => {
deployedContracts.push(contract);
done(null, {}); // deployer needs to finish with a receipt object
});
doneCb = sinon.fake();
});
afterEach(() => {
deployedContracts = [];
embark.teardown();
sinon.restore();
});
test('it should register deployFn and deploy contract by using it', () => {
let testContract = { className: 'TestContract', shouldDeploy: true };
embark.registerActionForEvent('deployment:contract:beforeDeploy', beforeDeployAction);
embark.registerActionForEvent('deployment:contract:shouldDeploy', shouldDeployAction);
embark.registerActionForEvent('deployment:contract:deployed', deployedAction);
embark.events.request('deployment:deployer:register', 'ethereum', deployFn);
embark.events.request('deployment:contract:deploy', testContract, doneCb);
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-20 23:47:01 +00:00
assert(beforeDeployAction.calledOnce);
assert(shouldDeployAction.calledOnce);
assert(deployFn.calledWith(testContract));
assert.equal(deployedContracts[0], testContract);
assert(doneCb.calledOnce);
});
test('it should deploy list of contracts', () => {
let testContracts = [
{ className: 'Contract1', shouldDeploy: true },
{ className: 'Contract2', shouldDeploy: true },
{ className: 'Contract3', shouldDeploy: true }
];
embark.registerActionForEvent('deployment:deployContracts:beforeAll', beforeAllAction);
embark.registerActionForEvent('deployment:contract:beforeDeploy', beforeDeployAction);
embark.registerActionForEvent('deployment:contract:shouldDeploy', shouldDeployAction);
embark.registerActionForEvent('deployment:contract:deployed', deployedAction);
embark.registerActionForEvent('deployment:deployContracts:afterAll', afterAllAction);
embark.events.request('deployment:deployer:register', 'ethereum', deployFn);
embark.events.request('deployment:contracts:deploy', testContracts, {}, doneCb);
assert(beforeAllAction.calledOnce);
embark.events.assert.commandHandlerCalledWith('deployment:contract:deploy', testContracts[0]);
embark.events.assert.commandHandlerCalledWith('deployment:contract:deploy', testContracts[1]);
embark.events.assert.commandHandlerCalledWith('deployment:contract:deploy', testContracts[2]);
assert(deployFn.calledWith(testContracts[0]));
assert(deployFn.calledWith(testContracts[1]));
assert(deployFn.calledWith(testContracts[2]));
assert.equal(deployedAction.callCount, 3);
assert.equal(deployedContracts.length, 3);
assert(afterAllAction.calledOnce);
assert(doneCb.calledOnce);
});
test('it should deploy contracts in correct order', () => {
let testContracts = [
{ className: 'A', shouldDeploy: true },
{ className: 'B', shouldDeploy: true },
{ className: 'C', shouldDeploy: true },
{ className: 'D', shouldDeploy: true },
{ className: 'E', shouldDeploy: true },
{ className: 'F', shouldDeploy: true }
];
let testContractDependencies = {
A: ['B'],
B: [],
C: ['A'],
D: ['F'],
E: ['A'],
F: []
};
embark.registerActionForEvent('deployment:deployContracts:beforeAll', beforeAllAction);
embark.registerActionForEvent('deployment:contract:beforeDeploy', beforeDeployAction);
embark.registerActionForEvent('deployment:contract:shouldDeploy', shouldDeployAction);
embark.registerActionForEvent('deployment:contract:deployed', deployedAction);
embark.registerActionForEvent('deployment:deployContracts:afterAll', afterAllAction);
embark.events.request('deployment:deployer:register', 'ethereum', deployFn);
embark.events.request('deployment:contracts:deploy', testContracts, testContractDependencies, doneCb);
assert.equal(deployedContracts.length, 6);
// expected result: [B, F, A, D, C, E]
assert.equal(deployedContracts[0].className, testContracts[1].className);
assert.equal(deployedContracts[1].className, testContracts[5].className);
assert.equal(deployedContracts[2].className, testContracts[0].className);
assert.equal(deployedContracts[3].className, testContracts[3].className);
assert.equal(deployedContracts[4].className, testContracts[2].className);
assert.equal(deployedContracts[5].className, testContracts[4].className);
});
});