jcov 1.0.0

data/examples/jspec/jspec/runner.js

@@ -0,0 +1,66 @@
+// JSpec reporter uses print as println
+print = println;
+
+load('jspec/lib/jspec.js');
+
+load('jspec/ext/slowness.js')
+
+JSpec._globalScope = this;
+
+JSpec._globals = {};
+// capture the current globals
+JSpec.captureGlobals = function () {
+  for (var i in JSpec._globalScope) {
+    JSpec._globals[i] = true;
+  }
+};
+// remove globals we haven't previously captured
+JSpec.cullGlobals = function () {
+  for (var i in JSpec._globalScope) {
+    if (!JSpec._globals[i]) {
+      delete JSpec._globalScope[i];
+    }
+  }
+};
+
+if (JCov.options.verbose) {
+  load('jspec/ext/trace.js')
+} else {
+  JSpec.include({
+    afterSpec: function (spec) {
+      putc((spec.requiresImplementation()) ? '*' : (spec.passed()) ? '.' : 'F');
+    }
+  });
+}
+
+JSpec.include({
+  afterSuite: function (suite) {
+    if (!suite.name) { // it's the top level suite
+      JSpec.cullGlobals();
+    }
+  }
+});
+
+// defining quit so jspec doesn't complain
+quit = function () {
+};
+
+TESTS = JCov.tests;
+
+if (TESTS.length == 1) {
+  print("Testing '"+TESTS[0]+"'");
+}
+
+thing = JSpec;
+for (var i = 0; i < TESTS.length; i++) {
+  thing = thing.exec(TESTS[i]);
+}
+
+JSpec.captureGlobals();
+
+thing
+.run({reporter:      JSpec.reporters.Terminal,
+      failuresOnly:  true,
+      fixturePath:   'jspec/fixtures',
+      disableColors: !JCov.options.color})
+.report();

data/examples/jspec/tests/mean_spec.js

@@ -0,0 +1,15 @@
+describe("mean.js", function () {
+  before(function () {
+    load("javascripts/mean.js");
+  });
+
+  describe("Math.prototype.mean", function () {
+    it("returns the average for an array of numbers", function () {
+      Math.mean([1,2,3,4,5,10]).should.equal 4.166666666666667
+    });
+
+    it("returns 0 for empty arrays", function () {
+      Math.mean([]).should.equal 0
+    });
+  });
+});

data/features/configuration.feature

@@ -0,0 +1,134 @@
+Feature: configuration
+  In order to use this tool effectively,
+  I want to configure it for my environment.
+
+  Background:
+    Given a file named "config/jcov.yml" with:
+    """
+    threshold: 76.8
+    threshold_must_match: true
+    """
+
+  Scenario: it can print out its loaded configuration
+    When I run `jcov check`
+    Then the output should contain:
+    """
+    threshold: 76.8
+    threshold_must_match: true
+    """
+
+  Scenario: it can have its configuration location overridden
+    Given a file named "foo/bar.yml" with:
+    """
+    threshold: 10
+    """
+    When I run `jcov check --config=foo/bar.yml`
+    Then the output should contain:
+    """
+    threshold: 10
+    """
+
+  Scenario: looks for its configuration in a set of logical places
+    Given a file named "jcov.yml" with:
+    """
+    threshold: 33
+    """
+    When I remove the file "config/jcov.yml"
+    When I run `jcov check`
+    Then the output should contain:
+    """
+    threshold: 33
+    """
+
+  Scenario: uses its default configuration if it can't find a configuration file
+    When I remove the file "config/jcov.yml"
+    When I run `jcov check`
+    Then the output should contain:
+    """
+    source_directory: public/javascripts
+    """
+
+  Scenario: it merges configuration with the defaults
+    When I run `jcov check`
+    Then the output should contain:
+    """
+    source_directory: public/javascripts
+    """
+    And the output should contain:
+    """
+    threshold: 76.8
+    """
+
+  Scenario: it complains if we provide a configuration file that doesn't exist
+    When I run `jcov check --config=not/a/file.yml`
+    Then the output should contain:
+    """
+    Cannot find file "not/a/file.yml"
+    """
+
+  Scenario: configures where to look for the test files
+    When I run `jcov check`
+    Then the output should contain:
+    """
+    test_directory:
+    """
+
+  Scenario: configures where to find the source files
+    When I run `jcov check`
+    Then the output should contain:
+    """
+    source_directory:
+    """
+
+  Scenario: configures which javascript file runs the tests
+    When I run `jcov check`
+    Then the output should contain:
+    """
+    test_runner:
+    """
+
+  Scenario: configures where to look for errors in javascript land
+    When I run `jcov check`
+    Then the output should contain:
+    """
+    error_field:
+    """
+
+  Scenario: has defaults for all the configuration values
+    When I remove the file "config/jcov.yml"
+    When I run `jcov check`
+    Then the output should contain:
+    """
+    test_directory: test/javascripts
+    """
+    And the output should contain:
+    """
+    source_directory: public/javascripts
+    """
+    And the output should contain:
+    """
+    test_runner: test/javascripts/runner.js
+    """
+    And the output should contain:
+    """
+    error_field: error_count
+    """
+    And the output should contain:
+    """
+    report_output_directory: jcov
+    """
+
+  Scenario: it prints out what file it is using
+    When I run `jcov check`
+    Then the output should contain:
+    """
+    Using configuration file: config/jcov.yml
+    """
+
+  Scenario: if it can't find a file it tells us that
+    When I remove the file "config/jcov.yml"
+    When I run `jcov check`
+    Then the output should contain:
+    """
+    No configuration file! Using defaults.
+    """

data/features/coverage.feature

@@ -0,0 +1,246 @@
+Feature: coverage
+  In order to make sure code is being executed
+  I want to report coverage statistics
+
+  Background:
+    Given a file named "public/javascripts/foo.js" with:
+    """
+    var one = "foo";                  // 1
+    var z = 0;                        // 2
+
+    var two = function () {           // 3
+      for (var i = 0; i < 10; i++) {  // 4
+        z++;                          // 5
+      }
+    };
+
+    var three = function () {         // 6
+      two();                          // 7
+    };
+
+    """
+    And a file named "test/javascripts/runner.js" with:
+    """
+    load("public/javascripts/foo.js");
+    error_count = 0;
+    """
+
+  Scenario: it will report coverage
+    When I run `jcov`
+    Then the output should contain:
+    """
+    Total Coverage: (4/7) 57.1%
+    """
+
+  Scenario: it will not report coverage when disabled
+    When I run `jcov --no-coverage`
+    Then the output should not contain:
+    """
+    Total Coverage:
+    """
+
+  Scenario: it will report slightly more coverage
+    Given a file named "test/javascripts/runner.js" with:
+    """
+    load("public/javascripts/foo.js");
+    two();
+    error_count = 0;
+    """
+    When I run `jcov`
+    Then the output should contain:
+    """
+    Total Coverage: (6/7) 85.7%
+    """
+
+  Scenario: it will report full coverage
+    Given a file named "test/javascripts/runner.js" with:
+    """
+    load("public/javascripts/foo.js");
+    three();
+    error_count = 0;
+    """
+    When I run `jcov`
+    Then the output should contain:
+    """
+    Total Coverage: (7/7) 100.0%
+    """
+
+  Scenario: it reports correctly if we don't load any files
+    Given a file named "test/javascripts/runner.js" with:
+    """
+    error_count = 0;
+    """
+    When I run `jcov`
+    Then the output should contain:
+    """
+    Total Coverage: (0/7) 0.0%
+    """
+
+  Scenario: it will report coverage across all files even if they're not loaded
+    Given a file named "test/javascripts/runner.js" with:
+    """
+    load("public/javascripts/foo.js");
+    three();
+    error_count = 0;
+    """
+    And a file named "public/javascripts/bar.js" with:
+    """
+    var foo = 1;
+    var bar = 2;
+    var baz = 3;
+    """
+    When I run `jcov`
+    Then the output should contain:
+    """
+    Total Coverage: (7/10) 70.0%
+    """
+
+  Scenario: reports an error message if the coverage is below the threshold
+    Given a file named "jcov.yml" with:
+    """
+    threshold: 80
+    """
+    When I run `jcov`
+    Then the output should contain:
+    """
+    FAIL! Coverage is lower than threshold! 57.1% < 80% :(
+    """
+
+  Scenario: doesn't report an error message if the coverage is above the threshold
+    Given a file named "jcov.yml" with:
+    """
+    threshold: 40
+    """
+    When I run `jcov`
+    Then the output should not contain:
+    """
+    FAIL!
+    """
+
+  Scenario: reports an error message if the coverage is above the threshold and threshold_must_match == true
+    Given a file named "jcov.yml" with:
+    """
+    threshold: 40
+    threshold_must_match: true
+    """
+    When I run `jcov`
+    Then the output should contain:
+    """
+    Coverage does not match threshold! 57.1% != 40%
+    """
+
+  Scenario: tells you where to update threshold if it does not match
+    Given a file named "jcov.yml" with:
+    """
+    threshold: 40
+    threshold_must_match: true
+    """
+    When I run `jcov`
+    Then the output should contain:
+    """
+    Please raise the threshold in ./jcov.yml
+    """
+
+  Scenario: tells you where to update threshold if it does not match even if the file is not in a typical location
+    Given a file named "foo/bar/jcov.yml" with:
+    """
+    threshold: 40
+    threshold_must_match: true
+    """
+    When I run `jcov --config foo/bar/jcov.yml`
+    Then the output should contain:
+    """
+    Please raise the threshold in foo/bar/jcov.yml
+    """
+
+  Scenario: doesn't report a threshold error message if the threshold is not set
+    When I run `jcov`
+    Then the output should not contain:
+    """
+    FAIL!
+    """
+
+  Scenario: returns a zero exit status if coverage is above the threshold
+    Given a file named "jcov.yml" with:
+    """
+    threshold: 40
+    """
+    When I run `jcov`
+    And the exit status should be 0
+
+  Scenario: returns a non-zero exit status if coverage is below the threshold
+    Given a file named "jcov.yml" with:
+    """
+    threshold: 80
+    """
+    When I run `jcov`
+    And the exit status should not be 0
+
+  Scenario: returns a non-zero exit status if coverage is above the threshold and threshold_must_match == true
+    Given a file named "jcov.yml" with:
+    """
+    threshold: 40
+    threshold_must_match = true
+    """
+    When I run `jcov`
+    Then the exit status should not be 0
+
+  Scenario: gives a helpful message if no files were checked for coverage
+    Given a file named "jcov.yml" with:
+    """
+    ignore:
+      - foo
+    """
+    When I run `jcov`
+    Then the output should contain:
+    """
+    No files were checked for coverage. Maybe your ignore list in ./jcov.yml is too inclusive?
+    """
+
+  Scenario: don't check coverage if we're running focused tests
+    Given a file named "jcov.yml" with:
+    """
+    threshold: 80
+    """
+    When I run `jcov public/javascripts/foo.js`
+    Then the exit status should be 0
+    And the output should not contain "FAIL"
+    And the output should not contain "Total Coverage"
+
+  Scenario: don't check coverage if we're running regex focused tests
+    Given a file named "jcov.yml" with:
+    """
+    threshold: 80
+    """
+    When I run `jcov --test foo`
+    Then the exit status should be 0
+    And the output should not contain "FAIL"
+    And the output should not contain "Total Coverage"
+
+
+  Scenario: functions should be reported as covered
+    Given a file named "public/javascripts/foo.js" with:
+    """
+    function foo() {
+      var bar = 0;
+    }
+    """
+    When I run `jcov`
+    Then the output should contain:
+    """
+    Total Coverage: (1/2) 50.0%
+    """
+
+  Scenario: ignores comments
+    Given a file named "public/javascripts/foo.js" with:
+    """
+    // one
+    // two
+    var bar = 0;
+    // three
+    """
+    When I run `jcov`
+    Then the output should contain:
+    """
+    Total Coverage: (1/1) 100.0%
+    """