Added junit format support

Modified the snapdragon binary to accept a format parameter to enable results
to be outputted in junit. Added the junit reporter and modified the run html
template to load the junit formatter when the format has been set to junit.

Author: Brian Miller

bin/snapdragon

@@ -6,6 +6,6 @@ require 'rubygems'
 require 'snapdragon/command_line_parser'
 require 'snapdragon/cli_application'
 
-Snapdragon::CommandLineParser.parse(ARGV)
-app = Snapdragon::CliApplication.new(ARGV)
+opts = Snapdragon::CommandLineParser.parse(ARGV)
+app = Snapdragon::CliApplication.new(opts, ARGV)
 exit(app.run)

bin/snapdragon_server

@@ -6,6 +6,6 @@ require 'rubygems'
 require 'snapdragon/command_line_parser'
 require 'snapdragon/cli_application'
 
-Snapdragon::CommandLineParser.parse(ARGV)
-app = Snapdragon::CliApplication.new(ARGV)
+opts = Snapdragon::CommandLineParser.parse(ARGV)
+app = Snapdragon::CliApplication.new(opts, ARGV)
 app.serve

lib/snapdragon/cli_application.rb

@@ -13,9 +13,8 @@
 
 module Snapdragon
   class CliApplication
-    def initialize(arguements)
-      @args = arguements
-      @suite = Snapdragon::Suite.new(arguements)
+    def initialize(options, paths)
+      @suite = Snapdragon::Suite.new(options, paths)
     end
 
     def run

lib/snapdragon/command_line_parser.rb

@@ -1,9 +1,13 @@
 require 'optparse'
+require 'ostruct'
 require_relative './version'
 
 module Snapdragon
   class CommandLineParser
     def self.parse(args)
+      options = OpenStruct.new
+      options.format = "console" 
+
       opts = OptionParser.new do |opts|
         opts.banner = "Usage: snapdragon [options] [files or directories]"
         opts.on('-v', '--version', "Show the current version of this gem") do
@@ -12,11 +16,15 @@ def self.parse(args)
         opts.on('-h', '--help', "show usage") do
           puts opts; exit
         end
+        opts.on('-f', '--format [FORMAT]', "set output format") do |format|
+          options.format = format
+        end
         if args.empty?
           puts opts; exit
         end
       end
       opts.parse!(args)
+      options
     end
   end
 end

lib/snapdragon/resources/SnapdragonJUnitReporter.js

@@ -0,0 +1,171 @@
+/*
+ * This is the junit reporter provided in the jasmine-reporters project
+ * available at https://github.com/larrymyers/jasmine-reporters
+ */
+(function() {
+
+  if (typeof jasmine == 'undefined') {
+    throw new Error("jasmine library does not exist in global namespace!");
+  }
+
+  function elapsed(startTime, endTime) {
+    return (endTime - startTime)/1000;
+  }
+
+  function ISODateString(d) {
+    function pad(n) { return n < 10 ? '0'+n : n; }
+
+    return d.getFullYear() + '-' +
+      pad(d.getMonth()+1) + '-' +
+      pad(d.getDate()) + 'T' +
+      pad(d.getHours()) + ':' +
+      pad(d.getMinutes()) + ':' +
+      pad(d.getSeconds());
+  }
+
+  function trim(str) {
+    return str.replace(/^\s+/, "" ).replace(/\s+$/, "" );
+  }
+
+  function escapeInvalidXmlChars(str) {
+    return str.replace(/\&/g, "&amp;")
+      .replace(/</g, "&lt;")
+      .replace(/\>/g, "&gt;")
+      .replace(/\"/g, "&quot;")
+      .replace(/\'/g, "&apos;");
+  }
+
+  var JUnitXmlReporter = function() {
+    this.useDotNotation = true;
+  };
+
+  JUnitXmlReporter.prototype = {
+    reportSpecStarting: function(spec) {
+      spec.startTime = new Date();
+
+      if (!spec.suite.startTime) {
+        spec.suite.startTime = spec.startTime;
+      }
+    },
+
+    reportSpecResults: function(spec) {
+      var results = spec.results();
+      spec.didFail = !results.passed();
+      spec.duration = elapsed(spec.startTime, new Date());
+      spec.output = '<testcase classname="' + this.getFullName(spec.suite) +
+        '" name="' + escapeInvalidXmlChars(spec.description) + '" time="' + spec.duration + '">';
+      if(results.skipped) {
+        spec.output = spec.output + "<skipped />";
+      }
+
+      var failure = "";
+      var failures = 0;
+      var resultItems = results.getItems();
+      for (var i = 0; i < resultItems.length; i++) {
+        var result = resultItems[i];
+
+        if (result.type == 'expect' && result.passed && !result.passed()) {
+          failures += 1;
+          failure += '<failure type="' + result.type + '" message="' + trim(escapeInvalidXmlChars(result.message)) + '">';
+          failure += escapeInvalidXmlChars(result.trace.stack || result.message);
+          failure += "</failure>";
+        }
+      }
+      if (failure) {
+        spec.output += failure;
+      }
+      spec.output += "</testcase>";
+    },
+
+    reportSuiteResults: function(suite) {
+      var results = suite.results();
+      var specs = suite.specs();
+      var specOutput = "";
+      // for JUnit results, let's only include directly failed tests (not nested suites')
+      var failedCount = 0;
+
+      suite.status = results.passed() ? 'Passed.' : 'Failed.';
+      if (results.totalCount === 0) { // todo: change this to check results.skipped
+        suite.status = 'Skipped.';
+      }
+
+      // if a suite has no (active?) specs, reportSpecStarting is never called
+      // and thus the suite has no startTime -- account for that here
+      suite.startTime = suite.startTime || new Date();
+      suite.duration = elapsed(suite.startTime, new Date());
+
+      for (var i = 0; i < specs.length; i++) {
+        failedCount += specs[i].didFail ? 1 : 0;
+        specOutput += "\n  " + specs[i].output;
+      }
+      suite.output = '\n<testsuite name="' + this.getFullName(suite) +
+        '" errors="0" tests="' + specs.length + '" failures="' + failedCount +
+        '" time="' + suite.duration + '" timestamp="' + ISODateString(suite.startTime) + '">';
+      suite.output += specOutput;
+      suite.output += "\n</testsuite>";
+    },
+
+    reportRunnerResults: function(runner) {
+      var suites = runner.suites();
+      for (var i = 0; i < suites.length; i++) {
+        var suite = suites[i];
+        var output = '<?xml version="1.0" encoding="UTF-8" ?>';
+        // if we are consolidating, only write out top-level suites
+        if (suite.parentSuite) {
+          continue;
+        }
+        else {
+          output += "\n<testsuites>";
+          output += this.getNestedOutput(suite);
+          output += "\n</testsuites>";
+          this.print(output);
+        }
+      }
+      this.signalCapybaraTestsFinishedRunning();
+    },
+
+    signalCapybaraTestsFinishedRunning:  function() {
+      var div = document.createElement('div');
+      div.id = 'testscomplete';
+      document.body.appendChild(div);
+    },
+
+    getNestedOutput: function(suite) {
+      var output = suite.output;
+      for (var i = 0; i < suite.suites().length; i++) {
+        output += this.getNestedOutput(suite.suites()[i]);
+      }
+      return output;
+    },
+
+    getFullName: function(suite, isFilename) {
+      var fullName;
+      if (this.useDotNotation) {
+        fullName = suite.description;
+        for (var parentSuite = suite.parentSuite; parentSuite; parentSuite = parentSuite.parentSuite) {
+          fullName = parentSuite.description + '.' + fullName;
+        }
+      }
+      else {
+        fullName = suite.getFullName();
+      }
+
+      // Either remove or escape invalid XML characters
+      if (isFilename) {
+        return fullName.replace(/[^\w]/g, "");
+      }
+      return escapeInvalidXmlChars(fullName);
+    },
+
+    print: function(str) {
+      var console = jasmine.getGlobal().console;
+
+      if (console && console.log) {
+        console.log(str);
+      }
+    }
+  };
+
+  // export public
+  jasmine.SnapdragonJUnitReporter = JUnitXmlReporter;
+})();

lib/snapdragon/suite.rb

@@ -2,10 +2,15 @@
 
 module Snapdragon
   class Suite
-    def initialize(paths)
+    def initialize(options, paths)
+      @options = options
       @paths = paths
     end
 
+    def formatter
+      @options.format
+    end
+
     def spec_files
       spec_file_objs = []
 

lib/snapdragon/views/run.erb

@@ -2,7 +2,11 @@
 <script type="text/javascript" src="/jasmine-core/jasmine.js"></script>
 <script type="text/javascript" src="/jasmine-core/jasmine-html.js"></script>
 
+<% if @suite.formatter == "junit" %>
+<script type="text/javascript" src="/resources/SnapdragonJUnitReporter.js"></script>
+<% else %>
 <script type="text/javascript" src="/resources/SnapdragonConsoleReporter.js"></script>
+<% end %>
 
 <!-- The implementation code the spec files being tested need -->
 <% @suite.require_file_relative_url_paths.each do |path| %>
@@ -19,16 +23,20 @@
     var jasmineEnv = jasmine.getEnv();
     jasmineEnv.updateInterval = 1000;
 
-    var htmlReporter = new jasmine.HtmlReporter();
-
-    jasmineEnv.addReporter(htmlReporter);
-
-    var snapdragonConsoleReporter = new jasmine.SnapdragonConsoleReporter({});
-    jasmineEnv.addReporter(snapdragonConsoleReporter);
-
-    jasmineEnv.specFilter = function(spec) {
-      return htmlReporter.specFilter(spec);
-    };
+    <% if @suite.formatter == "junit" %>
+      var snapdragonJUnitReporter = new jasmine.SnapdragonJUnitReporter();
+      jasmineEnv.addReporter(new jasmine.TrivialReporter());
+      jasmineEnv.addReporter(snapdragonJUnitReporter);
+    <% else %>
+      var htmlReporter = new jasmine.HtmlReporter();
+      jasmineEnv.addReporter(htmlReporter);
+      var snapdragonConsoleReporter = new jasmine.SnapdragonConsoleReporter({});
+      jasmineEnv.addReporter(snapdragonConsoleReporter);
+
+      jasmineEnv.specFilter = function(spec) {
+        return htmlReporter.specFilter(spec);
+      };
+    <% end %>
 
     var currentWindowOnload = window.onload;
 

spec/lib/snapdragon/cli_application_spec.rb

@@ -2,28 +2,23 @@
 
 describe Snapdragon::CliApplication do
   describe "#initialize" do
-    it "stores a copy of the given command line arguments" do
-      cmd_line_args = stub('command_line_args')
-      cli_app = Snapdragon::CliApplication.new(cmd_line_args)
-      cli_app.instance_variable_get(:@args).should eq(cmd_line_args)
-    end
-
     it "creates an empty Suite" do
       Snapdragon::Suite.should_receive(:new)
-      Snapdragon::CliApplication.new(stub)
+      Snapdragon::CliApplication.new(stub, stub)
     end
 
     it "assigns the new Suite to an instance variable" do
       suite = stub('suite')
       Snapdragon::Suite.stub(:new).and_return(suite)
-      app = Snapdragon::CliApplication.new(stub)
+      app = Snapdragon::CliApplication.new(stub, stub)
       app.instance_variable_get(:@suite).should eq(suite)
     end
   end
 
   describe "#run" do
-    let(:arguements) { stub('arguments') }
-    subject { Snapdragon::CliApplication.new(arguements) }
+    let(:paths) { stub('paths') }
+    let(:options) { stub('options') }
+    subject { Snapdragon::CliApplication.new(options, paths) }
 
     it "creates a capybara session" do
       suite = stub(filtered?: false)

spec/lib/snapdragon/command_line_parser_spec.rb

@@ -34,5 +34,17 @@
         lambda { subject.parse(["spec/hello_spec.rb"]) }.should_not raise_error(SystemExit)
       end
     end
+
+    context "when format is provided" do
+      it "sets the format value" do
+        subject.parse(["--format", "junit", "spec/hello_spec.rb"]).format.should eq "junit"
+      end
+    end
+
+    context "when format is not provided" do
+      it "defaults to console" do
+        subject.parse(["spec/hello_spec.rb"]).format.should eq "console"
+      end
+    end
   end
 end

spec/lib/snapdragon/suite_spec.rb

@@ -3,29 +3,49 @@
 describe Snapdragon::Suite do
   describe "#initialize" do
     it "constucts an instance of a Suite given an array of paths" do
+      options = stub
       paths = [stub, stub, stub]
-      Snapdragon::Suite.new(paths)
+      Snapdragon::Suite.new(options, paths)
     end
 
     it "stores the paths in an instance variable" do
+      options = stub
       paths = [stub, stub, stub]
-      suite = Snapdragon::Suite.new(paths)
+      suite = Snapdragon::Suite.new(options, paths)
       suite.instance_variable_get(:@paths).should eq(paths)
     end
+
+    it 'stores the options in an instance variable' do
+      options = stub
+      paths = [stub, stub, stub]
+      suite = Snapdragon::Suite.new(options, paths)
+      suite.instance_variable_get(:@options).should eq(options)
+    end
+  end
+
+  describe "#formatter" do
+    it "returns the configured formatter to use" do
+      formatter = stub
+      options = stub(format: formatter)
+      suite = Snapdragon::Suite.new(options, stub)
+      suite.formatter.should eq (formatter)
+    end
   end
 
   describe "#spec_files" do
     it "creates a path object to represent the path" do
+      options = stub
       paths = ['path_a_str', 'path_b_str']
-      suite = Snapdragon::Suite.new(paths)
+      suite = Snapdragon::Suite.new(options, paths)
       Snapdragon::Path.should_receive(:new).with('path_a_str').and_return(stub(spec_files: []))
       Snapdragon::Path.should_receive(:new).with('path_b_str').and_return(stub(spec_files: []))
       suite.spec_files
     end
 
     it "returns the collection of the spec files of all of the paths" do
+      options = stub
       paths = ['path_a_str', 'path_b_str']
-      suite = Snapdragon::Suite.new(paths)
+      suite = Snapdragon::Suite.new(options, paths)
       spec_file_a = stub('spec_file_a'), spec_file_b = stub('spec_file_b')
       Snapdragon::Path.stub(:new).with('path_a_str').and_return(stub(spec_files: [spec_file_a]))
       Snapdragon::Path.stub(:new).with('path_b_str').and_return(stub(spec_files: [spec_file_b]))