v2.5.0 - overhauled testing framework

CHANGELOG.md

@@ -1,8 +1,11 @@
 # CHANGELOG
 
-## v2.4.1 (2020-10-21)
+## v2.5.0 (2020-10-21)
 
-* More verbose testing by iterating each address record to test against instead of just index 0
+* Overhauled testing framework
+  * Introduced `chai` for better `assert` and `expect`
+  * Went from ~50 tests to ~1700 tests by iterating each record
+  * Added tests to ensure the data structure of each record was uniform by asserting keys were the same across every record - corrected a few records with bad keys
 
 ## v2.4.0 (2020-10-21)
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "dad-tool",
-  "version": "2.4.1",
+  "version": "2.5.0",
   "description": "Dummy Address Data (DAD) allows you to query a massive dataset for real addresses that are perfect for dummy data.",
   "main": "index.js",
   "scripts": {
@@ -24,6 +24,7 @@
     "dad": "./index.js"
   },
   "devDependencies": {
+    "chai": "^4.2.0",
     "coveralls": "^3.1.0",
     "eslint": "^6.8.0",
     "mocha": "^8.1.1",

test/australia-data.test.js

@@ -1,19 +1,29 @@
 /* eslint-env node, mocha */
-const assert = require('assert');
+const assert = require('chai').assert
+const expect = require('chai').expect
 const dad = require('../index')
 
-describe('Australia Data', () => {
-    it('returns a VT address', () => {
-        const address = dad.random('AU_VT')
-        assert.strictEqual(address.state, 'VIC');
+describe('AU VT Address Data', function () {
+    const address = dad.random('AU_VT')
+    const addresses = dad.list('AU_VT')
+
+    it('returns a random VT address', function () {
+        assert.equal(address.state, 'VIC');
     });
 
-    it('returns a list of VT addresses', () => {
-        const addresses = dad.list('AU_VT')
-        assert.strictEqual(addresses.addresses.length, 5);
-        var i
-        while (i <= addresses.length) {
-            assert.strictEqual(addresses.addresses[i].state, 'VIC')
-        }
+    it('returns a list of VT addresses with a length of 5', function () {
+        assert.equal(addresses.addresses.length, 5);
+    })
+
+    addresses.addresses.forEach(function (singleAddress) {
+        it(`returns "${singleAddress.street1}" from a list of VT addresses`, function () {
+            assert.equal(singleAddress.state, 'VIC')
+        });
+    })
+
+    addresses.addresses.forEach(function (singleAddress) {
+        it(`ensures the data structure of "${singleAddress.street1}" is uniform`, function () {
+            expect(singleAddress).to.contain.all.keys('street1', 'street2', 'city', 'state', 'zip', 'country');
+        });
     });
-});
+})

test/canada-data.test.js

@@ -1,19 +1,29 @@
 /* eslint-env node, mocha */
-const assert = require('assert');
+const assert = require('chai').assert
+const expect = require('chai').expect
 const dad = require('../index')
 
-describe('Canada Data', () => {
-    it('returns a BC address', () => {
-        const address = dad.random('CA_BC')
-        assert.strictEqual(address.state, 'BC');
+describe('CA BC Address Data', function () {
+    const address = dad.random('CA_BC')
+    const addresses = dad.list('CA_BC')
+
+    it('returns a random BC address', function () {
+        assert.equal(address.state, 'BC');
     });
 
-    it('returns a list of BC addresses', () => {
-        const addresses = dad.list('CA_BC')
-        assert.strictEqual(addresses.addresses.length, 5);
-        var i
-        while (i <= addresses.length) {
-            assert.strictEqual(addresses.addresses[i].state, 'BC')
-        }
+    it('returns a list of BC addresses with a length of 5', function () {
+        assert.equal(addresses.addresses.length, 5);
+    })
+
+    addresses.addresses.forEach(function (singleAddress) {
+        it(`returns "${singleAddress.street1}" from a list of BC addresses`, function () {
+            assert.equal(singleAddress.state, 'BC')
+        });
+    })
+
+    addresses.addresses.forEach(function (singleAddress) {
+        it(`ensures the data structure of "${singleAddress.street1}" is uniform`, function () {
+            expect(singleAddress).to.contain.all.keys('street1', 'street2', 'city', 'state', 'zip', 'country');
+        });
     });
-});
+})

test/china-data.test.js

@@ -1,33 +1,54 @@
 /* eslint-env node, mocha */
-const assert = require('assert');
+const assert = require('chai').assert
+const expect = require('chai').expect
 const dad = require('../index')
 
-describe('China Data', () => {
-    it('returns a BJ address', () => {
-        const address = dad.random('CN_BJ')
-        assert.strictEqual(address.country, 'CN');
+describe('CN BJ Address Data', function () {
+    const address = dad.random('CN_BJ')
+    const addresses = dad.list('CN_BJ')
+
+    it('returns a random BJ address', function () {
+        assert.equal(address.country, 'CN');
     });
 
-    it('returns a list of BJ addresses', () => {
-        const addresses = dad.list('CN_BJ')
-        assert.strictEqual(addresses.addresses.length, 5);
-        var i
-        while (i <= addresses.length) {
-            assert.strictEqual(addresses.addresses[i].country, 'CN')
-        }
+    it('returns a list of BJ addresses with a length of 5', function () {
+        assert.equal(addresses.addresses.length, 5);
+    })
+
+    addresses.addresses.forEach(function (singleAddress) {
+        it(`returns "${singleAddress.street1}" from a list of BJ addresses`, function () {
+            assert.equal(singleAddress.country, 'CN')
+        });
+    })
+
+    addresses.addresses.forEach(function (singleAddress) {
+        it(`ensures the data structure of "${singleAddress.street1}" is uniform`, function () {
+            expect(singleAddress).to.contain.all.keys('street1', 'street2', 'city', 'state', 'zip', 'country');
+        });
     });
+})
 
-    it('returns a HK address', () => {
-        const address = dad.random('CN_HK')
-        assert.strictEqual(address.state, 'Hong Kong');
+describe('CN HK Address Data', function () {
+    const address = dad.random('CN_HK')
+    const addresses = dad.list('CN_HK')
+
+    it('returns a random HK address', function () {
+        assert.equal(address.state, 'Hong Kong');
     });
 
-    it('returns a list of HK addresses', () => {
-        const addresses = dad.list('CN_HK')
-        assert.strictEqual(addresses.addresses.length, 5);
-        var i
-        while (i <= addresses.length) {
-            assert.strictEqual(addresses.addresses[i].state, 'Hong Kong')
-        }
+    it('returns a list of HK addresses with a length of 5', function () {
+        assert.equal(addresses.addresses.length, 5);
+    })
+
+    addresses.addresses.forEach(function (singleAddress) {
+        it(`returns "${singleAddress.street1}" from a list of HK addresses`, function () {
+            assert.equal(singleAddress.state, 'Hong Kong')
+        });
+    })
+
+    addresses.addresses.forEach(function (singleAddress) {
+        it(`ensures the data structure of "${singleAddress.street1}" is uniform`, function () {
+            expect(singleAddress).to.contain.all.keys('street1', 'street2', 'city', 'state', 'zip', 'country');
+        });
     });
-});
+})

test/errors.test.js

@@ -1,13 +1,13 @@
 /* eslint-env node, mocha */
-const assert = require('assert');
+const assert = require('chai').assert
 const dad = require('../index')
 
-describe('Bad Data', () => {
-    it('returns an error when bad data is passed', () => {
+describe('Bad Data', function () {
+    it('returns an error when bad data is passed', function () {
         assert.throws(() => { dad.random('BAD_DATA') }, Error);
     });
 
-    it('returns an error when no data is passed', () => {
+    it('returns an error when no data is passed', function () {
         assert.throws(() => { dad.random() }, Error);
     });
 });