kayvee 3.18.0 → 4.0.0

package/build/test/logger_test.js

@@ -1,345 +0,0 @@
-var KayveeLogger = require("../lib/logger/logger");
-var assert = require("assert");
-let sample = "";
-function outputFunc(text) {
-    sample = text;
-    return sample;
-}
-describe("logger_test", () => {
-    let logObj = null;
-    let logObj2 = null;
-    beforeEach(() => {
-        logObj = new KayveeLogger("logger-tester");
-        sample = "";
-        return logObj.setOutput(outputFunc);
-    });
-    describe(".constructor", () => {
-        it("passing in parameters to constructor", () => {
-            const formatter = (data) => `${data.level}.${data.source}.${data.title}`;
-            logObj = new KayveeLogger("logger-test", KayveeLogger.Info, formatter, outputFunc);
-            logObj.debug("testlogdebug");
-            let expected = "";
-            assert.equal(sample, expected);
-            logObj.info("testloginfo");
-            expected = `${KayveeLogger.Info}.logger-test.testloginfo`;
-            assert.equal(sample, expected);
-        });
-    });
-    describe(".validateloglvl", () => {
-        // Explicit validation checks
-        it("is case-insensitive in log level name", () => {
-            let logLvl = logObj._validateLogLvl("debug");
-            assert.equal(logLvl, KayveeLogger.Debug);
-            logLvl = logObj._validateLogLvl("Debug");
-            assert.equal(logLvl, KayveeLogger.Debug);
-        });
-        it("sets non-default log levels", () => {
-            let logLvl = logObj._validateLogLvl("info");
-            assert.equal(logLvl, KayveeLogger.Info);
-            // TODO: for each possible log level ...
-            logLvl = logObj._validateLogLvl("critical");
-            assert.equal(logLvl, KayveeLogger.Critical);
-        });
-        it("sets level to Debug, if given an invalid log level", () => {
-            const logLvl = logObj._validateLogLvl("sometest");
-            assert.equal(logLvl, KayveeLogger.Debug);
-        });
-    });
-    describe(".invalidlog", () => {
-        it("check valid debug level JSON output of invalid log level", () => {
-            // Invalid log levels will default to debug
-            logObj.setLogLevel("invalidloglevel");
-            logObj.debug("testlogdebug");
-            let expected = `{"deploy_env": "testing", "wf_id": "abc", "source": "logger-tester", "level": "${KayveeLogger.Debug}", "title": "testlogdebug"}`;
-            assert.deepEqual(JSON.parse(sample), JSON.parse(expected));
-            logObj.setLogLevel("sometest");
-            logObj.info("testloginfo");
-            expected = `{"deploy_env": "testing", "wf_id": "abc", "source": "logger-tester", "level": "${KayveeLogger.Info}", "title": "testloginfo"}`;
-            assert.deepEqual(JSON.parse(sample), JSON.parse(expected));
-        });
-    });
-    describe(".debug", () => {
-        it("test debug function", () => {
-            logObj.debug("testlogdebug");
-            const expected = `{"deploy_env": "testing", "wf_id": "abc", "source": "logger-tester", "level": "${KayveeLogger.Debug}", "title": "testlogdebug"}`;
-            assert.deepEqual(JSON.parse(sample), JSON.parse(expected));
-        });
-        it("test debugD function", () => {
-            logObj.debugD("testlogdebug", { key1: "val1", key2: "val2" });
-            const expected = `{"deploy_env": "testing", "wf_id": "abc", "source": "logger-tester",
-"level": "${KayveeLogger.Debug}", "title": "testlogdebug","key1": "val1", "key2": "val2"}`;
-            assert.deepEqual(JSON.parse(sample), JSON.parse(expected));
-        });
-    });
-    describe(".info", () => {
-        it("test info function", () => {
-            logObj.info("testloginfo");
-            const expected = `{"deploy_env": "testing", "wf_id": "abc", "source": "logger-tester", "level": "${KayveeLogger.Info}", "title": "testloginfo"}`;
-            assert.deepEqual(JSON.parse(sample), JSON.parse(expected));
-        });
-        it("test infoD function", () => {
-            logObj.infoD("testloginfo", { key1: "val1", key2: "val2" });
-            const expected = `{"deploy_env": "testing", "wf_id": "abc", "source": "logger-tester",
-"level": "${KayveeLogger.Info}", "title": "testloginfo","key1": "val1", "key2": "val2"}`;
-            assert.deepEqual(JSON.parse(sample), JSON.parse(expected));
-        });
-    });
-    describe(".warning", () => {
-        it("test warn function", () => {
-            logObj.warn("testlogwarning");
-            const expected = `{"deploy_env": "testing", "wf_id": "abc", "source": "logger-tester", "level": "${KayveeLogger.Warning}", "title": "testlogwarning"}`;
-            assert.deepEqual(JSON.parse(sample), JSON.parse(expected));
-        });
-        it("test warnD function", () => {
-            logObj.warnD("testlogwarning", { key1: "val1", key2: "val2" });
-            const expected = `{"deploy_env": "testing", "wf_id": "abc", "source": "logger-tester",
-"level": "${KayveeLogger.Warning}", "title": "testlogwarning","key1": "val1", "key2": "val2"}`;
-            assert.deepEqual(JSON.parse(sample), JSON.parse(expected));
-        });
-    });
-    describe(".error", () => {
-        it("test error function", () => {
-            logObj.error("testlogerror");
-            const expected = `{"deploy_env": "testing", "wf_id": "abc", "source": "logger-tester", "level": "${KayveeLogger.Error}", "title": "testlogerror"}`;
-            assert.deepEqual(JSON.parse(sample), JSON.parse(expected));
-        });
-        it("test errorD function", () => {
-            logObj.errorD("testlogerror", { key1: "val1", key2: "val2" });
-            const expected = `{"deploy_env": "testing", "wf_id": "abc", "source": "logger-tester",
-"level": "${KayveeLogger.Error}", "title": "testlogerror","key1": "val1", "key2": "val2"}`;
-            assert.deepEqual(JSON.parse(sample), JSON.parse(expected));
-        });
-    });
-    describe(".critical", () => {
-        it("test critical function", () => {
-            logObj.critical("testlogcritical");
-            const expected = `{"deploy_env": "testing", "wf_id": "abc", "source": "logger-tester", "level": "${KayveeLogger.Critical}", "title": "testlogcritical"}`;
-            assert.deepEqual(JSON.parse(sample), JSON.parse(expected));
-        });
-        it("test criticalD function", () => {
-            logObj.criticalD("testlogcritical", { key1: "val1", key2: "val2" });
-            const expected = `{"deploy_env": "testing", "wf_id": "abc", "source": "logger-tester",
-"level": "${KayveeLogger.Critical}", "title": "testlogcritical","key1": "val1", "key2": "val2"}`;
-            assert.deepEqual(JSON.parse(sample), JSON.parse(expected));
-        });
-    });
-    describe(".counter", () => {
-        it("test counter function", () => {
-            logObj.counter("testlogcounter");
-            const expected = `{"deploy_env": "testing", "wf_id": "abc", "source": "logger-tester",
-"level": "${KayveeLogger.Info}", "title": "testlogcounter", "type": "counter", "value": 1}`;
-            assert.deepEqual(JSON.parse(sample), JSON.parse(expected));
-        });
-        it("test counterD function", () => {
-            logObj.counterD("testlogcounter", 2, { key1: "val1", key2: "val2" });
-            const expected = `{"deploy_env": "testing", "wf_id": "abc", "source": "logger-tester",
-"level": "${KayveeLogger.Info}", "title": "testlogcounter","type": "counter", "value": 2,"key1": "val1",` +
-                ' "key2": "val2"}';
-            assert.deepEqual(JSON.parse(sample), JSON.parse(expected));
-        });
-        it("test counterD function with overrides", () => {
-            logObj.counterD("testlogcounter", 2, { key1: "val1", key2: "val2", value: 18 });
-            const expected = {
-                deploy_env: "testing",
-                wf_id: "abc",
-                source: "logger-tester",
-                level: KayveeLogger.Info,
-                title: "testlogcounter",
-                type: "counter",
-                value: 18,
-                key1: "val1",
-                key2: "val2",
-            };
-            assert.deepEqual(JSON.parse(sample), expected);
-        });
-    });
-    describe(".gauge", () => {
-        it("test gauge function", () => {
-            logObj.gauge("testloggauge", 0);
-            const expected = `{"deploy_env": "testing", "wf_id": "abc", "source": "logger-tester",
-"level": "${KayveeLogger.Info}", "title": "testloggauge", "type": "gauge", "value": 0}`;
-            assert.deepEqual(JSON.parse(sample), JSON.parse(expected));
-        });
-        it("test gaugeD function", () => {
-            logObj.gaugeD("testloggauge", 4, { key1: "val1", key2: "val2" });
-            const expected = `{"deploy_env": "testing", "wf_id": "abc", "source": "logger-tester",
-"level": "${KayveeLogger.Info}", "title": "testloggauge", "type": "gauge", "value": 4, "key1": "val1", "key2": "val2"}`;
-            assert.deepEqual(JSON.parse(sample), JSON.parse(expected));
-        });
-        it("test gaugeD function with overrids", () => {
-            logObj.gaugeD("testloggauge", 4, { key1: "val1", key2: "val2", value: 18 });
-            const expected = {
-                deploy_env: "testing",
-                wf_id: "abc",
-                source: "logger-tester",
-                level: KayveeLogger.Info,
-                title: "testloggauge",
-                type: "gauge",
-                value: 18,
-                key1: "val1",
-                key2: "val2",
-            };
-            assert.deepEqual(JSON.parse(sample), expected);
-        });
-    });
-    describe(".diffoutput", () => {
-        it("output to different output functions using same logger", () => {
-            logObj.info("testloginfo");
-            const infoLog = sample;
-            let output2 = "";
-            const outputFunc2 = (text) => {
-                output2 = text;
-                return output2;
-            };
-            logObj.setOutput(outputFunc2);
-            logObj.warn("testlogwarning");
-            assert.deepEqual(JSON.parse(infoLog), JSON.parse(sample));
-            assert.notDeepEqual(JSON.parse(output2), JSON.parse(sample));
-        });
-    });
-    describe(".nomodifydata", () => {
-        before(() => {
-            logObj.setOutput(outputFunc);
-        });
-        it("does not modify data", () => {
-            const data = {
-                str: "modify",
-                obj: {
-                    key: "value",
-                },
-                fun: "boo",
-            };
-            // not using deepClone since that's what we are
-            // somewhat testing
-            const dataCopy = {
-                str: "modify",
-                obj: {
-                    key: "value",
-                },
-                fun: "boo",
-            };
-            logObj.infoD("testInfoWithData", data);
-            assert.deepEqual(data, dataCopy);
-            const output = {
-                deploy_env: "testing",
-                wf_id: "abc",
-                fun: "boo",
-                level: "info",
-                obj: {
-                    key: "value",
-                },
-                source: "logger-tester",
-                title: "testInfoWithData",
-                str: "modify",
-            };
-            assert.deepEqual(JSON.parse(sample), output);
-        });
-    });
-    describe(".hiddenlog", () => {
-        describe(".logwarning", () => {
-            beforeEach(() => logObj.setLogLevel(KayveeLogger.Warning));
-            it("empty cases due to log level", () => {
-                logObj.debug("testlogdebug");
-                assert.equal(sample, "");
-                logObj.info("testloginfo");
-                assert.equal(sample, "");
-            });
-            it("not empty cases due to log level", () => {
-                logObj.warn("testlogwarning");
-                assert.notDeepEqual(JSON.parse(sample), "");
-                logObj.error("testlogerror");
-                assert.notDeepEqual(JSON.parse(sample), "");
-                logObj.critical("testlogcritical");
-                assert.notDeepEqual(JSON.parse(sample), "");
-            });
-        });
-        return describe(".logcritical", () => {
-            beforeEach(() => {
-                logObj.setLogLevel(KayveeLogger.Critical);
-            });
-            it("empty cases due to log level", () => {
-                logObj.debug("testlogdebug");
-                assert.equal(sample, "");
-                logObj.info("testloginfo");
-                assert.equal(sample, "");
-                logObj.warn("testlogwarning");
-                assert.equal(sample, "");
-                logObj.error("testlogerror");
-                assert.equal(sample, "");
-            });
-            it("not empty cases due to log level", () => {
-                logObj.critical("testlogcritical");
-                assert.notDeepEqual(JSON.parse(sample), "");
-            });
-        });
-    });
-    describe(".diffformat", () => {
-        it("use a different formatter than KV", () => {
-            const testFormatter = () => '"This is a test"';
-            logObj.setFormatter(testFormatter);
-            logObj.warn("testlogwarning");
-            assert.deepEqual(JSON.parse(sample), "This is a test");
-        });
-    });
-    describe("global overrides", () => {
-        it("what data has source prop", () => {
-            logObj.warnD("global-override", { source: "overrided" });
-            const output = {
-                deploy_env: "testing",
-                wf_id: "abc",
-                title: "global-override",
-                source: "overrided",
-                level: "warning",
-            };
-            assert.deepEqual(JSON.parse(sample), output);
-        });
-    });
-    return describe(".multipleloggers", () => {
-        before(() => {
-            logObj2 = new KayveeLogger("logger-tester2");
-            return logObj2;
-        });
-        it("log to same output buffer", () => {
-            logObj2.setOutput(outputFunc);
-            logObj.warn("testlogwarning");
-            const output1 = sample;
-            logObj2.info("testloginfo");
-            assert.notDeepEqual(JSON.parse(sample), JSON.parse(output1));
-        });
-        it("log to different output buffer", () => {
-            let output2 = "";
-            const outputFunc2 = (text) => {
-                output2 = text;
-                return output2;
-            };
-            logObj2.setOutput(outputFunc2);
-            logObj.warn("testlogwarning");
-            logObj2.info("testloginfo");
-            const loggerExpected = `
-      {"deploy_env": "testing", "wf_id": "abc", "source": "logger-tester", "level": "${KayveeLogger.Warning}", "title": "testlogwarning"}
-      `;
-            assert.deepEqual(JSON.parse(sample), JSON.parse(loggerExpected));
-            const logger2Expected = `{"deploy_env": "testing", "wf_id": "abc", "source": "logger-tester2", "level": "${KayveeLogger.Info}", "title": "testloginfo"}`;
-            assert.deepEqual(JSON.parse(output2), JSON.parse(logger2Expected));
-        });
-    });
-});
-describe("mockRouting", () => {
-    it("can override routing from setGlobalRouting, and captures routed logs", () => {
-        const logObj = new KayveeLogger("test-source");
-        KayveeLogger.mockRouting((kvdone) => {
-            KayveeLogger.setGlobalRouting("test/kvconfig.yml");
-            logObj.info("foo-title");
-            const ruleMatches = kvdone();
-            // should match one log
-            assert.equal(ruleMatches["rule-two"].length, 1);
-            // matched log should look like so
-            const expectedRule = {
-                type: "analytics",
-                series: "requests.everything",
-                rule: "rule-two",
-            };
-            assert.deepEqual(ruleMatches["rule-two"][0], expectedRule);
-        });
-    });
-});