GPII-2515: Add code coverage reporting...

.gitignore

@@ -4,3 +4,4 @@ gpii/node_modules/gsettingsBridge/nodegsettings/build/
 gpii/node_modules/packagekit/nodepackagekit/build/
 gpii/node_modules/xrandr/nodexrandr/build/
 /node_modules/
+coverage

.istanbul.yml

@@ -0,0 +1,14 @@
+# A common istanbul configuration file.  Avoids generating reports, as we are collecting data from various runs, and
+# will do that as a "posttest" step.  You must explicitly generate a report and summary, see the package.json for an
+# example command.
+instrumentation:
+  root: .
+  include-pid: true
+  default-excludes: false
+  excludes: ["tests/**", "coverage/**", "instrumented/**", "node_modules/**"]
+  complete-copy: true
+reporting:
+  dir: ./coverage
+  print: none
+  reports:
+    - none

Gruntfile.js

@@ -3,6 +3,7 @@ GPII Linux Personalization Framework Node.js Bootstrap
 
 Copyright 2014 RTF-US
 Copyright 2014 Emergya
+Copyright 2017 Raising the Floor International
 
 Licensed under the New BSD license. You may not use this file except in
 compliance with this License.
@@ -78,12 +79,6 @@ module.exports = function (grunt) {
                     "sudo rm -f /usr/share/applications/gpii-usb-user-listener.desktop",
                     "sudo rm -f -r /var/lib/gpii"
                 ].join("&&")
-            },
-            runAcceptanceTests: {
-                command: "vagrant ssh -c 'DISPLAY=:0 node /home/vagrant/sync/tests/AcceptanceTests.js'"
-            },
-            runUnitTests: {
-                command: "vagrant ssh -c 'cd /home/vagrant/sync/tests/; DISPLAY=:0 ./UnitTests.sh'"
             }
         }
     });
@@ -119,17 +114,4 @@ module.exports = function (grunt) {
     grunt.registerTask("uninstall", "Uninstall system level GPII Components", function () {
         grunt.task.run("shell:uninstallUsbLib");
     });
-
-    grunt.registerTask("unit-tests", "Run GPII unit tests", function () {
-        grunt.task.run("shell:runUnitTests");
-    });
-
-    grunt.registerTask("acceptance-tests", "Run GPII acceptance tests", function () {
-        grunt.task.run("shell:runAcceptanceTests");
-    });
-
-    grunt.registerTask("tests", "Run GPII unit and acceptance tests", function () {
-        grunt.task.run("shell:runUnitTests");
-        grunt.task.run("shell:runAcceptanceTests");
-    });
 };

README.md

@@ -1,6 +1,7 @@
 # GNU/Linux
 
-This repository contains all of the platform-specific code required to run the GPII Personalization Framework on GNU/Linux with GNOME.
+This repository contains all of the platform-specific code required to run the GPII Personalization Framework on
+GNU/Linux with GNOME.
 
 The following components can be found in the repository:
 
@@ -51,7 +52,9 @@ this may prompt you for sudo access.
 
 # Setting Up a Virtual Machine
 
-This repository contains content that will allow you to automatically provision a development VM. A [Vagrantfile](http://docs.vagrantup.com/v2/vagrantfile/) is provided that downloads a [Fedora Vagrant box](https://github.com/idi-ops/packer-fedora), starts a VM, and deploys the GPII Framework on it.
+This repository contains content that will allow you to automatically provision a development VM. A 
+[Vagrantfile](http://docs.vagrantup.com/v2/vagrantfile/) is provided that downloads a 
+[Fedora Vagrant box](https://github.com/idi-ops/packer-fedora), starts a VM, and deploys the GPII Framework on it.
 
 The ``provisioning`` directory contains these files:
 
@@ -61,25 +64,51 @@ The ``provisioning`` directory contains these files:
 
 ## Requirements
 
-Please ensure that the [QI Development Environments software requirements](https://github.com/GPII/qi-development-environments/blob/master/README.md#requirements) have been met. You will additionally need the following on your host operating system:
+Please ensure that the 
+[QI Development Environments software requirements](https://github.com/GPII/qi-development-environments/blob/master/README.md#requirements) 
+have been met. You will additionally need the following on your host operating system:
 
 * [grunt-cli](https://github.com/gruntjs/grunt-cli)
 * At least 2GB of available storage space
 
-## Getting Started
+## Creating a VM
 
 In order to create a new VM you will need to issue the following command:
 
     vagrant up
 
-By default the VM will use two processor cores and 2GB of RAM. Two environment variables can be passed to the ``vagrant up`` command to allocate more cores (``VM_CPUS=2``) and RAM (``VM_RAM=2048``). If this is your first time setting up this VM then the 2GB Fedora Vagrant box will be downloaded.
+By default the VM will use two processor cores and 2GB of RAM. Two environment variables can be passed to the 
+``vagrant up`` command to allocate more cores (``VM_CPUS=2``) and RAM (``VM_RAM=2048``). If this is your first time 
+setting up this VM then the 2GB Fedora Vagrant box will be downloaded.
 
-Once the box has been downloaded the provisioning process will ensure that project dependencies have been met and then the ``npm install`` and ``grunt --force build`` commands will be executed. If you reboot the VM the provisioner will not run again. However, you can use ``vagrant provision`` to trigger that process at any time.
-
-To run tests you can use the ``grunt tests`` command on your host which will run unit and acceptance tests in the VM. Or you could use ``grunt unit-tests`` and/or ``grunt acceptance-tests`` separately.
+Once the box has been downloaded the provisioning process will ensure that project dependencies have been met and then 
+the ``npm install`` and ``grunt --force build`` commands will be executed. If you reboot the VM the provisioner will not 
+run again. However, you can use ``vagrant provision`` to trigger that process at any time.
 
 You can stop the VM using ``vagrant halt`` or delete it altogether using ``vagrant destroy``.
 
+## Running Tests in the VM
+
+To run tests on the VM from the host machine, you can use the following commands:
+
+* ``npm run test:vagrant`` - Run all tests on the VM.
+* ``npm run test:vagrantUnit`` - Run just the unit tests on the VM.
+* ``npm run test:vagrantAcceptance`` - Run just the acceptance tests on the VM.
+
+You can also connect to the VM using the ``vagrant ssh`` command, and run the tests using one of the following commands:
+
+* ``npm test`` - Run all tests.
+* ``npm run test:unit`` - Run all unit tests.
+* ``npm run test:acceptance`` - Run the acceptance tests.
+
+## Coverage Reporting
+
+If you run the full suite of tests, a code coverage report will be generated in `coverage/lcov-report`, which can be
+viewed with a browser.  A summary of this report will be output to the console as well.
+
 ## Notes
 
-The entire Git working directory will be mounted at the ``/home/vagrant/sync`` path in the VM and bidirectionally synced with the host operating system. This means build artifacts created by processes in the VM will be exposed to the host. It will be safer if you commit to running build tasks such as ``npm install`` or ``grunt build`` in the VM and not attempt that on the host. 
+The entire Git working directory will be mounted at the ``/home/vagrant/sync`` path in the VM and bidirectionally synced 
+with the host operating system. This means build artifacts created by processes in the VM will be exposed to the host. 
+It will be safer if you commit to running build tasks such as ``npm install`` or ``grunt build`` in the VM and not 
+attempt that on the host. 

package.json

@@ -1,34 +1,49 @@
 {
-    "name": "gpii-linux",
-    "description": "Components of the GPII personalization infrastructure for use on Linux",
-    "version": "0.3.0",
-    "author": "GPII",
-    "bugs": "http://issues.gpii.net/browse/GPII",
-    "homepage": "http://gpii.net/",
-    "dependencies": {
-        "universal": "GPII/universal#1a3434d970cb484956eb18310683bdfe473123d6"
-    },
-    "devDependencies": {
-        "grunt": "1.0.1",
-        "fluid-grunt-eslint": "18.1.1",
-        "grunt-jsonlint": "1.0.4",
-        "grunt-shell": "1.3.0",
-        "nan": "2.4.0"
-    },
-    "license" : "BSD-3-Clause",
-    "keywords": [
-        "gpii",
-        "accessibility",
-        "settings",
-        "fluid",
-        "IoC",
-        "Inversion of Control",
-        "configuration",
-        "evented"
-    ],
-    "repository": "git://github.com/GPII/linux.git",
-    "main": "./gpii/index.js",
-    "engines": {
-        "node": ">=4.2.1"
-    }
+  "name": "gpii-linux",
+  "description": "Components of the GPII personalization infrastructure for use on Linux",
+  "version": "0.3.0",
+  "author": "GPII",
+  "bugs": "http://issues.gpii.net/browse/GPII",
+  "homepage": "http://gpii.net/",
+  "dependencies": {
+    "universal": "GPII/universal#06d5b9b672feecac88e2cf8e351248fad503a111"
+  },
+  "devDependencies": {
+    "fluid-grunt-eslint": "18.1.1",
+    "grunt": "1.0.1",
+    "grunt-jsonlint": "1.0.4",
+    "grunt-shell": "1.3.0",
+    "istanbul": "git://github.com/the-t-in-rtf/istanbul#828eb930add7bd663ca20649a917f3f3829e48c5",
+    "nan": "2.4.0",
+    "rimraf": "2.6.1"
+  },
+  "license": "BSD-3-Clause",
+  "keywords": [
+    "gpii",
+    "accessibility",
+    "settings",
+    "fluid",
+    "IoC",
+    "Inversion of Control",
+    "configuration",
+    "evented"
+  ],
+  "repository": "git://github.com/GPII/linux.git",
+  "main": "./gpii/index.js",
+  "engines": {
+    "node": ">=4.2.1"
+  },
+  "scripts": {
+    "pretest": "node node_modules/rimraf/bin.js coverage/* reports/*",
+    "test": "npm run test:unit && npm run test:acceptance",
+    "test:unit": "npm run test:unit:pretest && npm run test:unit:run && npm run test:unit:posttest",
+    "test:unit:pretest": "/usr/bin/bash ./gpii/node_modules/gsettingsBridge/tests/scripts/pretest.sh",
+    "test:unit:run": "node node_modules/istanbul/lib/cli.js cover tests/UnitTests.js --include-pid",
+    "test:unit:posttest": "/usr/bin/bash ./gpii/node_modules/gsettingsBridge/tests/scripts/posttest.sh",
+    "test:acceptance": "node node_modules/istanbul/lib/cli.js cover tests/AcceptanceTests.js --include-pid",
+    "test:vagrant": "vagrant ssh -c 'cd /home/vagrant/sync; npm install && DISPLAY=:0 npm test'",
+    "test:vagrantUnit": "vagrant ssh -c 'cd /home/vagrant/sync; npm install && DISPLAY=:0 npm run test:unit'",
+    "test:vagrantAcceptance": "vagrant ssh -c 'cd /home/vagrant/sync; npm install && DISPLAY=:0 npm run test:acceptance'",
+    "posttest": "node node_modules/istanbul/lib/cli.js report lcov text-summary"
+  }
 }

tests/UnitTests.js

@@ -0,0 +1,9 @@
+// Rollup to run all javascript-only unit tests.
+"use strict";
+require("../gpii/node_modules/alsa/test/alsaSettingsHandlerTests.js");
+require("../gpii/node_modules/orca/test/orcaSettingsHandlerTests.js");
+require("../gpii/node_modules/packagekit/test/all-tests.js");
+require("../gpii/node_modules/packagekit/nodepackagekit/nodepackagekit_test");
+require("../gpii/node_modules/xrandr/nodexrandr/nodexrandr_tests.js");
+require("../gpii/node_modules/xrandr/test/xrandrSettingsHandlerTests.js");
+require("../gpii/node_modules/gsettingsBridge/tests/gsettingsTests");

tests/UnitTests.sh

@@ -17,34 +17,16 @@ declare -i error_code
 
 trap 'error_code=$?' ERR EXIT
 
+# TODO: Convert this to a javascript-only approach so that we can test code coverage.
 pushd .
-cd ../gpii/node_modules/alsa/test
-node alsaSettingsHandlerTests.js
-popd
-
-pushd .
-cd ../gpii/node_modules/gsettingsBridge/tests
+cd gpii/node_modules/gsettingsBridge/tests
+# TODO: See if we can make this into a javascript-only approach
 ./runUnitTests.sh
+# TODO: Produces no output when run on its own from the repo root. Investigate.
 cd ../nodegsettings
 node .//nodegsettings_tests.js
 popd
 
-pushd .
-cd ../gpii/node_modules/orca/test
-node orcaSettingsHandlerTests.js
-popd
-
-pushd .
-cd ../gpii/node_modules/packagekit/test/
-node .//all-tests.js
-cd ../nodepackagekit
-node nodepackagekit_test.js
-popd
-
-# These XRANDR tests crash out on my system (AMB - Fedora 19 64-bit in VMWare Workstation 10.0.1 on Windows 7 64-bit) 
-node ../gpii/node_modules/xrandr/nodexrandr/nodexrandr_tests.js
-node ../gpii/node_modules/xrandr/test/xrandrSettingsHandlerTests.js
-
 if [ -n "$error_code" ]; then
   exit 1
 else