feat: add app.expectLog() for app and cluster (#77)

helper function to assert string value in logger

.travis.yml

@@ -3,7 +3,7 @@ language: node_js
 node_js:
   - '6'
   - '8'
-  - '9'
+  - '10'
 install:
   - npm i npminstall && npminstall
 script:

README.md

@@ -265,6 +265,23 @@ Clean all logs directory, default is true.
 
 If you are using `ava`, disable it.
 
+### app.expectLog(str[, logger])
+
+Assert some string value in the logger instance.
+
+```js
+it('should work', async () => {
+  await app.httpRequest()
+    .get('/')
+    .expect('hello world')
+    .expect(200);
+
+  app.expectLog('foo in logger');
+  app.expectLog('foo in coreLogger', 'coreLogger');
+  app.expectLog('foo in myCustomLogger', 'myCustomLogger');
+});
+```
+
 ### app.httpRequest()
 
 Request current app http server.

README.zh_CN.md

@@ -275,6 +275,23 @@ mm.app({
 
 如果是通过 ava 等并行测试框架进行测试，需要手动在执行测试前进行统一的日志清理，不能通过 mm 来处理，设置 `clean` 为 `false`。
 
+### app.expectLog(str[, logger])
+
+断言指定的字符串记录在指定的日志中。
+
+```js
+it('should work', async () => {
+  await app.httpRequest()
+    .get('/')
+    .expect('hello world')
+    .expect(200);
+
+  app.expectLog('foo in logger');
+  app.expectLog('foo in coreLogger', 'coreLogger');
+  app.expectLog('foo in myCustomLogger', 'myCustomLogger');
+});
+```
+
 ### app.httpRequest()
 
 请求当前应用 http 服务的辅助工具。

app/extend/application.js

@@ -2,6 +2,7 @@
 
 const mm = require('mm');
 const http = require('http');
+const fs = require('fs');
 const merge = require('merge-descriptors');
 const is = require('is-type-of');
 const assert = require('assert');
@@ -400,6 +401,27 @@ module.exports = {
   httpRequest() {
     return supertestRequest(this);
   },
+
+  /**
+   * expect str/regexp in the logger
+   * @param {String|RegExp} str - test str or regexp
+   * @param {String|Logger} [logger] - logger instance, default is `ctx.logger`
+   * @method App#expectLog
+   */
+  expectLog(str, logger) {
+    logger = logger || this.logger;
+    if (typeof logger === 'string') {
+      logger = this.getLogger(logger);
+    }
+    const filepath = logger.options.file;
+    const content = fs.readFileSync(filepath, 'utf8');
+    if (str instanceof RegExp) {
+      assert(str.test(content), `Can't find RegExp:"${str}" in ${filepath}`);
+    } else {
+      str = String(str);
+      assert(content.includes(str), `Can't find String:"${str}" in ${filepath}`);
+    }
+  },
 };
 
 function findHeaders(headers, key) {

appveyor.yml

@@ -2,7 +2,7 @@ environment:
   matrix:
     - nodejs_version: '6'
     - nodejs_version: '8'
-    - nodejs_version: '9'
+    - nodejs_version: '10'
 
 install:
   - ps: Install-Product node $env:nodejs_version

lib/cluster.js

@@ -189,6 +189,19 @@ class ClusterApplication extends Coffee {
     };
   }
 
+  /**
+   * expect str in the logger
+   * it's different from `app.expectLog()`, only support string params.
+   *
+   * @param {String} str - test str
+   * @param {String} [logger] - logger instance name, default is `logger`
+   * @method ClusterApplication#expectLog
+   */
+  expectLog(str, logger) {
+    logger = logger || 'logger';
+    this._callFunctionOnAppWorker('expectLog', [ str, logger ], null, true);
+  }
+
   httpRequest() {
     return supertestRequest(this);
   }

package.json

@@ -58,7 +58,7 @@
     "sdk-base": "^3.0.1"
   },
   "ci": {
-    "version": "6, 8, 9"
+    "version": "6, 8, 10"
   },
   "homepage": "https://github.com/eggjs/egg-mock",
   "repository": {

test/app.test.js

@@ -94,6 +94,33 @@ function call(method) {
           keepAliveTimeout: 5000,
         });
     });
+
+    it('should app.expectLog() work', function* () {
+      yield app.httpRequest()
+        .get('/logger')
+        .expect(200)
+        .expect({
+          ok: true,
+        });
+      app.expectLog('[app.expectLog() test] ok');
+      app.expectLog('[app.expectLog() test] ok', 'logger');
+      app.expectLog('[app.expectLog(coreLogger) test] ok', 'coreLogger');
+
+      if (method === 'app') {
+        app.expectLog(/\[app\.expectLog\(\) test\] ok/);
+        app.expectLog(/\[app\.expectLog\(\) test\] ok/, app.logger);
+        app.expectLog('[app.expectLog(coreLogger) test] ok', app.coreLogger);
+        app.expectLog(/\[app\.expectLog\(coreLogger\) test\] ok/, 'coreLogger');
+      }
+
+      try {
+        app.expectLog('[app.expectLog(coreLogger) test] ok');
+        throw new Error('should not run this');
+      } catch (err) {
+        assert(err.message.includes('Can\'t find String:"[app.expectLog(coreLogger) test] ok" in '));
+        assert(err.message.includes('app-web.log'));
+      }
+    });
   });
 
   describe(`mm.${method}({ baseDir, plugin=string })`, () => {

test/fixtures/app/app/router.js

@@ -10,4 +10,10 @@ module.exports = app => {
       keepAliveTimeout: this.app.serverKeepAliveTimeout,
     };
   });
+
+  app.get('/logger', function* () {
+    this.logger.info('[app.expectLog() test] ok');
+    this.coreLogger.info('[app.expectLog(coreLogger) test] ok');
+    this.body = { ok: true };
+  });
 };

test/format_options.test.js

@@ -123,7 +123,7 @@ describe('test/format_options.test.js', () => {
       formatOptions({
         plugin: true,
       });
-    }, `should set eggPlugin in ${baseDir}/package.json`);
+    }, new RegExp(`should set eggPlugin in ${baseDir}/package.json`));
   });
 
   it('should mock process.env.HOME when EGG_SERVER_ENV is default, test, prod', () => {

test/mock_service.async.js

@@ -6,7 +6,7 @@ const assert = require('assert');
 const mm = require('..');
 const fixtures = path.join(__dirname, 'fixtures');
 
-describe('test/mock_service.test.js', () => {
+describe('test/mock_service.async.js', () => {
   let app;
   before(async () => {
     app = mm.app({
@@ -59,7 +59,7 @@ describe('test/mock_service.test.js', () => {
   it('should throw', () => {
     assert.throws(() => {
       app.mockService('foo', 'not_exist', 'foo');
-    }, 'property not_exist in original object must be function');
+    }, /property not_exist in original object must be function/);
   });
 
   it('should return from service when mock with generator', done => {

test/mock_service.test.js

@@ -109,7 +109,7 @@ describe('test/mock_service.test.js', () => {
   it('should throw', () => {
     assert.throws(() => {
       app.mockService('foo', 'not_exist', 'foo');
-    }, 'property not_exist in original object must be function');
+    }, /property not_exist in original object must be function/);
   });
 
   it('should return from service when mock with generator', done => {