Change testing suite to follow lisk standards - Closes #448

package.json

@@ -66,6 +66,8 @@
 		"babel-plugin-istanbul": "=4.1.5",
 		"babel-preset-env": "=1.6.1",
 		"babel-register": "=6.26.0",
+		"chai": "=4.1.2",
+		"chai-as-promised": "=7.1.1",
 		"coveralls": "=3.0.0",
 		"eslint": "=4.11.0",
 		"eslint-config-airbnb-base": "=12.1.0",
@@ -78,8 +80,7 @@
 		"mocha-bdd": "=0.1.2",
 		"nyc": "=11.3.0",
 		"prettier": "=1.9.2",
-		"should": "=13.1.3",
-		"should-sinon": "=0.0.6",
-		"sinon": "=4.1.2"
+		"sinon": "=4.1.2",
+		"sinon-chai": "=2.14.0"
 	}
 }

test/setup.js

@@ -15,29 +15,41 @@
  */
 import os from 'os';
 import 'babel-polyfill';
-import should from 'should';
+import chai, { Assertion } from 'chai';
+import 'chai/register-should';
+import chaiAsPromised from 'chai-as-promised';
+import sinonChai from 'sinon-chai';
 import sinon from 'sinon';
-import 'should-sinon';
 import mochaBDD from 'mocha-bdd';
 
 process.env.NODE_ENV = 'test';
 process.env.LISKY_CONFIG_DIR =
 	process.env.LISKY_CONFIG_DIR || `${os.homedir()}/.lisky`;
 
-should.use((_, Assertion) => {
-	// istanbul ignore next
-	Assertion.add('hexString', function hexString() {
-		this.params = {
-			operator: 'to be hex string',
-		};
-		Buffer.from(this.obj, 'hex')
-			.toString('hex')
-			.should.equal(this.obj);
-	});
+/* eslint-disable no-underscore-dangle */
+Assertion.addMethod('matchAny', function handleAssert(matcher) {
+	const obj = this._obj;
+
+	new Assertion(obj).to.be.an('array');
+	const result = obj.some(val => matcher(val));
+	this.assert(
+		result,
+		'expected #{this} to match at least once',
+		'expected #{this} not to match',
+	);
+});
+
+Assertion.addMethod('customError', function handleAssert(error) {
+	const obj = this._obj;
+	new Assertion(obj).to.be.instanceOf(Error);
+	new Assertion(obj.name).to.equal(error.name);
+	new Assertion(obj.message).to.equal(error.message);
 });
+/* eslint-enable no-underscore-dangle */
 
 mochaBDD();
-// See https://github.com/shouldjs/should.js/issues/41
-Object.defineProperty(global, 'should', { value: should });
+
+[sinonChai, chaiAsPromised].forEach(chai.use);
+
 global.sinon = sinon;
 global.sandbox = sinon.sandbox.create();

test/steps/api/3_then.js

@@ -18,7 +18,7 @@ import { getFirstBoolean } from '../utils';
 
 export function itShouldNotSetTheLiskAPIInstanceTestnetSetting() {
 	const { liskAPIInstance } = this.test.ctx;
-	return liskAPIInstance.setTestnet.should.not.be.called();
+	return liskAPIInstance.setTestnet.should.not.be.called;
 }
 
 export function itShouldSetTheLiskAPIInstanceTestnetSettingTo() {
@@ -42,7 +42,7 @@ export function itShouldUseTheLiskAPIInstanceToSendARequestToTheEndpointUsingThe
 
 export function itShouldNotBroadcastTheSignature() {
 	const { liskAPIInstance } = this.test.ctx;
-	return liskAPIInstance.broadcastSignatures.should.not.be.called();
+	return liskAPIInstance.broadcastSignatures.should.not.be.called;
 }
 
 export function itShouldBroadcastTheSignature() {
@@ -54,7 +54,7 @@ export function itShouldBroadcastTheSignature() {
 
 export function itShouldNotBroadcastTheTransaction() {
 	const { liskAPIInstance } = this.test.ctx;
-	return liskAPIInstance.broadcastTransaction.should.not.be.called();
+	return liskAPIInstance.broadcastTransaction.should.not.be.called;
 }
 
 export function itShouldBroadcastTheTransaction() {
@@ -66,7 +66,7 @@ export function itShouldBroadcastTheTransaction() {
 
 export function itShouldResolveToTheAPIResponse() {
 	const { returnValue, apiResponse } = this.test.ctx;
-	return returnValue.should.be.fulfilledWith(apiResponse);
+	return returnValue.should.eventually.eql(apiResponse);
 }
 
 export function theLiskAPIInstanceShouldBeALiskJSAPIInstance() {

test/steps/childProcesses/3_then.js

@@ -32,7 +32,7 @@ export function itShouldExecuteAScriptExecutingThirdInASeparateChildProcess() {
 }
 
 export function itShouldNotExecuteAThirdScriptInASeparateChildProcess() {
-	return childProcess.exec.should.not.be.calledThrice();
+	return childProcess.exec.should.not.be.calledThrice;
 }
 
 export function theLiskyInstanceShouldLogTheFirstChildProcessOutputFirst() {

test/steps/config/3_then.js

@@ -42,7 +42,7 @@ export function itShouldUpdateTheConfigVariableToBoolean() {
 
 export function itShouldResolveToTheConfig() {
 	const { returnValue, config } = this.test.ctx;
-	return returnValue.should.be.fulfilledWith(config);
+	return returnValue.should.eventually.eql(config);
 }
 
 export function theDefaultConfigShouldBeExported() {

test/steps/crypto/3_then.js

@@ -27,12 +27,12 @@ export function itShouldSignTheMessageWithThePassphrase() {
 
 export function itShouldResolveToTheResultOfSigningTheMessage() {
 	const { returnValue, cryptoResult } = this.test.ctx;
-	return returnValue.should.be.fulfilledWith(cryptoResult);
+	return returnValue.should.eventually.eql(cryptoResult);
 }
 
 export function itShouldResolveToTheResultOfDecryptingThePassphrase() {
 	const { returnValue, cryptoResult } = this.test.ctx;
-	return returnValue.should.be.fulfilledWith(cryptoResult);
+	return returnValue.should.eventually.eql(cryptoResult);
 }
 
 export function itShouldDecryptThePassphraseUsingTheIVAndThePassword() {
@@ -46,7 +46,7 @@ export function itShouldDecryptThePassphraseUsingTheIVAndThePassword() {
 
 export function itShouldResolveToTheResultOfEncryptingThePassphraseCombinedWithThePublicKey() {
 	const { returnValue, cryptoResult, publicKey } = this.test.ctx;
-	return returnValue.should.be.fulfilledWith(
+	return returnValue.should.eventually.eql(
 		Object.assign({}, cryptoResult, { publicKey }),
 	);
 }
@@ -61,7 +61,7 @@ export function itShouldEncryptThePassphraseUsingThePassword() {
 
 export function itShouldResolveToTheResultOfEncryptingThePassphrase() {
 	const { returnValue, cryptoResult } = this.test.ctx;
-	return returnValue.should.be.fulfilledWith(cryptoResult);
+	return returnValue.should.eventually.eql(cryptoResult);
 }
 
 export function itShouldDecryptTheMessageUsingTheNonceThePassphraseAndTheSenderPublicKey() {
@@ -76,7 +76,7 @@ export function itShouldDecryptTheMessageUsingTheNonceThePassphraseAndTheSenderP
 
 export function itShouldResolveToTheResultOfDecryptingTheMessage() {
 	const { returnValue, cryptoResult } = this.test.ctx;
-	return returnValue.should.be.fulfilledWith(cryptoResult);
+	return returnValue.should.eventually.eql(cryptoResult);
 }
 
 export function itShouldEncryptTheMessageWithThePassphraseForTheRecipient() {
@@ -90,7 +90,7 @@ export function itShouldEncryptTheMessageWithThePassphraseForTheRecipient() {
 
 export function itShouldResolveToTheResultOfEncryptingTheMessage() {
 	const { returnValue, cryptoResult } = this.test.ctx;
-	return returnValue.should.be.fulfilledWith(cryptoResult);
+	return returnValue.should.eventually.eql(cryptoResult);
 }
 
 export function itShouldResolveToAnObjectWithThePassphraseAndThePublicKeyAndTheAddress() {
@@ -105,7 +105,7 @@ export function itShouldResolveToAnObjectWithThePassphraseAndThePublicKeyAndTheA
 		publicKey,
 		address,
 	};
-	return returnValue.should.be.fulfilledWith(expectedObject);
+	return returnValue.should.eventually.eql(expectedObject);
 }
 
 export function theSignatureShouldBeReturned() {
@@ -215,12 +215,12 @@ export function theDecryptedMessageShouldBeReturned() {
 
 export function itShouldResolveToThePassphrase() {
 	const { returnValue, passphrase } = this.test.ctx;
-	return returnValue.should.be.fulfilledWith(passphrase);
+	return returnValue.should.eventually.eql(passphrase);
 }
 
 export function itShouldReturnAnObjectWithThePassphrase() {
 	const { returnValue, passphrase } = this.test.ctx;
-	return returnValue.should.be.fulfilledWith({
+	return returnValue.should.eventually.eql({
 		passphrase,
 		secondPassphrase: null,
 		password: null,
@@ -230,7 +230,7 @@ export function itShouldReturnAnObjectWithThePassphrase() {
 
 export function itShouldReturnAnObjectWithTheSecondPassphrase() {
 	const { returnValue, secondPassphrase } = this.test.ctx;
-	return returnValue.should.be.fulfilledWith({
+	return returnValue.should.eventually.eql({
 		passphrase: null,
 		secondPassphrase,
 		password: null,
@@ -240,7 +240,7 @@ export function itShouldReturnAnObjectWithTheSecondPassphrase() {
 
 export function itShouldReturnAnObjectWithThePassword() {
 	const { returnValue, password } = this.test.ctx;
-	return returnValue.should.be.fulfilledWith({
+	return returnValue.should.eventually.eql({
 		passphrase: null,
 		secondPassphrase: null,
 		password,
@@ -250,7 +250,7 @@ export function itShouldReturnAnObjectWithThePassword() {
 
 export function itShouldReturnAnObjectWithTheData() {
 	const { returnValue, data } = this.test.ctx;
-	return returnValue.should.be.fulfilledWith({
+	return returnValue.should.eventually.eql({
 		passphrase: null,
 		secondPassphrase: null,
 		password: null,
@@ -266,7 +266,7 @@ export function itShouldReturnAnObjectWithThePassphraseTheSecondPassphraseThePas
 		password,
 		data,
 	} = this.test.ctx;
-	return returnValue.should.be.fulfilledWith({
+	return returnValue.should.eventually.eql({
 		passphrase,
 		secondPassphrase,
 		password,

test/steps/files/3_then.js

@@ -64,10 +64,10 @@ export function theDefaultConfigShouldBeWrittenToTheConfigFile() {
 }
 
 export function theConfigFileShouldNotBeWritten() {
-	return fsUtils.writeJSONSync.should.not.be.called();
+	return fsUtils.writeJSONSync.should.not.be.called;
 }
 
 export function itShouldResolveToTheFirstLineOfTheFile() {
 	const { returnValue, passphrase } = this.test.ctx;
-	return returnValue.should.be.fulfilledWith(passphrase);
+	return returnValue.should.eventually.eql(passphrase);
 }

test/steps/general/3_then.js

@@ -14,7 +14,7 @@
  *
  */
 import { getFirstQuotedString, getFirstNumber } from '../utils';
-import { FileSystemError, ValidationError } from '../../../src/utils/error';
+import { ValidationError, FileSystemError } from '../../../src/utils/error';
 
 export function theErrorShouldBeInstanceOfNodesBuiltInError() {
 	const { testError } = this.test.ctx;
@@ -35,13 +35,17 @@ export function itShouldReturnTheResult() {
 export function itShouldThrowValidationError() {
 	const { testFunction } = this.test.ctx;
 	const message = getFirstQuotedString(this.test.title);
-	return testFunction.should.throw(new ValidationError(message));
+	return testFunction.should
+		.throw()
+		.and.be.customError(new ValidationError(message));
 }
 
 export function itShouldThrowFileSystemError() {
 	const { testFunction } = this.test.ctx;
 	const message = getFirstQuotedString(this.test.title);
-	return testFunction.should.throw(new FileSystemError(message));
+	return testFunction.should
+		.throw()
+		.and.be.customError(new FileSystemError(message));
 }
 
 export function itShouldExitWithCode() {
@@ -52,7 +56,7 @@ export function itShouldExitWithCode() {
 
 export function itShouldResolveToTheErrorObject() {
 	const { returnValue, errorObject } = this.test.ctx;
-	return returnValue.should.be.fulfilledWith(errorObject);
+	return returnValue.should.eventually.eql(errorObject);
 }
 
 export async function itShouldResolveToAnObjectWithMessage() {
@@ -82,13 +86,17 @@ export function itShouldRejectWithTheErrorMessage() {
 export function itShouldRejectWithFileSystemErrorAndMessage() {
 	const { returnValue } = this.test.ctx;
 	const message = getFirstQuotedString(this.test.title);
-	return returnValue.should.be.rejectedWith(new FileSystemError(message));
+	return returnValue.should.be.rejected.then(err => {
+		return err.should.be.customError(new FileSystemError(message));
+	});
 }
 
 export function itShouldRejectWithValidationErrorAndMessage() {
 	const { returnValue } = this.test.ctx;
 	const message = getFirstQuotedString(this.test.title);
-	return returnValue.should.be.rejectedWith(new ValidationError(message));
+	return returnValue.should.be.rejected.then(err => {
+		return err.should.be.customError(new ValidationError(message));
+	});
 }
 
 export function itShouldRejectWithMessage() {
@@ -104,22 +112,22 @@ export function itShouldRejectWithTheOriginalRejection() {
 
 export function itShouldReturnAnEmptyObject() {
 	const { returnValue } = this.test.ctx;
-	return returnValue.should.be.fulfilledWith({});
+	return returnValue.should.eventually.eql({});
 }
 
 export function itShouldReturnTrue() {
 	const { returnValue } = this.test.ctx;
-	return returnValue.should.be.true();
+	return returnValue.should.be.true;
 }
 
 export function itShouldReturnFalse() {
 	const { returnValue } = this.test.ctx;
-	return returnValue.should.be.false();
+	return returnValue.should.be.false;
 }
 
 export function itShouldReturnNull() {
 	const { returnValue } = this.test.ctx;
-	return should(returnValue).be.null();
+	return should.equal(returnValue, null);
 }
 
 export function itShouldReturnString() {
@@ -131,12 +139,12 @@ export function itShouldReturnString() {
 
 export function itShouldResolveToTheOptions() {
 	const { options, returnValue } = this.test.ctx;
-	return returnValue.should.be.fulfilledWith(options);
+	return returnValue.should.eventually.eql(options);
 }
 
 export function itShouldResolveToTheDataAsAString() {
 	const { returnValue, data } = this.test.ctx;
-	return returnValue.should.be.fulfilledWith(data);
+	return returnValue.should.eventually.eql(data);
 }
 
 export function itShouldReturnAnObjectWithError() {
@@ -149,10 +157,10 @@ export function itShouldReturnAnObjectWithError() {
 
 export function itShouldResolveToTheWarrantyInformation() {
 	const { returnValue, warranty } = this.test.ctx;
-	return returnValue.should.be.fulfilledWith({ warranty });
+	return returnValue.should.eventually.eql({ warranty });
 }
 
 export function itShouldResolveToTheCopyrightInformation() {
 	const { returnValue, copyright } = this.test.ctx;
-	return returnValue.should.be.fulfilledWith({ copyright });
+	return returnValue.should.eventually.eql({ copyright });
 }