jcov 1.0.0

data/features/html_report.feature

@@ -0,0 +1,130 @@
+Feature: HTML Report
+  In order to know which exact lines are being executed
+  And to explore our source code
+  I want a persistant coverage report in HTML
+
+  Background:
+    Given a file named "public/javascripts/foo.js" with:
+    """
+    // this is a comment
+
+    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 "public/javascripts/bar.js" with:
+    """
+    var foo = 1;
+    var bar = 2;
+    var baz = 3;
+    """
+
+    And a file named "test/javascripts/runner.js" with:
+    """
+    load("public/javascripts/foo.js");
+    load("public/javascripts/bar.js");
+    error_count = 0;
+    """
+
+  Scenario: reports to an HTML file
+    When I run `jcov --report`
+    Then a file named "jcov/report.html" should exist
+
+  Scenario: reports individual files to their own HTML files
+    When I run `jcov --report`
+    Then a file named "jcov/public/javascripts/foo.js.html" should exist
+    Then a file named "jcov/public/javascripts/bar.js.html" should exist
+
+  Scenario: it copies a css file
+    When I run `jcov --report`
+    Then a file named "jcov/report.css" should exist
+
+  Scenario: has a list of ran files
+    When I run `jcov --report`
+    And I open the report
+    Then I should see "public/javascripts/foo.js (4/7) 57%"
+    And I should see "public/javascripts/bar.js (3/3) 100%"
+
+  Scenario: shows the total coverage
+    When I run `jcov --report`
+    And I open the report
+    And I should see "Total: (7/10) 70%"
+
+  Scenario: shows the total coverage in the title
+    When I run `jcov --report`
+    And I open the report
+    And I should see "JCov : 70%"
+
+  Scenario: shows empty source files
+    Given a file named "public/javascripts/foo.js" with:
+    """
+    // this is a comment
+    """
+    When I run `jcov --report`
+    And I open the report
+    Then I should see "public/javascripts/foo.js (EMPTY) 100%"
+
+  Scenario: click through to an individual file's report
+    When I run `jcov --report`
+    And I open the report
+    And I click "public/javascripts/foo.js"
+    Then I should see "public/javascripts/foo.js"
+
+  Scenario: can click back to the index
+    When I run `jcov --report`
+    And I open the report
+    And I click "public/javascripts/foo.js"
+    And I click "JCov"
+    Then I should be on /report.html
+
+  Scenario: see a file-level coverage percentage
+    When I run `jcov --report`
+    And I open the report
+    And I click "public/javascripts/foo.js"
+    Then I should see "57%"
+
+  Scenario: see covered lines
+    When I run `jcov --report`
+    And I open the report
+    And I click "public/javascripts/foo.js"
+    Then I should see these lines covered:
+      | line                      |
+      | var one = "foo";          |
+      | var z = 0;                |
+      | var two = function () {   |
+      | var three = function () { |
+
+  Scenario: see uncovered lines
+    When I run `jcov --report`
+    And I open the report
+    And I click "public/javascripts/foo.js"
+    Then I should see these lines not covered:
+      | line                           |
+      | for (var i = 0; i < 10; i++) { |
+      | z++;                           |
+      | two();                         |
+
+  Scenario: see uncoverable lines
+    When I run `jcov --report`
+    And I open the report
+    And I click "public/javascripts/foo.js"
+    Then I should see these lines uncoverable:
+      | line                           |
+      | // this is a comment           |
+
+  Scenario: it escapes HTML entities
+    When I run `jcov --report`
+    And I open the report
+    And I click "public/javascripts/foo.js"
+    Then I should see "for (var i = 0; i &lt; 10; i++)" in the HTML

data/features/javascript_interface.feature

@@ -0,0 +1,72 @@
+Feature: javascript interface
+  In order for my javascript test framework to run inside of jcov
+  it needs to have a set of interface methods
+
+  Scenario: I want to print a line
+    Given a file named "test/javascripts/runner.js" with:
+    """
+    println('foo');
+    println('bar');
+    """
+    When I run `jcov`
+    Then the output should contain:
+    """
+    foo
+    bar
+    """
+
+  Scenario: I want to print a line without a carrage return
+    Given a file named "test/javascripts/runner.js" with:
+    """
+    print('foo');
+    print('bar');
+    """
+    When I run `jcov`
+    Then the output should contain:
+    """
+    foobar
+    """
+
+  Scenario: I want to print a single character
+    Given a file named "test/javascripts/runner.js" with:
+    """
+    putc('.');
+    putc('.');
+    putc('.');
+    """
+    When I run `jcov`
+    Then the output should contain:
+    """
+    ...
+    """
+
+  Scenario: I want to read the contents of a file as a string
+    Given a file named "test/javascripts/runner.js" with:
+    """
+    var contents = readFile('foo.txt');
+    print(contents);
+    """
+    And a file named "foo.txt" with:
+    """
+    foo contents
+    """
+    When I run `jcov`
+    Then the output should contain:
+    """
+    foo contents
+    """
+
+  Scenario: I want to load a javascript file and have it executed
+    Given a file named "test/javascripts/runner.js" with:
+    """
+    load("test.js");
+    """
+    And a file named "test.js" with:
+    """
+    print("here I am");
+    """
+    When I run `jcov`
+    Then the output should contain:
+    """
+    here I am
+    """

data/features/reporting.feature

@@ -0,0 +1,108 @@
+Feature: reporting
+  In order to know how much of our 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: does not show a console coverage report unless asked
+    When I run `jcov`
+    Then the output should not contain:
+    """
+    Coverage Report
+    """
+
+  Scenario: shows a console coverage report when asked
+    When I run `jcov --report`
+    Then the output should contain:
+    """
+    Coverage Report
+    """
+    And the output should match:
+    """
+    public/javascripts/foo.js\s+\(4/7\)\s+57%
+    """
+
+  Scenario: reports on multiple files
+    Given a file named "public/javascripts/bar.js" with:
+    """
+    var foo = 1;
+    var bar = 2;
+    var baz = 3;
+    """
+    When I run `jcov --report`
+    Then the output should match:
+    """
+    public/javascripts/foo.js\s+\(4/7\)\s+57%
+    """
+    And the output should match:
+    """
+    public/javascripts/bar.js\s+\(0/3\)\s+0%
+    """
+
+  Scenario: only report on files actually run if --test is provided
+    Given a file named "public/javascripts/bar.js" with:
+    """
+    var foo = 1;
+    var bar = 2;
+    var baz = 3;
+    """
+    When I run `jcov --report --test foo`
+    Then the output should match:
+    """
+    public/javascripts/foo.js\s+\(4/7\)\s+57%
+    """
+    And the output should not contain:
+    """
+    public/javascripts/bar.js
+    """
+
+  Scenario: does not report on the runner if it's in the scripts directory
+    Given a file named "public/javascripts/runner.js" with:
+    """
+    load("public/javascripts/foo.js");
+    error_count = 0;
+    """
+    And a file named "jcov.yml" with:
+    """
+    test_runner: public/javascripts/runner.js
+    """
+    When I run `jcov --report`
+    Then the output should match:
+    """
+    public/javascripts/foo.js\s+\(4/7\)\s+57%
+    """
+    And the output should not contain:
+    """
+    public/javascripts/runner.js
+    """
+
+  Scenario: reports files as empty
+    Given a file named "public/javascripts/bar.js" with:
+    """
+    """
+    When I run `jcov --report`
+    Then the output should match:
+    """
+    public/javascripts/bar.js\s+\(EMPTY\)\s+100%
+    """

data/features/run.feature

@@ -0,0 +1,217 @@
+Feature: test runner
+  In order to test my Javascript without opening a browser
+  I want to use a tool that runs my tests headless.
+
+  Background:
+    Given a file named "public/javascripts/foo.js" with:
+    """
+    var z = 0;
+    """
+
+  Scenario: runs the runner.js file
+    Given a file named "test/javascripts/runner.js" with:
+    """
+    load("public/javascripts/foo.js");
+    println('foo');
+    """
+    When I run `jcov`
+    Then the output should contain:
+    """
+    foo
+    """
+
+  Scenario: reports success
+    Given a file named "test/javascripts/runner.js" with:
+    """
+    error_count = 0;
+    """
+    When I run `jcov`
+    Then the output should not contain:
+    """
+    Test Failures! :(
+    """
+    And the exit status should be 0
+
+  Scenario: reports the failures
+    Given a file named "test/javascripts/runner.js" with:
+    """
+    error_count = 3;
+    """
+    When I run `jcov`
+    Then the output should contain:
+    """
+    Test Failures! :(
+    """
+    And the exit status should not be 0
+
+  Scenario: provides the test framework the set of tests to run
+    Given a file named "test/javascripts/runner.js" with:
+    """
+    error_count = 0;
+    var t = JCov.tests;
+    for (var i = 0; i < t.length; i++) {
+      println(t[i]);
+    }
+    """
+    And an empty file named "test/javascripts/foo_test.js"
+    And an empty file named "test/javascripts/wazzle/bar_test.js"
+    When I run `jcov`
+    Then the output should contain:
+    """
+    test/javascripts/foo_test.js
+    test/javascripts/wazzle/bar_test.js
+    """
+    And the output should not contain:
+    """
+    test/javascripts/runner.js
+    """
+
+  Scenario: allows the user to run a focused test
+    Given a file named "test/javascripts/runner.js" with:
+    """
+    error_count = 0;
+    var t = JCov.tests;
+    for (var i = 0; i < t.length; i++) {
+      println(t[i]);
+    }
+    """
+    And an empty file named "test/javascripts/foo_test.js"
+    And an empty file named "test/javascripts/wazzle/bar_test.js"
+    When I run `jcov --test test/javascripts/wazzle/bar_test.js`
+    Then the output should contain:
+    """
+    test/javascripts/wazzle/bar_test.js
+    """
+    And the output should not contain:
+    """
+    test/javascripts/foo_test.js
+    """
+
+  Scenario: allows the user to run a focused test without the --test switch
+    Given a file named "test/javascripts/runner.js" with:
+    """
+    error_count = 0;
+    var t = JCov.tests;
+    for (var i = 0; i < t.length; i++) {
+      println(t[i]);
+    }
+    """
+    And an empty file named "test/javascripts/foo_test.js"
+    And an empty file named "test/javascripts/wazzle/bar_test.js"
+    When I run `jcov test/javascripts/wazzle/bar_test.js`
+    Then the output should contain:
+    """
+    test/javascripts/wazzle/bar_test.js
+    """
+    And the output should not contain:
+    """
+    test/javascripts/foo_test.js
+    """
+
+  Scenario: allows the user to run multiple focused tests
+    Given a file named "test/javascripts/runner.js" with:
+    """
+    error_count = 0;
+    var t = JCov.tests;
+    for (var i = 0; i < t.length; i++) {
+      println(t[i]);
+    }
+    """
+    And an empty file named "test/javascripts/foo_test.js"
+    And an empty file named "test/javascripts/wazzle/bar_test.js"
+    And an empty file named "test/javascripts/furble/baz_test.js"
+    When I run `jcov test/javascripts/wazzle/bar_test.js test/javascripts/furble/baz_test.js`
+    Then the output should contain:
+    """
+    test/javascripts/furble/baz_test.js
+    test/javascripts/wazzle/bar_test.js
+    """
+    And the output should not contain:
+    """
+    test/javascripts/foo_test.js
+    """
+
+  Scenario: allows the user to match tests with a regex
+    Given a file named "test/javascripts/runner.js" with:
+    """
+    error_count = 0;
+    var t = JCov.tests;
+    for (var i = 0; i < t.length; i++) {
+      println(t[i]);
+    }
+    """
+    And an empty file named "test/javascripts/foo_test.js"
+    And an empty file named "test/javascripts/wazzle/bar_test.js"
+    When I run `jcov --test "wa[z]{2}le"`
+    Then the output should contain:
+    """
+    test/javascripts/wazzle/bar_test.js
+    """
+    And the output should not contain:
+    """
+    test/javascripts/foo_test.js
+    """
+
+  Scenario: configuration is available to the javascript context
+    Given a file named "jcov.yml" with:
+    """
+    threshold: 33
+    """
+    And a file named "test/javascripts/runner.js" with:
+    """
+    error_count = 0;
+    println(JCov.config.threshold);
+    """
+    When I run `jcov`
+    Then the output should contain:
+    """
+    33
+    """
+
+  Scenario: user can enable verbose mode
+    Given a file named "test/javascripts/runner.js" with:
+    """
+    error_count = 0;
+    println(JCov.options.verbose);
+    """
+    When I run `jcov --verbose`
+    Then the output should contain:
+    """
+    true
+    """
+
+  Scenario: user can disable color output
+    Given a file named "test/javascripts/runner.js" with:
+    """
+    error_count = 0;
+    println(JCov.options.color);
+    """
+    When I run `jcov --no-color`
+    Then the output should contain:
+    """
+    false
+    """
+
+  Scenario: user can enable color output
+    Given a file named "test/javascripts/runner.js" with:
+    """
+    error_count = 0;
+    println(JCov.options.color);
+    """
+    When I run `jcov --color`
+    Then the output should contain:
+    """
+    true
+    """
+
+  Scenario: color defaults to off in a non-interactive shell (which cucumber is)
+    Given a file named "test/javascripts/runner.js" with:
+    """
+    error_count = 0;
+    println(JCov.options.color);
+    """
+    When I run `jcov`
+    Then the output should contain:
+    """
+    false
+    """