Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add colors to pretty formatter #71

Closed
wants to merge 1 commit into from
Closed

Add colors to pretty formatter #71

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions lib/cucumber/listener/formatter.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,28 @@ var Formatter = function (options) {
return logs;
};

self.colorize = function colorize(text, stepResult) {
var ansi_color = require('ansi-color');
if (stepResult.isFailed()) {
return ansi_color.set(text, Formatter.FAILED_COLOR);
} else if (stepResult.isSkipped()) {
return ansi_color.set(text, Formatter.SKIPPED_COLOR);
} else if (stepResult.isPending()) {
return ansi_color.set(text, Formatter.PENDING_COLOR);
} else if (stepResult.isUndefined()) {
return ansi_color.set(text, Formatter.UNDEFINED_COLOR);
} else if (stepResult.isSuccessful()) {
return ansi_color.set(text, Formatter.SUCCESSFUL_COLOR);
}

return text;
};

return self;
};
Formatter.FAILED_COLOR = "red";
Formatter.SUCCESSFUL_COLOR = "green";
Formatter.PENDING_COLOR = "yellow";
Formatter.UNDEFINED_COLOR = "yellow";
Formatter.SKIPPED_COLOR = "cyan";
module.exports = Formatter;
9 changes: 4 additions & 5 deletions lib/cucumber/listener/pretty_formatter.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
var PrettyFormatter = function(options) {
var Cucumber = require('../../cucumber');
var Cucumber = require('../../cucumber');

var self = Cucumber.Listener.Formatter(options);
var summarizer = Cucumber.Listener.Summarizer();
var summarizer = Cucumber.Listener.Summarizer({ colors: true });

var parentHear = self.hear;
self.hear = function hear(event, callback) {
Expand Down Expand Up @@ -33,13 +33,12 @@ var PrettyFormatter = function(options) {
self.handleStepResultEvent = function handleStepResult(event, callback) {
var stepResult = event.getPayloadItem('stepResult');
var step = stepResult.getStep();
var source = step.getKeyword() + step.getName() + "\n";
var source = self.colorize(step.getKeyword() + step.getName(), stepResult) + "\n";
self.logIndented(source, 2);

stepResult.isFailed();
if (stepResult.isFailed()) {
var failure = stepResult.getFailureException();
var failureDescription = failure.stack || failure;
var failureDescription = self.colorize(failure.stack || failure, stepResult);
self.logIndented(failureDescription + "\n", 3);
}
callback();
Expand Down
87 changes: 44 additions & 43 deletions lib/cucumber/listener/summarizer.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,26 @@
var Summarizer = function () {
var Summarizer = function (options) {
var Cucumber = require('../../cucumber');

var logs = "";
var failedScenarioLogBuffer = "";
var undefinedStepLogBuffer = "";
var failedStepResults = Cucumber.Type.Collection();
var statsJournal = Cucumber.Listener.StatsJournal();
var Formatter = Cucumber.Listener.Formatter;

var self = Cucumber.Listener();

var parentHear = self.hear;

var addStyleToText = function addStyleToText(text, color) {
var ansi_color;
if (options && options.colors) {
ansi_color = require('ansi-color');
return ansi_color.set(text, color);
}
return text;
};

self.hear = function hear(event, callback) {
statsJournal.hear(event, function () {
parentHear(event, callback);
Expand Down Expand Up @@ -101,7 +112,8 @@ var Summarizer = function () {
};

self.logFailedStepResults = function logFailedStepResults() {
self.log("(::) failed steps (::)\n\n");
var banner = "(::) failed steps (::)";
self.log(banner + "\n\n");
failedStepResults.syncForEach(function(stepResult) {
self.logFailedStepResult(stepResult);
});
Expand All @@ -117,53 +129,42 @@ var Summarizer = function () {
self.log("\n\n");
};

self.logScenariosSummary = function logScenariosSummary() {
var scenarioCount = statsJournal.getScenarioCount();
var passedScenarioCount = statsJournal.getPassedScenarioCount();
var undefinedScenarioCount = statsJournal.getUndefinedScenarioCount();
var pendingScenarioCount = statsJournal.getPendingScenarioCount();
var failedScenarioCount = statsJournal.getFailedScenarioCount();
var details = [];

self.log(scenarioCount + " scenario" + (scenarioCount != 1 ? "s" : ""));
if (scenarioCount > 0 ) {
if (failedScenarioCount > 0)
details.push(failedScenarioCount + " failed");
if (undefinedScenarioCount > 0)
details.push(undefinedScenarioCount + " undefined");
if (pendingScenarioCount > 0)
details.push(pendingScenarioCount + " pending");
if (passedScenarioCount > 0)
details.push(passedScenarioCount + " passed");
function logSummaryHelper(noun) {
var suffix = " " + noun.toLowerCase();
var count = statsJournal["get"+noun+"Count"]();
var passedCount = statsJournal["getPassed"+noun+"Count"]();
var undefinedCount = statsJournal["getUndefined"+noun+"Count"]();
var pendingCount = statsJournal["getPending"+noun+"Count"]();
var failedCount = statsJournal["getFailed"+noun+"Count"]();
var skippedCount = 0;
var details = [];

if (statsJournal["getSkipped"+noun+"Count"])
skippedCount = statsJournal["getSkipped"+noun+"Count"]();

self.log(count + suffix + (count != 1 ? "s" : ""));
if (count > 0 ) {
if (failedCount > 0)
details.push(addStyleToText(failedCount + " failed", Formatter.FAILED_COLOR));
if (undefinedCount > 0)
details.push(addStyleToText(undefinedCount + " undefined", Formatter.UNDEFINED_COLOR));
if (pendingCount > 0)
details.push(addStyleToText(pendingCount + " pending", Formatter.PENDING_COLOR));
if (skippedCount > 0)
details.push(addStyleToText(skippedCount + " skipped", Formatter.SKIPPED_COLOR));
if (passedCount > 0)
details.push(addStyleToText(passedCount + " passed", Formatter.SUCCESSFUL_COLOR));
self.log(" (" + details.join(', ') + ")");
}
self.log("\n");
}

self.logScenariosSummary = function logScenariosSummary() {
logSummaryHelper("Scenario");
};

self.logStepsSummary = function logStepsSummary() {
var stepCount = statsJournal.getStepCount();
var passedStepCount = statsJournal.getPassedStepCount();
var undefinedStepCount = statsJournal.getUndefinedStepCount();
var skippedStepCount = statsJournal.getSkippedStepCount();
var pendingStepCount = statsJournal.getPendingStepCount();
var failedStepCount = statsJournal.getFailedStepCount();
var details = [];

self.log(stepCount + " step" + (stepCount != 1 ? "s" : ""));
if (stepCount > 0) {
if (failedStepCount > 0)
details.push(failedStepCount + " failed");
if (undefinedStepCount > 0)
details.push(undefinedStepCount + " undefined");
if (pendingStepCount > 0)
details.push(pendingStepCount + " pending");
if (skippedStepCount > 0)
details.push(skippedStepCount + " skipped");
if (passedStepCount > 0)
details.push(passedStepCount + " passed");
self.log(" (" + details.join(', ') + ")");
}
self.log("\n");
logSummaryHelper("Step");
};

self.logUndefinedStepSnippets = function logUndefinedStepSnippets() {
Expand Down
5 changes: 3 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
"Olivier Melcher <[email protected]>",
"Tristan Dunn <[email protected]>",
"Ted de Koning",
"@renier",
"Renier Morales <renier@morales-rodriguez.net>",
"Aslak Hellesøy <[email protected]>",
"Aaron Garvey"
],
Expand Down Expand Up @@ -49,7 +49,8 @@
"mkdirp": "0.3.3",
"cucumber-html": "0.2.0",
"walkdir": "0.0.4",
"coffee-script": "1.3.3"
"coffee-script": "1.3.3",
"ansi-color": "0.2.1"
},
"scripts": {
"test": "./bin/cucumber.js && jasmine-node spec"
Expand Down
21 changes: 16 additions & 5 deletions spec/cucumber/listener/pretty_formatter_spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,10 @@ describe("Cucumber.Listener.PrettyFormatter", function () {
var formatter, formatterHearMethod, summarizer, prettyFormatter, options;

beforeEach(function () {
var Formatter = Cucumber.Listener.Formatter;
options = createSpy(options);
formatter = createSpyWithStubs("formatter", {log: null});
formatter.colorize = Formatter().colorize;
formatterHearMethod = spyOnStub(formatter, 'hear');
summarizer = createSpy("summarizer");
spyOn(Cucumber.Listener, 'Formatter').andReturn(formatter);
Expand Down Expand Up @@ -162,7 +164,8 @@ describe("Cucumber.Listener.PrettyFormatter", function () {
keyword = "step-keyword ";
name = "step-name";
step = createSpyWithStubs("step", { getKeyword: keyword, getName: name });
stepResult = createSpyWithStubs("step result", { getStep: step, isFailed: null });
stepResult = createSpyWithStubs("step result", {
getStep: step, isFailed: null, isSkipped: null, isSuccessful: null, isPending: null, isUndefined: null });
event = createSpyWithStubs("event", { getPayloadItem: stepResult });
spyOn(prettyFormatter, 'logIndented');
callback = createSpy("callback");
Expand Down Expand Up @@ -215,18 +218,26 @@ describe("Cucumber.Listener.PrettyFormatter", function () {

it("logs the failure stack when there is one, indented by three levels", function () {
var stack = "failure stack";
var text = stack + "\n";
var text = formatter.colorize(stack, stepResult) + "\n";
exception.stack = stack;
prettyFormatter.handleStepResultEvent(event, callback);
expect(prettyFormatter.logIndented).toHaveBeenCalledWith(text, 3);
//expect(prettyFormatter.logIndented).toHaveBeenCalledWith(text, 3);
// logIndented being called twice
expect(prettyFormatter.logIndented.mostRecentCall.args.length).toBe(2);
expect(prettyFormatter.logIndented.mostRecentCall.args[0]).toBe(text);
expect(prettyFormatter.logIndented.mostRecentCall.args[1]).toBe(3);
});

it("logs the failure itself when there no stack, indented by three levels", function () {
exception = "exception text";
var text = exception + "\n";
var text = formatter.colorize(exception, stepResult) + "\n";
stepResult.getFailureException.andReturn(exception);
prettyFormatter.handleStepResultEvent(event, callback);
expect(prettyFormatter.logIndented).toHaveBeenCalledWith(text, 3);
//expect(prettyFormatter.logIndented).toHaveBeenCalledWith(text, 3);
// logIndented being called twice
expect(prettyFormatter.logIndented.mostRecentCall.args.length).toBe(2);
expect(prettyFormatter.logIndented.mostRecentCall.args[0]).toBe(text);
expect(prettyFormatter.logIndented.mostRecentCall.args[1]).toBe(3);
});
});

Expand Down
2 changes: 2 additions & 0 deletions spec/cucumber/listener/summarizer_spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ describe("Cucumber.Listener.Summarizer", function () {

beforeEach(function () {
var Summarizer = Cucumber.Listener.Summarizer;
var Formatter = Cucumber.Listener.Formatter;
listener = createSpyWithStubs("listener");
listenerHearMethod = spyOnStub(listener, 'hear');
statsJournal = createSpy("stats journal");
Expand All @@ -14,6 +15,7 @@ describe("Cucumber.Listener.Summarizer", function () {
spyOn(Cucumber, 'Listener').andReturn(listener);
spyOnStub(Cucumber.Listener, 'StatsJournal').andReturn(statsJournal);
Cucumber.Listener.Summarizer = Summarizer;
Cucumber.Listener.Formatter = Formatter;
summarizer = Cucumber.Listener.Summarizer();
});

Expand Down