logtunnel 0.4.0 → 1.1.0

package/test/pipeline.spec.js

@@ -1,16 +1,16 @@
 const Lab = require('@hapi/lab');
 const Code = require('@hapi/code');
-const { runPipeline, _, f, i, F, p, o, H } = require('./utils');
+const { runPipeline, _, f, i, F, p, o, H, k } = require('./utils');
 
 const { describe, it } = exports.lab = Lab.script();
 const { expect } = Code;
 
 describe('pipeline', () => {
-    it('should remove rejected lines and keep accepted ones', () => {
+    it('should remove rejected lines and keep accepted ones', async () => {
         const args = [
             f('potato')
         ];
-        const actual = runPipeline([
+        const actual = await runPipeline([
             'yada yada yada',
             'lorem ipsum POTATO dolor',
             'ablueblue POTATO',
@@ -24,13 +24,13 @@ describe('pipeline', () => {
         expect(actual).to.equal(expected);
     });
 
-    it('should apply multiple filters', () => {
+    it('should apply multiple filters', async () => {
         const args = [
             f('foo'),
             f('bar'),
             i('nope'),
         ];
-        const actual = runPipeline([
+        const actual = await runPipeline([
             '1. foo',
             '2. foo bar nope',
             '3. foo bar',
@@ -43,12 +43,12 @@ describe('pipeline', () => {
         expect(actual).to.equal(expected);
     });
 
-    it('should apply default argument as filter', () => {
+    it('should apply default argument as filter', async () => {
         const args = [
             _('foo'),
             i('bar'),
         ];
-        const actual = runPipeline([
+        const actual = await runPipeline([
             '1. foo',
             '2. foo bar',
             '3. baz',
@@ -60,12 +60,12 @@ describe('pipeline', () => {
         expect(actual).to.equal(expected);
     });
 
-    it('should parse and format correctly', () => {
+    it('should parse and format correctly', async () => {
         const args = [
             p('logfmt'),
             o('json'),
         ];
-        const actual = runPipeline([
+        const actual = await runPipeline([
             'foo=bar baz=qux',
         ], args);
         const expected = [
@@ -75,13 +75,31 @@ describe('pipeline', () => {
         expect(actual).to.equal(expected);
     });
 
-    it('should filter by the original line even when parsers and outputs are provided', () => {
+    it('should buffer and format tables when requested', async () => {
+        const args = [
+            p('logfmt'),
+            o('table'),
+        ];
+        const actual = await runPipeline([
+            'foo=bar baz=qux',
+            'foo=longer',
+        ], args);
+        const expected = [
+            'foo     baz',
+            'bar     qux',
+            'longer',
+        ];
+
+        expect(actual).to.equal(expected);
+    });
+
+    it('should filter by the original line even when parsers and outputs are provided', async () => {
         const args = [
             p('logfmt'),
             o('json'),
             i('o=n'),
         ];
-        const actual = runPipeline([
+        const actual = await runPipeline([
             'foo=bar baz=qux',
             'foo=nope baz=qux',
         ], args);
@@ -92,13 +110,13 @@ describe('pipeline', () => {
         expect(actual).to.equal(expected);
     });
 
-    it('should apply field filters after parse', () => {
+    it('should apply field filters after parse', async () => {
         const args = [
             p('logfmt'),
             o('json'),
-            F('foo.startsWith("b")'),
+            F('startsWith foo "b"'),
         ];
-        const actual = runPipeline([
+        const actual = await runPipeline([
             'foo=bar baz=qux',
             'foo=nope baz=qux',
         ], args);
@@ -109,14 +127,14 @@ describe('pipeline', () => {
         expect(actual).to.equal(expected);
     });
 
-    it('should apply multiple field filters', () => {
+    it('should apply multiple field filters', async () => {
         const args = [
             p('logfmt'),
             o('json'),
-            F('foo.startsWith("b")'),
-            F('foo.endsWith("r")'),
+            F('startsWith foo "b"'),
+            F('endsWith foo "r"'),
         ];
-        const actual = runPipeline([
+        const actual = await runPipeline([
             'foo=baz baz=qux',
             'foo=bar baz=qux',
             'foo=tar baz=qux',
@@ -128,14 +146,34 @@ describe('pipeline', () => {
         expect(actual).to.equal(expected);
     });
 
-    it('should log headers when -H is provided', () => {
+    it('should log headers when -H is provided', async () => {
         const args = [
             p('table'),
             o('original'),
-            F('NAME === "foo"'),
+            F('eq NAME "foo"'),
+            H(),
+        ];
+        const actual = await runPipeline([
+            'NAME',
+            'foo',
+            'bar',
+        ], args);
+        const expected = [
+            'NAME',
+            'foo',
+        ];
+
+        expect(actual).to.equal(expected);
+    });
+
+    it('should log headers only once when both -H and -o table is provided', async () => {
+        const args = [
+            p('table'),
+            o('table'),
+            F('eq NAME "foo"'),
             H(),
         ];
-        const actual = runPipeline([
+        const actual = await runPipeline([
             'NAME',
             'foo',
             'bar',
@@ -147,4 +185,52 @@ describe('pipeline', () => {
 
         expect(actual).to.equal(expected);
     });
+
+    it('should not duplicate headers when parsing and reformatting tables with ignore filters', async () => {
+        const args = [
+            p('table'),
+            o('table'),
+            i('kube'),
+        ];
+        const actual = await runPipeline([
+            'NAMESPACE NAME',
+            'kube-system coredns',
+            'default api',
+        ], args);
+        const expected = [
+            'NAMESPACE  NAME',
+            'default    api',
+        ];
+
+        expect(actual).to.equal(expected);
+    });
+
+    it('should not specify null prototype of regex parser', async () => {
+        const args = [
+            p('(?<num>\\d*)'),
+        ];
+        const [actual] = await runPipeline([
+            '12',
+        ], args);
+
+        expect(actual).not.to.include('null prototype');
+    });
+
+    it('should parse and format kubectl tables with -k', async () => {
+        const args = [
+            k(),
+        ];
+        const actual = await runPipeline([
+            'NAME AGE',
+            'foo 1',
+            'bar 22',
+        ], args);
+        const expected = [
+            'NAME  AGE',
+            'foo   1',
+            'bar   22',
+        ];
+
+        expect(actual).to.equal(expected);
+    });
 });

package/test/utils.js

@@ -31,7 +31,7 @@ function slowPod(...strs) {
     return emitter;
 }
 
-function runPipeline(inputLines, args) {
+async function runPipeline(inputLines, args) {
     const lines = [];
 
     const stdout = { write: (line) => lines.push(line) };
@@ -39,6 +39,11 @@ function runPipeline(inputLines, args) {
 
     inputLines.forEach(line => pipeline.onLogLine(line));
 
+    // Waiting for nextTick promises to resolve
+    await Hoek.wait(0);
+
+    pipeline.onEnd();
+
     // Removing \n from the end of each line
     return lines.map(line => line.slice(0, -1));
 }
@@ -62,5 +67,6 @@ const F = str => ({ field: [str] });
 const p = str => ({ parser: str });
 const o = str => ({ output: str });
 const H = () => ({ headers: true });
+const k = () => ({ kubectl: true });
 
-module.exports = { pod, slowPod, runPipeline, _, f, i, F, p, o, H };
+module.exports = { pod, slowPod, runPipeline, _, f, i, F, p, o, H, k };

package/src/transformers/field.js

@@ -1,11 +0,0 @@
-const vm = require('vm');
-
-module.exports = filter =>  line => {
-    if(typeof line !== 'object') {
-        throw new Error("To use a field filter, you need to specify a parser like '-p json' ");
-    }
-
-    vm.createContext(line);
-    const result = vm.runInContext(filter, line);
-    return Boolean(result);
-};

package/src/transformers/filter.js

@@ -1,4 +0,0 @@
-module.exports = regexStr => line => {
-    const regex = new RegExp(regexStr, 'i');
-    return regex.test(line);
-};

package/src/transformers/ignore.js

@@ -1,4 +0,0 @@
-module.exports = regexStr => line => {
-    const regex = new RegExp(regexStr, 'i');
-    return !regex.test(line);
-};

package/src/transformers/output-json.js

@@ -1,7 +0,0 @@
-module.exports = () => line => {
-    if(typeof line !== 'object') {
-        throw new Error("To use an output transformer, you need to specify a parser like '-p json'");
-    }
-
-    return JSON.stringify(line);
-};

package/src/transformers/output-logfmt.js

@@ -1,9 +0,0 @@
-const logfmt = require('logfmt');
-
-module.exports = () => line => {
-    if(typeof line !== 'object') {
-        throw new Error("To use an output transformer, you need to specify a parser like '-p json'");
-    }
-
-    return logfmt.stringify(line);
-};

package/src/transformers/output-mustache.js

@@ -1,13 +0,0 @@
-const { compile } = require('jstache');
-
-module.exports = format => {
-    const template = compile(format);
-
-    return line => {
-        if(typeof line !== 'object') {
-            throw new Error("To use an output transformer, you need to specify a parser like '-p json' ");
-        }
-
-        return template(line);
-    };
-}

package/src/transformers/output-original.js

@@ -1,3 +0,0 @@
-module.exports = () => (_line, original) => {
-    return original;
-};

package/src/transformers/output-unset.js

@@ -1,12 +0,0 @@
-const util = require('util');
-
-module.exports = () => line => {
-    if(typeof line === 'string') {
-        return true;
-    }
-
-    return util.inspect({ ...line }, {
-        colors: true,
-        depth: null,
-    });
-};

package/src/transformers/output.js

@@ -1,15 +0,0 @@
-const json = require('./output-json');
-const logfmt = require('./output-logfmt');
-const mustache = require('./output-mustache');
-const original = require('./output-original');
-const unset = require('./output-unset');
-
-module.exports = format => {
-    switch(format?.toLowerCase()) {
-        case     void 0: return unset();
-        case     'json': return json();
-        case   'logfmt': return logfmt();
-        case 'original': return original();
-        default:         return mustache(format);
-    }
-};

package/src/transformers/parse-json.js

@@ -1,12 +0,0 @@
-module.exports = () => line => {
-    try {
-        const obj = JSON.parse(line);
-        if(typeof obj !== 'object') {
-            return false;
-        }
-
-        return obj;
-    } catch {
-        return false;
-    }
-};

package/src/transformers/parse-logfmt.js

@@ -1,9 +0,0 @@
-const logfmt = require('logfmt');
-
-module.exports = () => line => {
-    try {
-        return logfmt.parse(line);
-    } catch {
-        return false;
-    }
-};

package/src/transformers/parse-regex.js

@@ -1,4 +0,0 @@
-module.exports = regexStr => {
-    const regex = new RegExp(regexStr, 'i');
-    return line => regex.exec(line)?.groups ?? false;
-};

package/src/transformers/parse-table.js

@@ -1,26 +0,0 @@
-function splitColumns(line) {
-    return line.replace(/\s+/g, ' ').split(' ');
-}
-
-module.exports = () => {
-    let headers;
-
-    return (line, _original, pipeline) => {
-        if(!pipeline.firstLine) {
-            // Ignore first line, it's the headers
-            return false;
-        }
-        if(!headers) {
-            headers = splitColumns(pipeline.firstLine);
-        }
-
-        const columns = splitColumns(line);
-        const obj = {};
-
-        headers.forEach((header, i) => {
-            obj[header] = columns[i];
-        });
-
-        return obj;
-    };
-};

package/src/transformers/parse.js

@@ -1,14 +0,0 @@
-const json = require('./parse-json');
-const logfmt = require('./parse-logfmt');
-const regex = require('./parse-regex');
-const table = require('./parse-table');
-
-module.exports = format => {
-    switch(format?.toLowerCase()) {
-        case   void 0: return null;
-        case   'json': return json();
-        case 'logfmt': return logfmt();
-        case  'table': return table();
-        default:       return regex(format);
-    }
-};