js-test-driver-rails 0.3.4 → 0.4.0

data/.gitignore

@@ -4,3 +4,4 @@
 jsTestDriver.conf
 pkg/*
 tags
+.js_test_driver

data/README.markdown

@@ -76,6 +76,21 @@ If you want to user Jasmine, simply add:
 
 in your config file, somewhere before including your test files and you are golden:)
 
+Measuring code coverage
+-----------------------
+
+JsTestDriver has a pretty cool feature of being able to measure code coverage. To enable this in your config, you just need to add:
+
+    measure_coverage
+
+in your config file.
+
+You need to have lcov installed for the HTML report to be generated:
+
+    sudo apt-get install lcov
+
+The HTML coverage report will be saved in the .js_test_driver/tests/coverage directory.
+
 Rake tasks
 ----------
 

data/Rakefile

@@ -2,7 +2,7 @@ require 'rake/testtask'
 
 Rake::TestTask.new("test") do |test|
   test.libs << 'test'
-  test.pattern = 'test/unit/**/*_test.rb'
+  test.pattern = 'test/**/*_test.rb'
   test.verbose = true
 end
 

data/lib/js_test_driver/config.rb

@@ -59,12 +59,29 @@ module JsTestDriver
     #
     # There's no hacks or modifications here, so this method is just for the users convenience
     def enable_jasmine
-      this_directory = File.dirname(__FILE__)
-      vendor_directory = File.expand_path(File.join('..', '..', 'vendor'), this_directory)
       includes File.join(vendor_directory, "jasmine.js")
       includes File.join(vendor_directory, "JasmineAdapter.js")
     end
 
+    # Adds a JsTestDriver plugin for measuring coverage to the configuration
+    def measure_coverage
+      @measure_coverage = true
+      self.plugins << {
+        'name' => 'coverage',
+        'jar' => File.join(vendor_directory, 'coverage.jar'),
+        'module' => 'com.google.jstestdriver.coverage.CoverageModule'
+      }
+    end
+
+    def measure_coverage?
+      !!@measure_coverage
+    end
+
+    # Plugins to include in the config
+    def plugins
+      @plugins ||= []
+    end
+
     # config variable which has a regular setter,
     # but also can be set by calling the "getter" with an argument
     # and if called without an argument the getter will return the passed block
@@ -125,6 +142,7 @@ module JsTestDriver
       hash = {'server' => server, 'basepath' => base_path}
       hash['load'] = loaded_files unless loaded_files.empty?
       hash['exclude'] = map_paths(excluded_files) unless excluded_files.empty?
+      hash['plugin'] = plugins unless plugins.empty?
       return hash.to_yaml
     end
 
@@ -153,6 +171,11 @@ module JsTestDriver
 
     private
 
+    def vendor_directory
+      this_directory = File.dirname(__FILE__)
+      return File.expand_path(File.join('..', '..', 'vendor'), this_directory)
+    end
+
     def expand_globs(paths)
       with_expanded_paths = paths.map{|path| File.expand_path(path)}
       return with_expanded_paths.map{|path| path.include?('*') ? Dir[path] : path}.flatten

data/lib/js_test_driver/runner.rb

@@ -83,7 +83,7 @@ module JsTestDriver
       command.run
     end
 
-    def start_server_capture_and_run(tests, browsers, output_xml_path = nil, console = nil)
+    def start_server_capture_and_run(tests = nil, browsers = nil, output_xml_path = nil, console = nil)
       command = execute_jar
 
       add_start_server(command)
@@ -93,7 +93,13 @@ module JsTestDriver
       add_output_directory(command, output_xml_path) if output_xml_path
       add_capture_console(command) if console
 
-      command.run
+      result = command.run
+
+      if config.measure_coverage? && output_xml_path
+        generate_html_coverage_report(output_xml_path)
+      end
+
+      return result
     end
 
     def add_start_server(command)
@@ -129,8 +135,28 @@ module JsTestDriver
       Command.new('java').option('-jar', jar_path)
     end
 
+    def generate_html_coverage_report(output_path)
+      unless genhtml_installed?
+        puts "Could not find genhtml. You must install lcov (sudo apt-get install lcov)"
+        return
+      end
+
+      output_path = File.expand_path(output_path)
+
+      config_file_name = File.basename(config_yml_path)
+      coverage_file_name = config_file_name + '-coverage.dat'
+      coverage_file_path = File.join(output_path, coverage_file_name)
+      coverage_out_dir = File.join(output_path, 'coverage')
+
+      system("genhtml -o #{coverage_out_dir} #{coverage_file_path}")
+    end
+
     protected
 
+    def genhtml_installed?
+      !%x[which genhtml].strip.empty?
+    end
+
     def parse_config
       source = ""
       if File.exist?(config_path)

data/lib/js_test_driver/version.rb

@@ -1,3 +1,3 @@
 module JsTestDriver
-  VERSION = "0.3.4"
+  VERSION = "0.4.0"
 end

data/test/integration/sample_test.rb

@@ -0,0 +1,15 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'test_helper'))
+
+module JsTestDriver
+  class SampleTest < Test::Unit::TestCase
+
+    def test_running_sample_specs
+      config = JsTestDriver::Runner.new(:config_path => File.expand_path('../../sample/config/js_test_driver.rb', __FILE__))
+
+      output_path = File.expand_path('../../../.js_test_driver/', __FILE__)
+
+      assert config.start_server_capture_and_run(nil, nil, output_path), 'running tests should return a success'
+    end
+
+  end
+end

data/test/sample/config/js_test_driver.rb

@@ -0,0 +1,11 @@
+includes 'test/sample/lib/*.js'
+
+['google-chrome', 'firefox', 'chromium-browser'].select{|b| !%x[which #{b}].strip.empty? }.each do |b|
+  browser b
+end
+
+enable_jasmine
+measure_coverage
+
+includes 'test/sample/specs/spec_helper.js'
+includes 'test/sample/specs/**/*_spec.js'

data/test/sample/lib/calculator.js

@@ -0,0 +1,15 @@
+function Calculator(initialValue) {
+  this.value = initialValue;
+}
+
+Calculator.prototype = {
+  add: function(val) {
+    this.value += val;
+  },
+  multiply: function(val) {
+    this.value *= val;
+  },
+  sub: function(val) {
+    this.value -= val;
+  }
+};

data/test/sample/specs/calculator_spec.js

@@ -0,0 +1,19 @@
+describe('Calculator', function () {
+  var calc;
+
+  beforeEach(function () {
+    calc = new Calculator(2);
+  });
+
+  it('adds values', function() {
+    calc.add(2);
+
+    expect(calc.value).toEqual(4);
+  });
+
+  it('multiplies values', function() {
+    calc.multiply(3);
+
+    expect(calc.value).toEqual(6);
+  });
+});

data/test/sample/specs/spec_helper.js

@@ -0,0 +1,4 @@
+// nothing to see here
+
+function hello() {
+}

data/test/unit/config_test.rb

@@ -253,5 +253,18 @@ module JsTestDriver
       assert Dir[config.included_files[1]].size > 0
     end
 
+    def test_with_coverage_measuring_enabled
+      # given
+      config = given_an_empty_config
+
+      # when
+      config.measure_coverage
+
+      # then
+      assert_config_includes config, 'plugin' => [{'name' => 'coverage',
+        'jar' => File.expand_path('../../../vendor/coverage.jar', __FILE__),
+        'module' => 'com.google.jstestdriver.coverage.CoverageModule'}]
+    end
+
   end
 end

data/test/unit/runner_test.rb

@@ -92,5 +92,16 @@ module JsTestDriver
       runner.start_server_capture_and_run('TestCase', 'aaa,bbb', '.js_test_driver', true)
     end
 
+    def test_when_measuring_coverage
+      config = JsTestDriver::Config.new
+      config.measure_coverage
+      runner = given_a_runner(:config => config)
+
+      JsTestDriver::Runner::Command.any_instance.expects(:system)
+      runner.expects(:system).with("genhtml -o #{File.expand_path('.js_test_driver/coverage')} #{File.expand_path('.js_test_driver/jsTestDriver.conf-coverage.dat')}")
+
+      runner.start_server_capture_and_run(nil, 'aaa', '.js_test_driver')
+    end
+
   end
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 3
   - 4
-  version: 0.3.4
+  - 0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Adam Pohorecki
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-20 00:00:00 +02:00
+date: 2011-04-27 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -87,12 +87,18 @@ files:
 - test/fixtures/foo/a.html
 - test/fixtures/foo/bar/a.html
 - test/fixtures/hello.txt
+- test/integration/sample_test.rb
+- test/sample/config/js_test_driver.rb
+- test/sample/lib/calculator.js
+- test/sample/specs/calculator_spec.js
+- test/sample/specs/spec_helper.js
 - test/test_helper.rb
 - test/unit/config_test.rb
 - test/unit/html_fixture_test.rb
 - test/unit/runner_test.rb
 - vendor/JasmineAdapter.js
 - vendor/VERSIONS
+- vendor/coverage.jar
 - vendor/jasmine.js
 - vendor/js_test_driver.jar
 has_rdoc: true