thom-nic
commented
7 years ago I've figured out how to use socat for testing on Linux & OSX. It works on CircleCI if youapt-get socat in a prebuild step.
The raw command looks like this:
socat -d -d pty,raw,nonblock,echo=0,link=ttyV0 pty,raw,nonblock,echo=0,link=ttyV1Here's a snippet from a mocha test where I've got it all wrapped together:
const fs = require('fs');
const os = require('os');
const resolve = require('path').resolve;
const child_process = require('child_process');
const SerialPort = require('serialport');
describe('SerialPort', function() {
let client;
let hwWrite, hwRead;
let socat;
const MASTER_PORT = resolve('./ttyV0');
const SLAVE_PORT = resolve('./ttyV1');
const SOCAT_EXISTS = child_process.spawnSync('socat', ['-h']).status === 0;
if ( ! SOCAT_EXISTS ) {
console.warn("`socat` is not installed, skipping serial client tests...");
const installCmd = os.type() === 'Darwin' ? 'brew install socat' : 'sudo apt-get install socat';
console.warn(`Please run \`${installCmd}\` to enable these tests!`);
return;
}
beforeEach(done => {
socat = child_process.spawn('socat', ['-d','-d',
`pty,raw,nonblock,echo=0,link=${MASTER_PORT}`,
`pty,raw,nonblock,echo=0,link=${SLAVE_PORT}`],
{detached: true, stdio: 'ignore'});
socat.on('close', code => {
//console.log('socat exited with code', code);
}).on('error', done);
// socat needs time to init the fds. Wait for the expected ports to appear...
const waitForPorts = () => {
try {
if ( fs.statSync(MASTER_PORT).dev && fs.statSync(SLAVE_PORT).dev ) {
hwWrite = fs.createWriteStream(MASTER_PORT, {autoClose: false});
hwRead = fs.createReadStream(MASTER_PORT);
hwRead.on('error', () => {}); // ignore read errors on linux when client side stream is closed.
client = new SerialPort(SLAVE_PORT, {autoOpen: false});
done();
}
}
catch( ex ) { // ENOENT if both fds have not been created yet.
setTimeout(waitForPorts, 100);
}
};
waitForPorts();
});
afterEach(done => {
const cb = err => {
if ( hwWrite ) hwWrite.close();
socat.kill('SIGTERM');
done(err);
};
if ( client && client.isOpen() ) client.close(cb);
else cb();
});
// tests go here. `client` is an initialized serial client and `hwRead` and `hwWrite` are
// streams you can use for the 'other' side of the serial client.
});This manages to cleanup the virtual TTY links that socat creates after each test. If things aren't created and closed in the right order you end up with spurious stream errors but this has been working well for me. Can't help with windows though :/
reconbot
fourfathom
DraTeots
vkuehn
Craytor
hanfengcan
We need Serial Ports on our CI otherwise they're not doing all they could for us.
Travis ci supports socat on linux and osx I can install it and setup a "virtual Arduino" if someone can can figure a command to set up a pair of virtual ports.
Windows is a bit harder, there are a bunch of emulators but none of them look scriptable.