Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

test: add test and doc for listen options #1246

Merged
merged 1 commit into from
Jul 27, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions docs/source/zh-cn/core/deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,23 @@ EGG_SERVER_ENV=prod nohup node dispatch.js > stdout.log 2> stderr.log &
- 如果使用 Docker,可直接前台运行。
- 默认情况框架会创建和 CPU 核数相当的 app worker 数,可以充分的利用 CPU 资源。

### 启动配置项

你也可以在 `config.{env}.js` 中配置指定启动配置。

```js
// config/config.default.js
exports.cluster = {
listen: {
port: '7001',
hostname: '127.0.0.1',
// path: '/var/run/egg.sock',
}
}
```

`path`,`port`,`hostname` 均为 [server.listen](https://nodejs.org/api/http.html#http_server_listen_port_hostname_backlog_callback) 的参数,`egg.startCluster` 方法传入的 port 优先级高于此配置。

### 自定义框架启动

如果应用使用了[自定义框架](../advanced/framework.md),还需要指定额外的参数,比如框架为 `yadan`。
Expand Down
7 changes: 7 additions & 0 deletions test/fixtures/apps/app-server-with-hostname/app/router.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
'use strict';

module.exports = app => {
app.get('/', function* () {
this.body = 'done';
});
};
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
'use strict';

const address = require('address');

exports.keys = 'my keys';
exports.cluster = {
listen: {
hostname: address.ip(),
},
};
3 changes: 3 additions & 0 deletions test/fixtures/apps/app-server-with-hostname/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"name": "app-server-with-hostname"
}
33 changes: 32 additions & 1 deletion test/lib/cluster/app_worker.test.js
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
'use strict';

const request = require('supertest');
const address = require('address');
const assert = require('assert');
const utils = require('../../utils');

describe('test/lib/cluster/app_worker.test.js', () => {
let app;
before(() => {
app = utils.cluster('apps/app-server');
app.coverage(true);
return app.ready();
});
after(() => app.close());
Expand All @@ -16,4 +18,33 @@ describe('test/lib/cluster/app_worker.test.js', () => {
.get('/')
.expect('true');
});

describe('listen hostname', () => {
let app;
before(() => {
app = utils.cluster('apps/app-server-with-hostname');
return app.ready();
});
after(() => app.close());

it('should refuse other ip', function* () {
const url = address.ip() + ':' + app.port;

yield request(url)
.get('/')
.expect('done')
.expect(200);

try {
yield request('http://127.0.0.1:17010')
.get('/')
.expect('done')
.expect(200);
throw new Error('should not run');
} catch (err) {
assert(err.message === 'ECONNREFUSED: Connection refused');
}
});
});

});