Skip to content

fix (tests): Suppress console output in tests #181

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 30, 2018
Merged

fix (tests): Suppress console output in tests #181

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1d9673d
Remove unwanted console log output in tests
Oct 27, 2018
1ddd9e0
Use lodash find - tests run in older browsers
Oct 29, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion packages/optimizely-sdk/lib/core/bucketer/index.tests.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -312,7 +312,10 @@ describe('lib/core/bucketer', function() {
});

describe('testBucketWithBucketingId', function() {
var createdLogger = logger.createLogger({logLevel: LOG_LEVEL.INFO});
var createdLogger = logger.createLogger({
logLevel: LOG_LEVEL.INFO,
logToConsole: false,
});

beforeEach(function() {
configObj = projectConfig.createProjectConfig(testData);
Expand Down
7 changes: 4 additions & 3 deletions packages/optimizely-sdk/lib/core/decision_service/index.tests.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -333,7 +333,10 @@ describe('lib/core/decision_service', function() {

describe('when a bucketingID is provided', function() {
var configObj = projectConfig.createProjectConfig(testData);
var createdLogger = logger.createLogger({logLevel: LOG_LEVEL.DEBUG});
var createdLogger = logger.createLogger({
logLevel: LOG_LEVEL.DEBUG,
logToConsole: false,
});
var optlyInstance;
beforeEach(function () {
optlyInstance = new Optimizely({
Expand All @@ -349,13 +352,11 @@ describe('lib/core/decision_service', function() {

sinon.stub(eventDispatcher, 'dispatchEvent');
sinon.stub(errorHandler, 'handleError');
sinon.stub(createdLogger, 'log');
});

afterEach(function () {
eventDispatcher.dispatchEvent.restore();
errorHandler.handleError.restore();
createdLogger.log.restore();
});

var testUserAttributes = {
Expand Down
20 changes: 6 additions & 14 deletions packages/optimizely-sdk/lib/core/project_config/index.tests.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -565,13 +565,9 @@ describe('lib/core/project_config', function() {
});

describe('#getForcedVariation', function() {
var createdLogger = logger.createLogger({logLevel: LOG_LEVEL.INFO});
beforeEach(function() {
sinon.stub(createdLogger, 'log');
});

afterEach(function() {
createdLogger.log.restore();
var createdLogger = logger.createLogger({
logLevel: LOG_LEVEL.INFO,
logToConsole: false,
});

it('should return null for valid experimentKey, not set', function() {
Expand All @@ -592,13 +588,9 @@ describe('lib/core/project_config', function() {
});

describe('#setForcedVariation', function() {
var createdLogger = logger.createLogger({logLevel: LOG_LEVEL.INFO});
beforeEach(function() {
sinon.stub(createdLogger, 'log');
});

afterEach(function() {
createdLogger.log.restore();
var createdLogger = logger.createLogger({
logLevel: LOG_LEVEL.INFO,
logToConsole: false,
});

it('should return true for a valid forcedVariation in setForcedVariation', function() {
Expand Down
81 changes: 53 additions & 28 deletions packages/optimizely-sdk/lib/index.browser.tests.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
*/
var configValidator = require('./utils/config_validator');
var enums = require('./utils/enums');
var logger = require('./plugins/logger');
var Optimizely = require('./optimizely');
var optimizelyFactory = require('./index.browser');
var packageJSON = require('../package.json');
Expand All @@ -23,6 +24,7 @@ var testData = require('./tests/test_data');

var chai = require('chai');
var assert = chai.assert;
var find = require('lodash/find');
var sinon = require('sinon');

describe('javascript-sdk', function() {
Expand All @@ -32,9 +34,13 @@ describe('javascript-sdk', function() {
describe('createInstance', function() {
var fakeErrorHandler = { handleError: function() {}};
var fakeEventDispatcher = { dispatchEvent: function() {}};
var fakeLogger = { log: function() {}};
var silentLogger;

beforeEach(function() {
silentLogger = logger.createLogger({
logLevel: enums.LOG_LEVEL.INFO,
logToConsole: false,
});
sinon.spy(console, 'error');
sinon.stub(configValidator, 'validate');

Expand All @@ -57,6 +63,7 @@ describe('javascript-sdk', function() {
assert.doesNotThrow(function() {
optimizelyFactory.createInstance({
datafile: {},
logger: silentLogger,
});
});
});
Expand All @@ -66,7 +73,7 @@ describe('javascript-sdk', function() {
datafile: {},
errorHandler: fakeErrorHandler,
eventDispatcher: fakeEventDispatcher,
logger: fakeLogger,
logger: silentLogger,
});

assert.instanceOf(optlyInstance, Optimizely);
Expand All @@ -77,35 +84,18 @@ describe('javascript-sdk', function() {
datafile: {},
errorHandler: fakeErrorHandler,
eventDispatcher: fakeEventDispatcher,
logger: fakeLogger,
logger: silentLogger,
});
assert.equal('javascript-sdk', optlyInstance.clientEngine);
assert.equal(packageJSON.version, optlyInstance.clientVersion);
});

it('should instantiate the logger with a custom logLevel when provided', function() {
var optlyInstance = optimizelyFactory.createInstance({
datafile: {},
logLevel: enums.LOG_LEVEL.ERROR,
});

assert.equal(optlyInstance.logger.logLevel, enums.LOG_LEVEL.ERROR);
});

it('should default to INFO when no logLevel is provided', function() {
var optlyInstance = optimizelyFactory.createInstance({
datafile: {},
});

assert.equal(optlyInstance.logger.logLevel, enums.LOG_LEVEL.INFO);
});

it('should activate with provided event dispatcher', function(done) {
var optlyInstance = optimizelyFactory.createInstance({
datafile: testData.getTestProjectConfig(),
errorHandler: fakeErrorHandler,
eventDispatcher: eventDispatcher,
logger: fakeLogger,
logger: silentLogger,
});
var activate = optlyInstance.activate('testExperiment', 'testUser');
assert.strictEqual(activate, 'control');
Expand All @@ -117,7 +107,7 @@ describe('javascript-sdk', function() {
datafile: testData.getTestProjectConfig(),
errorHandler: fakeErrorHandler,
eventDispatcher: eventDispatcher,
logger: fakeLogger,
logger: silentLogger,
});

var didSetVariation = optlyInstance.setForcedVariation('testExperiment', 'testUser', 'control');
Expand All @@ -133,7 +123,7 @@ describe('javascript-sdk', function() {
datafile: testData.getTestProjectConfig(),
errorHandler: fakeErrorHandler,
eventDispatcher: eventDispatcher,
logger: fakeLogger,
logger: silentLogger,
});

var didSetVariation = optlyInstance.setForcedVariation('testExperiment', 'testUser', 'control');
Expand All @@ -155,7 +145,7 @@ describe('javascript-sdk', function() {
datafile: testData.getTestProjectConfig(),
errorHandler: fakeErrorHandler,
eventDispatcher: eventDispatcher,
logger: fakeLogger,
logger: silentLogger,
});

var didSetVariation = optlyInstance.setForcedVariation('testExperiment', 'testUser', 'control');
Expand All @@ -178,7 +168,7 @@ describe('javascript-sdk', function() {
datafile: testData.getTestProjectConfig(),
errorHandler: fakeErrorHandler,
eventDispatcher: eventDispatcher,
logger: fakeLogger,
logger: silentLogger,
});

var didSetVariation = optlyInstance.setForcedVariation('testExperiment', 'testUser', 'control');
Expand All @@ -203,7 +193,7 @@ describe('javascript-sdk', function() {
datafile: testData.getTestProjectConfig(),
errorHandler: fakeErrorHandler,
eventDispatcher: eventDispatcher,
logger: fakeLogger,
logger: silentLogger,
});

var didSetVariation = optlyInstance.setForcedVariation('testExperiment', 'testUser', 'control');
Expand All @@ -228,7 +218,7 @@ describe('javascript-sdk', function() {
datafile: testData.getTestProjectConfig(),
errorHandler: fakeErrorHandler,
eventDispatcher: eventDispatcher,
logger: fakeLogger,
logger: silentLogger,
});

var didSetVariation = optlyInstance.setForcedVariation('testExperiment', 'testUser', 'control');
Expand All @@ -250,7 +240,7 @@ describe('javascript-sdk', function() {
datafile: testData.getTestProjectConfig(),
errorHandler: fakeErrorHandler,
eventDispatcher: eventDispatcher,
logger: fakeLogger,
logger: silentLogger,
});

var didSetVariation = optlyInstance.setForcedVariation('testExperimentNotRunning', 'testUser', 'controlNotRunning');
Expand All @@ -261,6 +251,41 @@ describe('javascript-sdk', function() {

done();
});

describe('automatically created logger instances', function() {
beforeEach(function() {
sinon.stub(logger, 'createLogger').callsFake(function() {
return {
log: function() {},
};
});
});

afterEach(function() {
logger.createLogger.restore();
});

it('should instantiate the logger with a custom logLevel when provided', function() {
var optlyInstance = optimizelyFactory.createInstance({
datafile: testData.getTestProjectConfig(),
logLevel: enums.LOG_LEVEL.ERROR,
});
var foundCall = find(logger.createLogger.getCalls(), function(call) {
return call.returned(sinon.match.same(optlyInstance.logger));
});
assert.strictEqual(foundCall.args[0].logLevel, enums.LOG_LEVEL.ERROR);
});

it('should default to INFO when no logLevel is provided', function() {
var optlyInstance = optimizelyFactory.createInstance({
datafile: testData.getTestProjectConfig(),
});
var foundCall = find(logger.createLogger.getCalls(), function(call) {
return call.returned(sinon.match.same(optlyInstance.logger));
});
assert.strictEqual(foundCall.args[0].logLevel, enums.LOG_LEVEL.INFO);
});
});
});
});
});
15 changes: 8 additions & 7 deletions packages/optimizely-sdk/lib/index.node.tests.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,37 +28,38 @@ describe('optimizelyFactory', function() {
describe('createInstance', function() {
var fakeErrorHandler = { handleError: function() {}};
var fakeEventDispatcher = { dispatchEvent: function() {}};
var fakeLogger = { log: function() {}};
var fakeLogger;

beforeEach(function() {
sinon.spy(console, 'error');
fakeLogger = { log: sinon.spy() };
sinon.stub(logger, 'createLogger').returns(fakeLogger);
sinon.stub(configValidator, 'validate');
});

afterEach(function() {
console.error.restore();
logger.createLogger.restore();
configValidator.validate.restore();
});

it('should not throw if the provided config is not valid and call console.error if logger is passed in', function() {
it('should not throw if the provided config is not valid and log an error if logger is passed in', function() {
configValidator.validate.throws(new Error('Invalid config or something'));
assert.doesNotThrow(function() {
optimizelyFactory.createInstance({
datafile: {},
logger: logger.createLogger({ logLevel: enums.LOG_LEVEL.INFO }),
});
});
assert.isTrue(console.error.called);
sinon.assert.calledWith(fakeLogger.log, enums.LOG_LEVEL.ERROR);
});

it('should not throw if the provided config is not valid and call console.error if no-op logger is used', function() {
it('should not throw if the provided config is not valid and log an error if no-op logger is used', function() {
configValidator.validate.throws(new Error('Invalid config or something'));
assert.doesNotThrow(function() {
optimizelyFactory.createInstance({
datafile: {},
});
});
assert.isTrue(console.error.called);
sinon.assert.calledWith(fakeLogger.log, enums.LOG_LEVEL.ERROR);
});

it('should create an instance of optimizely', function() {
Expand Down
Loading