analogger 1.4.0 → 1.5.2

package/test/unit.cjs

@@ -1,455 +0,0 @@
-const chai = require("chai");
-const assertArrays = require("chai-arrays")
-const expect = chai.expect;
-const sinon = require("sinon");
-
-let alert, sandbox;
-
-// Arrange
-const myStub = {
-    myMethod: () => { }
-}
-
-
-const spies = require('chai-spies');
-
-chai.use(spies);
-chai.use(assertArrays)
-
-// sut
-const {anaLogger} = require("../src/cjs/ana-logger.cjs");
-const {LOG_CONTEXTS, LOG_TARGETS} = require("../example/cjs/contexts-def.cjs");
-
-describe('AnaLogger', function ()
-{
-    before(() =>
-    {
-        anaLogger.setContexts(LOG_CONTEXTS);
-        anaLogger.setTargets(LOG_TARGETS);
-        anaLogger.setActiveTarget(LOG_TARGETS.DEV3)
-        anaLogger.removeOverride({error: true})
-    })
-
-    beforeEach(() =>
-    {
-        alert = sinon.spy()
-        chai.spy.on(myStub, 'myMethod');
-
-        anaLogger.resetLogHistory()
-        anaLogger.keepLogHistory()
-        anaLogger.resetLogFormatter();
-    })
-
-    afterEach(()=>
-    {
-        chai.spy.restore(myStub.myMethod)
-    })
-
-    describe('#isContextValid()', function ()
-    {
-        it('should be true when a valid context object is passed', function ()
-        {
-            // Arrange
-            const context = LOG_CONTEXTS.TEST
-            // Act
-            const result = anaLogger.isContextValid(context)
-            // Assert
-            expect(result).to.be.true
-        });
-
-        it('should be false when an invalid context object is passed', function ()
-        {
-            // Arrange
-            const context = {}
-            // Act
-            const result = anaLogger.isContextValid(context)
-            // Assert
-            expect(result).to.be.false
-        });
-
-        it('should be false when a null context is passed', function ()
-        {
-            // Act
-            const result = anaLogger.isContextValid(null)
-            // Assert
-            expect(result).to.be.false
-        });
-    });
-
-    describe('#setOptions()', function ()
-    {
-        it('should have an option to silent the log', function ()
-        {
-            anaLogger.setOptions({silent: true})
-            const options = anaLogger.getOptions()
-            expect(options.silent).to.be.true
-        });
-    });
-
-    describe('#log()', function ()
-    {
-        it('should emulate console.log', function ()
-        {
-            // Arrange
-            anaLogger.setOptions({silent: false, hideError: false})
-
-            // Act
-            anaLogger.log(`Test Log example C1`);
-            const output = anaLogger.getLogHistory()
-
-            // Assert
-            expect(output).to.contain(`Test Log example C1`)
-        });
-
-        it('should understand values passed with context', function ()
-        {
-            // Act
-            anaLogger.log(LOG_CONTEXTS.C1, `Test Log example C1`);
-
-            // Assert
-            expect(anaLogger.getLogHistory()).to.contain(`Test Log example C1`)
-        });
-
-        it('should understand values passed with context as value of object', function ()
-        {
-            // Act
-            anaLogger.log({context: LOG_CONTEXTS.C1}, `Test Log example C1`);
-
-            // Assert
-            expect(anaLogger.getLogHistory()).to.contain(`Test Log example C1`)
-        });
-
-        it('should understand values passed with context defined as null', function ()
-        {
-            // Act
-            anaLogger.log({context: null}, `Test Log example C1`);
-
-            // Assert
-            expect(anaLogger.getLogHistory()).to.contain(`Test Log example C1`)
-        });
-
-        it('should populate history even though the hidelog option is on', function ()
-        {
-            anaLogger.setOptions({hideLog: true})
-
-            // Act
-            anaLogger.log({context: LOG_CONTEXTS.C1, lid: 123456789233}, `The hidden log`);
-
-            // Assert
-            expect(anaLogger.getLogHistory()).to.contain(`The hidden log`)
-        });
-
-        it('should not capture or display log from another defined target', function ()
-        {
-            anaLogger.setActiveTarget(LOG_TARGETS.DEV3)
-            anaLogger.log({target: LOG_TARGETS.DEV1}, `I am for DEV1`);
-
-            // Assert
-            expect(anaLogger.getLogHistory()).to.not.contain(`I am for DEV1`)
-        });
-
-        it('should capture logs when no active target is set', function ()
-        {
-            anaLogger.setActiveTarget(null)
-            anaLogger.log({target: LOG_TARGETS.DEV3}, `I am for DEV3`);
-
-            // Assert
-            expect(anaLogger.getLogHistory()).to.contain(`I am for DEV3`)
-        });
-
-        it('should capture logs from the same target', function ()
-        {
-            anaLogger.setActiveTarget(LOG_TARGETS.DEV3)
-            anaLogger.log({target: LOG_TARGETS.DEV3}, `I am for DEV3`);
-
-            // Assert
-            expect(anaLogger.getLogHistory()).to.contain(`I am for DEV3`)
-        });
-
-        it('should capture logs from the same target', function ()
-        {
-            anaLogger.log(LOG_CONTEXTS.TEST2, `I am for DEV3`);
-
-            // Assert
-            expect(anaLogger.getLogHistory()).to.contain(`I am for DEV3`)
-        });
-
-        it('should truncate some text when too long', function ()
-        {
-            // Act
-            anaLogger.log({
-                context: LOG_CONTEXTS.C1,
-                lid    : 123456789233
-            }, `The super long Log ID (lid) will be truncated`);
-
-            // Assert
-            expect(anaLogger.getLogHistory()).to.contain(`C1: (12... )`)
-        });
-
-
-    });
-
-    describe('#error()', function ()
-    {
-        it('should not show up when hideError mode is on', function ()
-        {
-            // Arrange
-            anaLogger.setOptions({hideError: true})
-
-            // Act
-            anaLogger.error(`Test Log example C1`);
-
-            // Assert
-            expect(anaLogger.getLogHistory()).to.not.contain(`Test Log example C1`)
-        });
-
-        it('should not show up when hideError mode is off', function ()
-        {
-            // Arrange
-            anaLogger.setOptions({hideError: false})
-
-            // Act
-            anaLogger.error(`Test Log example C1`);
-
-            // Assert
-            expect(anaLogger.getLogHistory()).to.contain(`Test Log example C1`)
-        });
-    });
-
-    describe('#info()', function ()
-    {
-        it('should display some log', function ()
-        {
-            anaLogger.info(`Hello from info`)
-            expect(anaLogger.getLogHistory()).to.contain(`Hello from info`)
-        });
-    });
-
-    describe('#warn()', function ()
-    {
-        it('should display some warn', function ()
-        {
-            anaLogger.warn(`Hello from warn`)
-            expect(anaLogger.getLogHistory()).to.contain(`Hello from warn`)
-        });
-    });
-
-    describe('#alert()', function ()
-    {
-        it('should not fail on alert', function ()
-        {
-            anaLogger.alert(`Hello from alert`, {aaa: 1012})
-            expect(anaLogger.getLogHistory()).to.contain(`Hello from alert`)
-        });
-
-        describe("in a non-Node environment", function ()
-        {
-            beforeEach(function ()
-            {
-                sandbox = sinon.createSandbox();
-            });
-
-
-            it('should be called', function ()
-            {
-                sandbox
-                    .stub(anaLogger, "isNode")
-                    .withArgs("Hello from alert")
-                    .returns(
-                        true
-                    );
-
-                chai.expect(() => anaLogger.alert(`Hello from alert`)).to.throw(`alert is not defined`);
-            });
-
-            afterEach(function ()
-            {
-                sandbox.restore();
-            });
-        })
-
-    });
-
-    describe('#assert()', function ()
-    {
-        it('should evaluate condition expressions', function ()
-        {
-            const result = anaLogger.assert(1 === 1)
-            expect(result).to.be.true
-        });
-
-        it('should detect failing condition expressions', function ()
-        {
-            const result = anaLogger.assert(1 === 2)
-            expect(result).to.be.false
-        });
-
-        it('should evaluate function expressions', function ()
-        {
-            const result = anaLogger.assert(() => true, true)
-            expect(result).to.be.true
-        });
-
-        it('should fail when function expressions fail', function ()
-        {
-            const result = anaLogger.assert(() => false, true)
-            expect(result).to.be.false
-        });
-
-        it('should evaluate more complex function expressions', function ()
-        {
-            const result = anaLogger.assert((a, b) => a === b, true, 2, 2)
-            expect(result).to.be.true
-        });
-
-        it('should not break the code when an invalid function is passed', function ()
-        {
-            expect(anaLogger.assert(() => nonExistentFunctionThatIsCalledAnyway(), true, 2, 2)
-            ).to.be.false
-        });
-    });
-
-    describe('#overrideConsole()', function ()
-    {
-        it('should override the console behaviour', function ()
-        {
-            anaLogger.overrideConsole({error: true})
-            console.log(`Test 1`)
-            expect(anaLogger.getLogHistory()).to.contain(`Test 1`)
-        });
-    });
-
-    describe('#setLogFormat()', function ()
-    {
-        /**
-         * We use a spy here, but things would have been straightforward with a simple "done" + async on the "it"
-         */
-        it('should replace the default formatter function with the given callback when invoking console.log', function ()
-        {
-            beforeEach(function ()
-            {
-            })
-
-            afterEach(function ()
-            {
-                chai.spy.restore(myStub.myMethod)
-            })
-
-            anaLogger.setLogFormat(
-                myStub.myMethod
-            );
-
-            console.log(LOG_CONTEXTS.C1, `Test Log example C4 with new format`);
-            expect(myStub.myMethod).to.have.been.called;
-        });
-
-        it("should reset the formatter to its first value", () =>
-        {
-            anaLogger.setLogFormat(
-                () => "If you see this the test has failed"
-            );
-            anaLogger.resetLogFormatter();
-            anaLogger.log(LOG_CONTEXTS.C1, `Test Log example C4 with new format`);
-            expect(anaLogger.getLogHistory()).to.contain(`C1: (      )`)
-        })
-
-        it("should reject invalid formatters", () =>
-        {
-            const res = anaLogger.setLogFormat(null);
-            expect(res).to.be.false
-        })
-    });
-
-    describe('#releaseLogHistory()', function ()
-    {
-        it('should not keep log history', function ()
-        {
-            anaLogger.releaseLogHistory()
-            anaLogger.log(`Hello you`)
-            expect(anaLogger.getLogHistory().length).to.equal(0)
-        });
-    });
-
-    describe('#getLogHistory()', function ()
-    {
-        it('should return history as a string', function ()
-        {
-            anaLogger.log(`Hello you`)
-            const arr = anaLogger.getLogHistory()
-            expect(arr).to.be.string
-        });
-
-        it('should return history as an array', function ()
-        {
-            anaLogger.log(`Hello you`)
-            const arr = anaLogger.getLogHistory(false)
-            expect(arr).to.be.array()
-        });
-
-        it('should return history as an array', function ()
-        {
-            anaLogger.log(`Hello you`)
-            const arr = anaLogger.getLogHistory(false)
-            expect(arr).to.be.array()
-        });
-    });
-
-    describe('#setErrorHandler()', function ()
-    {
-        it('should replace the error manager', function ()
-        {
-            anaLogger.setActiveTarget(LOG_TARGETS.USER)
-            anaLogger.error({target: LOG_TARGETS.USER}, `Test Error Log`);
-        });
-
-        it('should replace the error manager', function ()
-        {
-            anaLogger.setErrorHandler(
-                myStub.myMethod
-            );
-
-            console.error(`Test Error Log`);
-            expect(myStub.myMethod).to.have.been.called;
-        });
-
-        it('should replace the error manager targeting the user', function ()
-        {
-            anaLogger.setActiveTarget(LOG_TARGETS.USER)
-            anaLogger.setErrorHandler(
-                myStub.myMethod
-            );
-
-            anaLogger.error(`Test Error Log`);
-            expect(myStub.myMethod).to.have.been.called;
-        });
-
-    });
-
-    describe('#setErrorHandlerForUserTarget()', function ()
-    {
-        it('should replace the error manager targetting the user', function ()
-        {
-            anaLogger.setActiveTarget(LOG_TARGETS.USER)
-            anaLogger.setErrorHandlerForUserTarget(
-                myStub.myMethod
-            );
-
-            anaLogger.error(`Test Error Log`);
-            expect(myStub.myMethod).to.have.been.called;
-        });
-
-        it('should replace the error manager targeting the user', function ()
-        {
-            anaLogger.setActiveTarget(LOG_TARGETS.USER)
-            anaLogger.setErrorHandlerForUserTarget(
-                myStub.myMethod
-            );
-
-            anaLogger.error(`Test Error Log`);
-            expect(myStub.myMethod).to.have.been.called;
-        });
-
-    });
-
-
-});