We intend to use Mocha for testing Node.js and JavaScript.

How to run mocha tests with the Test accessor:

The Test accessor can be used to read a mocha test file and execute the tests.

Browser host

First, start the test server. Please see /accessors/web/hosts/browser/test/README.txt
Open a browser window and point to: http://localhost:8088/hosts/browser/test/test/testRunner.html
Click "react to inputs". The test output will appear at the top of the page, and also in the browser console window. You may need to open a debugging pane to see the console window.

Node host

From the command prompt, change to the directory: /accessors/web/hosts/node/test/mocha
Execute:

   node ../../nodeHostShell.js < ./testCommon.js

How to run mocha and test the Node.js facilities in Ptolemy II:

If you don't have Node.js, then see https://nodejs.org/en/download/

After Node.js is installed:

  cd $PTII
  svn update
  ./configure
  sudo npm install -g mocha
  sudo npm install -g mocha-junit-reporter 
  ant test.mocha

How to run mocha and test in the browser:

Please see the example in the accessors repo at accessors/web/hosts/browser/test/test/testAccessor.html

To run this example:

In a terminal shell on your local machine, start up the test server in the accessors repo using the instructions at accessors/web/hosts/browser/test/README.txt
Point your browser to http://localhost:8088/hosts/browser/test/test/testAccessor.html
Mocha will write the test results to the top of the page.

For more information, please see the mocha website, https://mochajs.org/#running-mocha-in-the-browser

How to write mocha tests

See https://mochajs.org/

An example test is in accessors/web/hosts/node/test/mocha/testNodeHost.js

The code uses the assert module:

  var assert = require('assert');

Mocha Functions

Below are the functions common mocha functions:

describe(): for grouping, which can be nested
it(): a test case
before(): Run before any describe() or it(),
beforeEach(): Run before each it()
after(): run after the last it()
afterEach(): run after each it()

Use assert.equal() to compare the results with known good results:

  assert.equal(a.latestOutput('output'), 50);

Add-ons

Chai is an assertion library that supports multiple assertion styles, including "should", "expect" and "assert". Assertions are chainable.
Sinon is a framework add-on for writing test spies, stubs and mocks. For example, Sinon can create a mock server for sending mock HTTP responses for REST accessor HTTP requests.

Resources

Looks like Mocha is a place to start for Node.js JavaScript testing frameworks.

Accessors Test Bed Design

Currently accessors/web/hosts/node/test/ includes a testNodeHost.js script.

To run the script

  cd accessors/web/hosts/node/test/
  node ../nodeHost.js < testNodeHost.js

Features we need:

When we run the tests, we want to have the output appear in the Jenkins Continuous Integration run. To do this, we need to generate JUnit-compatible XML output. Fortunately, there is the mocha-junit-reporter.
1. $PTII/build.xml would include a target that would run the tests using the mocha-junit-reporter
We might use multiple test harnesses, so we should but the Mocha tests in mocha/ subdirectory.
1. This would nicely match junit/.
2. The mocha/README.txt file should describe how to run the tests.
3. The mocha/ directories in the accessors repo don't have makefiles, but directories in ptII would have makefiles.
4. $PTII/org/terraswarm/accessor/test would include a test that would run the tests in $PTII/org/terraswarm/accessor/accessors/web/hosts/node/test/mocha

"this" rears its ugly head.

accessors/web/hosts/node/test/testNodeHost.js invokes this.instantiate

// This is just a simple smoke test for the Node.js host.
// To use it, run the node host and copy and paste the following into it.
var a = this.instantiate('TestComposite', 'test/TestComposite');
a.initialize();
a.provideInput('input', 10);
a.react();
a.latestOutput('output'); // Should return 50
a.wrapup();
quit;

Mocha

How to run mocha tests with the Test accessor:

Browser host

Node host

How to run mocha and test the Node.js facilities in Ptolemy II:

How to run mocha and test in the browser:

How to write mocha tests

Mocha Functions

Add-ons

Resources

Accessors Test Bed Design

"this" rears its ugly head.

JUnit reporting for Mocha

Mocha/Accessors issues

Relative paths in tests

TypeError: Converting circular structure to JSON

Mocha Output is truncated in Ant

See Also