1
0
Fork 0
mirror of https://github.com/openstf/stf synced 2025-10-04 18:29:17 +02:00

Separate device functionality into plugins.

This commit is contained in:
Simo Kinnunen 2014-03-14 20:18:53 +09:00
parent d61a70fda5
commit 3d20b06f7f
24 changed files with 1277 additions and 700 deletions

View file

@ -1,680 +1,35 @@
var assert = require('assert')
var util = require('util')
var http = require('http')
var Promise = require('bluebird')
var zmq = require('zmq')
var adbkit = require('adbkit')
var monkey = require('adbkit-monkey')
var request = Promise.promisifyAll(require('request'))
var httpProxy = require('http-proxy')
var split = require('split')
var syrup = require('syrup')
var logger = require('../util/logger')
var wire = require('../wire')
var wireutil = require('../wire/util')
var wirerouter = require('../wire/router')
var devutil = require('../util/devutil')
var pathutil = require('../util/pathutil')
var promiseutil = require('../util/promiseutil')
var Vitals = require('../util/vitals')
var ChannelManager = require('../wire/channelmanager')
var keyutil = require('../util/keyutil')
var inputAgent = require('../services/inputagent')
module.exports = function(options) {
var log = logger.createLogger('device')
, identity = Object.create(null)
, display = Object.create(null)
, vendor = Object.create(null)
, owner = null
, solo = wireutil.makePrivateChannel()
, channels = new ChannelManager()
, vitals = new Vitals()
, ports = {
http: 2870
, input: 2820
, stats: 2830
, forward: 2810
}
, services = {
input: null
, logcat: null
}
// Show serial number in logs
logger.setGlobalIdentifier(options.serial)
// Output
var push = zmq.socket('push')
options.endpoints.push.forEach(function(endpoint) {
log.info('Sending output to %s', endpoint)
push.connect(endpoint)
})
// Panic if necessary
Promise.onPossiblyUnhandledRejection(function(err, promise) {
log.fatal('Unhandled rejection', err.stack)
selfDestruct()
})
// Forward all logs
logger.on('entry', function(entry) {
push.send([wireutil.log,
wireutil.makeDeviceLogMessage(options.serial, entry)])
})
// Adb
var adb = adbkit.createClient()
// Input
var sub = zmq.socket('sub')
options.endpoints.sub.forEach(function(endpoint) {
log.info('Receiving input from %s', endpoint)
sub.connect(endpoint)
})
// Establish always-on channels
;[wireutil.global, solo].forEach(function(channel) {
log.info('Subscribing to permanent channel "%s"', channel)
sub.subscribe(channel)
channels.register(channel, Infinity)
})
// Unsubscribe from temporary channels when they timeout
channels.on('timeout', function(channel) {
log.info('Channel "%s" timed out', channel)
if (channel === owner.group) {
leaveGroup()
}
})
// Closure of vital functionality
vitals.on('end', function(name) {
log.fatal(util.format('Vital utility "%s" has ended', name))
selfDestruct()
})
// Error in vital utility
vitals.on('error', function(name, err) {
log.fatal(util.format('Vital utility "%s" had an error', err.stack))
selfDestruct()
})
promiseutil.periodicNotify(adb.waitBootComplete(options.serial), 1000)
.progressed(function() {
log.info('Waiting for boot to complete')
})
.then(function() {
log.info('Gathering properties')
return adb.getProperties(options.serial)
})
.then(function(properties) {
log.info('Solving identity')
return identity = devutil.makeIdentity(options.serial, properties)
})
.then(function() {
vendor = devutil.vendorFiles(identity)
return Promise.all(Object.keys(vendor).map(function(id) {
var res = vendor[id]
log.info(util.format('Pushing vendor file "%s"', res.dest))
return adb.push(options.serial, res.src, res.dest, res.mode)
.then(function(transfer) {
return new Promise(function(resolve, reject) {
transfer.on('error', reject)
transfer.on('end', resolve)
})
})
}))
})
.then(function() {
log.info('Checking if any processes from a previous run are still up')
return Promise.all([
devutil.killProcsByComm(
adb
, options.serial
, vendor.bin.comm
, vendor.bin.dest
)
, devutil.killProcsByComm(
adb
, options.serial
, 'app_process'
, 'app_process'
)
])
})
.then(function() {
log.info('Launching HTTP API')
return devutil.ensureUnusedPort(adb, options.serial, 2870)
.then(function(port) {
var log = logger.createLogger('device:remote:http')
return adb.shell(options.serial, [
vendor.bin.dest
, '--lib', vendor.lib.dest
, '--listen-http', port
])
.then(function(out) {
vitals.register('device:remote:http:shell', out)
out.pipe(split())
.on('data', function(chunk) {
log.info(chunk)
})
})
.then(function() {
return devutil.waitForPort(adb, options.serial, port)
})
.then(function(conn) {
var ours = options.ports.pop()
, everyones = options.ports.pop()
, url = util.format('http://127.0.0.1:%d', ours)
// Don't need the connection
conn.end()
log.info('Opening device HTTP API forwarder on "%s"', url)
return adb.forward(
options.serial
, util.format('tcp:%d', ours)
, util.format('tcp:%d', port)
)
.then(function() {
return request.getAsync({
url: util.format('%s/api/v1/displays/0', url)
, json: true
})
})
.then(function(args) {
assert.ok('id' in args[1], 'Invalid response from HTTP API')
identity.display = args[1]
})
.then(function() {
log.info(
'Opening HTTP API proxy on "http://%s:%s"'
, options.publicIp
, everyones
)
var resolver = Promise.defer()
function resolve() {
vitals.register('device:http:proxy', proxyServer)
resolver.resolve()
}
function reject(err) {
resolver.reject(err)
}
var proxy = httpProxy.createProxyServer({
target: url
, ws: false
, xfwd: false
})
var proxyServer = http.createServer(proxy.web)
.listen(everyones)
proxyServer.on('listening', resolve)
proxyServer.on('error', reject)
return resolver.promise.finally(function() {
proxyServer.removeListener('listening', resolve)
proxyServer.removeListener('error', reject)
})
})
.then(function() {
identity.display.url = util.format(
'http://%s:%s/api/v1/displays/0/screenshot.jpg'
, options.publicIp
, everyones
)
})
})
})
})
.then(function() {
log.info('Launching InputAgent')
return devutil.ensureUnusedPort(adb, options.serial, 1090)
.then(function(port) {
var log = logger.createLogger('device:inputAgent')
return promiseutil.periodicNotify(
inputAgent.openAgent(adb, options.serial)
, 1000
)
.progressed(function() {
log.info('Waiting for InputAgent')
})
.then(function(out) {
vitals.register('device:inputAgent:shell', out)
out.pipe(split())
.on('data', function(chunk) {
log.info(chunk)
})
return port
})
})
.then(function(port) {
return devutil.waitForPort(adb, options.serial, port)
})
.then(function(conn) {
services.inputAgentSocket = vitals.register(
'device:inputAgent:socket'
, conn
)
})
})
.then(function(apk) {
log.info('Launching InputService')
return inputAgent.stopService(adb, options.serial)
.then(function() {
return devutil.waitForPortToFree(adb, options.serial, 1100)
})
.then(function(port) {
var log = logger.createLogger('device:inputService')
return inputAgent.openService(adb, options.serial)
.then(function() {
return promiseutil.periodicNotify(
devutil.waitForPort(adb, options.serial, port)
, 1000
)
.progressed(function() {
log.info('Waiting for InputService')
})
})
})
.then(function(conn) {
services.inputServiceSocket = vitals.register(
'device:inputService:socket'
, conn
)
})
})
.then(function() {
log.info('Launching TouchService')
return devutil.ensureUnusedPort(adb, options.serial, 2820)
.then(function(port) {
var log = logger.createLogger('device:remote:touch')
return adb.shell(options.serial, [
vendor.bin.dest
, '--lib', vendor.lib.dest
, '--listen-input', port
])
.then(function(out) {
vitals.register('device:remote:touch:shell', out)
out.pipe(split())
.on('data', function(chunk) {
log.info(chunk)
})
return port
})
})
.then(function(port) {
return devutil.waitForPort(adb, options.serial, port)
})
.then(function(conn) {
return monkey.connectStream(conn)
})
.then(function(monkey) {
services.touch = vitals.register(
'device:remote:touch:monkey'
, Promise.promisifyAll(monkey)
)
})
})
.then(function() {
log.info('Launching stats service')
return devutil.ensureUnusedPort(adb, options.serial, 2830)
.then(function(port) {
var log = logger.createLogger('device:remote:stats')
return adb.shell(options.serial, [
vendor.bin.dest
, '--lib', vendor.lib.dest
, '--listen-stats', port
])
.then(function(out) {
vitals.register('device:remote:stats:shell', out)
out.pipe(split())
.on('data', function(chunk) {
log.info(chunk)
})
})
})
})
.then(function() {
log.info('Launching logcat service')
return adb.openLogcat(options.serial)
.then(function(logcat) {
services.logcat = vitals.register('device:logcat', logcat)
resetLogcat()
})
})
.then(function() {
log.info('Ready for instructions')
process.send('ready')
poke()
})
.catch(function(err) {
log.fatal('Setup failed', err.stack)
selfDestruct()
})
sub.on('message', wirerouter()
.on('message', function(channel) {
channels.keepalive(channel)
})
.on(wire.ProbeMessage, function(channel, message) {
push.send([wireutil.global,
wireutil.makeDeviceIdentityMessage(options.serial, identity)])
})
.on(wire.GroupMessage, function(channel, message) {
var seq = 0
if (devutil.matchesRequirements(identity, message.requirements)) {
if (!isGrouped()) {
joinGroup(message.owner, message.timeout)
push.send([
channel
, wireutil.envelope(new wire.TransactionDoneMessage(
options.serial
, seq++
, true
))
])
}
else if (isOwnedBy(message.owner)) {
push.send([
channel
, wireutil.envelope(new wire.TransactionDoneMessage(
options.serial
, seq++
, true
))
])
}
else {
push.send([
channel
, wireutil.envelope(new wire.TransactionDoneMessage(
options.serial
, seq++
, false
))
])
}
}
})
.on(wire.UngroupMessage, function(channel, message) {
var seq = 0
if (devutil.matchesRequirements(identity, message.requirements)) {
if (isGrouped()) {
leaveGroup()
push.send([
channel
, wireutil.envelope(new wire.TransactionDoneMessage(
options.serial
, seq++
, true
))
])
}
else {
push.send([
channel
, wireutil.envelope(new wire.TransactionDoneMessage(
options.serial
, seq++
, true
))
])
}
}
})
.on(wire.TouchDownMessage, function(channel, message) {
services.touch.touchDownAsync(message.x, message.y)
.catch(function(err) {
log.error('touchDown failed', err.stack)
})
})
.on(wire.TouchMoveMessage, function(channel, message) {
services.touch.touchMoveAsync(message.x, message.y)
.catch(function(err) {
log.error('touchMove failed', err.stack)
})
})
.on(wire.TouchUpMessage, function(channel, message) {
services.touch.touchUpAsync(message.x, message.y)
.catch(function(err) {
log.error('touchUp failed', err.stack)
})
})
.on(wire.TapMessage, function(channel, message) {
services.touch.tapAsync(message.x, message.y)
.catch(function(err) {
log.error('tap failed', err.stack)
})
})
.on(wire.KeyDownMessage, function(channel, message) {
inputAgent.sendInputEvent(services.inputAgentSocket, {
action: 0
, keyCode: keyutil.unwire(message.keyCode)
})
})
.on(wire.KeyUpMessage, function(channel, message) {
inputAgent.sendInputEvent(services.inputAgentSocket, {
action: 1
, keyCode: keyutil.unwire(message.keyCode)
})
})
.on(wire.KeyPressMessage, function(channel, message) {
inputAgent.sendInputEvent(services.inputAgentSocket, {
action: 2
, keyCode: keyutil.unwire(message.keyCode)
})
})
.on(wire.TypeMessage, function(channel, message) {
inputAgent.sendInputEvent(services.inputAgentSocket, {
action: 3
, keyCode: 0
, text: message.text
})
})
.on(wire.LogcatApplyFiltersMessage, function(channel, message) {
resetLogcat()
message.filters.forEach(function(filter) {
services.logcat.include(filter.tag, filter.priority)
})
})
.on(wire.ShellCommandMessage, function(channel, message) {
var router = this
, seq = 0
log.info('Running shell command "%s"', message.command)
adb.shell(options.serial, message.command)
.then(function(stream) {
var resolver = Promise.defer()
, timer
function keepAliveListener(channel, message) {
clearTimeout(timer)
timer = setTimeout(forceStop, message.timeout)
return syrup()
// We want to send logs before anything else start happening
.dependency(require('./device/plugins/logsender'))
.define(function(options) {
return syrup()
.dependency(require('./device/plugins/solo'))
.dependency(require('./device/plugins/heartbeat'))
.dependency(require('./device/plugins/display'))
.dependency(require('./device/plugins/http'))
.dependency(require('./device/plugins/input'))
.dependency(require('./device/plugins/logcat'))
.dependency(require('./device/plugins/shell'))
.dependency(require('./device/plugins/touch'))
.dependency(require('./device/plugins/owner'))
.define(function(options, solo) {
var log = logger.createLogger('device')
if (process.send) {
// Only if we have a parent process
process.send('ready')
}
function readableListener() {
var chunk
while (chunk = stream.read()) {
push.send([
channel
, wireutil.envelope(new wire.TransactionProgressMessage(
options.serial
, seq++
, chunk
))
])
}
}
function endListener() {
push.send([
channel
, wireutil.envelope(new wire.TransactionDoneMessage(
options.serial
, seq++
, true
))
])
resolver.resolve()
}
function errorListener(err) {
resolver.reject(err)
}
function forceStop() {
stream.end()
}
stream.on('readable', readableListener)
stream.on('end', endListener)
stream.on('error', errorListener)
sub.subscribe(channel)
router.on(wire.ShellKeepAliveMessage, keepAliveListener)
timer = setTimeout(forceStop, message.timeout)
return resolver.promise.finally(function() {
stream.removeListener('readable', readableListener)
stream.removeListener('end', endListener)
stream.removeListener('error', errorListener)
sub.unsubscribe(channel)
router.removeListener(wire.ShellKeepAliveMessage, keepAliveListener)
clearTimeout(timer)
})
})
.error(function(err) {
log.error('Shell command "%s" failed due to "%s"'
, message.command, err.message)
push.send([
channel
, wireutil.envelope(new wire.TransactionDoneMessage(
options.serial
, seq++
, false
, err.message
))
])
log.info('Fully operational')
return solo.poke()
})
.consume(options)
})
.handler())
function poke() {
push.send([
wireutil.global
, wireutil.envelope(new wire.DevicePokeMessage(
options.serial
, solo
))
])
}
function isGrouped() {
return !!owner
}
function resetLogcat() {
services.logcat
.resetFilters()
.excludeAll()
}
function logcatListener(entry) {
push.send([
owner.group
, wireutil.envelope(new wire.DeviceLogcatEntryMessage(
options.serial
, entry.date.getTime() / 1000
, entry.pid
, entry.tid
, entry.priority
, entry.tag
, entry.message
))
])
}
function isOwnedBy(someOwner) {
return owner && owner.group == someOwner.group
}
function joinGroup(newOwner, timeout) {
log.info('Now owned by "%s"', newOwner.email)
log.info('Subscribing to group channel "%s"', newOwner.group)
channels.register(newOwner.group, timeout)
sub.subscribe(newOwner.group)
push.send([
wireutil.global
, wireutil.envelope(new wire.JoinGroupMessage(
options.serial
, newOwner
))
])
services.logcat.on('entry', logcatListener)
inputAgent.acquireWakeLock(services.inputServiceSocket)
inputAgent.unlock(services.inputServiceSocket)
owner = newOwner
}
function leaveGroup() {
log.info('No longer owned by "%s"', owner.email)
log.info('Unsubscribing from group channel "%s"', owner.group)
channels.unregister(owner.group)
sub.unsubscribe(owner.group)
push.send([
wireutil.global
, wireutil.envelope(new wire.LeaveGroupMessage(
options.serial
, owner
))
])
services.logcat.removeListener('entry', logcatListener)
inputAgent.releaseWakeLock(services.inputServiceSocket)
inputAgent.lock(services.inputServiceSocket)
owner = null
}
function heartbeat() {
push.send([
wireutil.heartbeat
, wireutil.envelope(new wire.DeviceHeartbeatMessage(
options.serial
))
])
setTimeout(heartbeat, options.heartbeatInterval)
}
function selfDestruct() {
process.exit(1)
}
function gracefullyExit() {
if (isGrouped()) {
leaveGroup()
Promise.delay(500).then(gracefullyExit)
}
else {
log.info('Bye')
process.exit(0)
}
}
process.on('SIGINT', function() {
gracefullyExit()
})
process.on('SIGTERM', function() {
gracefullyExit()
})
heartbeat()
.consume(options)
}