Merge pull request #45 from hubotio/upgrade-to-hubot-7

feat: Bump Hubot version to 7 and update README doc with working exam…

Author: joeyguerra

README.md

@@ -1,4 +1,4 @@
-# mock adapter for unit-testing Hubot
+# Mock adapter for unit-testing Hubot
 
 I've whacked together a couple of Hubot scripts, but then they started getting
 more complicated. TDD is really the ONLY way to do any kind of meaningful
@@ -9,7 +9,7 @@ I couldn't find an existing method for writing unit tests for Hubot scripts.
 After digging around under Hubot's hood, I figured out all I really needed was
 an `Adapter` implementation I could spy on. That is what you see here.
 
-## example usage
+## Example Usage
 
 Let's assume you've got a really simple script, like this:
 
@@ -21,96 +21,44 @@ module.exports = function (robot) {
 };
 ```
 
-You want to test this, of course. So create a Mocha test:
+### Node Test Runner
 
-```js
-var expect = require("chai").expect;
-var path = require("path");
-
-var Robot = require("hubot/es2015").Robot;
-var TextMessage = require("hubot").TextMessage;
-
-describe("Eddie the shipboard computer", function () {
-  var robot;
-  var user;
-  var adapter;
-
-  beforeEach((done) => {
-    // create new robot, without http, using the mock adapter
-    robot = new Robot("hubot-mock-adapter", false, "Eddie");
-
-    // start adapter
-    robot.loadAdapter().then(() => {
-      // only load scripts we absolutely need, like auth.coffee
-      process.env.HUBOT_AUTH_ADMIN = "1";
-      robot.loadFile(
-        path.resolve(path.join("node_modules/hubot/src/scripts")),
-        "auth.coffee"
-      );
-
-      // load the module under test and configure it for the
-      // robot.  This is in place of external-scripts
-      require("../index")(robot);
-
-      robot.adapter.on("connected", () => {
-        // create a user
-        user = robot.brain.userForId("1", {
-          name: "mocha",
-          room: "#mocha",
-        });
-        adapter = robot.adapter;
-        done();
-      });
-
-      // start the bot
-      robot.run();
-    });
-  });
-
-  afterEach(function () {
-    robot.shutdown();
-  });
+Create a test file in a folder. e.g. [index.test.mjs](test/index.test.mjs).
 
-  it("responds when greeted", function (done) {
-    // here's where the magic happens!
-    adapter.on("reply", function (envelope, strings) {
-      expect(strings[0]).match(/Why hello there/);
+You'll need a Node version > 17.
 
-      done();
-    });
+Assuming your tests are in `test/` or have `.test.` before the file extension, just run `node --test`. For less typing, in your `package.json`, add a `test` script:
 
-    adapter.receive(new TextMessage(user, "Computer!"));
-  });
-});
+```json
+"scripts": {
+  "test": "node --test"
+}
 ```
 
+Then you can use `npm test` to run your tests!
+
+### Mocha
+
+Create a test file in a folder. e.g. [index.js](test/index.js).
+
 You'll need `devDependencies` something like this in your `package.json`:
 
 ```js
 "devDependencies": {
-  "coffee-script": "~1.6.3",
-  "chai": "~1.9.0",
-  "hubot-mock-adapter": "~1.0.0",
-  "mocha": "~1.17.1",
-  "hubot": "~2.7.2",
-  "sinon": "~1.9.0"
+  "coffeescript": "^2.7.0",
+  "chai": "^4.3.7",
+  "hubot-mock-adapter": "^1.x.x",
+  "mocha": "^10.2.0",
+  "hubot": "^7.x.x",
 }
 ```
 
-That's (almost) all there is to it!
-
-## firing up Mocha
+Assuming your tests are in `test/`, just run `node_modules/.bin/mocha --exit`. For less typing, in your `package.json`, add a `test` script:
 
-Assuming you're using [`mocha`][mocha] to run your tests, and your
-tests are in `test/`, just run `node_modules/.bin/mocha --compilers coffee:coffee-script`.
-For less typing, in your `package.json`, add a `test` script:
-
-```js
+```json
 "scripts": {
-    "test": "mocha --compilers coffee:coffee-script"
+  "test": "mocha --exit"
 }
 ```
 
 Then you can use `npm test` to run your tests!
-
-[mocha]: https://github.com/mhevery/jasmine-node