Thursday 20 June 2013

Adding KarmaJS support to WebStorm to automagically run tests on file changes (and test UI with SublimeText, Chrome and Cmd.exe)

On the AngularJs and KarmaJS theme (see A small AngularJS Jasmine test executed by KarmaJS and the related posts linked at the bottom), here is my first attempt at using Karma to test AngularJS code inside TeamMentor.

I’m using WebStorm instead of VisualStudio, since for Javascript coding WebStorm is MUCH better/faster/cleverer, specially since it has good support for AngularJs and Jasmine (with KarmaJS support easily added, as we are about to see).

Also shown below is a cool tool I created that hijacks windows from SublimeText, Chrome and Cmd.exe windows into the same UI (an O2 Platform .NET Script)

Here is the directory structure:


... with Karma.config.js looking like this:
module.exports = function(karma)
        frameworks: ['ng-scenario'],


        urlRoot: '/__karma/',

        autoWatch: true,

        proxies: {
            '/'     : 'http://localhost:12120/',
            '/Tests': 'http://localhost:12120/AngularJs/Tests/'


        //browsers: ['Chrome'],

        reporters: ['dots'],
        //reporters: ['progress'],
        plugins: [
                 ]  ,
        //logLevel: karma.LOG_DEBUG
        logLevel: karma.LOG_INFO

Simple.html like this:
<!DOCTYPE html>
<html xmlns:ng="" id="ng-app" ng-app>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" __content="IE=EmulateIE9" />
    <title>Simple AngularJS page</title>
    <script src="/Javascript/angularJS/1.0.5/angular.min.js"></script>
    <input type="text" ng-model="yourName" placeholder="Enter a name here">
    <h1>Hello {{yourName}}!</h1>

Simple.Spec.js like this:
describe('Test Angular Simple page', function()
        it('Open Webpage and check URL', function()
                expect(browser ().window().path()).toBe("/Tests/AngularJS/Simple.html");
                expect(browser ().location().path()).toBe("");
                expect(browser ().window().path()).not().toBe("/Tests/AngularJS/Simple.html");
                expect(browser ().window().path()).toBe("/Tests/AngularJS/aaa.html");

        it('Set Field value and check Angular scope update', function()
                var testValue = "This is a value";
                var expectedValue = "Hello "  + testValue + "!";

        it('get path value manually (using setTimeout)',function()
                var path = browser().window().path();
                console.log("(before timeout) path value = " + path.value );
                    console.log("(after timeout) path value = " + path.value );


… and MarkDown.Editor.Spec.js currently with just
describe('Markdown Editor - View funcionality', function()
        it("Should open", function()
                expect(browser ().window().path()).toBe("/Markdown/Editor");
                expect(browser ().location().path()).toBe("");

This is how I configured Karma to run on WebStorm:


Here is KarmaJS execution log:


Here are two connected KarmaJS Runners (one in IE and one in Chrome)


And finally, here is the (super useful) AngularJS: Scenario Test Runner view, in a collapsed state:


… and in an expanded state:


With this set-up KarmaJS is configured to run continuously and to monitor any file changes, which is really powerful, since it allows for continuous development and testing.

For example (to see the automagically execution in action), here is what the WebStorm UI looks like:

… with an Javascript error: (KarmaJS execution triggered on Save) :


… without the error:  (KarmaJS execution triggered on Save)


This is a really nice environment to quickly develop AngularJS apps, specially since the tests are super quick to execute and we can control what tests are executed (for example by creating multiple karma.conf.js files)

O2 Platform Test GUI (created by hijacking 3 processe' windows)

I also created a test GUI using the O2 Platform’s window-handle Hijack capabilities, which looked like this:


In the image above:
  • The host process is the O2 Platform Util - Win32 Window Handle Hijack (4x host panels ).h2 script/tool (which is a .Net app)

  • The left-hand side the Sublime Text editor (which is a C++, Pyhton app)

  • The top-right is Chrome (which is C++ app)

  • The bottom-right is cmd.exe (C++ app) running the command karma start karma.conf.js in the E:\TeamMentor\TM_Dev Repos\TM_Dev_Dinis\Web Applications\TM_Website\AngularJS\Karma folder
All in a nice, self-contained process/environment

Note that there are 4 separate process at play here (O2 Platform, Sublime, Chrome and Cmd.Exe w/ Karma)

Related AngularJS and KarmaJS posts: