Louis/command-tests (#88)

* Add commandExecuted test util function

Function for testing whether a command has been executed by a node.

* Add execute script tests for measure and simulator

* Add inputId() and outputId() methods

These methods can be used to easily retrieve the IDs of the first and
last nodes. Updated the commandExecuted() function to reflect this
change.

* Fix multiple nodes of the same type being added

* Remove assumed wires array

Remove wires being put into an array in add() method. This causes
complications if a node is connected to multiple other nodes.

* Fix PythonShell tests not starting fresh

* Add execute command tests

Includes:
- Bloch sphere
- Circuit diagram
- Classical register
- Hadamard gate
- Quantum circuit
- Quantum register
- Toffoli gate

* Run Node.js CI workflow on test/ file

* Revert "Fix PythonShell tests not starting fresh"

This reverts commit 8f560f9.

* Increase timeout limit

* Add before hook to PythonShell constructor tests

Stops the shell before running tests.

* Fix done() being called multiple times

* Add Toffoli gate command executed test

* Add multi-controlled-u-gate test suite

* Fix multiple done calls on error

* Add ibm-quantum-system execute command test

This command is disabled by default as it requires an API key to run.
For this to run on the CI, GitHub secrets could be used. To run this
locally, an API key should be assigned to the API_TOKEN constant.

* Add more execute command tests

Add tests for:
- barrier_spec.js
- cnot-gate_spec.js
- controlled-u-gate_spec.js
- identity-gate_spec.js
- multi-controlled-u-gate_spec.js
- not-gate_spec.js
- phase-gate_spec.js
- reset_spec.js
- rotation-gate_spec.js
- swap_spec.js
- unitary-gate_spec.js

Author: louislefevre

.github/workflows/node.js.yml

@@ -5,10 +5,12 @@ on:
     branches: [ master ]
     paths:
       - 'quantum/**'
+      - 'test/**'
   pull_request:
     branches: [ master ]
     paths:
       - 'quantum/**'
+      - 'test/**'
 
 jobs:
   build:

package.json

@@ -29,7 +29,7 @@
     "setup": "(npm run link && npm run venv) && echo Setup complete - run 'npm start' to open Node-RED",
     "link": "bash bin/link.sh || bin/link.sh",
     "venv": "bash bin/pyvenv.sh || bin/pyvenv.sh",
-    "test": "mocha \"test/**/*_spec.js\"",
+    "test": "mocha \"test/**/*_spec.js\" --timeout 10000",
     "clean": "rm -r venv/ & npm uninstall --prefix ~/.node-red/ node-red-contrib-quantum",
     "lint": "eslint --fix --ignore-path .gitignore .",
     "postinstall": "npm run venv"

test/flow-builder.js

@@ -12,6 +12,7 @@ const NODES = {
   'identity-gate': require('../quantum/nodes/identity-gate/identity-gate.js'),
   'local-simulator': require('../quantum/nodes/local-simulator/local-simulator.js'),
   'measure': require('../quantum/nodes/measure/measure.js'),
+  'multi-controlled-u-gate': require('../quantum/nodes/multi-controlled-u-gate/multi-controlled-u-gate.js'),
   'not-gate': require('../quantum/nodes/not-gate/not-gate.js'),
   'phase-gate': require('../quantum/nodes/phase-gate/phase-gate.js'),
   'quantum-circuit': require('../quantum/nodes/quantum-circuit/quantum-circuit.js'),
@@ -42,6 +43,24 @@ class FlowBuilder {
     return JSON.stringify(this.flow);
   }
 
+  /**
+   * Return the ID of the first node.
+   *
+   * @return {string} The nodes ID string.
+  */
+  get inputId() {
+    return this.flow[0].id;
+  }
+
+  /**
+   * Return the ID of the last node.
+   *
+   * @return {string} The nodes ID string.
+  */
+  get outputId() {
+    return this.flow[this.flow.length - 1].id;
+  }
+
   /**
    * Add a quantum node to the flow.
    *
@@ -54,9 +73,11 @@ class FlowBuilder {
     if (!NODES.hasOwnProperty(name)) {
       throw new Error(`Failed to find node ${name}`);
     }
-    let json = {id: id, wires: [wires], type: name, name: name.replace(/-/g, ' ')};
+    let json = {id: id, wires: wires, type: name, name: name.replace(/-/g, ' ')};
     Object.assign(json, properties);
-    this.nodes.push(NODES[name]);
+    if (!this.nodes.includes(NODES[name])) {
+      this.nodes.push(NODES[name]);
+    }
     this.flow.push(json);
   }
 

test/nodes/barrier_spec.js

@@ -1,6 +1,9 @@
-const barrierNode = require('../../quantum/nodes/barrier/barrier.js');
+const util = require('util');
 const testUtil = require('../test-util');
 const nodeTestHelper = testUtil.nodeTestHelper;
+const {FlowBuilder} = require('../flow-builder');
+const barrierNode = require('../../quantum/nodes/barrier/barrier.js');
+const snippets = require('../../quantum/snippets.js');
 
 
 describe('BarrierNode', function() {
@@ -16,4 +19,14 @@ describe('BarrierNode', function() {
   it('load node', function(done) {
     testUtil.isLoaded(barrierNode, 'barrier', done);
   });
+
+  it('execute command', function(done) {
+    let command = util.format(snippets.BARRIER, '0, ');
+    let flow = new FlowBuilder();
+    flow.add('quantum-circuit', 'n0', [['n1']], {structure: 'qubits', outputs: '1', qbitsreg: '1', cbitsreg: '1'});
+    flow.add('barrier', 'n1', [['n2']], {outputs: '1'});
+    flow.addOutput('n2');
+
+    testUtil.commandExecuted(flow, command, done);
+  });
 });

test/nodes/bloch-sphere_spec.js

@@ -1,6 +1,8 @@
-const blochSphereNode = require('../../quantum/nodes/bloch-sphere/bloch-sphere.js');
 const testUtil = require('../test-util');
 const nodeTestHelper = testUtil.nodeTestHelper;
+const {FlowBuilder} = require('../flow-builder');
+const blochSphereNode = require('../../quantum/nodes/bloch-sphere/bloch-sphere.js');
+const snippets = require('../../quantum/snippets.js');
 
 
 describe('BlochSphereNode', function() {
@@ -16,4 +18,19 @@ describe('BlochSphereNode', function() {
   it('load node', function(done) {
     testUtil.isLoaded(blochSphereNode, 'bloch-sphere', done);
   });
+
+  it('execute command', function(done) {
+    let command = snippets.BLOCH_SPHERE + snippets.ENCODE_IMAGE;
+    let flow = new FlowBuilder();
+    flow.add('quantum-circuit', 'n0', [['n1'], ['n2'], ['n3']],
+        {structure: 'qubits', outputs: '3', qbitsreg: '3', cbitsreg: '1'});
+    flow.add('hadamard-gate', 'n1', [['n4']]);
+    flow.add('hadamard-gate', 'n2', [['n4']]);
+    flow.add('not-gate', 'n3', [['n4']]);
+    flow.add('toffoli-gate', 'n4', [['n5'], ['n5'], ['n5']], {targetPosition: 'Middle'});
+    flow.add('bloch-sphere', 'n5', [['n6']]);
+    flow.addOutput('n6');
+
+    testUtil.commandExecuted(flow, command, done);
+  });
 });

test/nodes/circuit-diagram_spec.js

@@ -1,6 +1,8 @@
-const circuitDiagramNode = require('../../quantum/nodes/circuit-diagram/circuit-diagram.js');
 const testUtil = require('../test-util');
 const nodeTestHelper = testUtil.nodeTestHelper;
+const {FlowBuilder} = require('../flow-builder');
+const circuitDiagramNode = require('../../quantum/nodes/circuit-diagram/circuit-diagram.js');
+const snippets = require('../../quantum/snippets.js');
 
 
 describe('CircuitDiagramNode', function() {
@@ -16,4 +18,16 @@ describe('CircuitDiagramNode', function() {
   it('load node', function(done) {
     testUtil.isLoaded(circuitDiagramNode, 'circuit-diagram', done);
   });
+
+  it('execute command', function(done) {
+    let command = snippets.CIRCUIT_DIAGRAM + snippets.ENCODE_IMAGE;
+    let flow = new FlowBuilder();
+    flow.add('quantum-circuit', 'n0', [['n1']], {structure: 'qubits', outputs: '1', qbitsreg: '1', cbitsreg: '1'});
+    flow.add('hadamard-gate', 'n1', [['n2']]);
+    flow.add('measure', 'n2', [['n3']], {selectedBit: '0'});
+    flow.add('circuit-diagram', 'n3', [['n4']]);
+    flow.addOutput('n4');
+
+    testUtil.commandExecuted(flow, command, done);
+  });
 });

test/nodes/classical-register_spec.js

@@ -1,7 +1,9 @@
-const classicalRegisterNode = require('../../quantum/nodes/classical-register/classical-register.js');
+const util = require('util');
 const testUtil = require('../test-util');
+const classicalRegisterNode = require('../../quantum/nodes/classical-register/classical-register.js');
+const {FlowBuilder} = require('../flow-builder');
 const nodeTestHelper = testUtil.nodeTestHelper;
-
+const snippets = require('../../quantum/snippets.js');
 
 describe('ClassicalRegisterNode', function() {
   beforeEach(function(done) {
@@ -16,4 +18,16 @@ describe('ClassicalRegisterNode', function() {
   it('load node', function(done) {
     testUtil.isLoaded(classicalRegisterNode, 'classical-register', done);
   });
+
+  it('execute command', function(done) {
+    let command = util.format(snippets.CLASSICAL_REGISTER, '_test', '3, "test"');
+    let flow = new FlowBuilder();
+    flow.add('quantum-circuit', 'n0', [['n1'], ['n2']],
+        {structure: 'registers', outputs: '2', qbitsreg: '1', cbitsreg: '1'});
+    flow.add('quantum-register', 'n1', [['n3']], {outputs: '1'});
+    flow.add('classical-register', 'n2', [], {classicalBits: '3', name: 'test'});
+    flow.addOutput('n3');
+
+    testUtil.commandExecuted(flow, command, done);
+  });
 });

test/nodes/cnot-gate_spec.js

@@ -1,6 +1,9 @@
-const cnotGateNode = require('../../quantum/nodes/cnot-gate/cnot-gate.js');
+const util = require('util');
 const testUtil = require('../test-util');
 const nodeTestHelper = testUtil.nodeTestHelper;
+const {FlowBuilder} = require('../flow-builder');
+const cnotGateNode = require('../../quantum/nodes/cnot-gate/cnot-gate.js');
+const snippets = require('../../quantum/snippets.js');
 
 
 describe('CnotGateNode', function() {
@@ -16,4 +19,15 @@ describe('CnotGateNode', function() {
   it('load node', function(done) {
     testUtil.isLoaded(cnotGateNode, 'cnot-gate', done);
   });
+
+  it('execute command', function(done) {
+    let command = util.format(snippets.CNOT_GATE, '1', '0');
+    let flow = new FlowBuilder();
+    flow.add('quantum-circuit', 'n0', [['n1'], ['n1']],
+        {structure: 'qubits', outputs: '2', qbitsreg: '2', cbitsreg: '1'});
+    flow.add('cnot-gate', 'n1', [['n2']], {targetPosition: 'Upper'});
+    flow.addOutput('n2');
+
+    testUtil.commandExecuted(flow, command, done);
+  });
 });

test/nodes/controlled-u-gate_spec.js

@@ -1,6 +1,9 @@
-const controlledUGateNode = require('../../quantum/nodes/controlled-u-gate/controlled-u-gate.js');
+const util = require('util');
 const testUtil = require('../test-util');
 const nodeTestHelper = testUtil.nodeTestHelper;
+const {FlowBuilder} = require('../flow-builder');
+const controlledUGateNode = require('../../quantum/nodes/controlled-u-gate/controlled-u-gate.js');
+const snippets = require('../../quantum/snippets.js');
 
 
 describe('ControlledUGateNode', function() {
@@ -16,4 +19,16 @@ describe('ControlledUGateNode', function() {
   it('load node', function(done) {
     testUtil.isLoaded(controlledUGateNode, 'controlled-u-gate', done);
   });
+
+  it('execute command', function(done) {
+    let command = util.format(snippets.CU_GATE, '0*pi', '0*pi', '0*pi', '0*pi', '1', '0');
+    let flow = new FlowBuilder();
+    flow.add('quantum-circuit', 'n0', [['n1'], ['n1']],
+        {structure: 'qubits', outputs: '2', qbitsreg: '2', cbitsreg: '1'});
+    flow.add('controlled-u-gate', 'n1', [['n2']],
+        {targetPosition: 'Upper', theta: '0', phi: '0', lambda: '0', gamma: '0'});
+    flow.addOutput('n2');
+
+    testUtil.commandExecuted(flow, command, done);
+  });
 });

test/nodes/hadamard-gate_spec.js

@@ -1,6 +1,9 @@
-const hadamardGateNode = require('../../quantum/nodes/hadamard-gate/hadamard-gate.js');
+const util = require('util');
 const testUtil = require('../test-util');
 const nodeTestHelper = testUtil.nodeTestHelper;
+const {FlowBuilder} = require('../flow-builder');
+const hadamardGateNode = require('../../quantum/nodes/hadamard-gate/hadamard-gate.js');
+const snippets = require('../../quantum/snippets.js');
 
 
 describe('HadamardGateNode', function() {
@@ -16,4 +19,14 @@ describe('HadamardGateNode', function() {
   it('load node', function(done) {
     testUtil.isLoaded(hadamardGateNode, 'hadamard-gate', done);
   });
+
+  it('execute command', function(done) {
+    let command = util.format(snippets.HADAMARD_GATE, '0');
+    let flow = new FlowBuilder();
+    flow.add('quantum-circuit', 'n0', [['n1']], {structure: 'qubits', outputs: '1', qbitsreg: '1', cbitsreg: '1'});
+    flow.add('hadamard-gate', 'n1', [['n2']]);
+    flow.addOutput('n2');
+
+    testUtil.commandExecuted(flow, command, done);
+  });
 });

test/nodes/ibm-quantum-system_spec.js

@@ -1,7 +1,12 @@
-const ibmQuantumSystemNode = require('../../quantum/nodes/ibm-quantum-system/ibm-quantum-system.js');
+const util = require('util');
 const testUtil = require('../test-util');
 const nodeTestHelper = testUtil.nodeTestHelper;
+const {FlowBuilder} = require('../flow-builder');
+const ibmQuantumSystemNode = require('../../quantum/nodes/ibm-quantum-system/ibm-quantum-system.js');
+const snippets = require('../../quantum/snippets.js');
 
+// DO NOT COMMIT YOUR API TOKEN!
+const API_TOKEN = '';
 
 describe('IBMQuantumSystemNode', function() {
   beforeEach(function(done) {
@@ -16,4 +21,18 @@ describe('IBMQuantumSystemNode', function() {
   it('load node', function(done) {
     testUtil.isLoaded(ibmQuantumSystemNode, 'ibm-quantum-system', done);
   });
+
+  xit('execute command', function(done) {
+    // Disabled for now until we can use GitHub secrets to pass an API key to this test for CI.
+    let command = util.format(snippets.IBMQ_SYSTEM_DEFAULT + snippets.IBMQ_SYSTEM_RESULT, API_TOKEN, '1');
+    let flow = new FlowBuilder();
+    flow.add('quantum-circuit', 'n0', [['n1']], {structure: 'qubits', outputs: '1', qbitsreg: '1', cbitsreg: '1'});
+    flow.add('hadamard-gate', 'n1', [['n2']]);
+    flow.add('measure', 'n2', [['n3']], {selectedBit: '0'});
+    flow.add('ibm-quantum-system', 'n3', [['n4']], {api_token: API_TOKEN,
+      preferred_backend: '', preferred_output: ' Results'});
+    flow.addOutput('n4');
+
+    testUtil.commandExecuted(flow, command, done);
+  }).timeout(180000); // Needs long timeout as it takes awhile for IBM server to respond
 });

test/nodes/identity-gate_spec.js

@@ -1,6 +1,9 @@
-const identityGateNode = require('../../quantum/nodes/identity-gate/identity-gate.js');
+const util = require('util');
 const testUtil = require('../test-util');
 const nodeTestHelper = testUtil.nodeTestHelper;
+const {FlowBuilder} = require('../flow-builder');
+const identityGateNode = require('../../quantum/nodes/identity-gate/identity-gate.js');
+const snippets = require('../../quantum/snippets.js');
 
 
 describe('IdentityGateNode', function() {
@@ -16,4 +19,14 @@ describe('IdentityGateNode', function() {
   it('load node', function(done) {
     testUtil.isLoaded(identityGateNode, 'identity-gate', done);
   });
+
+  it('execute command', function(done) {
+    let command = util.format(snippets.IDENTITY, '0');
+    let flow = new FlowBuilder();
+    flow.add('quantum-circuit', 'n0', [['n1']], {structure: 'qubits', outputs: '1', qbitsreg: '1', cbitsreg: '1'});
+    flow.add('identity-gate', 'n1', [['n2']]);
+    flow.addOutput('n2');
+
+    testUtil.commandExecuted(flow, command, done);
+  });
 });

test/nodes/local-simulator_spec.js

@@ -1,10 +1,8 @@
 const util = require('util');
-const assert = require('chai').assert;
 const testUtil = require('../test-util');
 const nodeTestHelper = testUtil.nodeTestHelper;
 const {FlowBuilder} = require('../flow-builder');
 const localSimulatorNode = require('../../quantum/nodes/local-simulator/local-simulator.js');
-const shell = require('../../quantum/python.js').PythonShell;
 const snippets = require('../../quantum/snippets.js');
 
 
@@ -14,7 +12,6 @@ describe('LocalSimulatorNode', function() {
   });
 
   afterEach(function(done) {
-    shell.stop();
     nodeTestHelper.unload();
     nodeTestHelper.stopServer(done);
   });
@@ -23,29 +20,15 @@ describe('LocalSimulatorNode', function() {
     testUtil.isLoaded(localSimulatorNode, 'local-simulator', done);
   });
 
-  it('execute script', function(done) {
-    const flow = new FlowBuilder();
-    flow.add('quantum-circuit', 'n0', ['n1'], {structure: 'qubits', outputs: '1', qbitsreg: '1', cbitsreg: '1'});
-    flow.add('hadamard-gate', 'n1', ['n2']);
-    flow.add('measure', 'n2', ['n3'], {selectedBit: '0'});
-    flow.add('local-simulator', 'n3', ['n4'], {shots: '1'});
+  it('execute command', function(done) {
+    let command = util.format(snippets.LOCAL_SIMULATOR, '1');
+    let flow = new FlowBuilder();
+    flow.add('quantum-circuit', 'n0', [['n1']], {structure: 'qubits', outputs: '1', qbitsreg: '1', cbitsreg: '1'});
+    flow.add('hadamard-gate', 'n1', [['n2']]);
+    flow.add('measure', 'n2', [['n3']], {selectedBit: '0'});
+    flow.add('local-simulator', 'n3', [['n4']], {shots: '1'});
     flow.addOutput('n4');
 
-    nodeTestHelper.load(flow.nodes, flow.flow, function() {
-      let n0 = nodeTestHelper.getNode('n0');
-      let n4 = nodeTestHelper.getNode('n4');
-
-      n4.on('input', function(msg) {
-        try {
-          let command = util.format(snippets.LOCAL_SIMULATOR, '1');
-          assert.strictEqual(shell.lastCommand, command);
-          done();
-        } catch (err) {
-          done(err);
-        }
-      });
-
-      n0.receive({payload: ''});
-    });
+    testUtil.commandExecuted(flow, command, done);
   });
 });