Add displaySpecErrorMessages and displaySummaryErrorMessages to D…

…isplayProcessor #85
bcaudan · Jan 4, 2017 · 6e1653e · 6e1653e
1 parent 56e38e4
commit 6e1653e
Show file tree

Hide file tree

Showing 8 changed files with 97 additions and 27 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
+# 3.1.0
+
+* Add `displaySpecErrorMessages` and `displaySummaryErrorMessages` to DisplayProcessor [#85](https://github.com/bcaudan/jasmine-spec-reporter/issues/85)
+
 # 3.0.0
 
 ## Breaking changes

diff --git a/docs/customize-output.md b/docs/customize-output.md
@@ -30,6 +30,8 @@ You can then customize the following methods:
 * displaySpecStarted(spec, log)
 * displaySuccessfulSpec(spec, log)
 * displayFailedSpec(spec, log)
+* displaySpecErrorMessages(spec, log)
+* displaySummaryErrorMessages(spec, log)
 * displayPendingSpec(spec, log)
 
 The first argument is the jasmine object corresponding to the suite or the spec. The second argument is the log to be displayed. Those methods should return the modified log.

diff --git a/spec/custom-processor.spec.ts b/spec/custom-processor.spec.ts
@@ -66,7 +66,17 @@ describe("spec reporter", () => {
                             this.failed();
                         });
                     });
-                }).outputs).contains(/failed spec TEST/);
+                }).outputs).contains([/failed spec TEST/]);
+            });
+
+            it("should display spec error messages with custom display", () => {
+                expect(new Test(this.reporter, function ()  {
+                    this.describe("suite", () => {
+                        this.it("failed spec", () => {
+                            this.failed();
+                        });
+                    });
+                }).outputs).contains(["      - Expected true to be false. TEST"]);
             });
 
             it("should report pending with custom display", () => {
@@ -79,5 +89,17 @@ describe("spec reporter", () => {
                 }).outputs).contains(/pending spec TEST/);
             });
         });
+
+        describe("when summary", () => {
+            it("should display summary error messages with custom display", () => {
+                expect(new Test(this.reporter, function ()  {
+                    this.describe("suite", () => {
+                        this.it("failed spec", () => {
+                            this.failed();
+                        });
+                    });
+                }).summary).contains(["  - Expected true to be false. TEST"]);
+            });
+        });
     });
 });
diff --git a/spec/display-stacktrace.spec.ts b/spec/display-stacktrace.spec.ts
@@ -18,7 +18,7 @@ describe("with display stacktrace", () => {
                     });
                 }).outputs;
                 expect(outputs).not.contains(/passed assertion/);
-                expect(outputs).contains([ "    ✗ failed spec", "      - Expected true to be false.", /at Object\.<anonymous>/, "" ]);
+                expect(outputs).contains([ "    ✗ failed spec", "      - Expected true to be false.", /at Env\.env\.failed/, /at Object\.<anonymous>/, "" ]);
             });
         });
 

diff --git a/spec/helpers/test-processor.ts b/spec/helpers/test-processor.ts
@@ -28,6 +28,14 @@ export class TestProcessor extends DisplayProcessor {
         return log + this.test;
     }
 
+    displaySpecErrorMessages(spec: any, log: String): String {
+        return log + this.test;
+    }
+
+    displaySummaryErrorMessages(spec: any, log: String): String {
+        return log + this.test;
+    }
+
     displayPendingSpec(spec: any, log: String): String {
         return log + this.test;
     }

diff --git a/src/display/display-processor.ts b/src/display/display-processor.ts
@@ -23,6 +23,14 @@ export class DisplayProcessor {
         return log;
     }
 
+    displaySpecErrorMessages(spec: any, log: String): String {
+        return log;
+    }
+
+    displaySummaryErrorMessages(spec: any, log: String): String {
+        return log;
+    }
+
     displayPendingSpec(spec: any, log: String): String {
         return log;
     }

diff --git a/src/display/processors/default-processor.ts b/src/display/processors/default-processor.ts
@@ -1,6 +1,14 @@
 import { DisplayProcessor } from "../display-processor";
+import { Configuration } from "../../configuration";
 
 export class DefaultProcessor extends DisplayProcessor {
+    private configuration: Configuration;
+
+    constructor(configuration: Configuration) {
+        super(configuration);
+        this.configuration = configuration;
+    }
+
     displayJasmineStarted(): String {
         return "Spec started";
     }
@@ -17,11 +25,41 @@ export class DefaultProcessor extends DisplayProcessor {
         return DefaultProcessor.displaySpecDescription(spec);
     }
 
+    displaySpecErrorMessages(spec: any): String {
+        return DefaultProcessor.displayErrorMessages(spec, this.configuration.spec.displayStacktrace);
+    }
+
+    displaySummaryErrorMessages(spec: any): String {
+        return DefaultProcessor.displayErrorMessages(spec, this.configuration.summary.displayStacktrace);
+    }
+
     displayPendingSpec(spec: any): String {
         return DefaultProcessor.displaySpecDescription(spec);
     }
 
     private static displaySpecDescription(spec: any): String {
         return spec.description;
     }
+
+    private static displayErrorMessages(spec: any, withStacktrace: boolean): String {
+        let logs: String[] = [];
+        for (let i: number = 0; i < spec.failedExpectations.length; i++) {
+            logs.push("- ".failed + spec.failedExpectations[i].message.failed);
+            if (withStacktrace && spec.failedExpectations[i].stack) {
+                logs.push(DefaultProcessor.filterStackTraces(spec.failedExpectations[i].stack));
+            }
+        }
+        return logs.join("\n");
+    }
+
+    private static filterStackTraces(traces: string): string {
+        let lines: string[] = traces.split("\n");
+        let filtered: string[] = [];
+        for (let i: number = 1; i < lines.length; i++) {
+            if (!/(jasmine[^\/]*\.js|Timer\.listOnTimeout)/.test(lines[i])) {
+                filtered.push(lines[i]);
+            }
+        }
+        return filtered.join("\n");
+    }
 }
diff --git a/src/execution-display.ts b/src/execution-display.ts
@@ -124,7 +124,11 @@ export class ExecutionDisplay {
 
     failedSummary(spec: any, index: number): void {
         this.log(`${index}) ${spec.fullName}`);
-        this.displayErrorMessages(spec, this.configuration.summary.displayStacktrace);
+        this.increaseIndent();
+        this.process(spec, (displayProcessor: DisplayProcessor, spec: any, log: String): String => {
+            return displayProcessor.displaySummaryErrorMessages(spec, log);
+        });
+        this.decreaseIndent();
     }
 
     pendingsSummary(): void {
@@ -174,7 +178,11 @@ export class ExecutionDisplay {
             this.process(spec, (displayProcessor: DisplayProcessor, spec: any, log: String): String => {
                 return displayProcessor.displayFailedSpec(spec, log);
             });
-            this.displayErrorMessages(spec, this.configuration.spec.displayStacktrace);
+            this.increaseIndent();
+            this.process(spec, (displayProcessor: DisplayProcessor, spec: any, log: String): String => {
+                return displayProcessor.displaySpecErrorMessages(spec, log);
+            });
+            this.decreaseIndent();
         }
     }
 
@@ -188,28 +196,6 @@ export class ExecutionDisplay {
         }
     }
 
-    displayErrorMessages(spec: any, withStacktrace: boolean): void {
-        this.increaseIndent();
-        for (let i: number = 0; i < spec.failedExpectations.length; i++) {
-            this.log("- ".failed + spec.failedExpectations[i].message.failed);
-            if (withStacktrace && spec.failedExpectations[i].stack) {
-                this.log(this.filterStackTraces(spec.failedExpectations[i].stack));
-            }
-        }
-        this.decreaseIndent();
-    }
-
-    filterStackTraces(traces: string): string {
-        let lines: string[] = traces.split("\n");
-        let filtered: string[] = [];
-        for (let i: number = 1; i < lines.length; i++) {
-            if (!/(jasmine[^\/]*\.js|Timer\.listOnTimeout)/.test(lines[i])) {
-                filtered.push(lines[i]);
-            }
-        }
-        return filtered.join(`\n${this.currentIndent}`);
-    }
-
     suiteStarted(suite: any): void {
         this.suiteHierarchy.push(suite);
     }
@@ -263,7 +249,9 @@ export class ExecutionDisplay {
 
     log(stuff: String): void {
         if (stuff !== null) {
-            console.log(this.currentIndent + stuff);
+            stuff.split("\n").forEach((line: String) => {
+                console.log(line !== "" ? this.currentIndent + line : line);
+            });
             this.lastWasNewLine = false;
         }
     }