logger refactor, comments and cleanup

Author: ShMcK

lib/logger.js

@@ -0,0 +1,21 @@
+"use strict";
+var unexpectedOutput = /^(?!# TAP)(?!(not )?ok [0-9]+ -)(?!1..[0-9]+)(?!# E\s)(.*)$/gm;
+function logger(data) {
+    var logs = data.match(unexpectedOutput);
+    if (!logs && logs.length < 1) {
+        return;
+    }
+    logs.forEach(function (line) {
+        if (line.length > 0) {
+            try {
+                line = JSON.parse(JSON.stringify(line));
+                console.dir(JSON.parse(JSON.stringify(line)));
+            }
+            catch (e) {
+                console.log(line);
+            }
+        }
+    });
+}
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = logger;

lib/runner.js

@@ -1,27 +1,7 @@
 "use strict";
 var create_runner_1 = require('./create-runner');
 var parse_tap_1 = require('./parse-tap');
-function log(data) {
-    var logs = data.match(/^(?!# TAP)(?!(not )?ok [0-9]+ -)(?!1..[0-9]+)(?!# E\s)(.*)$/gm);
-    if (logs && logs.length > 0) {
-        logs.forEach(function (line) {
-            if (line.length > 0) {
-                try {
-                    line = JSON.parse(JSON.stringify(line));
-                    if (typeof line === 'string') {
-                        console.log(line);
-                    }
-                    else {
-                        console.dir(JSON.parse(JSON.stringify(line)));
-                    }
-                }
-                catch (e) {
-                    console.log(line);
-                }
-            }
-        });
-    }
-}
+var logger_1 = require('./logger');
 function runner(testFile, config, handleResult) {
     var runner = create_runner_1.default(config, testFile);
     var final = null;
@@ -31,7 +11,7 @@ function runner(testFile, config, handleResult) {
             if (!data || !data.length) {
                 return;
             }
-            log(data);
+            logger_1.default(data);
             final = parse_tap_1.default(data);
             if (!final) {
                 console.log('Error parsing test ouptut:', data);

src/create-runner.ts

@@ -5,6 +5,7 @@ let python = 'python';
 let localPath = '/usr/local/bin/python';
 let globalPath = '/usr/bin/python';
 
+// use python path for mac/linux (usr/local/bin, usr/bin), or windows (python)
 if (process.platform === 'darwin' && process.resourcesPath) {
   if (exists(localPath)) {
     python = localPath;
@@ -16,11 +17,12 @@ if (process.platform === 'darwin' && process.resourcesPath) {
 }
 
 export default function createRunner(config: CR.Config, testFile: string) {
+  // see pytest options: https://pytest.org/latest/usage.html
   return exec([
     python,
     '-m pytest',
-    '-s',
-    '--tap-stream',
+    '-s', // capture content
+    '--tap-stream', // TAP formatted output
     '-x', // stop after first failure
     '--tb=no', // no traceback
     testFile

src/logger.ts

@@ -0,0 +1,19 @@
+const unexpectedOutput: RegExp = /^(?!# TAP)(?!(not )?ok [0-9]+ -)(?!1..[0-9]+)(?!# E\s)(.*)$/gm;
+
+// capture any unexpected output to the log
+export default function logger(data: string): void {
+  var logs: string[] = data.match(unexpectedOutput);
+  if (!logs && logs.length < 1) {
+    return;
+  }
+  logs.forEach((line: string) => {
+    if (line.length > 0) {
+      try {
+        line = JSON.parse(JSON.stringify(line));
+        console.dir(JSON.parse(JSON.stringify(line)));
+      } catch (e) {
+        console.log(line);
+      }
+    }
+  });
+}

src/parse-tap.ts

@@ -11,25 +11,26 @@ function formatFeedback(message: string): string {
 
 export default function parseTap(data: string): ParseFinal {
 
+  // Output as TAP?
   if (!data || !data.match(regex.isTap)) {
     console.log('No TAP output: ', data);
     return;
   }
 
+  // Final test number?
   if (!data.match(regex.finalTest)) {
     console.log('Could not parse final test number: ', data);
     return;
   }
-
   let finalTest: number = parseInt(data.match(regex.finalTest)[1], 10);
-
   let final: ParseFinal = null;
 
+  // Fail or Pass?
   if (data.match(regex.error)) {
 
     // first FAILing test
 
-    let failingLineRegex = new RegExp(`^not ok ${finalTest} - (.+)$`, 'm');
+    let failingLineRegex: RegExp = new RegExp(`^not ok ${finalTest} - (.+)$`, 'm');
     let line: string = data.match(failingLineRegex)[1];
     if (!line || typeof line !== 'string') {
       console.log('Error matching failing test line: ', data);
@@ -56,7 +57,7 @@ export default function parseTap(data: string): ParseFinal {
 
     // all tests PASS
 
-    let finalPassRegex = new RegExp(`^ok ${finalTest} - (.+)$`, 'm');
+    let finalPassRegex: RegExp = new RegExp(`^ok ${finalTest} - (.+)$`, 'm');
     let line: string = data.match(finalPassRegex)[1];
     let taskPosition: number = parseInt(line.match(/Test([0-9]+)/)[1], 10);
 

src/runner.ts

@@ -1,25 +1,7 @@
 import createRunner from './create-runner';
 import parseTap from './parse-tap';
+import logger from './logger';
 
-function log(data: string): void {
-  var logs = data.match(/^(?!# TAP)(?!(not )?ok [0-9]+ -)(?!1..[0-9]+)(?!# E\s)(.*)$/gm);
-  if (logs && logs.length > 0) {
-    logs.forEach((line: string) => {
-      if (line.length > 0) {
-        try {
-          line = JSON.parse(JSON.stringify(line));
-          if (typeof line === 'string') {
-            console.log(line);
-          } else {
-            console.dir(JSON.parse(JSON.stringify(line)));
-          }
-        } catch (e) {
-          console.log(line);
-        }
-      }
-    });
-  }
-}
 
 export default function runner(testFile: string, config: CR.Config,
   handleResult: (result) => CR.TestResult): Promise<CR.TestResult> {
@@ -32,25 +14,29 @@ export default function runner(testFile: string, config: CR.Config,
     runner.stdout.on('data', function(data): void {
 
       data = data.toString();
+
+      // no output, end early
       if (!data || !data.length) {
         return;
       }
 
-      // capture any abnormal data as a log
-      log(data);
+      // log to Atom console
+      logger(data);
 
-      // transform data;
+      // parse data into JSON object
       final = parseTap(data);
+
+      // could not parse, log error
       if (!final) {
         console.log('Error parsing test ouptut:', data);
       }
 
+      // complete JSON object
       final.change = final.taskPosition - config.taskPosition;
       final.pass = final.change > 0;
 
       // return result to atom-coderoad
       handleResult(final);
-
     });
 
     runner.stderr.on('data', function(data) {

tsconfig.json

@@ -17,6 +17,7 @@
   "files": [
     "src/create-runner.ts",
     "src/exists.ts",
+    "src/logger.ts",
     "src/parse-tap.ts",
     "src/runner.ts",
     "src/typings/tsd.d.ts"