Migrates SDK CLI tests to test-environment

.circleci/config.yml

@@ -32,7 +32,7 @@ commands:
           condition: << parameters.run-yarn >>
           steps:
             - restore_cache:
-                key: yarn-cache-v7-
+                key: yarn-cache-v8-
             - run:
                 command: yarn
                 working_directory: "~/openzeppelin/<< parameters.workspace >>"
@@ -48,15 +48,14 @@ commands:
           working_directory: "~/openzeppelin/<< parameters.workspace >>"
 
 jobs:
-
   setup:
     <<: *defaults
     steps:
       - checkout
       - restore_cache:
           keys:
             - dependency-cache-v5-{{ checksum "yarn.lock" }}
-            - yarn-cache-v7-
+            - yarn-cache-v8-
       - run:
           name: Install dependencies and build
           command: yarn
@@ -73,7 +72,7 @@ jobs:
             - packages/cli/node_modules
             - packages/lib/node_modules
       - save_cache:
-          key: yarn-cache-v7-{{ checksum "yarn.lock" }}
+          key: yarn-cache-v8-{{ checksum "yarn.lock" }}
           paths:
             - ~/.cache/yarn/v6
       - persist_to_workspace:

packages/cli/package.json

@@ -8,8 +8,9 @@
   "scripts": {
     "copy-files": "./scripts/copy-files.sh",
     "compile-ts": "rm -rf lib && tsc",
-    "prepare": "npm run compile-ts && npm run copy-files && chmod 755 ./lib/bin/oz-cli.js",
-    "test": "./scripts/test.sh",
+    "compile-contracts": "rm -rf build/contracts && truffle compile",
+    "prepare": "npm run compile-contracts && npm run compile-ts && npm run copy-files && chmod 755 ./lib/bin/oz-cli.js",
+    "test": "TS_NODE_PROJECT='tsconfig.test.json' npx mocha --require ts-node/register --recursive test",
     "gen-docs": "./scripts/gen-docs.sh",
     "watch": "tsc -w",
     "lint": "eslint '*/**/*.{js,ts}' --quiet --fix",
@@ -57,6 +58,7 @@
   "dependencies": {
     "@openzeppelin/resolver-engine-core": "^0.3.3",
     "@openzeppelin/resolver-engine-imports-fs": "^0.3.3",
+    "@openzeppelin/test-environment": "^0.1.0",
     "@openzeppelin/upgrades": "^2.6.0",
     "@types/fs-extra": "^7.0.0",
     "@types/npm": "^2.0.29",
@@ -137,7 +139,7 @@
     "@types/node": "^10.12.12",
     "@typescript-eslint/eslint-plugin": "^1.9.0",
     "@typescript-eslint/parser": "^1.9.0",
-    "chai": "^4.1.2",
+    "chai": "^4.2.0",
     "chai-as-promised": "^7.1.1",
     "chai-bignumber": "^2.0.2",
     "chai-string": "^1.5.0",
@@ -149,6 +151,7 @@
     "lint-staged": "4.3.0",
     "lodash.mapkeys": "^4.6.0",
     "lodash.random": "^3.2.0",
+    "mocha": "^6.2.2",
     "mock-stdlib": "file:./test/mocks/mock-stdlib",
     "mock-stdlib-2": "file:./test/mocks/mock-stdlib-2",
     "mock-stdlib-invalid": "file:./test/mocks/mock-stdlib-invalid",

packages/cli/test/bin/helpers.test.js

@@ -1,3 +1,4 @@
+import { expect } from 'chai';
 import findRootDirectory from '../../src/bin/helpers';
 
 describe('bin helpers', function() {

packages/cli/test/commands/create2.test.js

@@ -3,7 +3,7 @@ require('../setup');
 
 import { stubCommands, itShouldParse } from './share';
 
-contract('create2 command', function() {
+describe('create2 command', function() {
   stubCommands();
 
   itShouldParse(

packages/cli/test/commands/link.test.js

@@ -9,7 +9,7 @@ describe('link command', function() {
   itShouldParse(
     'should call link script with a list of dependencies and no install',
     'link',
-    'zos link mock-stdlib@1.1.0 mock-stdlib-2@1.2.0 --no-install',
+    'openzeppelin link mock-stdlib@1.1.0 mock-stdlib-2@1.2.0 --no-install --no-interactive',
     function(link) {
       const dependencies = ['mock-stdlib@1.1.0', 'mock-stdlib-2@1.2.0'];
       link.should.have.been.calledWithExactly({
@@ -22,7 +22,7 @@ describe('link command', function() {
   itShouldParse(
     'should call push script when passing --push option',
     'push',
-    'zos link mock-stdlib@1.1.0 mock-stdlib-2@1.2.0 --push test',
+    'openzeppelin link mock-stdlib@1.1.0 mock-stdlib-2@1.2.0 --push test',
     function(push) {
       push.should.have.been.calledWithExactly({
         deployProxyAdmin: undefined,

packages/cli/test/config/TruffleConfig.test.js

@@ -7,7 +7,7 @@ import { FileSystem } from '@openzeppelin/upgrades';
 import TruffleConfig from '../../src/models/config/TruffleConfig';
 import CaptureLogs from '../helpers/captureLogs';
 
-contract('TruffleConfig', () => {
+describe('TruffleConfig', () => {
   const testDir = `${process.cwd()}/test/tmp`;
 
   beforeEach('create test dir', function() {

packages/cli/test/interface/ValidationLogger.test.js

@@ -5,7 +5,7 @@ import CaptureLogs from '../helpers/captureLogs';
 import { Contracts, getStorageLayout, compareStorageLayouts, getBuildArtifacts } from '@openzeppelin/upgrades';
 import ValidationLogger from '../../src/interface/ValidationLogger';
 
-contract('ValidationLogger', function() {
+describe('ValidationLogger', function() {
   beforeEach('capturing log output', function() {
     this.logs = new CaptureLogs();
   });

packages/cli/test/models/ContractManager.test.js

@@ -2,13 +2,15 @@
 
 require('../setup');
 
+import { expect } from 'chai';
+
 import sinon from 'sinon';
 import { FileSystem, Contracts } from '@openzeppelin/upgrades';
 import ContractManager from '../../src/models/local/ContractManager';
 import ProjectFile from '../../src/models/files/ProjectFile';
 import ConfigManager from '../../src/models/config/ConfigManager';
 
-contract('ContractManager', function([_, from]) {
+describe('ContractManager', function() {
   describe('methods', function() {
     describe('getContractNames', function() {
       context('without directory created', function() {
@@ -61,14 +63,16 @@ contract('ContractManager', function([_, from]) {
                 bytecode: '0x124',
                 contractName: 'Foo',
               };
-              FileSystem.writeJson(`${this.testDir}/build/contracts/Foo.json`, builtContract);
+              this.fooContractPath = `${this.testDir}/build/contracts/Foo.json`;
+              FileSystem.writeJson(this.fooContractPath, builtContract);
               this.projectFile = new ProjectFile(`${this.testDir}/zos.json`);
               this.contractManager = new ContractManager(this.projectFile);
               sinon.stub(ConfigManager, 'getBuildDir').returns(`${this.testDir}/build/contracts`);
               sinon.stub(Contracts, 'getLocalContractsDir').returns(`${this.testDir}/contracts`);
             });
 
             afterEach(function() {
+              FileSystem.remove(this.fooContractPath);
               sinon.restore();
             });
 

packages/cli/test/models/Dependency.test.js

@@ -2,11 +2,16 @@
 
 require('../setup');
 
+import { expect } from 'chai';
+import { accounts } from '@openzeppelin/test-environment';
+
 import sinon from 'sinon';
 import npm from 'npm-programmatic';
 import Dependency from '../../src/models/dependency/Dependency';
 
-contract('Dependency', function([_, from]) {
+describe('Dependency', function() {
+  const [from] = accounts;
+
   describe('static methods', function() {
     describe('#satisfiesVersion', function() {
       it('verifies if requirement satisfies version', function() {
@@ -24,7 +29,7 @@ contract('Dependency', function([_, from]) {
       it('fetches version from npm for org package', async function() {
         const actual = await Dependency.fetchVersionFromNpm('@openzeppelin/cli');
         actual.should.match(/^@openzeppelin\/cli@\^\d+\.\d+\.0$/);
-      });
+      }).timeout(5000);
     });
 
     describe('#fromNameAndVersion', function() {

packages/cli/test/models/ManifestVersion.test.js

@@ -4,7 +4,7 @@ import { checkVersion, isMigratableManifestVersion } from '../../src/models/file
 
 const projectFileName = 'project.json';
 
-contract('ManifestVersion', function() {
+describe('ManifestVersion', function() {
   describe('functions', function() {
     describe('checkVersion', function() {
       context('when latest version', function() {

packages/cli/test/models/NetworkFile.test.js

@@ -7,7 +7,7 @@ import NetworkFile from '../../src/models/files/NetworkFile';
 import ProjectFile from '../../src/models/files/ProjectFile';
 import { MANIFEST_VERSION } from '../../src/models/files/ManifestVersion';
 
-contract('NetworkFile', function() {
+describe('NetworkFile', function() {
   beforeEach('loads parent package file', function() {
     this.appProjectFile = new ProjectFile('test/mocks/packages/package-empty.zos.json');
   });

packages/cli/test/models/ProjectFile.test.js

@@ -1,10 +1,12 @@
 'use strict';
 require('../setup');
 
+import { expect } from 'chai';
+
 import ProjectFile from '../../src/models/files/ProjectFile';
 import { MANIFEST_VERSION } from '../../src/models/files/ManifestVersion';
 
-contract('ProjectFile', function() {
+describe('ProjectFile', function() {
   describe('class methods', function() {
     describe('#getLinkedDependencies', function() {
       it('gets an array of dependencies', function() {

packages/cli/test/models/TestHelper.test.js

@@ -3,14 +3,17 @@
 require('../setup');
 
 import { Contracts } from '@openzeppelin/upgrades';
+import { accounts } from '@openzeppelin/test-environment';
+
 import TestHelper from '../../src/models/TestHelper';
 import ProjectFile from '../../src/models/files/ProjectFile';
 import NetworkFile from '../../src/models/files/NetworkFile';
 
 const ImplV1 = Contracts.getFromLocal('ImplV1');
 const WithLibraryImpl = Contracts.getFromLocal('WithLibraryImplV1');
 
-contract('TestHelper', function([_, owner]) {
+describe('TestHelper', function() {
+  const [owner] = accounts;
   const txParams = { from: owner };
   const projectName = 'Herbs';
   const initialVersion = '1.1.0';

packages/cli/test/prompts/prompt.test.js

@@ -2,6 +2,7 @@
 
 require('../setup');
 import sinon from 'sinon';
+import { expect } from 'chai';
 
 import * as prompt from '../../src/prompts/prompt';
 

packages/cli/test/scripts/accounts.test.js

@@ -1,16 +1,14 @@
 'use strict';
 
 require('../setup');
-import utils from 'web3-utils';
 import sinon from 'sinon';
 import { ZWeb3 } from '@openzeppelin/upgrades';
+import { defaultSender, accounts as accountList } from '@openzeppelin/test-environment';
 
 import accounts from '../../src/scripts/accounts';
 import CaptureLogs from '../helpers/captureLogs';
 
-contract('accounts script', function(accountList) {
-  accountList = accountList.map(utils.toChecksumAddress);
-  const [defaultAccount] = accountList;
+describe('accounts script', function() {
   const network = 'test';
 
   beforeEach('caputre logs', function() {
@@ -27,7 +25,7 @@ contract('accounts script', function(accountList) {
 
       this.logs.infos.should.have.lengthOf(3);
       this.logs.infos[0].should.eq(`Accounts for ${network}:`);
-      this.logs.infos[1].should.eq(`Default: ${defaultAccount}`);
+      this.logs.infos[1].should.eq(`Default: ${defaultSender}`);
       accountList.forEach(account => this.logs.infos[2].should.match(new RegExp(account)));
     });
   });

packages/cli/test/scripts/add.test.js

@@ -2,11 +2,13 @@
 require('../setup');
 
 import sinon from 'sinon';
+import { expect } from 'chai';
+
 import add from '../../src/scripts/add';
 import addAll from '../../src/scripts/add-all';
 import ProjectFile from '../../src/models/files/ProjectFile';
 
-contract('add script', function() {
+describe('add script', function() {
   const contractName = 'ImplV1';
   const contractAlias = 'Impl';
   const contractsData = [{ name: contractName, alias: contractAlias }];

packages/cli/test/scripts/balance.test.js

@@ -2,16 +2,19 @@
 require('../setup');
 
 import utils from 'web3-utils';
-import { ZWeb3, Contracts } from '@openzeppelin/upgrades';
+import { Contracts } from '@openzeppelin/upgrades';
+import { accounts, web3 } from '@openzeppelin/test-environment';
+
 import CaptureLogs from '../helpers/captureLogs';
+import { fromWei } from '../../src/utils/units';
 
 import balance from '../../src/scripts/balance';
 
 const ERC20 = Contracts.getFromLocal('ERC20Fake');
 const ERC20Detailed = Contracts.getFromLocal('ERC20FakeDetailed');
 
-contract('balance script', function(accounts) {
-  const [_, accountAddress] = accounts.map(utils.toChecksumAddress);
+describe('balance script', function() {
+  const [accountAddress] = accounts;
 
   beforeEach('set logger captures', function() {
     this.logs = new CaptureLogs();
@@ -30,9 +33,10 @@ contract('balance script', function(accounts) {
 
     context('when not specifying an ERC20 token address', function() {
       it('logs balance in ETH', async function() {
+        const eth = fromWei(await web3.eth.getBalance(accountAddress), 'ether');
         await balance({ accountAddress });
         this.logs.infos.should.have.lengthOf(1);
-        this.logs.infos[0].should.eq('Balance: 100 ETH');
+        this.logs.infos[0].should.eq(`Balance: ${eth} ETH`);
       });
     });
 

packages/cli/test/scripts/bump.test.js

@@ -6,7 +6,7 @@ import bump from '../../src/scripts/bump';
 import link from '../../src/scripts/link';
 import ProjectFile from '../../src/models/files/ProjectFile';
 
-contract('bump script', function() {
+describe('bump script', function() {
   const newVersion = '0.2.0';
 
   describe('on app', function() {

packages/cli/test/scripts/call.test.js

@@ -1,21 +1,22 @@
 'use strict';
 require('../setup');
+
 import utils from 'web3-utils';
+import { accounts } from '@openzeppelin/test-environment';
 
 import add from '../../src/scripts/add';
 import push from '../../src/scripts/push';
 import call from '../../src/scripts/call';
 import sendTx from '../../src/scripts/send-tx';
 import createProxy from '../../src/scripts/create';
-import { Contracts } from '@openzeppelin/upgrades';
 import CaptureLogs from '../helpers/captureLogs';
 import ProjectFile from '../../src/models/files/ProjectFile';
 import NetworkFile from '../../src/models/files/NetworkFile';
 
-contract('call script', function(accounts) {
-  accounts = accounts.map(utils.toChecksumAddress);
-  const [_skipped, account] = accounts;
+describe('call script', function() {
+  const [account] = accounts;
   const txParams = { from: account };
+
   const network = 'test';
 
   beforeEach('setup', async function() {