<commit_before>karma-remote-reporter
=====================

THIS IS STILL WORK IN PROGRESS! A full documention how to use this plugin will follow soon.

Prerequisites
-------------

* install node.js (http://nodejs.org/download/)
* install karma (http://karma-runner.github.com)
* install websocket for nodejs: npm install ws


Basics
------
This application is about creating a javascript-based artefact that is able to send test results
to a configured server via websocket. Tests are executed in a karma environment.

This software is intended to become a Karma plugin which enables test reporting via websockets to a remote server.
Report results in junit style via websockets to a configurable remote server...

Testing remote reporter
-----------------------
For TESTING ISSUES there is a javascript called testwebsocket.js; it implements a handler that can
understand and change messages sent by the reporter.

For this test you will need two consoles: one for the karma test including the reporter client and
one for the server that handles reported messsages.

For the SERVER: go to the project root and start the nodejs server on console:

node test/lib/testwebsocketserver.js

For the KARMA TEST: go to the project root and start the karma test:

karma start test/lib/karma.conf.js
<commit_msg>Changed readme<commit_after>karma-remote-reporter
=====================

THIS IS STILL WORK IN PROGRESS! A full documention how to use this plugin will follow soon.

Prerequisites
-------------

* install node.js (http://nodejs.org/download/)
* install karma (http://karma-runner.github.com)
* install ws for nodejs: npm install ws
* install websocket for nodejs: npm install websocket


Basics
------
This application is about creating a javascript-based artefact that is able to send test results
to a configured server via websocket. Tests are executed in a karma environment.

This software is intended to become a Karma plugin which enables test reporting via websockets to a remote server.
Report results in junit style via websockets to a configurable remote server...

Development
-----------
To work at the plugin we need to build a test environment. It has three components:

* the karma-remote-report plugin
* test environment to execute karma with this plugin
* a nodejs test instance to receive test messages

Unfortunately it's not possible to keep development stuff in the same directory. So there is a script to build
a development environment.

Simply go to the home directory of this project and do

. scripts/development.sh

After finished this script, see output. It has the follow-up commands to start node testserver and to start karma.

{'fraction_non_alphanumeric': 0.08220720720720721, 'fraction_numerical': 0.0, 'mean_word_length': 3.880952380952381, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 3, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6450408', 'n_tokens_mistral': 689, 'n_tokens_neox': 655, 'n_words': 367}