hubot 3.4.0 → 4.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hubot",
-  "version": "3.4.0",
+  "version": "4.0.0",
   "author": "hubot",
   "keywords": [
     "github",
@@ -15,26 +15,24 @@
     "url": "https://github.com/hubotio/hubot.git"
   },
   "dependencies": {
-    "async": ">=0.1.0 <1.0.0",
-    "chalk": "^1.0.0",
+    "async": "^3.2.4",
     "cline": "^0.8.2",
-    "coffeescript": "1.6.3",
-    "connect-multiparty": "^2.1.1",
-    "express": "^4.16.3",
-    "express-basic-auth": "1.1.7",
-    "log": "1.4.0",
-    "optparse": "1.0.4"
+    "coffeescript": "^2.7.0",
+    "connect-multiparty": "^2.2.0",
+    "express": "^4.18.2",
+    "express-basic-auth": "^1.2.1",
+    "log": "^6.3.1",
+    "log-node": "^8.0.3",
+    "optparse": "^1.0.5"
   },
   "devDependencies": {
-    "chai": "~2.1.0",
-    "coveralls": "^3.0.2",
+    "chai": "^4.3.7",
     "is-circular": "^1.0.2",
     "mocha": "^10.2.0",
-    "mockery": "^1.4.0",
-    "nyc": "^15.1.0",
+    "mockery": "^2.1.0",
     "semantic-release": "^21.0.1",
-    "sinon": "~1.17.0",
-    "sinon-chai": "^2.8.0",
+    "sinon": "^15.0.4",
+    "sinon-chai": "^3.7.0",
     "standard": "^17.0.0"
   },
   "engines": {
@@ -48,9 +46,13 @@
   "scripts": {
     "start": "bin/hubot",
     "pretest": "standard",
-    "test": "nyc --reporter=html --reporter=text mocha",
-    "coverage": "nyc report --reporter=text-lcov | coveralls",
-    "test:smoke": "node src/**/*.js",
-    "semantic-release": "semantic-release pre && npm publish && semantic-release post"
+    "test": "mocha --exit",
+    "test:smoke": "node src/**/*.js"
+  },
+  "release": {
+    "branches": [
+      "master"
+    ],
+    "dryRun": false
   }
 }

package/src/adapters/shell.js

@@ -4,7 +4,6 @@ const fs = require('fs')
 const readline = require('readline')
 const Stream = require('stream')
 const cline = require('cline')
-const chalk = require('chalk')
 
 const Adapter = require('../adapter')
 
@@ -15,12 +14,13 @@ const TextMessage = _require.TextMessage
 const historySize = process.env.HUBOT_SHELL_HISTSIZE != null ? parseInt(process.env.HUBOT_SHELL_HISTSIZE) : 1024
 
 const historyPath = '.hubot_history'
+const bold = str => `\x1b[1m${str}\x1b[22m`
 
 class Shell extends Adapter {
   send (envelope/* , ...strings */) {
     const strings = [].slice.call(arguments, 1)
 
-    Array.from(strings).forEach(str => console.log(chalk.bold(`${str}`)))
+    Array.from(strings).forEach(str => console.log(bold(str)))
   }
 
   emote (envelope/* , ...strings */) {
@@ -36,15 +36,13 @@ class Shell extends Adapter {
 
   run () {
     this.buildCli()
-
     loadHistory((error, history) => {
       if (error) {
         console.log(error.message)
       }
-
       this.cli.history(history)
       this.cli.interact(`${this.robot.name}> `)
-      return this.emit('connected')
+      return this.emit('connected', this)
     })
   }
 
@@ -97,14 +95,11 @@ class Shell extends Adapter {
       }
 
       const outstream = fs.createWriteStream(historyPath, fileOpts)
-      outstream.on('finish', this.shutdown.bind(this))
-
+      outstream.on('end', this.shutdown.bind(this))
       for (i = 0, len = history.length; i < len; i++) {
         item = history[i]
         outstream.write(item + '\n')
       }
-
-      outstream.end(this.shutdown.bind(this))
     })
   }
 }

package/src/robot.js

@@ -1,11 +1,12 @@
 'use strict'
+require('log-node')()
 
 const EventEmitter = require('events').EventEmitter
 const fs = require('fs')
 const path = require('path')
 
 const async = require('async')
-const Log = require('log')
+const log = require('log')
 const HttpClient = require('./httpclient')
 
 const Brain = require('./brain')
@@ -49,7 +50,9 @@ class Robot {
       response: new Middleware(this),
       receive: new Middleware(this)
     }
-    this.logger = new Log(process.env.HUBOT_LOG_LEVEL || 'info')
+    process.env.LOG_LEVEL = process.env.LOG_LEVEL || process.env.HUBOT_LOG_LEVEL || 'info'
+    this.logger = log.get('robot')
+
     this.pingIntervalId = null
     this.globalHttpOptions = {}
 
@@ -317,13 +320,13 @@ class Robot {
           // stack doesn't get too big
           process.nextTick(() =>
             // Stop processing when message.done == true
-            done(context.response.message.done)
+            done(null, context.response.message.done)
           )
         })
       } catch (err) {
         this.emit('error', err, new this.Response(this, context.response.message, []))
         // Continue to next listener when there is an error
-        done(false)
+        done(null, false)
       }
     },
     // Ignore the result ( == the listener that set message.done = true)

package/test/datastore_test.js

@@ -30,6 +30,10 @@ describe('Datastore', function () {
     this.robot.brain.userForId('2', { name: 'User Two' })
   })
 
+  this.afterEach(function () {
+    this.clock.restore()
+  })
+
   describe('global scope', function () {
     it('returns undefined for values not in the datastore', function () {
       return this.robot.datastore.get('blah').then(function (value) {

package/test/robot_test.js

@@ -6,6 +6,7 @@
 // Assertions and Stubbing
 const chai = require('chai')
 const sinon = require('sinon')
+const emitter = require('log/lib/emitter')
 chai.use(require('sinon-chai'))
 
 const expect = chai.expect
@@ -374,7 +375,7 @@ describe('Robot', function () {
 
     describe('#loadFile', function () {
       beforeEach(function () {
-        this.sandbox = sinon.sandbox.create()
+        this.sandbox = sinon.createSandbox()
       })
 
       afterEach(function () {
@@ -422,15 +423,24 @@ describe('Robot', function () {
         })
 
         it('logs a warning for a .js file', function () {
-          sinon.stub(this.robot.logger, 'warning')
+          let wasCalled = false
+          const listener = e => {
+            wasCalled = e.messageTokens.some(t => t.indexOf('Expected scripts/test-script') > -1)
+          }
+          emitter.on('log', listener)
           this.robot.loadFile('./scripts', 'test-script.js')
-          expect(this.robot.logger.warning).to.have.been.called
+          expect(wasCalled).to.be.true
+          emitter.off('log', listener)
         })
 
         it('logs a warning for a .mjs file', function () {
-          sinon.stub(this.robot.logger, 'warning')
+          let wasCalled = false
+          const listener = e => {
+            wasCalled = e.messageTokens.some(t => t.indexOf('Expected scripts/test-script') > -1)
+          }
+          emitter.on('log', listener)
           this.robot.loadFile('./scripts', 'test-script.mjs')
-          expect(this.robot.logger.warning).to.have.been.called
+          expect(wasCalled).to.be.true
         })
       })
 
@@ -724,7 +734,7 @@ describe('Robot', function () {
       this.robot.catchAll(catchAllCallback)
 
       this.robot.receive(testMessage, function () {
-        expect(listenerCallback).to.have.been.called.once
+        expect(listenerCallback).to.have.been.calledOnce
         expect(catchAllCallback).to.not.have.been.called
         done()
       })

package/test/shell_test.js

@@ -0,0 +1,72 @@
+'use strict'
+
+/* global describe, beforeEach, it */
+
+const chai = require('chai')
+const sinon = require('sinon')
+chai.use(require('sinon-chai'))
+
+const expect = chai.expect
+
+const Robot = require('../src/robot')
+
+describe('Shell Adapter', function () {
+  beforeEach(function () {
+    this.robot = new Robot(null, 'shell', false, 'TestHubot')
+    this.robot.run()
+  })
+
+  this.afterEach(function () {
+    this.robot.shutdown()
+  })
+
+  describe('Public API', function () {
+    beforeEach(function () {
+      this.adapter = this.robot.adapter
+    })
+
+    it('assigns robot', function () {
+      expect(this.adapter.robot).to.equal(this.robot)
+    })
+
+    it('sends a message', function () {
+      this.adapter.send = sinon.spy()
+      this.adapter.send({ room: 'general' }, 'hello')
+
+      expect(this.adapter.send).to.have.been.calledWith({ room: 'general' }, 'hello')
+    })
+
+    it('emotes a message', function () {
+      this.adapter.send = sinon.spy()
+      this.adapter.emote({ room: 'general' }, 'hello')
+
+      expect(this.adapter.send).to.have.been.calledWith({ room: 'general' }, '* hello')
+    })
+
+    it('replies to a message', function () {
+      this.adapter.send = sinon.spy()
+      this.adapter.reply({ room: 'general', user: { name: 'mocha' } }, 'hello')
+
+      expect(this.adapter.send).to.have.been.calledWith({ room: 'general', user: { name: 'mocha' } }, 'mocha: hello')
+    })
+
+    it('runs the adapter and emits connected', function (done) {
+      const connected = () => {
+        this.adapter.off('connected', connected)
+        done()
+      }
+      this.adapter.on('connected', connected)
+      this.adapter.run()
+    })
+  })
+
+  it('dispatches received messages to the robot', function () {
+    this.robot.receive = sinon.spy()
+    this.adapter = this.robot.adapter
+    this.message = sinon.spy()
+
+    this.adapter.receive(this.message)
+
+    expect(this.robot.receive).to.have.been.calledWith(this.message)
+  })
+})

package/.env.example

@@ -1,2 +0,0 @@
-export NPM_TOKEN=npm_whatever
-export GITHUB_TOKEN=ghp_whatever

package/.envrc

@@ -1,5 +0,0 @@
-# TODO change to op://Personal/npmjs.org/NPM Publish
-export NPM_TOKEN=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
-
-# TODO change to op://Personal/te/NPM Publish
-export GITHUB_TOKEN=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

package/.travis.yml

@@ -1,27 +0,0 @@
-language: node_js
-node_js:
-  - "10"
-  - "8"
-  - "6"
-notifications:
-  email: false
-sudo: false
-addons:
-  apt:
-    packages:
-    - expect
-before_install:
-  - npm install -g npm@latest
-before_script:
-  - npm prune
-  - bin/e2e-test.sh
-after_success:
-  - npm run coverage
-branches:
-  except:
-    - /^v\d+\.\d+\.\d+$/
-deploy:
-  provider: script
-  skip_cleanup: true
-  script:
-    - npx travis-deploy-once "npx semantic-release"