add tests of abi-gen

4 files changed, 99 insertions, 1 deletions

diff --git a/packages/abi-gen/bin/abi-gen.js b/packages/abi-gen/bin/abi-gen.js
index c46eb9b66..8d6bdccf8 100755
--- a/packages/abi-gen/bin/abi-gen.js
+++ b/packages/abi-gen/bin/abi-gen.js
@@ -1,2 +1,2 @@
 #!/usr/bin/env node
-require('../lib/index.js')
+require('../lib/src/index.js')
diff --git a/packages/abi-gen/coverage/.gitkeep b/packages/abi-gen/coverage/.gitkeep
new file mode 100644
index 000000000..e69de29bb
--- /dev/null
+++ b/packages/abi-gen/coverage/.gitkeep
diff --git a/packages/abi-gen/package.json b/packages/abi-gen/package.json
index fd02634f9..b85b20d19 100644
--- a/packages/abi-gen/package.json
+++ b/packages/abi-gen/package.json
@@ -12,6 +12,11 @@
         "lint": "tslint --project .",
         "clean": "shx rm -rf lib scripts",
         "build": "tsc && copyfiles -u 2 './lib/monorepo_scripts/**/*' ./scripts",
+        "test": "yarn run_mocha",
+        "run_mocha": "mocha --require source-map-support/register --require make-promises-safe lib/test/**/*_test.js --bail --exit",
+        "test:circleci": "yarn test:coverage",
+        "test:coverage": "nyc npm run test --all && yarn coverage:report:lcov",
+        "coverage:report:lcov": "nyc report --reporter=text-lcov > coverage/lcov.info",
         "manual:postpublish": "yarn build; node ./scripts/postpublish.js"
     },
     "bin": {
@@ -35,6 +40,8 @@
         "handlebars": "^4.0.11",
         "lodash": "^4.17.4",
         "mkdirp": "^0.5.1",
+        "sleep": "^5.1.1",
+        "tmp": "^0.0.33",
         "to-snake-case": "^1.0.0",
         "yargs": "^10.0.3"
     },
@@ -45,9 +52,14 @@
         "@types/handlebars": "^4.0.36",
         "@types/mkdirp": "^0.5.1",
         "@types/node": "^8.0.53",
+        "@types/sleep": "^0.0.7",
+        "@types/tmp": "^0.0.33",
         "@types/yargs": "^10.0.0",
+        "chai": "^4.1.2",
         "copyfiles": "^1.2.0",
+        "dirty-chai": "^2.0.1",
         "make-promises-safe": "^1.1.0",
+        "mocha": "^5.2.0",
         "npm-run-all": "^4.1.2",
         "shx": "^0.2.2",
         "tslint": "5.8.0",
diff --git a/packages/abi-gen/test/utils_test.ts b/packages/abi-gen/test/utils_test.ts
new file mode 100644
index 000000000..c6147df38
--- /dev/null
+++ b/packages/abi-gen/test/utils_test.ts
@@ -0,0 +1,86 @@
+import * as chai from 'chai';
+import * as dirtyChai from 'dirty-chai';
+import * as fs from 'fs';
+import 'mocha';
+import * as sleep from 'sleep';
+import * as tmp from 'tmp';
+
+import { utils } from '../src/utils';
+
+tmp.setGracefulCleanup(); // remove tmp files even if there are failures
+
+chai.use(dirtyChai);
+
+const expect = chai.expect;
+
+const SLEEP_MS = 10; // time to wait before re-timestamping a file
+
+describe('makeOutputFileName()', () => {
+    it('should handle Metacoin usage', () => {
+        expect(utils.makeOutputFileName('Metacoin')).to.equal('metacoin');
+    });
+    it('should handle special zrx_token case', () => {
+        expect(utils.makeOutputFileName('ZRXToken')).to.equal('zrx_token');
+    });
+    it('should handle special erc_token case', () => {
+        expect(utils.makeOutputFileName('ERC20Token')).to.equal('erc20_token');
+    });
+});
+
+describe('writeOutputFile()', () => {
+    let tempFilePath: string;
+    before(() => {
+        tempFilePath = tmp.fileSync(
+            { discardDescriptor: true }, // close file (so we can update it)
+        ).name;
+    });
+    it('should write content to output file', () => {
+        const content = 'hello world';
+
+        utils.writeOutputFile(tempFilePath, content);
+
+        expect(fs.readFileSync(tempFilePath).toString()).to.equal(content);
+    });
+});
+
+describe('isOutputFileUpToDate()', () => {
+    it('should throw ENOENT when there is no abi file', () => {
+        expect(utils.isOutputFileUpToDate.bind('nonexistant1', 'nonexistant2')).to.throw('ENOENT');
+    });
+
+    describe('when the abi input file exists', () => {
+        let abiFile: string;
+        before(() => {
+            abiFile = tmp.fileSync(
+                { discardDescriptor: true }, // close file (set timestamp)
+            ).name;
+        });
+
+        describe('without an existing output file', () => {
+            it('should return false', () => {
+                expect(utils.isOutputFileUpToDate(abiFile, 'nonexistant_file')).to.be.false();
+            });
+        });
+
+        describe('with an existing output file', () => {
+            let outputFile: string;
+            before(() => {
+                sleep.msleep(SLEEP_MS); // to ensure different timestamp
+                outputFile = tmp.fileSync(
+                    { discardDescriptor: true }, // close file (set timestamp)
+                ).name;
+            });
+
+            it('should return true when output file and is newer than abi file', async () => {
+                expect(utils.isOutputFileUpToDate(abiFile, outputFile)).to.be.true();
+            });
+
+            it('should return false when output file exists but is older than abi file', () => {
+                sleep.msleep(SLEEP_MS); // to ensure different timestamp
+                fs.closeSync(fs.openSync(abiFile, 'w')); // touch abi file
+
+                expect(utils.isOutputFileUpToDate(abiFile, outputFile)).to.be.false();
+            });
+        });
+    });
+});