Skip to content

Commit

Permalink
avoid using same port number for test (denoland/deno#4147)
Browse files Browse the repository at this point in the history
  • Loading branch information
keroxp authored and denobot committed Feb 1, 2021
1 parent c1199e4 commit c915706
Show file tree
Hide file tree
Showing 13 changed files with 100 additions and 33 deletions.
6 changes: 4 additions & 2 deletions examples/chat/server.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,9 @@ async function wsHandler(ws: WebSocket): Promise<void> {
}
}

listenAndServe({ port: 8080 }, async req => {
const addr = Deno.args[0] ?? "127.0.0.1:8080";

listenAndServe(addr, async req => {
if (req.method === "GET" && req.url === "/") {
//Serve with hack
const u = new URL("./index.html", import.meta.url);
Expand Down Expand Up @@ -75,4 +77,4 @@ listenAndServe({ port: 8080 }, async req => {
}
}
});
console.log("chat server starting on :8080....");
console.log(`chat server starting on ${addr}....`);
15 changes: 12 additions & 3 deletions examples/chat/server_test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,22 @@ import { assert, assertEquals } from "../../testing/asserts.ts";
import { TextProtoReader } from "../../textproto/mod.ts";
import { BufReader } from "../../io/bufio.ts";
import { connectWebSocket, WebSocket } from "../../ws/mod.ts";
import { randomPort } from "../../http/test_util.ts";
import { delay } from "../../util/async.ts";

const port = randomPort();

const { test, build } = Deno;

async function startServer(): Promise<Deno.Process> {
const server = Deno.run({
args: [Deno.execPath(), "--allow-net", "--allow-read", "server.ts"],
args: [
Deno.execPath(),
"--allow-net",
"--allow-read",
"server.ts",
`127.0.0.1:${port}`
],
cwd: "examples/chat",
stdout: "piped"
});
Expand All @@ -35,7 +44,7 @@ test({
async fn() {
const server = await startServer();
try {
const resp = await fetch("http://127.0.0.1:8080/");
const resp = await fetch(`http://127.0.0.1:${port}/`);
assertEquals(resp.status, 200);
assertEquals(resp.headers.get("content-type"), "text/html");
const html = await resp.body.text();
Expand All @@ -55,7 +64,7 @@ test({
const server = await startServer();
let ws: WebSocket | undefined;
try {
ws = await connectWebSocket("http://127.0.0.1:8080/ws");
ws = await connectWebSocket(`http://127.0.0.1:${port}/ws`);
const it = ws.receive();
assertEquals((await it.next()).value, "Connected: [1]");
ws.send("Hello");
Expand Down
2 changes: 1 addition & 1 deletion examples/echo_server.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// Copyright 2018-2020 the Deno authors. All rights reserved. MIT license.
const hostname = "0.0.0.0";
const port = 8080;
const port = +(Deno.args[0] ?? "8080");
const listener = Deno.listen({ hostname, port });
console.log(`Listening on ${hostname}:${port}`);
for await (const conn of listener) {
Expand Down
6 changes: 4 additions & 2 deletions examples/tests/curl_test.ts
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
// Copyright 2018-2020 the Deno authors. All rights reserved. MIT license.
import { serve } from "../../http/server.ts";
import { assertStrictEq } from "../../testing/asserts.ts";
import { randomPort } from "../../http/test_util.ts";

const port = randomPort();
Deno.test({
name: "[examples/curl] send a request to a specified url",
// FIXME(bartlomieju): this test is leaking both resources and ops,
// and causes interference with other tests
ignore: true,
fn: async () => {
const server = serve({ port: 8081 });
const server = serve({ port });
(async (): Promise<void> => {
for await (const req of server) {
req.respond({ body: "Hello world" });
Expand All @@ -21,7 +23,7 @@ Deno.test({
Deno.execPath(),
"--allow-net",
"curl.ts",
"http://localhost:8081"
"http://localhost:" + port
],
cwd: "examples",
stdout: "piped"
Expand Down
8 changes: 5 additions & 3 deletions examples/tests/echo_server_test.ts
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
// Copyright 2018-2020 the Deno authors. All rights reserved. MIT license.
import { assertStrictEq, assertNotEquals } from "../../testing/asserts.ts";
import { BufReader, ReadLineResult } from "../../io/bufio.ts";
import { randomPort } from "../../http/test_util.ts";
const port = randomPort();

Deno.test("[examples/echo_server]", async () => {
const encoder = new TextEncoder();
const decoder = new TextDecoder();
const process = Deno.run({
args: [Deno.execPath(), "--allow-net", "echo_server.ts"],
args: [Deno.execPath(), "--allow-net", "echo_server.ts", `${port}`],
cwd: "examples",
stdout: "piped"
});
Expand All @@ -19,10 +21,10 @@ Deno.test("[examples/echo_server]", async () => {
assertNotEquals(message, Deno.EOF);
assertStrictEq(
decoder.decode((message as ReadLineResult).line).trim(),
"Listening on 0.0.0.0:8080"
"Listening on 0.0.0.0:" + port
);

conn = await Deno.connect({ hostname: "127.0.0.1", port: 8080 });
conn = await Deno.connect({ hostname: "127.0.0.1", port });
const connReader = new BufReader(conn);

await conn.write(encoder.encode("Hello echo_server\n"));
Expand Down
28 changes: 20 additions & 8 deletions http/file_server_test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,11 @@
import { assert, assertEquals, assertStrContains } from "../testing/asserts.ts";
import { BufReader } from "../io/bufio.ts";
import { TextProtoReader } from "../textproto/mod.ts";
import { randomPort } from "./test_util.ts";
const { test } = Deno;
let fileServer: Deno.Process;

const port = randomPort();
async function startFileServer(): Promise<void> {
fileServer = Deno.run({
args: [
Expand All @@ -14,7 +16,9 @@ async function startFileServer(): Promise<void> {
"--allow-net",
"http/file_server.ts",
".",
"--cors"
"--cors",
"--port",
`${port}`
],
stdout: "piped",
stderr: "null"
Expand All @@ -34,7 +38,7 @@ function killFileServer(): void {
test(async function serveFile(): Promise<void> {
await startFileServer();
try {
const res = await fetch("http://localhost:4500/README.md");
const res = await fetch(`http://localhost:${port}/README.md`);
assert(res.headers.has("access-control-allow-origin"));
assert(res.headers.has("access-control-allow-headers"));
assert(res.headers.has("content-type"));
Expand All @@ -52,7 +56,7 @@ test(async function serveFile(): Promise<void> {
test(async function serveDirectory(): Promise<void> {
await startFileServer();
try {
const res = await fetch("http://localhost:4500/");
const res = await fetch(`http://localhost:${port}/`);
assert(res.headers.has("access-control-allow-origin"));
assert(res.headers.has("access-control-allow-headers"));
const page = await res.text();
Expand All @@ -74,7 +78,7 @@ test(async function serveDirectory(): Promise<void> {
test(async function serveFallback(): Promise<void> {
await startFileServer();
try {
const res = await fetch("http://localhost:4500/badfile.txt");
const res = await fetch(`http://localhost:${port}/badfile.txt`);
assert(res.headers.has("access-control-allow-origin"));
assert(res.headers.has("access-control-allow-headers"));
assertEquals(res.status, 404);
Expand All @@ -87,12 +91,12 @@ test(async function serveFallback(): Promise<void> {
test(async function serveWithUnorthodoxFilename(): Promise<void> {
await startFileServer();
try {
let res = await fetch("http://localhost:4500/http/testdata/%");
let res = await fetch(`http://localhost:${port}/http/testdata/%`);
assert(res.headers.has("access-control-allow-origin"));
assert(res.headers.has("access-control-allow-headers"));
assertEquals(res.status, 200);
res.body.close();
res = await fetch("http://localhost:4500/http/testdata/test%20file.txt");
res = await fetch(`http://localhost:${port}/http/testdata/test%20file.txt`);
assert(res.headers.has("access-control-allow-origin"));
assert(res.headers.has("access-control-allow-headers"));
assertEquals(res.status, 200);
Expand All @@ -103,8 +107,16 @@ test(async function serveWithUnorthodoxFilename(): Promise<void> {
});

test(async function servePermissionDenied(): Promise<void> {
const _port = randomPort();
const deniedServer = Deno.run({
args: [Deno.execPath(), "run", "--allow-net", "http/file_server.ts"],
args: [
Deno.execPath(),
"run",
"--allow-net",
"http/file_server.ts",
"-p",
`${_port}`
],
stdout: "piped",
stderr: "piped"
});
Expand All @@ -116,7 +128,7 @@ test(async function servePermissionDenied(): Promise<void> {
assert(s !== Deno.EOF && s.includes("server listening"));

try {
const res = await fetch("http://localhost:4500/");
const res = await fetch(`http://localhost:${_port}/`);
res.body.close();
assertStrContains(
(await errReader.readLine()) as string,
Expand Down
3 changes: 2 additions & 1 deletion http/http_bench.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
// Copyright 2018-2020 the Deno authors. All rights reserved. MIT license.
import { serve } from "./server.ts";
import { randomPort } from "./test_util.ts";

const addr = Deno.args[0] || "127.0.0.1:4500";
const addr = Deno.args[0] || "127.0.0.1:" + randomPort();
const server = serve(addr);
const body = new TextEncoder().encode("Hello World");

Expand Down
2 changes: 1 addition & 1 deletion http/racing_server.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
import { serve, ServerRequest } from "./server.ts";
import { delay } from "../util/async.ts";

const addr = Deno.args[1] || "127.0.0.1:4501";
const addr = Deno.args[0] || "127.0.0.1:4501";
const server = serve(addr);

function body(i: number): string {
Expand Down
12 changes: 10 additions & 2 deletions http/racing_server_test.ts
Original file line number Diff line number Diff line change
@@ -1,12 +1,20 @@
import { assert, assertEquals } from "../testing/asserts.ts";
import { BufReader, BufWriter } from "../io/bufio.ts";
import { TextProtoReader } from "../textproto/mod.ts";
import { randomPort } from "./test_util.ts";
const port = randomPort();
const { connect, run, test } = Deno;

let server: Deno.Process;
async function startServer(): Promise<void> {
server = run({
args: [Deno.execPath(), "run", "-A", "http/racing_server.ts"],
args: [
Deno.execPath(),
"run",
"-A",
"http/racing_server.ts",
"127.0.0.1:" + port
],
stdout: "piped"
});
// Once racing server is ready it will write to its stdout.
Expand Down Expand Up @@ -61,7 +69,7 @@ Step7
test(async function serverPipelineRace(): Promise<void> {
await startServer();

const conn = await connect({ port: 4501 });
const conn = await connect({ port });
const r = new TextProtoReader(new BufReader(conn));
const w = new BufWriter(conn);
await w.write(new TextEncoder().encode(input));
Expand Down
23 changes: 16 additions & 7 deletions http/server_test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ import { BufReader, BufWriter } from "../io/bufio.ts";
import { delay } from "../util/async.ts";
import { encode, decode } from "../strings/mod.ts";
import { mockConn } from "./mock.ts";
import { randomPort } from "./test_util.ts";

const { Buffer, test } = Deno;

Expand Down Expand Up @@ -355,8 +356,14 @@ test({
ignore: true,
fn: async (): Promise<void> => {
// Runs a simple server as another process
const port = randomPort();
const p = Deno.run({
args: [Deno.execPath(), "--allow-net", "http/testdata/simple_server.ts"],
args: [
Deno.execPath(),
"--allow-net",
"http/testdata/simple_server.ts",
`${port}`
],
stdout: "piped"
});

Expand Down Expand Up @@ -395,13 +402,15 @@ test({
// FIXME(bartlomieju): hangs on windows, cause can't do `Deno.kill`
ignore: true,
fn: async (): Promise<void> => {
const port = randomPort();
// Runs a simple server as another process
const p = Deno.run({
args: [
Deno.execPath(),
"--allow-net",
"--allow-read",
"http/testdata/simple_https_server.ts"
"http/testdata/simple_https_server.ts",
`${port}`
],
stdout: "piped"
});
Expand All @@ -413,7 +422,6 @@ test({
serverIsRunning = false;
})
.catch((_): void => {}); // Ignores the error when closing the process.

try {
const r = new TextProtoReader(new BufReader(p.stdout!));
const s = await r.readLine();
Expand All @@ -424,7 +432,7 @@ test({
// Requests to the server and immediately closes the connection
const conn = await Deno.connectTLS({
hostname: "localhost",
port: 4503,
port,
certFile: "http/testdata/tls/RootCA.pem"
});
await Deno.writeAll(
Expand All @@ -448,7 +456,7 @@ test({
});

test("close server while iterating", async (): Promise<void> => {
const server = serve(":8123");
const server = serve({ port: randomPort() });
const nextWhileClosing = server[Symbol.asyncIterator]().next();
server.close();
assertEquals(await nextWhileClosing, { value: undefined, done: true });
Expand Down Expand Up @@ -491,8 +499,9 @@ test({
test({
name: "respond error closes connection",
async fn(): Promise<void> {
const port = randomPort();
const serverRoutine = async (): Promise<void> => {
const server = serve(":8124");
const server = serve(":" + port);
// @ts-ignore
for await (const req of server) {
await assertThrowsAsync(async () => {
Expand All @@ -509,7 +518,7 @@ test({
const p = serverRoutine();
const conn = await Deno.connect({
hostname: "127.0.0.1",
port: 8124
port
});
await Deno.writeAll(
conn,
Expand Down
20 changes: 20 additions & 0 deletions http/test_util.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
import { assert } from "../testing/asserts.ts";

function* portIterator(): IterableIterator<number> {
// use 55001 ~ 65535 (rest (49152~55000) are for cli/js)
let i = 55001;
while (true) {
yield i;
i++;
if (i > 65535) {
i = 55001;
}
}
}
const it = portIterator();
/** Obtain (maybe) safe port number for net tests */
export function randomPort(): number {
const { value } = it.next();
assert(value != null);
return value;
}
3 changes: 2 additions & 1 deletion http/testdata/simple_https_server.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,10 @@
// This is an example of a https server
import { serveTLS } from "../server.ts";

const port = parseInt(Deno.args[0] || "4503");
const tlsOptions = {
hostname: "localhost",
port: 4503,
port,
certFile: "./http/testdata/tls/localhost.crt",
keyFile: "./http/testdata/tls/localhost.key"
};
Expand Down
5 changes: 3 additions & 2 deletions http/testdata/simple_server.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@
// This is an example of a server that responds with an empty body
import { serve } from "../server.ts";

const addr = "0.0.0.0:4502";
console.log(`Simple server listening on ${addr}`);
const port = parseInt(Deno.args[0] || "4502");
const addr: Deno.ListenOptions = { port };
console.log(`Simple server listening on ${port}`);
for await (const req of serve(addr)) {
req.respond({});
}

0 comments on commit c915706

Please sign in to comment.