botium-core 1.15.10 → 1.15.13

package/samples/postman/README.md

@@ -1,5 +0,0 @@
-# Botium Grid Sample
-
-Before running one of these samples, please start the Botium Agent
-* either with botium-cli
-* or with botium-core - "npm run agent" in source directory

package/samples/postman/botiumFluent.js

@@ -1,37 +0,0 @@
-const BotDriver = require('../../index').BotDriver
-const Capabilities = require('../../index').Capabilities
-
-function assert (expected, actual) {
-  if (!actual || actual.indexOf(expected) < 0) {
-    console.log(`ERROR: Expected <${expected}>, got <${actual}>`)
-  } else {
-    console.log(`SUCCESS: Got Expected <${expected}>`)
-  }
-}
-
-const driver = new BotDriver()
-  .setCapability(Capabilities.BOTIUMGRIDURL, 'http://127.0.0.1:46100')
-  .setCapability(Capabilities.PROJECTNAME, 'IBM Watson Conversation Sample')
-  .setCapability(Capabilities.CONTAINERMODE, 'watsonconversation')
-  .setCapability(Capabilities.WATSONCONVERSATION_USER, '0274cb6f-3680-4cf7-bd6b-71c7f447542d')
-  .setCapability(Capabilities.WATSONCONVERSATION_PASSWORD, 'ZWDE5xo02sby')
-  .setCapability(Capabilities.WATSONCONVERSATION_WORKSPACE_ID, '97513bc0-c581-4bec-ac9f-ea6a8ec308a9')
-  .setCapability(Capabilities.WATSONCONVERSATION_COPY_WORKSPACE, false)
-
-driver.BuildFluent()
-  .Start()
-  .UserSaysText('start')
-  .WaitBotSaysText((text) => assert('Hi. It looks like a nice drive today. What would you like me to do?', text))
-  .UserSaysText('turn on the lights please')
-  .WaitBotSaysText((text) => assert('I\'ll turn on the lights for you.', text))
-  .UserSaysText('play some jazz music')
-  .WaitBotSaysText((text) => assert('Great choice! Playing some jazz for you.', text))
-  .Stop()
-  .Clean()
-  .Exec()
-  .then(() => {
-    console.log('READY')
-  })
-  .catch((err) => {
-    console.log('ERROR: ', err)
-  })

package/src/grid/agent/AgentWorker.js

@@ -1,204 +0,0 @@
-const util = require('util')
-const async = require('async')
-const debug = require('debug')('botium-core-AgentWorker')
-
-const BotDriver = require('../../BotDriver')
-const Capabilities = require('../../Capabilities')
-const Events = require('../../Events')
-const Commands = require('../../Commands')
-const ScriptingConstants = require('../../scripting/Constants')
-
-module.exports = class AgentWorker {
-  constructor (args = { socket: null, slot: null }) {
-    this.driver = null
-    this.container = null
-    this.args = args
-    this.socket = args.socket
-    if (this.socket) {
-      this.socket.on(Commands.BUILD_CONTAINER, this.Build.bind(this))
-      this.socket.on(Commands.START_CONTAINER, this.Start.bind(this))
-      this.socket.on(Commands.SENDTOBOT, this.UserSays.bind(this))
-      this.socket.on(Commands.STOP_CONTAINER, this.Stop.bind(this))
-      this.socket.on(Commands.CLEAN_CONTAINER, this.Clean.bind(this))
-      this.socket.on('disconnect', this.Clean.bind(this))
-      this.socket.on('error', this.Clean.bind(this))
-    }
-  }
-
-  Build (caps = {}, sources = {}, env = {}) {
-    debug(`Build ${JSON.stringify(caps)}, ${JSON.stringify(sources)}, ${JSON.stringify(env)}`)
-
-    return new Promise((resolve, reject) => {
-      if (this.driver || this.container) {
-        if (this.socket) {
-          this.socket.emit(Events.CONTAINER_BUILD_ERROR, 'build already called')
-        }
-        return reject(new Error('build already called'))
-      }
-      delete caps[Capabilities.BOTIUMGRIDURL]
-      caps[Capabilities.BOTIUMGRIDSLOT] = this.args.slot
-
-      this.driver = new BotDriver(caps, sources, env)
-      if (this.socket) {
-        this.driver.on(Events.CONTAINER_BUILDING, () => this.socket.emit(Events.CONTAINER_BUILDING))
-        this.driver.on(Events.CONTAINER_BUILT, () => this.socket.emit(Events.CONTAINER_BUILT))
-        this.driver.on(Events.CONTAINER_BUILD_ERROR, (err) => this.socket.emit(Events.CONTAINER_BUILD_ERROR, err.message ? err.message : err))
-        this.driver.on(Events.CONTAINER_STARTING, () => this.socket.emit(Events.CONTAINER_STARTING))
-        this.driver.on(Events.CONTAINER_STARTED, () => this.socket.emit(Events.CONTAINER_STARTED))
-        this.driver.on(Events.CONTAINER_START_ERROR, (c, err) => this.socket.emit(Events.CONTAINER_START_ERROR, err.message ? err.message : err))
-        this.driver.on(Events.CONTAINER_STOPPING, () => this.socket.emit(Events.CONTAINER_STOPPING))
-        this.driver.on(Events.CONTAINER_STOPPED, () => this.socket.emit(Events.CONTAINER_STOPPED))
-        this.driver.on(Events.CONTAINER_STOP_ERROR, (c, err) => this.socket.emit(Events.CONTAINER_STOP_ERROR, err.message ? err.message : err))
-        this.driver.on(Events.CONTAINER_CLEANING, () => this.socket.emit(Events.CONTAINER_CLEANING))
-        this.driver.on(Events.CONTAINER_CLEANED, () => this.socket.emit(Events.CONTAINER_CLEANED))
-        this.driver.on(Events.CONTAINER_CLEAN_ERROR, (c, err) => this.socket.emit(Events.CONTAINER_CLEAN_ERROR, err.message ? err.message : err))
-        this.driver.on(Events.BOT_CONNECTED, () => this.socket.emit(Events.BOT_CONNECTED))
-        this.driver.on(Events.MESSAGE_SENTTOBOT, () => this.socket.emit(Events.MESSAGE_SENTTOBOT))
-        this.driver.on(Events.MESSAGE_SENDTOBOT_ERROR, (c, err) => this.socket.emit(Events.MESSAGE_SENDTOBOT_ERROR, err.message ? err.message : err))
-        this.driver.on(Events.MESSAGE_RECEIVEDFROMBOT, (c, msg) => this.socket.emit(Events.MESSAGE_RECEIVEDFROMBOT, msg))
-      }
-
-      this.driver.Build()
-        .then((container) => {
-          debug('Build succeded')
-          this.container = container
-          resolve()
-        })
-        .catch((err) => {
-          this.driver = null
-          this.container = null
-          debug(`Build failed ${util.inspect(err)}`)
-          reject(err)
-        })
-    })
-  }
-
-  Start () {
-    debug('Start')
-
-    return new Promise((resolve, reject) => {
-      if (!this.container) {
-        if (this.socket) {
-          this.socket.emit(Events.CONTAINER_START_ERROR, 'container not built')
-        }
-        return reject(new Error('container not built'))
-      }
-      this.container.Start()
-        .then(() => {
-          debug('Start succeded')
-          resolve()
-        })
-        .catch((err) => {
-          debug(`Start failed ${util.inspect(err)}`)
-          reject(err)
-        })
-    })
-  }
-
-  RunScript (script) {
-    debug('RunScript')
-
-    return new Promise((resolve, reject) => {
-      if (!this.container) {
-        if (this.socket) {
-          this.socket.emit(Events.CONTAINER_START_ERROR, 'container not built')
-        }
-        return reject(new Error('container not built'))
-      }
-      const compiler = this.driver.BuildCompiler()
-      compiler.Compile(script, ScriptingConstants.SCRIPTING_FORMAT_TXT, ScriptingConstants.SCRIPTING_TYPE_CONVO)
-      async.eachSeries(compiler.convos, (convo, convoDone) => {
-        convo.Run(this.container).then(() => convoDone()).catch(convoDone)
-      },
-      (err) => {
-        if (err) return reject(err)
-        else resolve()
-      })
-    })
-  }
-
-  UserSays (msg) {
-    debug(`UserSays ${util.inspect(msg)}`)
-
-    return new Promise((resolve, reject) => {
-      if (!this.container) {
-        if (this.socket) {
-          this.socket.emit(Events.MESSAGE_SENDTOBOT_ERROR, 'container not built')
-        }
-        return reject(new Error('container not built'))
-      }
-      this.container.UserSays(msg)
-        .then(() => {
-          debug('UserSays succeded')
-          resolve()
-        })
-        .catch((err) => {
-          debug(`UserSays failed ${util.inspect(err)}`)
-          reject(err)
-        })
-    })
-  }
-
-  WaitBotSays (channel, timeoutMillis) {
-    debug(`BotSays ${channel} ${timeoutMillis}`)
-
-    return new Promise((resolve, reject) => {
-      if (!this.container) {
-        return reject(new Error('container not built'))
-      }
-      this.container.WaitBotSays(channel, timeoutMillis)
-        .then((botMsg) => {
-          debug('WaitBotSays succeded')
-          resolve(botMsg)
-        })
-        .catch((err) => {
-          debug(`WaitBotSays failed ${util.inspect(err)}`)
-          reject(err)
-        })
-    })
-  }
-
-  Stop () {
-    debug('Stop')
-
-    return new Promise((resolve, reject) => {
-      if (!this.container) {
-        if (this.socket) {
-          this.socket.emit(Events.CONTAINER_STOP_ERROR, 'container not built')
-        }
-        return reject(new Error('container not built'))
-      }
-      this.container.Stop()
-        .then(() => {
-          debug('Stop succeded')
-          resolve()
-        })
-        .catch((err) => {
-          debug(`Stop failed ${util.inspect(err)}`)
-          reject(err)
-        })
-    })
-  }
-
-  Clean () {
-    debug('Clean')
-
-    if (!this.container) return Promise.resolve()
-
-    return new Promise((resolve, reject) => {
-      this.container.Clean()
-        .then(() => {
-          this.container = null
-          this.driver = null
-          debug('Clean success')
-          resolve()
-        })
-        .catch((err) => {
-          this.container = null
-          this.driver = null
-          debug(`Clean failed ${util.inspect(err)}`)
-          reject(err)
-        })
-    })
-  }
-}

package/src/grid/agent/agent.js

@@ -1,96 +0,0 @@
-const util = require('util')
-const express = require('express')
-const bodyParser = require('body-parser')
-const http = require('http')
-const ioSocket = require('socket.io')
-const ioAuth = require('socketio-auth')
-const swaggerUi = require('swagger-ui-express')
-const debug = require('debug')('botium-core-agent')
-
-const Events = require('../../Events')
-const workerpool = require('./agentworkerpool')
-
-const port = process.env.PORT || 46100
-const apiToken = process.env.BOTIUM_API_TOKEN || ''
-if (!apiToken) {
-  console.log('WARNING: BOTIUM_API_TOKEN not set, all clients will be accepted')
-} else {
-  console.log('Add BOTIUM_API_TOKEN header to all HTTP requests, or BOTIUM_API_TOKEN URL parameter')
-}
-
-const app = express()
-const server = http.Server(app)
-const io = ioSocket(server)
-
-app.use(bodyParser.json())
-app.use(bodyParser.text())
-app.use(bodyParser.urlencoded({ extended: false }))
-app.use('/api/*', (req, res, next) => {
-  const clientApiToken = req.headers.BOTIUM_API_TOKEN || req.headers.botium_api_token || req.query.BOTIUM_API_TOKEN || req.query.botium_api_token || req.body.BOTIUM_API_TOKEN || req.body.botium_api_token
-
-  if (!apiToken || apiToken === clientApiToken) {
-    next()
-  } else {
-    debug('agent client not authenticated, wrong api token or api token not given')
-    const err = new Error('apiToken invalid')
-    err.code = 401
-    next(err)
-  }
-})
-app.use('/', require('./routes'))
-app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(require('./swagger.json')))
-app.use((err, req, res, next) => {
-  debug(`request failed: ${err}`)
-
-  if (err.message) res.statusMessage = err.message
-
-  res.status(err.code || 500)
-    .json({
-      status: 'error',
-      message: err.message ? err.message : err
-    })
-})
-
-app.get('/swagger.json', (req, res) => {
-  res.json(require('./swagger.json'))
-})
-
-ioAuth(io, {
-  authenticate: (socket, data, callback) => {
-    debug(`agent client authenticate ${socket.id} - ${JSON.stringify(data)} ...`)
-    const clientApiToken = data.apiToken
-
-    if (!apiToken || apiToken === clientApiToken) {
-      debug(`agent client authenticated ${socket.id}`)
-      return callback(null, true)
-    } else {
-      debug(`agent client not authenticated ${socket.id}`)
-      return callback(new Error('apiToken invalid'))
-    }
-  }
-})
-
-io.on('connection', (socket) => {
-  workerpool.allocate({ socket })
-    .then((worker) => {
-      debug(`agent client connected ${socket.id}, worker slot ${worker.args.slot}`)
-      socket.on('disconnect', () => {
-        debug(`agent client disconnected ${socket.id}`)
-        workerpool.free(worker)
-      })
-      socket.on('error', (err) => {
-        debug(`agent client error ${socket.id}: ${util.inspect(err)}`)
-        workerpool.free(worker)
-      })
-    })
-    .catch(() => {
-      socket.emit(Events.TOOMUCHWORKERS_ERROR, 'Maximum worker count exceeded')
-      socket.disconnect(true)
-    })
-})
-
-server.listen(port, () => {
-  console.log('Swagger UI available at /api-docs')
-  console.log('Swagger definition available at /swagger.json')
-  console.log(`listening on *:${port}`)
-})

package/src/grid/agent/agentworkerpool.js

@@ -1,58 +0,0 @@
-const path = require('path')
-
-const AgentWorker = require('./AgentWorker')
-
-const agentWorkers = new Array(process.env.BOTIUM_WORKER_COUNT ? parseInt(process.env.BOTIUM_WORKER_COUNT) : 10)
-
-const getStatus = () => {
-  return {
-    software: 'Botium Agent',
-    version: require(path.resolve(__dirname, '..', '..', '..', 'package.json')).version,
-    maxWorkers: agentWorkers.length,
-    currentWorkers: agentWorkers.filter((wp) => wp).length
-  }
-}
-
-const allocate = (workerArgs = {}) => {
-  return new Promise((resolve, reject) => {
-    const slot = agentWorkers.findIndex((wp) => !wp)
-
-    if (slot < 0) {
-      reject(new Error('no worker slot available'))
-    } else {
-      const worker = new AgentWorker({ ...workerArgs, slot })
-      agentWorkers[slot] = worker
-      resolve(worker)
-    }
-  })
-}
-
-const get = (slot) => {
-  if (agentWorkers[slot]) {
-    return Promise.resolve(agentWorkers[slot])
-  } else {
-    return Promise.reject(new Error(`worker slot ${slot} not available`))
-  }
-}
-
-const free = (worker) => {
-  return new Promise((resolve, reject) => {
-    worker.Clean()
-      .then(() => {
-        const slot = agentWorkers.findIndex((wp) => wp === worker)
-
-        if (slot >= 0) {
-          agentWorkers[slot] = null
-        }
-        resolve()
-      })
-      .catch(reject)
-  })
-}
-
-module.exports = {
-  getStatus,
-  allocate,
-  get,
-  free
-}