Merge pull request #1853 from TheRealPiotrP/dev/piotrp/logOutput

Enable Integration Tests to expose Logger output

Author: Piotr Puszkiewicz

.gitignore

@@ -12,4 +12,5 @@ install.*
 
 obj/
 bin/
-test/**/.vscode
+test/**/.vscode
+.logs/

.travis.yml

@@ -33,6 +33,12 @@ install:
 script:
   - npm test --silent
 
+after_failure:
+  - ./.travis/printLogs.sh
+
+after_success:
+  - ./.travis/printLogs.sh
+
 deploy:
   provider: releases
   api_key:

.travis/printLogs.sh

@@ -0,0 +1,25 @@
+#!/bin/bash
+
+# ---------------------------------------------------------------------------------------------
+#  Copyright (c) Microsoft Corporation. All rights reserved.
+#  Licensed under the MIT License. See License.txt in the project root for license information.
+# --------------------------------------------------------------------------------------------
+
+fold_start() {
+  echo -e "travis_fold:start:$1\033[33;1m$2\033[0m"
+}
+
+fold_end() {
+  echo -e "\ntravis_fold:end:$1\r"
+}
+
+fold_start testLogs "Test Logs"
+
+for f in ./.logs/*.log
+do
+  fold_start logFile $f
+  cat $f
+  fold_end logFile
+done
+
+fold_end testLogs

src/logger.ts

@@ -3,6 +3,12 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
+let Subscriber: (message: string) => void;
+
+export function SubscribeToAllLoggers(subscriber: (message:string) => void) {
+    Subscriber = subscriber;
+}
+
 export class Logger {
     private _writer: (message: string) => void;
     private _prefix: string;
@@ -20,17 +26,17 @@ export class Logger {
         if (this._atLineStart) {
             if (this._indentLevel > 0) {
                 const indent = " ".repeat(this._indentLevel * this._indentSize);
-                this._writer(indent);
+                this.write(indent);
             }
 
             if (this._prefix) {
-                this._writer(`[${this._prefix}] `);
+                this.write(`[${this._prefix}] `);
             }
 
             this._atLineStart = false;
         }
 
-        this._writer(message); 
+        this.write(message); 
     }
 
     public increaseIndent(): void {
@@ -53,4 +59,12 @@ export class Logger {
         this._appendCore(message + '\n');
         this._atLineStart = true;
     }
+
+    private write(message: string) {
+        this._writer(message);
+
+        if (Subscriber) {
+            Subscriber(message);
+        }
+    }
 }

test/integrationTests/index.ts

@@ -3,6 +3,10 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
+import * as fs from "fs";
+
+import { SubscribeToAllLoggers } from "../../src/logger";
+
 //
 // PLEASE DO NOT MODIFY / DELETE UNLESS YOU KNOW WHAT YOU ARE DOING
 //
@@ -15,7 +19,7 @@
 // to report the results back to the caller. When the tests are finished, return
 // a possible error to the callback or null if none.
 
-var testRunner = require('vscode/lib/testrunner');
+let testRunner = require('vscode/lib/testrunner');
 
 // You can directly control Mocha options by uncommenting the following lines
 // See https://github.com/mochajs/mocha/wiki/Using-mocha-programmatically#set-options for more info
@@ -26,4 +30,14 @@ testRunner.configure({
     useColors: true // colored output from test results
 });
 
+if (process.env.OSVC_SUITE) {
+    if (!fs.existsSync("./.logs")) {
+        fs.mkdirSync("./.logs");
+    }
+    
+    let logFilePath = `./.logs/${process.env.OSVC_SUITE}.log`;
+
+    SubscribeToAllLoggers(message => fs.appendFileSync(logFilePath, message));
+}
+
 module.exports = testRunner;

test/unitTests/index.ts

@@ -15,7 +15,7 @@
 // to report the results back to the caller. When the tests are finished, return
 // a possible error to the callback or null if none.
 
-var testRunner = require('vscode/lib/testrunner');
+let testRunner = require('vscode/lib/testrunner');
 
 // You can directly control Mocha options by uncommenting the following lines
 // See https://github.com/mochajs/mocha/wiki/Using-mocha-programmatically#set-options for more info
@@ -26,4 +26,4 @@ testRunner.configure({
     useColors: true // colored output from test results
 });
 
-module.exports = testRunner;
+module.exports = testRunner;