ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

Test Runner

by André Cerqueira ST2/ST3

Sublime Text plugin for running tests.

Labels testing

Details

Installs

  • Total 2K
  • Win 761
  • OS X 741
  • Linux 383
Jul 19 Jul 18 Jul 17 Jul 16 Jul 15 Jul 14 Jul 13 Jul 12 Jul 11 Jul 10 Jul 9 Jul 8 Jul 7 Jul 6 Jul 5 Jul 4 Jul 3 Jul 2 Jul 1 Jun 30 Jun 29 Jun 28 Jun 27 Jun 26 Jun 25 Jun 24 Jun 23 Jun 22 Jun 21 Jun 20 Jun 19 Jun 18 Jun 17 Jun 16 Jun 15 Jun 14 Jun 13 Jun 12 Jun 11 Jun 10 Jun 9 Jun 8 Jun 7 Jun 6 Jun 5
Windows 0 1 2 0 1 0 1 0 0 0 1 1 0 0 1 0 0 1 0 1 0 0 0 0 1 0 0 0 0 1 0 1 0 1 1 0 1 1 0 0 1 1 0 0 1
OS X 0 1 0 0 0 0 0 0 0 0 0 0 0 0 1 2 0 1 0 0 0 0 0 0 0 0 3 1 0 0 1 0 0 0 0 0 0 0 0 0 0 1 0 0 1
Linux 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 0 0 0 1 0 0 0 0 1 0 0 0 1 0 0 0

Readme

Source
raw.​githubusercontent.​com

Sublime Test Runner

Runs tests on save, with status bar summary and details on output panel. It should work with any console/terminal runnable test framework which produces TAP output.

Installation

The easiest way to install is via the Sublime Package Control plugin. Bring down your Command Palette (Command+Shift+P on OS X, Control+Shift+P on Linux/Windows), open “Package Control: Install Package” (in your Command Palette) and search for “Test Runner”. That's it!

To install it manually without Git: Download the latest source from GitHub, copy the whole directory into the Packages directory and rename it to “Test Runner”.

To install it manually with Git: Clone the repository in your Sublime Text 2 Packages directory:

git clone https://github.com/accerqueira/sublime-test-runner.git "Test Runner"

The “Packages” directory should be located at:

  • OS X:

    ~/Library/Application\ Support/Sublime\ Text\ 2/Packages/

  • Linux:

    ~/.Sublime\ Text\ 2/Packages/
    or
    ~/.config/sublime-text-2/Packages/

  • Windows:

    %APPDATA%/Sublime Text 2/Packages/

The plugin should be picked up automatically. If not, restart Sublime Text.

Usage

Test Runner will, by default, run make test REPORTER=tap whenever you save a file. You can also bring down the Command Palette and look for “Test Runner” available commands.

As an example, you could use the following rules for node.js Makefile (assuming you have mocha for testing and istanbul for test coverage):

test:
    @./node_modules/mocha/bin/_mocha -R $(REPORTER)

test-cov:
    @./node_modules/istanbul/lib/cli.js cover ./node_modules/mocha/bin/_mocha -- -R $(REPORTER)

.PHONY: test test-cov

For test result coloring, you can add something like this to your color scheme file:

<dict>
    <key>name</key>
    <string>Test PASS</string>
    <key>scope</key>
    <string>test.status.pass</string>
    <key>settings</key>
    <dict>
        <key>foreground</key>
        <string>#33FF33</string>
    </dict>
</dict>
<dict>
    <key>name</key>
    <string>Test FAIL</string>
    <key>scope</key>
    <string>test.status.fail</string>
    <key>settings</key>
    <dict>
        <key>foreground</key>
        <string>#FF3333</string>
    </dict>
</dict>
<dict>
    <key>name</key>
    <string>Test SKIP</string>
    <key>scope</key>
    <string>test.status.skip</string>
    <key>settings</key>
    <dict>
        <key>foreground</key>
        <string>#999999</string>
    </dict>
</dict>
<dict>
    <key>name</key>
    <string>Test TODO</string>
    <key>scope</key>
    <string>test.status.todo</string>
    <key>settings</key>
    <dict>
        <key>foreground</key>
        <string>#FFFF33</string>
    </dict>
</dict>

For more customization, the following scopes are available…

  • …for tests marked as passed:

    • test.result.pass
    • test.status.pass
    • test.description.pass
  • …for tests marked as failed:

    • test.result.fail
    • test.status.fail
    • test.description.fail
  • …for tests marked as skipped:

    • test.result.skip
    • test.status.skip
    • test.description.skip
  • …for tests marked as todo:

    • test.result.todo
    • test.status.todo
    • test.description.todo