Skip to content

Commit

Permalink
chore: rename this shit to Karma
Browse files Browse the repository at this point in the history 
BREAKING CHANGE: this breaks in couple of ways
- whenever you call the "testacular" binary, change it to "karma", eg. `testacular start` becomes `karma start`.
- if you rely on default name of the config file, change it to `karma.conf.js`.
- if you access `__testacular__` object in the client code, change it to `__karma__`, eg. `window.__testacular__.files` becomes `window.__karma__.files`.
Conflicts:
	CHANGELOG.md
	CONTRIBUTING.md
	README.md
	Testacular.sublime-project
	adapter/angular-scenario.wrapper
	adapter/jasmine.wrapper
	adapter/mocha.wrapper
	adapter/qunit.wrapper
	adapter/require.wrapper
	lib/init.js
	lib/server.js
	static/testacular.src.js
	test/client/jasmine.spec.js
	test/e2e/basic/karma.conf.js
	test/e2e/mocha/karma.conf.js
	test/e2e/qunit/karma.conf.js
	test/unit/logger.spec.coffee
  • Loading branch information
@vojtajina
vojtajina committed Mar 19, 2013
1 parent 8c138b5 commit 2b2044e
Show file tree
Hide file tree
Showing 38 changed files with 123 additions and 228 deletions.
2 changes: 1 addition & 1 deletion .npmignore
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ jsl.conf
Gruntfile.coffee
changelog.sh

Testacular.sublime-*
Karma.sublime-*
screencast*

adapter/jasmine.src.js
Expand Down
46 changes: 28 additions & 18 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
<a name="v0.6.1"></a>
### v0.6.1 (2013-03-18)


#### Bug Fixes

* **config:** do not change urlRoot even if proxied ([1be1ae1d](https://github.com/karma-runner/karma/commit/1be1ae1dc7ff7314f4ac2854815cb39d31362f14))
* **coverage:** always send a result object ([2d210aa6](https://github.com/karma-runner/karma/commit/2d210aa6697991f2eba05de58a696c5210485c88), closes [#365](https://github.com/karma-runner/karma/issues/365))
* **reporter.teamcity:** report spec names and proper browser name ([c8f6f5ea](https://github.com/karma-runner/karma/commit/c8f6f5ea0c5c40d37b511d51b49bd22c9da5ea86))

<a name="v0.6.0"></a>
## v0.6.0 (2013-02-22)

Expand All @@ -7,32 +17,32 @@

#### Bug Fixes

* **adapter.requirejs:** do not configure baseUrl automatically ([63f3f409](https://github.com/testacular/testacular/commit/63f3f409ae85a5137396a7ed6537bedfe4437cb3), closes [#291](https://github.com/testacular/testacular/issues/291))
* **init:** add missing browsers (Opera, IE) ([f39e5645](https://github.com/testacular/testacular/commit/f39e5645ec561c2681d907f7c1611f01911ee8fd))
* **reporter.junit:** Add browser log output to JUnit.xml ([f108799a](https://github.com/testacular/testacular/commit/f108799a4d8fd95b8c0250ee83c23ada25d026b9), closes [#302](https://github.com/testacular/testacular/issues/302))
* **adapter.requirejs:** do not configure baseUrl automatically ([63f3f409](https://github.com/karma-runner/karma/commit/63f3f409ae85a5137396a7ed6537bedfe4437cb3), closes [#291](https://github.com/karma-runner/karma/issues/291))
* **init:** add missing browsers (Opera, IE) ([f39e5645](https://github.com/karma-runner/karma/commit/f39e5645ec561c2681d907f7c1611f01911ee8fd))
* **reporter.junit:** Add browser log output to JUnit.xml ([f108799a](https://github.com/karma-runner/karma/commit/f108799a4d8fd95b8c0250ee83c23ada25d026b9), closes [#302](https://github.com/karma-runner/karma/issues/302))


#### Features

* add Teamcity reporter ([03e700ae](https://github.com/testacular/testacular/commit/03e700ae2234ca7ddb8f9235343e3b0c80868bbd))
* **adapter.jasmine:** remove only last failed specs anti-feature ([435bf72c](https://github.com/testacular/testacular/commit/435bf72cb12112462940c8114fbaa19f9de38531), closes [#148](https://github.com/testacular/testacular/issues/148))
* **config:** allow empty config file when called programmatically ([f3d77424](https://github.com/testacular/testacular/commit/f3d77424009f621e1fb9d60eeec7f052ebb3c585), closes [#358](https://github.com/testacular/testacular/issues/358))
* add Teamcity reporter ([03e700ae](https://github.com/karma-runner/karma/commit/03e700ae2234ca7ddb8f9235343e3b0c80868bbd))
* **adapter.jasmine:** remove only last failed specs anti-feature ([435bf72c](https://github.com/karma-runner/karma/commit/435bf72cb12112462940c8114fbaa19f9de38531), closes [#148](https://github.com/karma-runner/karma/issues/148))
* **config:** allow empty config file when called programmatically ([f3d77424](https://github.com/karma-runner/karma/commit/f3d77424009f621e1fb9d60eeec7f052ebb3c585), closes [#358](https://github.com/karma-runner/karma/issues/358))

<a name="v0.5.10"></a>
### v0.5.10 (2013-02-14)


#### Bug Fixes

* **init:** fix the logger configuration ([481dc3fd](https://github.com/testacular/testacular/commit/481dc3fd75f45a0efa8aabdb1c71e8234b9e8a06), closes [#340](https://github.com/testacular/testacular/issues/340))
* **proxy:** fix crashing proxy when browser hangs connection ([1c78a01a](https://github.com/testacular/testacular/commit/1c78a01a19411accb86f0bde9e040e5088752575))
* **init:** fix the logger configuration ([481dc3fd](https://github.com/karma-runner/karma/commit/481dc3fd75f45a0efa8aabdb1c71e8234b9e8a06), closes [#340](https://github.com/karma-runner/karma/issues/340))
* **proxy:** fix crashing proxy when browser hangs connection ([1c78a01a](https://github.com/karma-runner/karma/commit/1c78a01a19411accb86f0bde9e040e5088752575))


#### Features

* set urlRoot to /__testacular__/ when proxying the root ([8b4fd64d](https://github.com/testacular/testacular/commit/8b4fd64df6b7d07b5479e43dcd8cd2aa5e1efc9c))
* **adapter.requirejs:** normalize paths before appending timestamp ([94889e7d](https://github.com/testacular/testacular/commit/94889e7d2de701c67a2612e3fc6a51bfae891d36))
* update dependencies to the latest ([93f96278](https://github.com/testacular/testacular/commit/93f9627817f2d5d9446de9935930ca85cfa7df7f), [e34d8834](https://github.com/testacular/testacular/commit/e34d8834d69ec4e022fcd6e1be4055add96d693c))
* set urlRoot to /__karma__/ when proxying the root ([8b4fd64d](https://github.com/karma-runner/karma/commit/8b4fd64df6b7d07b5479e43dcd8cd2aa5e1efc9c))
* **adapter.requirejs:** normalize paths before appending timestamp ([94889e7d](https://github.com/karma-runner/karma/commit/94889e7d2de701c67a2612e3fc6a51bfae891d36))
* update dependencies to the latest ([93f96278](https://github.com/karma-runner/karma/commit/93f9627817f2d5d9446de9935930ca85cfa7df7f), [e34d8834](https://github.com/karma-runner/karma/commit/e34d8834d69ec4e022fcd6e1be4055add96d693c))


<a name="v0.5.9"></a>
Expand All @@ -41,16 +51,16 @@

#### Bug Fixes

* **adapter.requirejs:** show error if no timestamp defined for a file ([59dbdbd1](https://github.com/testacular/testacular/commit/59dbdbd136baa87467b9b9a4cb6ce226ae87bbef))
* **init:** fix logger configuration ([557922d7](https://github.com/testacular/testacular/commit/557922d71941e0929f9cdc0d3794424a1f27b311))
* **reporter:** remove newline from base reporter browser dump ([dfae18b6](https://github.com/testacular/testacular/commit/dfae18b63b413a1e6240d00b9dc0521ac0386ec5), closes [#297](https://github.com/testacular/testacular/issues/297))
* **reporter.dots:** only add newline to message when needed ([dbe1155c](https://github.com/testacular/testacular/commit/dbe1155cb57fc4caa792f83f45288238db0fc7e0)
* **adapter.requirejs:** show error if no timestamp defined for a file ([59dbdbd1](https://github.com/karma-runner/karma/commit/59dbdbd136baa87467b9b9a4cb6ce226ae87bbef))
* **init:** fix logger configuration ([557922d7](https://github.com/karma-runner/karma/commit/557922d71941e0929f9cdc0d3794424a1f27b311))
* **reporter:** remove newline from base reporter browser dump ([dfae18b6](https://github.com/karma-runner/karma/commit/dfae18b63b413a1e6240d00b9dc0521ac0386ec5), closes [#297](https://github.com/karma-runner/karma/issues/297))
* **reporter.dots:** only add newline to message when needed ([dbe1155c](https://github.com/karma-runner/karma/commit/dbe1155cb57fc4caa792f83f45288238db0fc7e0)

#### Features

* add "debug" button to easily open debugging window ([da85aab9](https://github.com/testacular/testacular/commit/da85aab927edd1614e4e05b136dee834344aa3cb))
* **config:** support running on a custom hostname ([b8c5fe85](https://github.com/testacular/testacular/commit/b8c5fe8533b13fd59cbf48972d2021069a84ae5b))
* **reporter.junit:** add a 'skipped' tag for skipped testcases ([6286406e](https://github.com/testacular/testacular/commit/6286406e0a36a61125ea16d6f49be07030164cb0), closes [#321](https://github.com/testacular/testacular/issues/321))
* add "debug" button to easily open debugging window ([da85aab9](https://github.com/karma-runner/karma/commit/da85aab927edd1614e4e05b136dee834344aa3cb))
* **config:** support running on a custom hostname ([b8c5fe85](https://github.com/karma-runner/karma/commit/b8c5fe8533b13fd59cbf48972d2021069a84ae5b))
* **reporter.junit:** add a 'skipped' tag for skipped testcases ([6286406e](https://github.com/karma-runner/karma/commit/6286406e0a36a61125ea16d6f49be07030164cb0), closes [#321](https://github.com/karma-runner/karma/issues/321))


### v0.5.8
Expand Down
24 changes: 12 additions & 12 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# How to contribute
If you are thinking about making Testacular better, or you just want to hack on it, that’s great! Here
If you are thinking about making Karma better, or you just want to hack on it, that’s great! Here
are some tips to get you started.

## Getting Started

* Make sure you have a [GitHub account](https://github.com/signup/free)
* Consider [submiting a ticket](https://github.com/vojtajina/testacular/issues/new) for your issue,
* Consider [submiting a ticket](https://github.com/karma-runner/karma/issues/new) for your issue,
assuming one does not already exist.
* Clearly describe the issue including steps to reproduce when it is a bug.
* Make sure you fill in the earliest version that you know has the issue.
Expand All @@ -14,11 +14,11 @@ are some tips to get you started.
* Fork the repository on GitHub

## Initial setup
* Clone your fork. For these instructions, we assume you cloned into '~/github/testacular'.
* Clone your fork. For these instructions, we assume you cloned into '~/github/karma'.
* Install dependencies:

```bash
$ cd ~/github/testacular
$ cd ~/github/karma
# install local dependencies
$ npm install

Expand All @@ -29,7 +29,7 @@ are some tips to get you started.
* Ensure you have a stable working baseline for development.
```bash
# This will run a full build and test pass.
$ cd ~/github/testacular
$ cd ~/github/karma
$ grunt
```
On an unmodified 'master' branch, this command should always complete and report success.
Expand All @@ -40,7 +40,7 @@ are some tips to get you started.
* File an issue (see above)

* Run 'grunt init-dev-env'. This will install a git commit trigger that will ensure your commit messages
follows the [Testacular - Git Commit Msg Format Conventions]
follows the [Karma - Git Commit Msg Format Conventions]



Expand All @@ -58,7 +58,7 @@ are some tips to get you started.
* Add tests for your changes as (or before) you make them, if at all possible.
We use coffee script for our tests.
* Commit your changes
* Follow the [Testacular - Git Commit Msg Format Conventions]
* Follow the [Karma - Git Commit Msg Format Conventions]
* Push your changes to your forked repository
* Send a pull request to the `master` branch.
* Before submitting, make sure the default 'grunt' command succeeds locally.
Expand Down Expand Up @@ -95,11 +95,11 @@ $ grunt test:client
* [Mailing List]
* [General GitHub documentation]
* [GitHub pull request documentation]
* [@TestacularJS]
* [@JsKarma]

[Testacular - Git Commit Msg Format Conventions]: http://testacular.github.com/0.6.0/dev/git-commit-msg.html
[Issue tracker]: https://github.com/vojtajina/testacular/issues
[Mailing List]: https://groups.google.com/forum/#!forum/testacular
[Karma - Git Commit Msg Format Conventions]: http://karma-runner.github.com/0.8/dev/git-commit-msg.html
[Issue tracker]: https://github.com/karma-runner/karma/issues
[Mailing List]: https://groups.google.com/forum/#!forum/karma-users
[General GitHub documentation]: http://help.github.com/
[GitHub pull request documentation]: http://help.github.com/send-pull-requests/
[@TestacularJS]: http://twitter.com/TestacularJS
[@JsKarma]: http://twitter.com/JsKarma
4 changes: 2 additions & 2 deletions Gruntfile.coffee
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ module.exports = (grunt) ->
test:
unit: 'simplemocha:unit'
tasks: 'simplemocha:tasks'
client: 'test/client/testacular.conf.js'
e2e: 'test/e2e/*/testacular.conf.js'
client: 'test/client/karma.conf.js'
e2e: 'test/e2e/*/karma.conf.js'


simplemocha:
Expand Down
56 changes: 27 additions & 29 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Testacular [![Build Status](https://secure.travis-ci.org/testacular/testacular.png?branch=stable)](http://travis-ci.org/testacular/testacular) [![Build Status](https://secure.travis-ci.org/testacular/testacular.png?branch=master)](http://travis-ci.org/testacular/testacular)
# Karma [![Build Status](https://secure.travis-ci.org/karma-runner/karma.png?branch=stable)](http://travis-ci.org/karma-runner/karma) [![Build Status](https://secure.travis-ci.org/karma-runner/karma.png?branch=master)](http://travis-ci.org/karma-runner/karma)

A simple tool that allows you to execute JavaScript code in multiple
_real_ browsers, powered by [Node.js] and [Socket.io].

> The main purpose of Testacular is to make your TDD development easy,
> The main purpose of Karma is to make your TDD development easy,
> fast, and fun.
## When should I use Testacular?
## When should I use Karma?

* You want to test code in *real* browsers.
* You want to test code in multiple browsers (desktop, mobile,
Expand All @@ -23,7 +23,7 @@ _real_ browsers, powered by [Node.js] and [Socket.io].

## But I still want to use \_insert testing library\_

Testacular is not a testing framework, neither an assertion library,
Karma is not a testing framework, neither an assertion library,
so for that you can use pretty much anything you like. Right now out
of the box there is support for

Expand Down Expand Up @@ -56,52 +56,52 @@ Every serious project has a screencast, so here is ours. Just click
If you have [Node.js] installed, it's as simple as

```bash
$ npm install -g testacular
$ npm install -g karma
```

This will give you the latest stable version available on npm. If you
want to live life on the edge you can do so by

```bash
$ npm install -g testacular@canary
$ npm install -g karma@canary
```

The curious can have a look at the documentation articles for
[Getting Started] and [Versioning].

### Using it.

Go into your project and create a testacular configuration. That is
just a simple JavaScript or CoffeeScript file that tells Testacular
Go into your project and create a Karma configuration. That is
just a simple JavaScript or CoffeeScript file that tells Karma
where all the awesomeness of your project are.

You can find a simple example in
[test/client/testacular.conf.js](https://github.com/testacular/testacular/blob/master/test/client/testacular.conf.js)
[test/client/karma.conf.js](https://github.com/karma-runner/karma/blob/master/test/client/karma.conf.js)
which contains most of the options.

To create your own from scratch there is the `init` command, which
will be named `testacular.conf.js` by default:
will be named `karma.conf.js` by default:

```bash
$ testacular init
$ karma init
```
This will ask you many questions and if you answered them all correct
you will be allowed to use Testacular.
you will be allowed to use Karma.

For more information on the configuration options see
[Configuration File Overview].

Now that you have your configuration all that is left to do is to
start Testacular:
start Karma:
```bash
$ testacular start
$ karma start
```

If you want to run tests manually (without auto watching file changes), you can:
```bash
$ testacular run
$ karma run
```
But only if you have started the Testacular server before.
But only if you have started the Karma server before.


## Why did you create this?
Expand All @@ -119,12 +119,12 @@ use the awesome [Socket.io] library and [Node.js].
* [Docs]
* [Mailing List]
* [Issuetracker]
* [@TestacularJS] on Twitter
* [@JsKarma] on Twitter

## This is so great. I want to help.

See
[Contributing.md](https://github.com/vojtajina/testacular/blob/master/CONTRIBUTING.md)
[Contributing.md](https://github.com/karma-runner/karma/blob/master/CONTRIBUTING.md)
or the [docs] for more information.


Expand Down Expand Up @@ -163,18 +163,16 @@ or the [docs] for more information.
[Jasmine]: http://pivotal.github.com/jasmine/
[Mocha]: http://visionmedia.github.com/mocha/
[QUnit]: http://qunitjs.com/
[Semantic Versioning]: http://semver.org/
[here]: http://www.youtube.com/watch?v=MVw8N3hTfCI
[installers]: http://nodejs.org/download/
[Mailing List]: https://groups.google.com/forum/#!forum/testacular
[Issuetracker]: https://github.com/testacular/testacular/issues
[@TestacularJS]: http://twitter.com/TestacularJS
[Mailing List]: https://groups.google.com/forum/#!forum/karma-users
[Issuetracker]: https://github.com/karma-runner/karma/issues
[@JsKarma]: http://twitter.com/JsKarma
[RequireJS]: http://requirejs.org/
[Istanbul]: https://github.com/gotwarlost/istanbul

[Browsers]: http://testacular.github.com/0.6.0/config/browsers.html
[Versioning]: http://testacular.github.com/0.6.0/about/versioning.html
[Configuration File Overview]: http://testacular.github.com/0.6.0/config/configuration-file.html
[docs]: http://testacular.github.com
[Docs]: http://testacular.github.com
[website]: http://testacular.github.com
[Browsers]: http://karma-runner.github.com/0.8/config/browsers.html
[Versioning]: http://karma-runner.github.com/0.8/about/versioning.html
[Configuration File Overview]: http://karma-runner.github.com/0.8/config/configuration-file.html
[docs]: http://karma-runner.github.com
[Docs]: http://karma-runner.github.com
[website]: http://karma-runner.github.com
Loading

0 comments on commit 2b2044e

Please sign in to comment.